zeldaret / tww

The Legend of Zelda: The Wind Waker 
[![Build Status]][actions] [![Progress]][progress site] [![DOL Progress]][progress site] [![RELs Progress]][progress site] [![Discord Badge]][discord]
=============
[Build Status]: https://github.com/zeldaret/tww/actions/workflows/build.yml/badge.svg
[actions]: https://github.com/zeldaret/tww/actions/workflows/build.yml
[Progress]: https://decomp.dev/zeldaret/tww.svg?mode=shield&measure=code&label=Code&category=all
[DOL Progress]: https://decomp.dev/zeldaret/tww.svg?mode=shield&measure=code&label=DOL&category=dol
[RELs Progress]: https://decomp.dev/zeldaret/tww.svg?mode=shield&measure=code&label=RELs&category=modules
[progress site]: https://zeldaret.github.io/tww/
[Discord Badge]: https://img.shields.io/discord/688807550715560050?color=%237289DA&logo=discord&logoColor=%23FFFFFF
[discord]: https://discord.com/invite/DqwyCBYKqf/
A work-in-progress decompilation of The Legend of Zelda: The Wind Waker for GameCube.
This repository does **not** contain any game assets or assembly whatsoever. An existing copy of the game is required.
All GameCube versions are supported:
- `GZLE01`: Rev 0 (USA), Rev 48 (KOR)
- `GZLP01`: Rev 0 (PAL)
- `GZLJ01`: Rev 0 (JPN)
- `D44J01`: Kiosk demo (JPN)
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`
macOS:
------
- Install ninja:
 [code] 
wibo, a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.
Linux:
------
- Install ninja.
wibo, a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.
Building
========
- Clone the repository:
 [code] 
- Copy your game's disc image to `orig/GZLE01`.
 - 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:
 [code] 
 To use a version other than `GZLE01` (USA), specify `--version GZLJ01` (JPN) or `--version GZLP01` (PAL).
- Build:
 [code] 
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`.
Setting up Ghidra
=================
Ghidra is a tool that automatically decompiles code. Although Ghidra's output is not accurate enough to be directly copy-pasted into this decompilation project, it can still be helpful for understanding functions and decompiling them fas