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
- Configurable Final Boss
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 a cia, 3ds, app, cxi or cci file of Metroid: Samus Returns as well as the desired output directory. Output files are in a format compatible with either Luma3DS or Azahar.
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.
Native code patch development
The external/ directory contains the tools for compiling and patching the
native 3DS code (via msr-remote-connector and magikoopa-py). These are
managed as git submodules, so after cloning you need to initialise them:
git submodule update --init --recursive
See external/README.md for setup and build instructions.
Metadata
Release files for open-samus-returns-rando 3.6.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| open_samus_returns_rando-3.6.2.tar.gz | 672.7 kB | With provenance | Details for open_samus_returns_rando-3.6.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| open_samus_returns_rando-3.6.2-py3-none-any.whl | Python 3 | none | any | Details for open_samus_returns_rando-3.6.2-py3-none-any.whl |
Total release size: 1.3 MB
Release files / open_samus_returns_rando-3.6.2.tar.gz
| Download URL | open_samus_returns_rando-3.6.2.tar.gz |
|---|---|
| Size | 672.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
26da553673969cd18e229b42472c1becdf9cef043340705db051c9656b5cc4b3
|
|
BLAKE2b-256 checksum How to use checksums |
2cfc5a41c96dcecddb0d6b61053b8f1a157dbb6fa914e4aece98a23d09a0e45e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 13, 2026.
Transparency logRelease files / open_samus_returns_rando-3.6.2-py3-none-any.whl
| Download URL | open_samus_returns_rando-3.6.2-py3-none-any.whl |
|---|---|
| Size | 598.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
67dc2bd4e109bdbb5d02339b8611322977a80172f1d2da5a9b211b7c2697c232
|
|
BLAKE2b-256 checksum How to use checksums |
90176259ede14e6bd4df75b564ea00a19fdcaa2d27d4895e6e5faf9214663e9b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 13, 2026.
Transparency logSecurity for open-samus-returns-rando 3.6.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for open_samus_returns_rando-3.6.2.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 13, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.