PyLibMS 3.2.3__tar.gz → 3.2.5__tar.gz

{pylibms-3.2.3 → pylibms-3.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 3.2.3
+Version: 3.2.5
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License: Copyright 2025 AbdyyEee
@@ -25,8 +25,8 @@ PylibMS is a library built in Python 3.10+ for the libMessageStudio (LMS) propri
 * Full reading and writing of MSBT files.
 * Full reading of MSBP files.
 * Supports encoded/decoded attributes
-* Supporting encoded/decoded tags 1:1 with Nintendos offical tool and BB code Syntax.
-* Additonal tag manipulation.
+* Supporting encoded/decoded tags 1:1 with Nintendo's official tool and BB code Syntax.
+* Additional tag manipulation.
 
 This library is designed to support LMS revision 3.0 and above, with the associated file formats used across the following Nintendo platforms:
 * Wii (Specific titles only)
@@ -35,6 +35,8 @@ This library is designed to support LMS revision 3.0 and above, with the associa
 * Mobile (Specific titles only)
 * Nintendo Switch
 
+MSBF is in current in the works.
+
 # Features and Usage
 Simple preview of the library is below. See [the wiki](https://github.com/AbdyyEee/PylibMS/wiki) for more explanations and examples.
 ## Reading 
@@ -57,7 +59,7 @@ To add or edit Preset, you may create an issue with the relevant `yaml` file and
 ```
 pip install PylibMS
 ```
-[Pip Page](https://pypi.org/project/PyLibMS/0.6/)
+[Pip Page](https://pypi.org/project/PyLibMS/)
 
 # Build Instructions
 Python version must be `>=3.12.`

{pylibms-3.2.3 → pylibms-3.2.5}/PyLibMS.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 3.2.3
+Version: 3.2.5
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License: Copyright 2025 AbdyyEee
@@ -25,8 +25,8 @@ PylibMS is a library built in Python 3.10+ for the libMessageStudio (LMS) propri
 * Full reading and writing of MSBT files.
 * Full reading of MSBP files.
 * Supports encoded/decoded attributes
-* Supporting encoded/decoded tags 1:1 with Nintendos offical tool and BB code Syntax.
-* Additonal tag manipulation.
+* Supporting encoded/decoded tags 1:1 with Nintendo's official tool and BB code Syntax.
+* Additional tag manipulation.
 
 This library is designed to support LMS revision 3.0 and above, with the associated file formats used across the following Nintendo platforms:
 * Wii (Specific titles only)
@@ -35,6 +35,8 @@ This library is designed to support LMS revision 3.0 and above, with the associa
 * Mobile (Specific titles only)
 * Nintendo Switch
 
+MSBF is in current in the works.
+
 # Features and Usage
 Simple preview of the library is below. See [the wiki](https://github.com/AbdyyEee/PylibMS/wiki) for more explanations and examples.
 ## Reading 
@@ -57,7 +59,7 @@ To add or edit Preset, you may create an issue with the relevant `yaml` file and
 ```
 pip install PylibMS
 ```
-[Pip Page](https://pypi.org/project/PyLibMS/0.6/)
+[Pip Page](https://pypi.org/project/PyLibMS/)
 
 # Build Instructions
 Python version must be `>=3.12.`

{pylibms-3.2.3 → pylibms-3.2.5}/README.md

@@ -4,8 +4,8 @@ PylibMS is a library built in Python 3.10+ for the libMessageStudio (LMS) propri
 * Full reading and writing of MSBT files.
 * Full reading of MSBP files.
 * Supports encoded/decoded attributes
-* Supporting encoded/decoded tags 1:1 with Nintendos offical tool and BB code Syntax.
-* Additonal tag manipulation.
+* Supporting encoded/decoded tags 1:1 with Nintendo's official tool and BB code Syntax.
+* Additional tag manipulation.
 
 This library is designed to support LMS revision 3.0 and above, with the associated file formats used across the following Nintendo platforms:
 * Wii (Specific titles only)
@@ -14,6 +14,8 @@ This library is designed to support LMS revision 3.0 and above, with the associa
 * Mobile (Specific titles only)
 * Nintendo Switch
 
+MSBF is in current in the works.
+
 # Features and Usage
 Simple preview of the library is below. See [the wiki](https://github.com/AbdyyEee/PylibMS/wiki) for more explanations and examples.
 ## Reading 
@@ -36,7 +38,7 @@ To add or edit Preset, you may create an issue with the relevant `yaml` file and
 ```
 pip install PylibMS
 ```
-[Pip Page](https://pypi.org/project/PyLibMS/0.6/)
+[Pip Page](https://pypi.org/project/PyLibMS/)
 
 # Build Instructions
 Python version must be `>=3.12.`

{pylibms-3.2.3 → pylibms-3.2.5}/lms/message/section/atr1.py

@@ -39,6 +39,11 @@ def read_encoded_atr1(reader: FileReader, section_size: int) -> ATR1Data:
 
 
 def read_decoded_atr1(reader: FileReader, config: AttributeConfig) -> ATR1Data:
+    # String table as a list is not necessary for decoded attributes
+    # It is easier to save all changes from the user by when writing
+    # to recreate the table from all the string parameters in every attribute
+    string_table = None
+
     section_start = reader.tell()
 
     attr_count = reader.read_uint32()
@@ -63,7 +68,7 @@ def read_decoded_atr1(reader: FileReader, config: AttributeConfig) -> ATR1Data:
 
         attributes.append(LMS_FieldMap(attribute))
 
-    return ATR1Data(attributes, size_per_attribute, None)
+    return ATR1Data(attributes, size_per_attribute, string_table)
 
 
 def write_encoded_atr1(

{pylibms-3.2.3 → pylibms-3.2.5}/lms/message/tag/io/param_io.py

@@ -13,10 +13,11 @@ TAG_PADDING_BYTE = b"\xcd"
 
 def read_encoded_parameters(
     reader: FileReader, parameter_size: int
-) -> list[str] | None:
+) -> list[int] | None:
+
     hex_parameters = reader.read_bytes(parameter_size).hex().upper()
     encoded_parameters = [
-        f"{hex_parameters[i : i + 2]}" for i in range(0, len(hex_parameters), 2)
+        int(f"{hex_parameters[i : i + 2]}", 16) for i in range(0, len(hex_parameters), 2)
     ]
     return encoded_parameters
 
@@ -42,10 +43,10 @@ def read_decoded_parameters(
     return LMS_FieldMap(parameters)
 
 
-def write_encoded_parameters(writer: FileWriter, parameters: list[str]) -> None:
+def write_encoded_parameters(writer: FileWriter, parameters: list[int]) -> None:
     writer.write_uint16(len(parameters))
     for param in parameters:
-        writer.write_bytes(bytes.fromhex(param))
+        writer.write_bytes(int.to_bytes(param, 1))
 
 
 def write_decoded_parameters(

{pylibms-3.2.3 → pylibms-3.2.5}/lms/message/tag/io/tag_io.py

@@ -92,7 +92,7 @@ def _read_decoded_tag(
     return LMS_DecodedTag(definition, parameters)
 
 
-def write_tag(writer: FileWriter, tag: LMS_EncodedTag | LMS_DecodedTag) -> None:
+def write_tag(writer: FileWriter, tag: LMS_ControlTag) -> None:
     start_indicator, close_indicator = get_tag_indicator(
         writer.encoding, writer.is_big_endian
     )

{pylibms-3.2.3 → pylibms-3.2.5}/lms/message/tag/lms_tag.py

@@ -5,7 +5,7 @@ from lms.message.definitions.field.lms_field import LMS_FieldMap
 from lms.message.tag.lms_tagexceptions import LMS_InvalidTagFormatError
 from lms.titleconfig.definitions.tags import TagConfig, TagDefinition
 
-TAG_PADDING_CHAR = "CD"
+TAG_PADDING_CHAR = 0xCD
 
 
 class LMS_EncodedTag:
@@ -25,7 +25,7 @@ class LMS_EncodedTag:
         self,
         group_id: int,
         tag_index: int,
-        parameters: list[str] | None = None,
+        parameters: list[int] | None = None,
         is_fallback: bool = False,
         is_closing: bool = False,
     ):
@@ -50,13 +50,13 @@ class LMS_EncodedTag:
         return self._tag_index
 
     @property
-    def parameters(self) -> list[str] | None:
-        """The list of hex string parameters."""
+    def parameters(self) -> list[int] | None:
+        """The list of parameters."""
         return self._parameters
 
     @property
     def is_fallback(self) -> bool:
-        """Determines if the tag is a fallback tag."""
+        """Determines if the tag is a fallback tag. Fallback tags have a '!' prefix before the group index."""
         return self._is_fallback
 
     @property
@@ -73,7 +73,8 @@ class LMS_EncodedTag:
         if self._parameters is None:
             return f"[{self.group_id}:{self.tag_index}]"
 
-        parameters = "-".join(self._parameters)
+        # 02x format to convert any int to hexadecimal uppercase
+        parameters = "-".join(format(param, "02x").upper() for param in self._parameters)
         return f"[{fallback_prefix}{self.group_id}:{self.tag_index} {parameters}]"
 
     @classmethod
@@ -103,10 +104,13 @@ class LMS_EncodedTag:
 
         if not cls.PARAMETER_FORMAT.match(param_str):
             raise LMS_InvalidTagFormatError(
-                f"Malformed parameters located in tag: '{tag}'"
+                f"Parameters located in the tag '{tag}'. Ensure all parameters are separated by dashes."
             )
 
-        parameters = [param.strip().upper() for param in param_str.split("-")]
+        try:
+            parameters = [int(param.strip().upper()) for param in param_str.split("-")]
+        except ValueError:
+            raise LMS_InvalidTagFormatError(f"Malformed parameters in tag '{tag}'. Ensure all the parameters are integers.")
 
         # Ensure 0xCD padding is added
         if len(parameters) % 2 == 1:

{pylibms-3.2.3 → pylibms-3.2.5}/lms/project/msbp.py

@@ -12,7 +12,7 @@ class MSBP:
     https://nintendo-formats.com/libs/lms/msbp.html.
     """
 
-    MAGIC = "MsjPrjBn"
+    MAGIC = "MsgPrjBn"
 
     def __init__(
         self,

{pylibms-3.2.3 → pylibms-3.2.5}/lms/project/msbpread.py

@@ -15,7 +15,6 @@ from lms.project.section.syl3 import read_styles
 from lms.project.section.tag2 import read_tag2
 from lms.project.section.tgg2 import read_tgg2
 from lms.project.section.tgp2 import read_tgp2
-from PylibMS.lms.project.definitions.color import LMS_Color
 
 __all__ = ["read_msbp", "read_msbp_path"]
 

{pylibms-3.2.3 → pylibms-3.2.5}/lms/titleconfig/definitions/tags.py

@@ -56,7 +56,7 @@ class TagConfig:
 
 @dataclass(frozen=True)
 class TagDefinition:
-    """Class that represents a signle definition in the tag config."""
+    """Class that represents a single definition in the tag config."""
 
     group_name: str
     group_id: int

{pylibms-3.2.3 → pylibms-3.2.5}/lms/titleconfig/presets/Tomodachi Life.yaml

@@ -4295,7 +4295,7 @@ attribute_definitions:
   description: ''
   definitions:
   - name: FileID
-    description: ''
+    description: 'The ID (located in the filename) of for the texture of the item.'
     datatype: int16
   - name: RegionJP
     description: 'Flag that determines if the item is enabled for Japenese regions of the game.'
@@ -4322,28 +4322,28 @@ attribute_definitions:
     - Disable
     - Enable
   - name: Price
-    description: ''
+    description: 'The price of the item in the JP version.'
     datatype: uint32
   - name: PriceUS
-    description: ''
+    description: 'The price of the item in the US version.'
     datatype: uint32
   - name: PriceEU
-    description: ''
+    description: 'The price of the item in the EU version.'
     datatype: uint32
   - name: PriceKR
-    description: ''
+    description: 'The price of the item in the KR version.'
     datatype: uint32
   - name: Shop
-    description: ''
-    datatype: uint8
+    description: 'Determines if the item can be sold at the shop.'
+    datatype: bool
   - name: Mii
     description: ''
-    datatype: uint8
+    datatype: bool
   - name: Food_FirstDaily
     description: ''
     datatype: uint8
   - name: BoxSize
-    description: ''
+    description: 'How large the the item texture will appear when displayed.'
     datatype: list
     list_items:
     - BoxSize_None
@@ -4351,7 +4351,7 @@ attribute_definitions:
     - BoxSize_Small
     - BoxSize_Big
   - name: Effect
-    description: ''
+    description: 'The steam effect of the item.'
     datatype: list
     list_items:
     - None
@@ -4359,7 +4359,7 @@ attribute_definitions:
     - Steam01
     - Steam02
   - name: Food_Type_JP
-    description: ''
+    description: 'The food type of the item for the JP version.'
     datatype: list
     list_items:
     - Japanese
@@ -4368,7 +4368,7 @@ attribute_definitions:
     - Dessert
     - Drink
   - name: Food_Type_USEU
-    description: ''
+    description: 'The food type of the item for both EU and US versions.'
     datatype: list
     list_items:
     - MainDishes
@@ -4376,7 +4376,7 @@ attribute_definitions:
     - Refreshments
     - Drinks
   - name: Food_Type_KR
-    description: ''
+    description: 'The food type of the item for the KR version.'
     datatype: list
     list_items:
     - Korean
@@ -4392,7 +4392,7 @@ attribute_definitions:
     - Quantity_Mid
     - Quantity_High
   - name: Food_Season
-    description: ''
+    description: 'Determines which season the item falls into.'
     datatype: list
     list_items:
     - Season_None
@@ -4401,94 +4401,94 @@ attribute_definitions:
     - Season_Autumn
     - Season_Winter
   - name: Food_Attr_Sweet
-    description: ''
+    description: 'Flag that determines if the food is considered sweet.'
     datatype: bool
   - name: Food_Attr_Spicy
-    description: ''
+    description: 'Flag that determines if the food is considered spicy.'
     datatype: bool
   - name: Food_Attr_Salty
-    description: ''
+    description: 'Flag that determines if the food is considered salty.'
     datatype: bool
   - name: Food_Attr_Sour
-    description: ''
+    description: 'Flag that determines if the food is considered sour.'
     datatype: bool
   - name: Food_Attr_Oily
-    description: ''
+    description: 'Flag that determines if the food is considered oily.'
     datatype: bool
   - name: Food_Attr_Cool
-    description: ''
+    description: 'Flag that determines if the food is considered cool.'
     datatype: bool
   - name: Food_Attr_Hot
-    description: ''
+    description: 'Flag that determines if the food is considered hot.'
     datatype: bool
   - name: Food_Attr_Awful
-    description: ''
+    description: 'Flag that determines if the food is considered dog water.'
     datatype: bool
   - name: Food_Attr_Confectionery
-    description: ''
+    description: 'Flag that determines if the food is considered a confectionery.'
     datatype: bool
   - name: Food_Attr_Fruit
-    description: ''
+    description: 'Flag that determines if the food is a fruit or has fruits as a main ingredient..'
     datatype: bool
   - name: Food_Attr_Vegetable
-    description: ''
+    description: 'Flag that determines if the food is a vegetable or has vegetables as a main ingredient.'
     datatype: bool
   - name: Food_Attr_Rice
-    description: ''
+    description: 'Flag that determines if the food is rice or has rice as a main ingredient.'
     datatype: bool
   - name: Food_Attr_Bread
-    description: ''
+    description: 'Flag that determines if the food is bread or has bread as a main ingredient.'
     datatype: bool
   - name: Food_Attr_Meat
-    description: ''
+    description: 'Flag that determines if the food is meat or has meat as a main ingredient.'
     datatype: bool
   - name: Food_Attr_Fish
-    description: ''
+    description: 'Flag that determines if the food is fish or has fish as a main ingredient.'
     datatype: bool
   - name: Food_Attr_Egg
-    description: ''
+    description: 'Flag that determines if the food is egg or has egg as a main ingredient.'
     datatype: bool
   - name: Food_Attr_Japanese
-    description: ''
+    description: 'Flag that determines if the food considered Japanese.'
     datatype: bool
   - name: Food_Attr_Western
-    description: ''
+    description: 'Flag that determines if the food is considered western.'
     datatype: bool
   - name: Food_Attr_Chinese
-    description: ''
+    description: 'Flag that determines if the food is considered Chinese.'
     datatype: bool
   - name: Food_Attr_Italian
-    description: ''
+    description: 'Flag that determines if the food is considered Italian.'
     datatype: bool
   - name: Food_Attr_Noodle
-    description: ''
+    description: 'Flag that determines if the food has noodles as a main ingredient.'
     datatype: bool
   - name: Food_Attr_Luxury
-    description: ''
+    description: 'Flag that determines if the food is considered luxurious'
     datatype: bool
   - name: Food_Attr_American
-    description: ''
+    description: 'Flag that determines if the food is considered American.'
     datatype: bool
   - name: Food_Attr_Asian
-    description: ''
+    description: 'Flag that determines if the food is considered Asian.'
     datatype: bool
   - name: Food_Attr_British
-    description: ''
+    description: 'Flag that determines if the food is considered British.'
     datatype: bool
   - name: Food_Attr_French
-    description: ''
+    description: 'Flag that determines if the food is considered French.'
     datatype: bool
   - name: Food_Attr_German
-    description: ''
+    description: 'Flag that determines if the food is considered German.'
     datatype: bool
   - name: Food_Attr_Spanish
-    description: ''
+    description: 'Flag that determines if the food is considered Spanish.'
     datatype: bool
   - name: Food_Attr_Junk
-    description: ''
+    description: 'Flag that determines if the food is considered as junk food.'
     datatype: bool
   - name: Food_Attr_Korean
-    description: ''
+    description: 'Flag that determines if the food is considered Korean.'
     datatype: bool
   - name: Food_NTR_ID
     description: ''
@@ -4574,7 +4574,7 @@ attribute_definitions:
     - '14'
     - '15'
   - name: Food_Se_Type
-    description: ''
+    description: 'The sound effect played when the food is consumed.'
     datatype: list
     list_items:
     - SE_MII_DRINK
@@ -4598,7 +4598,7 @@ attribute_definitions:
     description: ''
     datatype: uint8
   - name: Treasure_Type
-    description: ''
+    description: 'The type the treasure falls into.'
     datatype: list
     list_items:
     - TreasureToken
@@ -4636,7 +4636,7 @@ attribute_definitions:
     description: ''
     datatype: int32
   - name: Food_FirstCatalog
-    description: ''
+    description: 'Flag that determines if the food will be displayed on the first shop event played on a new save.'
     datatype: bool
   - name: ForIslanderOnly
     description: ''

{pylibms-3.2.3 → pylibms-3.2.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "PyLibMS"
-version = "3.2.3"
+version = "3.2.5"
 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"