PyLibMS 4.3.3__tar.gz → 5.0.0__tar.gz

{pylibms-4.3.3 → pylibms-5.0.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 4.3.3
+Version: 5.0.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
+Project-URL: Documentation, https://github.com/AbdyyEee/PylibMS/wiki
 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
@@ -30,11 +30,11 @@ formats from Nintendo.
 
 The following is supported:
 
-| Format | Read | Write | Configuration Support                                                                                                                       |
+| Format | Read | Write | Support                                                                                                                                     |
 |--------|------|-------|---------------------------------------------------------------------------------------------------------------------------------------------|
-| `MSBT` | ✅   | ✅    | Support for full attribute (`ATR1`) decoding. Tag decoding 1:1 matching with 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.                                                                                   |
+| `MSBT` | ✅   | ✅    | 1:1 Reading and writing Support for majority of sections. Full attribute (`ATR1`) decoding with configurations. Tag decoding 1:1 with the official Nintendo `.mstxt` file format. |
+| `MSBF` | ✅   | ✅    | 1:1 Reading and writing flowcharts (`FLW3`). Support for custom node definitions, attaching names and descriptions to nodes. Altering parameter datatypes for flexibility between games. |
+| `MSBP` | ✅   | ❌    | Viewing all MSBP relevant metadata and 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.
@@ -45,46 +45,31 @@ Simple preview of the library is below. See [the wiki](https://github.com/AbdyyE
 and examples.
 
 ## Reading
-
-### MSBT
-
 ```py
+# MSBT
 from lms.message.msbtio import read_msbt_path
 
 msbt = read_msbt_path("Text.msbt")
-```
-
-### MSBP
 
-```py
+# MSBP
 from lms.project.msbpread import read_msbp_path
 
 msbp = read_msbp_path("Project.msbp")
-```
-
-### MSBF
 
-```py
+# MSBF
 from lms.flowchart.msbfio import read_msbf_path
 
 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
+# MSBT
 from lms.message.msbtio import write_msbt_path
 
 write_msbt_path("Out_text.msbt")
-```
 
-### MSBF
-
-```py
+# MSBF
 from lms.flowchart.msbfio import write_msbf_path
 
 write_msbf_path("Out_Flowchart.msbf")
@@ -114,8 +99,16 @@ cd PyLibMS
 pip install -e .
 ```
 
-# Credits & Sources
+# AI Disclaimer
+Code in this library was written by me. AI was utilized occasionally when fit and always reviewed by me.
+
+`MSBT`: Only usage of AI was for control tag regex formats and for understanding implementing string importing with `re`.
+
+`MSBP`: AI was not utilized anywhere.
 
+`MSBF`: AI was only utilized for the `LMS_BaseNode.get_descendents` function and for consultation for ways to improve the API.
+
+# Credits & Sources
 * [SS-Decomp](https://github.com/zeldaret/ss): Referenced some parts of their MSBF decomp when adding the format
   to [Nintendo-File-Formats](https://nintendo-formats.com) and this library.
 * [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file

{pylibms-4.3.3 → pylibms-5.0.0}/PyLibMS.egg-info/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 4.3.3
+Version: 5.0.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
+Project-URL: Documentation, https://github.com/AbdyyEee/PylibMS/wiki
 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
@@ -30,11 +30,11 @@ formats from Nintendo.
 
 The following is supported:
 
-| Format | Read | Write | Configuration Support                                                                                                                       |
+| Format | Read | Write | Support                                                                                                                                     |
 |--------|------|-------|---------------------------------------------------------------------------------------------------------------------------------------------|
-| `MSBT` | ✅   | ✅    | Support for full attribute (`ATR1`) decoding. Tag decoding 1:1 matching with 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.                                                                                   |
+| `MSBT` | ✅   | ✅    | 1:1 Reading and writing Support for majority of sections. Full attribute (`ATR1`) decoding with configurations. Tag decoding 1:1 with the official Nintendo `.mstxt` file format. |
+| `MSBF` | ✅   | ✅    | 1:1 Reading and writing flowcharts (`FLW3`). Support for custom node definitions, attaching names and descriptions to nodes. Altering parameter datatypes for flexibility between games. |
+| `MSBP` | ✅   | ❌    | Viewing all MSBP relevant metadata and 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.
@@ -45,46 +45,31 @@ Simple preview of the library is below. See [the wiki](https://github.com/AbdyyE
 and examples.
 
 ## Reading
-
-### MSBT
-
 ```py
+# MSBT
 from lms.message.msbtio import read_msbt_path
 
 msbt = read_msbt_path("Text.msbt")
-```
-
-### MSBP
 
-```py
+# MSBP
 from lms.project.msbpread import read_msbp_path
 
 msbp = read_msbp_path("Project.msbp")
-```
-
-### MSBF
 
-```py
+# MSBF
 from lms.flowchart.msbfio import read_msbf_path
 
 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
+# MSBT
 from lms.message.msbtio import write_msbt_path
 
 write_msbt_path("Out_text.msbt")
-```
 
-### MSBF
-
-```py
+# MSBF
 from lms.flowchart.msbfio import write_msbf_path
 
 write_msbf_path("Out_Flowchart.msbf")
@@ -114,8 +99,16 @@ cd PyLibMS
 pip install -e .
 ```
 
-# Credits & Sources
+# AI Disclaimer
+Code in this library was written by me. AI was utilized occasionally when fit and always reviewed by me.
+
+`MSBT`: Only usage of AI was for control tag regex formats and for understanding implementing string importing with `re`.
+
+`MSBP`: AI was not utilized anywhere.
 
+`MSBF`: AI was only utilized for the `LMS_BaseNode.get_descendents` function and for consultation for ways to improve the API.
+
+# Credits & Sources
 * [SS-Decomp](https://github.com/zeldaret/ss): Referenced some parts of their MSBF decomp when adding the format
   to [Nintendo-File-Formats](https://nintendo-formats.com) and this library.
 * [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file

{pylibms-4.3.3 → pylibms-5.0.0}/PyLibMS.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ PyLibMS.egg-info/dependency_links.txt
 PyLibMS.egg-info/requires.txt
 PyLibMS.egg-info/top_level.txt
 lms/__init__.py
+lms/py.typed
 lms/common/__init__.py
 lms/common/lms_constants.py
 lms/common/lms_exceptions.py
@@ -26,7 +27,6 @@ lms/flowchart/flw3.py
 lms/flowchart/msbf.py
 lms/flowchart/msbfio.py
 lms/flowchart/definitions/__init__.py
-lms/flowchart/definitions/flowchart.py
 lms/flowchart/definitions/lms_nodeexceptions.py
 lms/flowchart/definitions/node.py
 lms/flowchart/definitions/node_type.py
@@ -67,9 +67,9 @@ lms/titleconfig/__init__.py
 lms/titleconfig/config.py
 lms/titleconfig/definitions/__init__.py
 lms/titleconfig/definitions/attribute.py
+lms/titleconfig/definitions/field.py
 lms/titleconfig/definitions/nodes.py
 lms/titleconfig/definitions/tags.py
-lms/titleconfig/definitions/value.py
 lms/titleconfig/presets/Badge Arcade.yaml
 lms/titleconfig/presets/Brain Age Concentration Training.yaml
 lms/titleconfig/presets/Kirby Planet Robobot.yaml

{pylibms-4.3.3 → pylibms-5.0.0}/README.md

@@ -9,11 +9,11 @@ formats from Nintendo.
 
 The following is supported:
 
-| Format | Read | Write | Configuration Support                                                                                                                       |
+| Format | Read | Write | Support                                                                                                                                     |
 |--------|------|-------|---------------------------------------------------------------------------------------------------------------------------------------------|
-| `MSBT` | ✅   | ✅    | Support for full attribute (`ATR1`) decoding. Tag decoding 1:1 matching with 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.                                                                                   |
+| `MSBT` | ✅   | ✅    | 1:1 Reading and writing Support for majority of sections. Full attribute (`ATR1`) decoding with configurations. Tag decoding 1:1 with the official Nintendo `.mstxt` file format. |
+| `MSBF` | ✅   | ✅    | 1:1 Reading and writing flowcharts (`FLW3`). Support for custom node definitions, attaching names and descriptions to nodes. Altering parameter datatypes for flexibility between games. |
+| `MSBP` | ✅   | ❌    | Viewing all MSBP relevant metadata and 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.
@@ -24,46 +24,31 @@ Simple preview of the library is below. See [the wiki](https://github.com/AbdyyE
 and examples.
 
 ## Reading
-
-### MSBT
-
 ```py
+# MSBT
 from lms.message.msbtio import read_msbt_path
 
 msbt = read_msbt_path("Text.msbt")
-```
 
-### MSBP
-
-```py
+# MSBP
 from lms.project.msbpread import read_msbp_path
 
 msbp = read_msbp_path("Project.msbp")
-```
-
-### MSBF
 
-```py
+# MSBF
 from lms.flowchart.msbfio import read_msbf_path
 
 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
+# MSBT
 from lms.message.msbtio import write_msbt_path
 
 write_msbt_path("Out_text.msbt")
-```
-
-### MSBF
 
-```py
+# MSBF
 from lms.flowchart.msbfio import write_msbf_path
 
 write_msbf_path("Out_Flowchart.msbf")
@@ -93,8 +78,16 @@ cd PyLibMS
 pip install -e .
 ```
 
-# Credits & Sources
+# AI Disclaimer
+Code in this library was written by me. AI was utilized occasionally when fit and always reviewed by me.
 
+`MSBT`: Only usage of AI was for control tag regex formats and for understanding implementing string importing with `re`.
+
+`MSBP`: AI was not utilized anywhere.
+
+`MSBF`: AI was only utilized for the `LMS_BaseNode.get_descendents` function and for consultation for ways to improve the API.
+
+# Credits & Sources
 * [SS-Decomp](https://github.com/zeldaret/ss): Referenced some parts of their MSBF decomp when adding the format
   to [Nintendo-File-Formats](https://nintendo-formats.com) and this library.
 * [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file

{pylibms-4.3.3 → pylibms-5.0.0}/lms/common/field/io.py

@@ -4,18 +4,18 @@ from lms.common.field.lms_datatype import (
     LMS_DataType,
     is_bool_datatype,
     is_bytes_datatype,
-    is_list_datatype,
+    is_enum_datatype,
     is_number_datatype,
 )
 from lms.common.field.lms_field import LMS_Field
 from lms.fileio.io import FileReader, FileWriter
-from lms.titleconfig.definitions.value import ValueDefinition
+from lms.titleconfig.definitions.field import FieldDefinition
 
 
 def read_field(
-    reader: FileReader,
-    definition: ValueDefinition,
-    read_variable_width_value: Callable | None = None,
+        reader: FileReader,
+        definition: FieldDefinition,
+        read_variable_width_value: Callable | None = None,
 ) -> LMS_Field:
     # String is excluded as their reading varies between MSBT/MSBF
     match definition.datatype:
@@ -33,27 +33,25 @@ def read_field(
             value = reader.read_int32()
         case LMS_DataType.FLOAT32:
             value = reader.read_float32()
-        case LMS_DataType.LIST:
+        case LMS_DataType.ENUM:
             if read_variable_width_value is not None:
                 index = read_variable_width_value()
             else:
                 index = reader.read_uint8()
-            value = definition.list_items[index]
+            value = definition.enum_members[index]
         case LMS_DataType.BOOL:
             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
+    return LMS_Field(value, definition)
 
 
 def write_field(
-    writer: FileWriter,
-    field: LMS_Field,
-    write_variable_width_value: Callable | None = None,
+        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] = {
@@ -68,8 +66,8 @@ def write_field(
         write_functions[field.datatype](field.value)
         return
 
-    if is_list_datatype(field.value, field.datatype):
-        value = field.list_items.index(field.value)
+    if is_enum_datatype(field.value, field.datatype):
+        value = list(field.enum_members.values()).index(field.value)
         if write_variable_width_value is not None:
             write_variable_width_value(value)
         else:

{pylibms-4.3.3 → pylibms-5.0.0}/lms/common/field/lms_datatype.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from enum import Enum
+from enum import IntEnum, auto
 from typing import Type, TypeGuard
 
 FLOAT32_MIN = -3.4028235e38
@@ -15,8 +15,9 @@ ALIAS_MAP = {
     "i32": "INT32",
     "f32": "FLOAT32",
     "str": "STRING",
+    # LIST fallback for ENUM datatype
+    "list": "ENUM",
     "bool": "BOOL",
-    "byte": "BYTES",
 }
 
 
@@ -32,8 +33,8 @@ def is_number_datatype(value: object, datatype: LMS_DataType) -> TypeGuard[int |
     ) and isinstance(value, int)
 
 
-def is_list_datatype(value: object, datatype: LMS_DataType) -> TypeGuard[str]:
-    return datatype is LMS_DataType.LIST and isinstance(value, str)
+def is_enum_datatype(value: object, datatype: LMS_DataType) -> TypeGuard[str]:
+    return datatype is LMS_DataType.ENUM and isinstance(value, str)
 
 
 def is_bool_datatype(value: object, datatype: LMS_DataType) -> TypeGuard[bool]:
@@ -48,7 +49,7 @@ def is_string_datatype(value: object, datatype: LMS_DataType) -> TypeGuard[str]:
     return datatype is LMS_DataType.STRING and isinstance(value, str)
 
 
-class LMS_DataType(Enum):
+class LMS_DataType(IntEnum):
     """Enum that represents a datatype for a value entry in a MSBT/MSBP file."""
 
     UINT8 = 0
@@ -62,64 +63,56 @@ class LMS_DataType(Enum):
     FLOAT32 = 6
 
     STRING = 8
-    LIST = 9
+    ENUM = 9
 
-    # - Interface types -
-    # These types act as an abstraction for a real LMS_Datatype
-    # The actual value isn't important since they are not real types, but are instantiated from a config
-    BOOL = "bool"
-    BYTES = "byte"
-
-    def to_string(self) -> str:
-        return self._name_.lower()
+    # Interface type for UINT8
+    BOOL = auto()
 
     @property
     def signed(self) -> bool:
         """Property for if the type is signed or not."""
         if self not in [
-            LMS_DataType.STRING,
-            LMS_DataType.LIST,
-            LMS_DataType.BOOL,
-            LMS_DataType.BYTES,
+            self.STRING,
+            self.ENUM,
+            self.BOOL,
         ]:
-            return self in [LMS_DataType.INT8, LMS_DataType.INT16, LMS_DataType.INT32]
+            return self in [self.INT8, self.INT16, self.INT32]
 
-        raise TypeError(f"Signed is not a valid property for '{self.to_string()}'!")
+        raise TypeError(f"Signed is not a valid property for '{self.name.lower()}'!")
 
     @property
     def builtin_type(self) -> Type[int | float | str | bool | bytes]:
         """The enum as the builtin python type."""
         return {
-            LMS_DataType.UINT8: int,
-            LMS_DataType.UINT16: int,
-            LMS_DataType.UINT32: int,
-            LMS_DataType.INT8: int,
-            LMS_DataType.INT16: int,
-            LMS_DataType.INT32: int,
-            LMS_DataType.FLOAT32: float,
-            LMS_DataType.STRING: str,
-            LMS_DataType.LIST: str,
-            LMS_DataType.BOOL: bool,
-            LMS_DataType.BYTES: bytes,
+            self.UINT8: int,
+            self.UINT16: int,
+            self.UINT32: int,
+            self.INT8: int,
+            self.INT16: int,
+            self.INT32: int,
+            self.FLOAT32: float,
+            self.STRING: str,
+            self.ENUM: str,
+            self.BOOL: bool,
         }[self]
 
     @property
     def stream_size(self) -> int:
         """Size of the datatype, only for fixed integers."""
         sizes = {
-            LMS_DataType.UINT8: 1,
-            LMS_DataType.UINT16: 2,
-            LMS_DataType.UINT32: 4,
-            LMS_DataType.INT8: 1,
-            LMS_DataType.INT16: 2,
-            LMS_DataType.INT32: 4,
-            LMS_DataType.FLOAT32: 4,
+            self.UINT8: 1,
+            self.UINT16: 2,
+            self.UINT32: 4,
+            self.INT8: 1,
+            self.INT16: 2,
+            self.INT32: 4,
+            self.FLOAT32: 4,
         }
 
         try:
             return sizes[self]
         except KeyError:
-            raise TypeError(f"Stream size is not defined for '{self.to_string()}'.")
+            raise TypeError(f"Stream size is not defined for '{self.name.lower()}'.")
 
     @classmethod
     def from_string(cls, string: str):
@@ -136,8 +129,8 @@ class LMS_DataType(Enum):
 
 
 def verify_number_from_datatype(
-    value: int | float,
-    datatype: LMS_DataType,
+        value: int | float,
+        datatype: LMS_DataType,
 ):
     if datatype is LMS_DataType.FLOAT32:
         max_value = FLOAT32_MAX
@@ -148,7 +141,7 @@ def verify_number_from_datatype(
             max_value = 2 ** (bits - 1)
             min_value = -max_value
         else:
-            min_value, max_value = 0, (2**bits) - 1
+            min_value, max_value = 0, (2 ** bits) - 1
 
     if not min_value <= value <= max_value:
         raise ValueError(