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,675 Commits 2 Branches 0 Tags 3.8 GiB
Assembly 61.1%
C++ 22.5%
Python 14.6%
C 0.9%
Makefile 0.7%
Other 0.1%
Go to file
Lachlan Watson df8d6655a3
d_a_obj_nameplate matching (#2445) 
* d_a_obj_nameplate equivalent

* Address review comments d_a_obj_nameplate matching
 		2025-05-16 17:22:14 +03:00
.github/workflows
…
.vscode Debug version now builds OK and all_source compiles (#2343) 2025-03-22 18:00:51 -07:00
assets
…
config d_a_bg mostly matching. update version symbols / add platform macros (#2410) 2025-04-25 20:53:30 +03:00
docs
…
include d_a_obj_nameplate matching (#2445) 2025-05-16 17:22:14 +03:00
orig GCN pal / jpn support, some debug work (#2375) 2025-04-06 21:08:25 +03:00
src d_a_obj_nameplate matching (#2445) 2025-05-16 17:22:14 +03:00
tools Utility script 'beautify_anm_data.py' to assist getting started with d_a_npc TUs (#2413) 2025-04-27 21:06:44 -07:00
.clang-format
…
.clangd Z2AudioLib work (#2339) 2025-03-21 23:03:43 -07:00
.flake8
…
.gitattributes
…
.gitignore
…
Doxyfile
…
LICENSE.md
…
README.md
…
configure.py d_a_obj_nameplate matching (#2445) 2025-05-16 17:22:14 +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.