Game-Decompilation/pikmin
1
0
Fork 0
mirror of https://github.com/projectPiki/pikmin.git synced 2024-11-22 21:09:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
A decompilation of Pikmin brought to you by fans of the series.
789 Commits 1 Branch 0 Tags 63 MiB
Assembly 68.4%
C++ 25.6%
C 5.8%
Python 0.2%
main
Go to file
Dean Southwood 9174340500
Some checks failed
Build / build (GPIE01_01) (push) Has been cancelled
Details
misc item + gameflow progress
2024-11-17 02:26:28 +11:00
.github/workflows Enable all_source and progress report 2024-09-27 01:06:06 -06:00
.vscode misc item + gameflow progress 2024-11-17 02:26:28 +11:00
asm --non-matching builds non-matching 2024-09-11 19:06:26 -04:00
config --non-matching builds non-matching 2024-09-11 19:06:26 -04:00
include misc item + gameflow progress 2024-11-17 02:26:28 +11:00
orig Add orig/*/.gitkeep and progress fixes 2024-09-10 23:51:18 -06:00
src misc item + gameflow progress 2024-11-17 02:26:28 +11:00
tools Add orig/*/.gitkeep and progress fixes 2024-09-10 23:51:18 -06:00
.clang-format Update .clang-format 2024-01-01 11:35:29 -05:00
.flake8 Migrate to dtk-template 2024-09-10 01:17:42 -06:00
.gitattributes Migrate to dtk-template 2024-09-10 01:17:42 -06:00
.gitignore Update .gitignore 2024-09-10 10:32:07 -04:00
configure.py misc item + gameflow progress 2024-11-17 02:26:28 +11:00
format-files.py clang-format 2022-01-21 16:54:21 -05:00
LICENSE.MD Create LICENSE.MD 2022-01-21 21:33:16 -05:00
README.MD Add orig/*/.gitkeep and progress fixes 2024-09-10 23:51:18 -06:00

README.MD

Pikmin
Build Status Code Progress Data Progress Discord Badge

A work-in-progress decompilation of Pikmin.

Supported versions:

  • DPIJ01: PikiDemo / Jitsuen-you Sample
  • GPIJ01_01: Japan (Rev 1)
  • GPIJ01_02: Japan (Rev 2)
  • GPIE01_00: USA (Rev 0)
  • GPIE01_01: USA (Rev 1)
  • GPIP01_00: Europe (Rev 0)

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/pikmin.git

  • Using Dolphin Emulator, extract your game's system data to orig/GPIE01_01. (Or the appropriate version folder.)

    • 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/GPIE01_01/sys/main.dol.

  • Configure:

    python configure.py

    To use version other than GPIE01_01, add --version. 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