SM64: Move Randomizer Content Update #2569

Magnemania · 2023-12-06T22:14:23Z

What is this fixing or adding?

This adds new options (which default to false) that allow the player to lock up to 10 of Mario's movement abilities behind collectible items.
This replaces most of the existing logic with a new logic system that parses rules from a basic language (to allow these rules to be easily read by players and updated in the future). The generated lambdas are simplified if the player does not randomize the moves.
Regions have been reworked to split levels into several subregions for move randomizer logic.
Star requirement options have been altered to use percentages, rather than hard numbers, so that the total star count option can be respected. This ensures that a player will always get the total star count they requested as long as enough locations exist in the world to fill it (whereas the old behavior would subtract stars from the player's total if they select certain other options). If the player leaves these options at their default values, star requirements will exactly match those in the vanilla game.

How was this tested?

The Archipelago community has been openly testing with the distributed APWorld since March of this year, and logic improvements have been implemented in response to community feedback.

If this makes graphical changes, please attach screenshots.

N00byKing

There are some things I missed the first time through I guess, but nothing major.
Keep in mind my python is not really good, so I might've made some mistakes in the review

N00byKing · 2023-12-07T10:11:08Z

worlds/sm64ex/Options.py

+def getMoveRandomizerOption(action: str):
+    class MoveRandomizerOption(Toggle):
+        """Mario is unable to perform this action until a corresponding item is picked up.
+        If Mario 64 is built with an alternative "nomoverando" branch, this option will not affect Mario."""


I'd rather this say something like This option is incompatible with builds using a 'nomoverando' branch.
The nomoverando branch prints huge warnings on screen if they attempt to load a game where move rando is enabled, its not like its a cheat code to have it not affect mario (Except if they can ignore that I guess).

Done. (1cab3ef)

N00byKing · 2023-12-07T10:14:18Z

worlds/sm64ex/Regions.py


+# List of all courses, including secrets, without BitS as that one is static


Comment is at a weird place. Currently looks like it is just referencing sm64_level_to_paintings, which does not include secrets.
In the first place these arent lists, but dicts from the game-specific entrance format to the name of the entrance.
Does make me realize I made the same mistake just below for sm64secrets though ^^'

Removed that comment and cleaned up the secrets comment. (f57ef5e)

N00byKing · 2023-12-07T10:18:49Z

worlds/sm64ex/Rules.py

        swapdict.pop(entrance)

-def set_rules(world, player: int, area_connections: dict):
+def set_rules(world, player: int, area_connections, star_costs, move_rando_bitvec: int):


Why did you remove the typing annotation?

Accident. (007aa81)

N00byKing · 2023-12-07T10:24:05Z

worlds/sm64ex/__init__.py

-                        self.multiworld.MIPS1Cost[self.player].value, self.multiworld.MIPS2Cost[self.player].value,
-                        self.multiworld.StarsToFinish[self.player].value)
-        self.multiworld.itempool += [self.create_item("Power Star") for i in range(0,starcount)]
-        self.multiworld.itempool += [self.create_item("1Up Mushroom") for i in range(starcount,120 - (15 if not self.multiworld.EnableCoinStars[self.player].value else 0))]


Items must be created in create_items, per #1460

Making Starcraft 2 comply with that PR is going to be involve rewriting the whole codebase from start-to-finish. A lot easier to fix it in SM64. Done. (163a61c)

Just to be a bit pedantic: It must be done by create_items, not in create_items - If for some reason you want to make items in generate_early for example, you can do that

I think you are no longer creating the ExclamationBox items

I think you are no longer creating the ExclamationBox items

Why would they not be created? I haven't done much to change the code in that part.

I cannot create the cannons or exclamation box items in create_items if the options result in them getting hard-placed later, as that would be modifying the item pool after create_items.

N00byKing · 2023-12-07T10:26:19Z

worlds/sm64ex/Rules.py

-        if randomized_entrances[91] not in sm64_paintings_to_level.keys(): # Unlucky :C (91 -> BoB Entrance)
-            rand = world.random.choice(sm64_paintings_to_level.values())
+        swapdict = {entrance: level for (level, entrance) in randomized_entrances.items()}
+        valid_first_courses = valid_move_randomizer_start_courses if move_rando_bitvec > 0 else list(sm64_paintings_to_level.keys())


Is the cast to list necessary here?

The cast to list is necessary. keys() generates a dict_keys object that behaves differently from a list, and tends to fail on any operation more complicated than iterating through all the elements once (like random.choice()).

N00byKing · 2023-12-07T10:34:59Z

worlds/sm64ex/Rules.py

        randomized_level_to_paintings = shuffle_dict_keys(world,sm64_level_to_paintings)
+        if world.AreaRandomizer[player].value < 3 and move_rando_bitvec > 0:
+            first_course = world.random.choice(valid_move_randomizer_start_courses)
+            for entrance, painting in randomized_level_to_paintings.items():


I dont like this loop.
Equivalent but to me nicer looking: next(key for key, value in dd.items() if value == 'value') .
Though tbh I found this on stackoverflow

I normally use comprehensions everywhere, I'm not sure why I didn't do so here. Changed. (29480bd)

N00byKing · 2023-12-07T10:39:59Z

worlds/sm64ex/Rules.py

-def fix_reg(entrance_ids, entrance, destination, swapdict, world):
-    if entrance_ids[entrance] == destination: # Unlucky :C
+def fix_reg(entrance_map, entrance, destination, swapdict, world):
+    if entrance_map[swapdict[entrance]] == destination: # Unlucky :C


Should probably be entrance_map[sm64_entrances_to_level[entrance]] right?

I'm having some trouble figuring out how fix_reg works, and it doesn't seem to be working correctly before or after that change. I'm going to have to take a look at it later; might make an enum for Entrances to make it easier to understand.

N00byKing

Second round is in

N00byKing · 2023-12-08T09:10:04Z

worlds/sm64ex/Rules.py

+            rand = world.random.choice(valid_first_courses)
+            rand_entrance = swapdict[rand]
+            randomized_entrances[Entrances.BOB_OMB_BATTLEFIELD], randomized_entrances[rand_entrance] = rand, first_course
+            swapdict.pop(rand)


Same as above.
Can probably be simplified to just use fix_reg as well.
fix_reg(randomized_entrances, Entrances.BOB_OMB_BATTLEFIELD, <Courses not in valid_first_courses>, swapdict, world)
You can then also remove the if cond just above, as its checked in fix_reg

N00byKing · 2023-12-08T09:16:41Z

worlds/sm64ex/Rules.py

-        swapdict[rand] = entrance_ids[entrance]
-        swapdict.pop(entrance)
+def fix_reg(entrance_map: Dict[Entrances, str], entrance: Entrances, destination: str,
+            swapdict: Dict[str, Entrances], world, invalid_regions: Set[str] = {}):


If you are introducing invalid_regions, no need to keep destination parameter; just use that instead. (Put it as third parameter tho, not at the end)

N00byKing · 2023-12-08T09:17:29Z

worlds/sm64ex/Rules.py

+        rand_region, rand_entrance = world.random.choice(replacement_regions)
+        entrance_map[entrance], entrance_map[rand_entrance] = rand_region, destination
+        swapdict[rand_region] = entrance
+        swapdict.pop(destination)


Thinking about it, this needs to always pop. Otherwise, on subsequent calls an invalid region might get swapped back in (So always pop entrance_map[entrance])
So for any call to fix_reg, after the call the destination for this entrance will no longer change

N00byKing · 2023-12-08T09:21:47Z

worlds/sm64ex/Rules.py

-            fix_reg(randomized_entrances, "Cavern of the Metal Cap", "Dire, Dire Docks", swapdict, world) # ... then dont allow COTMC to be mapped to DDD
+        fix_reg(randomized_entrances, Entrances.BOWSER_IN_THE_FIRE_SEA, "Dire, Dire Docks", swapdict, world)
+        if randomized_entrances[Entrances.BOWSER_IN_THE_FIRE_SEA] == "Hazy Maze Cave": # If BITFS is mapped to HMC...
+            fix_reg(randomized_entrances, Entrances.CAVERN_OF_THE_METAL_CAP, "Dire, Dire Docks", swapdict, world, {"Hazy Maze Cave"}) # ... then dont allow COTMC to be mapped to DDD


This can be simplified using invalid_regions, if you remove the destination parameter

fix_reg for BitFS fix_reg for COTMC (invalid regions both HMC and DDD)

So only 2 calls to fix_reg

N00byKing · 2023-12-08T09:36:29Z

worlds/sm64ex/Regions.py

+    locVCutM_table, locBitFS_table, locWMotR_table, locBitS_table, locSS_table
+
+
+class Entrances(int, Enum):


Not a fan of the name of this enum.
First, Entrances could also mean Entrances between regions.
Then, Entrances could also mean the string representations of the entrances (Tiny-Huge Island (Tiny)).
As a suggestion: The game code refers to the regions as levels (So LEVEL_THI for example). Something like SM64Levels?

Magnemania · 2023-12-10T19:44:56Z

Addressed the issues in Round 2. Also fixed an issue with the 1Up generation.

N00byKing

One last thing, otherwise LGTM!

N00byKing · 2023-12-11T09:21:06Z

worlds/sm64ex/__init__.py

+            if action == 'Double Jump': continue
+            if getattr(self.multiworld, f"MoveRandomizer{action.replace(' ','')}")[self.player].value:
+                max_stars -= 1
+                self.multiworld.itempool.append(self.create_item(action))


Can you move this to create_items? Its technically allowed here, but it would be more consistent with the other items.

Missed this comment. Moved item creation to create_items using the same conventions as checking for items in rules.

N00byKing · 2023-12-13T12:48:33Z

I am proud to present: ✅

Backported from ArchipelagoMW#2569

Backported from #2569

N00byKing · 2024-01-03T21:27:47Z

AP 0.4.4 is out so we should be out of feature freeze. @Magnemania please rebase, then this is hopefully good to go

Magnemania · 2024-01-03T22:15:46Z

AP 0.4.4 is out so we should be out of feature freeze. @Magnemania please rebase, then this is hopefully good to go

I, uh, hit the Rebase button in Pycharm, and I don't think it rebased correctly.

N00byKing · 2024-01-03T22:23:11Z

RIP Git History... Well, this was going to be squash merged anyway, so we'll do that manually.

Copy the sm64 world as you have it
Reset the branch on your end to the AP main branch
Copy it back, commit

So in the end there's only one commit with all changes. As I've already reviewed everything it should be fine.

Magnemania · 2024-01-03T23:07:37Z

RIP Git History... Well, this was going to be squash merged anyway, so we'll do that manually.

Copy the sm64 world as you have it

Reset the branch on your end to the AP main branch

Copy it back, commit

So in the end there's only one commit with all changes. As I've already reviewed everything it should be fine.

Going to be completely honest with you here, I've been Googling for the past hour and have absolutely no idea how to do that. I've been using PyCharm exclusively to interface with Git, and it doesn't look like it provides a way for me to reset a remote branch; I didn't think it was even possible to reset a branch. How do I do that?

N00byKing · 2024-01-03T23:09:59Z

I dont use GUI with git, and have never used pycharm... If you can use a terminal with git, git reset --hard origin/main will reset current branch

N00byKing · 2024-01-03T23:40:48Z

worlds/sm64ex/Rules.py

@@ -40,30 +63,35 @@ def set_rules(world, player: int, area_connections: dict):
            fix_reg(randomized_entrances, SM64Levels.CAVERN_OF_THE_METAL_CAP, {"Hazy Maze Cave"}, swapdict, world)

    # Destination Format: LVL | AREA with LVL = LEVEL_x, AREA = Area as used in sm64 code
-    # Cast to int to not rely on availability of SM64Levels enum. Will cause crash in MultiServer otherwise


You need to restore this comment

Hold on, I think I've figured out why the initial rebase didn't work. Didn't realize I had to force push. Think I might be able to restore somehow...

Nevermind, it looks like I could have undid the force push from the command line, but I did it from PyCharm. Comment is back. How do I give you and https://github.com/RBmans credit, again? He assisted with some logic changes in Rules.py.

Co-authored-by: name <[email protected]> in the commit message for RBman. You can get the mail from his original commit.

I only did minor things so no need

Nvm, he has the anonymized git email on. Ask him if he wants to be credited with or without real email, for both cases you need the address from him

Co-authored-by: RBman <[email protected]> Signed-off-by: Magnemania <[email protected]>

N00byKing

Green Tick number two

Signed-off-by: Magnemania <[email protected]>

…#2637) Backported from ArchipelagoMW#2569

* Super Mario 64: Move Randomizer Update Co-authored-by: RBman <[email protected]> Signed-off-by: Magnemania <[email protected]> * Fixed logic for Vanish Cap Under the Moat Signed-off-by: Magnemania <[email protected]>

ScipioWright added the is: enhancement Issues requesting new features or pull requests implementing new features. label Dec 6, 2023

N00byKing suggested changes Dec 7, 2023

View reviewed changes

N00byKing suggested changes Dec 8, 2023

View reviewed changes

N00byKing mentioned this pull request Dec 9, 2023

sm64ex: Fix generations #2583

Merged

N00byKing reviewed Dec 11, 2023

View reviewed changes

N00byKing approved these changes Dec 13, 2023

View reviewed changes

N00byKing mentioned this pull request Dec 13, 2023

sm64ex: Fix server #2599

Merged

N00byKing added a commit to N00byKing/Archipelago that referenced this pull request Dec 27, 2023

sm64ex: Fix randomizing Courses and Secrets separately

8829ef8

Backported from ArchipelagoMW#2569

N00byKing mentioned this pull request Dec 27, 2023

sm64ex: Fix randomizing Courses and Secrets separately #2637

Merged

Berserker66 pushed a commit that referenced this pull request Dec 28, 2023

sm64ex: Fix randomizing Courses and Secrets separately (#2637)

7c70b87

Backported from #2569

Magnemania closed this Jan 3, 2024

Magnemania force-pushed the sm64_move_randomizer branch from b31694f to 0df0955 Compare January 3, 2024 23:29

Magnemania reopened this Jan 3, 2024

N00byKing reviewed Jan 3, 2024

View reviewed changes

Magnemania force-pushed the sm64_move_randomizer branch from 9b0b2e9 to c3052dd Compare January 4, 2024 00:06

Super Mario 64: Move Randomizer Update

336a337

Co-authored-by: RBman <[email protected]> Signed-off-by: Magnemania <[email protected]>

Magnemania force-pushed the sm64_move_randomizer branch from c3052dd to 336a337 Compare January 4, 2024 00:27

N00byKing approved these changes Jan 4, 2024

View reviewed changes

Fixed logic for Vanish Cap Under the Moat

b483590

Signed-off-by: Magnemania <[email protected]>

PoryGone added the waiting-on: core-review Issue/PR has been peer-reviewed and is ready to be merged or needs input from a core maintainer. label Feb 10, 2024

Merge branch 'main' into sm64_move_randomizer

c84b9c3

Berserker66 approved these changes Feb 13, 2024

View reviewed changes

Berserker66 merged commit 0c8f726 into ArchipelagoMW:main Feb 13, 2024
12 checks passed

Jouramie pushed a commit to Jouramie/Archipelago that referenced this pull request Feb 28, 2024

sm64ex: Fix randomizing Courses and Secrets separately (ArchipelagoMW…

18c5a38

…#2637) Backported from ArchipelagoMW#2569

Magnemania deleted the sm64_move_randomizer branch April 7, 2024 12:16


		# List of all courses, including secrets, without BitS as that one is static

		locVCutM_table, locBitFS_table, locWMotR_table, locBitS_table, locSS_table


		class Entrances(int, Enum):

SM64: Move Randomizer Content Update #2569

SM64: Move Randomizer Content Update #2569

Conversation

Magnemania commented Dec 6, 2023

What is this fixing or adding?

How was this tested?

If this makes graphical changes, please attach screenshots.

N00byKing left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Magnemania Dec 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Magnemania Dec 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NewSoupVi Dec 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Magnemania Dec 7, 2023 • edited Loading

Choose a reason for hiding this comment

N00byKing left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

N00byKing Dec 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Magnemania commented Dec 10, 2023

N00byKing left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

N00byKing commented Dec 13, 2023

N00byKing commented Jan 3, 2024

Magnemania commented Jan 3, 2024

N00byKing commented Jan 3, 2024

Magnemania commented Jan 3, 2024

N00byKing commented Jan 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Magnemania Jan 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

N00byKing left a comment

Choose a reason for hiding this comment

Magnemania Dec 7, 2023 •

edited

Loading

Magnemania Dec 7, 2023 •

edited

Loading

NewSoupVi Dec 7, 2023 •

edited

Loading

Magnemania Dec 7, 2023 •

edited

Loading

N00byKing Dec 8, 2023 •

edited

Loading

N00byKing commented Jan 3, 2024 •

edited

Loading

Magnemania Jan 3, 2024 •

edited

Loading