PyLibMS 4.1.5__tar.gz → 4.1.7__tar.gz

{pylibms-4.1.5 → pylibms-4.1.7}/PKG-INFO

@@ -1,17 +1,18 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 4.1.5
+Version: 4.1.7
 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
 Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.12
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML>=6.0.1
@@ -19,19 +20,19 @@ Requires-Dist: requests>=2.34.0
 Dynamic: license-file
 
 # PyLibMS
+[![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 in Python 3.12+ for the libMessageStudio (LMS) proprietary file formats (`msbt`, `msbp`,
-`msbf`) from Nintendo. It supports the following:
+PyLibMS is a library built for Python 3.10 and above for the libMessageStudio (LMS) proprietary file formats from Nintendo. 
 
+The following is supported
 | Format | Read | Write | Configuration Support                                                                     |
 |-------------|------|-------|-------------------------------------------------------------------------------------------|
-| MSBT        | ✅    | ✅     | Complete attribute decoding + tag decoding down to official `mstxt` Nintendo tool syntax. |
-| MSBF        | ✅    | ✅     | Flexible node + parameter decoding through configuration definitions.                     |
-| MSBP        | ✅    | ❌     | N/A                                                                                       |
+| `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`        | ✅    | ❌     | Generating configuration files for use with `MSBT` files.                                                                                       |
 
-This library is designed to support LMS revision 3.0+ from most Nintendo consoles. 
-
-**Note**: MSBF files that use `FLW1` and `FLW2` are not supported, and will not be supported as they are revision <3.0 of LMS.
+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.
 
 # Features and Usage
 
@@ -67,21 +68,21 @@ To add or edit Preset, you may create an issue with the relevant `yaml` file and
 # Installation
 
 ```
-pip install PylibMS
+pip install PyLibMS
 ```
 
 [Pip Page](https://pypi.org/project/PyLibMS/)
 
 # Build Instructions
 
-Python version must be `>=3.12.`
+Python version must be `3.10` or higher.
 
 Clone the repository, then run `pip install` (venv recommended)
 
 ```bash
 git clone https://github.com/AbdyyEee/PylibMS.git
-cd PylibMS
-pip install -e 
+cd PyLibMS
+pip install -e .
 ```
 
 # Credits & Sources

{pylibms-4.1.5 → pylibms-4.1.7}/PyLibMS.egg-info/PKG-INFO

@@ -1,17 +1,18 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 4.1.5
+Version: 4.1.7
 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
 Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.12
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML>=6.0.1
@@ -19,19 +20,19 @@ Requires-Dist: requests>=2.34.0
 Dynamic: license-file
 
 # PyLibMS
+[![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 in Python 3.12+ for the libMessageStudio (LMS) proprietary file formats (`msbt`, `msbp`,
-`msbf`) from Nintendo. It supports the following:
+PyLibMS is a library built for Python 3.10 and above for the libMessageStudio (LMS) proprietary file formats from Nintendo. 
 
+The following is supported
 | Format | Read | Write | Configuration Support                                                                     |
 |-------------|------|-------|-------------------------------------------------------------------------------------------|
-| MSBT        | ✅    | ✅     | Complete attribute decoding + tag decoding down to official `mstxt` Nintendo tool syntax. |
-| MSBF        | ✅    | ✅     | Flexible node + parameter decoding through configuration definitions.                     |
-| MSBP        | ✅    | ❌     | N/A                                                                                       |
+| `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`        | ✅    | ❌     | Generating configuration files for use with `MSBT` files.                                                                                       |
 
-This library is designed to support LMS revision 3.0+ from most Nintendo consoles. 
-
-**Note**: MSBF files that use `FLW1` and `FLW2` are not supported, and will not be supported as they are revision <3.0 of LMS.
+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.
 
 # Features and Usage
 
@@ -67,21 +68,21 @@ To add or edit Preset, you may create an issue with the relevant `yaml` file and
 # Installation
 
 ```
-pip install PylibMS
+pip install PyLibMS
 ```
 
 [Pip Page](https://pypi.org/project/PyLibMS/)
 
 # Build Instructions
 
-Python version must be `>=3.12.`
+Python version must be `3.10` or higher.
 
 Clone the repository, then run `pip install` (venv recommended)
 
 ```bash
 git clone https://github.com/AbdyyEee/PylibMS.git
-cd PylibMS
-pip install -e 
+cd PyLibMS
+pip install -e .
 ```
 
 # Credits & Sources

{pylibms-4.1.5 → pylibms-4.1.7}/README.md

@@ -1,17 +1,17 @@
 # PyLibMS
+[![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 in Python 3.12+ for the libMessageStudio (LMS) proprietary file formats (`msbt`, `msbp`,
-`msbf`) from Nintendo. It supports the following:
+PyLibMS is a library built for Python 3.10 and above for the libMessageStudio (LMS) proprietary file formats from Nintendo. 
 
+The following is supported
 | Format | Read | Write | Configuration Support                                                                     |
 |-------------|------|-------|-------------------------------------------------------------------------------------------|
-| MSBT        | ✅    | ✅     | Complete attribute decoding + tag decoding down to official `mstxt` Nintendo tool syntax. |
-| MSBF        | ✅    | ✅     | Flexible node + parameter decoding through configuration definitions.                     |
-| MSBP        | ✅    | ❌     | N/A                                                                                       |
+| `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`        | ✅    | ❌     | Generating configuration files for use with `MSBT` files.                                                                                       |
 
-This library is designed to support LMS revision 3.0+ from most Nintendo consoles. 
-
-**Note**: MSBF files that use `FLW1` and `FLW2` are not supported, and will not be supported as they are revision <3.0 of LMS.
+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.
 
 # Features and Usage
 
@@ -47,21 +47,21 @@ To add or edit Preset, you may create an issue with the relevant `yaml` file and
 # Installation
 
 ```
-pip install PylibMS
+pip install PyLibMS
 ```
 
 [Pip Page](https://pypi.org/project/PyLibMS/)
 
 # Build Instructions
 
-Python version must be `>=3.12.`
+Python version must be `3.10` or higher.
 
 Clone the repository, then run `pip install` (venv recommended)
 
 ```bash
 git clone https://github.com/AbdyyEee/PylibMS.git
-cd PylibMS
-pip install -e 
+cd PyLibMS
+pip install -e .
 ```
 
 # Credits & Sources

{pylibms-4.1.5 → pylibms-4.1.7}/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.5 → pylibms-4.1.7}/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.5 → pylibms-4.1.7}/pyproject.toml

@@ -7,20 +7,30 @@ include = ["lms*"]
 
 [project]
 name = "PyLibMS"
-version = "4.1.5"
-requires-python = ">=3.12"
+version = "4.1.7"
+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 = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: 3.13"
-
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
 ]
 dependencies = [
     "PyYAML>=6.0.1",