tww/README.md
2023-09-14 17:34:26 -04:00

3.1 KiB

The Legend of Zelda: The Wind Waker
Build Status Progress DOL Progress RELs Progress

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.

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.

More documentation