randovania/yams

Yet Another Metroid-2-Remake Shuffler

Randovania

Welcome to Randovania, a randomizer platform for a multitude of games.

New here or looking to install? Check our website.

Supported Games

• Another Metroid 2 Remake
• Cave Story
• Metroid Dread
• Metroid Prime
• Metroid Prime 2: Echoes
• Metroid: Samus Returns

Randovania can randomize many aspects of its supported games, all while still ensuring they're completable without using any glitches or exploits. Its features include:

• Randomizing what can be found in each item location. Weapons, keys, and more can end up in completely new places.

• Use Multiworld sessions to shuffle items between multiple separate games, alone or with friends. All Multiworld games are compatible with each other - mix and match as you like!

• Randomize how areas connect to one another, or what resources are required to travel between areas. These options are highly customizable, letting you limit or unleash the chaos.

• Randomize your starting equipment and location. Feeling brave? You can even shuffle items you normally start with.

Have fun and start randomizing!

Installation

In the releases page, we have zip files with everything ready to use. Just extract and run!

For Linux users, we recommend using our Flatpak instead.

Community

Join the Randovania Discord: https://discord.gg/M23gCxj6fw

Invite links for specific games' servers can be found in the #game-communities channel in our server.

Credits

GUI and logic written by Henrique Gemignani, with contributions by SpaghettiToastBook, gollop and many others.

BashPrime, Pwootage, and April Wade made https://randomizer.metroidprime.run/, from which the GUI was based.

Website created by Hugoshido and duncathan_salt. portfolYOU Jekyll theme by Youssef Raafat. Free for personal and commercial use under the MIT license.

Installer is powered by Advanced Installer, which has graciously provided us with an open source license.

Linux Flatpak build contributed by Ethan Lee.

Games

Metroid Prime

• Game patching via randomprime. Originally authored by April Wade, it is now maintained and developed by toasterparty with contributions from others
• Room data collected by UltiNaruto, EthanArmbrust and SolventMercury.
• Converting Metroid Prime 2 models by Migs.

Metroid Prime 2: Echoes

• Game patching written by Claris.
• Room data initially collected by Claris, revamped by Dyceron.
• Menu Mod created by Claris. For more information, see the Menu Mod README.
• Converting Metroid Prime models by Migs.

Cave Story

• Patcher and logic written by duncathan_salt.
• Based on the original randomizer by shru.
• Features contributions from many others.

Metroid Dread

• Game Patching by:

  • Henrique "Darkszero" Gemignani
  • duncathan_salt
  • ScorelessPine
  • Arcanox
  • Migs
  • hyperbola0
  • Thanatos

• Logic Database by:

  • KirbymastaH
  • Dyceron
  • XenoWars
  • Mayberry
  • Hugoshido
  • Tyranisaur

• Assets by:

  • Morph Ball and Speed Booster pickup textures created by BigSharkZ.
  • Spider Magnet pickup texture by duncathan_salt with help from BigSharkZ.
  • New map icons by SkyTheLucario.

Another Metroid 2 Remake

• Game Patching by:

  • Miepee
  • JesRight

• Logic Database by:

  • Miepee
  • DruidVorse
  • JeffGainsNGames

• Assets by:

  • Morph Ball, and the Missile Launcher sprites were made by ShirtyScarab554 licensed under CC BY-SA 4.0.
  • Power Grip and the Shiny Nothing Orb were made by ShirtyScarab554, used under CC BY-SA 4.0, modified by AbyssalCreature and licensed under CC BY-SA 4.0.
  • New door sprites and other AM2R item sprites were made by AbyssalCreature licensed under CC BY-SA 4.0.

Metroid: Samus Returns

• Game Patching by:

  • Dyceron
  • Thanatos
  • Henrique "Darkszero" Gemignani
  • duncathan_salt
  • Merikatt

• Logic Database by:

  • Dyceron
  • Miepee
  • Haxaplax

Auto Tracker

Primes

• Game theme assets were provided by MaskedTAS.
• Pixel theme assets were provided by Uncle Reggie.

AM2R

• AM2R 1.5.5 item sprites were made by Eskimode7 licensed under CC BY-SA 4.0.
• The AM2R DNA sprite was made by AbyssalCreature licensed under CC BY-SA 4.0.
• The AM2R Morph Ball and Power Grip sprites were made by ShirtyScarab554 licensed under CC BY-SA 4.0.

Metroid: Samus Returns

• Game theme assets were provided by Dyceron.

Multiworld

Server and logic written by Henrique "Darkszero" Gemignani.

Primes

Dolphin and Nintendont integrations written by Henrique "Darkszero" Gemignani. These were based on Dolphin Memory Engine and Pwootage's Nintendont fork, respectively. In-game message alert initially written by encounter.

Cave Story

Cave Story Doukutsu and CSE2 Tweaked integations written by duncathan_salt, periwinkle and ikuyo.

Metroid Dread

Integration written by Thanatos and Henrique "Darkszero" Gemignani. The "unplug" icon is by tezar tantular from Noun Project (licensed under CC BY 3.0).

Another Metroid 2 Remake

Integration written by Miepee. Offworld sprites are licensed under CC BY-SA 4.0 and are made by AbyssalCreature, ShirtyScarab554 and many others.

Metroid: Samus Returns

Integration written by Thanatos.

Developer Help

Dependencies

• Python 3.12 64-bit
• Git

Setup

Getting started:

1. Clone this repository. (downloading the zip is not supported and will not work)
2. Open a terminal in the repository root
3. Run the following file:
   1. Windows: tools/prepare_virtual_env.bat
   2. Linux/macOS: tools/prepare_virtual_env.sh
4. You should see "Setup finished successfully." visible when the command finishes.
5. For certain use cases, such as exporting games or running tests, additional setup is needed.

In order to start Randovania, open:

1. Windows: tools/start_client.bat
2. Linux/macOS: tools/start_client.sh

In order to update your repository:

1. Update the git repository. (With git pull or anything else)
2. Make sure that Randovania is closed.
3. Re-run the steps from "Getting Started", starting at step 2.
   1. In case of unexpected errors, delete the venv in the root of the repository and start again.
4. Open Randovania normally.

In order to be able to export games:

1. Run both "Getting started" and "Start Randovania" steps.
2. Activate the virtual env. Check start_client.bat/sh for details.
3. Run python -m pip install -r requirements.txt.

In order to run the tests:

1. Run both "Getting started" and "Start Randovania" steps.
2. Activate the virtual env. Check start_client.bat/sh for details.
3. Run python -m pip install -r requirements.txt.
4. Run python -m pytest test.

In order to run the server:

1. Run both "Getting started" and "Start Randovania" steps.
2. Activate the virtual env. Check start_client.bat/sh for details.
3. Run python -m pip install -r requirements.txt.
4. Run python tools/prepare_dev_server_config.py once.
5. If you wish to use any Discord functionality, you'll need to create an app in Discord and fill both ids in tools/dev-server-configuration.json.
6. Run the server and client. You can this on
   1. Windows with tools/start_dev_server.bat for the server and tools/start_debug_client.bat for the client
   2. Linux/macOS with tools/start_dev_server.sh for the server and tools_start_debug_client.sh for client

This repository uses pre-commit. The hook is automatically configured with the prepare_virtual_env scripts.

Suggested IDE: PyCharm Community

Visual Studio Code

Clone this repository and open the folder in Visual Studio Code. It suggests several useful plugins for developing which you should download and install.

If your Python is setup properly, you can use the Create venv with all exporters task by pressing CTRL+SHIFT+P, type in Task, select Tasks: Run task and then select the task. It will create the venv with all the dependencies installed for you.

There is also a task defined to run all tests. To run individual tests you can utilise the Testing section of Visual Studio Code. You can simply run or debug a test there.

To start Randovania you can press CTRL+F5. If you only press F5, Randovania will start with a debugger. Be aware that starting with a debugger makes the application much slower.

Documentation

• Unfamiliar with a term? Check the glossary.
• Adding a new game? Check the dedicated guide.
• Changing a data format? Check the migrations documentation.
• Working with the logic database?
  • Read how the database is organized.
  • Read the unfinished script for a video on how to use the data editor.

yams's Issues

Add HudMemo for labs blocks

For new players, display a Hudmemo to explain that these blocks disappear only when all DNA is connected.

Ensure brightness level and water level is as it should be for all pipe rooms

Add BG3 south gamma, right dock -> left dock via morph glide to logic

See https://discord.com/channels/914291389293027329/1142816464945041500/1202770911950929970

Update schema.json and README

The README currently says

The API/Schema for the input json file will soon be documented.

Cross-referencing the schema.json and SeedObject it seems like the schema partially documents it but is missing some fields (at first glance, starting_items and pickups are missing documentation and pipes is not a field). This should be updated to be consistent, and the README should direct users to schema.json.

It looks like you could auto-generate a schema.json based on the SeedObject, based on this StackOverflow post. I'd also look into adding CI to ensure schema matches and see if there's a way to add property attributes for schema fields like description.

Add videos to logic DB

• https://www.youtube.com/watch?v=1T8X8W6G4-U&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=16
• https://www.youtube.com/watch?v=CCsGG55iT2w&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=19
• https://www.youtube.com/watch?v=g0kWLHM0p1Y&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=23
• https://www.youtube.com/watch?v=qiadG_Nmux4&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=26
• https://www.youtube.com/watch?v=BHjwXtE4i44&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=30
• https://www.youtube.com/watch?v=IXWb2U036Lg&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=31
• https://www.youtube.com/watch?v=7a_MN_ZBc58&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=17
• https://www.youtube.com/watch?v=BYGrFjVOOXQ&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=18
• https://www.youtube.com/watch?v=VpVOOVz0Wqo&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=20
• https://www.youtube.com/watch?v=f-OY6Ic-H9w&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=21
• https://www.youtube.com/watch?v=f_xVasfp93M&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=22
• https://www.youtube.com/watch?v=kxqAgmdHK_g&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=24
• https://www.youtube.com/watch?v=q8JhGGl8u-c&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=25
• https://www.youtube.com/watch?v=t42hj6u94cI&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=27
• https://www.youtube.com/watch?v=WayWFvCYE_8&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=32
• https://www.youtube.com/watch?v=Ms2W8U5Drpg&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=33
• https://www.youtube.com/watch?v=yDjHOQ-aG1w&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=34
• https://www.youtube.com/watch?v=VLu8ujljuGg&list=PL3l1MUvtY68XxNORgBQs--5vXjmcnpJ2m&index=35

When showing the hash mismatch popup, show the world name to the user, not the world uuid

get the world name from wherever pickup names get them
or hints, etc

If Research hatches are shuffled to be ammo doors, going through them doesnt unlock them

Solve problem of what item you collected being somewhat easy to miss

Current ideas:

• increase the popup text length. still doesnt solve the issue of alpha squad
• have a "most recent items" collected cosmetic option. solves alpha squad, but get issues with random/hidden models
  

Random Pipes: Make destinations more distinct in-game/minimap

Migrate package to pyproject.toml

Currently its still using setup.cfg for most things

Mention how many frames speedbooster takes to charge in speed booster upgrades

it takes 106 frames to charge.
relevant file: https://github.com/randovania/randovania/blob/main/randovania/games/am2r/pickup_database/pickup-database.json#L588

Revise Missile logic for Metroids

It's long overdue. they're currently too precise and don't give leeway for less skillful players.

Tower activation cutscene isnt skipped when cutscene skips are on

Adjust A5 damage requirements

Basically this whole area needs another pass with damage requirements.

Placing doors on transitions issues

• Place them on a different depth to be more in the background
• try to detect cases with single tile length rooms
• make special exception for lower door in water turbine station

Add json schema

Water Turbine gets automatically destroyed if other turbine is destroyed

https://discord.com/channels/914291389293027329/929070804564607096/1242387752486567978

Adding patches of flipping the game vertically/horizontally

Prepare texture pages when creating a release instead of at runtime

Change dual gammas gravityless to combat intermediate

Add hypermode morph glide in waterfall exterior

https://www.youtube.com/watch?v=pek-zZsYFec

Fix longer metroid fanfare songs

If the music for the metroid fanfares is too long (which can be achieved by custom music, or via music shuffle), then the music gets weirded out a bit and multiple songs play at the same time

Have an option to have a different required amount of DNA to unlock the lab

Reentering a boss room after killing the boss locks you into the room with no way to escape

:(

Require Dual Gammas to have gravity for combat, or a trick

See title.

gravity area corridor: add in logic that you can get the item via charge beam

should be gated via knowledge.

Move Doors when shuffled over Research Site Hatches

This door is partially obscured by foreground tiles making it easy to misidentify in door lock rando. Removing the vertical rock tiles would make the texture more easily readable. I could see this especially being an issue for EMP doors.

Rename 'Spazer Beam' room to 'Spazer Beam Chamber'

Requires preset and description migration.
See randovania/randovania#4796 as inspritation

BG3: Gamma South Septogg Helper only spawns AFTER a room reset

this either needs to be:

• changed to have the septogg spawn on gamma death
• removed from logic (bad)

Make the baby non collectable, unless the total amount of DNA was collected

Should be relatively easy to do, by having a DNA check in the trigger, and if it fails, destroy both the egg and the trigger.

AM2R: implement colored log entries for hints

#198

Expose bosses as resources

So you can have bosses on the tracker.

If shooting a charge beam at metroids but have other beams enabled, show a popup mesage

see itle. would be good for new users.

Don't compare word hash in hash check

but if the word hash changes and the actual hash doesn't, compatibility hasn't broken
which could happen from as benign a change as adding new hash words

The word hash however should still be shown to the end user if they have a hash mismatch.

Change info.plist on macos to enforce a seperate save directory

Ammo doors get unlocked as blue in labs, but are visible as ammo doors when reentering the room

See the video here: https://discord.com/channels/914291389293027329/1142816464945041500/1241101424453091349

Better flashlight and blindfold sprites

Would be nice to get these sprites to a similar quality as the rest of the sprites.

Make drop descriptions clearer

Instead of "Current power bombs increased by" it should probably say "Power bombs refilled by" or something.

AM2R: implement colored log entries for hints

Planned by @Jesright73 to implement

Very much recommended to use https://yal.cc/r/gml/ for testing
Somewhat of a spec sheet:
text:
- default color is white
- text can change its color via `{COLOR}` where COLOR is one of the following text, with the GM color in brackets: white (c_white), yellow (c_yellow), red (c_red), pink (c_fuchsia), green (c_green), blue (c_blue), light_blue (c_aqua), dim_blue (c_navy). Every other text will get interpreted as white. A `{COLOR}` will not get printed, but will cause that all text *after* it gets the color changed. Encountering `{COLOR` without a closing bracket, should cause a crash. Encountering `COLOR}` without an opening bracket should get interpreted as normal text that should get printed.

Examples:
- `Foo blabla bl` -> all text is white
- `asdfasdf{red}ww` -> `asdfasdfww` gets printed, with asdfasdf being in white, and ww in red.
- `asdf{green` -> game will crash
- `{hey yall}scott here` -> `scott here` gets printed in white


somewhat of implementation, may be very shaky but is hopefully good enough ground work
- set text color to white
- while (not_end_of_text)
  - if spaces exist in text, grab everything until space. if no space exists, grab until End_of_String
  - if grabbed_text contains '{' , only grab until the start of '{'
  - if grabbed_text contains '#', only grab until start of '#'
  - if the very first character is '{' (may need to rewrite this a bit, due to above condition)
    - change color
  - else
    - get width of the grabbed text (string_width)
    - have enough space? -> draw
    - not enough space, but can this fit onto a line on its own? -> newline and draw text
    - not enough space and cant fit onto newline? -> ???
the end result code should cause log text to be backwards compatible to how it is currently being drawn (mostly in regards to when text gets split onto a new line. my previous attempts were not lmao) 

Tower Gamma SE needs shinespark trick adjustment

• currently rated beginner, does not align with other levels given need for additional movement after

Adjust deeper A3 damage requirements.

This whole section should get the damage requirements adjusted. Especially rooms containing shirks.