semvec/pypi-packages huggingface dataset:
open-samus-returns-rando 3.4.0
An open source randomizer patcher for Metroid: Samus Returns.
Requires Python: >=3.10

# Open Samus Returns Rando
Open Source randomizer patcher for Metroid: Samus Returns. Intended for use in [Randovania](https://github.com/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](https://github.com/randovania/open-samus-returns-rando/blob/main/src/open_samus_returns_rando/files/schema.json) in order to successfully patch the game.

The patcher expects a path to a `cia`, `3ds`, `app` or `cxi` file 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/file.3ds --output-path path/to/the/output/mod --input-json path/to/patcher-config.json`

## Development
This repository uses [pre-commit](https://pre-commit.com/). 
```
pip install pre-commit
pre-commit install
```