Require Gohma setting and ER compatibility

Author: fenhl

EntranceShuffle.py

@@ -332,6 +332,7 @@ def rainbow_bridge_hint_kind(world: World) -> str:
     'Magic Meter':                                              (["mystic training", "pixie dust", "a green rectangle"], "a Magic Meter", 'item'),
     'Double Defense':                                           (["a white outline", "damage decrease", "strengthened love"], "Double Defense", 'item'),
     'Slingshot':                                                (["a seed shooter", "a rubberband", "a child's catapult"], "a Slingshot", 'item'),
+    'Deku Seed Bag':                                            (["a seed shooter", "a rubberband", "a child's catapult"], "a Slingshot", 'item'),
     'Boomerang':                                                (["a banana", "a stun stick"], "the Boomerang", 'item'),
     'Bow':                                                      (["an archery enabler", "a danger dart launcher"], "a Bow", 'item'),
     'Bomb Bag':                                                 (["an explosive container", "a blast bag"], "a Bomb Bag", 'item'),

HintList.py

@@ -422,6 +422,7 @@ class GetItemId(IntEnum):
     'Bomb Bag':                                        ('Item',     True,  GetItemId.GI_PROGRESSIVE_BOMB_BAG, None),
     'Bow':                                             ('Item',     True,  GetItemId.GI_PROGRESSIVE_BOW, None),
     'Slingshot':                                       ('Item',     True,  GetItemId.GI_PROGRESSIVE_SLINGSHOT, None),
+    'Deku Seed Bag':                                   ('Item',     True,  GetItemId.GI_PROGRESSIVE_SLINGSHOT, {'alias': ('Slingshot', 1)}),
     'Progressive Wallet':                              ('Item',     True,  GetItemId.GI_PROGRESSIVE_WALLET, {'progressive': 3}),
     'Progressive Scale':                               ('Item',     True,  GetItemId.GI_PROGRESSIVE_SCALE, {'progressive': 2}),
     'Deku Nut Capacity':                               ('Item',     None,  GetItemId.GI_PROGRESSIVE_NUT_CAPACITY, None),
@@ -549,6 +550,7 @@ class GetItemId(IntEnum):
 
     # Event items otherwise generated by generic event logic
     # can be defined here to enforce their appearance in playthroughs.
+    'Deku Tree Clear':                  ('Event',    True,  None, None),
     'Water Temple Clear':               ('Event',    True,  None, None),
     'Forest Trial Clear':               ('Event',    True,  None, None),
     'Fire Trial Clear':                 ('Event',    True,  None, None),

ItemList.py

@@ -16,6 +16,21 @@
     from World import World
 
 
+closed_forest_restricted_items: tuple[str, ...] = (
+    'Bomb Bag',
+    'Bombchus (5)',
+    'Bombchus (10)',
+    'Bombchus (20)',
+    'Bombchus',
+    'Dins Fire',
+    'Progressive Scale',
+    'Bolero of Fire',
+    'Serenade of Water',
+    'Nocturne of Shadow',
+    'Requiem of Spirit',
+    'Prelude of Light',
+)
+
 plentiful_items: list[str] = [
     'Biggoron Sword',
     'Boomerang',
@@ -37,7 +52,7 @@
     'Deku Stick Capacity',
     'Deku Nut Capacity',
     'Bow',
-    'Slingshot',
+    'Deku Seed Bag',
     'Bomb Bag',
     'Double Defense',
 ]
@@ -67,7 +82,7 @@
     'Progressive Wallet',
     'Magic Meter',
     'Bow',
-    'Slingshot',
+    'Deku Seed Bag',
     'Bomb Bag',
     'Bombchus (10)',
     'Lens of Truth',
@@ -228,7 +243,7 @@
         'Deku Stick Capacity': 1,
         'Deku Nut Capacity': 1,
         'Bow': 2,
-        'Slingshot': 2,
+        'Deku Seed Bag': 1,
         'Bomb Bag': 2,
         'Heart Container': 0,
     },
@@ -242,7 +257,7 @@
         'Deku Stick Capacity': 0,
         'Deku Nut Capacity': 0,
         'Bow': 1,
-        'Slingshot': 1,
+        'Deku Seed Bag': 0,
         'Bomb Bag': 1,
         'Heart Container': 0,
         'Piece of Heart': 0,

ItemPool.py

@@ -164,7 +164,7 @@ def shop_address(shop_id: int, shelf_id: int) -> int:
     # Lost Woods
     ("LW Gift from Saria",                                           ("Cutscene",     0xFF,  0x02, None,                            'Ocarina',                               ("Lost Woods", "Forest Area", "NPCs",))),
     ("LW Ocarina Memory Game",                                       ("NPC",          0x5B,  0x76, None,                            'Piece of Heart',                        ("Lost Woods", "Forest Area", "Minigames",))),
-    ("LW Target in Woods",                                           ("NPC",          0x5B,  0x60, None,                            'Slingshot',                             ("Lost Woods", "Forest Area", "NPCs",))),
+    ("LW Target in Woods",                                           ("NPC",          0x5B,  0x60, None,                            'Deku Seed Bag',                         ("Lost Woods", "Forest Area", "NPCs",))),
     ("LW Near Shortcuts Grotto Chest",                               ("Chest",        0x3E,  0x14, None,                            'Rupees (5)',                            ("Lost Woods", "Forest Area", "Grottos", "Chests",))),
     ("LW Trade Cojiro",                                              ("NPC",          0x5B,  0x1F, None,                            'Odd Mushroom',                          ("Lost Woods", "Forest",))),
     ("LW Trade Odd Potion",                                          ("NPC",          0x5B,  0x21, None,                            'Poachers Saw',                          ("Lost Woods", "Forest",))),
@@ -248,7 +248,7 @@ def shop_address(shop_id: int, shelf_id: int) -> int:
     ("HF Child Above Drawbridge Wonderitem 2",                       ("Wonderitem",   0x51, [(0,0,54),(0,1,52)], None,              'Rupees (20)',                           ("Hyrule Field", "Wonderitem"))),
     ("HF Child Above Drawbridge Wonderitem 3",                       ("Wonderitem",   0x51, [(0,0,55),(0,1,53)], None,              'Rupees (20)',                           ("Hyrule Field", "Wonderitem"))),
 
-    ("Market Shooting Gallery Reward",                               ("NPC",          0x42,  0x60, None,                            'Slingshot',                             ("Market", "Minigames",))),
+    ("Market Shooting Gallery Reward",                               ("NPC",          0x42,  0x60, None,                            'Deku Seed Bag',                         ("Market", "Minigames",))),
     ("Market Bombchu Bowling First Prize",                           ("NPC",          0x4B,  0x34, None,                            'Bomb Bag',                              ("Market", "Minigames",))),
     ("Market Bombchu Bowling Second Prize",                          ("NPC",          0x4B,  0x3E, None,                            'Piece of Heart',                        ("Market", "Minigames",))),
     ("Market Bombchu Bowling Bombchus",                              ("NPC",          0x4B,  0x03, None,                            'Bombchus (10)',                         None)),

LocationList.py

@@ -589,6 +589,8 @@ def make_bytes(txt: str, size: int) -> list[int]:
     rom.write_bytes(0xE5400E, [0xB4, 0xA4])
     if world.settings.open_forest != 'closed':
         rom.write_bytes(0xE5401C, [0x14, 0x0B])
+    # Move Link spawn 40 units forwards to prevent Pokey trap
+    rom.write_byte(0x206F0C7, 0xA3)
 
     # Remove the check on the number of days that passed for claim check.
     rom.write_bytes(0xED4470, [0x00, 0x00, 0x00, 0x00])

Patches.py

@@ -93,6 +93,7 @@ def alt_hint(self) -> Optional[HintArea]:
 
     def can_fill(self, item: Item, manual: bool = False) -> bool:
         from Hints import HintArea
+        from ItemPool import closed_forest_restricted_items
 
         if not manual and self.world.settings.empty_dungeons_mode != 'none' and item.dungeonitem:
             # An empty dungeon can only store its own dungeon items
@@ -103,6 +104,18 @@ def can_fill(self, item: Item, manual: bool = False) -> bool:
                 if item.world.precompleted_dungeons.get(dungeon.name, False) and dungeon.is_dungeon_item(item):
                     return False
 
+        if not manual and self.world.settings.require_gohma and item.name in (*closed_forest_restricted_items, 'Slingshot'):
+            hint_area = HintArea.at(self)
+            if hint_area.color == 'Green' and hint_area != HintArea.FOREST_TEMPLE and self.name != 'Queen Gohma Boss Room':
+                # Don't place items that can be used to escape the forest in Forest areas of worlds with Require Gohma
+                if item.name in closed_forest_restricted_items:
+                    return False
+            else:
+                # Place at least one slingshot for each player in the Forest area, to avoid requiring one player to leave the forest to get another player's slingshot.
+                # This is still not a 100% guarantee because the slingshot could be behind an item that's not in the forest, such as in a bombable grotto entrance in the Lost Woods.
+                if item.name == 'Slingshot' and 'Deku Tree' not in item.world.settings.dungeon_shortcuts and 'logic_deku_b1_skip' not in item.world.settings.allowed_tricks:
+                    return False
+
         is_self_dungeon_restricted = False
         is_self_region_restricted = None
         is_hint_color_restricted = None

Region.py

@@ -3,7 +3,7 @@
 from collections.abc import Callable, Collection, Iterable
 from typing import TYPE_CHECKING, Optional
 
-from ItemPool import song_list
+from ItemPool import closed_forest_restricted_items, song_list
 from Location import Location, DisableType
 from RulesCommon import AccessRule
 from Search import Search
@@ -79,6 +79,9 @@ def set_rules(world: World) -> None:
         if location.name in world.always_hints:
             location.add_rule(guarantee_hint)
 
+        if world.settings.require_gohma and location in world.distribution.skipped_locations:
+            add_item_rule(location, lambda location, item: item.name not in closed_forest_restricted_items)
+
     for location in world.settings.disabled_locations:
         try:
             world.get_location(location).disabled = DisableType.PENDING

Rules.py

@@ -1140,6 +1140,10 @@ def get_save_context_addresses() -> AddressesDict:
             'item_slot.slingshot'        : 'slingshot',
             'upgrades.bullet_bag'        : None,
         },
+        "Deku Seed Bag"    : {
+            'item_slot.slingshot'        : 'slingshot',
+            'upgrades.bullet_bag'        : None,
+        },
         "Deku Seeds" : {
             'ammo.slingshot'             : None,
         },

SaveContext.py

@@ -1216,31 +1216,27 @@ class SettingInfos:
             'closed':      'Closed Forest',
             },
         gui_tooltip    = '''\
-            'Open Forest': Mido no longer blocks the path to the
-            Deku Tree, and the Kokiri boy no longer blocks the path
-            out of the forest.
+            'Closed Forest': In the child era, Mido blocks the path
+            to the Deku Tree, requiring Kokiri Sword and Deku Shield
+            to access the Deku Tree, and another Kokiri boy blocks
+            the path out of the forest until Queen Gohma is defeated.
+            It may be logically required to "escape" the forest
+            (via one of the shortcuts in the Lost Woods, for example);
+            the setting "Closed Forest Requires Gohma" can be used to
+            prevent this.
 
             'Closed Deku': The Kokiri boy no longer blocks the path
             out of the forest, but Mido still blocks the path to the
             Deku Tree, requiring Kokiri Sword and Deku Shield to access
             the Deku Tree.
 
-            'Closed Forest': Beating Deku Tree is logically required
-            to leave the forest area (Kokiri Forest/Lost Woods/Sacred Forest
-            Meadow/Deku Tree), while the Kokiri Sword and a Deku Shield are
-            required to access the Deku Tree. Items needed for this will be
-            guaranteed inside the forest area. This setting is incompatible
-            with starting as adult, and so Starting Age will be locked to Child.
-            With any of "Shuffle Interior Entrances" set to "All", "Shuffle
-            Overworld Entrances" on, "Randomize Warp Song Destinations" on,
-            "Randomize Overworld Spawns" on, or "Shuffle Grottos" in Advanced
-            Logic, Closed Forest will instead be treated as Closed Deku with
-            starting age Child and WILL NOT guarantee that these items are
-            available in the forest area.
+            'Open Forest': Mido no longer blocks the path to the
+            Deku Tree, and the Kokiri boy no longer blocks the path
+            out of the forest.
         ''',
         shared         = True,
         disable        = {
-            'closed': {'settings': ['starting_age']}
+            'closed':  {'settings': ['starting_age']},
         },
         gui_params     = {
             'randomize_key': 'randomize_settings',
@@ -1252,6 +1248,37 @@ class SettingInfos:
         },
     )
 
+    require_gohma = Checkbutton(
+        gui_text       = 'Closed Forest Requires Gohma',
+        gui_tooltip    = '''\
+            Defeating Queen Gohma is required to leave the forest area
+            (Kokiri Forest/Lost Woods/Sacred Forest Meadow/Deku Tree).
+            Items needed for this will be guaranteed inside the forest area,
+            and items that could be used to escape the forest without
+            defeating Queen Gohma (such as explosives to enter Goron City)
+            will be prevented from appearing inside the forest area.
+
+            If entrances are shuffled, entrances inside and outside the
+            forest area will be shuffled separately. For example, "Shuffle
+            Dungeon Entrances" and "Shuffle Boss Entrances" don't affect the
+            Deku Tree. As an exception, grottos are not shuffled separately
+            (except in Advanced Logic), and neither are interiors if only
+            simple interiors are shuffled.
+
+            This setting is incompatible with starting as adult, and so
+            Starting Age will be locked to Child.
+        ''',
+        default        = True,
+        disabled_default = False,
+        shared         = True,
+        disable        = {
+            True : {'settings' : ['open_forest']},
+        },
+        gui_params     = {
+            'optional': True,
+        },
+    )
+
     open_kakariko = Combobox(
         gui_text       = 'Kakariko Gate',
         default        = 'closed',