Game-Decompilation/ac-decomp
1
0
Fork 0
mirror of https://github.com/Prakxo/ac-decomp.git synced 2024-11-23 06:10:07 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
967504633c
ac-decomp/README.md
Luke Street 1b0b96665a Migrate to dtk-template 
Co-authored-by: NWPlayer123 <NWPlayer123@users.noreply.github.com>
2024-10-28 19:18:21 -06:00

4.1 KiB
Raw Blame History

Animal Crossing
Build Status DOL Progress REL Progress Discord Badge

A work-in-progress decompilation of Animal Crossing.

This repository does not contain any game assets or assembly whatsoever. An existing copy of the game is required.

Supported versions:

  • GAFE01_00: Rev 0 (USA)

A decompilation of the original N64 version of the game is being worked on here.

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%.
  • Download ninja and add it to %PATH%.
    • Quick install via pip: pip install ninja

macOS

  • Install ninja:

    brew install ninja

  • Install wine-crossover:

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

After OS upgrades, if macOS complains about Wine Crossover.app being unverified, you can unquarantine it using:

sudo xattr -rd com.apple.quarantine '/Applications/Wine Crossover.app'

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 --recursive https://github.com/Prakxo/ac-decomp.git

  • Update and Initialize submodules:

    git submodule update --init --recursive

  • Copy your game's disc image to orig/GAFE01_00.

    • 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:

    python configure.py

    To use a version other than GAFE01_00 (USA), specify it with --version.

  • 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.

Credits

  • jamchamb, Cuyler36, NWPlayer123 and fraser125 for past documentation of Animal Crossing.
  • SeekyCt for ppcdis and helping setting up the project.
  • msg for helping with tools/map.py.