mirror of https://github.com/zeldaret/tww.git synced 2024-11-27 07:11:32 +00:00

Decompilation of The Legend of Zelda: The Wind Waker

Go to file

Dylan Ascencio a19d81f113 Small but important fix for m_DoExt_McaMorf		2023-09-14 20:12:10 -04:00
.github/workflows	Add progress calculation & upload to frogress	2023-09-14 17:34:26 -04:00
assets	Import project	2023-09-10 00:48:55 -04:00
config	Update dtk & config adjustments	2023-09-13 09:48:56 -04:00
docs	Import project	2023-09-10 00:48:55 -04:00
include	Small but important fix for m_DoExt_McaMorf	2023-09-14 20:12:10 -04:00
orig	Import project	2023-09-10 00:48:55 -04:00
src	Started work on pushable boxes (#32 )	2023-09-14 15:42:57 -07:00
tools	Fix transform_dep.py usage with sjiswrap	2023-09-14 17:41:01 -04:00
.clang-format	Import project	2023-09-10 00:48:55 -04:00
.gitattributes	Import project	2023-09-10 00:48:55 -04:00
.gitignore	Update .gitignore	2023-09-13 18:15:47 -04:00
configure.py	Merge pull request #33 from encounter/progress	2023-09-14 17:44:43 -04:00
LICENSE	Initial commit	2023-09-09 10:08:34 -04:00
README.md	Add progress calculation & upload to frogress	2023-09-14 17:34:26 -04:00

README.md

The Legend of Zelda: The Wind Waker

This repository supports the following versions:

GZLE01 - Rev 0 (USA), Rev 48 (KOR)
GZLP01 - Rev 0 (PAL)
GZLJ01 - Rev 0 (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 ninja and add it to %PATH%.
Install Python and add it to %PATH%.
- Also available from the Windows Store.

macOS:

Install ninja:
```
brew install ninja
```

Install wine-crossover:

brew install --cask --no-quarantine gcenx/wine/wine-crossover

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/tww.git

Using Dolphin Emulator, extract your game to orig/GZLE01 (or GZLJ01 for JPN, GZLE01 for PAL).
- To save space, the only necessary files are the following. Any others can be deleted.
  - sys/main.dol
  - files/rels/*.rel
  - files/RELS.arc
Configure:
```
python configure.py
```
To use a version other than GZLE01 (USA), specify --version GZLJ01 (JPN) or --version GZLP01 (PAL).
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.