Open Samus Returns Rando

Open Source randomizer patcher for Metroid: Samus Returns. Intended for use in Randovania. Currently supports patching the following:

• Starting Items
• Starting Location
• Pickups (Vanilla and Custom)
• Items on Metroids
• Shuffled DNA
• Shuffled Baby Metroid
• Elevator Destinations
• Door Types

Installation and Usage

pip install open-samus-returns-rando

You will need to provide JSON data matching the JSON schema in order to successfully patch the game.

The patcher expects a path to an extracted romfs directory of Metroid: Samus Returns as well as the desired output directory. Output files are in a format compatible with either Luma3DS or Citra.

With a JSON file: python -m open-samus-returns-rando --input-path path/to/samus-returns/romfs --output-path path/to/the/output/mod --input-json path/to/patcher-config.json

Development

This repository uses pre-commit.

pip install pre-commit
pre-commit install