randovania / open-dread-rando

Randomizer patcher for Metroid Dread

Open Dread Rando

Open Source randomizer patcher for Metroid Dread. Intended for use in Randovania. 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 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

open-dread-rando's Issues

Starting with Energy Tanks does not work

Used 2 starting ETanks, started with 99 health

atmosphere seems to expect a different folder structure for exefs patches

we'll need to be able to choose between emulator and console output.

Pickups: expect all known pickups to be present.

Would raise an error if some element is missing from the pickups actor.

Lock lower door to artaria CU until boss is defeated

Causes a softlock if entered from below

Map still highlights major locations even after collection

Put blast shields on both sides of doors

Power beam doors with a blast shield on the opposite side can't be opened without breaking the blast shield. Putting the blast shield on both sides should make the behavior much more intuitive

Many pickups for major upgrades play unknown item sound when collected

Seems to be with:

• Anything progressive
• Anything that came from EMMIs

Mystery crash in gravity subarea of Burenia

happened while entering from the early gravity entrance. logging wasn't enabled so reason for crash is unclear. error message suggested a null pointer. corrupt actor, perhaps?

escape sequence not activating

Dynamic model and popup text for progressive pickups

Update the model used by progressive pickups to reflect the item that would be given

Alternative goal: Kill all EMMI

After killing all emmi, the path to the ship opens without the escape sequence?

Phantom Cloak doesn't work immediately after being collected

Reloading from save after collection solves it.

Collecting a Power Bomb only gives ammo, not the main item

releasing the X forces some of chainreaction into post state, making vanilla varia inaccessible

Hijack Adam rooms for hints/arbitrary text

This involves:

• Removing event-based Adam conversations
• Don't lock player in the room until they talk with adam
• Replacing the text with user provided text
• wishlist: create new text2speech audio for new text

lock door to quiet robe room before fighting the robot soldier

causes a softlock if you enter the fight room first before the Emmi zone

hint mission log entries seem to overwrite each other

expansions seem to have smaller collision than they should

can just walk through them sometimes

Support TTS for hint text on Adam

For bonus points, we could support multiple TTS backends so it can be selectable via a cosmetic option.

Disable freeze event when using Artaria <-> Burenia elevator

Grabbing pickups stops Samus's speed booster charge

I'm not sure whether this is the case for all pickups in all locations, but there are at least some instances where grabbing an item while Samus is at top speed will stop her, as shown in this clip where I started running and just held left: https://streamable.com/u5yyu3

Expand Readme

Hey!

I hope this isn't too rude to ask, but could you explain a bit on how to use this tool in the readme? :)

Support Corpius

Speedbooster doesn't work immediately after collecting

Known workaround is to reload the game

Change what triggers the X release

Change to something more obvious like entering Elun, instead of touching the exit of the first morph ball tunnel

Defeating an EMMI does not play music until leaving the EMMI zone

some new double sided blast shields don't work

known example: blast shield added to wide beam room

Add some form of anti-softlock to save stations

Add warp to start to save stations.

Update icons on the map for pickups

Grapple Beam is missing the electric particles

Collecting Progressive Suit causes a crash on emulator

(Untested on console)
As in the title, collecting a progressive suit in a heated room seems to cause a crash. It may be possible that Gravity Suit in Cold Rooms may cause the same issue, but it is unknown. Attached is a zipped rdvgame where the bug can be found (generated on dev213) and an image of the location where this progressive suit was found.
This isn't an immediate issue considering heat/cold runs are not recommended to use, however if/when damage runs are used in the future, this could pose a problem.
EDIT: I may have spoken too soon, picking up another progressive suit elsewhere also caused a crash. It may not be the cause in the title, however crashes are still not good.

Dread Randomizer - Spreader Shrine Hall.zip

enlarge main PB model

entering artaria for the first time will always save the game at the vanilla spawn point

add randomizer credits

Support for displaying a textbox on start

So we can display things like random starting items.
This text should only be displayed when first starting the save.

Skip EMMI-defeated cutscenes

Specifically the cutscene where Samus walks up to the EMMI on the ground

Dairon purple teleporter wide beam door disappearing under unknown circumstances

Non-major items on bosses have weird side effects

This is related to a callback being created for when the inventory screen popup is closed. since ITEM_NONE has no popup, it never gets closed, and the callback never happens. this notably causes a softlock on Corpius as well as prevents the darkness going away on emmis

Collecting Varia/Gravity doesn't automatically change the model

Support having custom text if collecting PB tank before mains

This should be easy for expansions, unclear for emmi/bosses,

Prevent game from starting if current version is different from version used to randomize

This would be focused entirely on romfs.

1.0.0, 1.0.2 and 1.0.3 have the same romfs. 1.0.1 has some modified romfs, but that version is not interesting anyway.
2.0.0 has a modified romfs with significant changes.

Playing 2.0.0 with a romfs that comes from 1.0.X have at least missing text, but it's unknown if subtle things break.

Yellow EMMI pickup issues

Text was not changed.
Gave only max missile count, not current missiles.

Support for changing boss drops

EMMIs, both Core-X drops.

Ignoring Corpius because that's fun.

Models aren't animated properly

Pickups are using the sphere animation file, instead of the appropriate one

support creating new start points when passed a location

missile expansions on bosses do not increase current missile count, only max

Opening Wide Beam door in Dairon - Teleport to Cataris while powered down breaks

The blast shield is destroyed, but the door doesn't open. Then when the power is back online, the door can't be opened.

strange behavior with golzuna and gamestate

• golzuna won't spawn without releasing the X
• if entered normally, the door in its room will be locked
• at some point, a state change happens and the room is in its post-golzuna state, allowing passage through the door and presumably not spawning the boss?

Remove checkpoint after Kraid

This would be a part of series of removing checkpoints in places risky for softlocks.

Loading a save file after quitting to main menu breaks the HUD

Reseting the game solves it