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
Что это?Это открытая, ещё незавершённая декомпиляция Super Mario Galaxy 1, восстанавливающая оригинальный C++-код игры путём сопоставления со скомпилированным бинарником.
Это играбельный ПК-порт игры?Нет, это чисто декомпиляция, восстанавливающая исходный код; команда прямо говорит, что не пытается создать ПК-порт, хотя отдельный связанный порт в работе под названием «AstroCore» обсуждается в их Discord.
Как это собрать?Склонируйте репозиторий, сделайте дамп своей копии игры через Dolphin Emulator в orig/RMGK01 (строго необходим только sys/main.dol), затем запустите configure-скрипт и соберите с ninja.
Какие инструменты нужны перед сборкой?На Windows нужны Python и ninja, добавленные в PATH; на macOS и Linux достаточно установить ninja, а 32-битная обёртка wibo для Windows-бинарников скачивается автоматически для тулчейна.
Нужно ли владеть игрой, чтобы пользоваться этим?Да, в репозитории нет собственных игровых ресурсов или ассемблерного кода, поэтому нужно предоставить легально снятый дамп игры; официально поддерживается пока только корейский релиз RMGK01 Rev 0.
Использовала ли команда ИИ для ускорения декомпиляции?Нет. ИИ разрешался только для задач вне декомпиляции: именование переменных, чистка кода и документация; запросы на слияние (pull request) с декомпиляцией, сгенерированной ИИ, отклоняются.
Как сверять прогресс с оригинальным бинарником?Скачайте objdiff, укажите ему на сгенерированный в корне проекта objdiff.json и выбирайте объект в боковой панели, чтобы сравнить пересобранный код с оригиналом, с автопересборкой при изменении исходников.
Откуда взялась часть общего кода?Проект брал код и заголовки из других декомпиляций, включая проекты bte и tp из doldecomp (для JSystem) и ogws.
Size
92.6 MB
Stars
1.3K
Updated
CommitOct 17
Age
7y
Commits · 90 Days