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,576 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
LagoLunatic 4dc0cd9d09
Debug version now builds OK and all_source compiles (#2343) 
* Fix missing arg to JUT_ASSERT

* Fix some MWCC version diff errors

* Compile m_Do_ext, d_demo, actor_mng

* Add VSCode task to quickly switch between versions

* Unlink magLift for debug

* Update the hash of the debug dol

The old cbea5fa... hash here was for the dol generated by the alf2dol.py script, which produces incorrect alignment.

The dol with the new hash can be obtained by using `dtk elf2dol` to convert the debug .alf file to a dol.

The DOL now builds OK.

* Fix all debug REL dtor splits

All RELs now also build OK, meaning `ninja build/ShieldD/ok` now succeeds.

* Add genMessage declarations to all HIO subclasses

* Fixing more compilation errors

* m_Do_mtx 100% on debug

Cannot be linked due to weak function name mangling?

* Improve various matches

* Fix all remaining compilation errors

* Fix new compilation errors from main

* Fix retail regression

* Link f_pc_profile_lst
 		2025-03-22 18:00:51 -07:00
.github/workflows Update CI to deploy directly to GitHub Pages (#2230) 2024-10-30 15:42:43 -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 Debug version now builds OK and all_source compiles (#2343) 2025-03-22 18:00:51 -07:00
docs Setup d_a_b + misc actors (#2166) 2024-06-10 00:34:52 -07:00
include Debug version now builds OK and all_source compiles (#2343) 2025-03-22 18:00:51 -07:00
orig wip debug / pal building, b_gm mostly done (#2285) 2025-01-16 19:37:39 +02:00
src Debug version now builds OK and all_source compiles (#2343) 2025-03-22 18:00:51 -07:00
tools b_dr equivalent, update dtk-template (#2327) 2025-03-14 04:46:21 -04:00
.clang-format d_a_b_oh2 / d_a_obj_web0 / d_a_obj_web1 (#243) 2023-01-15 12:10:23 -07:00
.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 Debug version now builds OK and all_source compiles (#2343) 2025-03-22 18:00:51 -07: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.