Decompilation of The Legend of Zelda: Twilight Princess (GCN, USA)
Go to file
notyourav b6063221ee
Merge pull request #88 from barzamin/patch-1
fix branch name in doxygen workflow
2021-01-24 21:17:31 -08:00
.github/workflows Merge branch 'master' into patch-1 2021-01-21 22:20:42 -06:00
asm Z2AudioLib misc decomp (#75) 2021-01-21 23:16:51 -05:00
docs Doxygen (#84) 2021-01-18 14:00:28 -05:00
include Z2AudioLib misc decomp (#75) 2021-01-21 23:16:51 -05:00
libs Z2AudioLib misc decomp (#75) 2021-01-21 23:16:51 -05:00
src d_com_inf_game / d_save improvements (#82) 2021-01-11 11:32:56 -05:00
tools Z2AudioLib misc decomp (#75) 2021-01-21 23:16:51 -05:00
.clang-format add missing class in d_save and clang-format 2020-12-25 21:11:16 -05:00
.gitignore Doxygen (#84) 2021-01-18 14:00:28 -05:00
Doxyfile Doxygen (#84) 2021-01-18 14:00:28 -05:00
Makefile Z2AudioLib misc decomp (#75) 2021-01-21 23:16:51 -05:00
README.md Doxygen (#84) 2021-01-18 14:00:28 -05:00
asmdiff.sh fvb, functionvalue, vector (#77) 2021-01-18 14:27:25 -05:00
diff.py diff.py: robust/autodected path processing for xplatform --source (#85) 2021-01-18 14:38:53 -05:00
diff_settings.py Makefile: DEBUG option (#86) 2021-01-18 14:16:09 -05:00
dolzel2.sha1 ok 2020-08-29 17:54:55 -04:00
ldscript.lcf Z2AudioLib misc decomp (#75) 2021-01-21 23:16:51 -05:00
obj_files.mk fvb, functionvalue, vector (#77) 2021-01-18 14:27:25 -05:00

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

  1. Download and run the latest release of the Windows devkitpro installer
  2. Run the executable located at devkitPro\msys2\msys2.exe
  3. Update pacman by running the following command: pacman -Syu
  4. Install the necessary dependencies by running the following command: pacman -S python3-pip base-devel gcc vim cmake
  5. Change to the directory of where you cloned this repository and you are ready to build!

Build Instructions

  1. Obtain a clean DOL of TP (GCN USA) and place it at the root of the repo and name it baserom.dol.
  2. 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.
  3. Run make at 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.