PyLibMS
PyLibMS is a library built in Python 3.11 and above for reading and writing of libMessageStudio (LMS) proprietary file formats from Nintendo.
The following is supported:
| Format | Read | Write | Support |
|---|---|---|---|
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.
Features and Usage
Simple preview of the library is below. See the wiki for more explanations and examples.
Reading
# MSBT
from lms.message.msbtio import read_msbt_path
msbt = read_msbt_path("Text.msbt")
# MSBP
from lms.project.msbpread import read_msbp_path
msbp = read_msbp_path("Project.msbp")
# MSBF
from lms.flowchart.msbfio import read_msbf_path
msbf = read_msbf_path("Flowchart.msbf")
Writing
# MSBT
from lms.message.msbtio import write_msbt_path
write_msbt_path("Out_text.msbt")
# MSBF
from lms.flowchart.msbfio import write_msbf_path
write_msbf_path("Out_Flowchart.msbf")
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
Build Instructions
Python version must be 3.11 or higher.
Clone the repository, then run pip install (venv recommended)
git clone https://github.com/AbdyyEee/PylibMS.git
cd PyLibMS
pip install -e .
AI Disclaimer
Code in this library was written by me. AI was utilized occasionally when developing MSBT (specifically tag string importing) , MSBF and assisting in creating unit tests.
Credits & Sources
- SS-Decomp: Referenced some parts of their MSBF decomp when adding the format to Nintendo-File-Formats and this library.
- Nintendo-File-Formats by Kinnay: For existing information on the MSBT and MSBP file formats.
- Trippixyz: For helping me get started general decompilation of the formats and general help.
- AeonSake: Inspiration for some the implementation of the library and a bit of general help.
1 maintainer
Metadata
1 maintainer
Release files for PyLibMS 5.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pylibms-5.0.2.tar.gz | 57.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pylibms-5.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 135.1 kB
Release files / pylibms-5.0.2.tar.gz
| Download URL | pylibms-5.0.2.tar.gz |
|---|---|
| Size | 57.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3eabb0c2a9b7394a1bf7cd2a8bfcc8a4c3909f2ecbd6e815442e6e10ede582c8
|
|
BLAKE2b-256 checksum How to use checksums |
f16c2e409fe65efe62518b8df0c118ec7d2bb66428330d57be424b7836ce0b3e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.6
|
Release files / pylibms-5.0.2-py3-none-any.whl
| Download URL | pylibms-5.0.2-py3-none-any.whl |
|---|---|
| Size | 77.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
56095c0481cb8af09658663f15338aa0d0c29de408ceebd48067d6063d41a1d8
|
|
BLAKE2b-256 checksum How to use checksums |
5f242ff77534641d0e4e8707471ecf5616c994f52ae4ca7efd622337f4b4fdfe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.6
|
