open-prime-rando 0.20.0

An open source randomizer patcher for Metroid Prime 2 and 3.

Open Prime Rando

Open Source randomizer patcher for Prime 2 and eventually 3.

Running the patcher standalone

After cloning the repository, install the project and its extras:

uv sync --all-groups --all-extras

The command line entrypoint is open-prime-rando. The currently supported game is echoes, and the randomizer subcommand expects a configuration JSON plus input and output ISO paths:

uv run open-prime-rando echoes \
  --input-iso /path/to/prime2.iso \
  --output-iso /path/to/output.iso \
  randomizer \
  --input-json /path/to/config.json

Use uv run open-prime-rando echoes --help to see the available arguments for the Echoes patcher.

Updating hash files

Some tests compare the output of the patcher against pre-recorded hash files. When a code change intentionally alters the output, these files need to be regenerated.

Setup

The tests require ISO files for Metroid Prime 2: Echoes. Create a .env file in the repository root:

PRIME2_ISO=/path/to/prime2_ntsc.iso
PRIME2_PAL_ISO=/path/to/prime2_pal.iso

These can also be set as regular environment variables instead of using .env.

Running locally

uv run pytest --update-hashes -n 2

This runs only the hash-comparison tests and writes the new hashes in place of the old ones.

Via GitHub (pull requests)

Anyone with write access to the repository can comment /update-hashes on a pull request. A workflow will run the tests on the self-hosted runner, commit the updated files, and push them to the PR branch.

Credits

Echoes

Banner image created by rekameohs.