TUNIC: ER Refactor for better plando connections, fewer shops improvement

worlds/tunic/er_data.py

@@ -432,6 +432,9 @@ def destination_scene(self) -> str:  # the vanilla connection
            destination="ziggurat2020_2", tag="_"),
     Portal(name="Ziggurat Portal Room Entrance", region="Rooted Ziggurat Portal Room Entrance",
            destination="ziggurat2020_FTRoom", tag="_"),
+    # only if fixed shop is on, removed otherwise
+    Portal(name="Ziggurat Lower Falling Entrance", region="Zig Skip Exit",
+           destination="ziggurat2020_1", tag="_zig2_skip"),
 
     Portal(name="Ziggurat Portal Room Exit", region="Rooted Ziggurat Portal Room Exit",
            destination="ziggurat2020_3", tag="_"),
@@ -687,6 +690,7 @@ class DeadEnd(IntEnum):
     "Rooted Ziggurat Middle Bottom": RegionInfo("ziggurat2020_2"),
     "Rooted Ziggurat Lower Front": RegionInfo("ziggurat2020_3"),  # the vanilla entry point side
     "Rooted Ziggurat Lower Back": RegionInfo("ziggurat2020_3"),  # the boss side
+    "Zig Skip Exit": RegionInfo("ziggurat2020_3"),  # the exit from zig skip, for use with fixed shop on
     "Rooted Ziggurat Portal Room Entrance": RegionInfo("ziggurat2020_3"),  # the door itself on the zig 3 side
     "Rooted Ziggurat Portal": RegionInfo("ziggurat2020_FTRoom"),
     "Rooted Ziggurat Portal Room Exit": RegionInfo("ziggurat2020_FTRoom"),

worlds/tunic/er_rules.py

@@ -870,6 +870,9 @@ def set_er_region_rules(world: "TunicWorld", ability_unlocks: Dict[str, int], re
     regions["Rooted Ziggurat Portal Room Entrance"].connect(
         connecting_region=regions["Rooted Ziggurat Lower Back"])
 
+    regions["Zig Skip Exit"].connect(
+        connecting_region=regions["Rooted Ziggurat Lower Front"])
+
     regions["Rooted Ziggurat Portal"].connect(
         connecting_region=regions["Rooted Ziggurat Portal Room Exit"],
         rule=lambda state: state.has("Activate Ziggurat Fuse", player))

worlds/tunic/er_scripts.py

@@ -1,4 +1,4 @@
-from typing import Dict, List, Set, TYPE_CHECKING
+from typing import Dict, List, Set, TYPE_CHECKING, Tuple
 from BaseClasses import Region, ItemClassification, Item, Location
 from .locations import location_table
 from .er_data import Portal, tunic_er_regions, portal_mapping, \
@@ -88,7 +88,8 @@ def place_event_items(world: "TunicWorld", regions: Dict[str, Region]) -> None:
 
 def vanilla_portals() -> Dict[Portal, Portal]:
     portal_pairs: Dict[Portal, Portal] = {}
-    portal_map = portal_mapping.copy()
+    # we don't want the zig skip exit for vanilla portals, since it shouldn't be considered for logic here
+    portal_map = [portal for portal in portal_mapping if portal.name != "Ziggurat Lower Falling Entrance"]
 
     while portal_map:
         portal1 = portal_map[0]
@@ -124,29 +125,36 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
     two_plus: List[Portal] = []
     logic_rules = world.options.logic_rules.value
     player_name = world.multiworld.get_player_name(world.player)
+    portal_map = portal_mapping.copy()
 
     shop_scenes: Set[str] = set()
     shop_count = 6
-    if world.options.fixed_shop.value:
-        shop_count = 1
+    if world.options.fixed_shop:
+        shop_count = 0
         shop_scenes.add("Overworld Redux")
+    else:
+        # if fixed shop is off, remove this portal
+        for portal in portal_map:
+            if portal.name == "Ziggurat Lower Falling Entrance":
+                portal_map.remove(portal)
+                break
 
     if not logic_rules:
-        dependent_regions = dependent_regions_restricted
+        dependent_regions = dependent_regions_restricted.copy()
     elif logic_rules == 1:
-        dependent_regions = dependent_regions_nmg
+        dependent_regions = dependent_regions_nmg.copy()
     else:
-        dependent_regions = dependent_regions_ur
+        dependent_regions = dependent_regions_ur.copy()
 
     # create separate lists for dead ends and non-dead ends
     if logic_rules:
-        for portal in portal_mapping:
+        for portal in portal_map:
             if tunic_er_regions[portal.region].dead_end == 1:
                 dead_ends.append(portal)
             else:
                 two_plus.append(portal)
     else:
-        for portal in portal_mapping:
+        for portal in portal_map:
             if tunic_er_regions[portal.region].dead_end:
                 dead_ends.append(portal)
             else:
@@ -155,7 +163,7 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
     connected_regions: Set[str] = set()
     # make better start region stuff when/if implementing random start
     start_region = "Overworld"
-    connected_regions.update(add_dependent_regions(start_region, logic_rules))
+    connected_regions.update(add_dependent_regions(start_region, dependent_regions))
 
     plando_connections = world.multiworld.plando_connections[world.player]
 
@@ -182,6 +190,8 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
 
     non_dead_end_regions = set()
     for region_name, region_info in tunic_er_regions.items():
+        if region_name == "Zig Skip Exit" and not world.options.fixed_shop:
+            continue
         if not region_info.dead_end:
             non_dead_end_regions.add(region_name)
         elif region_info.dead_end == 2 and logic_rules:
@@ -244,7 +254,7 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
 
             portal_pairs[portal1] = portal2
 
-            # update dependent regions based on the plando'd connections, to ensure the portals connect well, logically
+            # update dependent regions based on the plando'd connections, to ensure the portals connect logically
             for origins, destinations in dependent_regions.items():
                 if portal1.region in origins:
                     if portal2.region in non_dead_end_regions:
@@ -257,7 +267,7 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
         while True:
             test1 = len(connected_regions)
             for region in connected_regions.copy():
-                connected_regions.update(add_dependent_regions(region, logic_rules))
+                connected_regions.update(add_dependent_regions(region, dependent_regions))
             test2 = len(connected_regions)
             if test1 == test2:
                 break
@@ -300,6 +310,10 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
         portal_pairs[portal1] = portal2
         two_plus.remove(portal1)
 
+        # add zig skip exit to the dependent regions
+        dependent_regions[("Zig Skip Exit",)] = ["Zig Skip Exit", "Rooted Ziggurat Lower Front",
+                                                 "Rooted Ziggurat Lower Back", "Rooted Ziggurat Portal Room Entrance"]
+
     random_object: Random = world.random
     if world.options.entrance_rando.value != 1:
         random_object = Random(world.options.entrance_rando.value)
@@ -311,10 +325,11 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
     previous_conn_num = 0
     fail_count = 0
     while len(connected_regions) < len(non_dead_end_regions):
-        # if the connected regions length stays unchanged for too long, it's stuck in a loop
-        # should, hopefully, only ever occur if someone plandos connections poorly
+        # if this is universal tracker, just break immediately and move on
         if hasattr(world.multiworld, "re_gen_passthrough"):
             break
+        # if the connected regions length stays unchanged for too long, it's stuck in a loop
+        # should, hopefully, only ever occur if someone plandos connections poorly
         if previous_conn_num == len(connected_regions):
             fail_count += 1
             if fail_count >= 500:
@@ -351,7 +366,7 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
 
         # once we have both portals, connect them and add the new region(s) to connected_regions
         if check_success == 2:
-            connected_regions.update(add_dependent_regions(portal2.region, logic_rules))
+            connected_regions.update(add_dependent_regions(portal2.region, dependent_regions))
             portal_pairs[portal1] = portal2
             check_success = 0
             random_object.shuffle(two_plus)
@@ -411,16 +426,9 @@ def create_randomized_entrances(portal_pairs: Dict[Portal, Portal], regions: Dic
 
 
 # loop through the static connections, return regions you can reach from this region
-# todo: refactor to take region_name and dependent_regions
-def add_dependent_regions(region_name: str, logic_rules: int) -> Set[str]:
+def add_dependent_regions(region_name: str, dependent_regions: Dict[Tuple[str, ...], List[str]]) -> Set[str]:
     region_set = set()
-    if not logic_rules:
-        regions_to_add = dependent_regions_restricted
-    elif logic_rules == 1:
-        regions_to_add = dependent_regions_nmg
-    else:
-        regions_to_add = dependent_regions_ur
-    for origin_regions, destination_regions in regions_to_add.items():
+    for origin_regions, destination_regions in dependent_regions.items():
         if region_name in origin_regions:
             # if you matched something in the first set, you get the regions in its paired set
             region_set.update(destination_regions)

worlds/tunic/options.py

@@ -116,7 +116,8 @@ class EntranceRando(TextChoice):
 
 
 class FixedShop(Toggle):
-    """Forces the Windmill entrance to lead to a shop, and places only one other shop in the pool.
+    """Forces the Windmill entrance to lead to a shop, and excludes all other shops from the entrance pool.
+    Adds another entrance in Rooted Ziggurat Lower to keep an even number of entrances.
     Has no effect if Entrance Rando is not enabled."""
     internal_name = "fixed_shop"
     display_name = "Fewer Shops in Entrance Rando"