Petari README

The project's README from github.com/SMGCommunity/Petari. As one markdown file: README.md.

Petari Build Status Progress Linking Discord Badge

A visual

A work-in-progress decompilation of Super Mario Galaxy 1.

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

This project is not meant to be an effort to create a PC Port. Join the the Discord server to learn more and ask about our work-in-progress PC port "AstroCore".

Regarding AI usage

A lot of dicussion and accusations have been made claiming we used AI/LLMs to accelerate the decompilation process. We did not.

Although AI was allowed for tasks that did not directly affect progress, such as variable naming, code cleanup, and documentation, it never ended up playing a role in this project. The fast progress acceleration of the project was a result of new collaborators, a ton of motivation, and great community efforts. It was not a result of AI usage or any other kind of automated decompilation work.

If you don't trust this statement enough, read the source code yourself and form your own conclusions.

Below are our AI usage guidelines:

[!NOTE] AI may be used for code cleanup, formatting, documentation, and naming assistance. AI-generated decompilation work is not allowed. Pull requests containing obvious AI-generated decompilation output or other AI slop will be rejected. Contributors should be able to explain and justify any decompilation work they submit. This also applies to all tool-generated code. We want to keep this project as human as possible.

Supported versions:

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.

macOS

wibo, a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.

Linux

wibo, a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.

Building

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

Big thanks to the doldecomp team for their efforts on bte, tp for JSystem, and ogws, where this repository has sourced code and headers from.

Petari (SMGCommunity/Petari)

Searching Database…

1.3K ·GitHub
Petari
What is this?This is an open-source, work-in-progress decompilation of Super Mario Galaxy 1, rebuilding the game's original C++ source code by matching it against the compiled binary.
Is this a playable PC port of the game?No, it is purely a decompilation effort that reconstructs source code; the team explicitly says it is not trying to create a PC port, though a separate related WIP port called 'AstroCore' is discussed on their Discord.
How do I build this?Clone the repository, dump your own copy of the game with Dolphin Emulator into orig/RMGK01 (only sys/main.dol is strictly required), then run the configure script and build with ninja.
What tools do I need installed before building?On Windows you need Python and ninja added to PATH; on macOS and Linux you only need to install ninja, and the wibo 32-bit Windows binary wrapper is downloaded automatically for the toolchain.
Do I need to own the game to use this?Yes, the repo contains no game assets or assembly code of its own, so you must supply a legally-dumped copy of the game; currently only the Korean RMGK01 Rev 0 release is officially supported.
Did the team use AI to speed up the decompilation?No. AI was only permitted for non-decompilation tasks like variable naming, code cleanup, and documentation; pull requests with AI-generated decompilation output are rejected.
How do I check my progress against the original binary?Download objdiff, point it at the objdiff.json generated in your project root, and select an object in the sidebar to diff your rebuilt code against the original, with auto-rebuilds on source changes.
Where did some of the shared code come from?The project sourced code and headers from other decompilation efforts, including doldecomp's bte and tp projects for JSystem, and ogws.
What are similar projects?re4, th08, Wind-Waker-Recomp, bbhost, Fable-2-Recomp, TheSimpsonsGameRecomp, rpcs3, Cpp2IL
Which topics is it in?decompiler, assembly, binary-analysis, retrogaming, modding, emulator, gamedev, game-development, game, github-actions, gaming, reverse-engineering
Creator
SMGCommunity
Size
92.6 MB
Stars
1.3K
Updated
CommitOct 14
Age
7y
Commits · 90 Days