* d_a_obj_kwheel00, 01, & d_a_obj_klift00 Equivalent (weak func and/or vtable order) * Three rels equivalent * Basic documentation for the three rels * Define explicit constructor for dMdl_obj_c (needed for proper array creation in d_a_obj_klift00) * Modify d_a_obj_bky_rock to account for new explicit constructor of dMdl_obj_c * Specify weak func and/or vtable orders for rels in config.py * Cleanup includes and dol2asm artifacts * * Fix debug build * Restore incorrectly removed l_bmdidx * Fix US retail equivalency |
||
|---|---|---|
| .github/workflows | ||
| .vscode | ||
| assets | ||
| config | ||
| docs | ||
| include | ||
| orig | ||
| src | ||
| tools | ||
| .clang-format | ||
| .clangd | ||
| .flake8 | ||
| .gitattributes | ||
| .gitignore | ||
| Doxyfile | ||
| LICENSE.md | ||
| README.md | ||
| configure.py | ||
README.md
The Legend of Zelda: Twilight Princess

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%.- Also available from the Windows Store.
- Download ninja and add it to
%PATH%.- Quick install via pip:
pip install ninja
- Quick install via pip:
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.pyTo 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.
