pikmin2/README.MD

Pikmin 2

A work-in-progress decompilation of Pikmin 2.

Supported versions:

• GPVE01: USA Retail
• GPVE01_D17: USA Demo 17

Index

• Dependencies
  • Windows
  • macOS
  • Linux
• Building
• Diffing
• Modding

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:

  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 https://github.com/projectPiki/pikmin2.git
  

• Using Dolphin Emulator, extract your game's system data to orig/GPVE01. (Or orig/GPVE01_D17 for demo)

  • Right-click the game in Dolphin's game list and select Properties.
  • Go to the Filesystem tab and right-click Disc -> Extract System Data.
  • After extraction, the following file should exist: orig/GPVE01/sys/main.dol.

• Configure:

  python configure.py
  

  To use the demo version, add --version GPVE01_D17. Add --help to see all available options.

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

Modding

To enable modding, run configure.py with the --non-matching flag:

python configure.py --non-matching

This:

• Disables final hash verification.
• Builds all assembly files in asm.
• Builds all source files marked as Equivalent in configure.py.

Once built with ninja, the new DOL will exist at build/GPVE01/main.dol.