PyLibMS 3.3.9__tar.gz → 4.0.1__tar.gz

pylibms-4.0.1/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: PyLibMS
+Version: 4.0.1
+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
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0.1
+Dynamic: license-file
+
+# 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:
+
+| File 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                                                                                       |
+
+This library is designed to support LMS revision 3.0 and above, with the associated file formats used across the
+following Nintendo platforms:
+
+* Wii (Specific titles only)
+* Nintendo 3DS
+* Wii U
+* Mobile (Specific titles only)
+* Nintendo Switch
+
+# Features and Usage
+
+Simple preview of the library is below. See [the wiki](https://github.com/AbdyyEee/PylibMS/wiki) for more explanations
+and examples.
+
+## Reading
+
+MSBT/MSBF
+
+```py
+from lms.message.msbtio import read_msbt_path
+from lms.message.msbfio import read_msbf_path
+
+msbt = read_msbt_path("Game.msbt")
+msbf = read_msbf_path("Game_Flowchart.msbf")
+```
+
+## Writing
+
+```py
+from lms.message.msbtio import write_msbt_path
+from lms.message.msbfio import write_msbf_path
+
+write_msbt_path("Out_Game.msbt")
+write_msbf_path("Out_Game_Flowchart.msbt")
+```
+
+# Adding/Editing Presets
+
+To add or edit Preset, you may create an issue with the relevant `yaml` file and the game it is for.
+
+# Installation
+
+```
+pip install PylibMS
+```
+
+[Pip Page](https://pypi.org/project/PyLibMS/)
+
+# Build Instructions
+
+Python version must be `>=3.12.`
+
+Clone the repository, then run `pip install` (venv recommended)
+
+```bash
+git clone https://github.com/AbdyyEee/PylibMS.git
+cd PylibMS
+pip install -e 
+```
+
+# Credits & Sources
+
+* [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file
+  formats.
+* [Trippixyz](https://github.com/Trippixyz): For helping me get started general decompilation of the formats and general
+  help.
+* [AeonSake](https://github.com/AeonSake): Inspiration for some the implementation of the library and a bit of general
+  help.

pylibms-4.0.1/PyLibMS.egg-info/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: PyLibMS
+Version: 4.0.1
+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
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0.1
+Dynamic: license-file
+
+# 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:
+
+| File 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                                                                                       |
+
+This library is designed to support LMS revision 3.0 and above, with the associated file formats used across the
+following Nintendo platforms:
+
+* Wii (Specific titles only)
+* Nintendo 3DS
+* Wii U
+* Mobile (Specific titles only)
+* Nintendo Switch
+
+# Features and Usage
+
+Simple preview of the library is below. See [the wiki](https://github.com/AbdyyEee/PylibMS/wiki) for more explanations
+and examples.
+
+## Reading
+
+MSBT/MSBF
+
+```py
+from lms.message.msbtio import read_msbt_path
+from lms.message.msbfio import read_msbf_path
+
+msbt = read_msbt_path("Game.msbt")
+msbf = read_msbf_path("Game_Flowchart.msbf")
+```
+
+## Writing
+
+```py
+from lms.message.msbtio import write_msbt_path
+from lms.message.msbfio import write_msbf_path
+
+write_msbt_path("Out_Game.msbt")
+write_msbf_path("Out_Game_Flowchart.msbt")
+```
+
+# Adding/Editing Presets
+
+To add or edit Preset, you may create an issue with the relevant `yaml` file and the game it is for.
+
+# Installation
+
+```
+pip install PylibMS
+```
+
+[Pip Page](https://pypi.org/project/PyLibMS/)
+
+# Build Instructions
+
+Python version must be `>=3.12.`
+
+Clone the repository, then run `pip install` (venv recommended)
+
+```bash
+git clone https://github.com/AbdyyEee/PylibMS.git
+cd PylibMS
+pip install -e 
+```
+
+# Credits & Sources
+
+* [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file
+  formats.
+* [Trippixyz](https://github.com/Trippixyz): For helping me get started general decompilation of the formats and general
+  help.
+* [AeonSake](https://github.com/AeonSake): Inspiration for some the implementation of the library and a bit of general
+  help.

{pylibms-3.3.9 → pylibms-4.0.1}/PyLibMS.egg-info/SOURCES.txt

@@ -9,23 +9,34 @@ PyLibMS.egg-info/requires.txt
 PyLibMS.egg-info/top_level.txt
 lms/__init__.py
 lms/common/__init__.py
-lms/common/lms_datatype.py
+lms/common/lms_constants.py
 lms/common/lms_exceptions.py
 lms/common/lms_fileinfo.py
+lms/common/field/__init__.py
+lms/common/field/io.py
+lms/common/field/lms_datatype.py
+lms/common/field/lms_field.py
 lms/common/stream/fileinfo.py
 lms/common/stream/hashtable.py
 lms/common/stream/section.py
 lms/fileio/encoding.py
 lms/fileio/io.py
+lms/flowchart/__init__.py
+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
 lms/message/__init__.py
+lms/message/lms_messagetext.py
 lms/message/msbt.py
 lms/message/msbtentry.py
 lms/message/msbtio.py
 lms/message/definitions/__init__.py
-lms/message/definitions/lms_messagetext.py
 lms/message/definitions/field/__init__.py
-lms/message/definitions/field/io.py
-lms/message/definitions/field/lms_field.py
 lms/message/section/__init__.py
 lms/message/section/atr1.py
 lms/message/section/nli1.py
@@ -56,6 +67,7 @@ lms/titleconfig/__init__.py
 lms/titleconfig/config.py
 lms/titleconfig/definitions/__init__.py
 lms/titleconfig/definitions/attribute.py
+lms/titleconfig/definitions/nodes.py
 lms/titleconfig/definitions/tags.py
 lms/titleconfig/definitions/value.py
 lms/titleconfig/presets/Badge Arcade.yaml
@@ -66,6 +78,5 @@ lms/titleconfig/presets/Super Mario 3D World + Bowsers Fury.yaml
 lms/titleconfig/presets/Super Mario Odyssey.yaml
 lms/titleconfig/presets/The Legend of Zelda Echos of Wisdom.yaml
 lms/titleconfig/presets/The Legend of Zelda a Link Between Worlds.yaml
-lms/titleconfig/presets/Tomodachi Life Living The Dream Demo.yaml
-lms/titleconfig/presets/Tomodachi Life Living the Dream Demo.yaml
-lms/titleconfig/presets/Tomodachi Life.yaml
+lms/titleconfig/presets/Tomodachi Life Living The Dream.yaml
+lms/titleconfig/presets/Tomodachi Life NA-EU.yaml

pylibms-4.0.1/README.md

@@ -0,0 +1,79 @@
+# 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:
+
+| File 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                                                                                       |
+
+This library is designed to support LMS revision 3.0 and above, with the associated file formats used across the
+following Nintendo platforms:
+
+* Wii (Specific titles only)
+* Nintendo 3DS
+* Wii U
+* Mobile (Specific titles only)
+* Nintendo Switch
+
+# Features and Usage
+
+Simple preview of the library is below. See [the wiki](https://github.com/AbdyyEee/PylibMS/wiki) for more explanations
+and examples.
+
+## Reading
+
+MSBT/MSBF
+
+```py
+from lms.message.msbtio import read_msbt_path
+from lms.message.msbfio import read_msbf_path
+
+msbt = read_msbt_path("Game.msbt")
+msbf = read_msbf_path("Game_Flowchart.msbf")
+```
+
+## Writing
+
+```py
+from lms.message.msbtio import write_msbt_path
+from lms.message.msbfio import write_msbf_path
+
+write_msbt_path("Out_Game.msbt")
+write_msbf_path("Out_Game_Flowchart.msbt")
+```
+
+# Adding/Editing Presets
+
+To add or edit Preset, you may create an issue with the relevant `yaml` file and the game it is for.
+
+# Installation
+
+```
+pip install PylibMS
+```
+
+[Pip Page](https://pypi.org/project/PyLibMS/)
+
+# Build Instructions
+
+Python version must be `>=3.12.`
+
+Clone the repository, then run `pip install` (venv recommended)
+
+```bash
+git clone https://github.com/AbdyyEee/PylibMS.git
+cd PylibMS
+pip install -e 
+```
+
+# Credits & Sources
+
+* [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file
+  formats.
+* [Trippixyz](https://github.com/Trippixyz): For helping me get started general decompilation of the formats and general
+  help.
+* [AeonSake](https://github.com/AeonSake): Inspiration for some the implementation of the library and a bit of general
+  help.

{pylibms-3.3.9/lms/message/definitions → pylibms-4.0.1/lms/common}/field/io.py

@@ -1,15 +1,15 @@
 from typing import Callable
 
-from lms.common.lms_datatype import (LMS_DataType, is_bool_datatype,
-                                     is_bytes_datatype, is_list_datatype,
-                                     is_number_datatype)
+from lms.common.field.lms_datatype import (LMS_DataType, is_bool_datatype,
+                                           is_bytes_datatype, is_list_datatype,
+                                           is_number_datatype)
+from lms.common.field.lms_field import LMS_Field
 from lms.fileio.io import FileReader, FileWriter
-from lms.message.definitions.field.lms_field import LMS_Field
 from lms.titleconfig.definitions.value import ValueDefinition
 
 
 def read_field(reader: FileReader, definition: ValueDefinition) -> LMS_Field:
-    # String is excluded as their reading varies between tags and attributes
+    # String is excluded as their reading varies between MSBT/MSBF
     match definition.datatype:
         case LMS_DataType.UINT8:
             value = reader.read_uint8()

{pylibms-3.3.9/lms/common → pylibms-4.0.1/lms/common/field}/lms_datatype.py

@@ -16,6 +16,7 @@ ALIAS_MAP = {
     "byte": "BYTES",
 }
 
+
 def is_number_datatype(value: object, datatype: LMS_DataType) -> TypeGuard[int | float]:
     return datatype in (
         LMS_DataType.UINT8,
@@ -57,16 +58,10 @@ class LMS_DataType(Enum):
 
     FLOAT32 = 6
 
-    # Unknown 16 bit type (value of 6) has yet to be documented
-    # Might be some sort of 2 byte integer, float, or may be an array.
-    # We won't ever know cause no game (yet that has been found) has utilized this type
-    # Thanks Nintendo.
-    ...
-
     STRING = 8
     LIST = 9
 
-    # Interface types
+    # - 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"
@@ -107,8 +102,8 @@ class LMS_DataType(Enum):
 
     @property
     def stream_size(self) -> int:
-        """The size the datatype takes up in a stream."""
-        return {
+        """Size of the datatype, only for fixed integers."""
+        sizes = {
             LMS_DataType.UINT8: 1,
             LMS_DataType.UINT16: 2,
             LMS_DataType.UINT32: 4,
@@ -116,10 +111,14 @@ class LMS_DataType(Enum):
             LMS_DataType.INT16: 2,
             LMS_DataType.INT32: 4,
             LMS_DataType.FLOAT32: 4,
-            LMS_DataType.LIST: 1,
-            LMS_DataType.BOOL: 1,
-            LMS_DataType.BYTES: 1,
-        }[self]
+        }
+
+        try:
+            return sizes[self]
+        except KeyError:
+            raise TypeError(
+                f"Stream size is not defined for '{self.to_string()}'."
+            )
 
     @classmethod
     def from_string(cls, string: str):

{pylibms-3.3.9/lms/message/definitions → pylibms-4.0.1/lms/common}/field/lms_field.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from collections.abc import Iterator
 from dataclasses import dataclass
 
-from lms.common.lms_datatype import LMS_DataType
+from lms.common.field.lms_datatype import LMS_DataType
 from lms.titleconfig.definitions.value import ValueDefinition
 
 FLOAT32_MIN = -3.4028235e38
@@ -11,6 +11,7 @@ FLOAT32_MAX = 3.4028235e38
 
 type FieldValue = int | str | float | bool | bytes
 
+
 @dataclass(frozen=True)
 class LMS_FieldMap:
     """
@@ -44,9 +45,9 @@ class LMS_FieldMap:
         for definition in definitions:
             match definition.datatype:
                 case LMS_DataType.LIST:
-                    field_map[definition.name] =  definition.list_items[0]
+                    field_map[definition.name] = definition.list_items[0]
                 case LMS_DataType.BOOL:
-                    field_map[definition.name] =  False
+                    field_map[definition.name] = False
                 case LMS_DataType.FLOAT32:
                     field_map[definition.name] = 0.0
                 case _:
@@ -97,15 +98,16 @@ class LMS_Field:
     """
 
     def __init__(
-            self, value: int | str | float | bytes | bool, definition: ValueDefinition
+            self, value: int | str | float | bytes | bool, definition: ValueDefinition,
     ):
-        _verify_value(value, definition)
+        _verify_value_from_definition(value, definition)
         self._definition = definition
         self._value = value
 
     def __repr__(self):
         if self.datatype is LMS_DataType.LIST:
             return f"LMS_Field(value={self._value!r}, list_items={self.list_items!r})"
+
         return f"LMS_Field(value={self._value!r}, type={self.datatype!r})"
 
     @property
@@ -135,11 +137,11 @@ class LMS_Field:
 
     @value.setter
     def value(self, new_value: int | str | float | bytes | bool):
-        _verify_value(new_value, self._definition)
+        _verify_value_from_definition(new_value, self._definition)
         self._value = new_value
 
 
-def _verify_value(
+def _verify_value_from_definition(
         value: int | str | float | bytes | bool, definition: ValueDefinition
 ) -> None:
     datatype = definition.datatype
@@ -161,33 +163,32 @@ def _verify_value(
                 )
             else:
                 return
-        case LMS_DataType.FLOAT32 if isinstance(value, float):
-            _verify_number_is_in_range(value, FLOAT32_MIN, FLOAT32_MAX, definition)
-            return
         case _ if isinstance(value, int):
-            bits = datatype.stream_size * 8
-            if datatype.signed:
-                max_value = 2 ** (bits - 1)
-                min_value = -max_value
-            else:
-                min_value, max_value = 0, (2 ** bits) - 1
-
-            _verify_number_is_in_range(value, min_value, max_value, definition)
+            _verify_number_datatype(value, definition.datatype)
             return
 
     raise TypeError(
-        f"The value provided for '{definition.name}' type '{type(value)}' should be '{datatype.builtin_type}'."
+        f"The value provided for '{definition.name}' type '{type(value)}' should be '{datatype.builtin_type}' (DATATYPE {definition.datatype})."
     )
 
 
-def _verify_number_is_in_range(
+def _verify_number_datatype(
         value: int | float,
-        min_value: int | float,
-        max_value: int | float,
-        definition: ValueDefinition,
+        datatype: LMS_DataType,
 ):
+    if datatype is LMS_DataType.FLOAT32:
+        max_value = FLOAT32_MAX
+        min_value = FLOAT32_MIN
+    else:
+        bits = datatype.stream_size * 8
+        if datatype.signed:
+            max_value = 2 ** (bits - 1)
+            min_value = -max_value
+        else:
+            min_value, max_value = 0, (2 ** bits) - 1
+
     if not min_value <= value <= max_value:
         raise ValueError(
-            f"""The value '{value}' of type '{definition.datatype}' provided for field '{definition.name}' 
+            f"""The value '{value}' of type '{datatype.name}' provided for this field
             is out of range of ({min_value}, {max_value})"""
         )

pylibms-4.0.1/lms/common/lms_constants.py

@@ -0,0 +1,9 @@
+# Common constant definitions between files
+PADDING_BYTE = b"\x00"
+
+SIZE_OFFSET = 0x12
+SECTION_DATA_START = 0x20
+SECTION_PADDING_BYTE = b"\xAB"
+
+LITTLE_ENDIAN_BOM = b"\xff\xfe"
+BIG_ENDIAN_BOM = b"\xfe\xff"

{pylibms-3.3.9 → pylibms-4.0.1}/lms/common/lms_exceptions.py

@@ -5,3 +5,6 @@ class LMS_UnexpectedMagicError(Exception): ...
 
 
 class LMS_MisalignedSizeError(Exception): ...
+
+
+class LMS_UnsupportedSectionError(Exception): ...

{pylibms-3.3.9 → pylibms-4.0.1}/lms/common/stream/fileinfo.py

@@ -1,12 +1,9 @@
 from lms.common import lms_exceptions
+from lms.common.lms_constants import BIG_ENDIAN_BOM, SECTION_DATA_START, LITTLE_ENDIAN_BOM, SIZE_OFFSET
 from lms.common.lms_fileinfo import LMS_FileInfo
 from lms.fileio.encoding import FileEncoding
 from lms.fileio.io import FileReader, FileWriter
 
-DATA_START = 0x20
-LITTLE_ENDIAN_BOM = b"\xff\xfe"
-BIG_ENDIAN_BOM = b"\xfe\xff"
-
 
 def read_file_info(reader: FileReader, expected_magic: str) -> LMS_FileInfo:
     magic = reader.read_string_len(8)
@@ -32,10 +29,10 @@ def read_file_info(reader: FileReader, expected_magic: str) -> LMS_FileInfo:
     file_size = reader.read_uint32()
 
     reader.seek(0, 2)
-    if file_size != reader.tell():
-        raise lms_exceptions.LMS_MisalignedSizeError(f"File size is misaligned!")
+    if file_size != (real_size := reader.tell()):
+        raise lms_exceptions.LMS_MisalignedSizeError(f"File size is misaligned!` Got {file_size} expected {real_size}.")
 
-    reader.seek(DATA_START)
+    reader.seek(SECTION_DATA_START)
 
     return LMS_FileInfo(
         is_big_endian,
@@ -62,4 +59,9 @@ def write_file_info(writer: FileWriter, magic: str, file_info: LMS_FileInfo) ->
     writer.write_bytes(b"\x00\x00")
     writer.write_bytes(b"\x00" * 4)
     writer.write_bytes(b"\x00" * 10)
-    writer.seek(DATA_START)
+    writer.seek(SECTION_DATA_START)
+
+
+def write_file_size(writer: FileWriter):
+    writer.seek(SIZE_OFFSET)
+    writer.write_uint32(writer.get_stream_size())

{pylibms-3.3.9 → pylibms-4.0.1}/lms/common/stream/hashtable.py

@@ -27,21 +27,23 @@ def read_labels(reader: FileReader) -> tuple[dict, int]:
     return sorted_labels, slot_count
 
 
-def write_labels(writer: FileWriter, labels: list[str], slot_count: int) -> None:
+def write_labels(writer: FileWriter, labels: list[str], slot_count: int, index_map: dict[str, int] = None) -> None:
     writer.write_uint32(slot_count)
 
     hash_slots = {}
-    index_map = {}
-    # Add each label to each hash slot
+
+    add_indices = index_map is None
+
+    if index_map is None:
+        index_map = {}
+
     for i, label in enumerate(labels):
-        hash = _calculate_hash(label, slot_count)
+        slot = _calculate_hash(label, slot_count)
 
-        if hash not in hash_slots:
-            hash_slots[hash] = [label]
-        else:
-            hash_slots[hash].append(label)
+        hash_slots.setdefault(slot, []).append(label)
 
-        index_map[label] = i
+        if add_indices:
+            index_map[label] = i
 
     label_offsets = slot_count * 8 + 4
 
@@ -66,8 +68,15 @@ def write_labels(writer: FileWriter, labels: list[str], slot_count: int) -> None
             writer.write_uint32(index_map[label])
 
 
-#  See https://nintendo-formats.com/libs/lms/overview.html#hash-tables
 def _calculate_hash(label: str, slot_count: int) -> int:
+    """
+    Calucate the hash of a label
+
+    :param label: the label to calculate the hash for.
+    :param slot_count: the number of slots.
+
+    Taken directly from https://nintendo-formats.com/libs/lms/overview.html#hash-tables
+    """
     hash = 0
     for character in label:
         hash = hash * 0x492 + ord(character)

{pylibms-3.3.9 → pylibms-4.0.1}/lms/common/stream/section.py

@@ -2,6 +2,9 @@ from typing import Any, Callable, Generator
 
 from lms.fileio.io import FileReader, FileWriter
 
+SECTION_PADDING_BYTE = b"\xAB"
+SECTION_ALIGNMENT = 16
+
 
 def read_section_data(
         reader: FileReader, section_count: int
@@ -14,7 +17,7 @@ def read_section_data(
         reader.skip(8)
         end = reader.tell() + size
 
-        yield (magic, size)
+        yield magic, size
 
         reader.seek(end)
         reader.align(16)
@@ -55,4 +58,4 @@ def _write_end_data(writer: FileWriter, data_start: int, size_offset: int) -> No
     writer.seek(size_offset)
     writer.write_uint32(size)
     writer.seek(end)
-    writer.write_alignment(b"\xab", 16)
+    writer.write_alignment(SECTION_PADDING_BYTE, SECTION_ALIGNMENT)

{pylibms-3.3.9 → pylibms-4.0.1}/lms/fileio/io.py

@@ -6,6 +6,8 @@ from typing import BinaryIO, Generator
 from io import BytesIO, IOBase
 from lms.fileio.encoding import FileEncoding
 
+PADDING_BYTE = b"\x00"
+
 STRUCT_TYPES = {
     "little": {
         "uint8": "<B",
@@ -90,6 +92,14 @@ class FileReader:
     def read_float32(self) -> float:
         return struct.unpack(self._get_datatype("float"), self._stream.read(4))[0]
 
+    def read_string_offset(self, section_start: int) -> str:
+        offset = self.read_uint32()
+        last_position = self.tell()
+        self.seek(section_start + offset)
+        string = self.read_encoded_string()
+        self.seek(last_position)
+        return string
+
     def read_string_len(self, length: int) -> str:
         return self._stream.read(length).decode("UTF-8")