PyLibMS 4.0.3__tar.gz → 4.1.0__tar.gz

{pylibms-4.0.3 → pylibms-4.1.0}/PKG-INFO

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyLibMS
-Version: 4.0.3
+Version: 4.1.0
 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.0.3 → pylibms-4.1.0}/lms/common/lms_exceptions.py

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

{pylibms-4.0.3 → pylibms-4.1.0}/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.3 → pylibms-4.1.0}/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.3 → pylibms-4.1.0}/lms/flowchart/definitions/node.py

@@ -122,8 +122,8 @@ class LMS_MessageNode(LMS_BaseNode):
             stream_next_node
         )
 
-        self._msbt_index = msbt_index
-        self._entry_index = label_index
+        self.msbt_index = msbt_index
+        self.label_index = label_index
         self._msbt = msbt
 
     @classmethod
@@ -147,16 +147,6 @@ class LMS_MessageNode(LMS_BaseNode):
         """
         return cls(None, None, file_index, msbt.entries.index(entry), msbt)
 
-    @property
-    def msbt_index(self) -> int:
-        """Index of the MSBT file the node references in a folder/archive."""
-        return self._msbt_index
-
-    @property
-    def label_index(self) -> int:
-        """Index of the MSBT entry the node references in the file."""
-        return self._entry_index
-
     @property
     def msbt(self) -> MSBT | None:
         """MSBT instance the node references. Optional, and must be set with `set_msbt` or by  providing a MSBT file on reading."""

{pylibms-4.0.3 → pylibms-4.1.0}/lms/flowchart/flw3.py

@@ -9,7 +9,7 @@ from lms.flowchart.definitions.node_type import LMS_NodeType, LMS_NodeParameterT
 from lms.message.msbt import MSBT
 from lms.titleconfig.definitions.nodes import NodeConfig, NodeDefinition
 
-NO_NEXT_NODE = -1
+NO_NEXT_NODE = 0xFFFF
 FLW3_HEADER_SIZE = 16
 NODE_SIZE = 16
 
@@ -50,7 +50,7 @@ def read_flw3(reader: FileReader, config: NodeConfig | None, msbt: MSBT | None,
                 reader.skip(2 + 4)
 
                 condition_id = reader.read_uint16()
-                case_count = reader.read_int16()
+                case_count = reader.read_uint16()
                 table_index = reader.read_uint16()
                 end = reader.tell()
 
@@ -86,7 +86,7 @@ def read_flw3(reader: FileReader, config: NodeConfig | None, msbt: MSBT | None,
             case LMS_NodeType.JUMP:
                 reader.seek(node_data)
                 next_flowchart_id = read_next_node_id(reader)
-                unknown_short0a = reader.read_int16()
+                unknown_short0a = reader.read_uint16()
                 node = LMS_JumpNode(i, next_flowchart_id, unknown_short0a)
                 reader.skip(4)
 
@@ -121,7 +121,7 @@ def read_flw3(reader: FileReader, config: NodeConfig | None, msbt: MSBT | None,
 
 
 def read_next_node_id(reader: FileReader) -> int | None:
-    return None if (id := reader.read_int16()) == NO_NEXT_NODE else id
+    return None if (id := reader.read_uint16()) == NO_NEXT_NODE else id
 
 
 def get_config_definition(config: NodeConfig,
@@ -163,15 +163,15 @@ def evaluate_node_parameter(reader: FileReader,
         # Default parameter reading
         match parameter_type:
             case LMS_NodeParameterType.PARAM_32_0 | LMS_NodeParameterType.PARAM_32_1:
-                return reader.read_int32()
+                return reader.read_uint32()
             case LMS_NodeParameterType.PARAM_16_16:
-                return reader.read_int16(), reader.read_int16()
+                return reader.read_uint16(), reader.read_uint16()
             case LMS_NodeParameterType.PARAM_16_8_8:
-                return reader.read_int16(), reader.read_int8(), reader.read_int8()
+                return reader.read_uint16(), reader.read_uint8(), reader.read_uint8()
             case LMS_NodeParameterType.PARAM_8_8_16:
-                return reader.read_int8(), reader.read_int8(), reader.read_int16()
+                return reader.read_uint8(), reader.read_uint8(), reader.read_uint16()
             case LMS_NodeParameterType.PARAM_8_8_8_8:
-                return reader.read_int8(), reader.read_int8(), reader.read_int8(), reader.read_int8()
+                return reader.read_uint8(), reader.read_uint8(), reader.read_uint8(), reader.read_uint8()
             case LMS_NodeParameterType.STRING:
                 return reader.read_string_offset(section_start)
             case _:
@@ -227,11 +227,11 @@ def write_flw3(writer: FileWriter, nodes: list[LMS_BaseNode], stream_ids: dict[L
                 starting_index = len(branch_table)
                 for branch in node.branches.values():
                     if branch is None:
-                        branch_table.append(-1)
+                        branch_table.append(NO_NEXT_NODE)
                     else:
                         branch_table.append(stream_ids[branch])
 
-                writer.write_int16(NO_NEXT_NODE)
+                writer.write_uint16(NO_NEXT_NODE)
 
                 writer.write_uint16(node.condition_id)
                 writer.write_uint16(node.case_count)
@@ -268,11 +268,11 @@ def write_flw3(writer: FileWriter, nodes: list[LMS_BaseNode], stream_ids: dict[L
                 writer.write_bytes(b"\x00" * 4)
 
                 write_next_node_id(writer, stream_ids[node.next_flowchart])
-                writer.write_int16(node.unknown_short0a)
+                writer.write_uint16(node.unknown_short0a)
                 writer.skip(4)
 
     for node_id in branch_table:
-        writer.write_int16(node_id)
+        writer.write_uint16(node_id)
 
     string_offset = FLW3_HEADER_SIZE + (NODE_SIZE * node_count) + (2 * len(branch_table))
 
@@ -303,24 +303,24 @@ def write_node_parameter(writer: FileWriter,
 
     match parameter_type:
         case LMS_NodeParameterType.PARAM_32_0 | LMS_NodeParameterType.PARAM_32_1:
-            writer.write_int32(value)
+            writer.write_uint32(value)
         case LMS_NodeParameterType.PARAM_16_16:
-            writer.write_int16(value[0])
-            writer.write_int16(value[1])
+            writer.write_uint16(value[0])
+            writer.write_uint16(value[1])
         case LMS_NodeParameterType.PARAM_16_8_8:
-            writer.write_int16(value[0])
-            writer.write_int8(value[1])
-            writer.write_int8(value[2])
+            writer.write_uint16(value[0])
+            writer.write_uint8(value[1])
+            writer.write_uint8(value[2])
         case LMS_NodeParameterType.PARAM_8_8_16:
-            writer.write_int8(value[0])
-            writer.write_int8(value[1])
-            writer.write_int16(value[2])
+            writer.write_uint8(value[0])
+            writer.write_uint8(value[1])
+            writer.write_uint16(value[2])
         case LMS_NodeParameterType.PARAM_8_8_8_8:
-            writer.write_int8(value[0])
-            writer.write_int8(value[1])
-            writer.write_int8(value[2])
-            writer.write_int8(value[3])
+            writer.write_uint8(value[0])
+            writer.write_uint8(value[1])
+            writer.write_uint8(value[2])
+            writer.write_uint8(value[3])
 
 
 def write_next_node_id(writer: FileWriter, id: int | None) -> None:
-    writer.write_int16(NO_NEXT_NODE if id is None else id)
+    writer.write_uint16(NO_NEXT_NODE if id is None else id)

{pylibms-4.0.3 → pylibms-4.1.0}/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,18 +25,34 @@ 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):
-        return iter(self._flowcharts.values())
+        return iter(self._flowcharts)
 
     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.3 → pylibms-4.1.0}/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.3 → pylibms-4.1.0}/lms/titleconfig/config.py

@@ -1,5 +1,9 @@
-from importlib import resources
+import hashlib
+import os.path
+import pathlib
+from typing import Literal, get_args
 
+import requests
 import yaml
 
 from lms.common.field.lms_datatype import LMS_DataType
@@ -10,6 +14,8 @@ from lms.titleconfig.definitions.nodes import NodeConfig, NodeDefinition
 from lms.titleconfig.definitions.tags import TagConfig, TagDefinition
 from lms.titleconfig.definitions.value import ValueDefinition
 
+PRESETS_URL = "https://api.github.com/repos/AbdyyEee/PyLibMS/contents/lms/titleconfig/presets"
+
 
 class TitleConfig:
     """
@@ -20,9 +26,17 @@ class TitleConfig:
     ATTR_KEY = "attribute_definitions"
     NODE_KEY = "node_definitions"
 
-    PRESET_LIST = [
-        file.name.removesuffix(".yaml")
-        for file in resources.files("lms.titleconfig.presets").iterdir()
+    GAME_PRESET = Literal[
+        "Badge Arcade",
+        "Brain Age Concentration Training",
+        "Kirby Planet Robobot",
+        "Super Mario Odyssey",
+        "Super Mario 3D Land",
+        "Super Mario 3D World + Bowsers Fury",
+        "The Legend of Zelda a Link Between Worlds",
+        "The Legend of Zelda Echos of Wisdom",
+        "Tomodachi Life Living The Dream",
+        "Tomodachi Life NA-EU",
     ]
 
     def __init__(
@@ -42,6 +56,84 @@ class TitleConfig:
         """The name of the game for the titleconfig."""
         return self._game
 
+    @classmethod
+    def get_preset_list(cls) -> tuple[str, ...]:
+        """Get the current preset list."""
+        return get_args(cls.GAME_PRESET)
+
+    @classmethod
+    def preset_has_update(cls, game: GAME_PRESET) -> bool:
+        """
+        Checks whether a preset has an available update.
+
+        :param game: the game preset.
+        """
+        preset_list = cls._request_preset_list()
+
+        if f"{game}.yaml" not in os.listdir("presets"):
+            raise FileNotFoundError(f"Preset '{game}.yaml' was not found!")
+
+        path = os.path.join("presets", f"{game}.yaml")
+
+        with open(path, "rb") as f:
+            data = f.read().replace(b"\r\n", b"\n")
+
+        # Blob calculation https://git-scm.com/book/en/v2/Git-Internals-Git-Objects.html
+        local_hash = hashlib.sha1(f"blob {len(data)}\0".encode() + data).hexdigest()
+
+        return local_hash != preset_list[game.lower()]["sha"]
+
+    @classmethod
+    def download_preset(cls, game: GAME_PRESET):
+        """
+        Fetches a preset from the repository and loads it to ./presets
+
+        :param game: the game preset.
+
+        List of presets:
+
+        https://github.com/AbdyyEee/PylibMS/tree/main/lms/titleconfig/presets
+        """
+
+        preset_list = cls._request_preset_list()
+
+        if game.lower() not in preset_list:
+            raise FileNotFoundError(f"Preset '{game}' not found.")
+
+        raw = cls._request_preset_file(game, preset_list)
+
+        if "presets" not in os.path.join(os.getcwd(), "presets", f"{game}.yaml"):
+            pathlib.Path("presets").mkdir()
+
+        path = os.path.join("presets", f"{game}.yaml")
+        with open(path, "wb") as f:
+            f.write(raw.content)
+
+    @classmethod
+    def _request_preset_list(cls) -> dict[str, dict]:
+        result = {}
+
+        try:
+            folder_response = requests.get(PRESETS_URL, timeout=10)
+            folder_response.raise_for_status()
+        except requests.exceptions.RequestException as e:
+            raise RuntimeError("An error occurred fetching the preset list!") from e
+
+        for preset in folder_response.json():
+            result[os.path.basename(preset["path"]).lower().removesuffix(".yaml")] = preset
+
+        return result
+
+    @classmethod
+    def _request_preset_file(cls, game: str, preset_list: dict) -> requests.Response:
+        try:
+            raw_response = requests.get(preset_list[game.lower()]["download_url"], timeout=10)
+            raw_response.raise_for_status()
+        except requests.exceptions.RequestException as e:
+            raise RuntimeError(f"An error occurred fetching the file data for preset '{game}'") from e
+
+        return raw_response
+
     @property
     def tag_config(self) -> TagConfig | None:
         """The loaded tag config instance."""
@@ -75,26 +167,6 @@ class TitleConfig:
         """The loaded node configuration."""
         return self._node_config
 
-    @classmethod
-    def load_preset(cls, game: str):
-        """
-        Loads an existing preset from a game.
-
-        :param game: the game preset.
-
-        The list of presets are found with `TitleConfig.preset_list`.
-        """
-        # TODO: Load presets via requests instead of hard-coded files in the library
-        preset_map = {preset.lower(): preset for preset in cls.PRESET_LIST}
-
-        if game.lower() not in preset_map:
-            raise FileNotFoundError(f"Preset '{game}' not found.")
-
-        actual_name = preset_map[game.lower()]
-
-        with resources.open_text("lms.titleconfig.presets", f"{actual_name}.yaml") as f:
-            return cls.load_config(f.read())
-
     @classmethod
     def load_file(cls, file_path: str):
         """

{pylibms-4.0.3 → pylibms-4.1.0}/lms/titleconfig/definitions/nodes.py

@@ -69,16 +69,16 @@ class NodeDefinition:
             if datatype_from_dict is None:
                 match parameter_type:
                     case LMS_NodeParameterType.PARAM_32_0 | LMS_NodeParameterType.PARAM_32_1:
-                        datatype_from_dict = LMS_DataType.INT32
+                        datatype_from_dict = LMS_DataType.UINT32
                     case LMS_NodeParameterType.PARAM_16_16:
-                        datatype_from_dict = (LMS_DataType.INT16, LMS_DataType.INT16)[i]
+                        datatype_from_dict = (LMS_DataType.UINT16, LMS_DataType.UINT16)[i]
                     case LMS_NodeParameterType.PARAM_16_8_8:
-                        datatype_from_dict = (LMS_DataType.INT16, LMS_DataType.INT8, LMS_DataType.INT8)[i]
+                        datatype_from_dict = (LMS_DataType.UINT16, LMS_DataType.UINT8, LMS_DataType.UINT8)[i]
                     case LMS_NodeParameterType.PARAM_8_8_16:
-                        datatype_from_dict = (LMS_DataType.INT8, LMS_DataType.INT8, LMS_DataType.INT16)[i]
+                        datatype_from_dict = (LMS_DataType.UINT8, LMS_DataType.UINT8, LMS_DataType.UINT16)[i]
                     case LMS_NodeParameterType.PARAM_8_8_8_8:
                         datatype_from_dict = \
-                            (LMS_DataType.INT8, LMS_DataType.INT8, LMS_DataType.INT8, LMS_DataType.INT8)[i]
+                            (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,

{pylibms-4.0.3 → pylibms-4.1.0}/lms/titleconfig/presets/Tomodachi Life NA-EU.yaml

@@ -3,61 +3,43 @@ node_definitions:
   branch:
     - id: 0
       name: EvaluateExpression
+      description: ''
       parameter_type: string
       parameters:
         - name: exp
-          description: ''
     - id: 1
       name: SwitchVariable
-      description: ''
       parameter_type: string
       parameters:
         - name: var
-          description: ''
   event:
     - id: 3
       name: SetVariable
-      description: ''
       parameter_type: string
       parameters:
         - name: expression
-          description: ''
     - id: 43
       name: SetMiiPosition
-      description: ''
       parameter_type: string
       parameters:
         - name: pos
-          description: ''
-    - id: 48
-      name: SetupMessage
-      description: ''
-      parameter_type: p16_16
-      parameters:
-        - name: val1
-        - name: val2
     - id: 58
       name: SetupButtonPrompt
-      description: ''
       next_node_dependency: true
       parameter_type: string
       parameters:
         - name: var
-          description: ''
     - id: 90
       name: LoadSEGroup
-      description: ''
       parameter_type: string
       parameters:
         - name: group
           description: ''
     - id: 96
       name: PlaySE
-      description: ''
       parameter_type: string
       parameters:
         - name: name
-          description: ''
 tag_definitions:
   groups:
     0: System
@@ -96,7 +78,7 @@ tag_definitions:
       description: 'Alters the size of the text.'
       parameters:
         - name: percent
-          description: 'The size as a percentage'
+          description: 'The size as a percentage.'
           datatype: uint16
     - name: Color
       group_id: 0
@@ -7466,4 +7448,4 @@ attribute_definitions:
           - Relation
       - name: SolvedCount
         description: ''
-        datatype: uint8
+        datatype: uint8

{pylibms-4.0.3 → pylibms-4.1.0}/pyproject.toml

@@ -7,7 +7,7 @@ include = ["lms*"]
 
 [project]
 name = "PyLibMS"
-version = "4.0.3"
+version = "4.1.0"
 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"