tfbscript 0.1.0__tar.gz

tfbscript-0.1.0/.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

tfbscript-0.1.0/FORMAT.md

@@ -0,0 +1,98 @@
+# .AI File format (TFBScript)
+
+A `.ai` file is **little-endian** and laid out as:
+
+```c
+struct TFBScriptFile {
+    uint8_t      magic_length;        // 0x0A (10)
+    char         magic[magic_length]; // TFB Script
+
+    uint32_t     unknown;
+
+    StringTable  opcode_table;
+
+    StringTable  global_references;
+    StringTable  local_references;
+
+    uint32_t     instruction_count; // Flattened instruction count
+
+    Instruction  instructions[instruction_count];
+};
+
+struct StringTable {
+    uint32_t    entry_count;
+
+    struct {
+        uint8_t   content_length;
+        char      content;
+        uint32_t  unused; // Always 0x000000
+    } entries[entry_count];
+
+    /*
+     Entry strings are `::`-separated
+     paths like `myactor::actor`, `score::user::value` or `move to::op-code`
+     (name / optional category / type).
+    */
+};
+
+struct Instruction {
+    uint8_t opcode_index;
+    DWORD   flags;
+
+    uint8_t payload_size;
+    byte    payload[payload_size];
+};
+  
+
+```
+
+## Instructions: opcode_index
+
+The index into *opcode_table* to get the actual opcode
+
+Example:
+
+```text
+opcode_table:
+    0x01 - print::op-code
+
+instruction 0:
+        opcode_index: 0x01 -> print::op-code
+...
+```
+
+## Instructions: flags
+
+A 32-bit, bit-packed field controlling flow and nesting:
+
+| Bits  | Field             | Meaning                                                        |
+|-------|-------------------|----------------------------------------------------------------|
+| 0–2   | `flow_control`    | `0` = end/return, `1` = continue, `2+` = break (N-1) levels up |
+| 3–5   | *reserved*        | unused/unknown                                                 |
+| 6     | `no_handler`      | opcode has no handler bound; loader skips construction         |
+| 7     | `runtime_scratch` | runtime-only scratch bit, always `0` on disk                   |
+| 11–31 | `descendant_span` | number of following instructions nested as this one's children |
+
+See [tfbscript/opcodes/base.py](tfbscript/opcodes/base.py) (`InstructionFlags`).
+
+## Instructions: payload
+
+The payload (params) of the opcode.
+
+Opcode specific, often uses building blocks such as:
+
+### Reference
+
+Size: 4 bytes, bit-packed
+
+resolves to a global table entry, a local table entry, or an engine builtin (`self`, `[~each]`, ...), plus optional member/sub/scope selectors.
+
+See [tfbscript/reference.py](tfbscript/reference.py).
+
+### RHS
+
+Size: 5-11 bytes
+
+A tag byte followed by an int32, float, RGBA color, int16 pair, or a reference — optionally extended by an operator byte and a second RHS, forming an expression like `(x + 1)`.
+
+See [tfbscript/rhs.py](tfbscript/rhs.py).

tfbscript-0.1.0/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.

tfbscript-0.1.0/NOTES

@@ -0,0 +1,7 @@
+1 FOOT = 12.0 INGAME UNITS
+
+1 FOOT = 30.48cm
+
+30.48cm = 12.0 INGAME UNITS / 12.0 INGAME UNITS = 30.48cm
+
+1 INGAME UNIT = 2.54cm / 2.54cm = 1 INGAME UNIT

tfbscript-0.1.0/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.5
+Name: tfbscript
+Version: 0.1.0
+Summary: Parser and decompiler for TFB script (.ai) files used by Madagascar - The Game (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: fonttools>=4.63.0
+Requires-Dist: pyside6>=6.11.1
+Requires-Dist: pyyaml>=6.0.3
+Description-Content-Type: text/markdown
+
+# Madagascar TFBTool
+ (uses outdated assumpsions about tfbscript)
+Parser and decompiler for TFB script (`.ai`) files, as used by *Madagascar - The Game* (2005).
+
+![Python >= 3.12](https://img.shields.io/badge/python-%3E%3D3.12-blue)
+
+## Contents
+
+- [Requirements](#requirements)
+- [Usage](#usage)
+- [Opcode coverage](#opcode-coverage)
+- [Contributing](#contributing)
+- [Thanks](#thanks)
+
+## Requirements
+
+- Python >= 3.12 (uses `typing.override`, added in 3.12)
+- UV package manager
+- Dependencies from `pyproject.toml`: `uv sync`
+
+## Usage
+
+### CLI
+
+```sh
+python -m tfbscript example_scripts/Teleporter.ai
+python -m tfbscript --no-color example_scripts/*.ai
+```
+
+Syntax coloring is auto-detected: on for a real terminal, off when piped or
+when `NO_COLOR` is set. Force it with `--color` / `--no-color`.
+
+### As a library
+
+```python
+from tfbscript import ScriptFile
+
+script = ScriptFile.from_path("example_scripts/Teleporter.ai")
+script.print_tree()
+```
+
+## Thanks
+
+A HUGE thanks to the Skylanders reverse engineering Discord server and its members, especially maff, bone and nefarioustechsupport.
+
+Another GIGANTIC ENORMOUS thanks to all the contributors to igRewrite8, and to [this fork](https://github.com/bonesinmysoup/igRewrite8/tree/trapteam-but-real).
+
+## Opcode coverage
+
+**36 / 36 opcodes implemented**.
+
+- [x] comment
+- [x] print
+- [x] if/else
+- [x] for each
+- [x] loop value
+- [x] create variable
+- [x] find variable
+- [x] set reference
+- [x] check reference
+- [x] set value
+- [x] check value
+- [x] inc value
+- [x] dec value
+- [x] slide value
+- [x] spawn actor
+- [x] teleport to
+- [x] move to
+- [x] move from
+- [x] displace
+- [x] turn to
+- [x] reset
+- [x] play animation
+- [x] play sound
+- [x] stop sound
+- [x] cut-scene
+- [x] check message
+- [x] send message
+- [x] set behavior
+- [x] check fov
+- [x] control
+- [x] run as player
+- [x] find subset
+- [x] check membership
+- [x] change membership
+- [x] use camera
+- [x] remove
+
+### Needs attention / TODOs
+
+- `spawn actor::op-code` - find out purpose of remaining byte
+- `displace::op-code` - confirm fields
+
+## Contributing
+
+Contributions as issues, pull requests, or any other form are welcome and wanted.
+
+Please run `pytest` after changes to verify against all scripts in `example_scripts/`, and `pyright` for type checking.

tfbscript-0.1.0/README.md

@@ -0,0 +1,98 @@
+# Madagascar TFBTool
+ (uses outdated assumpsions about tfbscript)
+Parser and decompiler for TFB script (`.ai`) files, as used by *Madagascar - The Game* (2005).
+
+![Python >= 3.12](https://img.shields.io/badge/python-%3E%3D3.12-blue)
+
+## Contents
+
+- [Requirements](#requirements)
+- [Usage](#usage)
+- [Opcode coverage](#opcode-coverage)
+- [Contributing](#contributing)
+- [Thanks](#thanks)
+
+## Requirements
+
+- Python >= 3.12 (uses `typing.override`, added in 3.12)
+- UV package manager
+- Dependencies from `pyproject.toml`: `uv sync`
+
+## Usage
+
+### CLI
+
+```sh
+python -m tfbscript example_scripts/Teleporter.ai
+python -m tfbscript --no-color example_scripts/*.ai
+```
+
+Syntax coloring is auto-detected: on for a real terminal, off when piped or
+when `NO_COLOR` is set. Force it with `--color` / `--no-color`.
+
+### As a library
+
+```python
+from tfbscript import ScriptFile
+
+script = ScriptFile.from_path("example_scripts/Teleporter.ai")
+script.print_tree()
+```
+
+## Thanks
+
+A HUGE thanks to the Skylanders reverse engineering Discord server and its members, especially maff, bone and nefarioustechsupport.
+
+Another GIGANTIC ENORMOUS thanks to all the contributors to igRewrite8, and to [this fork](https://github.com/bonesinmysoup/igRewrite8/tree/trapteam-but-real).
+
+## Opcode coverage
+
+**36 / 36 opcodes implemented**.
+
+- [x] comment
+- [x] print
+- [x] if/else
+- [x] for each
+- [x] loop value
+- [x] create variable
+- [x] find variable
+- [x] set reference
+- [x] check reference
+- [x] set value
+- [x] check value
+- [x] inc value
+- [x] dec value
+- [x] slide value
+- [x] spawn actor
+- [x] teleport to
+- [x] move to
+- [x] move from
+- [x] displace
+- [x] turn to
+- [x] reset
+- [x] play animation
+- [x] play sound
+- [x] stop sound
+- [x] cut-scene
+- [x] check message
+- [x] send message
+- [x] set behavior
+- [x] check fov
+- [x] control
+- [x] run as player
+- [x] find subset
+- [x] check membership
+- [x] change membership
+- [x] use camera
+- [x] remove
+
+### Needs attention / TODOs
+
+- `spawn actor::op-code` - find out purpose of remaining byte
+- `displace::op-code` - confirm fields
+
+## Contributing
+
+Contributions as issues, pull requests, or any other form are welcome and wanted.
+
+Please run `pytest` after changes to verify against all scripts in `example_scripts/`, and `pyright` for type checking.

tfbscript-0.1.0/demo.py

@@ -0,0 +1,24 @@
+# from tfbscript import ScriptFile
+# from tfbscript import open_editor, editor_from_filepath
+from tfbscript import editor_from_filepath
+# from contextlib import redirect_stdout
+
+# script = ScriptFile.from_path(
+#    #"PR_Pause_{0974a777-cf50-4185-857d-810db4807d9a}.ai.mod",
+#    r"C:\Users\maxst\Projects\madagascar-game-asset-tools\Levels\german\golf\golfball_as_player_{802e7002-2517-40a2-9658-5a17f51ad463}.ai",
+#    debugOptions={
+#        "listUnresolvedOps": True,
+#    },
+# )
+#
+# with open("log.txt", "w", encoding="utf-8") as f, redirect_stdout(f):
+#    script.print_tree()
+#
+# open_editor(script)
+
+PATH = r"C:\Users\maxst\Projects\madagascar-tfbscript\example_scripts\lemurs\670_SL_LemurConvoy.ai"
+
+editor_from_filepath(PATH)
+
+# with open("PR_Pause_{0974a777-cf50-4185-857d-810db4807d9a}.ai.mod", "wb") as f:
+#   script.write(f)