Go to file
TakaRikka 8185d87f85
copy homebuttonLib from oot-vc (#2960)
* initial copy of hbm from sdk_2009-12-11

* some more nw4hbm cleanup

* nw4hbm db mostly done

* nw4hbm snd copied from oot-vc

* nw4hbm ut copied

* nw4hbm lyt copied

* nw4hbm copied, mostly matching usa 1.0

* setup nw4hbm debug define

* fix HBMDataInfo struct

* add rvl sdk card lib
2025-12-16 16:55:07 +02:00
.github/workflows Add configuration for GZ2J01 (Wii JPN) (#2950) 2025-12-12 22:22:03 -08:00
.vscode Add configuration for GZ2J01 (Wii JPN) (#2950) 2025-12-12 22:22:03 -08:00
assets Add configuration for GZ2J01 (Wii JPN) (#2950) 2025-12-12 22:22:03 -08:00
config copy homebuttonLib from oot-vc (#2960) 2025-12-16 16:55:07 +02:00
docs Setup d_a_b + misc actors (#2166) 2024-06-10 00:34:52 -07:00
include copy homebuttonLib from oot-vc (#2960) 2025-12-16 16:55:07 +02:00
orig More Wii symbol cleanup (#2956) 2025-12-15 17:08:51 -08:00
src copy homebuttonLib from oot-vc (#2960) 2025-12-16 16:55:07 +02:00
tools Fix bugs in weak_order_diff.py (#2955) 2025-12-15 17:08:14 -08:00
.clang-format Debug work + some retail regalloc fixes (#2787) 2025-11-09 11:43:14 -08:00
.clangd Start linking some TUs on debug and PAL (#2612) 2025-08-27 17:37:31 -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 & use wibo on macOS (#2829) 2025-11-20 01:16:44 -08:00
configure.py copy homebuttonLib from oot-vc (#2960) 2025-12-16 16:55:07 +02: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
    

wibo, a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.

Linux

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.