falso
/
tp
mirror of https://github.com/zeldaret/tp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Decompilation of The Legend of Zelda: Twilight Princess (GCN, USA)
1,785 Commits 2 Branches 0 Tags 3.6 GiB
Assembly 61.1%
C++ 22.5%
Python 14.6%
C 0.9%
Makefile 0.7%
Other 0.1%
Go to file
carter-ktb21 b339d75483 padding cleanup 2025-07-24 11:05:23 -04:00
.github/workflows Update dtk-template (#2453) 2025-05-22 22:25:06 -07:00
.vscode Add more J3D_ASSERTs (#2491) 2025-06-19 23:41:43 -07:00
assets
…
config d_a_obj_tobyhouse equivalent (#2546) (#2543) 2025-07-22 15:22:58 +03:00
docs
…
include padding cleanup 2025-07-24 11:05:23 -04:00
orig add wii usa rev0 support (#2505) 2025-06-27 13:14:58 +03:00
src Enums added 2025-07-24 11:03:09 -04:00
tools d_a_obj_brg matching (#2539) 2025-07-18 10:53:45 +03:00
.clang-format
…
.clangd Z2AudioLib work (#2339) 2025-03-21 23:03:43 -07:00
.flake8
…
.gitattributes
…
.gitignore d_a_npc_ashB work (#2250) 2024-11-13 13:50:44 -08:00
Doxyfile
…
LICENSE.md
…
README.md Update dtk-template & fix source paths (#2231) 2024-10-30 16:35:28 -07:00
configure.py Enums added 2025-07-24 11:03:09 -04:00

README.md

The Legend of Zelda: Twilight Princess
Build Status Code Progress DOL Progress RELs Progress Discord Badge

A work-in-progress decompilation of The Legend of Zelda: Twilight Princess (GCN USA).

This repository does not contain any game assets or assembly whatsoever. An existing copy of the game is required.

More information about the project can be found here: https://zsrtp.link

Dependencies

Windows

On Windows, it's highly recommended to use native tooling. WSL or msys2 are not required.
When running under WSL, objdiff is unable to get filesystem notifications for automatic rebuilds.

  • Install Python and add it to %PATH%.
  • Download ninja and add it to %PATH%.
    • Quick install via pip: pip install ninja

macOS

  • Install ninja:

    brew install ninja

  • Install wine-crossover:

    brew install --cask --no-quarantine gcenx/wine/wine-crossover

After OS upgrades, if macOS complains about Wine Crossover.app being unverified, you can unquarantine it using:

sudo xattr -rd com.apple.quarantine '/Applications/Wine Crossover.app'

Linux

  • Install ninja.
  • For non-x86(_64) platforms: Install wine from your package manager.
    • For x86(_64), wibo, a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.

Building

  • Clone the repository:

    git clone https://github.com/zeldaret/tp.git

  • Copy your game's disc image to orig/GZ2E01.

    • Supported formats: ISO (GCM), RVZ, WIA, WBFS, CISO, NFS, GCZ, TGC.
    • After the initial build, the disc image can be deleted to save space.

  • Configure:

    python configure.py

    To use a version other than GZ2E01 (USA), specify it with --version.

  • Build:

    ninja

Diffing

Once the initial build succeeds, an objdiff.json should exist in the project root.

Download the latest release from encounter/objdiff. Under project settings, set Project directory. The configuration should be loaded automatically.

Select an object from the left sidebar to begin diffing. Changes to the project will rebuild automatically: changes to source files, headers, configure.py, splits.txt or symbols.txt.