Game-Decompilation/pikmin2
1
0
Fork 0
mirror of https://github.com/projectPiki/pikmin2.git synced 2024-11-23 05:20:06 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
A decompilation of Pikmin 2 (USA) brought to you by fans of the series.
4,355 Commits 1 Branch 0 Tags 220 MiB
Assembly 66.8%
C++ 28.6%
C 4.1%
Python 0.3%
Makefile 0.2%
253758b8ef
Go to file
PikHacker 253758b8ef
Some checks failed
Build / Build (GPVE01) (push) Has been cancelled
Details
Build / Build (GPVE01_D17) (push) Has been cancelled
Details
Build / Build (legacy) (GPVE01) (push) Has been cancelled
Details
Build / Build (legacy) (GPVE01_D17) (push) Has been cancelled
Details
zukan2d fixes / misc cleanup
2024-10-14 00:29:51 -04:00
.github/workflows Use dtk-template for ninja build (#216) 2024-08-17 00:36:56 -04:00
.vscode some kando stuff / change vscode to utf8 2024-08-17 15:42:02 -04:00
asm Link Kabuto.cpp 2024-09-16 13:17:57 +10:00
assets Use dtk-template for ninja build (#216) 2024-08-17 00:36:56 -04:00
config Use dtk-template for ninja build (#216) 2024-08-17 00:36:56 -04:00
docs zukan2d fixes / misc cleanup 2024-10-14 00:29:51 -04:00
include zukan2d fixes / misc cleanup 2024-10-14 00:29:51 -04:00
orig Use dtk-template for ninja build (#216) 2024-08-17 00:36:56 -04:00
sha1 Use dtk-template for ninja build (#216) 2024-08-17 00:36:56 -04:00
src zukan2d fixes / misc cleanup 2024-10-14 00:29:51 -04:00
tools decompctx include fix 2024-08-29 21:39:07 -04:00
.clang-format fix a bit more baseGameSection 2024-05-18 23:09:06 -04:00
.flake8 Use dtk-template for ninja build (#216) 2024-08-17 00:36:56 -04:00
.gitattributes Use dtk-template for ninja build (#216) 2024-08-17 00:36:56 -04:00
.gitignore Use dtk-template for ninja build (#216) 2024-08-17 00:36:56 -04:00
aoi.exe AOI refix 2023-10-24 01:51:13 +01:00
configure.py Link Kabuto.cpp 2024-09-16 13:17:57 +10:00
include_link.mk JAudio2 -> JAudio 2023-03-05 18:26:54 +11:00
ldscript.lcf nuke forcefiles 2023-10-19 23:17:46 -04:00
LICENSE.MD Rename LICENSE to LICENSE.MD 2022-01-21 21:35:01 -05:00
Makefile Use dtk-template for ninja build (#216) 2024-08-17 00:36:56 -04:00
obj_files.mk asm cleanup 2023-02-01 23:20:03 -05:00
README.MD make progress badges clickable 2024-09-20 13:36:35 +10:00

README.MD

Pikmin 2
Build Status Code Progress Data Progress Linked Progress Discord Badge

A work-in-progress decompilation of Pikmin 2.

Supported versions:

  • GPVE01: USA Retail
  • GPVE01_D17: USA Demo 17

Index

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 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. Dolphin filesystem extract
    • 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.

objdiff project configuration

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.