PyLibMS 4.0.2__tar.gz → 4.0.4__tar.gz

{pylibms-4.0.2 → pylibms-4.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 4.0.2
+Version: 4.0.4
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License-Expression: MIT
@@ -24,7 +24,9 @@ PylibMS is a library built in Python 3.12+ for the libMessageStudio (LMS) propri
 | MSBF        | ✅    | ✅     | Flexible node + parameter decoding through configuration definitions.                     |
 | MSBP        | ✅    | ❌     | N/A                                                                                       |
 
-This library is designed to support LMS revision 3.0+ from most Nintendo consoles. However, MSBF files that use `FLW1` and `FLW2` are not supported.
+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.
 
 # Features and Usage
 
@@ -37,7 +39,7 @@ MSBT/MSBF
 
 ```py
 from lms.message.msbtio import read_msbt_path
-from lms.message.msbfio import read_msbf_path
+from lms.flowchart.msbfio import read_msbf_path
 
 msbt = read_msbt_path("Game.msbt")
 msbf = read_msbf_path("Game_Flowchart.msbf")
@@ -47,7 +49,7 @@ msbf = read_msbf_path("Game_Flowchart.msbf")
 
 ```py
 from lms.message.msbtio import write_msbt_path
-from lms.message.msbfio import write_msbf_path
+from lms.flowchart.msbfio import write_msbf_path
 
 write_msbt_path("Out_Game.msbt")
 write_msbf_path("Out_Game_Flowchart.msbt")

{pylibms-4.0.2 → pylibms-4.0.4}/PyLibMS.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 4.0.2
+Version: 4.0.4
 Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
 Author: AbdyyEee
 License-Expression: MIT
@@ -24,7 +24,9 @@ PylibMS is a library built in Python 3.12+ for the libMessageStudio (LMS) propri
 | MSBF        | ✅    | ✅     | Flexible node + parameter decoding through configuration definitions.                     |
 | MSBP        | ✅    | ❌     | N/A                                                                                       |
 
-This library is designed to support LMS revision 3.0+ from most Nintendo consoles. However, MSBF files that use `FLW1` and `FLW2` are not supported.
+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.
 
 # Features and Usage
 
@@ -37,7 +39,7 @@ MSBT/MSBF
 
 ```py
 from lms.message.msbtio import read_msbt_path
-from lms.message.msbfio import read_msbf_path
+from lms.flowchart.msbfio import read_msbf_path
 
 msbt = read_msbt_path("Game.msbt")
 msbf = read_msbf_path("Game_Flowchart.msbf")
@@ -47,7 +49,7 @@ msbf = read_msbf_path("Game_Flowchart.msbf")
 
 ```py
 from lms.message.msbtio import write_msbt_path
-from lms.message.msbfio import write_msbf_path
+from lms.flowchart.msbfio import write_msbf_path
 
 write_msbt_path("Out_Game.msbt")
 write_msbf_path("Out_Game_Flowchart.msbt")

{pylibms-4.0.2 → pylibms-4.0.4}/README.md

@@ -9,7 +9,9 @@ PylibMS is a library built in Python 3.12+ for the libMessageStudio (LMS) propri
 | MSBF        | ✅    | ✅     | Flexible node + parameter decoding through configuration definitions.                     |
 | MSBP        | ✅    | ❌     | N/A                                                                                       |
 
-This library is designed to support LMS revision 3.0+ from most Nintendo consoles. However, MSBF files that use `FLW1` and `FLW2` are not supported.
+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.
 
 # Features and Usage
 
@@ -22,7 +24,7 @@ MSBT/MSBF
 
 ```py
 from lms.message.msbtio import read_msbt_path
-from lms.message.msbfio import read_msbf_path
+from lms.flowchart.msbfio import read_msbf_path
 
 msbt = read_msbt_path("Game.msbt")
 msbf = read_msbf_path("Game_Flowchart.msbf")
@@ -32,7 +34,7 @@ msbf = read_msbf_path("Game_Flowchart.msbf")
 
 ```py
 from lms.message.msbtio import write_msbt_path
-from lms.message.msbfio import write_msbf_path
+from lms.flowchart.msbfio import write_msbf_path
 
 write_msbt_path("Out_Game.msbt")
 write_msbf_path("Out_Game_Flowchart.msbt")

{pylibms-4.0.2 → pylibms-4.0.4}/lms/common/lms_exceptions.py

@@ -8,3 +8,6 @@ class LMS_MisalignedSizeError(Exception): ...
 
 
 class LMS_UnsupportedSectionError(Exception): ...
+
+
+class LMS_UnsupportedFileVersionError(Exception): ...

{pylibms-4.0.2 → pylibms-4.0.4}/lms/common/stream/fileinfo.py

@@ -23,6 +23,10 @@ def read_file_info(reader: FileReader, expected_magic: str) -> LMS_FileInfo:
     reader.encoding = encoding
 
     version = reader.read_uint8()
+
+    if version < 3:
+        raise lms_exceptions.LMS_UnsupportedFileVersionError("Only version 3+ files are supported!")
+
     section_count = reader.read_uint16()
 
     reader.skip(2)

{pylibms-4.0.2 → pylibms-4.0.4}/lms/flowchart/definitions/flowchart.py

@@ -53,7 +53,6 @@ class LMS_Flowchart:
         if node in self._nodes.values():
             raise ValueError(f"Node of ID '{node.id}' is already registered to this flowchart!")
 
-
         node.id = self._id_generator()
         self._nodes[node.id] = node
 

{pylibms-4.0.2 → pylibms-4.0.4}/lms/flowchart/flw3.py

@@ -261,7 +261,7 @@ def write_flw3(writer: FileWriter, nodes: list[LMS_BaseNode], stream_ids: dict[L
                 writer.write_bytes(b"\x00" * 2)
                 writer.write_bytes(b"\x00" * 4)
 
-                write_next_node_id(writer, node.next_node_id)
+                write_next_node_id(writer, None if node.next_node is None else stream_ids[node.next_node])
                 writer.skip(6)
             case LMS_JumpNode():
                 writer.write_bytes(b"\x00" * 2)

{pylibms-4.0.2 → pylibms-4.0.4}/lms/flowchart/msbf.py

@@ -1,6 +1,7 @@
 from types import MappingProxyType
 
 from lms.common.lms_fileinfo import LMS_FileInfo
+from lms.fileio.encoding import FileEncoding
 from lms.flowchart.definitions.flowchart import LMS_Flowchart
 from lms.flowchart.definitions.node import LMS_EntryNode
 
@@ -24,10 +25,9 @@ class MSBF:
     DEFAULT_SLOT_COUNT = 59
 
     def __init__(self, info: LMS_FileInfo | None = None,
-                 flowcharts: dict[str, LMS_Flowchart] = None):
+                 flowcharts: list[LMS_Flowchart] = None):
         self._info = info if info is not None else LMS_FileInfo()
-        self._flowcharts: dict[str, LMS_Flowchart] = flowcharts or {}
-
+        self._flowcharts = flowcharts or []
         self._global_node_id = 0
 
     def __iter__(self):
@@ -36,6 +36,23 @@ class MSBF:
     def __len__(self):
         return len(self._flowcharts)
 
+    @classmethod
+    def new(cls,
+            is_big_endian: bool = False,
+            encoding: FileEncoding = FileEncoding.UTF16,
+            version: int = 3,
+            section_count: int = 2):
+        """
+        Create a new MSBF instance.
+
+        :param is_big_endian: if the file is big endian.
+        :param encoding: the file encoding.
+        :param version: the file version.
+        :param section_count: the number of sections.
+
+        """
+        return MSBF(LMS_FileInfo(is_big_endian, encoding, version, section_count))
+
     @property
     def info(self) -> LMS_FileInfo:
         """The file info for the MSBT instance."""
@@ -44,7 +61,7 @@ class MSBF:
     @property
     def flowcharts(self) -> MappingProxyType[str, LMS_Flowchart]:
         """The flowcharts of the MSBF instance."""
-        return MappingProxyType(self._flowcharts)
+        return MappingProxyType({flowchart.name: flowchart for flowchart in self._flowcharts})
 
     @property
     def global_node_id(self) -> int:
@@ -67,14 +84,14 @@ class MSBF:
 
         :param flowchart_name: The name of the new flowchart.
         """
-        if flowchart_name in self._flowcharts:
+        if flowchart_name in self.flowcharts:
             raise KeyError(f"Flowchart with name '{flowchart_name}' already exists!")
 
         if entry_point is None:
             entry_point = LMS_EntryNode(self.generate_next_id(), flowchart_name=flowchart_name)
 
         flowchart = LMS_Flowchart(entry_point, self.generate_next_id)
-        self._flowcharts[flowchart_name] = flowchart
+        self._flowcharts.append(flowchart)
         return flowchart
 
     def delete_flowchart(self, name: str):

{pylibms-4.0.2 → pylibms-4.0.4}/lms/message/msbt.py

@@ -65,7 +65,8 @@ class MSBT:
             encoding: FileEncoding = FileEncoding.UTF16,
             version: int = 3,
             section_count: int = 2):
-        """Create a new MSBT instance.
+        """
+        Create a new MSBT instance.
 
         :param uses_nli1: flag to determine if to use nli1 section for labels.
         :param attribute_config: the attribute config object

{pylibms-4.0.2 → pylibms-4.0.4}/pyproject.toml

@@ -7,7 +7,7 @@ include = ["lms*"]
 
 [project]
 name = "PyLibMS"
-version = "4.0.2"
+version = "4.0.4"
 requires-python = ">=3.12"
 description = "Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF."
 readme = "README.md"