PyLibMS 2.1.2__tar.gz → 2.1.4__tar.gz

{pylibms-2.1.2 → pylibms-2.1.4}/LMS/Common/LMS_DataType.py

@@ -3,7 +3,7 @@ from typing import Literal, Type
 
 
 class LMS_DataType(Enum):
-
+    """Enum that represents a datatype for a value entry in a MSBT/MSBP file."""
     UINT8 = 0
     UINT16 = 1
     UINT32 = 2
@@ -15,12 +15,17 @@ class LMS_DataType(Enum):
     FLOAT32 = 6
 
     # Unknown 16 bit type (value of 6) has yet to be documented
+    # Might be some sort of 2 byte integer, float, or may be an array.
+    # We wont ever know cause no game (yet that has been found) has utilized this type
+    # Thanks Nintendo.
     ...
 
     STRING = 8
     LIST = 9
-
-    # Interface types
+ 
+    # These types are not offical, but allow for abstraction from the value of the actual type
+    # As an example, BOOL can be utilized for UInt8 values that act like a bool
+    # Byte types can also be used for when the type/value is unknown or if there is extra data in the tag.
     BOOL = "bool"
     BYTE = "byte"
 
@@ -59,7 +64,7 @@ class LMS_DataType(Enum):
 
     @property
     def stream_size(self) -> Literal[1, 2, 4]:
-        """The size the datatype takes up in a strema."""
+        """The size the datatype takes up in a stream."""
         return {
             LMS_DataType.UINT8: 1,
             LMS_DataType.UINT16: 2,

{pylibms-2.1.2 → pylibms-2.1.4}/LMS/Message/Definitions/Field/LMS_Field.py

@@ -1,4 +1,3 @@
-from dataclasses import dataclass, field
 
 from LMS.Common.LMS_DataType import LMS_DataType
 from LMS.TitleConfig.Definitions.Value import ValueDefinition
@@ -17,14 +16,13 @@ class LMS_Field:
         self._value = value
 
     def __repr__(self):
-        typename = self._definition.datatype.name
-        if typename == "LIST":
+        if self.datatype is LMS_DataType.LIST:
             if len(self.list_items) > 6:
                 preview = self.list_items[:3] + ["..."]
             else:
                 preview = self.list_items
             return f"LMS_Field(value={self._value}, options={preview})"
-        return f"LMS_Field(value={self._value!r}, type={typename})"
+        return f"LMS_Field(value={self._value}, type={self.datatype.name})"
 
     @property
     def name(self) -> str:

{pylibms-2.1.2 → pylibms-2.1.4}/LMS/Message/Definitions/LMS_MessageText.py

@@ -2,7 +2,9 @@ import re
 from typing import overload
 
 from LMS.Message.Definitions.Field.LMS_Field import LMS_Field
+from LMS.Message.Definitions.Field.LMS_FieldMap import LMS_FieldMap
 from LMS.Message.Tag.LMS_Tag import LMS_DecodedTag, LMS_EncodedTag, LMS_TagBase
+from LMS.Message.Tag.System_Definitions import get_system_tag
 from LMS.Message.Tag.Tag_Formats import (DECODED_FORMAT, ENCODED_FORMAT,
                                          TAG_FORMAT)
 from LMS.TitleConfig.Config import TagConfig
@@ -44,27 +46,29 @@ class LMS_MessageText:
 
     @overload
     def append_encoded_tag(
-        self, group: int, tag: int, parameters: list[str] | None = None
+        self, group: int, tag: int, *parameters: tuple[str] 
     ) -> None: ...
 
     @overload
     def append_encoded_tag(
-        self, group: str, tag: str, parameters: list[str] | None = None
+        self, group: str, tag: str, *parameters: tuple[str]
     ) -> None: ...
 
     def append_encoded_tag(
-        self, group: int | str, tag: int | str, parameters: list[str] | None = None
+        self, group: int | str, tag: int | str, *parameters: tuple[str]
     ):
         """Appends an encoded tag to the current message.
 
         :param group: the group name or index.
         :param tag: the group tag or index:
         :param parameters: a list of hex strings.
+
+        message.append_encoded_tag(1, 2, "01", "00", "00", "CD")
         """
         if isinstance(group, int) and isinstance(tag, int):
             self._parts.append(LMS_EncodedTag(group, tag, parameters))
             return
-
+        
         definition = self._config.get_definition_by_names(group, tag)
         self._parts.append(
             LMS_EncodedTag(
@@ -72,35 +76,38 @@ class LMS_MessageText:
             )
         )
 
-    def append_decoded_tag(
-        self,
-        group_name: str,
-        tag_name: str,
-        parameters: dict[str, int | float | str | bytes | bool] | None = None,
-    ) -> None:
+    def append_decoded_tag(self, group_name: str, tag_name: str, **parameters: LMS_FieldMap) -> None:
         """Appends an decoded tag to the current message.
 
         :param group_name: the group name.
         :param tag_name: the tag name.:
-        :param parameters: a dictionary of parameters mapped to their value.
+        :param parameters: keyword arguments of parameters mapped to their value.
+
+        ## Usage
+        ```
+        message.append_decoded_tag("Mii", "Nickname", buffer=1, type="Voice", conversion="None")
+        ```
         """
 
-        definition = self._config.get_definition_by_names(group_name, tag_name)
+        if group_name == "System":
+            definition = get_system_tag(tag_name)
+        else:
+            definition = self._config.get_definition_by_names(group_name, tag_name)
 
-        # The provided dict must match the structure defined in the config in order for value conversion to work
+        # The provided kwargs must match the structure defined in the config in order for value conversion to work
         converted_params = {
             param_def.name: LMS_Field(parameters[param_def.name], param_def)
             for param_def in definition.parameters
         }
-        self._parts.append(
-            LMS_DecodedTag(
-                definition.group_index,
-                definition.tag_index,
-                group_name,
-                tag_name,
-                converted_params,
-            )
+
+        tag = LMS_DecodedTag(
+            definition.group_index,
+            definition.tag_index,
+            group_name,
+            tag_name,
+            converted_params,
         )
+        self._parts.append(tag)
 
     def append_tag_string(self, string: str) -> None:
         """Appends a tag to the current message given a string.

{pylibms-2.1.2 → pylibms-2.1.4}/LMS/Message/MSBT.py

@@ -87,7 +87,7 @@ class MSBT:
             if self._tag_config is not None:
                 message_text = LMS_MessageText(text, self._tag_config)
             else:
-                message_text = text
+                message_text = LMS_MessageText(text)
         else:
             message_text = ""
 

{pylibms-2.1.2 → pylibms-2.1.4}/LMS/Message/MSBTStream.py

@@ -59,7 +59,7 @@ def read_msbt(
                 file.size_per_attribute = size_per_attribute
                 file.attr_string_table = string_table
             case "TXT2":
-                messages = read_txt2(reader, file_info.encoding, tag_config)
+                messages = read_txt2(reader, tag_config)
             case "TSY1":
                 style_indexes = read_tsy1(reader, len(labels))
             case _:

{pylibms-2.1.2 → pylibms-2.1.4}/LMS/Message/Section/TXT2.py

@@ -6,9 +6,9 @@ from LMS.Message.Tag.Stream import read_tag, write_tag
 from LMS.TitleConfig.Definitions.Tags import TagConfig
 
 
-def read_txt2(
-    reader: FileReader, encoding: FileEncoding, config: TagConfig
-) -> list[LMS_MessageText]:
+def read_txt2(reader: FileReader, config: TagConfig) -> list[LMS_MessageText]:
+    encoding = reader.encoding
+
     text_list = []
     count = reader.read_uint32()
 

{pylibms-2.1.2 → pylibms-2.1.4}/LMS/Message/Tag/LMS_Tag.py

@@ -10,6 +10,7 @@ from LMS.TitleConfig.Definitions.Tags import TagConfig
 
 
 class LMS_TagBase(ABC):
+    """Base class for encoded and decoded tags."""
     def __init__(
         self,
         group_index: int,
@@ -71,7 +72,7 @@ class LMS_EncodedTag(LMS_TagBase):
         self,
         group_index: int,
         tag_index: int,
-        parameters: list[str] = None,
+        parameters: list[str] | tuple[str] = None,
         group_name: str = None,
         tag_name: str = None,
     ):

{pylibms-2.1.2 → pylibms-2.1.4}/LMS/Message/Tag/Stream.py

@@ -6,7 +6,7 @@ from LMS.Message.Definitions.Field.Stream import read_field, write_field
 from LMS.Message.Tag.LMS_Tag import LMS_DecodedTag, LMS_EncodedTag, LMS_TagBase
 from LMS.Message.Tag.LMS_TagExceptions import (LMS_TagReadingError,
                                                LMS_TagWritingException)
-from LMS.Message.Tag.System_Definitions import SYSTEM_GROUP
+from LMS.Message.Tag.System_Definitions import get_system_tag
 from LMS.TitleConfig.Definitions.Tags import TagConfig, TagDefinition
 
 
@@ -29,12 +29,12 @@ def read_tag(
         return LMS_EncodedTag(group_index, tag_index, parameters)
 
     if group_index == 0:
-        definition = SYSTEM_GROUP[tag_index]
+        definition = get_system_tag(tag_index)
     else:
         definition = config.get_definition_by_indexes(group_index, tag_index)
 
     # If the parameters were omitted from the definition but the tag still has defined parameters, add the decoded
-    # names but read the tag as encoded. This is to account for encoded tags that group have tag names attatched.
+    # names but read the tag as encoded. This is to account for encoded tags that have group and tag names defined.
     # i.e [Group:Tag 00-00-00-FF]
     if definition.parameters is None and param_size > 0:
         parameters = _read_encoded_parameters(reader, param_size)

{pylibms-2.1.2 → pylibms-2.1.4}/LMS/Message/Tag/System_Definitions.py

@@ -2,6 +2,11 @@ from LMS.Common.LMS_DataType import LMS_DataType
 from LMS.TitleConfig.Definitions.Tags import TagDefinition
 from LMS.TitleConfig.Definitions.Value import ValueDefinition
 
+
+def get_system_tag(group: int | str) -> TagDefinition:
+    return SYSTEM_INT_MAP[group] if isinstance(group, int) else SYSTEM_STR_MAP[group]
+
+
 RUBY_TAG = TagDefinition(
     group_name="System",
     group_index=0,
@@ -74,10 +79,18 @@ PAGEBREAK_TAG = TagDefinition(
     description="Displays text in the same label on different pages.",
 )
 
-SYSTEM_GROUP = {
+SYSTEM_INT_MAP = {
     0: RUBY_TAG,
     1: FONT_TAG,
     2: SIZE_TAG,
     3: COLOR_TAG,
     4: PAGEBREAK_TAG,
 }
+
+SYSTEM_STR_MAP = {
+    "Ruby": RUBY_TAG,
+    "Font": FONT_TAG,
+    "Size": SIZE_TAG,
+    "Color": COLOR_TAG,
+    "Pagebreak": PAGEBREAK_TAG,
+}

{pylibms-2.1.2 → pylibms-2.1.4}/LMS/TitleConfig/Config.py

@@ -23,9 +23,7 @@ class TitleConfig:
         if file.name.endswith(".yaml")
     ]
 
-    def __init__(
-        self, attribute_configs: dict[str, AttributeConfig], tag_config: TagConfig
-    ):
+    def __init__(self, attribute_configs: dict[str, AttributeConfig], tag_config: TagConfig):
         self._attribute_configs = attribute_configs
         self._tag_config = tag_config
 
@@ -61,21 +59,16 @@ class TitleConfig:
         """Loads the config of a specified game.
 
         :param content: the config content, as a string or loaded as a dictionary."""
+        parsed_content = content
+
         if isinstance(content, str):
             parsed_content = yaml.safe_load(content)
-        else:
-            parsed_content = content
 
         # Load the attribute definitions
         attribute_configs = {}
         for config in parsed_content[ATTR_KEY]:
-            definitions = [
-                ValueDefinition.from_dict(value_def)
-                for value_def in config["definitions"]
-            ]
-            attribute_configs[config["name"]] = AttributeConfig(
-                config["name"], config["description"], definitions
-            )
+            definitions = [ValueDefinition.from_dict(value_def) for value_def in config["definitions"]]
+            attribute_configs[config["name"]] = AttributeConfig(config["name"], config["description"], definitions)
 
         # Load the tag definitions
         tag_definitions = []
@@ -107,9 +100,7 @@ class TitleConfig:
         config = {}
 
         config[TAG_KEY] = {
-            "groups": {
-                i: group.name for i, group in enumerate(project.tag_groups, start=1)
-            },
+            "groups": {i: group.name for i, group in enumerate(project.tag_groups, start=1)},
             "tags": [],
         }
 

{pylibms-2.1.2 → pylibms-2.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 2.1.2
+Version: 2.1.4
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License: Copyright 2025 AbdyyEee

{pylibms-2.1.2 → pylibms-2.1.4}/PyLibMS.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 2.1.2
+Version: 2.1.4
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License: Copyright 2025 AbdyyEee

{pylibms-2.1.2 → pylibms-2.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "PyLibMS"
-version = "2.1.2"
+version = "2.1.4"
 requires-python = ">=3.12"
 description = "Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF."
 readme = "README.md"