PyLibMS 2.1.1__tar.gz → 2.1.2__tar.gz

{pylibms-2.1.1 → pylibms-2.1.2}/LMS/FileIO/Stream.py

@@ -166,6 +166,12 @@ class FileWriter:
     def write_string(self, string: str):
         self.write_bytes(string.encode("UTF-8"))
 
+    def write_len_variable_encoding_string(self, string: str) -> None:
+        self.write_uint16(len(string) * self.encoding.width)
+        self.write_variable_encoding_string.write_variable_encoding_string(
+            string, False
+        )
+
     def write_variable_encoding_string(self, string: str, terminate: bool = True):
         self.write_bytes(string.encode(self.encoding.to_string_format(self.big_endian)))
         if terminate:

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

@@ -84,7 +84,6 @@ class LMS_Field:
                     return
             case LMS_DataType.FLOAT32:
                 min_value, max_value = -3.4028235e38, 3.4028235e38
-
             # Other number types fall here
             case _:
                 bits = datatype.stream_size * 8
@@ -108,16 +107,10 @@ def cast_value(value: int | str | float | bytes | bool, datatype: LMS_DataType)
         case LMS_DataType.BYTE:
             return hex(int(value))
         case LMS_DataType.BOOL:
+            if value not in ("false", "true"):
+                raise ValueError("Value must be true or false for bool type.")
             return value.strip().lower() == "true"
         case LMS_DataType.FLOAT32:
-            try:
-                return float(value)
-            except ValueError:
-                raise ValueError(f"Cannot convert '{value}' to float.")
+            return float(value)
         case _:
-            if value.isdigit():
-                return int(value)
-            else:
-                raise TypeError(
-                    f"The provided value for type '{datatype}' is not a digit!"
-                )
+            return int(value)

{pylibms-2.1.1 → pylibms-2.1.2}/LMS/Message/Section/ATR1.py

@@ -88,14 +88,14 @@ def write_decoded_atr1(
     string_offset = 8 + size_per_attribute * len(attributes)
     for attr in attributes:
         for field in attr.values():
-            if field.datatype is not LMS_DataType.STRING:
-                write_field(writer, field)
-            else:
+            if field.datatype is LMS_DataType.STRING:
                 writer.write_uint32(string_offset)
                 string_offset += (
                     len(field.value) * writer.encoding.width
                 ) + writer.encoding.width
                 string_table.append(field.value)
+            else:
+                write_field(writer, field)
 
     for string in string_table:
         writer.write_variable_encoding_string(string)

{pylibms-2.1.1 → pylibms-2.1.2}/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_Definition import SYSTEM_GROUP
+from LMS.Message.Tag.System_Definitions import SYSTEM_GROUP
 from LMS.TitleConfig.Definitions.Tags import TagConfig, TagDefinition
 
 
@@ -34,8 +34,8 @@ def read_tag(
         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. 
-    # i.e [System:Color 00-00-00-FF]
+    # names but read the tag as encoded. This is to account for encoded tags that group have tag names attatched.
+    # i.e [Group:Tag 00-00-00-FF]
     if definition.parameters is None and param_size > 0:
         parameters = _read_encoded_parameters(reader, param_size)
         return LMS_EncodedTag(
@@ -56,7 +56,7 @@ def read_tag(
 
 def write_tag(writer: FileWriter, tag: LMS_TagBase) -> None:
     tag_indicator = b"\x0e" + (b"\x00" * (writer.encoding.width - 1))
-    
+
     if writer.big_endian:
         tag_indicator = tag_indicator[::-1]
 
@@ -121,10 +121,10 @@ def _read_decoded_parameters(
 def _write_decoded_parameters(writer: FileWriter, tag: LMS_DecodedTag) -> None:
     param_size = 0
 
-    # Tags are padded by 0xCD if the size is not aligned to the encoding
+    # Tags are padded by a 0xCD byte if the size is not aligned to the encoding
     # This can occur before a string parameter, or at the end of the tag.
-    # Set a flag in order to be able to pad the first string correctly
-    needs_padding = False
+    # If a string parameter exists, then the padding will always be at the first string instance
+    # first_string is a flag so that the first string can be padded correctly.
     first_string = True
 
     for field in tag.parameters.values():
@@ -133,21 +133,19 @@ def _write_decoded_parameters(writer: FileWriter, tag: LMS_DecodedTag) -> None:
         else:
             param_size += field.datatype.stream_size
 
-    if param_size % 2 == 1:
-        needs_padding = True
+    if needs_padding := param_size % 2 == 1:
         param_size += 1
 
     writer.write_uint16(param_size)
     for field in tag.parameters.values():
         try:
             if field.datatype is LMS_DataType.STRING:
+
                 if first_string and needs_padding:
                     writer.write_bytes(b"\xcd")
-                    first_string = False
-                    needs_padding = False
+                    first_string, needs_padding = False, False
 
-                writer.write_uint16(len(field.value) * writer.encoding.width)
-                writer.write_variable_encoding_string(field.value, False)
+                writer.write_len_variable_encoding_string(field.value)
             else:
                 write_field(writer, field)
         except Exception as e:

{pylibms-2.1.1 → pylibms-2.1.2}/LMS/Project/MSBP.py

@@ -29,10 +29,6 @@ class MSBP:
         self._styles = styles
         self._source_files = source_files
 
-        self.clb1_exists = False
-        self.alb1_exists = False
-        self.slb1_exists = False
-
     @property
     def info(self) -> LMS_FileInfo:
         """The stream info of the MSBP."""

{pylibms-2.1.1 → pylibms-2.1.2}/LMS/Project/MSBPRead.py

@@ -46,7 +46,6 @@ def read_msbp(stream: BinaryIO | None) -> MSBP:
                 # Set the name attributes of last read item
                 for i in labels:
                     items[i].name = labels[i]
-                # Set the section exists
                 exist_map[magic] = True
             case "CLR1":
                 colors = read_clr1(reader)
@@ -80,6 +79,13 @@ def read_msbp(stream: BinaryIO | None) -> MSBP:
 
     # Combining tag data
     if tag_groups:
+
+        # Cut out the System group from the definitions
+        # Since these are predefined, there is no need to keep them.
+        # Easier to remove here as opposed to manually skipping over them while reading
+        # See Tag/System_Definition for the full System definition of tags.
+        tag_groups = tag_groups[1:]
+
         for group in tag_groups:
             group.tag_definitions = [tag_info_list[i] for i in group.tag_indexes]
 
@@ -93,9 +99,4 @@ def read_msbp(stream: BinaryIO | None) -> MSBP:
 
     file = MSBP(file_info, colors, attribute_info_list, tag_groups, styles, source_list)
     file.name = os.path.basename(stream.name).removesuffix(".msbp")
-
-    file.clb1_exists = exist_map["CLB1"]
-    file.alb1_exists = exist_map["ALB1"]
-    file.slb1_exists = exist_map["SLB1"]
-
     return file

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

@@ -105,19 +105,16 @@ class TitleConfig:
         # TODO: Add custom node definitions
 
         config = {}
-        # Source files may be a path to a non-existent directory.
-        # These files were generated from the source machine from the actual libMS tool
-        # Shorten the filename with basname and replace the extension with .msbt for lookup later when reading a MSBT
+
         config[TAG_KEY] = {
             "groups": {
-                i + 1: group.name for i, group in enumerate(project.tag_groups[1:])
+                i: group.name for i, group in enumerate(project.tag_groups, start=1)
             },
             "tags": [],
         }
 
-        # Slice to exclude System group
         if project.tag_groups is not None:
-            for group_i, group in enumerate(project.tag_groups[1:], start=1):
+            for group_i, group in enumerate(project.tag_groups, start=1):
                 for tag_i, info in enumerate(group.tag_definitions):
 
                     definition = {
@@ -142,10 +139,7 @@ class TitleConfig:
 
                     config[TAG_KEY]["tags"].append(definition)
 
-        # Set main attribute entries as the definitions from the MSBP
-        # Since most games use one MSBP these act the primary definitions
         config[ATTR_KEY] = []
-
         if project.attribute_info is not None:
 
             attr_definitions = []

{pylibms-2.1.1 → pylibms-2.1.2}/LMS/TitleConfig/Definitions/Attributes.py

@@ -6,6 +6,7 @@ from LMS.TitleConfig.Definitions.Value import ValueDefinition
 @dataclass(frozen=True)
 class AttributeConfig:
     """Class that represents an attribute config definition"""
+
     name: str
     description: str = field(repr=False)
     definitions: list[ValueDefinition]

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 2.1.1
+Version: 2.1.2
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License: Copyright 2025 AbdyyEee
@@ -13,7 +13,7 @@ License: Copyright 2025 AbdyyEee
 Project-URL: Documentation, https://github.com/AbdyyEee/PylibMS/wiki
 Project-URL: Repository, https://github.com/AbdyyEee/PylibMS
 Keywords: nintendo,msbf,msbt,msbp,modding,lms,libmessagestudio
-Requires-Python: >=3.10
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML==6.0.1
@@ -51,14 +51,15 @@ from LMS.Message.MSBTStream import write_msbt
 with open("Out.msbt", "wb") as f:
     write_msbt(f, msbt)
 ```
-# Adding Presets
-To add a Preset, you may create an issue with the relevant yaml file and the game it is for.
+# Adding/Editing Presets
+To add or edit Preset, you may create an issue with the relevant yaml file and the game it is for.
 
 # Installation
 ```
 pip install PylibMS
 ```
-Python version must be `>=3.10.`
+
+Python version must be `>=3.12.`
 # Credits & Sources
 * [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file formats.
 * [Trippixyz](https://github.com/Trippixyz): For helping me get started general decompilation of the formats and general help.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 2.1.1
+Version: 2.1.2
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License: Copyright 2025 AbdyyEee
@@ -13,7 +13,7 @@ License: Copyright 2025 AbdyyEee
 Project-URL: Documentation, https://github.com/AbdyyEee/PylibMS/wiki
 Project-URL: Repository, https://github.com/AbdyyEee/PylibMS
 Keywords: nintendo,msbf,msbt,msbp,modding,lms,libmessagestudio
-Requires-Python: >=3.10
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML==6.0.1
@@ -51,14 +51,15 @@ from LMS.Message.MSBTStream import write_msbt
 with open("Out.msbt", "wb") as f:
     write_msbt(f, msbt)
 ```
-# Adding Presets
-To add a Preset, you may create an issue with the relevant yaml file and the game it is for.
+# Adding/Editing Presets
+To add or edit Preset, you may create an issue with the relevant yaml file and the game it is for.
 
 # Installation
 ```
 pip install PylibMS
 ```
-Python version must be `>=3.10.`
+
+Python version must be `>=3.12.`
 # Credits & Sources
 * [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file formats.
 * [Trippixyz](https://github.com/Trippixyz): For helping me get started general decompilation of the formats and general help.

{pylibms-2.1.1 → pylibms-2.1.2}/PyLibMS.egg-info/SOURCES.txt

@@ -29,7 +29,7 @@ LMS/Message/Section/__init__.py
 LMS/Message/Tag/LMS_Tag.py
 LMS/Message/Tag/LMS_TagExceptions.py
 LMS/Message/Tag/Stream.py
-LMS/Message/Tag/System_Definition.py
+LMS/Message/Tag/System_Definitions.py
 LMS/Message/Tag/Tag_Formats.py
 LMS/Message/Tag/__init__.py
 LMS/Project/MSBP.py

{pylibms-2.1.1 → pylibms-2.1.2}/README.md

@@ -30,14 +30,15 @@ from LMS.Message.MSBTStream import write_msbt
 with open("Out.msbt", "wb") as f:
     write_msbt(f, msbt)
 ```
-# Adding Presets
-To add a Preset, you may create an issue with the relevant yaml file and the game it is for.
+# Adding/Editing Presets
+To add or edit Preset, you may create an issue with the relevant yaml file and the game it is for.
 
 # Installation
 ```
 pip install PylibMS
 ```
-Python version must be `>=3.10.`
+
+Python version must be `>=3.12.`
 # Credits & Sources
 * [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file formats.
 * [Trippixyz](https://github.com/Trippixyz): For helping me get started general decompilation of the formats and general help.

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

@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "PyLibMS"
-version = "2.1.1"
-requires-python = ">=3.10"
+version = "2.1.2"
+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"
 authors = [{ name = "AbdyyEee" }]
@@ -15,4 +15,4 @@ dependencies = ["PyYAML==6.0.1"]
 
 [project.urls]
 Documentation = "https://github.com/AbdyyEee/PylibMS/wiki"
-Repository = "https://github.com/AbdyyEee/PylibMS"
+Repository = "https://github.com/AbdyyEee/PylibMS"