Metadata-Version: 2.4
Name: PyLibMS
Version: 5.0.7
Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, UMSBT, MSBP, and MSBF.
Author: AbdyyEee
License-Expression: MIT
Project-URL: Repository, https://github.com/AbdyyEee/PylibMS
Project-URL: Documentation, https://pylibms.readthedocs.io/en/latest/
Keywords: nintendo,msbt,umsbt,message text,msbp,message project,msbf,message flowchart,flw3,modding,libmessagestudio
Classifier: Topic :: Software Development :: Libraries
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyYAML>=6.0.3
Requires-Dist: requests>=2.34.2
Provides-Extra: docs
Requires-Dist: sphinx>=8.0.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
Dynamic: license-file

# PyLibMS

[![Python Versions](https://img.shields.io/pypi/pyversions/PyLibMS)](https://pypi.org/project/PyLibMS/)
![LICENSE](https://img.shields.io/badge/license-MIT-blue)
[![PyPI version](https://badge.fury.io/py/PyLibMS.svg)](https://badge.fury.io/py/PyLibMS)
![Tests](https://github.com/abdyyeee/PyLibMS/actions/workflows/tests.yml/badge.svg?branch=main)

PyLibMS is a library built in Python 3.11 and above for reading and writing of revision >=3 of the libMessageStudio
(LMS) proprietary file formats from Nintendo. These include files generated for late **Wii** titles, **Nintendo 3DS**,
**Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.

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.       |
| `UMSBT` | ✅   | ✅    | 1:1 Reading and writing. Accessing, adding, inserting and deleting `MSBT` files within `UMSBT` archives.                                                                                 |
| `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.                                                                                         |                                                                        |

# Documentation

PyLibMS documentation is on [readthedocs](https://pylibms.readthedocs.io/en/latest/). A simple preview is below:

## Reading

```py
# MSBT
from lms.message.msbtio import read_msbt_path

msbt = read_msbt_path("Text.msbt")

# UMSBT
from lms.message.umsbtio import read_umsbt_path

umsbt = read_umsbt_path("TextU.umsbt")

# 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

```py
# MSBT
from lms.message.msbtio import write_msbt_path

write_msbt_path("Out_text.msbt")

# UMSBT
from lms.message.umsbtio import write_umsbt_path

write_umsbt_path("Out_textu.umsbt")

# 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

Python version must be `>=3.11.

```
pip install PyLibMS
```

[Pip Page](https://pypi.org/project/PyLibMS/)

# Build Instructions

Clone the repository, then run `pip install`.

```bash
git clone https://github.com/AbdyyEee/PylibMS.git
cd PyLibMS
pip install -e .
```

# AI Disclaimer

PyLibMS and its code is handwritten, developed and maintained by abdyyeee.

AI was occasionally consulted for minor implementation references during the development of MSBT, USMBT and MSBF. No AI
was utilized for MSBP. Any references were reviewed and tested beforehand, and no code was ever directly pasted from any
generative source.

The development of unit-tests were AI assisted.

# 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
  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 UMSBT implementation and other bits of the library. 
