randovania / yams

Yet Another Metroid-2-Remake Shuffler

Yet Another Metroid2 Shuffler (YAMS)

A patcher for providing a different randomization experience to AM2R different to what the game has built-in. It was primarily designed for Randovania, but it's also usable as a standalone patcher.
Usage:
./YAMS-CLI [path-to-original-data-file] [path-to-output-data-file] [path-to-json-file]

The API/Schema for the input json file will soon be documented. In the meantime, one can look at this source file.

Compilation

This project uses git submodules. So before compiling, please ensure you have cloned them (either by doing git clone --recursive https://github.com/randovania/YAMS, or if you have already cloned the repo, git submodule update --init).
After that, you can use the standard dotnet compilation step: dotnet build YAMS-CLI.

License

All code is licensed under the GNU Public License version 3. See the LICENSE-CODE file for full details.
Art assets are licensed under CC-BY-SA 4.0. For the full list of authors and more details, please read the Attribution.md file located in YAMS-LIB/sprites/.

yams's Issues

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.

Prepare texture pages when creating a release instead of at runtime

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

Water Turbine gets automatically destroyed if other turbine is destroyed

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

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.

Ensure music value is as it should be for every room, for future ER

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

Add HudMemo for labs blocks

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

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)

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.

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

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
  

Mark DNA hints which have been collected

Revise Missile logic for Metroids

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

Migrate package to pyproject.toml

Currently its still using setup.cfg for most things

Adding patches of flipping the game vertically/horizontally

Add json schema

Adjust deeper A3 damage requirements.

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

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

Add a history log

Option to change suit DR

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.

Expose bosses as resources

So you can have bosses on the tracker.

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

add starting items to item history

for completeness starting items should probably be shown in this tab.

Change dual gammas gravityless to combat intermediate

AM2R: Flashlight not working in Breeding Grounds Fly Stadium Access

I went into Breeding Grounds Fly Stadium Access with Flashlight 4 and the room was still dark
In Fly Stadium Access with Flashlight 4

In Fly Stadium with Flashlight 4

I am unsure if the bug is for all flashlight levels. The preset I use has one Flashlight item that gives Flashlight 4

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

See title.

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

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

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

:(

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

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

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

Adjust A5 damage requirements

Basically this whole area needs another pass with damage requirements.

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

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 hypermode morph glide in waterfall exterior

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

Make drop descriptions clearer

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

Better flashlight and blindfold sprites

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

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

Add Arm Cannon

Implement entrance rando

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) 

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

should be gated via knowledge.

Delete extra songs if they're not in the input directory but are in the output directory

otherwise its leaving side effects of music rando

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

see itle. would be good for new users.

AM2R: implement colored log entries for hints

#198

Tower Gamma SE needs shinespark trick adjustment

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

Tower activation cutscene isnt skipped when cutscene skips are on

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

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