madkit 0.1.3__tar.gz

madkit-0.1.3/.gitignore

@@ -0,0 +1,78 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyd
+
+# Virtual environments
+env/
+.venv/
+venv/
+
+# Python build/package output
+build/
+dist/
+*.egg-info/
+
+# uv
+# uv.lock is intentionally NOT ignored
+
+# Test / tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# IDE
+.vscode/
+.idea/
+.claude/
+
+# Environment / secrets
+.env
+.env.*
+!.env.example
+
+# OS
+.DS_Store
+Thumbs.db
+
+*.stream
+*.txd
+*.rws
+*.wav
+*.bsp
+*.dff
+
+Levels/
+
+
+# *.gig.* = Dont track this file
+**/*.gig.* 
+
+
+
+
+native/printhook
+native/mods
+
+# Local scratch drivers / experiments
+scratch/
+
+# Compiler output from examples/
+*.out.ai
+
+# mod build output (cli mod build)
+mods/*/build/
+
+# machine-specific settings (cli config)
+settings.toml
+
+mods/
+# tfbscript local data (game scripts, notes, decompiler output)
+packages/tfbscript/example_scripts/
+packages/tfbscript/my_scripts/
+packages/tfbscript/archive/
+packages/tfbscript/nopush.txt
+_MYNOTES.*
+*.decomp

madkit-0.1.3/.python-version

@@ -0,0 +1 @@
+3.14

madkit-0.1.3/EDITOR.yaml

@@ -0,0 +1,2 @@
+appereance:
+  font: "Microsoft Sans Serif" # MS Sans Serif != Microsoft Sans Serif

madkit-0.1.3/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

madkit-0.1.3/PKG-INFO

@@ -0,0 +1,211 @@
+Metadata-Version: 2.5
+Name: madkit
+Version: 0.1.3
+Summary: CLI and tools for modding Madagascar (2005)
+Project-URL: Repository, https://github.com/MaxStache/madagascar-game-asset-tools
+Project-URL: Issues, https://github.com/MaxStache/madagascar-game-asset-tools/issues
+Author: Max Stache
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.12
+Requires-Dist: cyclopts>=4.22.5
+Requires-Dist: fonttools>=4.63.0
+Requires-Dist: madformats>=0.1.0
+Requires-Dist: madlysimple>=0.1.0
+Requires-Dist: pillow>=12.3.0
+Requires-Dist: pymem>=1.14.0
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: rich>=14.3.0
+Requires-Dist: tfbpseudo[editor]>=0.1.0
+Requires-Dist: tfbscript>=0.1.0
+Requires-Dist: tqdm>=4.68.4
+Requires-Dist: watchdog>=6.0.0
+Description-Content-Type: text/markdown
+
+# Madagascar Asset Tools
+
+![Python >= 3.12](https://img.shields.io/badge/python-%3E%3D3.12-blue)
+
+Loads `.stream .dff .txd .bsp .txl .rws .lpa`
+
+`madkit` is a collection of tools for modding the game "Madagascar" (released in 2005): a CLI to unpack, repack and build mods for the game's level files, plus viewers for streams and textures.
+
+## Contents
+
+- [Requirements](#requirements)
+- [Getting started](#getting-started)
+  - [1. Create a modding folder](#1-create-a-modding-folder)
+  - [2. Copy the stock levels](#2-copy-the-stock-levels)
+  - [3. Configure madkit](#3-configure-madkit)
+- [Mods](#mods)
+- [CLI](#cli)
+- [Tools](#tools)
+- [Development](#development)
+
+## Requirements
+
+- [Python >= 3.12](https://www.python.org/downloads/)
+- Your own copy of the game
+
+> [!NOTE]
+>
+> ## 🎥 Video Tutorials
+>
+> **[▶️ Madagascar Modding Tutorials – YouTube Playlist](https://www.youtube.com/playlist?list=PLbBnMoHCtodg)**
+
+## Getting started
+
+### 1. Create a modding folder
+
+Make a folder for your mods with its own virtual environment, and install `madkit` and `madlysimple` into it:
+
+```bash
+mkdir my-madagascar-mods
+cd my-madagascar-mods
+python -m venv .venv
+
+# WINDOWS:
+.venv\Scripts\activate
+# LINUX/MACOS:
+source .venv/bin/activate
+
+pip install madkit madlysimple
+```
+
+`madkit` is the CLI and tools, `madlysimple` the helpers you use in your mod scripts.
+
+The environment stays active until you close the terminal. In every new terminal, `cd` into your modding folder and run the `activate` line again before using `madkit`.
+
+To update later: `pip install --upgrade madkit madlysimple`.
+
+### 2. Copy the stock levels
+
+Mods are built from the original `.stream` level files. Copy the game's `Levels/` folder into your modding folder:
+
+```text
+my-madagascar-mods/
+  .venv/
+  Levels/          # copy of <game folder>/Levels, never modified
+```
+
+> [!IMPORTANT]
+> Keep this copy untouched. `madkit mod install` overwrites the levels in the game folder, so building from the game's own `Levels/` would stack mods on top of each other.
+
+### 3. Configure madkit
+
+Tell `madkit` where the game is installed (once):
+
+```bash
+madkit config --game-dir "C:/Games/Madagascar"
+```
+
+This writes a `settings.toml` in the current folder, so run `madkit` from your modding folder. Use `--levels-dir` if your stock levels are somewhere other than `Levels/`.
+
+## Mods
+
+Create a mod:
+
+```bash
+madkit mod init my_mod --level kingofny
+```
+
+This creates:
+
+```text
+mods/my_mod/
+  mod.toml      # name, description
+  build.py      # @level(...) functions
+  assets/       # files the mod imports (.AI scripts, textures, ...)
+```
+
+Each `@level` function receives the named levels, loaded from `Levels/<level>.stream`.
+After all functions ran, every level they received is saved to `mods/my_mod/build/<level>.stream`.
+
+```python
+from pathlib import Path
+
+from madformats.mod import level
+from madformats.stream import RW_StreamFile
+
+ASSETS = Path(__file__).parent / "assets"
+
+@level("kingofny")
+def gold_coins(kingofny: RW_StreamFile) -> None:
+    kingofny.assetByName("DG_Coin_Collectable.AI").importFrom(ASSETS / "scripts/DG_Coin_Collectable.AI")
+
+@level("kingofny")          # stacked: runs once per level
+@level("kingofny_regen")
+def bigger_coins(lvl): ...
+
+@level("street", "kingofny")  # several names: one call with all levels
+def alex_to_marty(street, kingofny): ...
+```
+
+Build it, or build it and copy the levels into the game:
+
+```bash
+madkit mod build my_mod     # -> mods/my_mod/build/
+madkit mod install my_mod   # build + copy into <game folder>/Levels
+```
+
+Back up the game's `Levels/` folder before installing mods, so you can restore the originals.
+
+## CLI
+
+```bash
+madkit unpack LEVEL.stream output/directory/
+
+madkit repack input/directory/ LEVEL.stream
+```
+
+For more information run
+
+```bash
+madkit --help
+madkit COMMAND --help
+```
+
+## Tools
+
+GUI tools are run as modules:
+
+```bash
+python -m madkit.tools.stream LEVEL.stream   # stream viewer
+python -m madkit.tools.txd FILE.txd          # texture viewer
+python -m madkit.tools.analyze FILE          # RenderWare file viewer
+tfbeditor                                    # TfbPseudo AI script editor
+```
+
+## Development
+
+To work on madkit itself you need [uv](https://docs.astral.sh/uv/getting-started/installation/). Clone the repository and install the whole workspace:
+
+```bash
+git clone https://github.com/MaxStache/madagascar-game-asset-tools.git
+cd madagascar-game-asset-tools
+uv sync
+```
+
+The repository is a uv workspace with these packages, all installed in editable mode:
+
+| Package | Path | Import |
+| --- | --- | --- |
+| `madkit` (CLI + tools) | `src/madkit/` | `madkit.cli`, `madkit.tools.*` |
+| `madformats` (file formats) | `packages/madformats/` | `madformats` |
+| `madlysimple` (modding helpers) | `packages/madlysimple/` | `madlysimple` |
+| `tfbpseudo` (AI script compiler + editor) | `packages/tfbpseudo/` | `tfbpseudo` |
+| `tfbscript` (.ai parser/decompiler, `tfbtool`) | `packages/tfbscript/` | `tfbscript` |
+
+Each package under `packages/` has its own `pyproject.toml` and is published to PyPI on its own.
+
+## License
+
+Apache-2.0. See [LICENSE](https://github.com/MaxStache/madagascar-game-asset-tools/blob/main/LICENSE).
+
+## Disclaimer
+
+Unofficial fan project, not affiliated with or endorsed by DreamWorks,
+Activision or Toys for Bob. No game assets are included, you need your own copy of the game.

madkit-0.1.3/README.md

@@ -0,0 +1,184 @@
+# Madagascar Asset Tools
+
+![Python >= 3.12](https://img.shields.io/badge/python-%3E%3D3.12-blue)
+
+Loads `.stream .dff .txd .bsp .txl .rws .lpa`
+
+`madkit` is a collection of tools for modding the game "Madagascar" (released in 2005): a CLI to unpack, repack and build mods for the game's level files, plus viewers for streams and textures.
+
+## Contents
+
+- [Requirements](#requirements)
+- [Getting started](#getting-started)
+  - [1. Create a modding folder](#1-create-a-modding-folder)
+  - [2. Copy the stock levels](#2-copy-the-stock-levels)
+  - [3. Configure madkit](#3-configure-madkit)
+- [Mods](#mods)
+- [CLI](#cli)
+- [Tools](#tools)
+- [Development](#development)
+
+## Requirements
+
+- [Python >= 3.12](https://www.python.org/downloads/)
+- Your own copy of the game
+
+> [!NOTE]
+>
+> ## 🎥 Video Tutorials
+>
+> **[▶️ Madagascar Modding Tutorials – YouTube Playlist](https://www.youtube.com/playlist?list=PLbBnMoHCtodg)**
+
+## Getting started
+
+### 1. Create a modding folder
+
+Make a folder for your mods with its own virtual environment, and install `madkit` and `madlysimple` into it:
+
+```bash
+mkdir my-madagascar-mods
+cd my-madagascar-mods
+python -m venv .venv
+
+# WINDOWS:
+.venv\Scripts\activate
+# LINUX/MACOS:
+source .venv/bin/activate
+
+pip install madkit madlysimple
+```
+
+`madkit` is the CLI and tools, `madlysimple` the helpers you use in your mod scripts.
+
+The environment stays active until you close the terminal. In every new terminal, `cd` into your modding folder and run the `activate` line again before using `madkit`.
+
+To update later: `pip install --upgrade madkit madlysimple`.
+
+### 2. Copy the stock levels
+
+Mods are built from the original `.stream` level files. Copy the game's `Levels/` folder into your modding folder:
+
+```text
+my-madagascar-mods/
+  .venv/
+  Levels/          # copy of <game folder>/Levels, never modified
+```
+
+> [!IMPORTANT]
+> Keep this copy untouched. `madkit mod install` overwrites the levels in the game folder, so building from the game's own `Levels/` would stack mods on top of each other.
+
+### 3. Configure madkit
+
+Tell `madkit` where the game is installed (once):
+
+```bash
+madkit config --game-dir "C:/Games/Madagascar"
+```
+
+This writes a `settings.toml` in the current folder, so run `madkit` from your modding folder. Use `--levels-dir` if your stock levels are somewhere other than `Levels/`.
+
+## Mods
+
+Create a mod:
+
+```bash
+madkit mod init my_mod --level kingofny
+```
+
+This creates:
+
+```text
+mods/my_mod/
+  mod.toml      # name, description
+  build.py      # @level(...) functions
+  assets/       # files the mod imports (.AI scripts, textures, ...)
+```
+
+Each `@level` function receives the named levels, loaded from `Levels/<level>.stream`.
+After all functions ran, every level they received is saved to `mods/my_mod/build/<level>.stream`.
+
+```python
+from pathlib import Path
+
+from madformats.mod import level
+from madformats.stream import RW_StreamFile
+
+ASSETS = Path(__file__).parent / "assets"
+
+@level("kingofny")
+def gold_coins(kingofny: RW_StreamFile) -> None:
+    kingofny.assetByName("DG_Coin_Collectable.AI").importFrom(ASSETS / "scripts/DG_Coin_Collectable.AI")
+
+@level("kingofny")          # stacked: runs once per level
+@level("kingofny_regen")
+def bigger_coins(lvl): ...
+
+@level("street", "kingofny")  # several names: one call with all levels
+def alex_to_marty(street, kingofny): ...
+```
+
+Build it, or build it and copy the levels into the game:
+
+```bash
+madkit mod build my_mod     # -> mods/my_mod/build/
+madkit mod install my_mod   # build + copy into <game folder>/Levels
+```
+
+Back up the game's `Levels/` folder before installing mods, so you can restore the originals.
+
+## CLI
+
+```bash
+madkit unpack LEVEL.stream output/directory/
+
+madkit repack input/directory/ LEVEL.stream
+```
+
+For more information run
+
+```bash
+madkit --help
+madkit COMMAND --help
+```
+
+## Tools
+
+GUI tools are run as modules:
+
+```bash
+python -m madkit.tools.stream LEVEL.stream   # stream viewer
+python -m madkit.tools.txd FILE.txd          # texture viewer
+python -m madkit.tools.analyze FILE          # RenderWare file viewer
+tfbeditor                                    # TfbPseudo AI script editor
+```
+
+## Development
+
+To work on madkit itself you need [uv](https://docs.astral.sh/uv/getting-started/installation/). Clone the repository and install the whole workspace:
+
+```bash
+git clone https://github.com/MaxStache/madagascar-game-asset-tools.git
+cd madagascar-game-asset-tools
+uv sync
+```
+
+The repository is a uv workspace with these packages, all installed in editable mode:
+
+| Package | Path | Import |
+| --- | --- | --- |
+| `madkit` (CLI + tools) | `src/madkit/` | `madkit.cli`, `madkit.tools.*` |
+| `madformats` (file formats) | `packages/madformats/` | `madformats` |
+| `madlysimple` (modding helpers) | `packages/madlysimple/` | `madlysimple` |
+| `tfbpseudo` (AI script compiler + editor) | `packages/tfbpseudo/` | `tfbpseudo` |
+| `tfbscript` (.ai parser/decompiler, `tfbtool`) | `packages/tfbscript/` | `tfbscript` |
+
+Each package under `packages/` has its own `pyproject.toml` and is published to PyPI on its own.
+
+## License
+
+Apache-2.0. See [LICENSE](https://github.com/MaxStache/madagascar-game-asset-tools/blob/main/LICENSE).
+
+## Disclaimer
+
+Unofficial fan project, not affiliated with or endorsed by DreamWorks,
+Activision or Toys for Bob. No game assets are included, you need your own copy of the game.