Merge 'Patch mixed pools grotto and dungeon ER blue warps' into Dev-R

EntranceShuffle.py

@@ -83,21 +83,21 @@ def build_one_way_targets(world, types_to_include, exclude=(), target_region_nam
 
 entrance_shuffle_table = [
     ('Dungeon',         ('KF Outside Deku Tree -> Deku Tree Lobby',                         { 'index': 0x0000 }),
-                        ('Deku Tree Lobby -> KF Outside Deku Tree',                         { 'index': 0x0209, 'blue_warp': 0x0457 })),
+                        ('Deku Tree Lobby -> KF Outside Deku Tree',                         { 'index': 0x0209, 'blue_warp': 0x0457, 'blue_warp_addresses': [0xAC93A2, 0xCA3142] })),
     ('Dungeon',         ('Death Mountain -> Dodongos Cavern Beginning',                     { 'index': 0x0004 }),
-                        ('Dodongos Cavern Beginning -> Death Mountain',                     { 'index': 0x0242, 'blue_warp': 0x047A })),
+                        ('Dodongos Cavern Beginning -> Death Mountain',                     { 'index': 0x0242, 'blue_warp': 0x047A, 'blue_warp_addresses': [0xAC9336, 0xCA30CA] })),
     ('Dungeon',         ('Zoras Fountain -> Jabu Jabus Belly Beginning',                    { 'index': 0x0028 }),
-                        ('Jabu Jabus Belly Beginning -> Zoras Fountain',                    { 'index': 0x0221, 'blue_warp': 0x010E })),
+                        ('Jabu Jabus Belly Beginning -> Zoras Fountain',                    { 'index': 0x0221, 'blue_warp': 0x010E, 'blue_warp_addresses': [0xAC936A, 0xCA31B2] })),
     ('Dungeon',         ('SFM Forest Temple Entrance Ledge -> Forest Temple Lobby',         { 'index': 0x0169 }),
-                        ('Forest Temple Lobby -> SFM Forest Temple Entrance Ledge',         { 'index': 0x0215, 'blue_warp': 0x0608 })),
+                        ('Forest Temple Lobby -> SFM Forest Temple Entrance Ledge',         { 'index': 0x0215, 'blue_warp': 0x0608, 'blue_warp_addresses': [0xAC9F96, 0xCA3D66, 0xCA3D5A] })),
     ('Dungeon',         ('DMC Fire Temple Entrance -> Fire Temple Lower',                   { 'index': 0x0165 }),
-                        ('Fire Temple Lower -> DMC Fire Temple Entrance',                   { 'index': 0x024A, 'blue_warp': 0x0564 })),
+                        ('Fire Temple Lower -> DMC Fire Temple Entrance',                   { 'index': 0x024A, 'blue_warp': 0x0564, 'blue_warp_addresses': [0xACA516, 0xCA3DF2, 0xCA3DE6] })),
     ('Dungeon',         ('Lake Hylia -> Water Temple Lobby',                                { 'index': 0x0010 }),
-                        ('Water Temple Lobby -> Lake Hylia',                                { 'index': 0x021D, 'blue_warp': 0x060C })),
+                        ('Water Temple Lobby -> Lake Hylia',                                { 'index': 0x021D, 'blue_warp': 0x060C, 'blue_warp_addresses': [0xAC995A, 0xCA3E82, 0xCA3E76] })),
     ('Dungeon',         ('Desert Colossus -> Spirit Temple Lobby',                          { 'index': 0x0082 }),
-                        ('Spirit Temple Lobby -> Desert Colossus From Spirit Lobby',        { 'index': 0x01E1, 'blue_warp': 0x0610 })),
+                        ('Spirit Temple Lobby -> Desert Colossus From Spirit Lobby',        { 'index': 0x01E1, 'blue_warp': 0x0610, 'blue_warp_addresses': [0xACA402, 0xCA3F12, 0xCA3F06] })),
     ('Dungeon',         ('Graveyard Warp Pad Region -> Shadow Temple Entryway',             { 'index': 0x0037 }),
-                        ('Shadow Temple Entryway -> Graveyard Warp Pad Region',             { 'index': 0x0205, 'blue_warp': 0x0580 })),
+                        ('Shadow Temple Entryway -> Graveyard Warp Pad Region',             { 'index': 0x0205, 'blue_warp': 0x0580, 'blue_warp_addresses': [0xACA496, 0xCA3FA2, 0xCA3F96] })),
     ('Dungeon',         ('Kakariko Village -> Bottom of the Well',                          { 'index': 0x0098 }),
                         ('Bottom of the Well -> Kakariko Village',                          { 'index': 0x02A6 })),
     ('Dungeon',         ('ZF Ice Ledge -> Ice Cavern Beginning',                            { 'index': 0x0088 }),
@@ -352,7 +352,8 @@ def _add_boss_entrances():
         dungeon_data[name] = {
             'dungeon_index': forward['index'],
             'exit_index': reverse['index'],
-            'exit_blue_warp': reverse['blue_warp']
+            'exit_blue_warp': reverse['blue_warp'],
+            'exit_blue_warp_addresses': reverse['blue_warp_addresses']
         }
 
     for type, source, target, boss, dungeon, index, rindex, addresses in [

Notes/grotto_mixed_er_notes.txt

@@ -0,0 +1,52 @@
+z_demo.c vram 80052310 / vrom AC8270
+CS_TERMINATOR / command 3E8 processed at func_80052F34, end at 80054C4C / offset C24 to 293C / vrom AC8E94 to ACABAC
+
+Blue warp cutscene exit IDs
+Dungeon: hex cutscene base / int cutscene base / vanilla exit const / vanilla exit hex
+
+Deku:   0x000E / 14 / ENTR_SPOT04_11 / 0x0457 / vram 80053440 / offset 0x1130 / vrom AC93A0 / index vrom AC93A2
+DC:     0x000C / 12 / ENTR_SPOT16_5  / 0x047A / vram 800533D4 / offset 0x10C4 / vrom AC9334 / index vrom AC9336
+Jabu:   0x000D / 13 / ENTR_SPOT08_0  / 0x010E / vram 80053408 / offset 0x10F8 / vrom AC9368 / index vrom AC936A
+Forest: 0x0045 / 69 / ENTR_SPOT04_12 / 0x05E8 / vram 80054034 / offset 0x1D24 / vrom AC9F94 / index vrom AC9F96
+        NOTE: Kokiri Forest near Sprout, not Minuet warp pad
+        NOTE: Rando overrides this to ENTR_SPOT05_3 0x0608 (Minuet warp pad/blue warp revisit) if boss shuffle, dungeon ER, or overworld ER on
+Fire:   0x0062 / 98 / ENTR_SPOT17_5  / 0x0564 / vram 800545B4 / offset 0x22A4 / vrom ACA514 / index vrom ACA516
+Water:  0x0029 / 41 / ENTR_SPOT06_5  / 0x04E6 / vram 800539F8 / offset 0x16E8 / vrom AC9958 / index vrom AC995A
+        NOTE: Rando overrides this to ENTR_SPOT06_9 0x060C (blue warp revisit) if boss shuffle or dungeon ER on
+Shadow: 0x0061 / 97 / ENTR_SPOT02_8  / 0x0580 / vram 80054534 / offset 0x2224 / vrom ACA494 / index vrom ACA496
+        NOTE: If both spirit/shadow medallions are obtained, redirect to chamber cutscene kenjyanoma_sceneCutsceneData0x0012A0,
+              which redirects to 0x0074 / 116 cutscene command. This checks EVENTCHKINF_C8 to determine if last dungeon
+              completed prior to all meds obtained was either spirit or shadow. Rando overrides this cutscene to never run,
+              so we don't need to edit exits for case 116.
+Spirit: 0x0060 / 96 / ENTR_SPOT11_8  / 0x0610 / vram 800544A0 / offset 0x2190 / vrom ACA400 / index vrom ACA402
+
+
+z_door_warp1.c vram 80904520 / vrom CA1CE0
+ChildWarpOut = func_80905820
+AdultWarpOut = func_809063B0
+RutoWarpOut not relevant, only used for cutscene for first blue warp entry, handled above in cutscene edits. Revisits handled in ChildWarpOut
+
+Blue warp revisit exit IDs (child)
+Dungeon: child exit const / child exit hex / adult exit const / adult exit hex
+NOTE: Child dungeons use the same entrance index for child and adult
+
+Deku:   ENTR_SPOT04_11 / 0x0457 / vram 80905980 / offset 0x1460 / vrom CA3140 / index vrom CA3142
+DC:     ENTR_SPOT16_5  / 0x047A / vram 80905908 / offset 0x13E8 / vrom CA30C8 / index vrom CA30CA
+Jabu:   ENTR_SPOT08_0  / 0x010E / vram 809059F0 / offset 0x14D0 / vrom CA31B0 / index vrom CA31B2
+Forest: ENTR_SPOT05_2  / 0x0600 / vram 809065A4 / offset 0x2084 / vrom CA3D64 / index vrom CA3D66
+Fire:   ENTR_SPOT17_4  / 0x04F6 / vram 80906630 / offset 0x2110 / vrom CA3DF0 / index vrom CA3DF2
+Water:  ENTR_SPOT06_8  / 0x0604 / vram 809066C0 / offset 0x21A0 / vrom CA3E80 / index vrom CA3E82
+Shadow: ENTR_SPOT02_7  / 0x0568 / vram 809067E0 / offset 0x22C0 / vrom CA3FA0 / index vrom CA3FA2
+Spirit: ENTR_SPOT11_5  / 0x01F1 / vram 80906750 / offset 0x2230 / vrom CA3F10 / index vrom CA3F12
+
+Blue warp revisit exit IDs (adult)
+Dungeon: child exit const / child exit hex / adult exit const / adult exit hex
+
+Deku:   N/A           / N/A    / 
+DC:     N/A           / N/A    / 
+Jabu:   N/A           / N/A    / 
+Forest: ENTR_SPOT05_3 / 0x0608 / vram 80906598 / offset 0x2078 / vrom CA3D58 / index vrom CA3D5A
+Fire:   ENTR_SPOT17_5 / 0x0564 / vram 80906624 / offset 0x2104 / vrom CA3DE4 / index vrom CA3DE6
+Water:  ENTR_SPOT06_9 / 0x060C / vram 809066B4 / offset 0x2194 / vrom CA3E74 / index vrom CA3E76
+Shadow: ENTR_SPOT02_8 / 0x0580 / vram 809067D4 / offset 0x22B4 / vrom CA3F94 / index vrom CA3F96
+Spirit: ENTR_SPOT11_8 / 0x0610 / vram 80906744 / offset 0x2224 / vrom CA3F04 / index vrom CA3F06

Patches.py

@@ -901,6 +901,7 @@ def add_scene_exits(scene_start, offset = 0):
 
     def set_entrance_updates(entrances):
         blue_warp_remaps = {}
+        blue_warp_address_remaps = {}
         if (world.settings.shuffle_bosses != 'off'):
             # Connect lake hylia fill exit to revisit exit
             rom.write_int16(0xAC995A, 0x060C)
@@ -930,6 +931,7 @@ def set_entrance_updates(entrances):
                 # If dungeons are shuffled but their bosses are moved, they're going to refer to the wrong blue warp
                 # slots.  Create a table to remap them for later.
                 blue_warp_remaps[original_boss['exit_blue_warp']] = new_boss['exit_blue_warp']
+                blue_warp_address_remaps[original_boss['exit_blue_warp']] = original_boss['exit_blue_warp_addresses']
 
         # Boss shuffle done(?)
         for entrance in entrances:
@@ -949,6 +951,7 @@ def set_entrance_updates(entrances):
             if "blue_warp" in new_entrance:
                 blue_warp = new_entrance["blue_warp"]
                 blue_warp = blue_warp_remaps.get(blue_warp, blue_warp)
+                blue_warp_addresses = blue_warp_address_remaps.get(blue_warp, new_entrance['blue_warp_addresses'])
                 if "blue_warp" in replaced_entrance:
                     blue_out_data = replaced_entrance["blue_warp"]
                 else:
@@ -961,8 +964,21 @@ def set_entrance_updates(entrances):
                 # vanilla as it never took you to the exit and the lake fill is handled
                 # above by removing the cutscene completely. Child has problems with Adult
                 # blue warps, so always use the return entrance if a child.
-                copy_entrance_record(blue_out_data + 2, blue_warp + 2, 2)
-                copy_entrance_record(replaced_entrance["index"], blue_warp, 2)
+                #
+                # This method does not work with mixed entrance pools between dungeons
+                # and grottos as grotto entrances are not in the entrance table.
+                # Grotto entrance indices always have the format 0x1000 + grotto ID or
+                # 0x2000 + grotto ID, which is greater than any entrance table index.
+                # If the dungeon is in a grotto, edit the blue warp hardcodes to the grotto
+                # entrance index, otherwise use the "normal" entrance table method.
+                # This runs after and overrides the cutscene edits for Forest Temple
+                # and Water Temple if needed.
+                if blue_out_data >= 0x1000:
+                    for address in blue_warp_addresses:
+                        rom.write_int16(address, blue_out_data)
+                else:
+                    copy_entrance_record(blue_out_data + 2, blue_warp + 2, 2)
+                    copy_entrance_record(replaced_entrance["index"], blue_warp, 2)
 
     exit_table = generate_exit_lookup_table()
 

version.py

@@ -1 +1 @@
-__version__ = '6.2.133 R-1'
+__version__ = '6.2.133 R-2'