PyLibMS 4.2.0__tar.gz → 4.2.1__tar.gz

pylibms-4.2.1/MANIFEST.in

@@ -0,0 +1 @@
+include README.md LICENSE

{pylibms-4.2.0 → pylibms-4.2.1}/PKG-INFO

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 4.2.0
+Version: 4.2.1
 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.2.0 → pylibms-4.2.1}/lms/flowchart/definitions/flowchart.py

@@ -16,6 +16,7 @@ class LMS_Flowchart:
             for node in entry_point.get_descendents():
                 self._nodes[node.id] = node
 
+
     def __iter__(self) -> Iterator[LMS_BaseNode]:
         return iter(self._nodes.values())
 

{pylibms-4.2.0 → pylibms-4.2.1}/lms/flowchart/definitions/node.py

@@ -27,15 +27,14 @@ class LMS_BaseNode:
                  id: int | None,
                  node_type: LMS_NodeType,
                  parameter_type: LMS_NodeParameterType,
-                 parameter_value: LMS_NodeParameter | None,
-                 stream_next_id: int | None = None):
+                 parameter_value: LMS_NodeParameter | None):
         self.id = id
         self._node_type = node_type
 
         self._parameter_type = parameter_type
         self._parameter_value = parameter_value
 
-        self._stream_next_id: int | None = stream_next_id
+        self._stream_next_id: int | None = None
         self._next_node: LMS_BaseNode | None = None
 
     @property
@@ -76,14 +75,6 @@ class LMS_BaseNode:
         if not isinstance(value, self._parameter_type.builtin_type):
             raise TypeError(f"Wrong value provided! Expected {self._parameter_type.builtin_type} got {type(value)}")
 
-        sliced_datatype = {
-            LMS_NodeParameterType.PARAM_16_16: (LMS_DataType.UINT16, LMS_DataType.UINT16),
-            LMS_NodeParameterType.PARAM_16_8_8: (LMS_DataType.UINT16, LMS_DataType.UINT8, LMS_DataType.UINT8),
-            LMS_NodeParameterType.PARAM_8_8_16: (LMS_DataType.UINT8, LMS_DataType.UINT8, LMS_DataType.UINT16),
-            LMS_NodeParameterType.PARAM_8_8_8_8: (LMS_DataType.UINT8, LMS_DataType.UINT8, LMS_DataType.UINT8,
-                                                  LMS_DataType.UINT8)
-        }
-
         match self._parameter_type:
             case LMS_NodeParameterType.STRING:
                 self._parameter_value = value
@@ -92,7 +83,8 @@ class LMS_BaseNode:
                 self._parameter_value = value
             case _:
                 for i, parameter in enumerate(value):
-                    verify_number_from_datatype(parameter, sliced_datatype[self._parameter_type][i])
+                    verify_number_from_datatype(parameter,
+                                                self._parameter_type.sliced_datatype[self._parameter_type][i])
 
         self._parameter_value = value
 
@@ -100,8 +92,6 @@ class LMS_BaseNode:
         """Set the next node for the instance.
 
         :param node: the node object, None for no next node."""
-        # Once next_node is properly set, stream_id is never accessed again
-        # While it does become stale, there is no point to altering it afterward
         self._next_node = node
         return node
 
@@ -143,7 +133,6 @@ class LMS_MessageNode(LMS_BaseNode):
 
     def __init__(self,
                  id: int | None,
-                 stream_next_node: int,
                  msbt_index: int,
                  label_index: int,
                  msbt: MSBT | None = None
@@ -153,7 +142,6 @@ class LMS_MessageNode(LMS_BaseNode):
             LMS_NodeType.MESSAGE,
             LMS_NodeParameterType.NONE,
             None,
-            stream_next_node
         )
 
         self.msbt_index = msbt_index
@@ -211,13 +199,20 @@ class LMS_BranchNode(LMS_BaseNode):
             LMS_NodeType.BRANCH,
             parameter_type,
             parameter_value,
-            NO_NEXT_NODE
         )
 
         self._condition_id = condition_id
         self._branches: dict[int, LMS_BaseNode | None] = {}
         self._definition = definition
 
+    def __repr__(self):
+        if self._definition is None:
+            return super().__repr__()
+        return f"{self._definition.name}({ {field.name: field.value for field in self._parameter_value} } {self.id}"
+
+    def set_next_node(self, node: LMS_BaseNode | None) -> LMS_BaseNode | None:
+        raise NotImplementedError("Use function set_branch_case to alter the flow of a branch node!")
+
     @classmethod
     def new(cls,
             parameter_type: LMS_NodeParameterType,
@@ -345,19 +340,22 @@ class LMS_EventNode(LMS_BaseNode):
                  parameter_type: LMS_NodeParameterType,
                  parameter_value: LMS_FieldMap | int | str | tuple[int, ...],
                  action_id: int,
-                 stream_next_id: int | None = None,
                  definition: NodeDefinition | None = None,
                  ):
         super().__init__(
             id,
             LMS_NodeType.EVENT,
             parameter_type,
-            parameter_value,
-            stream_next_id)
+            parameter_value)
 
         self._action_id = action_id
         self._definition = definition
 
+    def __repr__(self):
+        if self._definition is None:
+            return super().__repr__()
+        return f"{self._definition.name}({ {field.name: field.value for field in self._parameter_value} } {self.id}"
+
     @classmethod
     def new(cls, parameter_type: LMS_NodeParameterType, parameter_value: int | str | tuple[int, ...], action_id: int):
         """
@@ -409,13 +407,12 @@ class LMS_EntryNode(LMS_BaseNode):
     Class that represents an entry node. Node that is at the start of a flowchart.
     """
 
-    def __init__(self, id: int, stream_next_id=None, flowchart_name: str = ""):
+    def __init__(self, id: int, flowchart_name: str = ""):
         super().__init__(
             id,
             LMS_NodeType.ENTRY,
             LMS_NodeParameterType.NONE,
-            None,
-            stream_next_id)
+            None)
 
         self.flowchart_name = flowchart_name
 
@@ -425,13 +422,12 @@ class LMS_JumpNode(LMS_BaseNode):
     Class that represents a jump node. Node that jumps to another flowchart.
     """
 
-    def __init__(self, id: int, next_flowchart_id: int, unknown_short0a: int):
+    def __init__(self, id: int, unknown_short0a: int):
         super().__init__(
             id,
             LMS_NodeType.JUMP,
             LMS_NodeParameterType.NONE,
-            None,
-            next_flowchart_id)
+            None)
 
         self.next_flowchart: LMS_EntryNode | None = None
 

{pylibms-4.2.0 → pylibms-4.2.1}/lms/flowchart/definitions/node_type.py

@@ -54,21 +54,21 @@ class LMS_NodeParameterType(IntEnum):
     NONE = -1
 
     @property
-    def sliced_datatype(self):
-        """The parameter type split into the raw datatypes. Not valid for PARAM_32_0, PARAM_32_1, and STRING."""
+    def sliced_datatype(self) -> tuple[LMS_DataType, ...]:
+        """The parameter type split into the raw datatypes. Not valid for STRING."""
         if self in [
             LMS_NodeParameterType.NONE,
-            LMS_NodeParameterType.PARAM_32_0,
-            LMS_NodeParameterType.PARAM_32_1,
             LMS_NodeParameterType.STRING]:
             raise TypeError(f"There is no sliced datatypes for {self} parameter types!")
 
         return {
+            LMS_NodeParameterType.PARAM_32_0: (LMS_DataType.UINT32,),
             LMS_NodeParameterType.PARAM_16_16: (LMS_DataType.UINT16, LMS_DataType.UINT16),
             LMS_NodeParameterType.PARAM_16_8_8: (LMS_DataType.UINT16, LMS_DataType.UINT8, LMS_DataType.UINT8),
             LMS_NodeParameterType.PARAM_8_8_16: (LMS_DataType.UINT8, LMS_DataType.UINT8, LMS_DataType.UINT16),
             LMS_NodeParameterType.PARAM_8_8_8_8: (LMS_DataType.UINT8, LMS_DataType.UINT8, LMS_DataType.UINT8,
-                                                  LMS_DataType.UINT8)
+                                                  LMS_DataType.UINT8),
+            LMS_NodeParameterType.PARAM_32_1: (LMS_DataType.UINT32,)
         }[self]
 
     @property

{pylibms-4.2.0 → pylibms-4.2.1}/lms/flowchart/flw3.py

@@ -28,6 +28,8 @@ def read_flw3(reader: FileReader, config: NodeConfig | None, msbt: MSBT | None,
 
     nodes: list[LMS_BaseNode] = []
     entry_nodes: list[LMS_EntryNode] = []
+
+    next_id_map: dict[LMS_BaseNode, int | None] = {}
     branch_metadata: dict[LMS_BranchNode, dict] = {}
 
     for i in range(node_count):
@@ -45,7 +47,7 @@ def read_flw3(reader: FileReader, config: NodeConfig | None, msbt: MSBT | None,
                 stream_next_id = read_next_node_id(reader)
                 file_index = reader.read_uint16()
                 message_index = reader.read_uint16()
-                node = LMS_MessageNode(i, stream_next_id, file_index, message_index, msbt)
+                node = LMS_MessageNode(i, file_index, message_index, msbt)
                 reader.skip(2)
             case LMS_NodeType.BRANCH:
                 # There is no next node id as the next node is determined by the branches
@@ -78,27 +80,29 @@ def read_flw3(reader: FileReader, config: NodeConfig | None, msbt: MSBT | None,
                 definition = get_config_definition(config, LMS_NodeType.EVENT, parameter_type, event_id)
                 parameter_value = evaluate_node_parameter(reader, section_start, parameter_type, definition)
 
-                node = LMS_EventNode(i, parameter_type, parameter_value, event_id, stream_next_id, definition)
+                node = LMS_EventNode(i, parameter_type, parameter_value, event_id, definition)
                 reader.seek(end)
             case LMS_NodeType.ENTRY:
                 reader.seek(node_data)
                 stream_next_id = read_next_node_id(reader)
-                node = LMS_EntryNode(i, stream_next_id)
+                node = LMS_EntryNode(i)
                 entry_nodes.append(node)
                 reader.skip(6)
             case LMS_NodeType.JUMP:
                 reader.seek(node_data)
-                next_flowchart_id = read_next_node_id(reader)
+                stream_next_id = read_next_node_id(reader)
                 unknown_short0a = reader.read_uint16()
-                node = LMS_JumpNode(i, next_flowchart_id, unknown_short0a)
+                node = LMS_JumpNode(i, unknown_short0a)
                 reader.skip(4)
 
+        next_id_map[node] = stream_next_id
         nodes.append(node)
 
     node_map: dict[int, LMS_BaseNode] = {node.id: node for node in nodes}
     branch_ids = [read_next_node_id(reader) for _ in range(branch_table_id_count)]
 
     for node in nodes:
+        next_node_id = next_id_map[node]
 
         if isinstance(node, LMS_BranchNode):
             case_count, starting_index = branch_metadata[node]
@@ -112,13 +116,13 @@ def read_flw3(reader: FileReader, config: NodeConfig | None, msbt: MSBT | None,
 
             continue
         elif isinstance(node, LMS_JumpNode):
-            node.next_flowchart = node_map[node.next_node_id]
+            node.next_flowchart = node_map[next_node_id]
             continue
 
-        if node.next_node_id is None:
+        if next_node_id is None:
             continue
 
-        node.set_next_node(node_map[node.next_node_id])
+        node.set_next_node(node_map[next_node_id])
 
     return node_count, entry_nodes
 
@@ -159,7 +163,7 @@ def evaluate_node_parameter(reader: FileReader,
             })
 
         for i, param_definition in enumerate(definition.parameter_definitions):
-            stream_map = {1: reader.read_uint8, 2: reader.read_uint16, 3: reader.read_uint32}
+            stream_map = {1: reader.read_uint8, 2: reader.read_uint16, 4: reader.read_uint32}
             result[param_definition.name] = read_field(reader, param_definition,
                                                        stream_map[parameter_type.sliced_datatype[i].stream_size])
 

{pylibms-4.2.0 → pylibms-4.2.1}/lms/titleconfig/presets/Tomodachi Life NA-EU.yaml

@@ -8,7 +8,7 @@ node_definitions:
         - name: exp
     - id: 1
       name: SwitchVariable
-      case_format: "var == {case}"
+      case_format: "var == $case"
       parameter_type: string
       parameters:
         - name: var
@@ -29,6 +29,11 @@ node_definitions:
       parameter_type: string
       parameters:
         - name: var
+    - id: 82
+      name: SetFlag
+      parameter_type: p32_1
+      parameters:
+        - name: flag
     - id: 90
       name: LoadSEGroup
       parameter_type: string

{pylibms-4.2.0 → pylibms-4.2.1}/pyproject.toml

@@ -7,7 +7,7 @@ include = ["lms*"]
 
 [project]
 name = "PyLibMS"
-version = "4.2.0"
+version = "4.2.1"
 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-4.2.0/MANIFEST.in

@@ -1,2 +0,0 @@
-include README.md LICENSE
-recursive-include lms/titleconfig/presets *.yaml