mirror of https://github.com/zeldaret/tp
* set up Doxygen - `.gitignore`: ignore Doxygen output - limit Doxygen search to relevant paths - move extra `.md`s to docs/ - `Makefile`: add Doxygen target - use as much SVG as possible for Doxygen diagrams - alias @meme as an \xrefitem * new github workflow: run doxygen and push to gh pages |
||
|---|---|---|
| .github/workflows | ||
| asm | ||
| docs | ||
| include | ||
| libs | ||
| src | ||
| tools | ||
| .clang-format | ||
| .gitignore | ||
| Doxyfile | ||
| Makefile | ||
| README.md | ||
| asmdiff.sh | ||
| diff.py | ||
| diff_settings.py | ||
| dolzel2.sha1 | ||
| ldscript.lcf | ||
| obj_files.mk | ||
README.md
The Legend of Zelda: Twilight Princess
This repo contains a WIP decompilation of The Legend of Zelda: Twilight Princess (GCN USA).
It builds the following DOL:
main.dol - sha1: 4997D93B9692620C40E90374A0F1DBF0E4889395
And will eventually build all the RELs.
Windows Prerequisites
- Download and run the latest release of the Windows devkitpro installer
- Run the executable located at
devkitPro\msys2\msys2.exe - Update pacman by running the following command:
pacman -Syu - Install the necessary dependencies by running the following command:
pacman -S python3-pip base-devel gcc vim cmake - Change to the directory of where you cloned this repository and you are ready to build!
Build Instructions
- Obtain a clean DOL of TP (GCN USA) and place it at the root of the repo and name it
baserom.dol. - Obtain a copy of the MWCC PowerPC compiler (version 2.7 to be exact). See below for a link to our Discord server which has the CodeWarrior compilers pinned in the #tp-decomp channel.
- Run
makeat the root of the repo.
Contributions
All contributions are welcome. This is a group effort, and even small contributions can make a difference. Some tasks also don't require much knowledge to get started.
Most discussions happen on our Discord Server, where you are welcome to ask if you need help getting started, or if you have any questions regarding this project and other decompilation projects.