PyLibMS 2.0.4__tar.gz → 2.0.6__tar.gz

{pylibms-2.0.4 → pylibms-2.0.6}/LMS/Field/LMS_Field.py

@@ -1,7 +1,7 @@
 from dataclasses import dataclass, field
 
-from LMS.TitleConfig.Definitions.Value import ValueDefinition
 from LMS.Field.LMS_DataType import LMS_DataType
+from LMS.TitleConfig.Definitions.Value import ValueDefinition
 
 
 class LMS_Field:

{pylibms-2.0.4 → pylibms-2.0.6}/LMS/Field/Stream.py

@@ -1,7 +1,7 @@
-from LMS.TitleConfig.Definitions.Value import ValueDefinition
 from LMS.Field.LMS_DataType import LMS_DataType
 from LMS.Field.LMS_Field import LMS_Field
 from LMS.FileIO.Stream import FileReader, FileWriter
+from LMS.TitleConfig.Definitions.Value import ValueDefinition
 
 
 def read_field(reader: FileReader, definition: ValueDefinition) -> LMS_Field:

{pylibms-2.0.4 → pylibms-2.0.6}/LMS/Message/Definitions/LMS_MessageText.py

@@ -1,11 +1,10 @@
 import re
 from typing import overload
 
-from LMS.TitleConfig.Config import TagConfig
 from LMS.Field.LMS_Field import LMS_Field
 from LMS.Message.Tag.LMS_Tag import LMS_DecodedTag, LMS_EncodedTag, LMS_TagBase
-from LMS.Message.Tag.Tag_Formats import (DECODED_FORMAT, ENCODED_FORMAT,
-                                         TAG_FORMAT)
+from LMS.Message.Tag.Tag_Formats import DECODED_FORMAT, ENCODED_FORMAT, TAG_FORMAT
+from LMS.TitleConfig.Config import TagConfig
 
 
 class LMS_MessageText:

{pylibms-2.0.4 → pylibms-2.0.6}/LMS/Message/MSBTStream.py

@@ -3,16 +3,23 @@ from typing import BinaryIO
 from LMS.Common import LMS_Exceptions
 from LMS.Common.Stream.FileInfo import read_file_info, write_file_info
 from LMS.Common.Stream.Hashtable import read_labels, write_labels
-from LMS.Common.Stream.Section import (read_section_data, write_section,
-                                       write_unsupported_section)
-from LMS.TitleConfig.Config import AttributeConfig, TagConfig
+from LMS.Common.Stream.Section import (
+    read_section_data,
+    write_section,
+    write_unsupported_section,
+)
 from LMS.FileIO.Stream import FileReader, FileWriter
 from LMS.Message.MSBT import MSBT
 from LMS.Message.MSBTEntry import MSBTEntry
-from LMS.Message.Section.ATR1 import (read_decoded_atr1, read_encoded_atr1,
-                                      write_decoded_atr1, write_encoded_atr1)
+from LMS.Message.Section.ATR1 import (
+    read_decoded_atr1,
+    read_encoded_atr1,
+    write_decoded_atr1,
+    write_encoded_atr1,
+)
 from LMS.Message.Section.TSY1 import read_tsy1, write_tsy1
 from LMS.Message.Section.TXT2 import read_txt2, write_txt2
+from LMS.TitleConfig.Config import AttributeConfig, TagConfig
 
 
 def read_msbt(

{pylibms-2.0.4 → pylibms-2.0.6}/LMS/Message/Section/ATR1.py

@@ -1,9 +1,9 @@
-from LMS.TitleConfig.Definitions.Attributes import AttributeConfig
 from LMS.Field.LMS_DataType import LMS_DataType
 from LMS.Field.LMS_Field import LMS_DataType, LMS_Field
 from LMS.Field.Stream import read_field, write_field
 from LMS.FileIO.Stream import FileReader, FileWriter
 from LMS.Message.Definitions.LMS_FieldMap import LMS_FieldMap
+from LMS.TitleConfig.Definitions.Attributes import AttributeConfig
 
 
 def read_encoded_atr1(

{pylibms-2.0.4 → pylibms-2.0.6}/LMS/Message/Section/TXT2.py

@@ -1,9 +1,9 @@
-from LMS.TitleConfig.Definitions.Tags import TagConfig
 from LMS.FileIO.Encoding import FileEncoding
 from LMS.FileIO.Stream import FileReader, FileWriter
 from LMS.Message.Definitions.LMS_MessageText import LMS_MessageText
 from LMS.Message.Tag.LMS_Tag import LMS_TagBase
 from LMS.Message.Tag.Stream import read_tag, write_tag
+from LMS.TitleConfig.Definitions.Tags import TagConfig
 
 
 def read_txt2(

{pylibms-2.0.4 → pylibms-2.0.6}/LMS/Message/Tag/LMS_Tag.py

@@ -1,12 +1,11 @@
 import re
 from abc import ABC, abstractmethod
 
-from LMS.TitleConfig.Definitions.Tags import TagConfig
 from LMS.Field.LMS_Field import LMS_Field, cast_value
 from LMS.Message.Definitions.LMS_FieldMap import LMS_FieldMap
 from LMS.Message.Tag.LMS_TagExceptions import LMS_InvalidTagFormatError
-from LMS.Message.Tag.Tag_Formats import (DECODED_FORMAT, ENCODED_FORMAT,
-                                         PARAMETER_FORMAT)
+from LMS.Message.Tag.Tag_Formats import DECODED_FORMAT, ENCODED_FORMAT, PARAMETER_FORMAT
+from LMS.TitleConfig.Definitions.Tags import TagConfig
 
 
 class LMS_TagBase(ABC):

{pylibms-2.0.4 → pylibms-2.0.6}/LMS/Message/Tag/Stream.py

@@ -1,12 +1,15 @@
-from LMS.TitleConfig.Definitions.Tags import TagConfig, TagDefinition
 from LMS.Field.LMS_DataType import LMS_DataType
 from LMS.Field.LMS_Field import LMS_Field
 from LMS.Field.Stream import read_field, write_field
 from LMS.FileIO.Stream import FileReader, FileWriter
 from LMS.Message.Definitions.LMS_FieldMap import LMS_FieldMap
 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.LMS_TagExceptions import (
+    LMS_TagReadingError,
+    LMS_TagWritingException,
+)
+from LMS.Message.Tag.System_Definition import SYSTEM_GROUP
+from LMS.TitleConfig.Definitions.Tags import TagConfig, TagDefinition
 
 
 def read_tag(
@@ -18,7 +21,8 @@ def read_tag(
 ) -> LMS_EncodedTag | LMS_DecodedTag:
     end = reader.tell() + param_size
 
-    if config is None:
+    # System tags of group 0 are always defined, ensure they are read like any other decoded tag by default
+    if config is None and group_index > 0:
         parameters = _read_encoded_parameters(reader, param_size)
 
         if parameters is None:
@@ -26,7 +30,10 @@ def read_tag(
 
         return LMS_EncodedTag(group_index, tag_index, parameters)
 
-    definition = config.get_definition_by_indexes(group_index, tag_index)
+    if group_index == 0:
+        definition = SYSTEM_GROUP[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, read them.
     # This is to account for encoded tags that group have tag names attatched.
@@ -59,20 +66,20 @@ def write_tag(writer: FileWriter, tag: LMS_TagBase) -> None:
 
     if tag.parameters is None:
         writer.write_uint16(0)
-        return None
+        return
 
     if isinstance(tag, LMS_EncodedTag):
         _write_encoded_parameters(writer, tag.parameters)
     else:
         _write_decoded_parameters(writer, tag)
 
-    return None
+    return
 
 
 # --
 def _read_encoded_parameters(reader: FileReader, param_size: int) -> list[str] | None:
     if param_size == 0:
-        return None
+        return
 
     hex_parameters = reader.read_bytes(param_size).hex().upper()
     encoded_parameters = [
@@ -88,8 +95,11 @@ def _write_encoded_parameters(writer: FileWriter, parameters: list[str] | None)
 
 
 def _read_decoded_parameters(
-    reader: FileReader, definition: TagDefinition
-) -> LMS_FieldMap:
+    reader: FileReader, definition: TagDefinition | None
+) -> LMS_FieldMap | None:
+    if definition.parameters is None:
+        return
+
     parameters = {}
     for param in definition.parameters:
         param_offset = reader.tell()

pylibms-2.0.6/LMS/Message/Tag/System_Definition.py

@@ -0,0 +1,83 @@
+from LMS.Field.LMS_DataType import LMS_DataType
+from LMS.TitleConfig.Definitions.Tags import TagDefinition
+from LMS.TitleConfig.Definitions.Value import ValueDefinition
+
+RUBY_TAG = TagDefinition(
+    group_name="System",
+    group_index=0,
+    tag_name="Ruby",
+    tag_index=0,
+    description="Displays a RUBY character.",
+    parameters=[
+        ValueDefinition(
+            name="rt", description="The ruby character.", datatype=LMS_DataType.STRING
+        )
+    ],
+)
+
+FONT_TAG = TagDefinition(
+    group_name="System",
+    group_index=0,
+    tag_name="Font",
+    tag_index=1,
+    description="Sets the font file of text.",
+    parameters=[
+        ValueDefinition(
+            name="face", description="The font face name.", datatype=LMS_DataType.STRING
+        )
+    ],
+)
+
+SIZE_TAG = TagDefinition(
+    group_name="System",
+    group_index=0,
+    tag_name="Size",
+    tag_index=2,
+    description="Alters the size of text.",
+    parameters=[
+        ValueDefinition(
+            name="percent",
+            description="The new size as a percent.",
+            datatype=LMS_DataType.UINT16,
+        )
+    ],
+)
+COLOR_TAG = TagDefinition(
+    group_name="System",
+    group_index=0,
+    tag_name="Color",
+    tag_index=3,
+    description="Sets the color of text in a message in RGBA form.",
+    parameters=[
+        ValueDefinition(
+            name="r", description="The red color value.", datatype=LMS_DataType.UINT8
+        ),
+        ValueDefinition(
+            name="g", description="The green color value.", datatype=LMS_DataType.UINT8
+        ),
+        ValueDefinition(
+            name="b", description="The blue color value.", datatype=LMS_DataType.UINT8
+        ),
+        ValueDefinition(
+            name="a",
+            description="The alpha transprency value.",
+            datatype=LMS_DataType.UINT8,
+        ),
+    ],
+)
+
+PAGEBREAK_TAG = TagDefinition(
+    group_name="System",
+    group_index=0,
+    tag_name="PageBreak",
+    tag_index=4,
+    description="Displays text in the same label on different pages.",
+)
+
+SYSTEM_GROUP = {
+    0: RUBY_TAG,
+    1: FONT_TAG,
+    2: SIZE_TAG,
+    3: COLOR_TAG,
+    4: PAGEBREAK_TAG,
+}

{pylibms-2.0.4 → pylibms-2.0.6}/LMS/TitleConfig/Config.py

@@ -3,11 +3,11 @@ from typing import Self
 
 import yaml
 
+from LMS.Field.LMS_DataType import LMS_DataType
+from LMS.Project.MSBP import MSBP
 from LMS.TitleConfig.Definitions.Attributes import AttributeConfig
 from LMS.TitleConfig.Definitions.Tags import TagConfig, TagDefinition
 from LMS.TitleConfig.Definitions.Value import ValueDefinition
-from LMS.Field.LMS_DataType import LMS_DataType
-from LMS.Project.MSBP import MSBP
 
 
 class TitleConfig:
@@ -15,12 +15,14 @@ class TitleConfig:
 
     # Populate the preset list from the directory
     PRESET_LIST = [
-            file.name.removesuffix(".yaml")
-            for file in resources.files("LMS.TitleConfig.Presets").iterdir()
-            if file.name.endswith(".yaml")
-        ]
-
-    def __init__(self, attribute_configs: dict[str, AttributeConfig], tag_config: TagConfig):
+        file.name.removesuffix(".yaml")
+        for file in resources.files("LMS.TitleConfig.Presets").iterdir()
+        if file.name.endswith(".yaml")
+    ]
+
+    def __init__(
+        self, attribute_configs: dict[str, AttributeConfig], tag_config: TagConfig
+    ):
         self._attribute_configs = attribute_configs
         self._tag_config = tag_config
 
@@ -61,22 +63,15 @@ class TitleConfig:
         else:
             parsed_content = content
 
-        group_map = {0: "System"}
-        tag_config = []
-
-        # Add the System tag definitions to the config
-        with resources.open_text("LMS.Message.Tag", "System.yaml") as f:
-            system_tags = yaml.safe_load(f)
-            tag_config = system_tags
-
+        raw_tag_config = []
         # Combine with the rest of the cofnig
-        group_map |= parsed_content["tag_definitions"]["groups"]
+        group_map = parsed_content["tag_definitions"]["groups"]
         for tag_def in parsed_content["tag_definitions"]["tags"]:
-            tag_config.append(tag_def)
+            raw_tag_config.append(tag_def)
 
         # Load tag definitions
         tag_definitions = []
-        for tag_def in tag_config:
+        for tag_def in raw_tag_config:
             tag_name = tag_def["name"]
             group_index, tag_index = tag_def["group_index"], tag_def["tag_index"]
             group_name = group_map[group_index]
@@ -92,7 +87,11 @@ class TitleConfig:
                     param_description = param_def["description"]
                     datatype = LMS_DataType.from_string(param_def["datatype"])
                     list_items = param_def.get("list_items")
-                    parameters.append(ValueDefinition(param_name, param_description, datatype, list_items))
+                    parameters.append(
+                        ValueDefinition(
+                            param_name, param_description, datatype, list_items
+                        )
+                    )
 
             tag_definitions.append(
                 TagDefinition(
@@ -121,7 +120,9 @@ class TitleConfig:
                 definition = ValueDefinition(name, description, datatype, list_items)
                 definitions.append(definition)
 
-            structure = AttributeConfig(structure_name, structure["description"], definitions)
+            structure = AttributeConfig(
+                structure_name, structure["description"], definitions
+            )
             attribute_config[structure_name] = structure
 
         return cls(attribute_config, tag_config)
@@ -151,7 +152,9 @@ class TitleConfig:
         # 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:])},
+            "groups": {
+                i + 1: group.name for i, group in enumerate(project.tag_groups[1:])
+            },
             "tags": [],
         }
 

{pylibms-2.0.4 → pylibms-2.0.6}/LMS/TitleConfig/Definitions/Tags.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 
 from LMS.TitleConfig.Definitions.Value import ValueDefinition
 
@@ -14,7 +14,7 @@ class TagDefinition:
     tag_name: str
     tag_index: int
     description: str
-    parameters: list[ValueDefinition] | None
+    parameters: list[ValueDefinition] = field(default=None)
 
 
 @dataclass(frozen=True)

{pylibms-2.0.4 → pylibms-2.0.6}/LMS/TitleConfig/Definitions/Value.py

@@ -1,4 +1,4 @@
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 
 from LMS.Field.LMS_DataType import LMS_DataType
 
@@ -8,4 +8,4 @@ class ValueDefinition:
     name: str
     description: str
     datatype: LMS_DataType
-    list_items: dict[int, str]
+    list_items: dict[int, str] = field(default=None)

pylibms-2.0.6/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md LICENSE
+recursive-include LMS/TitleConfig/Presets *.yaml

{pylibms-2.0.4 → pylibms-2.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 2.0.4
+Version: 2.0.6
 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.0.4 → pylibms-2.0.6}/PyLibMS.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 2.0.4
+Version: 2.0.6
 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.0.4 → pylibms-2.0.6}/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.yaml
+LMS/Message/Tag/System_Definition.py
 LMS/Message/Tag/Tag_Formats.py
 LMS/Message/Tag/__init__.py
 LMS/Project/MSBP.py

{pylibms-2.0.4 → pylibms-2.0.6}/pyproject.toml

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

pylibms-2.0.4/LMS/Message/Tag/System.yaml

@@ -1,47 +0,0 @@
-- name: Ruby
-  group_index: 0
-  tag_index: 0
-  description: 'Displays a RUBY character.'
-  parameters:
-  - name: rt
-    description: 'The ruby character.'
-    datatype: string
-- name: Font
-  group_index: 0
-  tag_index: 1
-  description: 'Sets the font file of text.'
-  parameters:
-  - name: face
-    description: 'The font face name.'
-    datatype: string
-- name: Size
-  group_index: 0
-  tag_index: 2
-  description: 'Alters the size of text.'
-  parameters:
-  - name: percent
-    description: 'The new size as a percent.'
-    datatype: uint16
-- name: Color
-  group_index: 0
-  tag_index: 3
-  description: 'Sets the color of text in a message in RGBA form.'
-  parameters:
-  - name: r
-    description: 'The red color value.'
-    datatype: uint8
-  - name: g
-    description: 'The green color value.'
-    datatype: uint8
-  - name: b
-    description: 'The blue color value.'
-    datatype: uint8
-  - name: a
-    description: 'The alpha transprency value.'
-    datatype: uint8
-- name: PageBreak
-  group_index: 0
-  tag_index: 4
-  description: 'Displays text in the same label on different pages.'
-  parameters: []
-  

pylibms-2.0.4/MANIFEST.in

@@ -1,3 +0,0 @@
-include README.md LICENSE
-include LMS/Message/Tag/System.yaml
-recursive-include LMS/TitleConfig/Presets *.yaml