Decompilation of The Legend of Zelda: Twilight Princess (GCN, USA)
Go to file
Carco_21 3318b5e936
Continued monkey work (monkey business if you will) - Monkey-related TUs (#2469)
* Initial work

* Work on ori2 and others

* Work on npc_ks_home

* Work on npc_ks_demo_022

* Chugging through

* Started on demo_camera

* More demo_camera work

* 51% equivalent

* General cleanup

* Fixed compile error in d_a_e_mk

* Small d_a_e_mk fix

* d_a_e_fs fix

* PR cleanup

* Started work on d_a_obj_sw

* d_a_obj_sw work

* Small fixes

* d_a_obj_so work

* d_a_obj_so almost equivalent and small work on d_a_npc_ks

* Work on npc_ks_guide_00

* Work on guide functions

* 80% matching

* Almost have all functions worked on

* All functions worked on

* Initial d_a_npc_saru work

* Tiny bit more work

* daNpc_Saru almost matching

* fixed array issue

* obj_kago work

* d_a_obj_kago almost matching

* sare_npc brief fix

* PR cleanup
2025-06-07 19:41:01 +03:00
.github/workflows Update dtk-template (#2453) 2025-05-22 22:25:06 -07:00
.vscode Debug version now builds OK and all_source compiles (#2343) 2025-03-22 18:00:51 -07:00
assets switch to dtk setup (#2203) 2024-10-10 08:29:58 -06:00
config d_a_npc_henna equivalent (#2473) 2025-06-03 23:31:22 +03:00
docs Setup d_a_b + misc actors (#2166) 2024-06-10 00:34:52 -07:00
include Continued monkey work (monkey business if you will) - Monkey-related TUs (#2469) 2025-06-07 19:41:01 +03:00
orig GCN pal / jpn support, some debug work (#2375) 2025-04-06 21:08:25 +03:00
src Continued monkey work (monkey business if you will) - Monkey-related TUs (#2469) 2025-06-07 19:41:01 +03:00
tools Update dtk-template (#2453) 2025-05-22 22:25:06 -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 add license (#389) 2023-07-25 17:22:44 -04:00
README.md Update dtk-template & fix source paths (#2231) 2024-10-30 16:35:28 -07:00
configure.py d_a_b_gg equivalent (#2478) 2025-06-07 17:37:27 +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.