https://github.com/randovania/open-dread-rando
Randomizer patcher for Metroid Dread
https://github.com/randovania/open-dread-rando
metroid-dread randomizer
Last synced: 11 months ago
JSON representation
Randomizer patcher for Metroid Dread
- Host: GitHub
- URL: https://github.com/randovania/open-dread-rando
- Owner: randovania
- License: gpl-3.0
- Created: 2021-11-23T21:46:54.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T23:52:16.000Z (over 1 year ago)
- Last Synced: 2024-10-29T14:22:30.320Z (over 1 year ago)
- Topics: metroid-dread, randomizer
- Language: Lua
- Size: 10.8 MB
- Stars: 19
- Watchers: 2
- Forks: 15
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Open Dread Rando
Open Source randomizer patcher for Metroid Dread. Intended for use in [Randovania](https://randovania.github.io/).
Currently supports patching item pickups, starting items, and elevator/shuttle/teleportal destinations.
## Installation
`pip install open-dread-rando`
## Usage
You will need to provide JSON data matching the [JSON schema](https://github.com/randovania/open-dread-rando/blob/main/src/open_dread_rando/files/schema.json) in order to successfully patch the game.
The patcher expects a path to an extracted romfs directory of Metroid Dread 1.0.0 or 2.1.0 as well as the desired output directory.
Output files are in a format compatible with either Atmosphere or Ryujinx, depending on the settings provided.
With a JSON file:
`python -m open_dread_rando --input-path path/to/dread/romfs --output-path path/to/the/output-mod --input-json path/to/patcher-config.json`
## Game Versions
Only versions 1.0.0 and the latest version are supported long term. Other versions might be compatible at any given point,
but new releases are free to remove that.
Currently, the following versions are supported:
- 1.0.0
- 2.1.0