Decompilation of The Legend of Zelda: Twilight Princess (GCN, USA)
Go to file
Carco_21 c0717e1e56
d_a_obj_lv6bemos2 and d_a_obj_lv6bemos almost equivalent (#2527)
* initial work

* All but one function equivalent

* Missed comment that needed to be removed

* initial work

* got to CreateHeap

* d_a_obj_lv6bemos almost equivalent
2025-07-15 23:05:04 +03: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 switch to dtk setup (#2203) 2024-10-10 08:29:58 -06:00
config Minor d_a_alink fixes (#2534) 2025-07-15 23:00:01 +03:00
docs
include d_a_obj_lv6bemos2 and d_a_obj_lv6bemos almost equivalent (#2527) 2025-07-15 23:05:04 +03:00
orig add wii usa rev0 support (#2505) 2025-06-27 13:14:58 +03:00
src d_a_obj_lv6bemos2 and d_a_obj_lv6bemos almost equivalent (#2527) 2025-07-15 23:05:04 +03:00
tools d_a_npc_besu equivalent (#2510) 2025-07-06 03:07:33 -07:00
.clang-format
.clangd Z2AudioLib work (#2339) 2025-03-21 23:03:43 -07:00
.flake8 switch to dtk setup (#2203) 2024-10-10 08:29:58 -06:00
.gitattributes switch to dtk setup (#2203) 2024-10-10 08:29:58 -06:00
.gitignore d_a_npc_ashB work (#2250) 2024-11-13 13:50:44 -08:00
Doxyfile switch to dtk setup (#2203) 2024-10-10 08:29:58 -06:00
LICENSE.md
README.md Update dtk-template & fix source paths (#2231) 2024-10-30 16:35:28 -07:00
configure.py d_a_e_cr / d_a_e_cr_egg done (#2536) 2025-07-15 22:57:21 +03: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.