Petari ships withDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/SMGCommunity/Petari/llms.txt
Use this file to discover all available pages before exploring further.
.github.example/workflows/build.yml, a ready-made CI workflow that builds every version on each push or pull request and reports decompilation progress to frogress on pushes to main. Complete the three sections below to activate it.
Build repository
A separate, private GitHub repository stores the Docker build container that CI uses to compile the project. It is kept private so game assets are never publicly accessible.Create the build repository
Create a new private repository from the
encounter/dtk-template-build
template.
A common convention is to append -build to your project name — for
example, smg-build.Add game assets
Copy your game’s original files into the
orig/GAMEID directory, replacing
GAMEID with your game’s actual ID to match the orig/ layout in your
main repository. Include only the files required for the build, such as
sys/main.dol and any .rel or .sel files.Wait for the build container action
After pushing, GitHub Actions will build and publish the container image as
a package on the repository. Once the action finishes, open the repository’s
Packages page, then open Package settings.
Progress tracking
Decompilation progress is pushed to frogress so the community can track how complete the project is. You need an API key to authenticate those uploads.Request an API key
Join the GC/Wii Decompilation Discord and
post in
#frogress to request a key for your project. Include your project
name, repository URL, game ID(s), and whether the game uses REL files.Workflow setup
With the build repository and API key in place, enable the workflow by renaming and editing the example configuration.Rename the example directory
Rename
.github.example to .github at the root of your repository. This
makes GitHub recognise the included workflow file.Point the workflow at your build image
Open
.github/workflows/build.yml and update the container: field to the
package URL of the image published by your build repository.Set the game ID
Replace the placeholder
GAMEID value in build.yml with your game’s
actual ID. If your project supports multiple versions, provide a list of
IDs.Update the progress slug
Set
PROGRESS_SLUG in build.yml to the project slug you registered on
frogress. This slug identifies which project receives the progress reports.