Madagascar TFBTool

(uses outdated assumpsions about tfbscript) Parser and decompiler for TFB script (.ai) files, as used by Madagascar - The Game (2005).

Contents

• Requirements
• Usage
• Opcode coverage
• Contributing
• Thanks

Requirements

• Python >= 3.12 (uses typing.override, added in 3.12)
• UV package manager
• Dependencies from pyproject.toml: uv sync

Usage

CLI

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

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.

Opcode coverage

36 / 36 opcodes implemented.

• comment
• print
• if/else
• for each
• loop value
• create variable
• find variable
• set reference
• check reference
• set value
• check value
• inc value
• dec value
• slide value
• spawn actor
• teleport to
• move to
• move from
• displace
• turn to
• reset
• play animation
• play sound
• stop sound
• cut-scene
• check message
• send message
• set behavior
• check fov
• control
• run as player
• find subset
• check membership
• change membership
• use camera
• 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.