PyLibMS 4.3.2__tar.gz → 4.3.4__tar.gz

{pylibms-4.3.2 → pylibms-4.3.4}/PKG-INFO

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

{pylibms-4.3.2 → pylibms-4.3.4}/PyLibMS.egg-info/PKG-INFO

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

{pylibms-4.3.2 → pylibms-4.3.4}/lms/common/lms_constants.py

@@ -1,4 +1,6 @@
 # Common constant definitions between files
+LMS_MINIMUM_VERSION = 3
+
 PADDING_BYTE = b"\x00"
 
 SIZE_OFFSET = 0x12

{pylibms-4.3.2 → pylibms-4.3.4}/lms/common/stream/fileinfo.py

@@ -3,7 +3,7 @@ from lms.common.lms_constants import (
     BIG_ENDIAN_BOM,
     SECTION_DATA_START,
     LITTLE_ENDIAN_BOM,
-    SIZE_OFFSET,
+    SIZE_OFFSET, LMS_MINIMUM_VERSION,
 )
 from lms.common.lms_fileinfo import LMS_FileInfo
 from lms.fileio.encoding import FileEncoding
@@ -29,7 +29,7 @@ def read_file_info(reader: FileReader, expected_magic: str) -> LMS_FileInfo:
 
     version = reader.read_uint8()
 
-    if version < 3:
+    if version < LMS_MINIMUM_VERSION:
         raise lms_exceptions.LMS_UnsupportedFileVersionError(
             "Only version 3+ files are supported!"
         )

{pylibms-4.3.2 → pylibms-4.3.4}/lms/flowchart/definitions/node.py

@@ -185,7 +185,7 @@ class LMS_MessageNode(LMS_BaseNode):
 
     @property
     def msbt(self) -> MSBT | None:
-        """MSBT instance the node references. Optional, and must be set with `set_msbt` or by  providing a MSBT file on reading."""
+        """MSBT instance the node references. Optional, is set by providing a MSBT file on reading."""
         return self._msbt
 
     @property
@@ -313,26 +313,33 @@ class LMS_BranchNode(LMS_BaseNode):
             case_map.setdefault(branch, []).append(case)
 
         if self.definition is not None:
-            if self.definition.case_options:
+            definition: NodeDefinition = self.definition
+
+            if definition.case_options:
                 for case, branch in self._branches.items():
-                    case_message = self.definition.case_options.get(
-                        case, f"Case {case}"
+                    case_format = definition.case_options.get(
+                        case, None,
                     )
 
-                    result.append(((case,), case_message, branch))
+                    if case_format is None:
+                        formatted_message = f"Case {case}"
+                    else:
+                        formatted_message = self._format_case_message(case, case_format)
+
+                    result.append(((case,), formatted_message, branch))
 
                 return result
 
-            if self.definition.case_format is not None:
+            if definition.case_format is not None:
                 if compress_shared_references:
                     for branch, cases in case_map.items():
                         case_message = self._format_case_message(
-                            merge_shared_cases(cases)
+                            merge_shared_cases(cases), definition.case_format
                         )
                         result.append((tuple(cases), case_message, branch))
                 else:
                     for case, branch in self._branches.items():
-                        case_message = self._format_case_message(case)
+                        case_message = self._format_case_message(case, definition.case_format)
                         result.append(((case,), case_message, branch))
 
                 return result
@@ -352,8 +359,8 @@ class LMS_BranchNode(LMS_BaseNode):
 
         return result
 
-    def _format_case_message(self, case_prefix: str):
-        prefix = string.Template(self._definition.case_format)
+    def _format_case_message(self, case_prefix: str, case_format: str):
+        prefix = string.Template(case_format)
 
         # Unpack dict for formatting $case and $param formats
         # Allows inserting parameter values dynamically into the case message

{pylibms-4.3.2 → pylibms-4.3.4}/lms/flowchart/msbf.py

@@ -22,14 +22,17 @@ class MSBF:
     """
 
     MAGIC = "MsgFlwBn"
-
     DEFAULT_SLOT_COUNT = 59
 
     def __init__(
             self, info: LMS_FileInfo | None = None, flowcharts: list[LMS_Flowchart] = None
     ):
         self._info = info if info is not None else LMS_FileInfo()
-        self._shared_references: dict[int, LMS_BaseNode] = {}
+
+        # While unlikely to vary, and have yet to find a file that changes the slot count (unlike MSBT)
+        # it is wiser to store an editable attribute just in case a game decides to vary the amount.
+        self.slot_count = MSBF.DEFAULT_SLOT_COUNT
+
         self._flowcharts = flowcharts or []
         self._nodes: dict[int, LMS_BaseNode] = {}
         self._global_node_id = 0
@@ -77,7 +80,11 @@ class MSBF:
         )
 
     def get_flowchart_references(self, node_id: int) -> set[LMS_Flowchart]:
-        """References of nodes between flowcharts."""
+        """
+        Determines which flowcharts contain this node.
+
+        :param node_id: The node to find references for.
+        """
         return {flowchart for flowchart in self._flowcharts if node_id in flowchart.nodes}
 
     def register_node(self, node: LMS_BaseNode, flowchart: LMS_Flowchart = None) -> None:
@@ -85,7 +92,7 @@ class MSBF:
         Registers a node to the MSBF instance.
 
         :param node: The node to register.
-        :param flowchart: optional argument that registers the node to that flowchart.
+        :param flowchart: Optional argument that registers the node to that flowchart.
         """
         if not isinstance(node, LMS_BaseNode):
             raise TypeError(
@@ -135,10 +142,6 @@ class MSBF:
         if flowchart_name in self.flowcharts:
             raise KeyError(f"Flowchart with name '{flowchart_name}' already exists!")
 
-        # Node IDs may not be sequential after user additions/deletions, so we track the absolute max value of
-        # all nodes and store it so that _generate_next_id can set any IDs added via the flowchart correctly.
-        self._global_node_id = max((node.id for flowchart in self for node in flowchart), default=1) + 1
-
         if entry_point is None:
             entry_point = LMS_EntryNode(self._generate_next_id(), flowchart_name)
 
@@ -150,6 +153,11 @@ class MSBF:
                 self._nodes[node_id] = node
 
         self._nodes = dict(sorted(self._nodes.items()))
+
+        # Node IDs may not be sequential after user additions/deletions, so we track the absolute max value of
+        # all nodes and store it so that _generate_next_id can set any IDs added via the flowchart correctly.
+        self._global_node_id = max(self._nodes, default=-1) + 1
+
         return flowchart
 
     def delete_flowchart(self, name: str):

{pylibms-4.3.2 → pylibms-4.3.4}/lms/flowchart/msbfio.py

@@ -59,13 +59,12 @@ def read_msbf(
     file_info = read_file_info(reader, MSBF.MAGIC)
 
     msbf = MSBF(file_info)
-
     for magic, size in read_section_data(reader, file_info.section_count):
         match magic:
             case "FLW3":
                 entry_nodes = read_flw3(reader, config, msbt)
             case "FEN1":
-                labels, _ = read_labels(reader)
+                labels, slot_count = read_labels(reader)
             case "REF1":
                 raise LMS_UnsupportedSectionError("""REF1 was found in the MSBF file! Please report this file as an issue
                                                   in the PyLibMS repository https://github.com/AbdyyEee/PylibMS""")
@@ -74,6 +73,7 @@ def read_msbf(
         entry_nodes[i].flowchart_name = label
         msbf.add_flowchart(label, entry_nodes[i])
 
+    msbf.slot_count = slot_count
     return msbf
 
 
@@ -115,12 +115,6 @@ def write_msbf(file: MSBF) -> bytes:
     # Saved here so ids aren't mutated in the current state
     stream_ids = {node: stream_id for stream_id, node in enumerate(file.nodes.values())}
 
-    for chart in file:
-        if amount := len(chart.get_dangling_nodes()):
-            raise LMS_Error(
-                f"Unable to write the flowchart '{chart.name}'! There are {amount} dangling nodes."
-            )
-
     index_map = {
         flowchart.name: stream_ids[flowchart.entry_point] for flowchart in file
     }
@@ -131,7 +125,7 @@ def write_msbf(file: MSBF) -> bytes:
         "FEN1",
         write_labels,
         list(file.flowcharts.keys()),
-        MSBF.DEFAULT_SLOT_COUNT,
+        file.slot_count,
         index_map,
     )
     write_file_size(writer)

{pylibms-4.3.2 → pylibms-4.3.4}/lms/project/section/tag2.py

@@ -5,7 +5,8 @@ from lms.project.definitions.tag import LMS_TagDefinition
 def read_tag2(reader: FileReader) -> list[LMS_TagDefinition]:
     info_list = []
 
-    count = reader.read_uint32()
+    count = reader.read_uint16()
+    reader.skip(2)
     for offset in reader.read_offset_array(count):
         reader.seek(offset)
 
@@ -14,5 +15,6 @@ def read_tag2(reader: FileReader) -> list[LMS_TagDefinition]:
         name = reader.read_encoded_string()
 
         info_list.append(LMS_TagDefinition(name, parameter_indices))
+        reader.align(4)
 
     return info_list

{pylibms-4.3.2 → pylibms-4.3.4}/lms/project/section/tgg2.py

@@ -5,7 +5,8 @@ from lms.project.definitions.tag import LMS_TagGroup
 def read_tgg2(reader: FileReader, version: int) -> list[LMS_TagGroup]:
     group_list = []
 
-    count = reader.read_uint32()
+    count = reader.read_uint16()
+    reader.skip(2)
     for i, offset in enumerate(reader.read_offset_array(count)):
         reader.seek(offset)
 
@@ -18,5 +19,6 @@ def read_tgg2(reader: FileReader, version: int) -> list[LMS_TagGroup]:
 
         name = reader.read_encoded_string()
         group_list.append(LMS_TagGroup(name, group_id, tag_indexes))
+        reader.align(4)
 
     return group_list

{pylibms-4.3.2 → pylibms-4.3.4}/lms/project/section/tgp2.py

@@ -6,7 +6,8 @@ from lms.project.definitions.tag import LMS_TagParamDefinition
 def read_tgp2(reader: FileReader) -> list[LMS_TagParamDefinition]:
     parameter_info = []
 
-    count = reader.read_uint32()
+    count = reader.read_uint16()
+    reader.skip(2)
     for offset in reader.read_offset_array(count):
         reader.seek(offset)
 
@@ -24,5 +25,6 @@ def read_tgp2(reader: FileReader) -> list[LMS_TagParamDefinition]:
         parameter_info.append(
             LMS_TagParamDefinition(name, LMS_DataType.LIST, list_indexes)
         )
+        reader.align(4)
 
     return parameter_info

{pylibms-4.3.2 → pylibms-4.3.4}/lms/titleconfig/config.py

@@ -29,31 +29,16 @@ class TitleConfig:
     NODE_KEY = "node_definitions"
 
     GAME_PRESET = Literal[
-        "Animal Crossing: City Folk",
-        "Animal Crossing: New Horizons",
-        "Animal Crossing: New Leaf",
-        "The Legend of Zelda: Echoes of Wisdom"
-        "Metroid Prime 4: Beyond"
-        "Mario vs. Donkey Kong"
-        "Paper Mario: Color Splash"
-        "Paper Mario: Sticker Star"
-        "Paper Mario: The Origami King"
-        "Paper Mario: The Thousand-Year Door (Nintendo Switch)"
-        "Super Mario 3D Land"
-        "Super Mario 3D World + Bowser's Fury"
-        "Super Mario Odyssey"
-        "Splatoon 3"
-        "The Legend of Zelda: Link's Awakening (Nintendo Switch)"
-        "The Legend of Zelda a Link Between Worlds",
-        "The Legend of Zelda: Tri Force Heroes"
-        "Tomodachi Life (NA-EU)",
-        "Tomodachi Life (JP)",
-        "Tomodachi Life: Living the Dream",
-        "The Legend of Zelda: Tears of the Kingdom"
-        "Wii Sports Club"
+        "Badge Arcade",
         "Brain Age Concentration Training",
         "Kirby Planet Robobot",
         "Super Mario Odyssey",
+        "Super Mario 3D Land",
+        "Super Mario 3D World + Bowsers Fury",
+        "The Legend of Zelda a Link Between Worlds",
+        "The Legend of Zelda Echos of Wisdom",
+        "Tomodachi Life Living The Dream",
+        "Tomodachi Life NA-EU",
     ]
 
     def __init__(
@@ -218,7 +203,7 @@ class TitleConfig:
         game = parsed_content.get("game")
 
         attribute_configs = {}
-        for config in parsed_content[cls.ATTR_KEY]:
+        for config in parsed_content.get(cls.ATTR_KEY, []):
             definitions = [
                 ValueDefinition.from_dict(value_def)
                 for value_def in config["definitions"]
@@ -227,21 +212,28 @@ class TitleConfig:
                 config["name"], config.get("description", ""), definitions
             )
 
+        tag_config = None
         tag_definitions: dict[int, list[TagDefinition]] = {}
-        group_map = parsed_content[cls.TAG_KEY]["groups"]
+        tag_content = parsed_content.get(cls.TAG_KEY, None)
 
-        for tag_def in parsed_content[cls.TAG_KEY]["tags"]:
-            definition = TagDefinition.from_dict(tag_def, group_map)
-            if definition.group_id not in tag_definitions:
-                tag_definitions[definition.group_id] = []
-            tag_definitions[definition.group_id].append(definition)
+        if tag_content is not None:
+            group_map = tag_content["groups"]
 
-        tag_config = TagConfig(group_map, tag_definitions)
+            for tag_def in tag_content["tags"]:
+                definition = TagDefinition.from_dict(tag_def, group_map)
+                if definition.group_id not in tag_definitions:
+                    tag_definitions[definition.group_id] = []
+                tag_definitions[definition.group_id].append(definition)
+
+            tag_config = TagConfig(group_map, tag_definitions)
 
         branch_nodes: dict[int, NodeDefinition | tuple[NodeDefinition, ...]] = {}
         event_nodes: dict[int, tuple[NodeDefinition, ...]] = {}
 
-        for definition in parsed_content[cls.NODE_KEY]["branch"]:
+        node_data = parsed_content.get(cls.NODE_KEY, [])
+        branch_data, event_data = node_data.get("branch", []), node_data.get("event", [])
+
+        for definition in branch_data:
             node_id = definition["id"]
 
             node_definition = NodeDefinition.from_dict(
@@ -259,7 +251,7 @@ class TitleConfig:
             else:
                 branch_nodes[node_id] = (existing, node_definition)
 
-        for definition in parsed_content[cls.NODE_KEY]["event"]:
+        for definition in event_data:
             node_id = definition["id"]
 
             node_definition = NodeDefinition.from_dict(

{pylibms-4.3.2 → pylibms-4.3.4}/pyproject.toml

@@ -7,7 +7,7 @@ include = ["lms*"]
 
 [project]
 name = "PyLibMS"
-version = "4.3.2"
+version = "4.3.4"
 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"