PyLibMS 4.1.6__tar.gz → 4.2.0__tar.gz

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

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 4.1.6
+Version: 4.2.0
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License-Expression: MIT
 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,flw3
+Keywords: nintendo,msbt,message text,msbp,message project,msbf,message flowchart,flw3,modding,libmessagestudio
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -23,14 +23,14 @@ Dynamic: license-file
 [![Python Versions](https://img.shields.io/pypi/pyversions/PyLibMS)](https://pypi.org/project/PyLibMS/) 
 [![PyPI version](https://badge.fury.io/py/PyLibMS.svg)](https://badge.fury.io/py/PyLibMS)
 
-PyLibMS is a library built for Python 3.10 and above for the libMessageStudio (LMS) proprietary file formats from Nintendo. 
+PyLibMS is a library built in Python 3.10 and above for reading and writing of libMessageStudio (LMS) proprietary file formats from Nintendo. 
 
 The following is supported
 | Format | Read | Write | Configuration Support                                                                     |
 |-------------|------|-------|-------------------------------------------------------------------------------------------|
 | `MSBT`        | ✅    | ✅     | Support for full attribute (`ATR1`) decoding. Tag decoding 1:1 with the official Nintendo `.mstxt` file format. |
 | `MSBF`        | ✅    | ✅     | Support for custom node definitions, attaching names and descriptions to nodes. Altering parameter datatypes for flexibility between games.  |
-| `MSBP`        | ✅    | ❌     | N/A                                                                                       |
+| `MSBP`        | ✅    | ❌     | Generating configuration files for use with `MSBT` files.                                                                                       |
 
 This library is designed to support LMS revision >=3.0. These include files generated for late **Wii** titles, **Nintendo 3DS**, **Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
 
@@ -41,24 +41,45 @@ and examples.
 
 ## Reading
 
-MSBT/MSBF
+### MSBT
 
 ```py
 from lms.message.msbtio import read_msbt_path
+
+msbt = read_msbt_path("Text.msbt")
+```
+
+### MSBP
+```py
+from lms.project.msbpread import read_msbp_path
+
+msbp = read_msbp_path("Project.msbp")
+```
+
+
+### MSBF
+```py
 from lms.flowchart.msbfio import read_msbf_path
 
-msbt = read_msbt_path("Game.msbt")
-msbf = read_msbf_path("Game_Flowchart.msbf")
+msbf = read_msbf_path("Flowchart.msbf")
 ```
 
+
 ## Writing
+There is no writing for `MSBP` files as most of the time it acts as leftover metadata and not actually loaded by games.
 
+### MSBT
 ```py
 from lms.message.msbtio import write_msbt_path
+
+write_msbt_path("Out_text.msbt")
+```
+
+### MSBF
+```py
 from lms.flowchart.msbfio import write_msbf_path
 
-write_msbt_path("Out_Game.msbt")
-write_msbf_path("Out_Game_Flowchart.msbt")
+write_msbf_path("Out_Flowchart.msbf")
 ```
 
 # Adding/Editing Presets

{pylibms-4.1.6 → pylibms-4.2.0}/PyLibMS.egg-info/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 4.1.6
+Version: 4.2.0
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License-Expression: MIT
 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,flw3
+Keywords: nintendo,msbt,message text,msbp,message project,msbf,message flowchart,flw3,modding,libmessagestudio
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -23,14 +23,14 @@ Dynamic: license-file
 [![Python Versions](https://img.shields.io/pypi/pyversions/PyLibMS)](https://pypi.org/project/PyLibMS/) 
 [![PyPI version](https://badge.fury.io/py/PyLibMS.svg)](https://badge.fury.io/py/PyLibMS)
 
-PyLibMS is a library built for Python 3.10 and above for the libMessageStudio (LMS) proprietary file formats from Nintendo. 
+PyLibMS is a library built in Python 3.10 and above for reading and writing of libMessageStudio (LMS) proprietary file formats from Nintendo. 
 
 The following is supported
 | Format | Read | Write | Configuration Support                                                                     |
 |-------------|------|-------|-------------------------------------------------------------------------------------------|
 | `MSBT`        | ✅    | ✅     | Support for full attribute (`ATR1`) decoding. Tag decoding 1:1 with the official Nintendo `.mstxt` file format. |
 | `MSBF`        | ✅    | ✅     | Support for custom node definitions, attaching names and descriptions to nodes. Altering parameter datatypes for flexibility between games.  |
-| `MSBP`        | ✅    | ❌     | N/A                                                                                       |
+| `MSBP`        | ✅    | ❌     | Generating configuration files for use with `MSBT` files.                                                                                       |
 
 This library is designed to support LMS revision >=3.0. These include files generated for late **Wii** titles, **Nintendo 3DS**, **Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
 
@@ -41,24 +41,45 @@ and examples.
 
 ## Reading
 
-MSBT/MSBF
+### MSBT
 
 ```py
 from lms.message.msbtio import read_msbt_path
+
+msbt = read_msbt_path("Text.msbt")
+```
+
+### MSBP
+```py
+from lms.project.msbpread import read_msbp_path
+
+msbp = read_msbp_path("Project.msbp")
+```
+
+
+### MSBF
+```py
 from lms.flowchart.msbfio import read_msbf_path
 
-msbt = read_msbt_path("Game.msbt")
-msbf = read_msbf_path("Game_Flowchart.msbf")
+msbf = read_msbf_path("Flowchart.msbf")
 ```
 
+
 ## Writing
+There is no writing for `MSBP` files as most of the time it acts as leftover metadata and not actually loaded by games.
 
+### MSBT
 ```py
 from lms.message.msbtio import write_msbt_path
+
+write_msbt_path("Out_text.msbt")
+```
+
+### MSBF
+```py
 from lms.flowchart.msbfio import write_msbf_path
 
-write_msbt_path("Out_Game.msbt")
-write_msbf_path("Out_Game_Flowchart.msbt")
+write_msbf_path("Out_Flowchart.msbf")
 ```
 
 # Adding/Editing Presets

{pylibms-4.1.6 → pylibms-4.2.0}/README.md

@@ -2,14 +2,14 @@
 [![Python Versions](https://img.shields.io/pypi/pyversions/PyLibMS)](https://pypi.org/project/PyLibMS/) 
 [![PyPI version](https://badge.fury.io/py/PyLibMS.svg)](https://badge.fury.io/py/PyLibMS)
 
-PyLibMS is a library built for Python 3.10 and above for the libMessageStudio (LMS) proprietary file formats from Nintendo. 
+PyLibMS is a library built in Python 3.10 and above for reading and writing of libMessageStudio (LMS) proprietary file formats from Nintendo. 
 
 The following is supported
 | Format | Read | Write | Configuration Support                                                                     |
 |-------------|------|-------|-------------------------------------------------------------------------------------------|
 | `MSBT`        | ✅    | ✅     | Support for full attribute (`ATR1`) decoding. Tag decoding 1:1 with the official Nintendo `.mstxt` file format. |
 | `MSBF`        | ✅    | ✅     | Support for custom node definitions, attaching names and descriptions to nodes. Altering parameter datatypes for flexibility between games.  |
-| `MSBP`        | ✅    | ❌     | N/A                                                                                       |
+| `MSBP`        | ✅    | ❌     | Generating configuration files for use with `MSBT` files.                                                                                       |
 
 This library is designed to support LMS revision >=3.0. These include files generated for late **Wii** titles, **Nintendo 3DS**, **Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
 
@@ -20,24 +20,45 @@ and examples.
 
 ## Reading
 
-MSBT/MSBF
+### MSBT
 
 ```py
 from lms.message.msbtio import read_msbt_path
+
+msbt = read_msbt_path("Text.msbt")
+```
+
+### MSBP
+```py
+from lms.project.msbpread import read_msbp_path
+
+msbp = read_msbp_path("Project.msbp")
+```
+
+
+### MSBF
+```py
 from lms.flowchart.msbfio import read_msbf_path
 
-msbt = read_msbt_path("Game.msbt")
-msbf = read_msbf_path("Game_Flowchart.msbf")
+msbf = read_msbf_path("Flowchart.msbf")
 ```
 
+
 ## Writing
+There is no writing for `MSBP` files as most of the time it acts as leftover metadata and not actually loaded by games.
 
+### MSBT
 ```py
 from lms.message.msbtio import write_msbt_path
+
+write_msbt_path("Out_text.msbt")
+```
+
+### MSBF
+```py
 from lms.flowchart.msbfio import write_msbf_path
 
-write_msbt_path("Out_Game.msbt")
-write_msbf_path("Out_Game_Flowchart.msbt")
+write_msbf_path("Out_Flowchart.msbf")
 ```
 
 # Adding/Editing Presets

{pylibms-4.1.6 → pylibms-4.2.0}/lms/common/field/io.py

@@ -8,7 +8,8 @@ from lms.fileio.io import FileReader, FileWriter
 from lms.titleconfig.definitions.value import ValueDefinition
 
 
-def read_field(reader: FileReader, definition: ValueDefinition) -> LMS_Field:
+def read_field(reader: FileReader, definition: ValueDefinition,
+               read_variable_width_value: Callable | None = None) -> LMS_Field:
     # String is excluded as their reading varies between MSBT/MSBF
     match definition.datatype:
         case LMS_DataType.UINT8:
@@ -26,17 +27,23 @@ def read_field(reader: FileReader, definition: ValueDefinition) -> LMS_Field:
         case LMS_DataType.FLOAT32:
             value = reader.read_float32()
         case LMS_DataType.LIST:
-            index = reader.read_uint8()
+            if read_variable_width_value is not None:
+                index = read_variable_width_value()
+            else:
+                index = reader.read_uint8()
             value = definition.list_items[index]
         case LMS_DataType.BOOL:
-            value = bool(reader.read_uint8())
+            if read_variable_width_value is not None:
+                value = bool(read_variable_width_value())
+            else:
+                value = bool(reader.read_uint8())
         case LMS_DataType.BYTES:
             value = reader.read_bytes(1)
 
     return LMS_Field(value, definition)  # type: ignore
 
 
-def write_field(writer: FileWriter, field: LMS_Field) -> None:
+def write_field(writer: FileWriter, field: LMS_Field, write_variable_width_value: Callable | None = None) -> None:
     if is_number_datatype(field.value, field.datatype):
         write_functions: dict[LMS_DataType, Callable] = {
             LMS_DataType.UINT8: writer.write_uint8,
@@ -51,10 +58,17 @@ def write_field(writer: FileWriter, field: LMS_Field) -> None:
         return
 
     if is_list_datatype(field.value, field.datatype):
-        writer.write_uint8(field.list_items.index(field.value))
+        value = field.list_items.index(field.value)
+        if write_variable_width_value is not None:
+            write_variable_width_value(value)
+        else:
+            writer.write_uint8(value)
     elif is_bytes_datatype(field.value, field.datatype):
         writer.write_bytes(field.value)
     elif is_bool_datatype(field.value, field.datatype):
-        writer.write_uint8(bool(field.value))
+        if write_variable_width_value is not None:
+            write_variable_width_value(bool(field.value))
+        else:
+            writer.write_uint8(bool(field.value))
     else:
         raise ValueError(f"Unsupported datatype: {field.datatype}")

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

@@ -1,5 +1,5 @@
 from types import MappingProxyType
-from typing import Callable
+from typing import Callable, Iterator
 
 from lms.flowchart.definitions.node import LMS_EntryNode, LMS_BranchNode, LMS_BaseNode
 
@@ -16,6 +16,9 @@ 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())
+
     def __len__(self) -> int:
         return len(self._nodes)
 
@@ -89,7 +92,7 @@ class LMS_Flowchart:
 
         del self._nodes[node_id]
 
-    def get_dangling_nodes(self):
+    def get_dangling_nodes(self) -> list[LMS_BaseNode]:
         """
         Retrieves all the nodes that do not have a parent in the flowchart.
         """

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

@@ -365,6 +365,7 @@ class LMS_EventNode(LMS_BaseNode):
 
         :param parameter_type: the parameter type.
         :param parameter_value: the parameter value.
+        :param action_id: the action_id of the node.
 
         """
         verify_parameter_structure(parameter_value, parameter_type)
@@ -435,7 +436,7 @@ class LMS_JumpNode(LMS_BaseNode):
         self.next_flowchart: LMS_EntryNode | None = None
 
         # TODO: Document this unknown value at 0xA in the node
-        # This value is usually -1 in TL but is a set value in other games
+        # This value is usually -1 in TL 3DS but is a set value in other games
         self.unknown_short0a = unknown_short0a
 
     @classmethod

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

@@ -1,7 +1,7 @@
-from typing import Type
 from enum import IntEnum
+from typing import Type
 
-from lms.common.lms_exceptions import LMS_Error
+from lms.common.field.lms_datatype import LMS_DataType
 
 PARAMETER_ALIASES = {
     "p32_0": "PARAM_32_0",
@@ -53,8 +53,27 @@ class LMS_NodeParameterType(IntEnum):
     PARAM_32_1 = 6
     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."""
+        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_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)
+        }[self]
+
     @property
     def value_count(self) -> int:
+        """Amount of values the parameter holds."""
         if self is LMS_NodeParameterType.NONE:
             raise TypeError("There is no value count for NONE parameter types!")
 
@@ -70,6 +89,7 @@ class LMS_NodeParameterType(IntEnum):
 
     @property
     def builtin_type(self) -> Type[int] | Type[tuple[int, ...]] | Type[str]:
+        """The builtin type of the parameter type."""
         if self is LMS_NodeParameterType.NONE:
             raise TypeError("There is no builtin type for NONE parameter types!")
 

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

@@ -1,4 +1,5 @@
 from lms.common.field.io import read_field, write_field
+from lms.common.field.lms_datatype import LMS_DataType
 from lms.common.field.lms_field import LMS_FieldMap, LMS_Field
 from lms.common.lms_exceptions import LMS_Error
 from lms.fileio.io import FileReader, FileWriter
@@ -13,6 +14,8 @@ NO_NEXT_NODE = 0xFFFF
 FLW3_HEADER_SIZE = 16
 NODE_SIZE = 16
 
+VARIABLE_WIDTH_DATATYPES = (LMS_DataType.BOOL, LMS_DataType.LIST)
+
 
 def read_flw3(reader: FileReader, config: NodeConfig | None, msbt: MSBT | None, ) -> tuple[
     int, dict[int, LMS_EntryNode]]:
@@ -155,8 +158,10 @@ def evaluate_node_parameter(reader: FileReader,
                 param_definition.name: LMS_Field(value, param_definition)
             })
 
-        for param_definition in definition.parameter_definitions:
-            result[param_definition.name] = read_field(reader, param_definition)
+        for i, param_definition in enumerate(definition.parameter_definitions):
+            stream_map = {1: reader.read_uint8, 2: reader.read_uint16, 3: reader.read_uint32}
+            result[param_definition.name] = read_field(reader, param_definition,
+                                                       stream_map[parameter_type.sliced_datatype[i].stream_size])
 
         return LMS_FieldMap(result)
     else:
@@ -297,8 +302,13 @@ def write_node_parameter(writer: FileWriter,
                          value: LMS_NodeParameter,
                          parameter_type: LMS_NodeParameterType) -> None:
     if isinstance(value, LMS_FieldMap):
-        for field in value:
-            write_field(writer, field)
+        for i, field in enumerate(value):
+            # In MSBF files there could be a case where naturally one bit datatypes take up 2/4 bits.
+            if field.datatype in VARIABLE_WIDTH_DATATYPES:
+                stream_map = {1: writer.write_uint8, 2: writer.write_uint16, 3: writer.write_uint32}
+                write_field(writer, field, stream_map[parameter_type.sliced_datatype[i].stream_size])
+            else:
+                write_field(writer, field)
         return
 
     match parameter_type:

{pylibms-4.1.6 → pylibms-4.2.0}/lms/flowchart/msbf.py

@@ -63,17 +63,13 @@ class MSBF:
         """The flowcharts of the MSBF instance."""
         return MappingProxyType({flowchart.name: flowchart for flowchart in self._flowcharts})
 
-    @property
-    def global_node_id(self) -> int:
-        """Current node ID count."""
-        return self._global_node_id
-
     def set_global_id_count(self, value: int) -> None:
-        if value < self._global_node_id:
-            raise ValueError("Cannot decrease global node ID below existing count.")
         self._global_node_id = value
 
     def generate_next_id(self) -> int:
+        """
+        Lazy generation for the next ID of a node. IDs are normalized properly when the msbf file is being written.
+        """
         next_id = self._global_node_id
         self._global_node_id += 1
         return next_id
@@ -97,7 +93,7 @@ class MSBF:
     def delete_flowchart(self, name: str):
         """Delete a flowchart from the MSBF instance."""
 
-        if name not in self._flowcharts:
+        if name not in self.flowcharts:
             raise KeyError(f"Flowchart with name {name} does not exist!")
 
         del self._flowcharts[name]

{pylibms-4.1.6 → pylibms-4.2.0}/lms/titleconfig/definitions/nodes.py

@@ -55,11 +55,13 @@ class NodeDefinition:
     type: LMS_NodeType.BRANCH | LMS_NodeType.EVENT
     parameter_type: LMS_NodeParameterType
     parameter_definitions: tuple[ValueDefinition, ...]
+    case_format: str | None
     next_node_dependency: bool = False
 
     @classmethod
     def from_dict(cls, id: int, node_type: LMS_NodeType, data: dict) -> NodeDefinition:
 
+        description = data.get("description", "")
         converted_parameters: list[ValueDefinition] = []
         parameter_type = LMS_NodeParameterType.from_string(data["parameter_type"])
 
@@ -83,15 +85,19 @@ class NodeDefinition:
                             (LMS_DataType.UINT8, LMS_DataType.UINT8, LMS_DataType.UINT8, LMS_DataType.UINT8)[i]
                     case LMS_NodeParameterType.STRING:
                         datatype_from_dict = LMS_DataType.STRING
-                definition = ValueDefinition(parameter["name"], data.get("description", ""), datatype_from_dict,
+                definition = ValueDefinition(parameter["name"], description, datatype_from_dict,
                                              list_items)
             else:
-                definition = ValueDefinition(parameter["name"], data["description"],
+                definition = ValueDefinition(parameter["name"], description,
                                              LMS_DataType.from_string(datatype_from_dict),
                                              list_items)
 
             converted_parameters.append(definition)
 
+        # case_format is only for branch nodesa
+        if (case_format := data.get("case_format", None)) is not None and type == LMS_NodeType.EVENT:
+            raise ValueError("There may only be case_format for branch nodes!")
+
         return NodeDefinition(
             name=data["name"],
             id=id,
@@ -99,5 +105,6 @@ class NodeDefinition:
             type=node_type,
             parameter_type=parameter_type,
             parameter_definitions=converted_parameters,
+            case_format=case_format,
             next_node_dependency=data.get("next_node_dependency", False)
         )

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

@@ -8,6 +8,7 @@ node_definitions:
         - name: exp
     - id: 1
       name: SwitchVariable
+      case_format: "var == {case}"
       parameter_type: string
       parameters:
         - name: var

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

@@ -7,12 +7,22 @@ include = ["lms*"]
 
 [project]
 name = "PyLibMS"
-version = "4.1.6"
+version = "4.2.0"
 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"
 authors = [{ name = "AbdyyEee" }]
-keywords = ["nintendo", "msbf", "msbt", "msbp", "modding", "lms", "libmessagestudio", "flw3"]
+keywords = [
+    "nintendo",
+    "msbt",
+    "message text",
+    "msbp",
+    "message project",
+    "msbf",
+    "message flowchart",
+    "flw3",
+    "modding",
+    "libmessagestudio"]
 license = "MIT"
 license-files = ["LICENSE*"]
 classifiers = [