PyLibMS 5.0.3__tar.gz → 5.0.5__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. {pylibms-5.0.3 → pylibms-5.0.5}/LICENSE +6 -6
  2. {pylibms-5.0.3 → pylibms-5.0.5}/MANIFEST.in +1 -1
  3. {pylibms-5.0.3 → pylibms-5.0.5}/PKG-INFO +118 -118
  4. {pylibms-5.0.3 → pylibms-5.0.5}/PyLibMS.egg-info/PKG-INFO +118 -118
  5. {pylibms-5.0.3 → pylibms-5.0.5}/PyLibMS.egg-info/SOURCES.txt +4 -10
  6. {pylibms-5.0.3 → pylibms-5.0.5}/README.md +97 -97
  7. {pylibms-5.0.3 → pylibms-5.0.5}/lms/common/field/io.py +80 -80
  8. {pylibms-5.0.3 → pylibms-5.0.5}/lms/common/field/lms_datatype.py +152 -152
  9. {pylibms-5.0.3 → pylibms-5.0.5}/lms/common/field/lms_field.py +183 -183
  10. {pylibms-5.0.3 → pylibms-5.0.5}/lms/common/lms_constants.py +12 -12
  11. {pylibms-5.0.3 → pylibms-5.0.5}/lms/common/lms_exceptions.py +13 -13
  12. {pylibms-5.0.3 → pylibms-5.0.5}/lms/common/lms_fileinfo.py +12 -11
  13. {pylibms-5.0.3 → pylibms-5.0.5}/lms/common/stream/fileinfo.py +85 -80
  14. {pylibms-5.0.3 → pylibms-5.0.5}/lms/common/stream/hashtable.py +88 -88
  15. {pylibms-5.0.3 → pylibms-5.0.5}/lms/common/stream/section.py +57 -57
  16. {pylibms-5.0.3 → pylibms-5.0.5}/lms/fileio/encoding.py +40 -42
  17. pylibms-5.0.5/lms/fileio/endian.py +19 -0
  18. {pylibms-5.0.3 → pylibms-5.0.5}/lms/fileio/io.py +199 -198
  19. {pylibms-5.0.3 → pylibms-5.0.5}/lms/flowchart/definitions/lms_nodeexceptions.py +7 -7
  20. {pylibms-5.0.3 → pylibms-5.0.5}/lms/flowchart/definitions/node.py +632 -632
  21. {pylibms-5.0.3 → pylibms-5.0.5}/lms/flowchart/definitions/node_type.py +130 -130
  22. {pylibms-5.0.3 → pylibms-5.0.5}/lms/flowchart/flw3.py +421 -421
  23. {pylibms-5.0.3 → pylibms-5.0.5}/lms/flowchart/msbf.py +209 -208
  24. {pylibms-5.0.3 → pylibms-5.0.5}/lms/flowchart/msbfio.py +140 -139
  25. {pylibms-5.0.3 → pylibms-5.0.5}/lms/message/lms_messagetext.py +185 -184
  26. {pylibms-5.0.3 → pylibms-5.0.5}/lms/message/msbt.py +286 -271
  27. {pylibms-5.0.3 → pylibms-5.0.5}/lms/message/msbtentry.py +103 -103
  28. {pylibms-5.0.3 → pylibms-5.0.5}/lms/message/msbtio.py +252 -246
  29. {pylibms-5.0.3 → pylibms-5.0.5}/lms/message/section/atr1.py +115 -115
  30. {pylibms-5.0.3 → pylibms-5.0.5}/lms/message/section/nli1.py +22 -22
  31. {pylibms-5.0.3 → pylibms-5.0.5}/lms/message/section/tsy1.py +13 -13
  32. {pylibms-5.0.3 → pylibms-5.0.5}/lms/message/section/txt2.py +67 -67
  33. {pylibms-5.0.3 → pylibms-5.0.5}/lms/message/tag/io/param_io.py +91 -91
  34. {pylibms-5.0.3 → pylibms-5.0.5}/lms/message/tag/io/tag_io.py +116 -115
  35. {pylibms-5.0.3 → pylibms-5.0.5}/lms/message/tag/lms_tag.py +236 -236
  36. {pylibms-5.0.3 → pylibms-5.0.5}/lms/message/tag/lms_tagexceptions.py +10 -10
  37. pylibms-5.0.5/lms/message/umsbt.py +91 -0
  38. pylibms-5.0.5/lms/message/umsbtio.py +183 -0
  39. {pylibms-5.0.3 → pylibms-5.0.5}/lms/project/definitions/attribute.py +32 -32
  40. {pylibms-5.0.3 → pylibms-5.0.5}/lms/project/definitions/color.py +10 -10
  41. {pylibms-5.0.3 → pylibms-5.0.5}/lms/project/definitions/style.py +10 -10
  42. {pylibms-5.0.3 → pylibms-5.0.5}/lms/project/definitions/tag.py +137 -137
  43. {pylibms-5.0.3 → pylibms-5.0.5}/lms/project/msbp.py +71 -71
  44. {pylibms-5.0.3 → pylibms-5.0.5}/lms/project/msbpread.py +112 -111
  45. {pylibms-5.0.3 → pylibms-5.0.5}/lms/project/section/ali2.py +22 -22
  46. {pylibms-5.0.3 → pylibms-5.0.5}/lms/project/section/ati2.py +17 -17
  47. {pylibms-5.0.3 → pylibms-5.0.5}/lms/project/section/clr1.py +15 -15
  48. {pylibms-5.0.3 → pylibms-5.0.5}/lms/project/section/string.py +16 -16
  49. {pylibms-5.0.3 → pylibms-5.0.5}/lms/project/section/syl3.py +17 -17
  50. {pylibms-5.0.3 → pylibms-5.0.5}/lms/project/section/tag2.py +20 -20
  51. {pylibms-5.0.3 → pylibms-5.0.5}/lms/project/section/tgg2.py +24 -24
  52. {pylibms-5.0.3 → pylibms-5.0.5}/lms/project/section/tgp2.py +30 -30
  53. {pylibms-5.0.3 → pylibms-5.0.5}/lms/titleconfig/config.py +301 -301
  54. {pylibms-5.0.3 → pylibms-5.0.5}/lms/titleconfig/definitions/attribute.py +28 -28
  55. {pylibms-5.0.3 → pylibms-5.0.5}/lms/titleconfig/definitions/field.py +32 -32
  56. {pylibms-5.0.3 → pylibms-5.0.5}/lms/titleconfig/definitions/nodes.py +151 -151
  57. {pylibms-5.0.3 → pylibms-5.0.5}/lms/titleconfig/definitions/tags.py +90 -90
  58. {pylibms-5.0.3 → pylibms-5.0.5}/pyproject.toml +42 -42
  59. {pylibms-5.0.3 → pylibms-5.0.5}/setup.cfg +4 -4
  60. pylibms-5.0.3/lms/titleconfig/presets/Badge Arcade.yaml +0 -430
  61. pylibms-5.0.3/lms/titleconfig/presets/Brain Age Concentration Training.yaml +0 -132
  62. pylibms-5.0.3/lms/titleconfig/presets/Kirby Planet Robobot.yaml +0 -209
  63. pylibms-5.0.3/lms/titleconfig/presets/Super Mario 3D Land.yaml +0 -367
  64. pylibms-5.0.3/lms/titleconfig/presets/Super Mario 3D World + Bowsers Fury.yaml +0 -200
  65. pylibms-5.0.3/lms/titleconfig/presets/Super Mario Odyssey.yaml +0 -1961
  66. pylibms-5.0.3/lms/titleconfig/presets/The Legend of Zelda Echos of Wisdom.yaml +0 -110
  67. pylibms-5.0.3/lms/titleconfig/presets/The Legend of Zelda a Link Between Worlds.yaml +0 -383
  68. pylibms-5.0.3/lms/titleconfig/presets/Tomodachi Life Living The Dream.yaml +0 -3369
  69. {pylibms-5.0.3 → pylibms-5.0.5}/PyLibMS.egg-info/dependency_links.txt +0 -0
  70. {pylibms-5.0.3 → pylibms-5.0.5}/PyLibMS.egg-info/requires.txt +0 -0
  71. {pylibms-5.0.3 → pylibms-5.0.5}/PyLibMS.egg-info/top_level.txt +0 -0
  72. {pylibms-5.0.3 → pylibms-5.0.5}/lms/__init__.py +0 -0
  73. {pylibms-5.0.3 → pylibms-5.0.5}/lms/common/__init__.py +0 -0
  74. {pylibms-5.0.3 → pylibms-5.0.5}/lms/common/field/__init__.py +0 -0
  75. {pylibms-5.0.3 → pylibms-5.0.5}/lms/flowchart/__init__.py +0 -0
  76. {pylibms-5.0.3 → pylibms-5.0.5}/lms/flowchart/definitions/__init__.py +0 -0
  77. {pylibms-5.0.3 → pylibms-5.0.5}/lms/message/__init__.py +0 -0
  78. {pylibms-5.0.3 → pylibms-5.0.5}/lms/message/definitions/__init__.py +0 -0
  79. {pylibms-5.0.3 → pylibms-5.0.5}/lms/message/section/__init__.py +0 -0
  80. {pylibms-5.0.3 → pylibms-5.0.5}/lms/message/tag/__init__.py +0 -0
  81. {pylibms-5.0.3 → pylibms-5.0.5}/lms/project/__init__.py +0 -0
  82. {pylibms-5.0.3 → pylibms-5.0.5}/lms/project/definitions/__init__.py +0 -0
  83. {pylibms-5.0.3 → pylibms-5.0.5}/lms/py.typed +0 -0
  84. {pylibms-5.0.3 → pylibms-5.0.5}/lms/titleconfig/__init__.py +0 -0
  85. {pylibms-5.0.3 → pylibms-5.0.5}/lms/titleconfig/definitions/__init__.py +0 -0
@@ -1,7 +1,7 @@
1
- Copyright 2025 AbdyyEee
2
-
3
- Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4
-
5
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6
-
1
+ Copyright 2025 AbdyyEee
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4
+
5
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6
+
7
7
  THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -1 +1 @@
1
- include README.md LICENSE
1
+ include README.md LICENSE
@@ -1,118 +1,118 @@
1
- Metadata-Version: 2.4
2
- Name: PyLibMS
3
- Version: 5.0.3
4
- Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
5
- Author: AbdyyEee
6
- License-Expression: MIT
7
- Project-URL: Repository, https://github.com/AbdyyEee/PylibMS
8
- Project-URL: Documentation, https://github.com/AbdyyEee/PylibMS/wiki
9
- Keywords: nintendo,msbt,message text,msbp,message project,msbf,message flowchart,flw3,modding,libmessagestudio
10
- Classifier: Programming Language :: Python :: 3.11
11
- Classifier: Programming Language :: Python :: 3.12
12
- Classifier: Programming Language :: Python :: 3.13
13
- Classifier: Programming Language :: Python :: 3.14
14
- Classifier: Programming Language :: Python :: 3.15
15
- Requires-Python: >=3.11
16
- Description-Content-Type: text/markdown
17
- License-File: LICENSE
18
- Requires-Dist: PyYAML>=6.0.1
19
- Requires-Dist: requests>=2.34.0
20
- Dynamic: license-file
21
-
22
- # PyLibMS
23
-
24
- [![Python Versions](https://img.shields.io/pypi/pyversions/PyLibMS)](https://pypi.org/project/PyLibMS/)
25
- ![LICENSE](https://img.shields.io/badge/license-MIT-blue)
26
- [![PyPI version](https://badge.fury.io/py/PyLibMS.svg)](https://badge.fury.io/py/PyLibMS)
27
- ![Tests](https://github.com/abdyyeee/PyLibMS/actions/workflows/tests.yml/badge.svg?branch=main)
28
-
29
- PyLibMS is a library built in Python 3.11 and above for reading and writing of libMessageStudio (LMS) proprietary file
30
- formats from Nintendo.
31
-
32
- The following is supported:
33
-
34
- | Format | Read | Write | Support |
35
- |--------|------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
36
- | `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. |
37
- | `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. |
38
- | `MSBP` | ✅ | ❌ | Viewing all MSBP relevant metadata and generating configuration files for use with `MSBT` files. |
39
-
40
- This library is designed to support LMS revision >=3.0. These include files generated for late **Wii** titles,
41
- **Nintendo 3DS**, **Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
42
-
43
- # Features and Usage
44
-
45
- Simple preview of the library is below. See [the wiki](https://github.com/AbdyyEee/PylibMS/wiki) for more explanations
46
- and examples.
47
-
48
- ## Reading
49
-
50
- ```py
51
- # MSBT
52
- from lms.message.msbtio import read_msbt_path
53
-
54
- msbt = read_msbt_path("Text.msbt")
55
-
56
- # MSBP
57
- from lms.project.msbpread import read_msbp_path
58
-
59
- msbp = read_msbp_path("Project.msbp")
60
-
61
- # MSBF
62
- from lms.flowchart.msbfio import read_msbf_path
63
-
64
- msbf = read_msbf_path("Flowchart.msbf")
65
- ```
66
-
67
- ## Writing
68
-
69
- ```py
70
- # MSBT
71
- from lms.message.msbtio import write_msbt_path
72
-
73
- write_msbt_path("Out_text.msbt")
74
-
75
- # MSBF
76
- from lms.flowchart.msbfio import write_msbf_path
77
-
78
- write_msbf_path("Out_Flowchart.msbf")
79
- ```
80
-
81
- # Adding/Editing Presets
82
-
83
- To add or edit Preset, you may create an issue with the relevant `yaml` file and the game it is for.
84
-
85
- # Installation
86
-
87
- ```
88
- pip install PyLibMS
89
- ```
90
-
91
- [Pip Page](https://pypi.org/project/PyLibMS/)
92
-
93
- # Build Instructions
94
-
95
- Python version must be `3.11` or higher.
96
-
97
- Clone the repository, then run `pip install` (venv recommended)
98
-
99
- ```bash
100
- git clone https://github.com/AbdyyEee/PylibMS.git
101
- cd PyLibMS
102
- pip install -e .
103
- ```
104
-
105
- # AI Disclaimer
106
-
107
- 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.
108
-
109
- # Credits & Sources
110
-
111
- * [SS-Decomp](https://github.com/zeldaret/ss): Referenced some parts of their MSBF decomp when adding the format
112
- to [Nintendo-File-Formats](https://nintendo-formats.com) and this library.
113
- * [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file
114
- formats.
115
- * [Trippixyz](https://github.com/Trippixyz): For helping me get started general decompilation of the formats and general
116
- help.
117
- * [AeonSake](https://github.com/AeonSake): Inspiration for some the implementation of the library and a bit of general
118
- help.
1
+ Metadata-Version: 2.4
2
+ Name: PyLibMS
3
+ Version: 5.0.5
4
+ Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
5
+ Author: AbdyyEee
6
+ License-Expression: MIT
7
+ Project-URL: Repository, https://github.com/AbdyyEee/PylibMS
8
+ Project-URL: Documentation, https://github.com/AbdyyEee/PylibMS/wiki
9
+ Keywords: nintendo,msbt,message text,msbp,message project,msbf,message flowchart,flw3,modding,libmessagestudio
10
+ Classifier: Programming Language :: Python :: 3.11
11
+ Classifier: Programming Language :: Python :: 3.12
12
+ Classifier: Programming Language :: Python :: 3.13
13
+ Classifier: Programming Language :: Python :: 3.14
14
+ Classifier: Programming Language :: Python :: 3.15
15
+ Requires-Python: >=3.11
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ Requires-Dist: PyYAML>=6.0.1
19
+ Requires-Dist: requests>=2.34.0
20
+ Dynamic: license-file
21
+
22
+ # PyLibMS
23
+
24
+ [![Python Versions](https://img.shields.io/pypi/pyversions/PyLibMS)](https://pypi.org/project/PyLibMS/)
25
+ ![LICENSE](https://img.shields.io/badge/license-MIT-blue)
26
+ [![PyPI version](https://badge.fury.io/py/PyLibMS.svg)](https://badge.fury.io/py/PyLibMS)
27
+ ![Tests](https://github.com/abdyyeee/PyLibMS/actions/workflows/tests.yml/badge.svg?branch=main)
28
+
29
+ PyLibMS is a library built in Python 3.11 and above for reading and writing of libMessageStudio (LMS) proprietary file
30
+ formats from Nintendo.
31
+
32
+ The following is supported:
33
+
34
+ | Format | Read | Write | Support |
35
+ |--------|------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
36
+ | `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. |
37
+ | `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. |
38
+ | `MSBP` | ✅ | ❌ | Viewing all MSBP relevant metadata and generating configuration files for use with `MSBT` files. |
39
+
40
+ This library is designed to support LMS revision >=3.0. These include files generated for late **Wii** titles,
41
+ **Nintendo 3DS**, **Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
42
+
43
+ # Features and Usage
44
+
45
+ Simple preview of the library is below. See [the wiki](https://github.com/AbdyyEee/PylibMS/wiki) for more explanations
46
+ and examples.
47
+
48
+ ## Reading
49
+
50
+ ```py
51
+ # MSBT
52
+ from lms.message.msbtio import read_msbt_path
53
+
54
+ msbt = read_msbt_path("Text.msbt")
55
+
56
+ # MSBP
57
+ from lms.project.msbpread import read_msbp_path
58
+
59
+ msbp = read_msbp_path("Project.msbp")
60
+
61
+ # MSBF
62
+ from lms.flowchart.msbfio import read_msbf_path
63
+
64
+ msbf = read_msbf_path("Flowchart.msbf")
65
+ ```
66
+
67
+ ## Writing
68
+
69
+ ```py
70
+ # MSBT
71
+ from lms.message.msbtio import write_msbt_path
72
+
73
+ write_msbt_path("Out_text.msbt")
74
+
75
+ # MSBF
76
+ from lms.flowchart.msbfio import write_msbf_path
77
+
78
+ write_msbf_path("Out_Flowchart.msbf")
79
+ ```
80
+
81
+ # Adding/Editing Presets
82
+
83
+ To add or edit Preset, you may create an issue with the relevant `yaml` file and the game it is for.
84
+
85
+ # Installation
86
+
87
+ ```
88
+ pip install PyLibMS
89
+ ```
90
+
91
+ [Pip Page](https://pypi.org/project/PyLibMS/)
92
+
93
+ # Build Instructions
94
+
95
+ Python version must be `3.11` or higher.
96
+
97
+ Clone the repository, then run `pip install` (venv recommended)
98
+
99
+ ```bash
100
+ git clone https://github.com/AbdyyEee/PylibMS.git
101
+ cd PyLibMS
102
+ pip install -e .
103
+ ```
104
+
105
+ # AI Disclaimer
106
+
107
+ 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.
108
+
109
+ # Credits & Sources
110
+
111
+ * [SS-Decomp](https://github.com/zeldaret/ss): Referenced some parts of their MSBF decomp when adding the format
112
+ to [Nintendo-File-Formats](https://nintendo-formats.com) and this library.
113
+ * [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file
114
+ formats.
115
+ * [Trippixyz](https://github.com/Trippixyz): For helping me get started general decompilation of the formats and general
116
+ help.
117
+ * [AeonSake](https://github.com/AeonSake): Inspiration for some the implementation of the library and a bit of general
118
+ help.
@@ -1,118 +1,118 @@
1
- Metadata-Version: 2.4
2
- Name: PyLibMS
3
- Version: 5.0.3
4
- Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
5
- Author: AbdyyEee
6
- License-Expression: MIT
7
- Project-URL: Repository, https://github.com/AbdyyEee/PylibMS
8
- Project-URL: Documentation, https://github.com/AbdyyEee/PylibMS/wiki
9
- Keywords: nintendo,msbt,message text,msbp,message project,msbf,message flowchart,flw3,modding,libmessagestudio
10
- Classifier: Programming Language :: Python :: 3.11
11
- Classifier: Programming Language :: Python :: 3.12
12
- Classifier: Programming Language :: Python :: 3.13
13
- Classifier: Programming Language :: Python :: 3.14
14
- Classifier: Programming Language :: Python :: 3.15
15
- Requires-Python: >=3.11
16
- Description-Content-Type: text/markdown
17
- License-File: LICENSE
18
- Requires-Dist: PyYAML>=6.0.1
19
- Requires-Dist: requests>=2.34.0
20
- Dynamic: license-file
21
-
22
- # PyLibMS
23
-
24
- [![Python Versions](https://img.shields.io/pypi/pyversions/PyLibMS)](https://pypi.org/project/PyLibMS/)
25
- ![LICENSE](https://img.shields.io/badge/license-MIT-blue)
26
- [![PyPI version](https://badge.fury.io/py/PyLibMS.svg)](https://badge.fury.io/py/PyLibMS)
27
- ![Tests](https://github.com/abdyyeee/PyLibMS/actions/workflows/tests.yml/badge.svg?branch=main)
28
-
29
- PyLibMS is a library built in Python 3.11 and above for reading and writing of libMessageStudio (LMS) proprietary file
30
- formats from Nintendo.
31
-
32
- The following is supported:
33
-
34
- | Format | Read | Write | Support |
35
- |--------|------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
36
- | `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. |
37
- | `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. |
38
- | `MSBP` | ✅ | ❌ | Viewing all MSBP relevant metadata and generating configuration files for use with `MSBT` files. |
39
-
40
- This library is designed to support LMS revision >=3.0. These include files generated for late **Wii** titles,
41
- **Nintendo 3DS**, **Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
42
-
43
- # Features and Usage
44
-
45
- Simple preview of the library is below. See [the wiki](https://github.com/AbdyyEee/PylibMS/wiki) for more explanations
46
- and examples.
47
-
48
- ## Reading
49
-
50
- ```py
51
- # MSBT
52
- from lms.message.msbtio import read_msbt_path
53
-
54
- msbt = read_msbt_path("Text.msbt")
55
-
56
- # MSBP
57
- from lms.project.msbpread import read_msbp_path
58
-
59
- msbp = read_msbp_path("Project.msbp")
60
-
61
- # MSBF
62
- from lms.flowchart.msbfio import read_msbf_path
63
-
64
- msbf = read_msbf_path("Flowchart.msbf")
65
- ```
66
-
67
- ## Writing
68
-
69
- ```py
70
- # MSBT
71
- from lms.message.msbtio import write_msbt_path
72
-
73
- write_msbt_path("Out_text.msbt")
74
-
75
- # MSBF
76
- from lms.flowchart.msbfio import write_msbf_path
77
-
78
- write_msbf_path("Out_Flowchart.msbf")
79
- ```
80
-
81
- # Adding/Editing Presets
82
-
83
- To add or edit Preset, you may create an issue with the relevant `yaml` file and the game it is for.
84
-
85
- # Installation
86
-
87
- ```
88
- pip install PyLibMS
89
- ```
90
-
91
- [Pip Page](https://pypi.org/project/PyLibMS/)
92
-
93
- # Build Instructions
94
-
95
- Python version must be `3.11` or higher.
96
-
97
- Clone the repository, then run `pip install` (venv recommended)
98
-
99
- ```bash
100
- git clone https://github.com/AbdyyEee/PylibMS.git
101
- cd PyLibMS
102
- pip install -e .
103
- ```
104
-
105
- # AI Disclaimer
106
-
107
- 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.
108
-
109
- # Credits & Sources
110
-
111
- * [SS-Decomp](https://github.com/zeldaret/ss): Referenced some parts of their MSBF decomp when adding the format
112
- to [Nintendo-File-Formats](https://nintendo-formats.com) and this library.
113
- * [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file
114
- formats.
115
- * [Trippixyz](https://github.com/Trippixyz): For helping me get started general decompilation of the formats and general
116
- help.
117
- * [AeonSake](https://github.com/AeonSake): Inspiration for some the implementation of the library and a bit of general
118
- help.
1
+ Metadata-Version: 2.4
2
+ Name: PyLibMS
3
+ Version: 5.0.5
4
+ Summary: Python library built for the libMessageStudio (LMS) proprietary file formats from Nintendo. Supports MSBT, MSBP, and MSBF.
5
+ Author: AbdyyEee
6
+ License-Expression: MIT
7
+ Project-URL: Repository, https://github.com/AbdyyEee/PylibMS
8
+ Project-URL: Documentation, https://github.com/AbdyyEee/PylibMS/wiki
9
+ Keywords: nintendo,msbt,message text,msbp,message project,msbf,message flowchart,flw3,modding,libmessagestudio
10
+ Classifier: Programming Language :: Python :: 3.11
11
+ Classifier: Programming Language :: Python :: 3.12
12
+ Classifier: Programming Language :: Python :: 3.13
13
+ Classifier: Programming Language :: Python :: 3.14
14
+ Classifier: Programming Language :: Python :: 3.15
15
+ Requires-Python: >=3.11
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ Requires-Dist: PyYAML>=6.0.1
19
+ Requires-Dist: requests>=2.34.0
20
+ Dynamic: license-file
21
+
22
+ # PyLibMS
23
+
24
+ [![Python Versions](https://img.shields.io/pypi/pyversions/PyLibMS)](https://pypi.org/project/PyLibMS/)
25
+ ![LICENSE](https://img.shields.io/badge/license-MIT-blue)
26
+ [![PyPI version](https://badge.fury.io/py/PyLibMS.svg)](https://badge.fury.io/py/PyLibMS)
27
+ ![Tests](https://github.com/abdyyeee/PyLibMS/actions/workflows/tests.yml/badge.svg?branch=main)
28
+
29
+ PyLibMS is a library built in Python 3.11 and above for reading and writing of libMessageStudio (LMS) proprietary file
30
+ formats from Nintendo.
31
+
32
+ The following is supported:
33
+
34
+ | Format | Read | Write | Support |
35
+ |--------|------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
36
+ | `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. |
37
+ | `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. |
38
+ | `MSBP` | ✅ | ❌ | Viewing all MSBP relevant metadata and generating configuration files for use with `MSBT` files. |
39
+
40
+ This library is designed to support LMS revision >=3.0. These include files generated for late **Wii** titles,
41
+ **Nintendo 3DS**, **Wii U**, **Mobile**, **Nintendo Switch** and **Nintendo Switch 2** games.
42
+
43
+ # Features and Usage
44
+
45
+ Simple preview of the library is below. See [the wiki](https://github.com/AbdyyEee/PylibMS/wiki) for more explanations
46
+ and examples.
47
+
48
+ ## Reading
49
+
50
+ ```py
51
+ # MSBT
52
+ from lms.message.msbtio import read_msbt_path
53
+
54
+ msbt = read_msbt_path("Text.msbt")
55
+
56
+ # MSBP
57
+ from lms.project.msbpread import read_msbp_path
58
+
59
+ msbp = read_msbp_path("Project.msbp")
60
+
61
+ # MSBF
62
+ from lms.flowchart.msbfio import read_msbf_path
63
+
64
+ msbf = read_msbf_path("Flowchart.msbf")
65
+ ```
66
+
67
+ ## Writing
68
+
69
+ ```py
70
+ # MSBT
71
+ from lms.message.msbtio import write_msbt_path
72
+
73
+ write_msbt_path("Out_text.msbt")
74
+
75
+ # MSBF
76
+ from lms.flowchart.msbfio import write_msbf_path
77
+
78
+ write_msbf_path("Out_Flowchart.msbf")
79
+ ```
80
+
81
+ # Adding/Editing Presets
82
+
83
+ To add or edit Preset, you may create an issue with the relevant `yaml` file and the game it is for.
84
+
85
+ # Installation
86
+
87
+ ```
88
+ pip install PyLibMS
89
+ ```
90
+
91
+ [Pip Page](https://pypi.org/project/PyLibMS/)
92
+
93
+ # Build Instructions
94
+
95
+ Python version must be `3.11` or higher.
96
+
97
+ Clone the repository, then run `pip install` (venv recommended)
98
+
99
+ ```bash
100
+ git clone https://github.com/AbdyyEee/PylibMS.git
101
+ cd PyLibMS
102
+ pip install -e .
103
+ ```
104
+
105
+ # AI Disclaimer
106
+
107
+ 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.
108
+
109
+ # Credits & Sources
110
+
111
+ * [SS-Decomp](https://github.com/zeldaret/ss): Referenced some parts of their MSBF decomp when adding the format
112
+ to [Nintendo-File-Formats](https://nintendo-formats.com) and this library.
113
+ * [Nintendo-File-Formats](https://nintendo-formats.com) by Kinnay: For existing information on the MSBT and MSBP file
114
+ formats.
115
+ * [Trippixyz](https://github.com/Trippixyz): For helping me get started general decompilation of the formats and general
116
+ help.
117
+ * [AeonSake](https://github.com/AeonSake): Inspiration for some the implementation of the library and a bit of general
118
+ help.
@@ -21,6 +21,7 @@ lms/common/stream/fileinfo.py
21
21
  lms/common/stream/hashtable.py
22
22
  lms/common/stream/section.py
23
23
  lms/fileio/encoding.py
24
+ lms/fileio/endian.py
24
25
  lms/fileio/io.py
25
26
  lms/flowchart/__init__.py
26
27
  lms/flowchart/flw3.py
@@ -35,6 +36,8 @@ lms/message/lms_messagetext.py
35
36
  lms/message/msbt.py
36
37
  lms/message/msbtentry.py
37
38
  lms/message/msbtio.py
39
+ lms/message/umsbt.py
40
+ lms/message/umsbtio.py
38
41
  lms/message/definitions/__init__.py
39
42
  lms/message/section/__init__.py
40
43
  lms/message/section/atr1.py
@@ -68,13 +71,4 @@ lms/titleconfig/definitions/__init__.py
68
71
  lms/titleconfig/definitions/attribute.py
69
72
  lms/titleconfig/definitions/field.py
70
73
  lms/titleconfig/definitions/nodes.py
71
- lms/titleconfig/definitions/tags.py
72
- lms/titleconfig/presets/Badge Arcade.yaml
73
- lms/titleconfig/presets/Brain Age Concentration Training.yaml
74
- lms/titleconfig/presets/Kirby Planet Robobot.yaml
75
- lms/titleconfig/presets/Super Mario 3D Land.yaml
76
- lms/titleconfig/presets/Super Mario 3D World + Bowsers Fury.yaml
77
- lms/titleconfig/presets/Super Mario Odyssey.yaml
78
- lms/titleconfig/presets/The Legend of Zelda Echos of Wisdom.yaml
79
- lms/titleconfig/presets/The Legend of Zelda a Link Between Worlds.yaml
80
- lms/titleconfig/presets/Tomodachi Life Living The Dream.yaml
74
+ lms/titleconfig/definitions/tags.py