Animal Crossing: City Folk

A decompilation of Animal Crossing: City Folk for the Nintendo Wii.

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

Supported versions:

• RUUE01_00: Rev 0 (USA)

Dependencies

• Install Python.
• Install ninja.

See Dependencies for platform-specific setup. Native tooling is recommended on Windows; WSL and MSYS2 are not required. The compiler, linker and other build tools are downloaded automatically. On supported macOS and Linux platforms, wibo runs the Windows compiler tools.

Building

1. Clone the repository:

   git clone https://github.com/ACreTeam/cf-decomp.git
   cd cf-decomp

2. Extract your game's data partition and copy the files into orig/RUUE01_00. The build requires the original DOL and all 187 RELs in this layout:

   orig/RUUE01_00/sys/main.dol
   orig/RUUE01_00/files/rels/*.rel
   

3. Configure:

   python configure.py --version RUUE01_00

4. Build:

   ninja

A successful build verifies the DOL and all RELs against their original SHA-1 hashes. See City Folk configuration setup for details.

Diffing

Once the initial build succeeds, an objdiff.json should exist in the project root.

Download objdiff. Under project settings, set Project directory to this repository. The configuration should load automatically.

Select an object from the left sidebar to begin diffing. Changes to source files, headers, configure.py, splits.txt or symbols.txt trigger automatic rebuilds.

Documentation

• City Folk configuration setup
• Identified source splits
• symbols.txt
• splits.txt
• GitHub Actions and decomp.dev setup

Credits

• encounter and NWPlayer123 for dtk-template and the build system.