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,471 Commits 2 Branches 0 Tags 3.6 GiB
Assembly 61.1%
C++ 22.5%
Python 14.6%
C 0.9%
Makefile 0.7%
Other 0.1%
Go to file
Luke Street bbc2b87815
Update CI to deploy directly to GitHub Pages (#2230) 		2024-10-30 15:42:43 -07:00
.github/workflows Update CI to deploy directly to GitHub Pages (#2230) 2024-10-30 15:42:43 -07:00
.vscode Work on daNpc_Hanjo_c (#2225) 2024-10-25 23:44:26 -07:00
assets switch to dtk setup (#2203) 2024-10-10 08:29:58 -06:00
config/GZ2E01 d_a_alink work / lv4digsand done / e_s1 matched (#2224) 2024-10-25 06:47:02 +03:00
docs Setup d_a_b + misc actors (#2166) 2024-06-10 00:34:52 -07:00
include alink horse mostly done (#2229) 2024-10-31 00:41:08 +02:00
orig/GZ2E01 switch to dtk setup (#2203) 2024-10-10 08:29:58 -06:00
src alink horse mostly done (#2229) 2024-10-31 00:41:08 +02:00
tools update dtk (#2221) 2024-10-21 04:46:00 +03: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 obj_Iceleaf almost done / d_a_alink work (#2217) 2024-10-19 11:54:22 +03: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 Add clangd support for VS Code (#2207) 2024-10-12 21:43:10 -07: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 switch to dtk setup (#2203) 2024-10-10 08:29:58 -06:00
configure.py Work on daNpc_Hanjo_c (#2225) 2024-10-25 23:44:26 -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 disc image to orig/GZ2E01.
    Supported formats: ISO (GCM), RVZ, WIA, WBFS, CISO, NFS, GCZ, TGC.

    • To save space, extract the disc image and keep only the following files:
      • sys/main.dol
      • files/RELS.arc
      • files/rel/**/*.rel

  • 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.