Update docs/apworld_dev_faq.md

Co-authored-by: qwint <qwint.42@gmail.com>

.gitattributes

@@ -1 +0,0 @@
-worlds/blasphemous/region_data.py linguist-generated=true

.github/workflows/unittests.yml

@@ -37,13 +37,12 @@ jobs:
           - {version: '3.9'}
           - {version: '3.10'}
           - {version: '3.11'}
-          - {version: '3.12'}
         include:
           - python: {version: '3.8'}  # win7 compat
             os: windows-latest
-          - python: {version: '3.12'}  # current
+          - python: {version: '3.11'}  # current
             os: windows-latest
-          - python: {version: '3.12'}  # current
+          - python: {version: '3.11'}  # current
             os: macos-latest
 
     steps:
@@ -71,7 +70,7 @@ jobs:
         os:
           - ubuntu-latest
         python:
-          - {version: '3.12'}  # current
+          - {version: '3.11'}  # current
 
     steps:
     - uses: actions/checkout@v4

BaseClasses.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-import collections
+import copy
 import itertools
 import functools
 import logging
@@ -11,10 +11,8 @@ from argparse import Namespace
 from collections import Counter, deque
 from collections.abc import Collection, MutableSequence
 from enum import IntEnum, IntFlag
-from typing import (AbstractSet, Any, Callable, ClassVar, Dict, Iterable, Iterator, List, Mapping, NamedTuple,
-                    Optional, Protocol, Set, Tuple, Union, Type)
-
-from typing_extensions import NotRequired, TypedDict
+from typing import Any, Callable, Dict, Iterable, Iterator, List, Mapping, NamedTuple, Optional, Set, Tuple, \
+                   TypedDict, Union, Type, ClassVar
 
 import NetUtils
 import Options
@@ -24,16 +22,16 @@ if typing.TYPE_CHECKING:
     from worlds import AutoWorld
 
 
-class Group(TypedDict):
+class Group(TypedDict, total=False):
     name: str
     game: str
     world: "AutoWorld.World"
-    players: AbstractSet[int]
-    item_pool: NotRequired[Set[str]]
-    replacement_items: NotRequired[Dict[int, Optional[str]]]
-    local_items: NotRequired[Set[str]]
-    non_local_items: NotRequired[Set[str]]
-    link_replacement: NotRequired[bool]
+    players: Set[int]
+    item_pool: Set[str]
+    replacement_items: Dict[int, Optional[str]]
+    local_items: Set[str]
+    non_local_items: Set[str]
+    link_replacement: bool
 
 
 class ThreadBarrierProxy:
@@ -50,11 +48,6 @@ class ThreadBarrierProxy:
                                "Please use multiworld.per_slot_randoms[player] or randomize ahead of output.")
 
 
-class HasNameAndPlayer(Protocol):
-    name: str
-    player: int
-
-
 class MultiWorld():
     debug_types = False
     player_name: Dict[int, str]
@@ -70,6 +63,7 @@ class MultiWorld():
     state: CollectionState
 
     plando_options: PlandoOptions
+    accessibility: Dict[int, Options.Accessibility]
     early_items: Dict[int, Dict[str, int]]
     local_early_items: Dict[int, Dict[str, int]]
     local_items: Dict[int, Options.LocalItems]
@@ -163,7 +157,7 @@ class MultiWorld():
         self.start_inventory_from_pool: Dict[int, Options.StartInventoryPool] = {}
 
         for player in range(1, players + 1):
-            def set_player_attr(attr: str, val) -> None:
+            def set_player_attr(attr, val):
                 self.__dict__.setdefault(attr, {})[player] = val
             set_player_attr('plando_items', [])
             set_player_attr('plando_texts', {})
@@ -172,13 +166,13 @@ class MultiWorld():
             set_player_attr('completion_condition', lambda state: True)
         self.worlds = {}
         self.per_slot_randoms = Utils.DeprecateDict("Using per_slot_randoms is now deprecated. Please use the "
-                                                    "world's random object instead (usually self.random)")
+                                                      "world's random object instead (usually self.random)")
         self.plando_options = PlandoOptions.none
 
     def get_all_ids(self) -> Tuple[int, ...]:
         return self.player_ids + tuple(self.groups)
 
-    def add_group(self, name: str, game: str, players: AbstractSet[int] = frozenset()) -> Tuple[int, Group]:
+    def add_group(self, name: str, game: str, players: Set[int] = frozenset()) -> Tuple[int, Group]:
         """Create a group with name and return the assigned player ID and group.
         If a group of this name already exists, the set of players is extended instead of creating a new one."""
         from worlds import AutoWorld
@@ -202,7 +196,7 @@ class MultiWorld():
 
         return new_id, new_group
 
-    def get_player_groups(self, player: int) -> Set[int]:
+    def get_player_groups(self, player) -> Set[int]:
         return {group_id for group_id, group in self.groups.items() if player in group["players"]}
 
     def set_seed(self, seed: Optional[int] = None, secure: bool = False, name: Optional[str] = None):
@@ -265,7 +259,7 @@ class MultiWorld():
                         "link_replacement": replacement_prio.index(item_link["link_replacement"]),
                     }
 
-        for _name, item_link in item_links.items():
+        for name, item_link in item_links.items():
             current_item_name_groups = AutoWorld.AutoWorldRegister.world_types[item_link["game"]].item_name_groups
             pool = set()
             local_items = set()
@@ -294,86 +288,6 @@ class MultiWorld():
             group["non_local_items"] = item_link["non_local_items"]
             group["link_replacement"] = replacement_prio[item_link["link_replacement"]]
 
-    def link_items(self) -> None:
-        """Called to link together items in the itempool related to the registered item link groups."""
-        from worlds import AutoWorld
-
-        for group_id, group in self.groups.items():
-            def find_common_pool(players: Set[int], shared_pool: Set[str]) -> Tuple[
-                Optional[Dict[int, Dict[str, int]]], Optional[Dict[str, int]]
-            ]:
-                classifications: Dict[str, int] = collections.defaultdict(int)
-                counters = {player: {name: 0 for name in shared_pool} for player in players}
-                for item in self.itempool:
-                    if item.player in counters and item.name in shared_pool:
-                        counters[item.player][item.name] += 1
-                        classifications[item.name] |= item.classification
-
-                for player in players.copy():
-                    if all([counters[player][item] == 0 for item in shared_pool]):
-                        players.remove(player)
-                        del (counters[player])
-
-                if not players:
-                    return None, None
-
-                for item in shared_pool:
-                    count = min(counters[player][item] for player in players)
-                    if count:
-                        for player in players:
-                            counters[player][item] = count
-                    else:
-                        for player in players:
-                            del (counters[player][item])
-                return counters, classifications
-
-            common_item_count, classifications = find_common_pool(group["players"], group["item_pool"])
-            if not common_item_count:
-                continue
-
-            new_itempool: List[Item] = []
-            for item_name, item_count in next(iter(common_item_count.values())).items():
-                for _ in range(item_count):
-                    new_item = group["world"].create_item(item_name)
-                    # mangle together all original classification bits
-                    new_item.classification |= classifications[item_name]
-                    new_itempool.append(new_item)
-
-            region = Region("Menu", group_id, self, "ItemLink")
-            self.regions.append(region)
-            locations = region.locations
-            for item in self.itempool:
-                count = common_item_count.get(item.player, {}).get(item.name, 0)
-                if count:
-                    loc = Location(group_id, f"Item Link: {item.name} -> {self.player_name[item.player]} {count}",
-                        None, region)
-                    loc.access_rule = lambda state, item_name = item.name, group_id_ = group_id, count_ = count: \
-                        state.has(item_name, group_id_, count_)
-
-                    locations.append(loc)
-                    loc.place_locked_item(item)
-                    common_item_count[item.player][item.name] -= 1
-                else:
-                    new_itempool.append(item)
-
-            itemcount = len(self.itempool)
-            self.itempool = new_itempool
-
-            while itemcount > len(self.itempool):
-                items_to_add = []
-                for player in group["players"]:
-                    if group["link_replacement"]:
-                        item_player = group_id
-                    else:
-                        item_player = player
-                    if group["replacement_items"][player]:
-                        items_to_add.append(AutoWorld.call_single(self, "create_item", item_player,
-                            group["replacement_items"][player]))
-                    else:
-                        items_to_add.append(AutoWorld.call_single(self, "create_filler", item_player))
-                self.random.shuffle(items_to_add)
-                self.itempool.extend(items_to_add[:itemcount - len(self.itempool)])
-
     def secure(self):
         self.random = ThreadBarrierProxy(secrets.SystemRandom())
         self.is_race = True
@@ -395,7 +309,7 @@ class MultiWorld():
         return tuple(world for player, world in self.worlds.items() if
                      player not in self.groups and self.game[player] == game_name)
 
-    def get_name_string_for_object(self, obj: HasNameAndPlayer) -> str:
+    def get_name_string_for_object(self, obj) -> str:
         return obj.name if self.players == 1 else f'{obj.name} ({self.get_player_name(obj.player)})'
 
     def get_player_name(self, player: int) -> str:
@@ -437,7 +351,7 @@ class MultiWorld():
             subworld = self.worlds[player]
             for item in subworld.get_pre_fill_items():
                 subworld.collect(ret, item)
-        ret.sweep_for_advancements()
+        ret.sweep_for_events()
 
         if use_cache:
             self._all_state = ret
@@ -446,7 +360,7 @@ class MultiWorld():
     def get_items(self) -> List[Item]:
         return [loc.item for loc in self.get_filled_locations()] + self.itempool
 
-    def find_item_locations(self, item: str, player: int, resolve_group_locations: bool = False) -> List[Location]:
+    def find_item_locations(self, item, player: int, resolve_group_locations: bool = False) -> List[Location]:
         if resolve_group_locations:
             player_groups = self.get_player_groups(player)
             return [location for location in self.get_locations() if
@@ -455,7 +369,7 @@ class MultiWorld():
         return [location for location in self.get_locations() if
                 location.item and location.item.name == item and location.item.player == player]
 
-    def find_item(self, item: str, player: int) -> Location:
+    def find_item(self, item, player: int) -> Location:
         return next(location for location in self.get_locations() if
                     location.item and location.item.name == item and location.item.player == player)
 
@@ -548,9 +462,9 @@ class MultiWorld():
                 return True
             state = starting_state.copy()
         else:
-            state = CollectionState(self)
-            if self.has_beaten_game(state):
+            if self.has_beaten_game(self.state):
                 return True
+            state = CollectionState(self)
         prog_locations = {location for location in self.get_locations() if location.item
                           and location.item.advancement and location not in state.locations_checked}
 
@@ -609,21 +523,26 @@ class MultiWorld():
         players: Dict[str, Set[int]] = {
             "minimal": set(),
             "items": set(),
-            "full": set()
+            "locations": set()
         }
-        for player, world in self.worlds.items():
-            players[world.options.accessibility.current_key].add(player)
+        for player, access in self.accessibility.items():
+            players[access.current_key].add(player)
 
         beatable_fulfilled = False
 
-        def location_condition(location: Location) -> bool:
+        def location_condition(location: Location):
             """Determine if this location has to be accessible, location is already filtered by location_relevant"""
-            return location.player in players["full"] or \
-                (location.item and location.item.player not in players["minimal"])
+            if location.player in players["locations"] or (location.item and location.item.player not in
+                                                           players["minimal"]):
+                return True
+            return False
 
-        def location_relevant(location: Location) -> bool:
+        def location_relevant(location: Location):
             """Determine if this location is relevant to sweep."""
-            return location.player in players["full"] or location.advancement
+            if location.progress_type != LocationProgressType.EXCLUDED \
+               and (location.player in players["locations"] or location.advancement):
+                return True
+            return False
 
         def all_done() -> bool:
             """Check if all access rules are fulfilled"""
@@ -668,7 +587,7 @@ class CollectionState():
     multiworld: MultiWorld
     reachable_regions: Dict[int, Set[Region]]
     blocked_connections: Dict[int, Set[Entrance]]
-    advancements: Set[Location]
+    events: Set[Location]
     path: Dict[Union[Region, Entrance], PathValue]
     locations_checked: Set[Location]
     stale: Dict[int, bool]
@@ -680,7 +599,7 @@ class CollectionState():
         self.multiworld = parent
         self.reachable_regions = {player: set() for player in parent.get_all_ids()}
         self.blocked_connections = {player: set() for player in parent.get_all_ids()}
-        self.advancements = set()
+        self.events = set()
         self.path = {}
         self.locations_checked = set()
         self.stale = {player: True for player in parent.get_all_ids()}
@@ -692,25 +611,17 @@ class CollectionState():
 
     def update_reachable_regions(self, player: int):
         self.stale[player] = False
-        world: AutoWorld.World = self.multiworld.worlds[player]
         reachable_regions = self.reachable_regions[player]
+        blocked_connections = self.blocked_connections[player]
         queue = deque(self.blocked_connections[player])
-        start: Region = world.get_region(world.origin_region_name)
+        start = self.multiworld.get_region("Menu", player)
 
         # init on first call - this can't be done on construction since the regions don't exist yet
         if start not in reachable_regions:
             reachable_regions.add(start)
-            self.blocked_connections[player].update(start.exits)
+            blocked_connections.update(start.exits)
             queue.extend(start.exits)
 
-        if world.explicit_indirect_conditions:
-            self._update_reachable_regions_explicit_indirect_conditions(player, queue)
-        else:
-            self._update_reachable_regions_auto_indirect_conditions(player, queue)
-
-    def _update_reachable_regions_explicit_indirect_conditions(self, player: int, queue: deque):
-        reachable_regions = self.reachable_regions[player]
-        blocked_connections = self.blocked_connections[player]
         # run BFS on all connections, and keep track of those blocked by missing items
         while queue:
             connection = queue.popleft()
@@ -730,39 +641,16 @@ class CollectionState():
                     if new_entrance in blocked_connections and new_entrance not in queue:
                         queue.append(new_entrance)
 
-    def _update_reachable_regions_auto_indirect_conditions(self, player: int, queue: deque):
-        reachable_regions = self.reachable_regions[player]
-        blocked_connections = self.blocked_connections[player]
-        new_connection: bool = True
-        # run BFS on all connections, and keep track of those blocked by missing items
-        while new_connection:
-            new_connection = False
-            while queue:
-                connection = queue.popleft()
-                new_region = connection.connected_region
-                if new_region in reachable_regions:
-                    blocked_connections.remove(connection)
-                elif connection.can_reach(self):
-                    assert new_region, f"tried to search through an Entrance \"{connection}\" with no Region"
-                    reachable_regions.add(new_region)
-                    blocked_connections.remove(connection)
-                    blocked_connections.update(new_region.exits)
-                    queue.extend(new_region.exits)
-                    self.path[new_region] = (new_region.name, self.path.get(connection, None))
-                    new_connection = True
-            # sweep for indirect connections, mostly Entrance.can_reach(unrelated_Region)
-            queue.extend(blocked_connections)
-
     def copy(self) -> CollectionState:
         ret = CollectionState(self.multiworld)
-        ret.prog_items = {player: counter.copy() for player, counter in self.prog_items.items()}
-        ret.reachable_regions = {player: region_set.copy() for player, region_set in
-                                 self.reachable_regions.items()}
-        ret.blocked_connections = {player: entrance_set.copy() for player, entrance_set in
-                                   self.blocked_connections.items()}
-        ret.advancements = self.advancements.copy()
-        ret.path = self.path.copy()
-        ret.locations_checked = self.locations_checked.copy()
+        ret.prog_items = copy.deepcopy(self.prog_items)
+        ret.reachable_regions = {player: copy.copy(self.reachable_regions[player]) for player in
+                                 self.reachable_regions}
+        ret.blocked_connections = {player: copy.copy(self.blocked_connections[player]) for player in
+                                   self.blocked_connections}
+        ret.events = copy.copy(self.events)
+        ret.path = copy.copy(self.path)
+        ret.locations_checked = copy.copy(self.locations_checked)
         for function in self.additional_copy_functions:
             ret = function(self, ret)
         return ret
@@ -792,25 +680,20 @@ class CollectionState():
     def can_reach_region(self, spot: str, player: int) -> bool:
         return self.multiworld.get_region(spot, player).can_reach(self)
 
-    def sweep_for_events(self, locations: Optional[Iterable[Location]] = None) -> None:
-        Utils.deprecate("sweep_for_events has been renamed to sweep_for_advancements. The functionality is the same. "
-                        "Please switch over to sweep_for_advancements.")
-        return self.sweep_for_advancements(locations)
-
-    def sweep_for_advancements(self, locations: Optional[Iterable[Location]] = None) -> None:
+    def sweep_for_events(self, key_only: bool = False, locations: Optional[Iterable[Location]] = None) -> None:
         if locations is None:
             locations = self.multiworld.get_filled_locations()
-        reachable_advancements = True
-        # since the loop has a good chance to run more than once, only filter the advancements once
-        locations = {location for location in locations if location.advancement and location not in self.advancements}
-
-        while reachable_advancements:
-            reachable_advancements = {location for location in locations if location.can_reach(self)}
-            locations -= reachable_advancements
-            for advancement in reachable_advancements:
-                self.advancements.add(advancement)
-                assert isinstance(advancement.item, Item), "tried to collect Event with no Item"
-                self.collect(advancement.item, True, advancement)
+        reachable_events = True
+        # since the loop has a good chance to run more than once, only filter the events once
+        locations = {location for location in locations if location.advancement and location not in self.events and
+                     not key_only or getattr(location.item, "locked_dungeon_item", False)}
+        while reachable_events:
+            reachable_events = {location for location in locations if location.can_reach(self)}
+            locations -= reachable_events
+            for event in reachable_events:
+                self.events.add(event)
+                assert isinstance(event.item, Item), "tried to collect Event with no Item"
+                self.collect(event.item, True, event)
 
     # item name related
     def has(self, item: str, player: int, count: int = 1) -> bool:
@@ -844,7 +727,7 @@ class CollectionState():
             if found >= count:
                 return True
         return False
-
+    
     def has_from_list_unique(self, items: Iterable[str], player: int, count: int) -> bool:
         """Returns True if the state contains at least `count` items matching any of the item names from a list.
         Ignores duplicates of the same item."""
@@ -859,7 +742,7 @@ class CollectionState():
     def count_from_list(self, items: Iterable[str], player: int) -> int:
         """Returns the cumulative count of items from a list present in state."""
         return sum(self.prog_items[player][item_name] for item_name in items)
-
+    
     def count_from_list_unique(self, items: Iterable[str], player: int) -> int:
         """Returns the cumulative count of items from a list present in state. Ignores duplicates of the same item."""
         return sum(self.prog_items[player][item_name] > 0 for item_name in items)
@@ -905,16 +788,20 @@ class CollectionState():
         )
 
     # Item related
-    def collect(self, item: Item, prevent_sweep: bool = False, location: Optional[Location] = None) -> bool:
+    def collect(self, item: Item, event: bool = False, location: Optional[Location] = None) -> bool:
         if location:
             self.locations_checked.add(location)
 
         changed = self.multiworld.worlds[item.player].collect(self, item)
 
+        if not changed and event:
+            self.prog_items[item.player][item.name] += 1
+            changed = True
+
         self.stale[item.player] = True
 
-        if changed and not prevent_sweep:
-            self.sweep_for_advancements()
+        if changed and not event:
+            self.sweep_for_events()
 
         return changed
 
@@ -938,7 +825,7 @@ class Entrance:
     addresses = None
     target = None
 
-    def __init__(self, player: int, name: str = "", parent: Optional[Region] = None) -> None:
+    def __init__(self, player: int, name: str = '', parent: Region = None):
         self.name = name
         self.parent_region = parent
         self.player = player
@@ -958,6 +845,9 @@ class Entrance:
         region.entrances.append(self)
 
     def __repr__(self):
+        return self.__str__()
+
+    def __str__(self):
         multiworld = self.parent_region.multiworld if self.parent_region else None
         return multiworld.get_name_string_for_object(self) if multiworld else f'{self.name} (Player {self.player})'
 
@@ -1083,7 +973,7 @@ class Region:
             self.locations.append(location_type(self.player, location, address, self))
 
     def connect(self, connecting_region: Region, name: Optional[str] = None,
-                rule: Optional[Callable[[CollectionState], bool]] = None) -> Entrance:
+                rule: Optional[Callable[[CollectionState], bool]] = None) -> entrance_type:
         """
         Connects this Region to another Region, placing the provided rule on the connection.
 
@@ -1123,6 +1013,9 @@ class Region:
                          rules[connecting_region] if rules and connecting_region in rules else None)
 
     def __repr__(self):
+        return self.__str__()
+
+    def __str__(self):
         return self.multiworld.get_name_string_for_object(self) if self.multiworld else f'{self.name} (Player {self.player})'
 
 
@@ -1141,9 +1034,9 @@ class Location:
     locked: bool = False
     show_in_spoiler: bool = True
     progress_type: LocationProgressType = LocationProgressType.DEFAULT
-    always_allow: Callable[[CollectionState, Item], bool] = staticmethod(lambda state, item: False)
+    always_allow = staticmethod(lambda state, item: False)
     access_rule: Callable[[CollectionState], bool] = staticmethod(lambda state: True)
-    item_rule: Callable[[Item], bool] = staticmethod(lambda item: True)
+    item_rule = staticmethod(lambda item: True)
     item: Optional[Item] = None
 
     def __init__(self, player: int, name: str = '', address: Optional[int] = None, parent: Optional[Region] = None):
@@ -1152,20 +1045,16 @@ class Location:
         self.address = address
         self.parent_region = parent
 
-    def can_fill(self, state: CollectionState, item: Item, check_access: bool = True) -> bool:
-        return ((
-            self.always_allow(state, item)
-            and item.name not in state.multiworld.worlds[item.player].options.non_local_items
-        ) or (
-            (self.progress_type != LocationProgressType.EXCLUDED or not (item.advancement or item.useful))
-            and self.item_rule(item)
-            and (not check_access or self.can_reach(state))
-        ))
+    def can_fill(self, state: CollectionState, item: Item, check_access=True) -> bool:
+        return ((self.always_allow(state, item) and item.name not in state.multiworld.worlds[item.player].options.non_local_items)
+                or ((self.progress_type != LocationProgressType.EXCLUDED or not (item.advancement or item.useful))
+                    and self.item_rule(item)
+                    and (not check_access or self.can_reach(state))))
 
     def can_reach(self, state: CollectionState) -> bool:
-        # Region.can_reach is just a cache lookup, so placing it first for faster abort on average
+        # self.access_rule computes faster on average, so placing it first for faster abort
         assert self.parent_region, "Can't reach location without region"
-        return self.parent_region.can_reach(state) and self.access_rule(state)
+        return self.access_rule(state) and self.parent_region.can_reach(state)
 
     def place_locked_item(self, item: Item):
         if self.item:
@@ -1175,6 +1064,9 @@ class Location:
         self.locked = True
 
     def __repr__(self):
+        return self.__str__()
+
+    def __str__(self):
         multiworld = self.parent_region.multiworld if self.parent_region and self.parent_region.multiworld else None
         return multiworld.get_name_string_for_object(self) if multiworld else f'{self.name} (Player {self.player})'
 
@@ -1196,7 +1088,7 @@ class Location:
     @property
     def native_item(self) -> bool:
         """Returns True if the item in this location matches game."""
-        return self.item is not None and self.item.game == self.game
+        return self.item and self.item.game == self.game
 
     @property
     def hint_text(self) -> str:
@@ -1279,6 +1171,9 @@ class Item:
         return hash((self.name, self.player))
 
     def __repr__(self) -> str:
+        return self.__str__()
+
+    def __str__(self) -> str:
         if self.location and self.location.parent_region and self.location.parent_region.multiworld:
             return self.location.parent_region.multiworld.get_name_string_for_object(self)
         return f"{self.name} (Player {self.player})"
@@ -1356,9 +1251,9 @@ class Spoiler:
 
         # in the second phase, we cull each sphere such that the game is still beatable,
         # reducing each range of influence to the bare minimum required inside it
-        restore_later: Dict[Location, Item] = {}
+        restore_later = {}
         for num, sphere in reversed(tuple(enumerate(collection_spheres))):
-            to_delete: Set[Location] = set()
+            to_delete = set()
             for location in sphere:
                 # we remove the item at location and check if game is still beatable
                 logging.debug('Checking if %s (Player %d) is required to beat the game.', location.item.name,
@@ -1376,7 +1271,7 @@ class Spoiler:
             sphere -= to_delete
 
         # second phase, sphere 0
-        removed_precollected: List[Item] = []
+        removed_precollected = []
         for item in (i for i in chain.from_iterable(multiworld.precollected_items.values()) if i.advancement):
             logging.debug('Checking if %s (Player %d) is required to beat the game.', item.name, item.player)
             multiworld.precollected_items[item.player].remove(item)
@@ -1396,6 +1291,8 @@ class Spoiler:
         state = CollectionState(multiworld)
         collection_spheres = []
         while required_locations:
+            state.sweep_for_events(key_only=True)
+
             sphere = set(filter(state.can_reach, required_locations))
 
             for location in sphere:
@@ -1457,7 +1354,7 @@ class Spoiler:
                 # Maybe move the big bomb over to the Event system instead?
                 if any(exit_path == 'Pyramid Fairy' for path in self.paths.values()
                        for (_, exit_path) in path):
-                    if multiworld.worlds[player].options.mode != 'inverted':
+                    if multiworld.mode[player] != 'inverted':
                         self.paths[str(multiworld.get_region('Big Bomb Shop', player))] = \
                             get_path(state, multiworld.get_region('Big Bomb Shop', player))
                     else:
@@ -1529,9 +1426,9 @@ class Spoiler:
 
             if self.paths:
                 outfile.write('\n\nPaths:\n\n')
-                path_listings: List[str] = []
+                path_listings = []
                 for location, path in sorted(self.paths.items()):
-                    path_lines: List[str] = []
+                    path_lines = []
                     for region, exit in path:
                         if exit is not None:
                             path_lines.append("{} -> {}".format(region, exit))

CommonClient.py

@@ -252,7 +252,7 @@ class CommonContext:
     starting_reconnect_delay: int = 5
     current_reconnect_delay: int = starting_reconnect_delay
     command_processor: typing.Type[CommandProcessor] = ClientCommandProcessor
-    ui: typing.Optional["kvui.GameManager"] = None
+    ui = None
     ui_task: typing.Optional["asyncio.Task[None]"] = None
     input_task: typing.Optional["asyncio.Task[None]"] = None
     keep_alive_task: typing.Optional["asyncio.Task[None]"] = None

Fill.py

@@ -12,12 +12,7 @@ from worlds.generic.Rules import add_item_rule
 
 
 class FillError(RuntimeError):
-    def __init__(self, *args: typing.Union[str, typing.Any], **kwargs) -> None:
-        if "multiworld" in kwargs and isinstance(args[0], str):
-            placements = (args[0] + f"\nAll Placements:\n" +
-                          f"{[(loc, loc.item) for loc in kwargs['multiworld'].get_filled_locations()]}")
-            args = (placements, *args[1:])
-        super().__init__(*args)
+    pass
 
 
 def _log_fill_progress(name: str, placed: int, total_items: int) -> None:
@@ -29,7 +24,7 @@ def sweep_from_pool(base_state: CollectionState, itempool: typing.Sequence[Item]
     new_state = base_state.copy()
     for item in itempool:
         new_state.collect(item, True)
-    new_state.sweep_for_advancements(locations=locations)
+    new_state.sweep_for_events(locations=locations)
     return new_state
 
 
@@ -217,7 +212,7 @@ def fill_restrictive(multiworld: MultiWorld, base_state: CollectionState, locati
                             f"Unfilled locations:\n"
                             f"{', '.join(str(location) for location in locations)}\n"
                             f"Already placed {len(placements)}:\n"
-                            f"{', '.join(str(place) for place in placements)}", multiworld=multiworld)
+                            f"{', '.join(str(place) for place in placements)}")
 
     item_pool.extend(unplaced_items)
 
@@ -304,7 +299,7 @@ def remaining_fill(multiworld: MultiWorld,
                             f"Unfilled locations:\n"
                             f"{', '.join(str(location) for location in locations)}\n"
                             f"Already placed {len(placements)}:\n"
-                            f"{', '.join(str(place) for place in placements)}", multiworld=multiworld)
+                            f"{', '.join(str(place) for place in placements)}")
 
     itempool.extend(unplaced_items)
 
@@ -329,8 +324,8 @@ def accessibility_corrections(multiworld: MultiWorld, state: CollectionState, lo
             pool.append(location.item)
             state.remove(location.item)
             location.item = None
-            if location in state.advancements:
-                state.advancements.remove(location)
+            if location in state.events:
+                state.events.remove(location)
             locations.append(location)
     if pool and locations:
         locations.sort(key=lambda loc: loc.progress_type != LocationProgressType.PRIORITY)
@@ -363,7 +358,7 @@ def distribute_early_items(multiworld: MultiWorld,
         early_priority_locations: typing.List[Location] = []
         loc_indexes_to_remove: typing.Set[int] = set()
         base_state = multiworld.state.copy()
-        base_state.sweep_for_advancements(locations=(loc for loc in multiworld.get_filled_locations() if loc.address is None))
+        base_state.sweep_for_events(locations=(loc for loc in multiworld.get_filled_locations() if loc.address is None))
         for i, loc in enumerate(fill_locations):
             if loc.can_reach(base_state):
                 if loc.progress_type == LocationProgressType.PRIORITY:
@@ -511,8 +506,7 @@ def distribute_items_restrictive(multiworld: MultiWorld,
         if progitempool:
             raise FillError(
                 f"Not enough locations for progression items. "
-                f"There are {len(progitempool)} more progression items than there are available locations.",
-                multiworld=multiworld,
+                f"There are {len(progitempool)} more progression items than there are available locations."
             )
         accessibility_corrections(multiworld, multiworld.state, defaultlocations)
 
@@ -529,8 +523,7 @@ def distribute_items_restrictive(multiworld: MultiWorld,
     if excludedlocations:
         raise FillError(
             f"Not enough filler items for excluded locations. "
-            f"There are {len(excludedlocations)} more excluded locations than filler or trap items.",
-            multiworld=multiworld,
+            f"There are {len(excludedlocations)} more excluded locations than filler or trap items."
         )
 
     restitempool = filleritempool + usefulitempool
@@ -558,7 +551,7 @@ def flood_items(multiworld: MultiWorld) -> None:
     progress_done = False
 
     # sweep once to pick up preplaced items
-    multiworld.state.sweep_for_advancements()
+    multiworld.state.sweep_for_events()
 
     # fill multiworld from top of itempool while we can
     while not progress_done:
@@ -596,7 +589,7 @@ def flood_items(multiworld: MultiWorld) -> None:
             if candidate_item_to_place is not None:
                 item_to_place = candidate_item_to_place
             else:
-                raise FillError('No more progress items left to place.', multiworld=multiworld)
+                raise FillError('No more progress items left to place.')
 
         # find item to replace with progress item
         location_list = multiworld.get_reachable_locations()
@@ -653,6 +646,7 @@ def balance_multiworld_progression(multiworld: MultiWorld) -> None:
 
         def get_sphere_locations(sphere_state: CollectionState,
                                  locations: typing.Set[Location]) -> typing.Set[Location]:
+            sphere_state.sweep_for_events(key_only=True, locations=locations)
             return {loc for loc in locations if sphere_state.can_reach(loc)}
 
         def item_percentage(player: int, num: int) -> float:
@@ -746,7 +740,7 @@ def balance_multiworld_progression(multiworld: MultiWorld) -> None:
                             ), items_to_test):
                                 reducing_state.collect(location.item, True, location)
 
-                            reducing_state.sweep_for_advancements(locations=locations_to_test)
+                            reducing_state.sweep_for_events(locations=locations_to_test)
 
                             if multiworld.has_beaten_game(balancing_state):
                                 if not multiworld.has_beaten_game(reducing_state):
@@ -829,7 +823,7 @@ def distribute_planned(multiworld: MultiWorld) -> None:
             warn(warning, force)
 
     swept_state = multiworld.state.copy()
-    swept_state.sweep_for_advancements()
+    swept_state.sweep_for_events()
     reachable = frozenset(multiworld.get_reachable_locations(swept_state))
     early_locations: typing.Dict[int, typing.List[str]] = collections.defaultdict(list)
     non_early_locations: typing.Dict[int, typing.List[str]] = collections.defaultdict(list)

Generate.py

@@ -511,7 +511,7 @@ def roll_settings(weights: dict, plando_options: PlandoOptions = PlandoOptions.b
             continue
         logging.warning(f"{option_key} is not a valid option name for {ret.game} and is not present in triggers.")
     if PlandoOptions.items in plando_options:
-        ret.plando_items = copy.deepcopy(game_weights.get("plando_items", []))
+        ret.plando_items = game_weights.get("plando_items", [])
     if ret.game == "A Link to the Past":
         roll_alttp_settings(ret, game_weights)
 

KH1Client.py

@@ -1,9 +0,0 @@
-if __name__ == '__main__':
-    import ModuleUpdate
-    ModuleUpdate.update()
-
-    import Utils
-    Utils.init_logging("KH1Client", exception_logger="Client")
-
-    from worlds.kh1.Client import launch
-    launch()

Launcher.py

@@ -266,7 +266,7 @@ def run_gui():
             if file and component:
                 run_component(component, file)
             else:
-                logging.warning(f"unable to identify component for {file}")
+                logging.warning(f"unable to identify component for {filename}")
 
         def _stop(self, *largs):
             # ran into what appears to be https://groups.google.com/g/kivy-users/c/saWDLoYCSZ4 with PyCharm.

LttPAdjuster.py

@@ -14,7 +14,7 @@ import tkinter as tk
 from argparse import Namespace
 from concurrent.futures import as_completed, ThreadPoolExecutor
 from glob import glob
-from tkinter import Tk, Frame, Label, StringVar, Entry, filedialog, messagebox, Button, Radiobutton, LEFT, X, BOTH, TOP, LabelFrame, \
+from tkinter import Tk, Frame, Label, StringVar, Entry, filedialog, messagebox, Button, Radiobutton, LEFT, X, TOP, LabelFrame, \
     IntVar, Checkbutton, E, W, OptionMenu, Toplevel, BOTTOM, RIGHT, font as font, PhotoImage
 from tkinter.constants import DISABLED, NORMAL
 from urllib.parse import urlparse
@@ -29,8 +29,7 @@ from Utils import output_path, local_path, user_path, open_file, get_cert_none_s
 
 
 GAME_ALTTP = "A Link to the Past"
-WINDOW_MIN_HEIGHT = 525
-WINDOW_MIN_WIDTH = 425
+
 
 class AdjusterWorld(object):
     def __init__(self, sprite_pool):
@@ -243,17 +242,16 @@ def adjustGUI():
     from argparse import Namespace
     from Utils import __version__ as MWVersion
     adjustWindow = Tk()
-    adjustWindow.minsize(WINDOW_MIN_WIDTH, WINDOW_MIN_HEIGHT)
     adjustWindow.wm_title("Archipelago %s LttP Adjuster" % MWVersion)
     set_icon(adjustWindow)
 
     rom_options_frame, rom_vars, set_sprite = get_rom_options_frame(adjustWindow)
 
-    bottomFrame2 = Frame(adjustWindow, padx=8, pady=2)
+    bottomFrame2 = Frame(adjustWindow)
 
     romFrame, romVar = get_rom_frame(adjustWindow)
 
-    romDialogFrame = Frame(adjustWindow, padx=8, pady=2)
+    romDialogFrame = Frame(adjustWindow)
     baseRomLabel2 = Label(romDialogFrame, text='Rom to adjust')
     romVar2 = StringVar()
     romEntry2 = Entry(romDialogFrame, textvariable=romVar2)
@@ -263,9 +261,9 @@ def adjustGUI():
         romVar2.set(rom)
 
     romSelectButton2 = Button(romDialogFrame, text='Select Rom', command=RomSelect2)
-    romDialogFrame.pack(side=TOP, expand=False, fill=X)
-    baseRomLabel2.pack(side=LEFT, expand=False, fill=X, padx=(0, 8))
-    romEntry2.pack(side=LEFT, expand=True, fill=BOTH, pady=1)
+    romDialogFrame.pack(side=TOP, expand=True, fill=X)
+    baseRomLabel2.pack(side=LEFT)
+    romEntry2.pack(side=LEFT, expand=True, fill=X)
     romSelectButton2.pack(side=LEFT)
 
     def adjustRom():
@@ -333,11 +331,12 @@ def adjustGUI():
         messagebox.showinfo(title="Success", message="Settings saved to persistent storage")
 
     adjustButton = Button(bottomFrame2, text='Adjust Rom', command=adjustRom)
-    rom_options_frame.pack(side=TOP, padx=8, pady=8, fill=BOTH, expand=True)
+    rom_options_frame.pack(side=TOP)
     adjustButton.pack(side=LEFT, padx=(5,5))
 
     saveButton = Button(bottomFrame2, text='Save Settings', command=saveGUISettings)
     saveButton.pack(side=LEFT, padx=(5,5))
+
     bottomFrame2.pack(side=TOP, pady=(5,5))
 
     tkinter_center_window(adjustWindow)
@@ -577,7 +576,7 @@ class AttachTooltip(object):
 def get_rom_frame(parent=None):
     adjuster_settings = get_adjuster_settings(GAME_ALTTP)
 
-    romFrame = Frame(parent, padx=8, pady=8)
+    romFrame = Frame(parent)
     baseRomLabel = Label(romFrame, text='LttP Base Rom: ')
     romVar = StringVar(value=adjuster_settings.baserom)
     romEntry = Entry(romFrame, textvariable=romVar)
@@ -597,19 +596,20 @@ def get_rom_frame(parent=None):
     romSelectButton = Button(romFrame, text='Select Rom', command=RomSelect)
 
     baseRomLabel.pack(side=LEFT)
-    romEntry.pack(side=LEFT, expand=True, fill=BOTH, pady=1)
+    romEntry.pack(side=LEFT, expand=True, fill=X)
     romSelectButton.pack(side=LEFT)
-    romFrame.pack(side=TOP, fill=X)
+    romFrame.pack(side=TOP, expand=True, fill=X)
 
     return romFrame, romVar
 
 def get_rom_options_frame(parent=None):
     adjuster_settings = get_adjuster_settings(GAME_ALTTP)
 
-    romOptionsFrame = LabelFrame(parent, text="Rom options", padx=8, pady=8)
-
+    romOptionsFrame = LabelFrame(parent, text="Rom options")
+    romOptionsFrame.columnconfigure(0, weight=1)
+    romOptionsFrame.columnconfigure(1, weight=1)
     for i in range(5):
-        romOptionsFrame.rowconfigure(i, weight=0, pad=4)
+        romOptionsFrame.rowconfigure(i, weight=1)
     vars = Namespace()
 
     vars.MusicVar = IntVar()
@@ -660,7 +660,7 @@ def get_rom_options_frame(parent=None):
     spriteSelectButton = Button(spriteDialogFrame, text='...', command=SpriteSelect)
 
     baseSpriteLabel.pack(side=LEFT)
-    spriteEntry.pack(side=LEFT, expand=True, fill=X)
+    spriteEntry.pack(side=LEFT)
     spriteSelectButton.pack(side=LEFT)
 
     oofDialogFrame = Frame(romOptionsFrame)

Main.py

@@ -11,8 +11,7 @@ from typing import Dict, List, Optional, Set, Tuple, Union
 
 import worlds
 from BaseClasses import CollectionState, Item, Location, LocationProgressType, MultiWorld, Region
-from Fill import FillError, balance_multiworld_progression, distribute_items_restrictive, distribute_planned, \
-    flood_items
+from Fill import balance_multiworld_progression, distribute_items_restrictive, distribute_planned, flood_items
 from Options import StartInventoryPool
 from Utils import __version__, output_path, version_tuple, get_settings
 from settings import get_settings
@@ -101,7 +100,7 @@ def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = No
                 multiworld.early_items[player][item_name] = max(0, early-count)
                 remaining_count = count-early
                 if remaining_count > 0:
-                    local_early = multiworld.local_early_items[player].get(item_name, 0)
+                    local_early = multiworld.early_local_items[player].get(item_name, 0)
                     if local_early:
                         multiworld.early_items[player][item_name] = max(0, local_early - remaining_count)
                     del local_early
@@ -152,7 +151,6 @@ def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = No
     # Because some worlds don't actually create items during create_items this has to be as late as possible.
     if any(getattr(multiworld.worlds[player].options, "start_inventory_from_pool", None) for player in multiworld.player_ids):
         new_items: List[Item] = []
-        old_items: List[Item] = []
         depletion_pool: Dict[int, Dict[str, int]] = {
             player: getattr(multiworld.worlds[player].options,
                             "start_inventory_from_pool",
@@ -171,26 +169,97 @@ def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = No
                 depletion_pool[item.player][item.name] -= 1
                 # quick abort if we have found all items
                 if not target:
-                    old_items.extend(multiworld.itempool[i+1:])
+                    new_items.extend(multiworld.itempool[i+1:])
                     break
             else:
-                old_items.append(item)
+                new_items.append(item)
 
         # leftovers?
         if target:
             for player, remaining_items in depletion_pool.items():
                 remaining_items = {name: count for name, count in remaining_items.items() if count}
                 if remaining_items:
-                    logger.warning(f"{multiworld.get_player_name(player)}"
+                    raise Exception(f"{multiworld.get_player_name(player)}"
                                     f" is trying to remove items from their pool that don't exist: {remaining_items}")
-                    # find all filler we generated for the current player and remove until it matches 
-                    removables = [item for item in new_items if item.player == player]
-                    for _ in range(sum(remaining_items.values())):
-                        new_items.remove(removables.pop())
-        assert len(multiworld.itempool) == len(new_items + old_items), "Item Pool amounts should not change."
-        multiworld.itempool[:] = new_items + old_items
+        assert len(multiworld.itempool) == len(new_items), "Item Pool amounts should not change."
+        multiworld.itempool[:] = new_items
 
-    multiworld.link_items()
+    # temporary home for item links, should be moved out of Main
+    for group_id, group in multiworld.groups.items():
+        def find_common_pool(players: Set[int], shared_pool: Set[str]) -> Tuple[
+            Optional[Dict[int, Dict[str, int]]], Optional[Dict[str, int]]
+        ]:
+            classifications: Dict[str, int] = collections.defaultdict(int)
+            counters = {player: {name: 0 for name in shared_pool} for player in players}
+            for item in multiworld.itempool:
+                if item.player in counters and item.name in shared_pool:
+                    counters[item.player][item.name] += 1
+                    classifications[item.name] |= item.classification
+
+            for player in players.copy():
+                if all([counters[player][item] == 0 for item in shared_pool]):
+                    players.remove(player)
+                    del (counters[player])
+
+            if not players:
+                return None, None
+
+            for item in shared_pool:
+                count = min(counters[player][item] for player in players)
+                if count:
+                    for player in players:
+                        counters[player][item] = count
+                else:
+                    for player in players:
+                        del (counters[player][item])
+            return counters, classifications
+
+        common_item_count, classifications = find_common_pool(group["players"], group["item_pool"])
+        if not common_item_count:
+            continue
+
+        new_itempool: List[Item] = []
+        for item_name, item_count in next(iter(common_item_count.values())).items():
+            for _ in range(item_count):
+                new_item = group["world"].create_item(item_name)
+                # mangle together all original classification bits
+                new_item.classification |= classifications[item_name]
+                new_itempool.append(new_item)
+
+        region = Region("Menu", group_id, multiworld, "ItemLink")
+        multiworld.regions.append(region)
+        locations = region.locations
+        for item in multiworld.itempool:
+            count = common_item_count.get(item.player, {}).get(item.name, 0)
+            if count:
+                loc = Location(group_id, f"Item Link: {item.name} -> {multiworld.player_name[item.player]} {count}",
+                               None, region)
+                loc.access_rule = lambda state, item_name = item.name, group_id_ = group_id, count_ = count: \
+                    state.has(item_name, group_id_, count_)
+
+                locations.append(loc)
+                loc.place_locked_item(item)
+                common_item_count[item.player][item.name] -= 1
+            else:
+                new_itempool.append(item)
+
+        itemcount = len(multiworld.itempool)
+        multiworld.itempool = new_itempool
+
+        while itemcount > len(multiworld.itempool):
+            items_to_add = []
+            for player in group["players"]:
+                if group["link_replacement"]:
+                    item_player = group_id
+                else:
+                    item_player = player
+                if group["replacement_items"][player]:
+                    items_to_add.append(AutoWorld.call_single(multiworld, "create_item", item_player,
+                                                                group["replacement_items"][player]))
+                else:
+                    items_to_add.append(AutoWorld.call_single(multiworld, "create_filler", item_player))
+            multiworld.random.shuffle(items_to_add)
+            multiworld.itempool.extend(items_to_add[:itemcount - len(multiworld.itempool)])
 
     if any(multiworld.item_links.values()):
         multiworld._all_state = None
@@ -347,7 +416,7 @@ def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = No
             output_file_futures.append(pool.submit(write_multidata))
             if not check_accessibility_task.result():
                 if not multiworld.can_beat_game():
-                    raise FillError("Game appears as unbeatable. Aborting.", multiworld=multiworld)
+                    raise Exception("Game appears as unbeatable. Aborting.")
                 else:
                     logger.warning("Location Accessibility requirements not fulfilled.")
 

ModuleUpdate.py

@@ -75,13 +75,13 @@ def update(yes: bool = False, force: bool = False) -> None:
     if not update_ran:
         update_ran = True
 
-        install_pkg_resources(yes=yes)
-        import pkg_resources
-
         if force:
             update_command()
             return
 
+        install_pkg_resources(yes=yes)
+        import pkg_resources
+
         prev = ""  # if a line ends in \ we store here and merge later
         for req_file in requirements_files:
             path = os.path.join(os.path.dirname(sys.argv[0]), req_file)

MultiServer.py

@@ -67,21 +67,6 @@ def update_dict(dictionary, entries):
     return dictionary
 
 
-def queue_gc():
-    import gc
-    from threading import Thread
-
-    gc_thread: typing.Optional[Thread] = getattr(queue_gc, "_thread", None)
-    def async_collect():
-        time.sleep(2)
-        setattr(queue_gc, "_thread", None)
-        gc.collect()
-    if not gc_thread:
-        gc_thread = Thread(target=async_collect)
-        setattr(queue_gc, "_thread", gc_thread)
-        gc_thread.start()
-
-
 # functions callable on storable data on the server by clients
 modify_functions = {
     # generic:
@@ -566,9 +551,6 @@ class Context:
                         self.logger.info(f"Saving failed. Retry in {self.auto_save_interval} seconds.")
                     else:
                         self.save_dirty = False
-                if not atexit_save:  # if atexit is used, that keeps a reference anyway
-                    queue_gc()
-
             self.auto_saver_thread = threading.Thread(target=save_regularly, daemon=True)
             self.auto_saver_thread.start()
 
@@ -1009,7 +991,7 @@ def collect_player(ctx: Context, team: int, slot: int, is_group: bool = False):
                     collect_player(ctx, team, group, True)
 
 
-def get_remaining(ctx: Context, team: int, slot: int) -> typing.List[typing.Tuple[int, int]]:
+def get_remaining(ctx: Context, team: int, slot: int) -> typing.List[int]:
     return ctx.locations.get_remaining(ctx.location_checks, team, slot)
 
 
@@ -1221,10 +1203,6 @@ class CommonCommandProcessor(CommandProcessor):
             timer = int(seconds, 10)
         except ValueError:
             timer = 10
-        else:
-            if timer > 60 * 60:
-                raise ValueError(f"{timer} is invalid. Maximum is 1 hour.")
-
         async_start(countdown(self.ctx, timer))
         return True
 
@@ -1372,10 +1350,10 @@ class ClientMessageProcessor(CommonCommandProcessor):
     def _cmd_remaining(self) -> bool:
         """List remaining items in your game, but not their location or recipient"""
         if self.ctx.remaining_mode == "enabled":
-            rest_locations = get_remaining(self.ctx, self.client.team, self.client.slot)
-            if rest_locations:
-                self.output("Remaining items: " + ", ".join(self.ctx.item_names[self.ctx.games[slot]][item_id]
-                                                            for slot, item_id in rest_locations))
+            remaining_item_ids = get_remaining(self.ctx, self.client.team, self.client.slot)
+            if remaining_item_ids:
+                self.output("Remaining items: " + ", ".join(self.ctx.item_names[self.ctx.games[self.client.slot]][item_id]
+                                                            for item_id in remaining_item_ids))
             else:
                 self.output("No remaining items found.")
             return True
@@ -1385,10 +1363,10 @@ class ClientMessageProcessor(CommonCommandProcessor):
             return False
         else:  # is goal
             if self.ctx.client_game_state[self.client.team, self.client.slot] == ClientStatus.CLIENT_GOAL:
-                rest_locations = get_remaining(self.ctx, self.client.team, self.client.slot)
-                if rest_locations:
-                    self.output("Remaining items: " + ", ".join(self.ctx.item_names[self.ctx.games[slot]][item_id]
-                                                                for slot, item_id in rest_locations))
+                remaining_item_ids = get_remaining(self.ctx, self.client.team, self.client.slot)
+                if remaining_item_ids:
+                    self.output("Remaining items: " + ", ".join(self.ctx.item_names[self.ctx.games[self.client.slot]][item_id]
+                                                                for item_id in remaining_item_ids))
                 else:
                     self.output("No remaining items found.")
                 return True
@@ -2061,8 +2039,6 @@ class ServerCommandProcessor(CommonCommandProcessor):
             item_name, usable, response = get_intended_text(item_name, names)
             if usable:
                 amount: int = int(amount)
-                if amount > 100:
-                    raise ValueError(f"{amount} is invalid. Maximum is 100.")
                 new_items = [NetworkItem(names[item_name], -1, 0) for _ in range(int(amount))]
                 send_items_to(self.ctx, team, slot, *new_items)
 

NetUtils.py

@@ -79,7 +79,6 @@ class NetworkItem(typing.NamedTuple):
     item: int
     location: int
     player: int
-    """ Sending player, except in LocationInfo (from LocationScouts), where it is the receiving player. """
     flags: int = 0
 
 
@@ -398,12 +397,12 @@ class _LocationStore(dict, typing.MutableMapping[int, typing.Dict[int, typing.Tu
                 location_id not in checked]
 
     def get_remaining(self, state: typing.Dict[typing.Tuple[int, int], typing.Set[int]], team: int, slot: int
-                      ) -> typing.List[typing.Tuple[int, int]]:
+                      ) -> typing.List[int]:
         checked = state[team, slot]
         player_locations = self[slot]
-        return sorted([(player_locations[location_id][1], player_locations[location_id][0]) for
-                        location_id in player_locations if
-                        location_id not in checked])
+        return sorted([player_locations[location_id][0] for
+                       location_id in player_locations if
+                       location_id not in checked])
 
 
 if typing.TYPE_CHECKING:  # type-check with pure python implementation until we have a typing stub

Options.py

@@ -786,22 +786,17 @@ class VerifyKeys(metaclass=FreezeValidKeys):
     verify_location_name: bool = False
     value: typing.Any
 
-    def verify_keys(self) -> None:
-        if self.valid_keys:
-            data = set(self.value)
-            dataset = set(word.casefold() for word in data) if self.valid_keys_casefold else set(data)
-            extra = dataset - self._valid_keys
+    @classmethod
+    def verify_keys(cls, data: typing.Iterable[str]) -> None:
+        if cls.valid_keys:
+            data = set(data)
+            dataset = set(word.casefold() for word in data) if cls.valid_keys_casefold else set(data)
+            extra = dataset - cls._valid_keys
             if extra:
-                raise OptionError(
-                    f"Found unexpected key {', '.join(extra)} in {getattr(self, 'display_name', self)}. "
-                    f"Allowed keys: {self._valid_keys}."
-                )
+                raise Exception(f"Found unexpected key {', '.join(extra)} in {cls}. "
+                                f"Allowed keys: {cls._valid_keys}.")
 
     def verify(self, world: typing.Type[World], player_name: str, plando_options: "PlandoOptions") -> None:
-        try:
-            self.verify_keys()
-        except OptionError as validation_error:
-            raise OptionError(f"Player {player_name} has invalid option keys:\n{validation_error}")
         if self.convert_name_groups and self.verify_item_name:
             new_value = type(self.value)()  # empty container of whatever value is
             for item_name in self.value:
@@ -838,6 +833,7 @@ class OptionDict(Option[typing.Dict[str, typing.Any]], VerifyKeys, typing.Mappin
     @classmethod
     def from_any(cls, data: typing.Dict[str, typing.Any]) -> OptionDict:
         if type(data) == dict:
+            cls.verify_keys(data)
             return cls(data)
         else:
             raise NotImplementedError(f"Cannot Convert from non-dictionary, got {type(data)}")
@@ -883,6 +879,7 @@ class OptionList(Option[typing.List[typing.Any]], VerifyKeys):
     @classmethod
     def from_any(cls, data: typing.Any):
         if is_iterable_except_str(data):
+            cls.verify_keys(data)
             return cls(data)
         return cls.from_text(str(data))
 
@@ -908,6 +905,7 @@ class OptionSet(Option[typing.Set[str]], VerifyKeys):
     @classmethod
     def from_any(cls, data: typing.Any):
         if is_iterable_except_str(data):
+            cls.verify_keys(data)
             return cls(data)
         return cls.from_text(str(data))
 
@@ -950,19 +948,6 @@ class PlandoTexts(Option[typing.List[PlandoText]], VerifyKeys):
             self.value = []
             logging.warning(f"The plando texts module is turned off, "
                             f"so text for {player_name} will be ignored.")
-        else:
-            super().verify(world, player_name, plando_options)
-
-    def verify_keys(self) -> None:
-        if self.valid_keys:
-            data = set(text.at for text in self)
-            dataset = set(word.casefold() for word in data) if self.valid_keys_casefold else set(data)
-            extra = dataset - self._valid_keys
-            if extra:
-                raise OptionError(
-                    f"Invalid \"at\" placement {', '.join(extra)} in {getattr(self, 'display_name', self)}. "
-                    f"Allowed placements: {self._valid_keys}."
-                )
 
     @classmethod
     def from_any(cls, data: PlandoTextsFromAnyType) -> Self:
@@ -986,6 +971,7 @@ class PlandoTexts(Option[typing.List[PlandoText]], VerifyKeys):
                         texts.append(text)
                 else:
                     raise Exception(f"Cannot create plando text from non-dictionary type, got {type(text)}")
+            cls.verify_keys([text.at for text in texts])
             return cls(texts)
         else:
             raise NotImplementedError(f"Cannot Convert from non-list, got {type(data)}")
@@ -1158,35 +1144,18 @@ class PlandoConnections(Option[typing.List[PlandoConnection]], metaclass=Connect
 
 
 class Accessibility(Choice):
-    """
-    Set rules for reachability of your items/locations.
-    
-    **Full:** ensure everything can be reached and acquired.
+    """Set rules for reachability of your items/locations.
 
-    **Minimal:** ensure what is needed to reach your goal can be acquired.
+    - **Locations:** ensure everything can be reached and acquired.
+    - **Items:** ensure all logically relevant items can be acquired.
+    - **Minimal:** ensure what is needed to reach your goal can be acquired.
     """
     display_name = "Accessibility"
     rich_text_doc = True
-    option_full = 0
+    option_locations = 0
+    option_items = 1
     option_minimal = 2
     alias_none = 2
-    alias_locations = 0
-    alias_items = 0
-    default = 0
-
-
-class ItemsAccessibility(Accessibility):
-    """
-    Set rules for reachability of your items/locations.
-    
-    **Full:** ensure everything can be reached and acquired.
-
-    **Minimal:** ensure what is needed to reach your goal can be acquired.
-
-    **Items:** ensure all logically relevant items can be acquired. Some items, such as keys, may be self-locking, and
-    some locations may be inaccessible.
-    """
-    option_items = 1
     default = 1
 
 
@@ -1236,7 +1205,6 @@ class CommonOptions(metaclass=OptionsMetaProperty):
         :param option_names: names of the options to return
         :param casing: case of the keys to return. Supports `snake`, `camel`, `pascal`, `kebab`
         """
-        assert option_names, "options.as_dict() was used without any option names."
         option_results = {}
         for option_name in option_names:
             if option_name in type(self).type_hints:
@@ -1518,3 +1486,31 @@ def generate_yaml_templates(target_folder: typing.Union[str, "pathlib.Path"], ge
 
             with open(os.path.join(target_folder, game_name + ".yaml"), "w", encoding="utf-8-sig") as f:
                 f.write(res)
+
+
+if __name__ == "__main__":
+
+    from worlds.alttp.Options import Logic
+    import argparse
+
+    map_shuffle = Toggle
+    compass_shuffle = Toggle
+    key_shuffle = Toggle
+    big_key_shuffle = Toggle
+    hints = Toggle
+    test = argparse.Namespace()
+    test.logic = Logic.from_text("no_logic")
+    test.map_shuffle = map_shuffle.from_text("ON")
+    test.hints = hints.from_text('OFF')
+    try:
+        test.logic = Logic.from_text("overworld_glitches_typo")
+    except KeyError as e:
+        print(e)
+    try:
+        test.logic_owg = Logic.from_text("owg")
+    except KeyError as e:
+        print(e)
+    if test.map_shuffle:
+        print("map_shuffle is on")
+    print(f"Hints are {bool(test.hints)}")
+    print(test)

README.md

@@ -72,10 +72,6 @@ Currently, the following games are supported:
 * Aquaria
 * Yu-Gi-Oh! Ultimate Masters: World Championship Tournament 2006
 * A Hat in Time
-* Old School Runescape
-* Kingdom Hearts 1
-* Mega Man 2
-* Yacht Dice
 
 For setup and instructions check out our [tutorials page](https://archipelago.gg/tutorial/).
 Downloads can be found at [Releases](https://github.com/ArchipelagoMW/Archipelago/releases), including compiled

WebHost.py

@@ -1,4 +1,3 @@
-import argparse
 import os
 import multiprocessing
 import logging
@@ -32,15 +31,6 @@ def get_app() -> "Flask":
         import yaml
         app.config.from_file(configpath, yaml.safe_load)
         logging.info(f"Updated config from {configpath}")
-    # inside get_app() so it's usable in systems like gunicorn, which do not run WebHost.py, but import it.
-    parser = argparse.ArgumentParser()
-    parser.add_argument('--config_override', default=None,
-                        help="Path to yaml config file that overrules config.yaml.")
-    args = parser.parse_known_args()[0]
-    if args.config_override:
-        import yaml
-        app.config.from_file(os.path.abspath(args.config_override), yaml.safe_load)
-        logging.info(f"Updated config from {args.config_override}")
     if not app.config["HOST_ADDRESS"]:
         logging.info("Getting public IP, as HOST_ADDRESS is empty.")
         app.config["HOST_ADDRESS"] = Utils.get_public_ipv4()

WebHostLib/customserver.py

@@ -72,14 +72,6 @@ class WebHostContext(Context):
         self.video = {}
         self.tags = ["AP", "WebHost"]
 
-    def __del__(self):
-        try:
-            import psutil
-            from Utils import format_SI_prefix
-            self.logger.debug(f"Context destroyed, Mem: {format_SI_prefix(psutil.Process().memory_info().rss, 1024)}iB")
-        except ImportError:
-            self.logger.debug("Context destroyed")
-
     def _load_game_data(self):
         for key, value in self.static_server_data.items():
             # NOTE: attributes are mutable and shared, so they will have to be copied before being modified
@@ -257,7 +249,6 @@ def run_server_process(name: str, ponyconfig: dict, static_server_data: dict,
                 ctx = WebHostContext(static_server_data, logger)
                 ctx.load(room_id)
                 ctx.init_save()
-                assert ctx.server is None
                 try:
                     ctx.server = websockets.serve(
                         functools.partial(server, ctx=ctx), ctx.host, ctx.port, ssl=ssl_context)
@@ -288,7 +279,6 @@ def run_server_process(name: str, ponyconfig: dict, static_server_data: dict,
                     ctx.auto_shutdown = Room.get(id=room_id).timeout
                 if ctx.saving:
                     setattr(asyncio.current_task(), "save", lambda: ctx._save(True))
-                assert ctx.shutdown_task is None
                 ctx.shutdown_task = asyncio.create_task(auto_shutdown(ctx, []))
                 await ctx.shutdown_task
 
@@ -335,7 +325,7 @@ def run_server_process(name: str, ponyconfig: dict, static_server_data: dict,
         def run(self):
             while 1:
                 next_room = rooms_to_run.get(block=True,  timeout=None)
-                gc.collect()
+                gc.collect(0)
                 task = asyncio.run_coroutine_threadsafe(start_room(next_room), loop)
                 self._tasks.append(task)
                 task.add_done_callback(self._done)

WebHostLib/options.py

@@ -231,13 +231,6 @@ def generate_yaml(game: str):
 
                 del options[key]
 
-            # Detect keys which end with -range, indicating a NamedRange with a possible custom value
-            elif key_parts[-1].endswith("-range"):
-                if options[key_parts[-1][:-6]] == "custom":
-                    options[key_parts[-1][:-6]] = val
-
-                del options[key]
-
         # Detect random-* keys and set their options accordingly
         for key, val in options.copy().items():
             if key.startswith("random-"):

WebHostLib/requirements.txt

@@ -1,11 +1,10 @@
 flask>=3.0.3
-werkzeug>=3.0.4
-pony>=0.7.19
+werkzeug>=3.0.3
+pony>=0.7.17
 waitress>=3.0.0
 Flask-Caching>=2.3.0
 Flask-Compress>=1.15
-Flask-Limiter>=3.8.0
+Flask-Limiter>=3.7.0
 bokeh>=3.1.1; python_version <= '3.8'
-bokeh>=3.4.3; python_version == '3.9'
-bokeh>=3.5.2; python_version >= '3.10'
+bokeh>=3.4.1; python_version >= '3.9'
 markupsafe>=2.1.5

WebHostLib/static/assets/faq/faq_en.md

@@ -77,4 +77,4 @@ There, you will find examples of games in the `worlds` folder:
 You may also find developer documentation in the `docs` folder:  
 [/docs Folder in Archipelago Code](https://github.com/ArchipelagoMW/Archipelago/tree/main/docs).
 
-If you have more questions, feel free to ask in the **#ap-world-dev** channel on our Discord.
+If you have more questions, feel free to ask in the **#archipelago-dev** channel on our Discord.

WebHostLib/templates/playerOptions/macros.html

@@ -54,7 +54,7 @@
 {% macro NamedRange(option_name, option) %}
     {{ OptionTitle(option_name, option) }}
     <div class="named-range-container">
-        <select id="{{ option_name }}-select" name="{{ option_name }}" data-option-name="{{ option_name }}" {{ "disabled" if option.default == "random" }}>
+        <select id="{{ option_name }}-select" data-option-name="{{ option_name }}" {{ "disabled" if option.default == "random" }}>
             {% for key, val in option.special_range_names.items() %}
                 {% if option.default == val %}
                     <option value="{{ val }}" selected>{{ key|replace("_", " ")|title }} ({{ val }})</option>
@@ -64,17 +64,17 @@
             {% endfor %}
             <option value="custom" hidden>Custom</option>
         </select>
-        <div class="named-range-wrapper js-required">
+        <div class="named-range-wrapper">
             <input
                     type="range"
                     id="{{ option_name }}"
-                    name="{{ option_name }}-range"
+                    name="{{ option_name }}"
                     min="{{ option.range_start }}"
                     max="{{ option.range_end }}"
                     value="{{ option.default | default(option.range_start) if option.default != "random" else option.range_start }}"
                     {{ "disabled" if option.default == "random" }}
             />
-            <span id="{{ option_name }}-value" class="range-value">
+            <span id="{{ option_name }}-value" class="range-value js-required">
                 {{ option.default | default(option.range_start) if option.default != "random" else option.range_start }}
             </span>
             {{ RandomizeButton(option_name, option) }}

WebHostLib/templates/playerOptions/playerOptions.html

@@ -11,7 +11,7 @@
     <noscript>
         <style>
             .js-required{
-                display: none !important;
+                display: none;
             }
         </style>
     </noscript>

WebHostLib/templates/weightedOptions/macros.html

@@ -138,7 +138,7 @@
                     id="{{ option_name }}-{{ key }}"
                     name="{{ option_name }}||{{ key }}"
                     value="1"
-                    {{ "checked" if key in option.default }}
+                    checked="{{ "checked" if key in option.default else "" }}"
                 />
                 <label for="{{ option_name }}-{{ key }}">
                     {{ key }}

WebHostLib/tracker.py

@@ -79,7 +79,7 @@ class TrackerData:
 
             # Normal lookup tables as well.
             self.item_name_to_id[game] = game_package["item_name_to_id"]
-            self.location_name_to_id[game] = game_package["location_name_to_id"]
+            self.location_name_to_id[game] = game_package["item_name_to_id"]
 
     def get_seed_name(self) -> str:
         """Retrieves the seed name."""

_speedups.pyx

@@ -287,15 +287,15 @@ cdef class LocationStore:
                     entry in self.entries[start:start + count] if
                     entry.location not in checked]
 
-    def get_remaining(self, state: State, team: int, slot: int) -> List[Tuple[int, int]]:
+    def get_remaining(self, state: State, team: int, slot: int) -> List[int]:
         cdef LocationEntry* entry
         cdef ap_player_t sender = slot
         cdef size_t start = self.sender_index[sender].start
         cdef size_t count = self.sender_index[sender].count
         cdef set checked = state[team, slot]
-        return sorted([(entry.receiver, entry.item) for
-                        entry in self.entries[start:start+count] if
-                        entry.location not in checked])
+        return sorted([entry.item for
+                       entry in self.entries[start:start+count] if
+                       entry.location not in checked])
 
 
 @cython.auto_pickle(False)

docs/CODEOWNERS

@@ -78,9 +78,6 @@
 # Kirby's Dream Land 3
 /worlds/kdl3/ @Silvris
 
-# Kingdom Hearts
-/worlds/kh1/ @gaithern
-
 # Kingdom Hearts 2
 /worlds/kh2/ @JaredWeakStrike
 
@@ -106,9 +103,6 @@
 # Minecraft
 /worlds/minecraft/ @KonoTyran @espeon65536
 
-# Mega Man 2
-/worlds/mm2/ @Silvris
-
 # MegaMan Battle Network 3
 /worlds/mmbn3/ @digiholic
 
@@ -118,8 +112,8 @@
 # Noita
 /worlds/noita/ @ScipioWright @heinermann
 
-# Old School Runescape
-/worlds/osrs @digiholic
+# Ocarina of Time
+/worlds/oot/ @espeon65536
 
 # Overcooked! 2
 /worlds/overcooked2/ @toasterparty
@@ -199,9 +193,6 @@
 # The Witness
 /worlds/witness/ @NewSoupVi @blastron
 
-# Yacht Dice
-/worlds/yachtdice/ @spinerak
-
 # Yoshi's Island
 /worlds/yoshisisland/ @PinkSwitch
 
@@ -227,9 +218,6 @@
 # Links Awakening DX
 # /worlds/ladx/
 
-# Ocarina of Time
-# /worlds/oot/
-
 ## Disabled Unmaintained Worlds
 
 # The following worlds in this repo are currently unmaintained and disabled as they do not work in core. If you are

docs/apworld_dev_faq.md

@@ -43,3 +43,26 @@ A faster alternative to the `for` loop would be to use a [list comprehension](ht
 ```py
 item_pool += [self.create_filler() for _ in range(total_locations - len(item_pool))]
 ```
+
+---
+
+### I learned about indirect conditions in the world API document, but I want to know more. What are they and why are they necessary?
+
+The world API document mentions indirect conditions and **when** you should use them, but not *how* they work and *why* they are necessary. This is because the explanation is quite complicated.
+
+Region sweep (the algorithm that determines which regions are reachable) is a Breadth-First Search of the region graph from the origin region, checking entrances one by one and adding newly reached nodes (regions) and their entrances to the queue until there is nothing more to check.
+
+For performance reasons, AP only checks every entrance once. However, if an entrance's access condition depends on regions, then it is possible for this to happen:
+1. An entrance that depends on a region is checked and determined to be nontraversable because the region hasn't been reached yet during the graph search.
+2. After that, the region is reached by the graph search.
+
+The entrance *would* now be determined to be traversable if it were rechecked, but it is not.
+To account for this case, AP would have to recheck all entrances every time a new region is reached until no new regions are reached.
+
+However, there is a way to **manually** define that a *specific* entrance needs to be rechecked during region sweep if a *specific* region is reached during it. This is what an indirect condition is.
+This keeps almost all of the performance upsides. Even a game making heavy use of indirect conditions (See: The Witness) is still significantly faster than if it just blanket "rechecked all entrances until nothing new is found".
+The reason entrance access rules using `location.can_reach` and `entrance.can_reach` are also affected is simple: They call `region.can_reach` on their respective parent/source region.
+
+We recognize it can feel like a trap since it will not alert you when you are missing an indirect condition, and that some games have very complex access rules.
+As of [PR #3682 (Core: Region handling customization)](https://github.com/ArchipelagoMW/Archipelago/pull/3682) being merged, it is also possible for a world to opt out of indirect conditions entirely, although it does come at a flat performance cost.
+It should only be used by games that *really* need it. For most games, it should be reasonable to know all entrance → region dependencies, and in this case, indirect conditions are still preferred because they are faster.

docs/network protocol.md

@@ -702,18 +702,14 @@ GameData is a **dict** but contains these keys and values. It's broken out into
 | checksum            | str            | A checksum hash of this game's data.                                                                                          |
 
 ### Tags
-Tags are represented as a list of strings, the common client tags follow:
+Tags are represented as a list of strings, the common Client tags follow:
 
-| Name      | Notes                                                                                                                                |
-|-----------|--------------------------------------------------------------------------------------------------------------------------------------|
-| AP        | Signifies that this client is a reference client, its usefulness is mostly in debugging to compare client behaviours more easily.    |
-| DeathLink | Client participates in the DeathLink mechanic, therefore will send and receive DeathLink bounce packets.                             |
-| HintGame  | Indicates the client is a hint game, made to send hints instead of locations. Special join/leave message,¹ `game` is optional.²      |
-| Tracker   | Indicates the client is a tracker, made to track instead of sending locations. Special join/leave message,¹ `game` is optional.²     |
-| TextOnly  | Indicates the client is a basic client, made to chat instead of sending locations. Special join/leave message,¹ `game` is optional.² |
-
-¹: When connecting or disconnecting, the chat message shows e.g. "tracking".\
-²: Allows `game` to be empty or null in [Connect](#connect). Game and version validation will then be skipped.
+| Name       | Notes                                                                                                                                                                                                              |
+|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| AP         | Signifies that this client is a reference client, its usefulness is mostly in debugging to compare client behaviours more easily.                                                                                  |
+| DeathLink  | Client participates in the DeathLink mechanic, therefore will send and receive DeathLink bounce packets                                                                                                            |
+| Tracker    | Tells the server that this client will not send locations and is actually a Tracker. When specified and used with empty or null `game` in [Connect](#connect), game and game's version validation will be skipped. |
+| TextOnly   | Tells the server that this client will not send locations and is intended for chat. When specified and used with empty or null `game` in [Connect](#connect), game and game's version validation will be skipped.  |
 
 ### DeathLink
 A special kind of Bounce packet that can be supported by any AP game. It targets the tag "DeathLink" and carries the following data:

docs/options api.md

@@ -24,7 +24,7 @@ display as `Value1` on the webhost.
 files, and both will resolve as `value1`. This should be used when changing options around, i.e. changing a Toggle to a
 Choice, and defining `alias_true = option_full`.
 - All options with a fixed set of possible values (i.e. those which inherit from `Toggle`, `(Text)Choice` or
-`(Named)Range`) support `random` as a generic option. `random` chooses from any of the available values for that
+`(Named/Special)Range`) support `random` as a generic option. `random` chooses from any of the available values for that
 option, and is reserved by AP. You can set this as your default value, but you cannot define your own `option_random`.
 However, you can override `from_text` and handle `text == "random"` to customize its behavior or
 implement it for additional option types.
@@ -129,23 +129,6 @@ class Difficulty(Choice):
     default = 1
 ```
 
-### Option Visibility
-Every option has a Visibility IntFlag, defaulting to `all` (`0b1111`). This lets you choose where the option will be
-displayed. This only impacts where options are displayed, not how they can be used. Hidden options are still valid
-options in a yaml. The flags are as follows:
-* `none` (`0b0000`): This option is not shown anywhere
-* `template` (`0b0001`): This option shows up in template yamls
-* `simple_ui` (`0b0010`): This option shows up on the options page
-* `complex_ui` (`0b0100`): This option shows up on the advanced/weighted options page
-* `spoiler` (`0b1000`): This option shows up in spoiler logs
-
-```python
-from Options import Choice, Visibility
-
-class HiddenChoiceOption(Choice):
-    visibility = Visibility.none
-```
-
 ### Option Groups
 Options may be categorized into groups for display on the WebHost. Option groups are displayed in the order specified
 by your world on the player-options and weighted-options pages. In the generated template files, there will be a comment

docs/running from source.md

@@ -8,7 +8,7 @@ use that version. These steps are for developers or platforms without compiled r
 
 What you'll need:
  * [Python 3.8.7 or newer](https://www.python.org/downloads/), not the Windows Store version
-   * Python 3.12.x is currently the newest supported version
+   * **Python 3.12 is currently unsupported**
  * pip: included in downloads from python.org, separate in many Linux distributions
  * Matching C compiler
    * possibly optional, read operating system specific sections
@@ -31,14 +31,14 @@ After this, you should be able to run the programs.
 
 Recommended steps
  * Download and install a "Windows installer (64-bit)" from the [Python download page](https://www.python.org/downloads)
-   * [read above](#General) which versions are supported
+   * **Python 3.12 is currently unsupported**
 
  * **Optional**: Download and install Visual Studio Build Tools from
    [Visual Studio Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/).
    * Refer to [Windows Compilers on the python wiki](https://wiki.python.org/moin/WindowsCompilers) for details. 
      Generally, selecting the box for "Desktop Development with C++" will provide what you need.
    * Build tools are not required if all modules are installed pre-compiled. Pre-compiled modules are pinned on
-     [Discord in #ap-core-dev](https://discord.com/channels/731205301247803413/731214280439103580/905154456377757808)
+     [Discord in #archipelago-dev](https://discord.com/channels/731205301247803413/731214280439103580/905154456377757808)
 
  * It is recommended to use [PyCharm IDE](https://www.jetbrains.com/pycharm/)
  * Run Generate.py which will prompt installation of missing modules, press enter to confirm

docs/world api.md

@@ -303,31 +303,6 @@ generation (entrance randomization).
 An access rule is a function that returns `True` or `False` for a `Location` or `Entrance` based on the current `state`
 (items that have been collected).
 
-The two possible ways to make a [CollectionRule](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/generic/Rules.py#L10) are:
-- `def rule(state: CollectionState) -> bool:`
-- `lambda state: ... boolean expression ...`
-
-An access rule can be assigned through `set_rule(location, rule)`.
-
-Access rules usually check for one of two things.
-- Items that have been collected (e.g. `state.has("Sword", player)`)
-- Locations, Regions or Entrances that have been reached (e.g. `state.can_reach_region("Boss Room")`)
-
-Keep in mind that entrances and locations implicitly check for the accessibility of their parent region, so you do not need to check explicitly for it.
-
-#### An important note on Entrance access rules:
-When using `state.can_reach` within an entrance access condition, you must also use `multiworld.register_indirect_condition`.
-
-For efficiency reasons, every time reachable regions are searched, every entrance is only checked once in a somewhat non-deterministic order.
-This is fine when checking for items using `state.has`, because items do not change during a region sweep.
-However, `state.can_reach` checks for the very same thing we are updating: Regions.
-This can lead to non-deterministic behavior and, in the worst case, even generation failures.
-Even doing `state.can_reach_location` or `state.can_reach_entrance` is problematic, as these functions call `state.can_reach_region` on the respective parent region.
-
-**Therefore, it is considered unsafe to perform `state.can_reach` from within an access condition for an entrance**, unless you are checking for something that sits in the source region of the entrance.
-You can use `multiworld.register_indirect_condition(region, entrance)` to explicitly tell the generator that, when a given region becomes accessible, it is necessary to re-check a specific entrance.
-You **must** use `multiworld.register_indirect_condition` if you perform this kind of `can_reach` from an entrance access rule, unless you have a **very** good technical understanding of the relevant code and can reason why it will never lead to problems in your case.
-
 ### Item Rules
 
 An item rule is a function that returns `True` or `False` for a `Location` based on a single item. It can be used to
@@ -655,7 +630,7 @@ def set_rules(self) -> None:
 
 Custom methods can be defined for your logic rules. The access rule that ultimately gets assigned to the Location or
 Entrance should be
-a [`CollectionRule`](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/generic/Rules.py#L10).
+a [`CollectionRule`](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/generic/Rules.py#L9).
 Typically, this is done by defining a lambda expression on demand at the relevant bit, typically calling other
 functions, but this can also be achieved by defining a method with the appropriate format and assigning it directly.
 For an example, see [The Messenger](/worlds/messenger/rules.py).

docs/world maintainer.md

@@ -26,17 +26,8 @@ Unless these are shared between multiple people, we expect the following from ea
 ### Adding a World
 
 When we merge your world into the core Archipelago repository, you automatically become world maintainer unless you
-nominate someone else (i.e. there are multiple devs).
-
-### Being added as a maintainer to an existing implementation
-
-At any point, a world maintainer can approve the addition of another maintainer to their world.  
-In order to do this, either an existing maintainer or the new maintainer must open a PR updating the
-[CODEOWNERS](/docs/CODEOWNERS) file.  
-This change must be approved by all existing maintainers of the affected world, the new maintainer candidate, and
-one core maintainer.  
-To help the core team review the change, information about the new maintainer and their contributions should be
-included in the PR description.
+nominate someone else (i.e. there are multiple devs). You can define who is allowed to approve changes to your world
+in the [CODEOWNERS](/docs/CODEOWNERS) document.
 
 ### Getting Voted
 
@@ -44,7 +35,7 @@ When a world is unmaintained, the [core maintainers](https://github.com/orgs/Arc
 can vote for a new maintainer if there is a candidate.
 For a vote to pass, the majority of participating core maintainers must vote in the affirmative.
 The time limit is 1 week, but can end early if the majority is reached earlier.
-Voting shall be conducted on Discord in #ap-core-dev.
+Voting shall be conducted on Discord in #archipelago-dev.
 
 ## Dropping out
 
@@ -60,7 +51,7 @@ for example when they become unreachable.
 For a vote to pass, the majority of participating core maintainers must vote in the affirmative.
 The time limit is 2 weeks, but can end early if the majority is reached earlier AND the world maintainer was pinged and
 made their case or was pinged and has been unreachable for more than 2 weeks already.
-Voting shall be conducted on Discord in #ap-core-dev. Commits that are a direct result of the voting shall include
+Voting shall be conducted on Discord in #archipelago-dev. Commits that are a direct result of the voting shall include
 date, voting members and final result in the commit message.
 
 ## Handling of Unmaintained Worlds

inno_setup.iss

@@ -186,11 +186,6 @@ Root: HKCR; Subkey: "{#MyAppName}cv64patch";                     ValueData: "Arc
 Root: HKCR; Subkey: "{#MyAppName}cv64patch\DefaultIcon";         ValueData: "{app}\ArchipelagoBizHawkClient.exe,0";                                          ValueType: string; ValueName: "";
 Root: HKCR; Subkey: "{#MyAppName}cv64patch\shell\open\command";  ValueData: """{app}\ArchipelagoBizHawkClient.exe"" ""%1""";                                 ValueType: string; ValueName: "";
 
-Root: HKCR; Subkey: ".apmm2";                                   ValueData: "{#MyAppName}mm2patch";                               Flags: uninsdeletevalue; ValueType: string; ValueName: "";
-Root: HKCR; Subkey: "{#MyAppName}mm2patch";                     ValueData: "Archipelago Mega Man 2 Patch";                    Flags: uninsdeletekey;   ValueType: string; ValueName: "";
-Root: HKCR; Subkey: "{#MyAppName}mm2patch\DefaultIcon";         ValueData: "{app}\ArchipelagoBizHawkClient.exe,0";                                          ValueType: string; ValueName: "";
-Root: HKCR; Subkey: "{#MyAppName}mm2patch\shell\open\command";  ValueData: """{app}\ArchipelagoBizHawkClient.exe"" ""%1""";                                 ValueType: string; ValueName: "";
-
 Root: HKCR; Subkey: ".apladx";                                   ValueData: "{#MyAppName}ladxpatch";        Flags: uninsdeletevalue; ValueType: string;  ValueName: "";
 Root: HKCR; Subkey: "{#MyAppName}ladxpatch";                     ValueData: "Archipelago Links Awakening DX Patch"; Flags: uninsdeletekey;   ValueType: string;  ValueName: "";
 Root: HKCR; Subkey: "{#MyAppName}ladxpatch\DefaultIcon";         ValueData: "{app}\ArchipelagoLinksAwakeningClient.exe,0";                           ValueType: string;  ValueName: "";

kvui.py

@@ -5,8 +5,6 @@ import typing
 import re
 from collections import deque
 
-assert "kivy" not in sys.modules, "kvui should be imported before kivy for frozen compatibility"
-
 if sys.platform == "win32":
     import ctypes
 

requirements.txt

@@ -1,14 +1,14 @@
 colorama>=0.4.6
-websockets>=13.0.1
-PyYAML>=6.0.2
-jellyfish>=1.1.0
+websockets>=12.0
+PyYAML>=6.0.1
+jellyfish>=1.0.3
 jinja2>=3.1.4
 schema>=0.7.7
 kivy>=2.3.0
 bsdiff4>=1.2.4
 platformdirs>=4.2.2
-certifi>=2024.8.30
-cython>=3.0.11
+certifi>=2024.6.2
+cython>=3.0.10
 cymem>=2.0.8
-orjson>=3.10.7
-typing_extensions>=4.12.2
+orjson>=3.10.3
+typing_extensions>=4.12.1

setup.py

@@ -66,6 +66,7 @@ non_apworlds: set = {
     "Adventure",
     "ArchipIDLE",
     "Archipelago",
+    "ChecksFinder",
     "Clique",
     "Final Fantasy",
     "Lufia II Ancient Cave",

test/bases.py

@@ -23,8 +23,8 @@ class TestBase(unittest.TestCase):
         state = CollectionState(self.multiworld)
         for item in items:
             item.classification = ItemClassification.progression
-            state.collect(item, prevent_sweep=True)
-        state.sweep_for_advancements()
+            state.collect(item, event=True)
+        state.sweep_for_events()
         state.update_reachable_regions(1)
         self._state_cache[self.multiworld, tuple(items)] = state
         return state
@@ -221,8 +221,8 @@ class WorldTestBase(unittest.TestCase):
         if isinstance(items, Item):
             items = (items,)
         for item in items:
-            if item.location and item.advancement and item.location in self.multiworld.state.advancements:
-                self.multiworld.state.advancements.remove(item.location)
+            if item.location and item.advancement and item.location in self.multiworld.state.events:
+                self.multiworld.state.events.remove(item.location)
             self.multiworld.state.remove(item)
 
     def can_reach_location(self, location: str) -> bool:
@@ -293,11 +293,13 @@ class WorldTestBase(unittest.TestCase):
         if not (self.run_default_tests and self.constructed):
             return
         with self.subTest("Game", game=self.game, seed=self.multiworld.seed):
+            excluded = self.multiworld.worlds[self.player].options.exclude_locations.value
             state = self.multiworld.get_all_state(False)
             for location in self.multiworld.get_locations():
-                with self.subTest("Location should be reached", location=location.name):
-                    reachable = location.can_reach(state)
-                    self.assertTrue(reachable, f"{location.name} unreachable")
+                if location.name not in excluded:
+                    with self.subTest("Location should be reached", location=location.name):
+                        reachable = location.can_reach(state)
+                        self.assertTrue(reachable, f"{location.name} unreachable")
             with self.subTest("Beatable"):
                 self.multiworld.state = state
                 self.assertBeatable(True)

test/general/test_fill.py

@@ -174,8 +174,8 @@ class TestFillRestrictive(unittest.TestCase):
         player1 = generate_player_data(multiworld, 1, 3, 3)
         player2 = generate_player_data(multiworld, 2, 3, 3)
 
-        multiworld.worlds[player1.id].options.accessibility.value = Accessibility.option_minimal
-        multiworld.worlds[player2.id].options.accessibility.value = Accessibility.option_full
+        multiworld.accessibility[player1.id].value = multiworld.accessibility[player1.id].option_minimal
+        multiworld.accessibility[player2.id].value = multiworld.accessibility[player2.id].option_locations
 
         multiworld.completion_condition[player1.id] = lambda state: True
         multiworld.completion_condition[player2.id] = lambda state: state.has(player2.prog_items[2].name, player2.id)
@@ -192,7 +192,7 @@ class TestFillRestrictive(unittest.TestCase):
         location_pool = player1.locations[1:] + player2.locations
         item_pool = player1.prog_items[:-1] + player2.prog_items
         fill_restrictive(multiworld, multiworld.state, location_pool, item_pool)
-        multiworld.state.sweep_for_advancements()  # collect everything
+        multiworld.state.sweep_for_events()  # collect everything
 
         # all of player2's locations and items should be accessible (not all of player1's)
         for item in player2.prog_items:
@@ -443,8 +443,8 @@ class TestFillRestrictive(unittest.TestCase):
         item = player1.prog_items[0]
         item.code = None
         location.place_locked_item(item)
-        multiworld.state.sweep_for_advancements()
-        multiworld.state.sweep_for_advancements()
+        multiworld.state.sweep_for_events()
+        multiworld.state.sweep_for_events()
         self.assertTrue(multiworld.state.prog_items[item.player][item.name], "Sweep did not collect - Test flawed")
         self.assertEqual(multiworld.state.prog_items[item.player][item.name], 1, "Sweep collected multiple times")
 

test/general/test_options.py

@@ -1,6 +1,6 @@
 import unittest
 
-from BaseClasses import MultiWorld, PlandoOptions
+from BaseClasses import PlandoOptions
 from Options import ItemLinks
 from worlds.AutoWorld import AutoWorldRegister
 
@@ -47,15 +47,3 @@ class TestOptions(unittest.TestCase):
             self.assertIn("Bow", link.value[0]["item_pool"])
         
         # TODO test that the group created using these options has the items
-
-    def test_item_links_resolve(self):
-        """Test item link option resolves correctly."""
-        item_link_group = [{
-            "name": "ItemLinkTest",
-            "item_pool": ["Everything"],
-            "link_replacement": False,
-            "replacement_item": None,
-        }]
-        item_links = {1: ItemLinks.from_any(item_link_group), 2: ItemLinks.from_any(item_link_group)}
-        for link in item_links.values():
-            self.assertEqual(link.value[0], item_link_group[0])

test/general/test_reachability.py

@@ -14,18 +14,6 @@ class TestBase(unittest.TestCase):
             "Desert Northern Cliffs",  # on top of mountain, only reachable via OWG
             "Dark Death Mountain Bunny Descent Area"  # OWG Mountain descent
         },
-        # These Blasphemous regions are not reachable with default options
-        "Blasphemous": {
-            "D01Z04S13[SE]", # difficulty must be hard
-            "D01Z05S25[E]", # difficulty must be hard
-            "D02Z02S05[W]", # difficulty must be hard and purified_hand must be true
-            "D04Z01S06[E]", # purified_hand must be true
-            "D04Z02S02[NE]", # difficulty must be hard and purified_hand must be true
-            "D05Z01S11[SW]", # difficulty must be hard
-            "D06Z01S08[N]", # difficulty must be hard and purified_hand must be true
-            "D20Z02S11[NW]", # difficulty must be hard
-            "D20Z02S11[E]", # difficulty must be hard
-        },
         "Ocarina of Time": {
             "Prelude of Light Warp",  # Prelude is not progression by default
             "Serenade of Water Warp",  # Serenade is not progression by default
@@ -49,10 +37,12 @@ class TestBase(unittest.TestCase):
             unreachable_regions = self.default_settings_unreachable_regions.get(game_name, set())
             with self.subTest("Game", game=game_name):
                 multiworld = setup_solo_multiworld(world_type)
+                excluded = multiworld.worlds[1].options.exclude_locations.value
                 state = multiworld.get_all_state(False)
                 for location in multiworld.get_locations():
-                    with self.subTest("Location should be reached", location=location.name):
-                        self.assertTrue(location.can_reach(state), f"{location.name} unreachable")
+                    if location.name not in excluded:
+                        with self.subTest("Location should be reached", location=location.name):
+                            self.assertTrue(location.can_reach(state), f"{location.name} unreachable")
 
                 for region in multiworld.get_regions():
                     if region.name in unreachable_regions:

test/multiworld/test_multiworlds.py

@@ -55,7 +55,7 @@ class TestAllGamesMultiworld(MultiworldTestBase):
         all_worlds = list(AutoWorldRegister.world_types.values())
         self.multiworld = setup_multiworld(all_worlds, ())
         for world in self.multiworld.worlds.values():
-            world.options.accessibility.value = Accessibility.option_full
+            world.options.accessibility.value = Accessibility.option_locations
         self.assertSteps(gen_steps)
         with self.subTest("filling multiworld", seed=self.multiworld.seed):
             distribute_items_restrictive(self.multiworld)
@@ -66,10 +66,10 @@ class TestAllGamesMultiworld(MultiworldTestBase):
 class TestTwoPlayerMulti(MultiworldTestBase):
     def test_two_player_single_game_fills(self) -> None:
         """Tests that a multiworld of two players for each registered game world can generate."""
-        for world_type in AutoWorldRegister.world_types.values():
-            self.multiworld = setup_multiworld([world_type, world_type], ())
+        for world in AutoWorldRegister.world_types.values():
+            self.multiworld = setup_multiworld([world, world], ())
             for world in self.multiworld.worlds.values():
-                world.options.accessibility.value = Accessibility.option_full
+                world.options.accessibility.value = Accessibility.option_locations
             self.assertSteps(gen_steps)
         with self.subTest("filling multiworld", seed=self.multiworld.seed):
             distribute_items_restrictive(self.multiworld)

test/netutils/test_location_store.py

@@ -130,9 +130,9 @@ class Base:
 
         def test_get_remaining(self) -> None:
             self.assertEqual(self.store.get_remaining(full_state, 0, 1), [])
-            self.assertEqual(self.store.get_remaining(one_state, 0, 1), [(1, 13), (2, 21)])
-            self.assertEqual(self.store.get_remaining(empty_state, 0, 1), [(1, 13), (2, 21), (2, 22)])
-            self.assertEqual(self.store.get_remaining(empty_state, 0, 3), [(4, 99)])
+            self.assertEqual(self.store.get_remaining(one_state, 0, 1), [13, 21])
+            self.assertEqual(self.store.get_remaining(empty_state, 0, 1), [13, 21, 22])
+            self.assertEqual(self.store.get_remaining(empty_state, 0, 3), [99])
 
         def test_location_set_intersection(self) -> None:
             locations = {10, 11, 12}

worlds/AutoWorld.py

@@ -292,14 +292,6 @@ class World(metaclass=AutoWorldRegister):
     web: ClassVar[WebWorld] = WebWorld()
     """see WebWorld for options"""
 
-    origin_region_name: str = "Menu"
-    """Name of the Region from which accessibility is tested."""
-
-    explicit_indirect_conditions: bool = True
-    """If True, the world implementation is supposed to use MultiWorld.register_indirect_condition() correctly.
-    If False, everything is rechecked at every step, which is slower computationally, 
-    but may be desirable in complex/dynamic worlds."""
-
     multiworld: "MultiWorld"
     """autoset on creation. The MultiWorld object for the currently generating multiworld."""
     player: int

worlds/LauncherComponents.py

@@ -132,8 +132,7 @@ def _install_apworld(apworld_src: str = "") -> Optional[Tuple[pathlib.Path, path
             break
     if found_already_loaded:
         raise Exception(f"Installed APWorld successfully, but '{module_name}' is already loaded,\n"
-                        "so a Launcher restart is required to use the new installation.\n"
-                        "If the Launcher is not open, no action needs to be taken.")
+                        "so a Launcher restart is required to use the new installation.")
     world_source = worlds.WorldSource(str(target), is_zip=True)
     bisect.insort(worlds.world_sources, world_source)
     world_source.load()

worlds/__init__.py

@@ -73,12 +73,7 @@ class WorldSource:
                 else:  # TODO: remove with 3.8 support
                     mod = importer.load_module(os.path.basename(self.path).rsplit(".", 1)[0])
 
-                if mod.__package__ is not None:
-                    mod.__package__ = f"worlds.{mod.__package__}"
-                else:
-                    # load_module does not populate package, we'll have to assume mod.__name__ is correct here
-                    # probably safe to remove with 3.8 support
-                    mod.__package__ = f"worlds.{mod.__name__}"
+                mod.__package__ = f"worlds.{mod.__package__}"
                 mod.__name__ = f"worlds.{mod.__name__}"
                 sys.modules[mod.__name__] = mod
                 with warnings.catch_warnings():

worlds/ahit/Items.py

@@ -39,7 +39,7 @@ def create_itempool(world: "HatInTimeWorld") -> List[Item]:
                 continue
         else:
             if name == "Scooter Badge":
-                if world.options.CTRLogic == CTRLogic.option_scooter or get_difficulty(world) >= Difficulty.MODERATE:
+                if world.options.CTRLogic is CTRLogic.option_scooter or get_difficulty(world) >= Difficulty.MODERATE:
                     item_type = ItemClassification.progression
             elif name == "No Bonk Badge" and world.is_dw():
                 item_type = ItemClassification.progression

worlds/ahit/Regions.py

@@ -659,10 +659,6 @@ def is_valid_act_combo(world: "HatInTimeWorld", entrance_act: Region,
             if exit_act.name not in chapter_finales:
                 return False
 
-    exit_chapter: str = act_chapters.get(exit_act.name)
-    # make sure that certain time rift combinations never happen
-    always_block: bool = exit_chapter != "Mafia Town" and exit_chapter != "Subcon Forest"
-    if not ignore_certain_rules or always_block:
         if entrance_act.name in rift_access_regions and exit_act.name in rift_access_regions[entrance_act.name]:
             return False
 
@@ -688,12 +684,9 @@ def is_valid_first_act(world: "HatInTimeWorld", act: Region) -> bool:
     if act.name not in guaranteed_first_acts:
         return False
 
-    if world.options.ActRandomizer == ActRandomizer.option_light and "Time Rift" in act.name:
-        return False
-
     # If there's only a single level in the starting chapter, only allow Mafia Town or Subcon Forest levels
     start_chapter = world.options.StartingChapter
-    if start_chapter == ChapterIndex.ALPINE or start_chapter == ChapterIndex.SUBCON:
+    if start_chapter is ChapterIndex.ALPINE or start_chapter is ChapterIndex.SUBCON:
         if "Time Rift" in act.name:
             return False
 
@@ -730,8 +723,7 @@ def is_valid_first_act(world: "HatInTimeWorld", act: Region) -> bool:
     elif act.name == "Contractual Obligations" and world.options.ShuffleSubconPaintings:
         return False
 
-    if world.options.ShuffleSubconPaintings and "Time Rift" not in act.name \
-       and act_chapters.get(act.name, "") == "Subcon Forest":
+    if world.options.ShuffleSubconPaintings and act_chapters.get(act.name, "") == "Subcon Forest":
         # Only allow Subcon levels if painting skips are allowed
         if diff < Difficulty.MODERATE or world.options.NoPaintingSkips:
             return False
@@ -968,35 +960,40 @@ def get_act_by_number(world: "HatInTimeWorld", chapter_name: str, num: int) -> R
 def create_thug_shops(world: "HatInTimeWorld"):
     min_items: int = world.options.NyakuzaThugMinShopItems.value
     max_items: int = world.options.NyakuzaThugMaxShopItems.value
-
-    thug_location_counts: Dict[str, int] = {}
+    count = -1
+    step = 0
+    old_name = ""
 
     for key, data in shop_locations.items():
-        thug_name = data.nyakuza_thug
-        if thug_name == "":
-            # Different shop type.
+        if data.nyakuza_thug == "":
             continue
 
-        if thug_name not in world.nyakuza_thug_items:
-            shop_item_count = world.random.randint(min_items, max_items)
-            world.nyakuza_thug_items[thug_name] = shop_item_count
-        else:
-            shop_item_count = world.nyakuza_thug_items[thug_name]
-
-        if shop_item_count <= 0:
+        if old_name != "" and old_name == data.nyakuza_thug:
             continue
 
-        location_count = thug_location_counts.setdefault(thug_name, 0)
-        if location_count >= shop_item_count:
-            # Already created all the locations for this thug.
-            continue
+        try:
+            if world.nyakuza_thug_items[data.nyakuza_thug] <= 0:
+                continue
+        except KeyError:
+            pass
 
-        # Create the shop location.
-        region = world.multiworld.get_region(data.region, world.player)
-        loc = HatInTimeLocation(world.player, key, data.id, region)
-        region.locations.append(loc)
-        world.shop_locs.append(loc.name)
-        thug_location_counts[thug_name] = location_count + 1
+        if count == -1:
+            count = world.random.randint(min_items, max_items)
+            world.nyakuza_thug_items.setdefault(data.nyakuza_thug, count)
+            if count <= 0:
+                continue
+
+        if count >= 1:
+            region = world.multiworld.get_region(data.region, world.player)
+            loc = HatInTimeLocation(world.player, key, data.id, region)
+            region.locations.append(loc)
+            world.shop_locs.append(loc.name)
+
+            step += 1
+            if step >= count:
+                old_name = data.nyakuza_thug
+                step = 0
+                count = -1
 
 
 def create_events(world: "HatInTimeWorld") -> int:

worlds/ahit/Rules.py

@@ -1,6 +1,7 @@
 from worlds.AutoWorld import CollectionState
 from worlds.generic.Rules import add_rule, set_rule
-from .Locations import location_table, zipline_unlocks, is_location_valid, shop_locations, event_locs
+from .Locations import location_table, zipline_unlocks, is_location_valid, contract_locations, \
+    shop_locations, event_locs
 from .Types import HatType, ChapterIndex, hat_type_to_item, Difficulty, HitType
 from BaseClasses import Location, Entrance, Region
 from typing import TYPE_CHECKING, List, Callable, Union, Dict
@@ -147,14 +148,14 @@ def set_rules(world: "HatInTimeWorld"):
     if world.is_dlc1():
         chapter_list.append(ChapterIndex.CRUISE)
 
-    if world.is_dlc2() and final_chapter != ChapterIndex.METRO:
+    if world.is_dlc2() and final_chapter is not ChapterIndex.METRO:
         chapter_list.append(ChapterIndex.METRO)
 
     chapter_list.remove(starting_chapter)
     world.random.shuffle(chapter_list)
 
     # Make sure Alpine is unlocked before any DLC chapters are, as the Alpine door needs to be open to access them
-    if starting_chapter != ChapterIndex.ALPINE and (world.is_dlc1() or world.is_dlc2()):
+    if starting_chapter is not ChapterIndex.ALPINE and (world.is_dlc1() or world.is_dlc2()):
         index1 = 69
         index2 = 69
         pos: int
@@ -164,7 +165,7 @@ def set_rules(world: "HatInTimeWorld"):
         if world.is_dlc1():
             index1 = chapter_list.index(ChapterIndex.CRUISE)
 
-        if world.is_dlc2() and final_chapter != ChapterIndex.METRO:
+        if world.is_dlc2() and final_chapter is not ChapterIndex.METRO:
             index2 = chapter_list.index(ChapterIndex.METRO)
 
         lowest_index = min(index1, index2)
@@ -241,6 +242,9 @@ def set_rules(world: "HatInTimeWorld"):
         if not is_location_valid(world, key):
             continue
 
+        if key in contract_locations.keys():
+            continue
+
         loc = world.multiworld.get_location(key, world.player)
 
         for hat in data.required_hats:
@@ -252,7 +256,7 @@ def set_rules(world: "HatInTimeWorld"):
         if data.paintings > 0 and world.options.ShuffleSubconPaintings:
             add_rule(loc, lambda state, paintings=data.paintings: has_paintings(state, world, paintings))
 
-        if data.hit_type != HitType.none and world.options.UmbrellaLogic:
+        if data.hit_type is not HitType.none and world.options.UmbrellaLogic:
             if data.hit_type == HitType.umbrella:
                 add_rule(loc, lambda state: state.has("Umbrella", world.player))
 
@@ -381,8 +385,8 @@ def set_moderate_rules(world: "HatInTimeWorld"):
              lambda state: can_use_hat(state, world, HatType.ICE), "or")
 
     # Moderate: Clock Tower Chest + Ruined Tower with nothing
-    set_rule(world.multiworld.get_location("Mafia Town - Clock Tower Chest", world.player), lambda state: True)
-    set_rule(world.multiworld.get_location("Mafia Town - Top of Ruined Tower", world.player), lambda state: True)
+    add_rule(world.multiworld.get_location("Mafia Town - Clock Tower Chest", world.player), lambda state: True)
+    add_rule(world.multiworld.get_location("Mafia Town - Top of Ruined Tower", world.player), lambda state: True)
 
     # Moderate: enter and clear The Subcon Well without Hookshot and without hitting the bell
     for loc in world.multiworld.get_region("The Subcon Well", world.player).locations:
@@ -432,8 +436,8 @@ def set_moderate_rules(world: "HatInTimeWorld"):
 
     if world.is_dlc1():
         # Moderate: clear Rock the Boat without Ice Hat
-        set_rule(world.multiworld.get_location("Rock the Boat - Post Captain Rescue", world.player), lambda state: True)
-        set_rule(world.multiworld.get_location("Act Completion (Rock the Boat)", world.player), lambda state: True)
+        add_rule(world.multiworld.get_location("Rock the Boat - Post Captain Rescue", world.player), lambda state: True)
+        add_rule(world.multiworld.get_location("Act Completion (Rock the Boat)", world.player), lambda state: True)
 
         # Moderate: clear Deep Sea without Ice Hat
         set_rule(world.multiworld.get_location("Act Completion (Time Rift - Deep Sea)", world.player),
@@ -514,7 +518,7 @@ def set_hard_rules(world: "HatInTimeWorld"):
                  lambda state: can_use_hat(state, world, HatType.ICE))
 
         # Hard: clear Rush Hour with Brewing Hat only
-        if world.options.NoTicketSkips != NoTicketSkips.option_true:
+        if world.options.NoTicketSkips is not NoTicketSkips.option_true:
             set_rule(world.multiworld.get_location("Act Completion (Rush Hour)", world.player),
                      lambda state: can_use_hat(state, world, HatType.BREWING))
         else:
@@ -855,9 +859,6 @@ def set_rift_rules(world: "HatInTimeWorld", regions: Dict[str, Region]):
 
     for entrance in regions["Time Rift - Alpine Skyline"].entrances:
         add_rule(entrance, lambda state: has_relic_combo(state, world, "Crayon"))
-        if entrance.parent_region.name == "Alpine Free Roam":
-            add_rule(entrance,
-                     lambda state: can_use_hookshot(state, world) and can_hit(state, world, umbrella_only=True))
 
     if world.is_dlc1():
         for entrance in regions["Time Rift - Balcony"].entrances:
@@ -936,9 +937,6 @@ def set_default_rift_rules(world: "HatInTimeWorld"):
 
     for entrance in world.multiworld.get_region("Time Rift - Alpine Skyline", world.player).entrances:
         add_rule(entrance, lambda state: has_relic_combo(state, world, "Crayon"))
-        if entrance.parent_region.name == "Alpine Free Roam":
-            add_rule(entrance,
-                     lambda state: can_use_hookshot(state, world) and can_hit(state, world, umbrella_only=True))
 
     if world.is_dlc1():
         for entrance in world.multiworld.get_region("Time Rift - Balcony", world.player).entrances:

worlds/ahit/__init__.py

@@ -1,16 +1,15 @@
 from BaseClasses import Item, ItemClassification, Tutorial, Location, MultiWorld
 from .Items import item_table, create_item, relic_groups, act_contracts, create_itempool, get_shop_trap_name, \
-    calculate_yarn_costs, alps_hooks
+    calculate_yarn_costs
 from .Regions import create_regions, randomize_act_entrances, chapter_act_info, create_events, get_shuffled_region
 from .Locations import location_table, contract_locations, is_location_valid, get_location_names, TASKSANITY_START_ID, \
     get_total_locations
-from .Rules import set_rules, has_paintings
+from .Rules import set_rules
 from .Options import AHITOptions, slot_data_options, adjust_options, RandomizeHatOrder, EndGoal, create_option_groups
-from .Types import HatType, ChapterIndex, HatInTimeItem, hat_type_to_item, Difficulty
+from .Types import HatType, ChapterIndex, HatInTimeItem, hat_type_to_item
 from .DeathWishLocations import create_dw_regions, dw_classes, death_wishes
 from .DeathWishRules import set_dw_rules, create_enemy_events, hit_list, bosses
 from worlds.AutoWorld import World, WebWorld, CollectionState
-from worlds.generic.Rules import add_rule
 from typing import List, Dict, TextIO
 from worlds.LauncherComponents import Component, components, icon_paths, launch_subprocess, Type
 from Utils import local_path
@@ -87,27 +86,19 @@ class HatInTimeWorld(World):
         if self.is_dw_only():
             return
 
-        # Take care of some extremely restrictive starts in other chapters with act shuffle off
-        if not self.options.ActRandomizer:
-            start_chapter = self.options.StartingChapter
-            if start_chapter == ChapterIndex.ALPINE:
-                self.multiworld.push_precollected(self.create_item("Hookshot Badge"))
-                if self.options.UmbrellaLogic:
-                    self.multiworld.push_precollected(self.create_item("Umbrella"))
+        # If our starting chapter is 4 and act rando isn't on, force hookshot into inventory
+        # If starting chapter is 3 and painting shuffle is enabled, and act rando isn't, give one free painting unlock
+        start_chapter: ChapterIndex = ChapterIndex(self.options.StartingChapter)
 
-                if self.options.ShuffleAlpineZiplines:
-                    ziplines = list(alps_hooks.keys())
-                    ziplines.remove("Zipline Unlock - The Twilight Bell Path")  # not enough checks from this one
-                    self.multiworld.push_precollected(self.create_item(self.random.choice(ziplines)))
-            elif start_chapter == ChapterIndex.SUBCON:
-                if self.options.ShuffleSubconPaintings:
-                    self.multiworld.push_precollected(self.create_item("Progressive Painting Unlock"))
-            elif start_chapter == ChapterIndex.BIRDS:
-                if self.options.UmbrellaLogic:
-                    if self.options.LogicDifficulty < Difficulty.EXPERT:
+        if start_chapter == ChapterIndex.ALPINE or start_chapter == ChapterIndex.SUBCON:
+            if not self.options.ActRandomizer:
+                if start_chapter == ChapterIndex.ALPINE:
+                    self.multiworld.push_precollected(self.create_item("Hookshot Badge"))
+                    if self.options.UmbrellaLogic:
                         self.multiworld.push_precollected(self.create_item("Umbrella"))
-                elif self.options.LogicDifficulty < Difficulty.MODERATE:
-                    self.multiworld.push_precollected(self.create_item("Umbrella"))
+
+                if start_chapter == ChapterIndex.SUBCON and self.options.ShuffleSubconPaintings:
+                    self.multiworld.push_precollected(self.create_item("Progressive Painting Unlock"))
 
     def create_regions(self):
         # noinspection PyClassVar
@@ -128,10 +119,7 @@ class HatInTimeWorld(World):
         # place vanilla contract locations if contract shuffle is off
         if not self.options.ShuffleActContracts:
             for name in contract_locations.keys():
-                loc = self.get_location(name)
-                loc.place_locked_item(create_item(self, name))
-                if self.options.ShuffleSubconPaintings and loc.name != "Snatcher's Contract - The Subcon Well":
-                    add_rule(loc, lambda state: has_paintings(state, self, 1))
+                self.multiworld.get_location(name, self.player).place_locked_item(create_item(self, name))
 
     def create_items(self):
         if self.has_yarn():
@@ -329,7 +317,7 @@ class HatInTimeWorld(World):
 
     def remove(self, state: "CollectionState", item: "Item") -> bool:
         old_count: int = state.count(item.name, self.player)
-        change = super().remove(state, item)
+        change = super().collect(state, item)
         if change and old_count == 1:
             if "Stamp" in item.name:
                 if "2 Stamp" in item.name:

worlds/alttp/Dungeons.py

@@ -248,7 +248,7 @@ def fill_dungeons_restrictive(multiworld: MultiWorld):
                     pass
             for item in pre_fill_items:
                 multiworld.worlds[item.player].collect(all_state_base, item)
-            all_state_base.sweep_for_advancements()
+            all_state_base.sweep_for_events()
 
             # Remove completion condition so that minimal-accessibility worlds place keys properly
             for player in {item.player for item in in_dungeon_items}:
@@ -262,8 +262,8 @@ def fill_dungeons_restrictive(multiworld: MultiWorld):
                         all_state_base.remove(item_factory(key_data[3], multiworld.worlds[player]))
                         loc = multiworld.get_location(key_loc, player)
 
-                        if loc in all_state_base.advancements:
-                            all_state_base.advancements.remove(loc)
+                        if loc in all_state_base.events:
+                            all_state_base.events.remove(loc)
             fill_restrictive(multiworld, all_state_base, locations, in_dungeon_items, lock=True, allow_excluded=True,
                              name="LttP Dungeon Items")
 

worlds/alttp/ItemPool.py

@@ -682,7 +682,7 @@ def get_pool_core(world, player: int):
     if 'triforce_hunt' in goal:
 
         if world.triforce_pieces_mode[player].value == TriforcePiecesMode.option_extra:
-            treasure_hunt_total = (world.triforce_pieces_required[player].value
+            treasure_hunt_total = (world.triforce_pieces_available[player].value
                                    + world.triforce_pieces_extra[player].value)
         elif world.triforce_pieces_mode[player].value == TriforcePiecesMode.option_percentage:
             percentage = float(world.triforce_pieces_percentage[player].value) / 100

worlds/alttp/Options.py

@@ -1,8 +1,8 @@
 import typing
 
 from BaseClasses import MultiWorld
-from Options import Choice, Range, DeathLink, DefaultOnToggle, FreeText, ItemsAccessibility, Option, \
-    PlandoBosses, PlandoConnections, PlandoTexts, Removed, StartInventoryPool, Toggle
+from Options import Choice, Range, Option, Toggle, DefaultOnToggle, DeathLink, \
+    StartInventoryPool, PlandoBosses, PlandoConnections, PlandoTexts, FreeText, Removed
 from .EntranceShuffle import default_connections, default_dungeon_connections, \
     inverted_default_connections, inverted_default_dungeon_connections
 from .Text import TextTable
@@ -743,7 +743,6 @@ class ALttPPlandoTexts(PlandoTexts):
 
 
 alttp_options: typing.Dict[str, type(Option)] = {
-    "accessibility": ItemsAccessibility,
     "plando_connections": ALttPPlandoConnections,
     "plando_texts": ALttPPlandoTexts,
     "start_inventory_from_pool": StartInventoryPool,

worlds/alttp/Rules.py

@@ -2,7 +2,6 @@ import collections
 import logging
 from typing import Iterator, Set
 
-from Options import ItemsAccessibility
 from BaseClasses import Entrance, MultiWorld
 from worlds.generic.Rules import (add_item_rule, add_rule, forbid_item,
                                   item_name_in_location_names, location_item_name, set_rule, allow_self_locking_items)
@@ -40,7 +39,7 @@ def set_rules(world):
         else:
             # Set access rules according to max glitches for multiworld progression.
             # Set accessibility to none, and shuffle assuming the no logic players can always win
-            world.accessibility[player].value = ItemsAccessibility.option_minimal
+            world.accessibility[player] = world.accessibility[player].from_text("minimal")
             world.progression_balancing[player].value = 0
 
     else:
@@ -378,7 +377,7 @@ def global_rules(multiworld: MultiWorld, player: int):
                                 or state.has("Cane of Somaria", player)))
     set_rule(multiworld.get_location('Tower of Hera - Big Chest', player), lambda state: state.has('Big Key (Tower of Hera)', player))
     set_rule(multiworld.get_location('Tower of Hera - Big Key Chest', player), lambda state: has_fire_source(state, player))
-    if multiworld.accessibility[player] != 'full':
+    if multiworld.accessibility[player] != 'locations':
         set_always_allow(multiworld.get_location('Tower of Hera - Big Key Chest', player), lambda state, item: item.name == 'Small Key (Tower of Hera)' and item.player == player)
 
     set_rule(multiworld.get_entrance('Swamp Palace Moat', player), lambda state: state.has('Flippers', player) and state.has('Open Floodgate', player))
@@ -394,7 +393,7 @@ def global_rules(multiworld: MultiWorld, player: int):
         if state.has('Hookshot', player)
         else state._lttp_has_key('Small Key (Swamp Palace)', player, 4))
     set_rule(multiworld.get_location('Swamp Palace - Big Chest', player), lambda state: state.has('Big Key (Swamp Palace)', player))
-    if multiworld.accessibility[player] != 'full':
+    if multiworld.accessibility[player] != 'locations':
         allow_self_locking_items(multiworld.get_location('Swamp Palace - Big Chest', player), 'Big Key (Swamp Palace)')
     set_rule(multiworld.get_entrance('Swamp Palace (North)', player), lambda state: state.has('Hookshot', player) and state._lttp_has_key('Small Key (Swamp Palace)', player, 5))
     if not multiworld.small_key_shuffle[player] and multiworld.glitches_required[player] not in ['hybrid_major_glitches', 'no_logic']:
@@ -412,7 +411,7 @@ def global_rules(multiworld: MultiWorld, player: int):
              lambda state: ((state._lttp_has_key('Small Key (Thieves Town)', player, 3)) or (location_item_name(state, 'Thieves\' Town - Big Chest', player) == ("Small Key (Thieves Town)", player)) and state._lttp_has_key('Small Key (Thieves Town)', player, 2)) and state.has('Hammer', player))
     set_rule(multiworld.get_location('Thieves\' Town - Blind\'s Cell', player),
              lambda state: state._lttp_has_key('Small Key (Thieves Town)', player))
-    if multiworld.accessibility[player] != 'full' and not multiworld.key_drop_shuffle[player]:
+    if multiworld.accessibility[player] != 'locations' and not multiworld.key_drop_shuffle[player]:
         set_always_allow(multiworld.get_location('Thieves\' Town - Big Chest', player), lambda state, item: item.name == 'Small Key (Thieves Town)' and item.player == player)
     set_rule(multiworld.get_location('Thieves\' Town - Attic', player), lambda state: state._lttp_has_key('Small Key (Thieves Town)', player, 3))
     set_rule(multiworld.get_location('Thieves\' Town - Spike Switch Pot Key', player),
@@ -424,7 +423,7 @@ def global_rules(multiworld: MultiWorld, player: int):
     set_rule(multiworld.get_entrance('Skull Woods First Section West Door', player), lambda state: state._lttp_has_key('Small Key (Skull Woods)', player, 5))
     set_rule(multiworld.get_entrance('Skull Woods First Section (Left) Door to Exit', player), lambda state: state._lttp_has_key('Small Key (Skull Woods)', player, 5))
     set_rule(multiworld.get_location('Skull Woods - Big Chest', player), lambda state: state.has('Big Key (Skull Woods)', player) and can_use_bombs(state, player))
-    if multiworld.accessibility[player] != 'full':
+    if multiworld.accessibility[player] != 'locations':
         allow_self_locking_items(multiworld.get_location('Skull Woods - Big Chest', player), 'Big Key (Skull Woods)')
     set_rule(multiworld.get_entrance('Skull Woods Torch Room', player), lambda state: state._lttp_has_key('Small Key (Skull Woods)', player, 4) and state.has('Fire Rod', player) and has_sword(state, player))  # sword required for curtain
     add_rule(multiworld.get_location('Skull Woods - Prize', player), lambda state: state._lttp_has_key('Small Key (Skull Woods)', player, 5))
@@ -523,12 +522,12 @@ def global_rules(multiworld: MultiWorld, player: int):
 
     set_rule(multiworld.get_entrance('Palace of Darkness Big Key Chest Staircase', player), lambda state: can_use_bombs(state, player) and (state._lttp_has_key('Small Key (Palace of Darkness)', player, 6) or (
             location_item_name(state, 'Palace of Darkness - Big Key Chest', player) in [('Small Key (Palace of Darkness)', player)] and state._lttp_has_key('Small Key (Palace of Darkness)', player, 3))))
-    if multiworld.accessibility[player] != 'full':
+    if multiworld.accessibility[player] != 'locations':
         set_always_allow(multiworld.get_location('Palace of Darkness - Big Key Chest', player), lambda state, item: item.name == 'Small Key (Palace of Darkness)' and item.player == player and state._lttp_has_key('Small Key (Palace of Darkness)', player, 5))
 
     set_rule(multiworld.get_entrance('Palace of Darkness Spike Statue Room Door', player), lambda state: state._lttp_has_key('Small Key (Palace of Darkness)', player, 6) or (
             location_item_name(state, 'Palace of Darkness - Harmless Hellway', player) in [('Small Key (Palace of Darkness)', player)] and state._lttp_has_key('Small Key (Palace of Darkness)', player, 4)))
-    if multiworld.accessibility[player] != 'full':
+    if multiworld.accessibility[player] != 'locations':
         set_always_allow(multiworld.get_location('Palace of Darkness - Harmless Hellway', player), lambda state, item: item.name == 'Small Key (Palace of Darkness)' and item.player == player and state._lttp_has_key('Small Key (Palace of Darkness)', player, 5))
 
     set_rule(multiworld.get_entrance('Palace of Darkness Maze Door', player), lambda state: state._lttp_has_key('Small Key (Palace of Darkness)', player, 6))
@@ -547,7 +546,7 @@ def global_rules(multiworld: MultiWorld, player: int):
                 location_item_name(state, 'Ganons Tower - Map Chest', player) in [('Big Key (Ganons Tower)', player)] and state._lttp_has_key('Small Key (Ganons Tower)', player, 6)))
 
     # this seemed to be causing generation failure, disable for now
-    # if world.accessibility[player] != 'full':
+    # if world.accessibility[player] != 'locations':
     #     set_always_allow(world.get_location('Ganons Tower - Map Chest', player), lambda state, item: item.name == 'Small Key (Ganons Tower)' and item.player == player and state._lttp_has_key('Small Key (Ganons Tower)', player, 7) and state.can_reach('Ganons Tower (Hookshot Room)', 'region', player))
 
     # It is possible to need more than 6 keys to get through this entrance if you spend keys elsewhere. We reflect this in the chest requirements.
@@ -1201,7 +1200,7 @@ def set_trock_key_rules(world, player):
                 # Must not go in the Chain Chomps chest - only 2 other chests available and 3+ keys required for all other chests
                 forbid_item(world.get_location('Turtle Rock - Chain Chomps', player), 'Big Key (Turtle Rock)', player)
                 forbid_item(world.get_location('Turtle Rock - Pokey 2 Key Drop', player), 'Big Key (Turtle Rock)', player)
-            if world.accessibility[player] == 'full':
+            if world.accessibility[player] == 'locations':
                 if world.big_key_shuffle[player] and can_reach_big_chest:
                     # Must not go in the dungeon - all 3 available chests (Chomps, Big Chest, Crystaroller) must be keys to access laser bridge, and the big key is required first
                     for location in ['Turtle Rock - Chain Chomps', 'Turtle Rock - Compass Chest',
@@ -1215,7 +1214,7 @@ def set_trock_key_rules(world, player):
                     location.place_locked_item(item)
                     toss_junk_item(world, player)
 
-    if world.accessibility[player] != 'full':
+    if world.accessibility[player] != 'locations':
         set_always_allow(world.get_location('Turtle Rock - Big Key Chest', player), lambda state, item: item.name == 'Small Key (Turtle Rock)' and item.player == player
                 and state.can_reach(state.multiworld.get_region('Turtle Rock (Second Section)', player)))
 

worlds/alttp/SubClasses.py

@@ -76,6 +76,10 @@ class ALttPItem(Item):
         if self.type in {"SmallKey", "BigKey", "Map", "Compass"}:
             return self.type
 
+    @property
+    def locked_dungeon_item(self):
+        return self.location.locked and self.dungeon_item
+
 
 class LTTPRegionType(IntEnum):
     LightWorld = 1

worlds/alttp/__init__.py

@@ -356,8 +356,6 @@ class ALTTPWorld(World):
                 self.dungeon_local_item_names |= self.item_name_groups[option.item_name_group]
                 if option == "original_dungeon":
                     self.dungeon_specific_item_names |= self.item_name_groups[option.item_name_group]
-                else:
-                    self.options.local_items.value |= self.dungeon_local_item_names
 
         self.difficulty_requirements = difficulties[multiworld.item_pool[player].current_key]
 

worlds/alttp/docs/plando_en.md

@@ -2,8 +2,8 @@
 
 ## Configuration
 
-1. All plando options are enabled by default, except for "items plando" which has to be enabled before it can be used (opt-in).
-2. To enable it, go to your installation directory (Windows default: `C:\ProgramData\Archipelago`), then open the host.yaml
+1. Plando features have to be enabled first, before they can be used (opt-in).
+2. To do so, go to your installation directory (Windows default: `C:\ProgramData\Archipelago`), then open the host.yaml
    file with a text editor.
 3. In it, you're looking for the option key `plando_options`. To enable all plando modules you can set the value
    to `bosses, items, texts, connections`
@@ -66,7 +66,6 @@ boss_shuffle:
     - ignored if only one world is generated
     - can be a number, to target that slot in the multiworld
     - can be a name, to target that player's world
-    - can be a list of names, to target those players' worlds
     - can be true, to target any other player's world
     - can be false, to target own world and is the default
     - can be null, to target a random world
@@ -133,15 +132,17 @@ plando_items:
 
 ### Texts
 
+- This module is disabled by default.
 - Has the options `text`, `at`, and `percentage`
-- All of these options support subweights
 - percentage is the percentage chance for this text to be placed, can be omitted entirely for 100%
 - text is the text to be placed.
+    - can be weighted.
     - `\n` is a newline.
     - `@` is the entered player's name.
     - Warning: Text Mapper does not support full unicode.
     - [Alphabet](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Text.py#L758)
 - at is the location within the game to attach the text to.
+    - can be weighted.
     - [List of targets](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Text.py#L1499)
 
 #### Example
@@ -161,6 +162,7 @@ and `uncle_dying_sewer`, then places the text "This is a plando. You've been war
 
 ### Connections
 
+- This module is disabled by default.
 - Has the options `percentage`, `entrance`, `exit` and `direction`.
 - All options support subweights
 - percentage is the percentage chance for this to be connected, can be omitted entirely for 100%

worlds/alttp/test/dungeons/TestDungeon.py

@@ -54,7 +54,7 @@ class TestDungeon(LTTPTestBase):
 
                 for item in items:
                     item.classification = ItemClassification.progression
-                    state.collect(item, prevent_sweep=True)  # prevent_sweep=True prevents running sweep_for_advancements() and picking up
-                state.sweep_for_advancements()             # key drop keys repeatedly
+                    state.collect(item, event=True)  # event=True prevents running sweep_for_events() and picking up
+                state.sweep_for_events()             # key drop keys repeatedly
 
-                self.assertEqual(self.multiworld.get_location(location, 1).can_reach(state), access, f"failed {self.multiworld.get_location(location, 1)} with: {item_pool}")
+                self.assertEqual(self.multiworld.get_location(location, 1).can_reach(state), access, f"failed {self.multiworld.get_location(location, 1)} with: {item_pool}")

worlds/alttp/test/inverted/TestInverted.py

@@ -1,11 +1,11 @@
-from worlds.alttp.Dungeons import get_dungeon_item_pool
+from worlds.alttp.Dungeons import create_dungeons, get_dungeon_item_pool
 from worlds.alttp.EntranceShuffle import link_inverted_entrances
 from worlds.alttp.InvertedRegions import create_inverted_regions
 from worlds.alttp.ItemPool import difficulties
 from worlds.alttp.Items import item_factory
 from worlds.alttp.Regions import mark_light_world_regions
 from worlds.alttp.Shops import create_shops
-from test.bases import TestBase
+from test.TestBase import TestBase
 
 from worlds.alttp.test import LTTPTestBase
 

worlds/alttp/test/inverted_minor_glitches/TestInvertedMinor.py

@@ -6,7 +6,7 @@ from worlds.alttp.Items import item_factory
 from worlds.alttp.Options import GlitchesRequired
 from worlds.alttp.Regions import mark_light_world_regions
 from worlds.alttp.Shops import create_shops
-from test.bases import TestBase
+from test.TestBase import TestBase
 
 from worlds.alttp.test import LTTPTestBase
 

worlds/alttp/test/inverted_owg/TestInvertedOWG.py

@@ -6,7 +6,7 @@ from worlds.alttp.Items import item_factory
 from worlds.alttp.Options import GlitchesRequired
 from worlds.alttp.Regions import mark_light_world_regions
 from worlds.alttp.Shops import create_shops
-from test.bases import TestBase
+from test.TestBase import TestBase
 
 from worlds.alttp.test import LTTPTestBase
 

worlds/alttp/test/options/test_dungeon_fill.py

@@ -1,60 +0,0 @@
-from unittest import TestCase
-
-from BaseClasses import MultiWorld
-from test.general import gen_steps, setup_multiworld
-from worlds.AutoWorld import call_all
-from worlds.generic.Rules import locality_rules
-from ... import ALTTPWorld
-from ...Options import DungeonItem
-
-
-class DungeonFillTestBase(TestCase):
-    multiworld: MultiWorld
-    world_1: ALTTPWorld
-    world_2: ALTTPWorld
-    options = (
-        "big_key_shuffle",
-        "small_key_shuffle",
-        "key_drop_shuffle",
-        "compass_shuffle",
-        "map_shuffle",
-    )
-
-    def setUp(self):
-        self.multiworld = setup_multiworld([ALTTPWorld, ALTTPWorld], ())
-        self.world_1 = self.multiworld.worlds[1]
-        self.world_2 = self.multiworld.worlds[2]
-
-    def generate_with_options(self, option_value: int):
-        for option in self.options:
-            getattr(self.world_1.options, option).value = getattr(self.world_2.options, option).value = option_value
-
-        for step in gen_steps:
-            call_all(self.multiworld, step)
-            # this is where locality rules are set in normal generation which we need to verify this test
-            if step == "set_rules":
-                locality_rules(self.multiworld)
-
-    def test_original_dungeons(self):
-        self.generate_with_options(DungeonItem.option_original_dungeon)
-        for location in self.multiworld.get_filled_locations():
-            with (self.subTest(location=location)):
-                if location.parent_region.dungeon is None:
-                    self.assertIs(location.item.dungeon, None)
-                else:
-                    self.assertEqual(location.player, location.item.player,
-                                     f"{location.item} does not belong to {location}'s player")
-                    if location.item.dungeon is None:
-                        continue
-                    self.assertIs(location.item.dungeon, location.parent_region.dungeon,
-                                  f"{location.item} was not placed in its original dungeon.")
-
-    def test_own_dungeons(self):
-        self.generate_with_options(DungeonItem.option_own_dungeons)
-        for location in self.multiworld.get_filled_locations():
-            with self.subTest(location=location):
-                if location.parent_region.dungeon is None:
-                    self.assertIs(location.item.dungeon, None)
-                else:
-                    self.assertEqual(location.player, location.item.player,
-                                     f"{location.item} does not belong to {location}'s player")

worlds/apsudoku/__init__.py

@@ -4,7 +4,7 @@ from BaseClasses import Tutorial
 from ..AutoWorld import WebWorld, World
 
 class AP_SudokuWebWorld(WebWorld):
-    options_page = False
+    options_page = "games/Sudoku/info/en"
     theme = 'partyTime'
 
     setup_en = Tutorial(

worlds/apsudoku/docs/setup_en.md

@@ -1,7 +1,9 @@
 # APSudoku Setup Guide
 
 ## Required Software
-- [APSudoku](https://github.com/APSudoku/APSudoku)
+- [APSudoku](https://github.com/EmilyV99/APSudoku)
+- Windows (most tested on Win10)
+- Other platforms might be able to build from source themselves; and may be included in the future.
 
 ## General Concept
 
@@ -11,33 +13,25 @@ Does not need to be added at the start of a seed, as it does not create any slot
 
 ## Installation Procedures
 
-Go to the latest release from the [APSudoku Releases page](https://github.com/APSudoku/APSudoku/releases/latest). Download and extract the appropriate file for your platform.
+Go to the latest release from the [APSudoku Releases page](https://github.com/EmilyV99/APSudoku/releases). Download and extract the `APSudoku.zip` file.
 
 ## Joining a MultiWorld Game
 
-1. Run the APSudoku executable.
-2. Under `Settings` → `Connection` at the top-right:
-	- Enter the server address and port number
+1. Run APSudoku.exe
+2. Under the 'Archipelago' tab at the top-right:
+	- Enter the server url & port number
 	- Enter the name of the slot you wish to connect to
 	- Enter the room password (optional)
 	- Select DeathLink related settings (optional)
-	- Press `Connect`
-4. Under the `Sudoku` tab
-	- Choose puzzle difficulty
-	- Click `Start` to generate a puzzle
-5. Try to solve the Sudoku. Click `Check` when done
-	- A correct solution rewards you with 1 hint for a location in the world you are connected to
-	- An incorrect solution has no penalty, unless DeathLink is enabled (see below)
+	- Press connect
+3. Go back to the 'Sudoku' tab
+	- Click the various '?' buttons for information on how to play / control
+4. Choose puzzle difficulty
+5. Try to solve the Sudoku. Click 'Check' when done.
 
-Info:
-- You can set various settings under `Settings` → `Sudoku`, and can change the colors used under `Settings` → `Theme`.
-- While connected, you can view the `Console` and `Hints` tabs for standard TextClient-like features
-- You can also use the `Tracking` tab to view either a basic tracker or a valid [GodotAP tracker pack](https://github.com/EmilyV99/GodotAP/blob/main/tracker_packs/GET_PACKS.md)
-- While connected, the number of "unhinted" locations for your slot is shown in the upper-left of the the `Sudoku` tab. (If this reads 0, no further hints can be earned for this slot, as every locations is already hinted)
-- Click the various `?` buttons for information on controls/how to play
 ## DeathLink Support
 
-If `DeathLink` is enabled when you click `Connect`:
-- Lose a life if you check an incorrect puzzle (not an _incomplete_ puzzle- if any cells are empty, you get off with a warning), or if you quit a puzzle without solving it (including disconnecting).
-- Your life count is customizable (default 0). Dying with 0 lives left kills linked players AND resets your puzzle.
+If 'DeathLink' is enabled when you click 'Connect':
+- Lose a life if you check an incorrect puzzle (not an _incomplete_ puzzle- if any cells are empty, you get off with a warning), or quit a puzzle without solving it (including disconnecting).
+- Life count customizable (default 0). Dying with 0 lives left kills linked players AND resets your puzzle.
 - On receiving a DeathLink from another player, your puzzle resets. 

worlds/aquaria/Items.py

@@ -99,7 +99,7 @@ item_table = {
     "Mutant Costume": ItemData(698020, 1, ItemType.JUNK, ItemGroup.COLLECTIBLE),  # collectible_mutant_costume
     "Baby Nautilus": ItemData(698021, 1, ItemType.NORMAL, ItemGroup.UTILITY),  # collectible_nautilus
     "Baby Piranha": ItemData(698022, 1, ItemType.NORMAL, ItemGroup.UTILITY),  # collectible_piranha
-    "Arnassi Armor": ItemData(698023, 1, ItemType.PROGRESSION, ItemGroup.UTILITY),  # collectible_seahorse_costume
+    "Arnassi Armor": ItemData(698023, 1, ItemType.NORMAL, ItemGroup.UTILITY),  # collectible_seahorse_costume
     "Seed Bag": ItemData(698024, 1, ItemType.JUNK, ItemGroup.COLLECTIBLE),  # collectible_seed_bag
     "King's Skull": ItemData(698025, 1, ItemType.JUNK, ItemGroup.COLLECTIBLE),  # collectible_skull
     "Song Plant Spore": ItemData(698026, 1, ItemType.JUNK, ItemGroup.COLLECTIBLE),  # collectible_spore_seed

worlds/aquaria/Locations.py

@@ -45,7 +45,7 @@ class AquariaLocations:
         "Home Water, bulb below the grouper fish": 698058,
         "Home Water, bulb in the path below Nautilus Prime": 698059,
         "Home Water, bulb in the little room above the grouper fish": 698060,
-        "Home Water, bulb in the end of the path close to the Verse Cave": 698061,
+        "Home Water, bulb in the end of the left path from the Verse Cave": 698061,
         "Home Water, bulb in the top left path": 698062,
         "Home Water, bulb in the bottom left room": 698063,
         "Home Water, bulb close to Naija's Home": 698064,
@@ -67,7 +67,7 @@ class AquariaLocations:
 
     locations_song_cave = {
         "Song Cave, Erulian spirit": 698206,
-        "Song Cave, bulb in the top right part": 698071,
+        "Song Cave, bulb in the top left part": 698071,
         "Song Cave, bulb in the big anemone room": 698072,
         "Song Cave, bulb in the path to the singing statues": 698073,
         "Song Cave, bulb under the rock in the path to the singing statues": 698074,
@@ -152,9 +152,6 @@ class AquariaLocations:
 
     locations_arnassi_path = {
         "Arnassi Ruins, Arnassi Statue": 698164,
-    }
-
-    locations_arnassi_cave_transturtle = {
         "Arnassi Ruins, Transturtle": 698217,
     }
 
@@ -272,12 +269,9 @@ class AquariaLocations:
     }
 
     locations_forest_bl = {
-        "Kelp Forest bottom left area, Transturtle": 698212,
-    }
-
-    locations_forest_bl_sc = {
         "Kelp Forest bottom left area, bulb close to the spirit crystals": 698054,
         "Kelp Forest bottom left area, Walker Baby": 698186,
+        "Kelp Forest bottom left area, Transturtle": 698212,
     }
 
     locations_forest_br = {
@@ -376,7 +370,7 @@ class AquariaLocations:
 
     locations_sun_temple_r = {
         "Sun Temple, first bulb of the temple": 698091,
-        "Sun Temple, bulb on the right part": 698092,
+        "Sun Temple, bulb on the left part": 698092,
         "Sun Temple, bulb in the hidden room of the right part": 698093,
         "Sun Temple, Sun Key": 698182,
     }
@@ -408,9 +402,6 @@ class AquariaLocations:
         "Abyss right area, bulb in the middle path": 698110,
         "Abyss right area, bulb behind the rock in the middle path": 698111,
         "Abyss right area, bulb in the left green room": 698112,
-    }
-
-    locations_abyss_r_transturtle = {
         "Abyss right area, Transturtle": 698214,
     }
 
@@ -508,7 +499,6 @@ location_table = {
     **AquariaLocations.locations_skeleton_path_sc,
     **AquariaLocations.locations_arnassi,
     **AquariaLocations.locations_arnassi_path,
-    **AquariaLocations.locations_arnassi_cave_transturtle,
     **AquariaLocations.locations_arnassi_crab_boss,
     **AquariaLocations.locations_sun_temple_l,
     **AquariaLocations.locations_sun_temple_r,
@@ -519,7 +509,6 @@ location_table = {
     **AquariaLocations.locations_abyss_l,
     **AquariaLocations.locations_abyss_lb,
     **AquariaLocations.locations_abyss_r,
-    **AquariaLocations.locations_abyss_r_transturtle,
     **AquariaLocations.locations_energy_temple_1,
     **AquariaLocations.locations_energy_temple_2,
     **AquariaLocations.locations_energy_temple_3,
@@ -541,7 +530,6 @@ location_table = {
     **AquariaLocations.locations_forest_tr,
     **AquariaLocations.locations_forest_tr_fp,
     **AquariaLocations.locations_forest_bl,
-    **AquariaLocations.locations_forest_bl_sc,
     **AquariaLocations.locations_forest_br,
     **AquariaLocations.locations_forest_boss,
     **AquariaLocations.locations_forest_boss_entrance,

worlds/aquaria/Regions.py

@@ -14,112 +14,97 @@ from worlds.generic.Rules import add_rule, set_rule
 
 # Every condition to connect regions
 
-def _has_hot_soup(state: CollectionState, player: int) -> bool:
+def _has_hot_soup(state:CollectionState, player: int) -> bool:
     """`player` in `state` has the hotsoup item"""
-    return state.has_any({"Hot soup", "Hot soup x 2"}, player)
+    return state.has("Hot soup", player)
 
 
-def _has_tongue_cleared(state: CollectionState, player: int) -> bool:
+def _has_tongue_cleared(state:CollectionState, player: int) -> bool:
     """`player` in `state` has the Body tongue cleared item"""
     return state.has("Body tongue cleared", player)
 
 
-def _has_sun_crystal(state: CollectionState, player: int) -> bool:
+def _has_sun_crystal(state:CollectionState, player: int) -> bool:
     """`player` in `state` has the Sun crystal item"""
     return state.has("Has sun crystal", player) and _has_bind_song(state, player)
 
 
-def _has_li(state: CollectionState, player: int) -> bool:
+def _has_li(state:CollectionState, player: int) -> bool:
     """`player` in `state` has Li in its team"""
     return state.has("Li and Li song", player)
 
 
-def _has_damaging_item(state: CollectionState, player: int) -> bool:
+def _has_damaging_item(state:CollectionState, player: int) -> bool:
     """`player` in `state` has the shield song item"""
-    return state.has_any({"Energy form", "Nature form", "Beast form", "Li and Li song", "Baby Nautilus",
-                          "Baby Piranha", "Baby Blaster"}, player)
+    return state.has_any({"Energy form",  "Nature form", "Beast form", "Li and Li song", "Baby Nautilus",
+                         "Baby Piranha", "Baby Blaster"}, player)
 
 
-def _has_energy_attack_item(state: CollectionState, player: int) -> bool:
-    """`player` in `state` has items that can do a lot of damage (enough to beat bosses)"""
-    return _has_energy_form(state, player) or _has_dual_form(state, player)
-
-
-def _has_shield_song(state: CollectionState, player: int) -> bool:
+def _has_shield_song(state:CollectionState, player: int) -> bool:
     """`player` in `state` has the shield song item"""
     return state.has("Shield song", player)
 
 
-def _has_bind_song(state: CollectionState, player: int) -> bool:
+def _has_bind_song(state:CollectionState, player: int) -> bool:
     """`player` in `state` has the bind song item"""
     return state.has("Bind song", player)
 
 
-def _has_energy_form(state: CollectionState, player: int) -> bool:
+def _has_energy_form(state:CollectionState, player: int) -> bool:
     """`player` in `state` has the energy form item"""
     return state.has("Energy form", player)
 
 
-def _has_beast_form(state: CollectionState, player: int) -> bool:
+def _has_beast_form(state:CollectionState, player: int) -> bool:
     """`player` in `state` has the beast form item"""
     return state.has("Beast form", player)
 
 
-def _has_beast_and_soup_form(state: CollectionState, player: int) -> bool:
-    """`player` in `state` has the beast form item"""
-    return _has_beast_form(state, player) and _has_hot_soup(state, player)
-
-
-def _has_beast_form_or_arnassi_armor(state: CollectionState, player: int) -> bool:
-    """`player` in `state` has the beast form item"""
-    return _has_beast_form(state, player) or state.has("Arnassi Armor", player)
-
-
-def _has_nature_form(state: CollectionState, player: int) -> bool:
+def _has_nature_form(state:CollectionState, player: int) -> bool:
     """`player` in `state` has the nature form item"""
     return state.has("Nature form", player)
 
 
-def _has_sun_form(state: CollectionState, player: int) -> bool:
+def _has_sun_form(state:CollectionState, player: int) -> bool:
     """`player` in `state` has the sun form item"""
     return state.has("Sun form", player)
 
 
-def _has_light(state: CollectionState, player: int) -> bool:
+def _has_light(state:CollectionState, player: int) -> bool:
     """`player` in `state` has the light item"""
     return state.has("Baby Dumbo", player) or _has_sun_form(state, player)
 
 
-def _has_dual_form(state: CollectionState, player: int) -> bool:
+def _has_dual_form(state:CollectionState, player: int) -> bool:
     """`player` in `state` has the dual form item"""
     return _has_li(state, player) and state.has("Dual form", player)
 
 
-def _has_fish_form(state: CollectionState, player: int) -> bool:
+def _has_fish_form(state:CollectionState, player: int) -> bool:
     """`player` in `state` has the fish form item"""
     return state.has("Fish form", player)
 
 
-def _has_spirit_form(state: CollectionState, player: int) -> bool:
+def _has_spirit_form(state:CollectionState, player: int) -> bool:
     """`player` in `state` has the spirit form item"""
     return state.has("Spirit form", player)
 
 
-def _has_big_bosses(state: CollectionState, player: int) -> bool:
+def _has_big_bosses(state:CollectionState, player: int) -> bool:
     """`player` in `state` has beated every big bosses"""
     return state.has_all({"Fallen God beated", "Mithalan God beated", "Drunian God beated",
-                          "Sun God beated", "The Golem beated"}, player)
+                         "Sun God beated", "The Golem beated"}, player)
 
 
-def _has_mini_bosses(state: CollectionState, player: int) -> bool:
+def _has_mini_bosses(state:CollectionState, player: int) -> bool:
     """`player` in `state` has beated every big bosses"""
     return state.has_all({"Nautilus Prime beated", "Blaster Peg Prime beated", "Mergog beated",
-                          "Mithalan priests beated", "Octopus Prime beated", "Crabbius Maximus beated",
-                          "Mantis Shrimp Prime beated", "King Jellyfish God Prime beated"}, player)
+                         "Mithalan priests beated", "Octopus Prime beated", "Crabbius Maximus beated",
+                         "Mantis Shrimp Prime beated", "King Jellyfish God Prime beated"}, player)
 
 
-def _has_secrets(state: CollectionState, player: int) -> bool:
-    return state.has_all({"First secret obtained", "Second secret obtained", "Third secret obtained"}, player)
+def _has_secrets(state:CollectionState, player: int) -> bool:
+    return state.has_all({"First secret obtained", "Second secret obtained", "Third secret obtained"},player)
 
 
 class AquariaRegions:
@@ -149,7 +134,6 @@ class AquariaRegions:
     skeleton_path: Region
     skeleton_path_sc: Region
     arnassi: Region
-    arnassi_cave_transturtle: Region
     arnassi_path: Region
     arnassi_crab_boss: Region
     simon: Region
@@ -168,7 +152,6 @@ class AquariaRegions:
     forest_tr: Region
     forest_tr_fp: Region
     forest_bl: Region
-    forest_bl_sc: Region
     forest_br: Region
     forest_boss: Region
     forest_boss_entrance: Region
@@ -196,7 +179,6 @@ class AquariaRegions:
     abyss_l: Region
     abyss_lb: Region
     abyss_r: Region
-    abyss_r_transturtle: Region
     ice_cave: Region
     bubble_cave: Region
     bubble_cave_boss: Region
@@ -231,7 +213,7 @@ class AquariaRegions:
     """
 
     def __add_region(self, hint: str,
-                     locations: Optional[Dict[str, int]]) -> Region:
+                     locations: Optional[Dict[str, Optional[int]]]) -> Region:
         """
         Create a new Region, add it to the `world` regions and return it.
         Be aware that this function have a side effect on ``world`.`regions`
@@ -254,7 +236,7 @@ class AquariaRegions:
         self.home_water_nautilus = self.__add_region("Home Water, Nautilus nest",
                                                      AquariaLocations.locations_home_water_nautilus)
         self.home_water_transturtle = self.__add_region("Home Water, turtle room",
-                                                        AquariaLocations.locations_home_water_transturtle)
+                                                     AquariaLocations.locations_home_water_transturtle)
         self.naija_home = self.__add_region("Naija's Home", AquariaLocations.locations_naija_home)
         self.song_cave = self.__add_region("Song Cave", AquariaLocations.locations_song_cave)
 
@@ -298,8 +280,6 @@ class AquariaRegions:
         self.arnassi = self.__add_region("Arnassi Ruins", AquariaLocations.locations_arnassi)
         self.arnassi_path = self.__add_region("Arnassi Ruins, back entrance path",
                                               AquariaLocations.locations_arnassi_path)
-        self.arnassi_cave_transturtle = self.__add_region("Arnassi Ruins, transturtle area",
-                                                          AquariaLocations.locations_arnassi_cave_transturtle)
         self.arnassi_crab_boss = self.__add_region("Arnassi Ruins, Crabbius Maximus lair",
                                                    AquariaLocations.locations_arnassi_crab_boss)
 
@@ -322,9 +302,9 @@ class AquariaRegions:
                                              AquariaLocations.locations_cathedral_r)
         self.cathedral_underground = self.__add_region("Mithalas Cathedral underground",
                                                        AquariaLocations.locations_cathedral_underground)
-        self.cathedral_boss_r = self.__add_region("Mithalas Cathedral, Mithalan God room", None)
-        self.cathedral_boss_l = self.__add_region("Mithalas Cathedral, after Mithalan God room",
+        self.cathedral_boss_r = self.__add_region("Mithalas Cathedral, Mithalan God room",
                                                   AquariaLocations.locations_cathedral_boss)
+        self.cathedral_boss_l = self.__add_region("Mithalas Cathedral, after Mithalan God room", None)
 
     def __create_forest(self) -> None:
         """
@@ -340,8 +320,6 @@ class AquariaRegions:
                                               AquariaLocations.locations_forest_tr_fp)
         self.forest_bl = self.__add_region("Kelp Forest bottom left area",
                                            AquariaLocations.locations_forest_bl)
-        self.forest_bl_sc = self.__add_region("Kelp Forest bottom left area, spirit crystals",
-                                              AquariaLocations.locations_forest_bl_sc)
         self.forest_br = self.__add_region("Kelp Forest bottom right area",
                                            AquariaLocations.locations_forest_br)
         self.forest_sprite_cave = self.__add_region("Kelp Forest spirit cave",
@@ -397,9 +375,9 @@ class AquariaRegions:
         self.sun_temple_r = self.__add_region("Sun Temple right area",
                                               AquariaLocations.locations_sun_temple_r)
         self.sun_temple_boss_path = self.__add_region("Sun Temple before boss area",
-                                                      AquariaLocations.locations_sun_temple_boss_path)
+                                                    AquariaLocations.locations_sun_temple_boss_path)
         self.sun_temple_boss = self.__add_region("Sun Temple boss area",
-                                                 AquariaLocations.locations_sun_temple_boss)
+                                                   AquariaLocations.locations_sun_temple_boss)
 
     def __create_abyss(self) -> None:
         """
@@ -410,8 +388,6 @@ class AquariaRegions:
                                          AquariaLocations.locations_abyss_l)
         self.abyss_lb = self.__add_region("Abyss left bottom area", AquariaLocations.locations_abyss_lb)
         self.abyss_r = self.__add_region("Abyss right area", AquariaLocations.locations_abyss_r)
-        self.abyss_r_transturtle = self.__add_region("Abyss right area, transturtle",
-                                                     AquariaLocations.locations_abyss_r_transturtle)
         self.ice_cave = self.__add_region("Ice Cave", AquariaLocations.locations_ice_cave)
         self.bubble_cave = self.__add_region("Bubble Cave", AquariaLocations.locations_bubble_cave)
         self.bubble_cave_boss = self.__add_region("Bubble Cave boss area", AquariaLocations.locations_bubble_cave_boss)
@@ -431,7 +407,7 @@ class AquariaRegions:
         self.sunken_city_r = self.__add_region("Sunken City right area",
                                                AquariaLocations.locations_sunken_city_r)
         self.sunken_city_boss = self.__add_region("Sunken City boss area",
-                                                  AquariaLocations.locations_sunken_city_boss)
+                              AquariaLocations.locations_sunken_city_boss)
 
     def __create_body(self) -> None:
         """
@@ -451,7 +427,7 @@ class AquariaRegions:
         self.final_boss_tube = self.__add_region("The Body, final boss area turtle room",
                                                  AquariaLocations.locations_final_boss_tube)
         self.final_boss = self.__add_region("The Body, final boss",
-                                            AquariaLocations.locations_final_boss)
+                                                   AquariaLocations.locations_final_boss)
         self.final_boss_end = self.__add_region("The Body, final boss area", None)
 
     def __connect_one_way_regions(self, source_name: str, destination_name: str,
@@ -479,8 +455,8 @@ class AquariaRegions:
         """
         Connect entrances of the different regions around `home_water`
         """
-        self.__connect_one_way_regions("Menu", "Verse Cave right area",
-                                       self.menu, self.verse_cave_r)
+        self.__connect_regions("Menu", "Verse Cave right area",
+                               self.menu, self.verse_cave_r)
         self.__connect_regions("Verse Cave left area", "Verse Cave right area",
                                self.verse_cave_l, self.verse_cave_r)
         self.__connect_regions("Verse Cave", "Home Water", self.verse_cave_l, self.home_water)
@@ -488,8 +464,7 @@ class AquariaRegions:
         self.__connect_regions("Home Water", "Song Cave", self.home_water, self.song_cave)
         self.__connect_regions("Home Water", "Home Water, nautilus nest",
                                self.home_water, self.home_water_nautilus,
-                               lambda state: _has_energy_attack_item(state, self.player) and
-                                             _has_bind_song(state, self.player))
+                               lambda state: _has_energy_form(state, self.player) and _has_bind_song(state, self.player))
         self.__connect_regions("Home Water", "Home Water transturtle room",
                                self.home_water, self.home_water_transturtle)
         self.__connect_regions("Home Water", "Energy Temple first area",
@@ -497,7 +472,7 @@ class AquariaRegions:
                                lambda state: _has_bind_song(state, self.player))
         self.__connect_regions("Home Water", "Energy Temple_altar",
                                self.home_water, self.energy_temple_altar,
-                               lambda state: _has_energy_attack_item(state, self.player) and
+                               lambda state: _has_energy_form(state, self.player) and
                                              _has_bind_song(state, self.player))
         self.__connect_regions("Energy Temple first area", "Energy Temple second area",
                                self.energy_temple_1, self.energy_temple_2,
@@ -507,28 +482,28 @@ class AquariaRegions:
                                lambda state: _has_fish_form(state, self.player))
         self.__connect_regions("Energy Temple idol room", "Energy Temple boss area",
                                self.energy_temple_idol, self.energy_temple_boss,
-                               lambda state: _has_energy_attack_item(state, self.player) and
-                                             _has_fish_form(state, self.player))
+                               lambda state: _has_energy_form(state, self.player))
         self.__connect_one_way_regions("Energy Temple first area", "Energy Temple boss area",
                                        self.energy_temple_1, self.energy_temple_boss,
                                        lambda state: _has_beast_form(state, self.player) and
-                                                     _has_energy_attack_item(state, self.player))
+                                                     _has_energy_form(state, self.player))
         self.__connect_one_way_regions("Energy Temple boss area", "Energy Temple first area",
                                        self.energy_temple_boss, self.energy_temple_1,
-                                       lambda state: _has_energy_attack_item(state, self.player))
+                                       lambda state: _has_energy_form(state, self.player))
         self.__connect_regions("Energy Temple second area", "Energy Temple third area",
                                self.energy_temple_2, self.energy_temple_3,
-                               lambda state: _has_energy_form(state, self.player))
+                               lambda state: _has_bind_song(state, self.player) and
+                                             _has_energy_form(state, self.player))
         self.__connect_regions("Energy Temple boss area", "Energy Temple blaster room",
                                self.energy_temple_boss, self.energy_temple_blaster_room,
                                lambda state: _has_nature_form(state, self.player) and
                                              _has_bind_song(state, self.player) and
-                                             _has_energy_attack_item(state, self.player))
+                                             _has_energy_form(state, self.player))
         self.__connect_regions("Energy Temple first area", "Energy Temple blaster room",
                                self.energy_temple_1, self.energy_temple_blaster_room,
                                lambda state: _has_nature_form(state, self.player) and
                                              _has_bind_song(state, self.player) and
-                                             _has_energy_attack_item(state, self.player) and
+                                             _has_energy_form(state, self.player) and
                                              _has_beast_form(state, self.player))
         self.__connect_regions("Home Water", "Open Water top left area",
                                self.home_water, self.openwater_tl)
@@ -545,7 +520,7 @@ class AquariaRegions:
                                self.openwater_tl, self.forest_br)
         self.__connect_regions("Open Water top right area", "Open Water top right area, turtle room",
                                self.openwater_tr, self.openwater_tr_turtle,
-                               lambda state: _has_beast_form_or_arnassi_armor(state, self.player))
+                               lambda state: _has_beast_form(state, self.player))
         self.__connect_regions("Open Water top right area", "Open Water bottom right area",
                                self.openwater_tr, self.openwater_br)
         self.__connect_regions("Open Water top right area", "Mithalas City",
@@ -554,9 +529,10 @@ class AquariaRegions:
                                self.openwater_tr, self.veil_bl)
         self.__connect_one_way_regions("Open Water top right area", "Veil bottom right",
                                        self.openwater_tr, self.veil_br,
-                                       lambda state: _has_beast_form_or_arnassi_armor(state, self.player))
+                                       lambda state: _has_beast_form(state, self.player))
         self.__connect_one_way_regions("Veil bottom right", "Open Water top right area",
-                                       self.veil_br, self.openwater_tr)
+                                       self.veil_br, self.openwater_tr,
+                                       lambda state: _has_beast_form(state, self.player))
         self.__connect_regions("Open Water bottom left area", "Open Water bottom right area",
                                self.openwater_bl, self.openwater_br)
         self.__connect_regions("Open Water bottom left area", "Skeleton path",
@@ -575,14 +551,10 @@ class AquariaRegions:
                                        self.arnassi, self.openwater_br)
         self.__connect_regions("Arnassi", "Arnassi path",
                                self.arnassi, self.arnassi_path)
-        self.__connect_regions("Arnassi ruins, transturtle area", "Arnassi path",
-                               self.arnassi_cave_transturtle, self.arnassi_path,
-                               lambda state: _has_fish_form(state, self.player))
         self.__connect_one_way_regions("Arnassi path", "Arnassi crab boss area",
                                        self.arnassi_path, self.arnassi_crab_boss,
-                                       lambda state: _has_beast_form_or_arnassi_armor(state, self.player) and
-                                                     (_has_energy_attack_item(state, self.player) or
-                                                      _has_nature_form(state, self.player)))
+                                       lambda state: _has_beast_form(state, self.player) and
+                                                     _has_energy_form(state, self.player))
         self.__connect_one_way_regions("Arnassi crab boss area", "Arnassi path",
                                        self.arnassi_crab_boss, self.arnassi_path)
 
@@ -592,62 +564,61 @@ class AquariaRegions:
         """
         self.__connect_one_way_regions("Mithalas City", "Mithalas City top path",
                                        self.mithalas_city, self.mithalas_city_top_path,
-                                       lambda state: _has_beast_form_or_arnassi_armor(state, self.player))
+                                       lambda state: _has_beast_form(state, self.player))
         self.__connect_one_way_regions("Mithalas City_top_path", "Mithalas City",
                                        self.mithalas_city_top_path, self.mithalas_city)
         self.__connect_regions("Mithalas City", "Mithalas City home with fishpass",
                                self.mithalas_city, self.mithalas_city_fishpass,
                                lambda state: _has_fish_form(state, self.player))
         self.__connect_regions("Mithalas City", "Mithalas castle",
-                               self.mithalas_city, self.cathedral_l)
+                               self.mithalas_city, self.cathedral_l,
+                               lambda state: _has_fish_form(state, self.player))
         self.__connect_one_way_regions("Mithalas City top path", "Mithalas castle, flower tube",
                                        self.mithalas_city_top_path,
                                        self.cathedral_l_tube,
                                        lambda state: _has_nature_form(state, self.player) and
-                                                     _has_energy_attack_item(state, self.player))
+                                                     _has_energy_form(state, self.player))
         self.__connect_one_way_regions("Mithalas castle, flower tube area", "Mithalas City top path",
                                        self.cathedral_l_tube,
                                        self.mithalas_city_top_path,
-                                       lambda state: _has_nature_form(state, self.player))
+                                       lambda state: _has_beast_form(state, self.player) and
+                                                     _has_nature_form(state, self.player))
         self.__connect_one_way_regions("Mithalas castle flower tube area", "Mithalas castle, spirit crystals",
-                                       self.cathedral_l_tube, self.cathedral_l_sc,
-                                       lambda state: _has_spirit_form(state, self.player))
+                               self.cathedral_l_tube, self.cathedral_l_sc,
+                               lambda state: _has_spirit_form(state, self.player))
         self.__connect_one_way_regions("Mithalas castle_flower tube area", "Mithalas castle",
-                                       self.cathedral_l_tube, self.cathedral_l,
-                                       lambda state: _has_spirit_form(state, self.player))
+                               self.cathedral_l_tube, self.cathedral_l,
+                               lambda state: _has_spirit_form(state, self.player))
         self.__connect_regions("Mithalas castle", "Mithalas castle, spirit crystals",
                                self.cathedral_l, self.cathedral_l_sc,
                                lambda state: _has_spirit_form(state, self.player))
-        self.__connect_one_way_regions("Mithalas castle", "Cathedral boss right area",
-                                       self.cathedral_l, self.cathedral_boss_r,
-                                       lambda state: _has_beast_form(state, self.player))
-        self.__connect_one_way_regions("Cathedral boss left area", "Mithalas castle",
-                                       self.cathedral_boss_l, self.cathedral_l,
-                                       lambda state: _has_beast_form(state, self.player))
+        self.__connect_regions("Mithalas castle", "Cathedral boss left area",
+                               self.cathedral_l, self.cathedral_boss_l,
+                               lambda state: _has_beast_form(state, self.player) and
+                                             _has_energy_form(state, self.player) and
+                                             _has_bind_song(state, self.player))
         self.__connect_regions("Mithalas castle", "Mithalas Cathedral underground",
                                self.cathedral_l, self.cathedral_underground,
-                               lambda state: _has_beast_form(state, self.player))
-        self.__connect_one_way_regions("Mithalas castle", "Mithalas Cathedral",
-                                       self.cathedral_l, self.cathedral_r,
-                                       lambda state: _has_bind_song(state, self.player) and
-                                                     _has_energy_attack_item(state, self.player))
-        self.__connect_one_way_regions("Mithalas Cathedral", "Mithalas Cathedral underground",
-                                       self.cathedral_r, self.cathedral_underground)
-        self.__connect_one_way_regions("Mithalas Cathedral underground", "Mithalas Cathedral",
-                                       self.cathedral_underground, self.cathedral_r,
-                                       lambda state: _has_beast_form(state, self.player) and
-                                                     _has_energy_attack_item(state, self.player))
-        self.__connect_one_way_regions("Mithalas Cathedral underground", "Cathedral boss right area",
-                                       self.cathedral_underground, self.cathedral_boss_r)
-        self.__connect_one_way_regions("Cathedral boss right area", "Mithalas Cathedral underground",
+                               lambda state: _has_beast_form(state, self.player) and
+                                             _has_bind_song(state, self.player))
+        self.__connect_regions("Mithalas castle", "Mithalas Cathedral",
+                               self.cathedral_l, self.cathedral_r,
+                               lambda state: _has_bind_song(state, self.player) and
+                                             _has_energy_form(state, self.player))
+        self.__connect_regions("Mithalas Cathedral", "Mithalas Cathedral underground",
+                               self.cathedral_r, self.cathedral_underground,
+                               lambda state: _has_energy_form(state, self.player))
+        self.__connect_one_way_regions("Mithalas Cathedral underground", "Cathedral boss left area",
+                                       self.cathedral_underground, self.cathedral_boss_r,
+                                       lambda state: _has_energy_form(state, self.player) and
+                                                     _has_bind_song(state, self.player))
+        self.__connect_one_way_regions("Cathedral boss left area", "Mithalas Cathedral underground",
                                        self.cathedral_boss_r, self.cathedral_underground,
                                        lambda state: _has_beast_form(state, self.player))
-        self.__connect_one_way_regions("Cathedral boss right area", "Cathedral boss left area",
+        self.__connect_regions("Cathedral boss right area", "Cathedral boss left area",
                                        self.cathedral_boss_r, self.cathedral_boss_l,
                                        lambda state: _has_bind_song(state, self.player) and
-                                                     _has_energy_attack_item(state, self.player))
-        self.__connect_one_way_regions("Cathedral boss left area", "Cathedral boss right area",
-                                       self.cathedral_boss_l, self.cathedral_boss_r)
+                                                     _has_energy_form(state, self.player))
 
     def __connect_forest_regions(self) -> None:
         """
@@ -657,12 +628,6 @@ class AquariaRegions:
                                self.forest_br, self.veil_bl)
         self.__connect_regions("Forest bottom right", "Forest bottom left area",
                                self.forest_br, self.forest_bl)
-        self.__connect_one_way_regions("Forest bottom left area", "Forest bottom left area, spirit crystals",
-                                       self.forest_bl, self.forest_bl_sc,
-                                       lambda state: _has_energy_attack_item(state, self.player) or
-                                                     _has_fish_form(state, self.player))
-        self.__connect_one_way_regions("Forest bottom left area, spirit crystals", "Forest bottom left area",
-                                       self.forest_bl_sc, self.forest_bl)
         self.__connect_regions("Forest bottom right", "Forest top right area",
                                self.forest_br, self.forest_tr)
         self.__connect_regions("Forest bottom left area", "Forest fish cave",
@@ -676,7 +641,7 @@ class AquariaRegions:
                                self.forest_tl, self.forest_tl_fp,
                                lambda state: _has_nature_form(state, self.player) and
                                              _has_bind_song(state, self.player) and
-                                             _has_energy_attack_item(state, self.player) and
+                                             _has_energy_form(state, self.player) and
                                              _has_fish_form(state, self.player))
         self.__connect_regions("Forest top left area", "Forest top right area",
                                self.forest_tl, self.forest_tr)
@@ -684,7 +649,7 @@ class AquariaRegions:
                                self.forest_tl, self.forest_boss_entrance)
         self.__connect_regions("Forest boss area", "Forest boss entrance",
                                self.forest_boss, self.forest_boss_entrance,
-                               lambda state: _has_energy_attack_item(state, self.player))
+                               lambda state: _has_energy_form(state, self.player))
         self.__connect_regions("Forest top right area", "Forest top right area fish pass",
                                self.forest_tr, self.forest_tr_fp,
                                lambda state: _has_fish_form(state, self.player))
@@ -698,7 +663,7 @@ class AquariaRegions:
         self.__connect_regions("Fermog cave", "Fermog boss",
                                self.mermog_cave, self.mermog_boss,
                                lambda state: _has_beast_form(state, self.player) and
-                                             _has_energy_attack_item(state, self.player))
+                                             _has_energy_form(state, self.player))
 
     def __connect_veil_regions(self) -> None:
         """
@@ -716,7 +681,8 @@ class AquariaRegions:
                                self.veil_b_sc, self.veil_br,
                                lambda state: _has_spirit_form(state, self.player))
         self.__connect_regions("Veil bottom right", "Veil top left area",
-                               self.veil_br, self.veil_tl)
+                               self.veil_br, self.veil_tl,
+                               lambda state: _has_beast_form(state, self.player))
         self.__connect_regions("Veil top left area", "Veil_top left area, fish pass",
                                self.veil_tl, self.veil_tl_fp,
                                lambda state: _has_fish_form(state, self.player))
@@ -725,25 +691,20 @@ class AquariaRegions:
         self.__connect_regions("Veil top left area", "Turtle cave",
                                self.veil_tl, self.turtle_cave)
         self.__connect_regions("Turtle cave", "Turtle cave Bubble Cliff",
-                               self.turtle_cave, self.turtle_cave_bubble)
+                               self.turtle_cave, self.turtle_cave_bubble,
+                               lambda state: _has_beast_form(state, self.player))
         self.__connect_regions("Veil right of sun temple", "Sun Temple right area",
                                self.veil_tr_r, self.sun_temple_r)
-        self.__connect_one_way_regions("Sun Temple right area", "Sun Temple left area",
-                                       self.sun_temple_r, self.sun_temple_l,
-                                       lambda state: _has_bind_song(state, self.player) or
-                                                     _has_light(state, self.player))
-        self.__connect_one_way_regions("Sun Temple left area", "Sun Temple right area",
-                                       self.sun_temple_l, self.sun_temple_r,
-                                       lambda state: _has_light(state, self.player))
+        self.__connect_regions("Sun Temple right area", "Sun Temple left area",
+                               self.sun_temple_r, self.sun_temple_l,
+                               lambda state: _has_bind_song(state, self.player))
         self.__connect_regions("Sun Temple left area", "Veil left of sun temple",
                                self.sun_temple_l, self.veil_tr_l)
         self.__connect_regions("Sun Temple left area", "Sun Temple before boss area",
-                               self.sun_temple_l, self.sun_temple_boss_path,
-                               lambda state: _has_light(state, self.player) or
-                                             _has_sun_crystal(state, self.player))
+                               self.sun_temple_l, self.sun_temple_boss_path)
         self.__connect_regions("Sun Temple before boss area", "Sun Temple boss area",
                                self.sun_temple_boss_path, self.sun_temple_boss,
-                               lambda state: _has_energy_attack_item(state, self.player))
+                               lambda state: _has_energy_form(state, self.player))
         self.__connect_one_way_regions("Sun Temple boss area", "Veil left of sun temple",
                                        self.sun_temple_boss, self.veil_tr_l)
         self.__connect_regions("Veil left of sun temple", "Octo cave top path",
@@ -751,7 +712,7 @@ class AquariaRegions:
                                lambda state: _has_fish_form(state, self.player) and
                                              _has_sun_form(state, self.player) and
                                              _has_beast_form(state, self.player) and
-                                             _has_energy_attack_item(state, self.player))
+                                             _has_energy_form(state, self.player))
         self.__connect_regions("Veil left of sun temple", "Octo cave bottom path",
                                self.veil_tr_l, self.octo_cave_b,
                                lambda state: _has_fish_form(state, self.player))
@@ -767,22 +728,16 @@ class AquariaRegions:
                                self.abyss_lb, self.sunken_city_r,
                                lambda state: _has_li(state, self.player))
         self.__connect_one_way_regions("Abyss left bottom area", "Body center area",
-                                       self.abyss_lb, self.body_c,
-                                       lambda state: _has_tongue_cleared(state, self.player))
+                               self.abyss_lb, self.body_c,
+                               lambda state: _has_tongue_cleared(state, self.player))
         self.__connect_one_way_regions("Body center area", "Abyss left bottom area",
-                                       self.body_c, self.abyss_lb)
+                               self.body_c, self.abyss_lb)
         self.__connect_regions("Abyss left area", "King jellyfish cave",
                                self.abyss_l, self.king_jellyfish_cave,
-                               lambda state: (_has_energy_form(state, self.player) and
-                                              _has_beast_form(state, self.player)) or
-                                             _has_dual_form(state, self.player))
+                               lambda state: _has_energy_form(state, self.player) and
+                                             _has_beast_form(state, self.player))
         self.__connect_regions("Abyss left area", "Abyss right area",
                                self.abyss_l, self.abyss_r)
-        self.__connect_one_way_regions("Abyss right area", "Abyss right area, transturtle",
-                                       self.abyss_r, self.abyss_r_transturtle)
-        self.__connect_one_way_regions("Abyss right area, transturtle", "Abyss right area",
-                                       self.abyss_r_transturtle, self.abyss_r,
-                                       lambda state: _has_light(state, self.player))
         self.__connect_regions("Abyss right area", "Inside the whale",
                                self.abyss_r, self.whale,
                                lambda state: _has_spirit_form(state, self.player) and
@@ -792,14 +747,13 @@ class AquariaRegions:
                                lambda state: _has_spirit_form(state, self.player) and
                                              _has_sun_form(state, self.player) and
                                              _has_bind_song(state, self.player) and
-                                             _has_energy_attack_item(state, self.player))
+                                             _has_energy_form(state, self.player))
         self.__connect_regions("Abyss right area", "Ice Cave",
                                self.abyss_r, self.ice_cave,
                                lambda state: _has_spirit_form(state, self.player))
-        self.__connect_regions("Ice cave", "Bubble Cave",
+        self.__connect_regions("Abyss right area", "Bubble Cave",
                                self.ice_cave, self.bubble_cave,
-                               lambda state: _has_beast_form(state, self.player) or
-                                             _has_hot_soup(state, self.player))
+                               lambda state: _has_beast_form(state, self.player))
         self.__connect_regions("Bubble Cave boss area", "Bubble Cave",
                                self.bubble_cave, self.bubble_cave_boss,
                                lambda state: _has_nature_form(state, self.player) and _has_bind_song(state, self.player)
@@ -818,7 +772,7 @@ class AquariaRegions:
                                self.sunken_city_l, self.sunken_city_boss,
                                lambda state: _has_beast_form(state, self.player) and
                                              _has_sun_form(state, self.player) and
-                                             _has_energy_attack_item(state, self.player) and
+                                             _has_energy_form(state, self.player) and
                                              _has_bind_song(state, self.player))
 
     def __connect_body_regions(self) -> None:
@@ -826,13 +780,11 @@ class AquariaRegions:
         Connect entrances of the different regions around The Body
         """
         self.__connect_regions("Body center area", "Body left area",
-                               self.body_c, self.body_l,
-                               lambda state: _has_energy_form(state, self.player))
+                               self.body_c, self.body_l)
         self.__connect_regions("Body center area", "Body right area top path",
                                self.body_c, self.body_rt)
         self.__connect_regions("Body center area", "Body right area bottom path",
-                               self.body_c, self.body_rb,
-                               lambda state: _has_energy_form(state, self.player))
+                               self.body_c, self.body_rb)
         self.__connect_regions("Body center area", "Body bottom area",
                                self.body_c, self.body_b,
                                lambda state: _has_dual_form(state, self.player))
@@ -851,12 +803,22 @@ class AquariaRegions:
         self.__connect_one_way_regions("final boss third form area", "final boss end",
                                        self.final_boss, self.final_boss_end)
 
-    def __connect_transturtle(self, item_source: str, item_target: str, region_source: Region,
-                              region_target: Region) -> None:
+    def __connect_transturtle(self, item_source: str, item_target: str, region_source: Region, region_target: Region,
+                              rule=None) -> None:
         """Connect a single transturtle to another one"""
         if item_source != item_target:
-            self.__connect_one_way_regions(item_source, item_target, region_source, region_target,
-                                           lambda state: state.has(item_target, self.player))
+            if rule is None:
+                self.__connect_one_way_regions(item_source, item_target, region_source, region_target,
+                                               lambda state: state.has(item_target, self.player))
+            else:
+                self.__connect_one_way_regions(item_source, item_target, region_source, region_target, rule)
+
+    def __connect_arnassi_path_transturtle(self, item_source: str, item_target: str, region_source: Region,
+                                           region_target: Region) -> None:
+        """Connect the Arnassi Ruins transturtle to another one"""
+        self.__connect_one_way_regions(item_source, item_target, region_source, region_target,
+                                       lambda state: state.has(item_target, self.player) and
+                                                     _has_fish_form(state, self.player))
 
     def _connect_transturtle_to_other(self, item: str, region: Region) -> None:
         """Connect a single transturtle to all others"""
@@ -865,10 +827,24 @@ class AquariaRegions:
         self.__connect_transturtle(item, "Transturtle Open Water top right", region, self.openwater_tr_turtle)
         self.__connect_transturtle(item, "Transturtle Forest bottom left", region, self.forest_bl)
         self.__connect_transturtle(item, "Transturtle Home Water", region, self.home_water_transturtle)
-        self.__connect_transturtle(item, "Transturtle Abyss right", region, self.abyss_r_transturtle)
+        self.__connect_transturtle(item, "Transturtle Abyss right", region, self.abyss_r)
         self.__connect_transturtle(item, "Transturtle Final Boss", region, self.final_boss_tube)
         self.__connect_transturtle(item, "Transturtle Simon Says", region, self.simon)
-        self.__connect_transturtle(item, "Transturtle Arnassi Ruins", region, self.arnassi_cave_transturtle)
+        self.__connect_transturtle(item, "Transturtle Arnassi Ruins", region, self.arnassi_path,
+                                       lambda state: state.has("Transturtle Arnassi Ruins", self.player) and
+                                                     _has_fish_form(state, self.player))
+
+    def _connect_arnassi_path_transturtle_to_other(self, item: str, region: Region) -> None:
+        """Connect the Arnassi Ruins transturtle to all others"""
+        self.__connect_arnassi_path_transturtle(item, "Transturtle Veil top left", region, self.veil_tl)
+        self.__connect_arnassi_path_transturtle(item, "Transturtle Veil top right", region, self.veil_tr_l)
+        self.__connect_arnassi_path_transturtle(item, "Transturtle Open Water top right", region,
+                                                self.openwater_tr_turtle)
+        self.__connect_arnassi_path_transturtle(item, "Transturtle Forest bottom left", region, self.forest_bl)
+        self.__connect_arnassi_path_transturtle(item, "Transturtle Home Water", region, self.home_water_transturtle)
+        self.__connect_arnassi_path_transturtle(item, "Transturtle Abyss right", region, self.abyss_r)
+        self.__connect_arnassi_path_transturtle(item, "Transturtle Final Boss", region, self.final_boss_tube)
+        self.__connect_arnassi_path_transturtle(item, "Transturtle Simon Says", region, self.simon)
 
     def __connect_transturtles(self) -> None:
         """Connect every transturtle with others"""
@@ -877,10 +853,10 @@ class AquariaRegions:
         self._connect_transturtle_to_other("Transturtle Open Water top right", self.openwater_tr_turtle)
         self._connect_transturtle_to_other("Transturtle Forest bottom left", self.forest_bl)
         self._connect_transturtle_to_other("Transturtle Home Water", self.home_water_transturtle)
-        self._connect_transturtle_to_other("Transturtle Abyss right", self.abyss_r_transturtle)
+        self._connect_transturtle_to_other("Transturtle Abyss right", self.abyss_r)
         self._connect_transturtle_to_other("Transturtle Final Boss", self.final_boss_tube)
         self._connect_transturtle_to_other("Transturtle Simon Says", self.simon)
-        self._connect_transturtle_to_other("Transturtle Arnassi Ruins", self.arnassi_cave_transturtle)
+        self._connect_arnassi_path_transturtle_to_other("Transturtle Arnassi Ruins", self.arnassi_path)
 
     def connect_regions(self) -> None:
         """
@@ -917,7 +893,7 @@ class AquariaRegions:
         self.__add_event_location(self.energy_temple_boss,
                                   "Beating Fallen God",
                                   "Fallen God beated")
-        self.__add_event_location(self.cathedral_boss_l,
+        self.__add_event_location(self.cathedral_boss_r,
                                   "Beating Mithalan God",
                                   "Mithalan God beated")
         self.__add_event_location(self.forest_boss,
@@ -994,9 +970,8 @@ class AquariaRegions:
         """Since Urns need to be broken, add a damaging item to rules"""
         add_rule(self.multiworld.get_location("Open Water top right area, first urn in the Mithalas exit", self.player),
                  lambda state: _has_damaging_item(state, self.player))
-        add_rule(
-            self.multiworld.get_location("Open Water top right area, second urn in the Mithalas exit", self.player),
-            lambda state: _has_damaging_item(state, self.player))
+        add_rule(self.multiworld.get_location("Open Water top right area, second urn in the Mithalas exit", self.player),
+                 lambda state: _has_damaging_item(state, self.player))
         add_rule(self.multiworld.get_location("Open Water top right area, third urn in the Mithalas exit", self.player),
                  lambda state: _has_damaging_item(state, self.player))
         add_rule(self.multiworld.get_location("Mithalas City, first urn in one of the homes", self.player),
@@ -1044,46 +1019,66 @@ class AquariaRegions:
         Modify rules for location that need soup
         """
         add_rule(self.multiworld.get_location("Turtle cave, Urchin Costume", self.player),
-                 lambda state: _has_hot_soup(state, self.player))
+                 lambda state: _has_hot_soup(state, self.player) and _has_beast_form(state, self.player))
+        add_rule(self.multiworld.get_location("Sun Worm path, first cliff bulb", self.player),
+                 lambda state: _has_hot_soup(state, self.player) and _has_beast_form(state, self.player))
+        add_rule(self.multiworld.get_location("Sun Worm path, second cliff bulb", self.player),
+                 lambda state: _has_hot_soup(state, self.player) and _has_beast_form(state, self.player))
         add_rule(self.multiworld.get_location("The Veil top right area, bulb at the top of the waterfall", self.player),
-                 lambda state: _has_beast_and_soup_form(state, self.player))
+                 lambda state: _has_hot_soup(state, self.player) and _has_beast_form(state, self.player))
 
     def __adjusting_under_rock_location(self) -> None:
         """
         Modify rules implying bind song needed for bulb under rocks
         """
         add_rule(self.multiworld.get_location("Home Water, bulb under the rock in the left path from the Verse Cave",
-                                              self.player), lambda state: _has_bind_song(state, self.player))
+                                         self.player), lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("Verse Cave left area, bulb under the rock at the end of the path",
-                                              self.player), lambda state: _has_bind_song(state, self.player))
+                                         self.player), lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("Naija's Home, bulb under the rock at the right of the main path",
-                                              self.player), lambda state: _has_bind_song(state, self.player))
+                                         self.player), lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("Song Cave, bulb under the rock in the path to the singing statues",
-                                              self.player), lambda state: _has_bind_song(state, self.player))
+                                         self.player), lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("Song Cave, bulb under the rock close to the song door",
-                                              self.player), lambda state: _has_bind_song(state, self.player))
+                                         self.player), lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("Energy Temple second area, bulb under the rock",
-                                              self.player), lambda state: _has_bind_song(state, self.player))
+                                         self.player), lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("Open Water top left area, bulb under the rock in the right path",
-                                              self.player), lambda state: _has_bind_song(state, self.player))
+                                         self.player), lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("Open Water top left area, bulb under the rock in the left path",
-                                              self.player), lambda state: _has_bind_song(state, self.player))
+                                         self.player), lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("Kelp Forest top right area, bulb under the rock in the right path",
-                                              self.player), lambda state: _has_bind_song(state, self.player))
+                                         self.player), lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("The Veil top left area, bulb under the rock in the top right path",
-                                              self.player), lambda state: _has_bind_song(state, self.player))
+                                         self.player), lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("Abyss right area, bulb behind the rock in the whale room",
-                                              self.player), lambda state: _has_bind_song(state, self.player))
+                                         self.player), lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("Abyss right area, bulb in the middle path",
-                                              self.player), lambda state: _has_bind_song(state, self.player))
+                                         self.player), lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("The Veil top left area, bulb under the rock in the top right path",
-                                              self.player), lambda state: _has_bind_song(state, self.player))
+                                         self.player), lambda state: _has_bind_song(state, self.player))
 
     def __adjusting_light_in_dark_place_rules(self) -> None:
         add_rule(self.multiworld.get_location("Kelp Forest top right area, Black Pearl", self.player),
                  lambda state: _has_light(state, self.player))
         add_rule(self.multiworld.get_location("Kelp Forest bottom right area, Odd Container", self.player),
                  lambda state: _has_light(state, self.player))
+        add_rule(self.multiworld.get_entrance("Transturtle Veil top left to Transturtle Abyss right", self.player),
+                 lambda state: _has_light(state, self.player))
+        add_rule(self.multiworld.get_entrance("Transturtle Open Water top right to Transturtle Abyss right", self.player),
+                 lambda state: _has_light(state, self.player))
+        add_rule(self.multiworld.get_entrance("Transturtle Veil top right to Transturtle Abyss right", self.player),
+                 lambda state: _has_light(state, self.player))
+        add_rule(self.multiworld.get_entrance("Transturtle Forest bottom left to Transturtle Abyss right", self.player),
+                 lambda state: _has_light(state, self.player))
+        add_rule(self.multiworld.get_entrance("Transturtle Home Water to Transturtle Abyss right", self.player),
+                 lambda state: _has_light(state, self.player))
+        add_rule(self.multiworld.get_entrance("Transturtle Final Boss to Transturtle Abyss right", self.player),
+                 lambda state: _has_light(state, self.player))
+        add_rule(self.multiworld.get_entrance("Transturtle Simon Says to Transturtle Abyss right", self.player),
+                 lambda state: _has_light(state, self.player))
+        add_rule(self.multiworld.get_entrance("Transturtle Arnassi Ruins to Transturtle Abyss right", self.player),
+                 lambda state: _has_light(state, self.player))
         add_rule(self.multiworld.get_entrance("Body center area to Abyss left bottom area", self.player),
                  lambda state: _has_light(state, self.player))
         add_rule(self.multiworld.get_entrance("Veil left of sun temple to Octo cave top path", self.player),
@@ -1102,14 +1097,12 @@ class AquariaRegions:
     def __adjusting_manual_rules(self) -> None:
         add_rule(self.multiworld.get_location("Mithalas Cathedral, Mithalan Dress", self.player),
                  lambda state: _has_beast_form(state, self.player))
-        add_rule(
-            self.multiworld.get_location("Open Water bottom left area, bulb inside the lowest fish pass", self.player),
-            lambda state: _has_fish_form(state, self.player))
+        add_rule(self.multiworld.get_location("Open Water bottom left area, bulb inside the lowest fish pass", self.player),
+                 lambda state: _has_fish_form(state, self.player))
         add_rule(self.multiworld.get_location("Kelp Forest bottom left area, Walker Baby", self.player),
                  lambda state: _has_spirit_form(state, self.player))
-        add_rule(
-            self.multiworld.get_location("The Veil top left area, bulb hidden behind the blocking rock", self.player),
-            lambda state: _has_bind_song(state, self.player))
+        add_rule(self.multiworld.get_location("The Veil top left area, bulb hidden behind the blocking rock", self.player),
+                 lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("Turtle cave, Turtle Egg", self.player),
                  lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("Abyss left area, bulb in the bottom fish pass", self.player),
@@ -1121,119 +1114,103 @@ class AquariaRegions:
         add_rule(self.multiworld.get_location("Verse Cave right area, Big Seed", self.player),
                  lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("Arnassi Ruins, Song Plant Spore", self.player),
-                 lambda state: _has_beast_form_or_arnassi_armor(state, self.player))
+                 lambda state: _has_beast_form(state, self.player))
         add_rule(self.multiworld.get_location("Energy Temple first area, bulb in the bottom room blocked by a rock",
-                                              self.player), lambda state: _has_bind_song(state, self.player))
+                                         self.player), lambda state: _has_energy_form(state, self.player))
         add_rule(self.multiworld.get_location("Home Water, bulb in the bottom left room", self.player),
                  lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("Home Water, bulb in the path below Nautilus Prime", self.player),
                  lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("Naija's Home, bulb after the energy door", self.player),
-                 lambda state: _has_energy_attack_item(state, self.player))
+                 lambda state: _has_energy_form(state, self.player))
         add_rule(self.multiworld.get_location("Abyss right area, bulb behind the rock in the whale room", self.player),
                  lambda state: _has_spirit_form(state, self.player) and
                                _has_sun_form(state, self.player))
         add_rule(self.multiworld.get_location("Arnassi Ruins, Arnassi Armor", self.player),
-                 lambda state: _has_fish_form(state, self.player) or
-                               _has_beast_and_soup_form(state, self.player))
-        add_rule(self.multiworld.get_location("Mithalas City, urn inside a home fish pass", self.player),
-                 lambda state: _has_damaging_item(state, self.player))
-        add_rule(self.multiworld.get_location("Mithalas City, urn in the Castle flower tube entrance", self.player),
-                 lambda state: _has_damaging_item(state, self.player))
-        add_rule(self.multiworld.get_location(
-            "The Veil top right area, bulb in the middle of the wall jump cliff", self.player
-        ), lambda state: _has_beast_form_or_arnassi_armor(state, self.player))
-        add_rule(self.multiworld.get_location("Kelp Forest top left area, Jelly Egg", self.player),
-                 lambda state: _has_beast_form(state, self.player))
-        add_rule(self.multiworld.get_location("Sun Worm path, first cliff bulb", self.player),
-                 lambda state: state.has("Sun God beated", self.player))
-        add_rule(self.multiworld.get_location("Sun Worm path, second cliff bulb", self.player),
-                 lambda state: state.has("Sun God beated", self.player))
-        add_rule(self.multiworld.get_location("The Body center area, breaking Li's cage", self.player),
-                 lambda state: _has_tongue_cleared(state, self.player))
+                 lambda state: _has_fish_form(state, self.player) and
+                               _has_spirit_form(state, self.player))
 
     def __no_progression_hard_or_hidden_location(self) -> None:
         self.multiworld.get_location("Energy Temple boss area, Fallen God Tooth",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Mithalas boss area, beating Mithalan God",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Kelp Forest boss area, beating Drunian God",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Sun Temple boss area, beating Sun God",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Sunken City, bulb on top of the boss area",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Home Water, Nautilus Egg",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Energy Temple blaster room, Blaster Egg",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Mithalas City Castle, beating the Priests",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Mermog cave, Piranha Egg",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Octopus Cave, Dumbo Egg",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("King Jellyfish Cave, bulb in the right path from King Jelly",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("King Jellyfish Cave, Jellyfish Costume",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Final Boss area, bulb in the boss third form room",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Sun Worm path, first cliff bulb",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Sun Worm path, second cliff bulb",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("The Veil top right area, bulb at the top of the waterfall",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Bubble Cave, bulb in the left cave wall",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Bubble Cave, bulb in the right cave wall (behind the ice crystal)",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Bubble Cave, Verse Egg",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Kelp Forest bottom left area, bulb close to the spirit crystals",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Kelp Forest bottom left area, Walker Baby",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Sun Temple, Sun Key",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("The Body bottom area, Mutant Costume",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Sun Temple, bulb in the hidden room of the right part",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
         self.multiworld.get_location("Arnassi Ruins, Arnassi Armor",
-                                     self.player).item_rule = \
+                                     self.player).item_rule =\
             lambda item: item.classification != ItemClassification.progression
 
     def adjusting_rules(self, options: AquariaOptions) -> None:
         """
         Modify rules for single location or optional rules
         """
-        self.multiworld.get_entrance("Before Final Boss to Final Boss", self.player)
         self.__adjusting_urns_rules()
         self.__adjusting_crates_rules()
         self.__adjusting_soup_rules()
@@ -1257,7 +1234,7 @@ class AquariaRegions:
                      lambda state: _has_bind_song(state, self.player))
         if options.unconfine_home_water.value in [0, 2]:
             add_rule(self.multiworld.get_entrance("Home Water to Open Water top left area", self.player),
-                     lambda state: _has_bind_song(state, self.player) and _has_energy_attack_item(state, self.player))
+                     lambda state: _has_bind_song(state, self.player) and _has_energy_form(state, self.player))
         if options.early_energy_form:
             self.multiworld.early_items[self.player]["Energy form"] = 1
 
@@ -1297,7 +1274,6 @@ class AquariaRegions:
         self.multiworld.regions.append(self.arnassi)
         self.multiworld.regions.append(self.arnassi_path)
         self.multiworld.regions.append(self.arnassi_crab_boss)
-        self.multiworld.regions.append(self.arnassi_cave_transturtle)
         self.multiworld.regions.append(self.simon)
 
     def __add_mithalas_regions_to_world(self) -> None:
@@ -1324,7 +1300,6 @@ class AquariaRegions:
         self.multiworld.regions.append(self.forest_tr)
         self.multiworld.regions.append(self.forest_tr_fp)
         self.multiworld.regions.append(self.forest_bl)
-        self.multiworld.regions.append(self.forest_bl_sc)
         self.multiworld.regions.append(self.forest_br)
         self.multiworld.regions.append(self.forest_boss)
         self.multiworld.regions.append(self.forest_boss_entrance)
@@ -1362,7 +1337,6 @@ class AquariaRegions:
         self.multiworld.regions.append(self.abyss_l)
         self.multiworld.regions.append(self.abyss_lb)
         self.multiworld.regions.append(self.abyss_r)
-        self.multiworld.regions.append(self.abyss_r_transturtle)
         self.multiworld.regions.append(self.ice_cave)
         self.multiworld.regions.append(self.bubble_cave)
         self.multiworld.regions.append(self.bubble_cave_boss)

worlds/aquaria/test/__init__.py

@@ -141,7 +141,7 @@ after_home_water_locations = [
     "Sun Temple, bulb at the top of the high dark room",
     "Sun Temple, Golden Gear",
     "Sun Temple, first bulb of the temple",
-    "Sun Temple, bulb on the right part",
+    "Sun Temple, bulb on the left part",
     "Sun Temple, bulb in the hidden room of the right part",
     "Sun Temple, Sun Key",
     "Sun Worm path, first path bulb",

worlds/aquaria/test/test_beast_form_access.py

@@ -13,16 +13,36 @@ class BeastFormAccessTest(AquariaTestBase):
     def test_beast_form_location(self) -> None:
         """Test locations that require beast form"""
         locations = [
+            "Mithalas City Castle, beating the Priests",
+            "Arnassi Ruins, Crab Armor",
+            "Arnassi Ruins, Song Plant Spore",
+            "Mithalas City, first bulb at the end of the top path",
+            "Mithalas City, second bulb at the end of the top path",
+            "Mithalas City, bulb in the top path",
+            "Mithalas City, Mithalas Pot",
+            "Mithalas City, urn in the Castle flower tube entrance",
             "Mermog cave, Piranha Egg",
-            "Kelp Forest top left area, Jelly Egg",
             "Mithalas Cathedral, Mithalan Dress",
+            "Turtle cave, bulb in Bubble Cliff",
+            "Turtle cave, Urchin Costume",
+            "Sun Worm path, first cliff bulb",
+            "Sun Worm path, second cliff bulb",
             "The Veil top right area, bulb at the top of the waterfall",
+            "Bubble Cave, bulb in the left cave wall",
+            "Bubble Cave, bulb in the right cave wall (behind the ice crystal)",
+            "Bubble Cave, Verse Egg",
             "Sunken City, bulb on top of the boss area",
             "Octopus Cave, Dumbo Egg",
             "Beating the Golem",
             "Beating Mergog",
+            "Beating Crabbius Maximus",
             "Beating Octopus Prime",
-            "Sunken City cleared",
+            "Beating Mantis Shrimp Prime",
+            "King Jellyfish Cave, Jellyfish Costume",
+            "King Jellyfish Cave, bulb in the right path from King Jelly",
+            "Beating King Jellyfish God Prime",
+            "Beating Mithalan priests",
+            "Sunken City cleared"
         ]
         items = [["Beast form"]]
         self.assertAccessDependency(locations, items)

worlds/aquaria/test/test_beast_form_or_arnassi_armor_access.py

@@ -1,39 +0,0 @@
-"""
-Author: Louis M
-Date: Thu, 18 Apr 2024 18:45:56 +0000
-Description: Unit test used to test accessibility of locations with and without the beast form or arnassi armor
-"""
-
-from . import AquariaTestBase
-
-
-class BeastForArnassiArmormAccessTest(AquariaTestBase):
-    """Unit test used to test accessibility of locations with and without the beast form or arnassi armor"""
-
-    def test_beast_form_arnassi_armor_location(self) -> None:
-        """Test locations that require beast form or arnassi armor"""
-        locations = [
-            "Mithalas City Castle, beating the Priests",
-            "Arnassi Ruins, Crab Armor",
-            "Arnassi Ruins, Song Plant Spore",
-            "Mithalas City, first bulb at the end of the top path",
-            "Mithalas City, second bulb at the end of the top path",
-            "Mithalas City, bulb in the top path",
-            "Mithalas City, Mithalas Pot",
-            "Mithalas City, urn in the Castle flower tube entrance",
-            "Mermog cave, Piranha Egg",
-            "Mithalas Cathedral, Mithalan Dress",
-            "Kelp Forest top left area, Jelly Egg",
-            "The Veil top right area, bulb in the middle of the wall jump cliff",
-            "The Veil top right area, bulb at the top of the waterfall",
-            "Sunken City, bulb on top of the boss area",
-            "Octopus Cave, Dumbo Egg",
-            "Beating the Golem",
-            "Beating Mergog",
-            "Beating Crabbius Maximus",
-            "Beating Octopus Prime",
-            "Beating Mithalan priests",
-            "Sunken City cleared"
-        ]
-        items = [["Beast form", "Arnassi Armor"]]
-        self.assertAccessDependency(locations, items)

worlds/aquaria/test/test_energy_form_access.py

@@ -17,16 +17,55 @@ class EnergyFormAccessTest(AquariaTestBase):
     def test_energy_form_location(self) -> None:
         """Test locations that require Energy form"""
         locations = [
+            "Home Water, Nautilus Egg",
+            "Naija's Home, bulb after the energy door",
+            "Energy Temple first area, bulb in the bottom room blocked by a rock",
             "Energy Temple second area, bulb under the rock",
+            "Energy Temple bottom entrance, Krotite Armor",
             "Energy Temple third area, bulb in the bottom path",
-            "The Body left area, first bulb in the top face room",
-            "The Body left area, second bulb in the top face room",
-            "The Body left area, bulb below the water stream",
-            "The Body left area, bulb in the top path to the top face room",
-            "The Body left area, bulb in the bottom face room",
-            "The Body right area, bulb in the top path to the bottom face room",
-            "The Body right area, bulb in the bottom face room",
+            "Energy Temple boss area, Fallen God Tooth",
+            "Energy Temple blaster room, Blaster Egg",
+            "Mithalas City Castle, beating the Priests",
+            "Mithalas Cathedral, first urn in the top right room",
+            "Mithalas Cathedral, second urn in the top right room",
+            "Mithalas Cathedral, third urn in the top right room",
+            "Mithalas Cathedral, urn in the flesh room with fleas",
+            "Mithalas Cathedral, first urn in the bottom right path",
+            "Mithalas Cathedral, second urn in the bottom right path",
+            "Mithalas Cathedral, urn behind the flesh vein",
+            "Mithalas Cathedral, urn in the top left eyes boss room",
+            "Mithalas Cathedral, first urn in the path behind the flesh vein",
+            "Mithalas Cathedral, second urn in the path behind the flesh vein",
+            "Mithalas Cathedral, third urn in the path behind the flesh vein",
+            "Mithalas Cathedral, fourth urn in the top right room",
+            "Mithalas Cathedral, Mithalan Dress",
+            "Mithalas Cathedral, urn below the left entrance",
+            "Mithalas boss area, beating Mithalan God",
+            "Kelp Forest top left area, bulb close to the Verse Egg",
+            "Kelp Forest top left area, Verse Egg",
+            "Kelp Forest boss area, beating Drunian God",
+            "Mermog cave, Piranha Egg",
+            "Octopus Cave, Dumbo Egg",
+            "Sun Temple boss area, beating Sun God",
+            "Arnassi Ruins, Crab Armor",
+            "King Jellyfish Cave, bulb in the right path from King Jelly",
+            "King Jellyfish Cave, Jellyfish Costume",
+            "Sunken City, bulb on top of the boss area",
             "Final Boss area, bulb in the boss third form room",
+            "Beating Fallen God",
+            "Beating Mithalan God",
+            "Beating Drunian God",
+            "Beating Sun God",
+            "Beating the Golem",
+            "Beating Nautilus Prime",
+            "Beating Blaster Peg Prime",
+            "Beating Mergog",
+            "Beating Mithalan priests",
+            "Beating Octopus Prime",
+            "Beating Crabbius Maximus",
+            "Beating King Jellyfish God Prime",
+            "First secret",
+            "Sunken City cleared",
             "Objective complete",
         ]
         items = [["Energy form"]]

worlds/aquaria/test/test_energy_form_or_dual_form_access.py

@@ -1,92 +0,0 @@
-"""
-Author: Louis M
-Date: Thu, 18 Apr 2024 18:45:56 +0000
-Description: Unit test used to test accessibility of locations with and without the energy form and dual form (and Li)
-"""
-
-from . import AquariaTestBase
-
-
-class EnergyFormDualFormAccessTest(AquariaTestBase):
-    """Unit test used to test accessibility of locations with and without the energy form and dual form (and Li)"""
-    options = {
-        "early_energy_form": False,
-    }
-
-    def test_energy_form_or_dual_form_location(self) -> None:
-        """Test locations that require Energy form or dual form"""
-        locations = [
-            "Naija's Home, bulb after the energy door",
-            "Home Water, Nautilus Egg",
-            "Energy Temple second area, bulb under the rock",
-            "Energy Temple bottom entrance, Krotite Armor",
-            "Energy Temple third area, bulb in the bottom path",
-            "Energy Temple blaster room, Blaster Egg",
-            "Energy Temple boss area, Fallen God Tooth",
-            "Mithalas City Castle, beating the Priests",
-            "Mithalas boss area, beating Mithalan God",
-            "Mithalas Cathedral, first urn in the top right room",
-            "Mithalas Cathedral, second urn in the top right room",
-            "Mithalas Cathedral, third urn in the top right room",
-            "Mithalas Cathedral, urn in the flesh room with fleas",
-            "Mithalas Cathedral, first urn in the bottom right path",
-            "Mithalas Cathedral, second urn in the bottom right path",
-            "Mithalas Cathedral, urn behind the flesh vein",
-            "Mithalas Cathedral, urn in the top left eyes boss room",
-            "Mithalas Cathedral, first urn in the path behind the flesh vein",
-            "Mithalas Cathedral, second urn in the path behind the flesh vein",
-            "Mithalas Cathedral, third urn in the path behind the flesh vein",
-            "Mithalas Cathedral, fourth urn in the top right room",
-            "Mithalas Cathedral, Mithalan Dress",
-            "Mithalas Cathedral, urn below the left entrance",
-            "Kelp Forest top left area, bulb close to the Verse Egg",
-            "Kelp Forest top left area, Verse Egg",
-            "Kelp Forest boss area, beating Drunian God",
-            "Mermog cave, Piranha Egg",
-            "Octopus Cave, Dumbo Egg",
-            "Sun Temple boss area, beating Sun God",
-            "King Jellyfish Cave, bulb in the right path from King Jelly",
-            "King Jellyfish Cave, Jellyfish Costume",
-            "Sunken City right area, crate close to the save crystal",
-            "Sunken City right area, crate in the left bottom room",
-            "Sunken City left area, crate in the little pipe room",
-            "Sunken City left area, crate close to the save crystal",
-            "Sunken City left area, crate before the bedroom",
-            "Sunken City left area, Girl Costume",
-            "Sunken City, bulb on top of the boss area",
-            "The Body center area, breaking Li's cage",
-            "The Body center area, bulb on the main path blocking tube",
-            "The Body left area, first bulb in the top face room",
-            "The Body left area, second bulb in the top face room",
-            "The Body left area, bulb below the water stream",
-            "The Body left area, bulb in the top path to the top face room",
-            "The Body left area, bulb in the bottom face room",
-            "The Body right area, bulb in the top face room",
-            "The Body right area, bulb in the top path to the bottom face room",
-            "The Body right area, bulb in the bottom face room",
-            "The Body bottom area, bulb in the Jelly Zap room",
-            "The Body bottom area, bulb in the nautilus room",
-            "The Body bottom area, Mutant Costume",
-            "Final Boss area, bulb in the boss third form room",
-            "Final Boss area, first bulb in the turtle room",
-            "Final Boss area, second bulb in the turtle room",
-            "Final Boss area, third bulb in the turtle room",
-            "Final Boss area, Transturtle",
-            "Beating Fallen God",
-            "Beating Blaster Peg Prime",
-            "Beating Mithalan God",
-            "Beating Drunian God",
-            "Beating Sun God",
-            "Beating the Golem",
-            "Beating Nautilus Prime",
-            "Beating Mergog",
-            "Beating Mithalan priests",
-            "Beating Octopus Prime",
-            "Beating King Jellyfish God Prime",
-            "Beating the Golem",
-            "Sunken City cleared",
-            "First secret",
-            "Objective complete"
-        ]
-        items = [["Energy form", "Dual form", "Li and Li song", "Body tongue cleared"]]
-        self.assertAccessDependency(locations, items)

worlds/aquaria/test/test_fish_form_access.py

@@ -17,7 +17,6 @@ class FishFormAccessTest(AquariaTestBase):
         """Test locations that require fish form"""
         locations = [
             "The Veil top left area, bulb inside the fish pass",
-            "Energy Temple first area, Energy Idol",
             "Mithalas City, Doll",
             "Mithalas City, urn inside a home fish pass",
             "Kelp Forest top right area, bulb in the top fish pass",
@@ -31,7 +30,8 @@ class FishFormAccessTest(AquariaTestBase):
             "Octopus Cave, Dumbo Egg",
             "Octopus Cave, bulb in the path below the Octopus Cave path",
             "Beating Octopus Prime",
-            "Abyss left area, bulb in the bottom fish pass"
+            "Abyss left area, bulb in the bottom fish pass",
+            "Arnassi Ruins, Arnassi Armor"
         ]
         items = [["Fish form"]]
         self.assertAccessDependency(locations, items)

worlds/aquaria/test/test_light_access.py

@@ -39,6 +39,7 @@ class LightAccessTest(AquariaTestBase):
             "Abyss right area, bulb in the middle path",
             "Abyss right area, bulb behind the rock in the middle path",
             "Abyss right area, bulb in the left green room",
+            "Abyss right area, Transturtle",
             "Ice Cave, bulb in the room to the right",
             "Ice Cave, first bulb in the top exit room",
             "Ice Cave, second bulb in the top exit room",

worlds/aquaria/test/test_spirit_form_access.py

@@ -30,6 +30,7 @@ class SpiritFormAccessTest(AquariaTestBase):
             "Sunken City left area, Girl Costume",
             "Beating Mantis Shrimp Prime",
             "First secret",
+            "Arnassi Ruins, Arnassi Armor",
         ]
         items = [["Spirit form"]]
         self.assertAccessDependency(locations, items)

worlds/blasphemous/ExtractorConfig.json

@@ -1,19 +0,0 @@
-{
-	"type": "WorldDefinition",
-	"configuration": "./output/StringWorldDefinition.json",
-	"emptyRegionsToKeep": [
-		"D17Z01S01",
-		"D01Z02S01",
-		"D02Z03S09",
-		"D03Z03S11",
-		"D04Z03S01",
-		"D06Z01S09",
-		"D20Z02S09",
-		"D09Z01S09[Cell24]",
-		"D09Z01S08[Cell7]",
-		"D09Z01S08[Cell18]",
-		"D09BZ01S01[Cell24]",
-		"D09BZ01S01[Cell17]",
-		"D09BZ01S01[Cell19]"
-	]
-}

worlds/blasphemous/Items.py

@@ -637,35 +637,52 @@ item_table: List[ItemDict] = [
         'classification': ItemClassification.filler}
 ]
 
+event_table: Dict[str, str] = {
+    "OpenedDCGateW": "D01Z05S24",
+    "OpenedDCGateE": "D01Z05S12",
+    "OpenedDCLadder": "D01Z05S20",
+    "OpenedWOTWCave": "D02Z01S06",
+    "RodeGOTPElevator": "D02Z02S11",
+    "OpenedConventLadder": "D02Z03S11",
+    "BrokeJondoBellW": "D03Z02S09",
+    "BrokeJondoBellE": "D03Z02S05",
+    "OpenedMOMLadder": "D04Z02S06",
+    "OpenedTSCGate": "D05Z02S11",
+    "OpenedARLadder": "D06Z01S23",
+    "BrokeBOTTCStatue": "D08Z01S02",
+    "OpenedWOTHPGate": "D09Z01S05",
+    "OpenedBOTSSLadder": "D17Z01S04"
+}
+
 group_table: Dict[str, Set[str]] = {
-    "wounds"  : {"Holy Wound of Attrition",
+    "wounds"  : ["Holy Wound of Attrition",
                  "Holy Wound of Contrition",
-                 "Holy Wound of Compunction"},
+                 "Holy Wound of Compunction"],
 
-    "masks"   : {"Deformed Mask of Orestes",
+    "masks"   : ["Deformed Mask of Orestes",
                  "Mirrored Mask of Dolphos",
-                 "Embossed Mask of Crescente"},
+                 "Embossed Mask of Crescente"],
 
-    "marks"   : {"Mark of the First Refuge",
+    "marks"   : ["Mark of the First Refuge",
                  "Mark of the Second Refuge",
-                 "Mark of the Third Refuge"},
+                 "Mark of the Third Refuge"],
 
-    "tirso"   : {"Bouquet of Rosemary",
+    "tirso"   : ["Bouquet of Rosemary",
                  "Incense Garlic",
                  "Olive Seeds",
                  "Dried Clove",
                  "Sooty Garlic",
-                 "Bouquet of Thyme"},
+                 "Bouquet of Thyme"],
 
-    "tentudia": {"Tentudia's Carnal Remains",
+    "tentudia": ["Tentudia's Carnal Remains",
                  "Remains of Tentudia's Hair",
-                 "Tentudia's Skeletal Remains"},
+                 "Tentudia's Skeletal Remains"],
 
-    "egg"     : {"Melted Golden Coins",
+    "egg"     : ["Melted Golden Coins",
                  "Torn Bridal Ribbon",
-                 "Black Grieving Veil"},
+                 "Black Grieving Veil"],
 
-    "bones"   : {"Parietal bone of Lasser, the Inquisitor",
+    "bones"   : ["Parietal bone of Lasser, the Inquisitor",
                  "Jaw of Ashgan, the Inquisitor",
                  "Cervical vertebra of Zicher, the Brewmaster",
                  "Clavicle of Dalhuisen, the Schoolchild",
@@ -708,14 +725,14 @@ group_table: Dict[str, Set[str]] = {
                  "Scaphoid of Fierce, the Leper",
                  "Anklebone of Weston, the Pilgrim",
                  "Calcaneum of Persian, the Bandit",
-                 "Navicular of Kahnnyhoo, the Murderer"},
+                 "Navicular of Kahnnyhoo, the Murderer"],
     
-    "power"   : {"Life Upgrade",
+    "power"   : ["Life Upgrade",
                  "Fervour Upgrade",
                  "Empty Bile Vessel",
-                 "Quicksilver"},
+                 "Quicksilver"],
 
-    "prayer"  : {"Seguiriya to your Eyes like Stars",
+    "prayer"  : ["Seguiriya to your Eyes like Stars",
                  "Debla of the Lights",
                  "Saeta Dolorosa",
                  "Campanillero to the Sons of the Aurora",
@@ -729,17 +746,10 @@ group_table: Dict[str, Set[str]] = {
                  "Romance to the Crimson Mist",
                  "Zambra to the Resplendent Crown",
                  "Cantina of the Blue Rose",
-                 "Mirabras of the Return to Port"},
-
-    "toe"     : {"Little Toe made of Limestone",
-                 "Big Toe made of Limestone",
-                 "Fourth Toe made of Limestone"},
-    
-    "eye"     : {"Severed Right Eye of the Traitor",
-                 "Broken Left Eye of the Traitor"}
+                 "Mirabras of the Return to Port"]
 }
 
-tears_list: List[str] = [
+tears_set: Set[str] = [
     "Tears of Atonement (500)",
     "Tears of Atonement (625)",
     "Tears of Atonement (750)",
@@ -762,16 +772,16 @@ tears_list: List[str] = [
     "Tears of Atonement (30000)"
 ]
 
-reliquary_set: Set[str] = {
+reliquary_set: Set[str] = [
     "Reliquary of the Fervent Heart",
     "Reliquary of the Suffering Heart",
     "Reliquary of the Sorrowful Heart"
-}
+]
 
-skill_set: Set[str] = {
+skill_set: Set[str] = [
     "Combo Skill",
     "Charged Skill",
     "Ranged Skill",
     "Dive Skill",
     "Lunge Skill"
-}
+]

worlds/blasphemous/Options.py

@@ -1,5 +1,4 @@
-from dataclasses import dataclass
-from Options import Choice, Toggle, DefaultOnToggle, DeathLink, PerGameCommonOptions, OptionGroup
+from Options import Choice, Toggle, DefaultOnToggle, DeathLink, StartInventoryPool
 import random
 
 
@@ -21,30 +20,23 @@ class ChoiceIsRandom(Choice):
 
 
 class PrieDieuWarp(DefaultOnToggle):
-    """
-    Automatically unlocks the ability to warp between Prie Dieu shrines.
-    """
+    """Automatically unlocks the ability to warp between Prie Dieu shrines."""
     display_name = "Unlock Fast Travel"
 
 
 class SkipCutscenes(DefaultOnToggle):
-    """
-    Automatically skips most cutscenes.
-    """
+    """Automatically skips most cutscenes."""
     display_name = "Auto Skip Cutscenes"
 
 
 class CorpseHints(DefaultOnToggle):
-    """
-    Changes the 34 corpses in game to give various hints about item locations.
-    """
+    """Changes the 34 corpses in game to give various hints about item locations."""
     display_name = "Corpse Hints"
 
 
 class Difficulty(Choice):
-    """
-    Adjusts the overall difficulty of the randomizer, including upgrades required to defeat bosses and advanced movement tricks or glitches.
-    """
+    """Adjusts the overall difficulty of the randomizer, including upgrades required to defeat bosses 
+    and advanced movement tricks or glitches."""
     display_name = "Difficulty"
     option_easy = 0
     option_normal = 1
@@ -53,18 +45,15 @@ class Difficulty(Choice):
 
 
 class Penitence(Toggle):
-    """
-    Allows one of the three Penitences to be chosen at the beginning of the game.
-    """
+    """Allows one of the three Penitences to be chosen at the beginning of the game."""
     display_name = "Penitence"
 
 
 class StartingLocation(ChoiceIsRandom):
-    """
-    Choose where to start the randomizer. Note that some starting locations cannot be chosen with certain other options.
-    
-    Specifically, Brotherhood and Mourning And Havoc cannot be chosen if Shuffle Dash is enabled, and Grievance Ascends cannot be chosen if Shuffle Wall Climb is enabled.
-    """
+    """Choose where to start the randomizer. Note that some starting locations cannot be chosen with certain 
+    other options.
+    Specifically, Brotherhood and Mourning And Havoc cannot be chosen if Shuffle Dash is enabled, and Grievance Ascends 
+    cannot be chosen if Shuffle Wall Climb is enabled."""
     display_name = "Starting Location"
     option_brotherhood = 0
     option_albero = 1
@@ -77,15 +66,10 @@ class StartingLocation(ChoiceIsRandom):
 
 
 class Ending(Choice):
-    """
-    Choose which ending is required to complete the game.
-    
+    """Choose which ending is required to complete the game.
     Talking to Tirso in Albero will tell you the selected ending for the current game.
-    
     Ending A: Collect all thorn upgrades.
-    
-    Ending C: Collect all thorn upgrades and the Holy Wound of Abnegation.
-    """
+    Ending C: Collect all thorn upgrades and the Holy Wound of Abnegation."""
     display_name = "Ending"
     option_any_ending = 0
     option_ending_a = 1
@@ -94,18 +78,14 @@ class Ending(Choice):
 
 
 class SkipLongQuests(Toggle):
-    """
-    Ensures that the rewards for long quests will be filler items.
-    
-    Affected locations: "Albero: Donate 50000 Tears", "Ossuary: 11th reward", "AtTotS: Miriam's gift", "TSC: Jocinero's final reward"
-    """
+    """Ensures that the rewards for long quests will be filler items.
+    Affected locations: \"Albero: Donate 50000 Tears\", \"Ossuary: 11th reward\", \"AtTotS: Miriam's gift\", 
+    \"TSC: Jocinero's final reward\""""
     display_name = "Skip Long Quests"
 
 
 class ThornShuffle(Choice):
-    """
-    Shuffles the Thorn given by Deogracias and all Thorn upgrades into the item pool.
-    """
+    """Shuffles the Thorn given by Deogracias and all Thorn upgrades into the item pool."""
     display_name = "Shuffle Thorn"
     option_anywhere = 0
     option_local_only = 1
@@ -114,68 +94,50 @@ class ThornShuffle(Choice):
 
 
 class DashShuffle(Toggle):
-    """
-    Turns the ability to dash into an item that must be found in the multiworld.
-    """
+    """Turns the ability to dash into an item that must be found in the multiworld."""
     display_name = "Shuffle Dash"
 
 
 class WallClimbShuffle(Toggle):
-    """
-    Turns the ability to climb walls with your sword into an item that must be found in the multiworld.
-    """
+    """Turns the ability to climb walls with your sword into an item that must be found in the multiworld."""
     display_name = "Shuffle Wall Climb"
 
 
 class ReliquaryShuffle(DefaultOnToggle):
-    """
-    Adds the True Torment exclusive Reliquary rosary beads into the item pool.
-    """
+    """Adds the True Torment exclusive Reliquary rosary beads into the item pool."""
     display_name = "Shuffle Penitence Rewards"
 
 
 class CustomItem1(Toggle):
-    """
-    Adds the custom relic Boots of Pleading into the item pool, which grants the ability to fall onto spikes and survive.
-    
-    Must have the "Boots of Pleading" mod installed to connect to a multiworld.
-    """
+    """Adds the custom relic Boots of Pleading into the item pool, which grants the ability to fall onto spikes 
+    and survive.
+    Must have the \"Blasphemous-Boots-of-Pleading\" mod installed to connect to a multiworld."""
     display_name = "Boots of Pleading"
 
 
 class CustomItem2(Toggle):
-    """
-    Adds the custom relic Purified Hand of the Nun into the item pool, which grants the ability to jump a second time in mid-air.
-    
-    Must have the "Double Jump" mod installed to connect to a multiworld.
-    """
+    """Adds the custom relic Purified Hand of the Nun into the item pool, which grants the ability to jump 
+    a second time in mid-air.
+    Must have the \"Blasphemous-Double-Jump\" mod installed to connect to a multiworld."""
     display_name = "Purified Hand of the Nun"
 
 
 class StartWheel(Toggle):
-    """
-    Changes the beginning gift to The Young Mason's Wheel.
-    """
+    """Changes the beginning gift to The Young Mason's Wheel."""
     display_name = "Start with Wheel"
 
 
 class SkillRando(Toggle):
-    """
-    Randomizes the abilities from the skill tree into the item pool.
-    """
+    """Randomizes the abilities from the skill tree into the item pool."""
     display_name = "Skill Randomizer"
 
 
 class EnemyRando(Choice):
-    """
-    Randomizes the enemies that appear in each room.
-    
-    Shuffled: Enemies will be shuffled amongst each other, but can only appear as many times as they do in a standard game.
-    
+    """Randomizes the enemies that appear in each room.
+    Shuffled: Enemies will be shuffled amongst each other, but can only appear as many times as they do in 
+    a standard game.
     Randomized: Every enemy is completely random, and can appear any number of times.
-    
-    Some enemies will never be randomized.
-    """
+    Some enemies will never be randomized."""
     display_name = "Enemy Randomizer"
     option_disabled = 0
     option_shuffled = 1
@@ -184,75 +146,43 @@ class EnemyRando(Choice):
 
 
 class EnemyGroups(DefaultOnToggle):
-    """
-    Randomized enemies will be chosen from sets of specific groups. 
-
+    """Randomized enemies will chosen from sets of specific groups. 
     (Weak, normal, large, flying)
-    
-    Has no effect if Enemy Randomizer is disabled.
-    """
+    Has no effect if Enemy Randomizer is disabled."""
     display_name = "Enemy Groups"
 
 
 class EnemyScaling(DefaultOnToggle):
-    """
-    Randomized enemies will have their stats increased or decreased depending on the area they appear in.
-
-    Has no effect if Enemy Randomizer is disabled.
-    """
+    """Randomized enemies will have their stats increased or decreased depending on the area they appear in.
+    Has no effect if Enemy Randomizer is disabled."""
     display_name = "Enemy Scaling"
 
 
 class BlasphemousDeathLink(DeathLink):
-    """
-    When you die, everyone dies. The reverse is also true.
-
-    Note that Guilt Fragments will not appear when killed by Death Link.
-    """
+    """When you die, everyone dies. The reverse is also true.
+    Note that Guilt Fragments will not appear when killed by Death Link."""
 
 
-@dataclass
-class BlasphemousOptions(PerGameCommonOptions):
-    prie_dieu_warp: PrieDieuWarp
-    skip_cutscenes: SkipCutscenes
-    corpse_hints: CorpseHints
-    difficulty: Difficulty
-    penitence: Penitence
-    starting_location: StartingLocation
-    ending: Ending
-    skip_long_quests: SkipLongQuests
-    thorn_shuffle: ThornShuffle
-    dash_shuffle: DashShuffle
-    wall_climb_shuffle: WallClimbShuffle
-    reliquary_shuffle: ReliquaryShuffle
-    boots_of_pleading: CustomItem1
-    purified_hand: CustomItem2
-    start_wheel: StartWheel
-    skill_randomizer: SkillRando
-    enemy_randomizer: EnemyRando
-    enemy_groups: EnemyGroups
-    enemy_scaling: EnemyScaling
-    death_link: BlasphemousDeathLink
-
-
-blas_option_groups = [
-    OptionGroup("Quality of Life",  [
-        PrieDieuWarp,
-        SkipCutscenes,
-        CorpseHints,
-        SkipLongQuests,
-        StartWheel
-    ]),
-    OptionGroup("Moveset", [
-        DashShuffle,
-        WallClimbShuffle,
-        SkillRando,
-        CustomItem1,
-        CustomItem2
-    ]),
-    OptionGroup("Enemy Randomizer", [
-        EnemyRando,
-        EnemyGroups,
-        EnemyScaling
-    ])
-]
+blasphemous_options = {
+    "prie_dieu_warp": PrieDieuWarp,
+    "skip_cutscenes": SkipCutscenes,
+    "corpse_hints": CorpseHints,
+    "difficulty": Difficulty,
+    "penitence": Penitence,
+    "starting_location": StartingLocation,
+    "ending": Ending,
+    "skip_long_quests": SkipLongQuests,
+    "thorn_shuffle" : ThornShuffle,
+    "dash_shuffle": DashShuffle,
+    "wall_climb_shuffle": WallClimbShuffle,
+    "reliquary_shuffle": ReliquaryShuffle,
+    "boots_of_pleading": CustomItem1,
+    "purified_hand": CustomItem2,
+    "start_wheel": StartWheel,
+    "skill_randomizer": SkillRando,
+    "enemy_randomizer": EnemyRando,
+    "enemy_groups": EnemyGroups,
+    "enemy_scaling": EnemyScaling,
+    "death_link": BlasphemousDeathLink,
+    "start_inventory": StartInventoryPool
+}

worlds/blasphemous/Preprocessor.py

@@ -1,582 +0,0 @@
-# Preprocessor to convert Blasphemous Randomizer logic into a StringWorldDefinition for use with APHKLogicExtractor
-# https://github.com/BrandenEK/Blasphemous.Randomizer
-# https://github.com/ArchipelagoMW-HollowKnight/APHKLogicExtractor
-
-
-import json, requests, argparse
-from typing import List, Dict, Any
-
-
-def load_resource_local(file: str) -> List[Dict[str, Any]]:
-    print(f"Reading from {file}")
-    loaded = []
-    with open(file, encoding="utf-8") as f:
-        loaded = read_json(f.readlines())
-        f.close()
-
-    return loaded
-
-
-def load_resource_from_web(url: str) -> List[Dict[str, Any]]:
-    req = requests.get(url, timeout=1)
-    print(f"Reading from {url}")
-    req.encoding = "utf-8"
-    lines: List[str] = []
-    for line in req.text.splitlines():
-        while "\t" in line:
-            line = line[1::]
-        if line != "":
-            lines.append(line)
-    return read_json(lines)
-
-
-def read_json(lines: List[str]) -> List[Dict[str, Any]]:
-    loaded = []
-    creating_object: bool = False
-    obj: str = ""
-    for line in lines:
-        stripped = line.strip()
-        if "{" in stripped:
-            creating_object = True
-            obj += stripped
-            continue
-        elif "}," in stripped or "}" in stripped and "]" in lines[lines.index(line)+1]:
-            creating_object = False
-            obj += "}"
-            #print(f"obj = {obj}")
-            loaded.append(json.loads(obj))
-            obj = ""
-            continue
-
-        if not creating_object:
-            continue
-        else:
-            try:
-                if "}," in lines[lines.index(line)+1] and stripped[-1] == ",":
-                    obj += stripped[:-1]
-                else:
-                    obj += stripped
-            except IndexError:
-                obj += stripped
-
-    return loaded
-
-
-def get_room_from_door(door: str) -> str:
-    return door[:door.find("[")]
-
-
-def preprocess_logic(is_door: bool, id: str, logic: str) -> str:
-    if id in logic and not is_door:
-        index: int = logic.find(id)
-        logic = logic[:index] + logic[index+len(id)+4:]
-
-    while ">=" in logic:
-        index: int = logic.find(">=")
-        logic = logic[:index-1] + logic[index+3:]
-
-    while ">" in logic:
-        index: int = logic.find(">")
-        count = int(logic[index+2])
-        count += 1
-        logic = logic[:index-1] + str(count) + logic[index+3:]
-
-    while "<=" in logic:
-        index: int = logic.find("<=")
-        logic = logic[:index-1] + logic[index+3:]
-    
-    while "<" in logic:
-        index: int = logic.find("<")
-        count = int(logic[index+2])
-        count += 1
-        logic = logic[:index-1] + str(count) + logic[index+3:]
-
-    #print(logic)
-    return logic
-
-
-def build_logic_conditions(logic: str) -> List[List[str]]:
-    all_conditions: List[List[str]] = []
-
-    parts = logic.split()
-    sub_part: str = ""
-    current_index: int = 0
-    parens: int = -1
-    current_condition: List[str] = []
-    parens_conditions: List[List[List[str]]] = []
-
-    for index, part in enumerate(parts):
-        #print(current_index, index, parens, part)
-
-        # skip parts that have already been handled
-        if index < current_index:
-            continue
-
-        # break loop if reached final part
-        try:
-            parts[index+1]
-        except IndexError:
-            #print("INDEXERROR", part)
-            if parens < 0:
-                current_condition.append(part)
-                if len(parens_conditions) > 0:
-                    for i in parens_conditions:
-                        for j in i:
-                            all_conditions.append(j + current_condition)
-                else:
-                    all_conditions.append(current_condition)
-                break
-
-        #print(current_condition, parens, sub_part)
-
-        # prepare for subcondition
-        if "(" in part:
-            # keep track of nested parentheses
-            if parens == -1:
-                parens = 0
-            for char in part:
-                if char == "(":
-                    parens += 1
-            
-            # add to sub part
-            if sub_part == "":
-                sub_part = part
-            else:
-                sub_part += f" {part}"
-            #if not ")" in part:
-            continue
-
-        # end of subcondition
-        if ")" in part:
-            # read every character in case of multiple closing parentheses
-            for char in part:
-                if char == ")":
-                    parens -= 1
-
-            sub_part += f" {part}"
-
-            # if reached end of parentheses, handle subcondition
-            if parens == 0:
-                #print(current_condition, sub_part)
-                parens = -1
-
-                try:
-                    parts[index+1]
-                except IndexError:
-                    #print("END OF LOGIC")
-                    if len(parens_conditions) > 0:
-                        parens_conditions.append(build_logic_subconditions(current_condition, sub_part))
-                        #print("PARENS:", parens_conditions)
-
-                        temp_conditions: List[List[str]] = []
-
-                        for i in parens_conditions[0]:
-                            for j in parens_conditions[1]:
-                                temp_conditions.append(i + j)
-
-                        parens_conditions.pop(0)
-                        parens_conditions.pop(0)
-
-                        while len(parens_conditions) > 0:
-                            temp_conditions2 = temp_conditions
-                            temp_conditions = []
-                            for k in temp_conditions2:
-                                for l in parens_conditions[0]:
-                                    temp_conditions.append(k + l)
-                            
-                            parens_conditions.pop(0)
-
-                        #print("TEMP:", remove_duplicates(temp_conditions))
-                        all_conditions += temp_conditions
-                    else:
-                        all_conditions += build_logic_subconditions(current_condition, sub_part)
-                else:
-                    #print("NEXT PARTS:", parts[index+1], parts[index+2])
-                    if parts[index+1] == "&&":
-                        parens_conditions.append(build_logic_subconditions(current_condition, sub_part))
-                        #print("PARENS:", parens_conditions)
-                    else:
-                        if len(parens_conditions) > 0:
-                            parens_conditions.append(build_logic_subconditions(current_condition, sub_part))
-                            #print("PARENS:", parens_conditions)
-
-                            temp_conditions: List[List[str]] = []
-
-                            for i in parens_conditions[0]:
-                                for j in parens_conditions[1]:
-                                    temp_conditions.append(i + j)
-
-                            parens_conditions.pop(0)
-                            parens_conditions.pop(0)
-
-                            while len(parens_conditions) > 0:
-                                temp_conditions2 = temp_conditions
-                                temp_conditions = []
-                                for k in temp_conditions2:
-                                    for l in parens_conditions[0]:
-                                        temp_conditions.append(k + l)
-                                
-                                parens_conditions.pop(0)
-
-                            #print("TEMP:", remove_duplicates(temp_conditions))
-                            all_conditions += temp_conditions
-                        else:
-                            all_conditions += build_logic_subconditions(current_condition, sub_part)
-
-                    current_index = index+2
-                    
-                    current_condition = []
-                    sub_part = ""
-                    
-            continue
-
-        # collect all parts until reaching end of parentheses
-        if parens > 0:
-            sub_part += f" {part}"
-            continue
-
-        current_condition.append(part)
-
-        # continue with current condition
-        if parts[index+1] == "&&":
-            current_index = index+2
-            continue
-        
-        # add condition to list and start new one
-        elif parts[index+1] == "||":
-            if len(parens_conditions) > 0:
-                for i in parens_conditions:
-                    for j in i:
-                        all_conditions.append(j + current_condition)
-                parens_conditions = []
-            else:    
-                all_conditions.append(current_condition)
-            current_condition = []
-            current_index = index+2
-            continue
-        
-    return remove_duplicates(all_conditions)
-
-
-def build_logic_subconditions(current_condition: List[str], subcondition: str) -> List[List[str]]:
-    #print("STARTED SUBCONDITION", current_condition, subcondition)
-    subconditions = build_logic_conditions(subcondition[1:-1])
-    final_conditions = []
-
-    for condition in subconditions:
-        final_condition = current_condition + condition
-        final_conditions.append(final_condition)
-
-    #print("ENDED SUBCONDITION")
-    #print(final_conditions)
-    return final_conditions
-
-
-def remove_duplicates(conditions: List[List[str]]) -> List[List[str]]:
-    final_conditions: List[List[str]] = []
-    for condition in conditions:
-        final_conditions.append(list(dict.fromkeys(condition)))
-
-    return final_conditions
-
-
-def handle_door_visibility(door: Dict[str, Any]) -> Dict[str, Any]:
-    if door.get("visibilityFlags") == None:
-        return door
-    else:
-        flags: List[str] = str(door.get("visibilityFlags")).split(", ")
-        #print(flags)
-        temp_flags: List[str] = []
-        this_door: bool = False
-        #required_doors: str = ""
-
-        if "ThisDoor" in flags:
-            this_door = True
-
-        #if "requiredDoors" in flags:
-        #    required_doors: str = " || ".join(door.get("requiredDoors"))
-
-        if "DoubleJump" in flags:
-            temp_flags.append("DoubleJump")
-
-        if "NormalLogic" in flags:
-            temp_flags.append("NormalLogic")
-
-        if "NormalLogicAndDoubleJump" in flags:
-            temp_flags.append("NormalLogicAndDoubleJump")
-
-        if "HardLogic" in flags:
-            temp_flags.append("HardLogic")
-
-        if "HardLogicAndDoubleJump" in flags:
-            temp_flags.append("HardLogicAndDoubleJump")
-
-        if "EnemySkips" in flags:
-            temp_flags.append("EnemySkips")
-
-        if "EnemySkipsAndDoubleJump" in flags:
-            temp_flags.append("EnemySkipsAndDoubleJump")
-
-        # remove duplicates
-        temp_flags = list(dict.fromkeys(temp_flags))
-
-        original_logic: str = door.get("logic")
-        temp_logic: str = ""
-
-        if this_door:
-            temp_logic = door.get("id")
-
-        if temp_flags != []:
-            if temp_logic != "":
-                temp_logic += " || "
-            temp_logic += ' && '.join(temp_flags)
-
-        if temp_logic != "" and original_logic != None:
-            if len(original_logic.split()) == 1:
-                if len(temp_logic.split()) == 1:
-                    door["logic"] = f"{temp_logic} && {original_logic}"
-                else:
-                    door["logic"] = f"({temp_logic}) && {original_logic}"
-            else:
-                if len(temp_logic.split()) == 1:
-                    door["logic"] = f"{temp_logic} && ({original_logic})"
-                else:
-                    door["logic"] = f"({temp_logic}) && ({original_logic})"
-        elif temp_logic != "" and original_logic == None:
-            door["logic"] = temp_logic
-        
-        return door
-
-
-def get_state_provider_for_condition(condition: List[str]) -> str:
-    for item in condition:
-        if (item[0] == "D" and item[3] == "Z" and item[6] == "S")\
-        or (item[0] == "D" and item[3] == "B" and item[4] == "Z" and item[7] == "S"):
-            return item
-    return None
-
-
-def parse_args() -> argparse.Namespace:
-    parser = argparse.ArgumentParser()
-    parser.add_argument('-l', '--local', action="store_true", help="Use local files in the same directory instead of reading resource files from the BrandenEK/Blasphemous-Randomizer repository.")
-    args = parser.parse_args()
-    return args
-
-
-def main(args: argparse.Namespace):
-    doors = []
-    locations = []
-
-    if (args.local):
-        doors = load_resource_local("doors.json")
-        locations = load_resource_local("locations_items.json")
-    
-    else:
-        doors = load_resource_from_web("https://raw.githubusercontent.com/BrandenEK/Blasphemous-Randomizer/main/resources/data/Randomizer/doors.json")
-        locations = load_resource_from_web("https://raw.githubusercontent.com/BrandenEK/Blasphemous-Randomizer/main/resources/data/Randomizer/locations_items.json")
-
-    original_connections: Dict[str, str] = {}
-    rooms: Dict[str, List[str]] = {}
-    output: Dict[str, Any] = {}
-    logic_objects: List[Dict[str, Any]] = []
-
-    for door in doors:
-         if door.get("originalDoor") != None:
-            if not door.get("id") in original_connections:
-                original_connections[door.get("id")] = door.get("originalDoor")
-                original_connections[door.get("originalDoor")] = door.get("id")
-
-            room: str = get_room_from_door(door.get("originalDoor"))
-            if not room in rooms.keys():
-                rooms[room] = [door.get("id")]
-            else:
-                rooms[room].append(door.get("id"))
-
-    def flip_doors_in_condition(condition: List[str]) -> List[str]:
-        new_condition = []
-        for item in condition:
-            if item in original_connections:
-                new_condition.append(original_connections[item])
-            else:
-                new_condition.append(item)
-
-        return new_condition
-    
-    for room in rooms.keys():
-        obj = {
-            "Name": room,
-            "Logic": [],
-            "Handling": "Default"
-        }
-
-        for door in rooms[room]:
-            logic = {
-                "StateProvider": door,
-                "Conditions": [],
-                "StateModifiers": []
-            }
-            obj["Logic"].append(logic)
-        
-        logic_objects.append(obj)
-
-    for door in doors:
-        if door.get("direction") == 5:
-            continue
-
-        handling: str = "Transition"
-        if "Cell" in door.get("id"):
-            handling = "Default"
-        obj = {
-            "Name": door.get("id"),
-            "Logic": [],
-            "Handling": handling
-        }
-
-        visibility_flags: List[str] = []
-        if door.get("visibilityFlags") != None:
-            visibility_flags = str(door.get("visibilityFlags")).split(", ")
-            if "1" in visibility_flags:
-                visibility_flags.remove("1")
-                visibility_flags.append("ThisDoor")
-
-        required_doors: List[str] = []
-        if door.get("requiredDoors"):
-            required_doors = door.get("requiredDoors")
-
-        if len(visibility_flags) > 0:
-            for flag in visibility_flags:
-                if flag == "RequiredDoors":
-                    continue
-
-                if flag == "ThisDoor":
-                    flag = original_connections[door.get("id")]
-                
-                if door.get("logic") != None:
-                    logic: str = door.get("logic")
-                    logic = f"{flag} && ({logic})"
-                    logic = preprocess_logic(True, door.get("id"), logic)
-                    conditions = build_logic_conditions(logic)
-                    for condition in conditions:
-                        condition = flip_doors_in_condition(condition)
-                        state_provider: str = get_room_from_door(door.get("id"))
-
-                        if get_state_provider_for_condition(condition) != None:
-                            state_provider = get_state_provider_for_condition(condition)
-                            condition.remove(state_provider)
-
-                        logic = {
-                            "StateProvider": state_provider,
-                            "Conditions": condition,
-                            "StateModifiers": []
-                        }
-                        obj["Logic"].append(logic)
-                else:
-                    logic = {
-                        "StateProvider": get_room_from_door(door.get("id")),
-                        "Conditions": [flag],
-                        "StateModifiers": []
-                    }
-                    obj["Logic"].append(logic)
-            
-            if "RequiredDoors" in visibility_flags:
-                for d in required_doors:
-                    flipped = original_connections[d]
-                    if door.get("logic") != None:
-                        logic: str = preprocess_logic(True, door.get("id"), door.get("logic"))
-                        conditions = build_logic_conditions(logic)
-                        for condition in conditions:
-                            condition = flip_doors_in_condition(condition)
-                            state_provider: str = flipped
-
-                            if flipped in condition:
-                                condition.remove(flipped)
-
-                            logic = {
-                                "StateProvider": state_provider,
-                                "Conditions": condition,
-                                "StateModifiers": []
-                            }
-                            obj["Logic"].append(logic)
-                    else:
-                        logic = {
-                            "StateProvider": flipped,
-                            "Conditions": [],
-                            "StateModifiers": []
-                        }
-                        obj["Logic"].append(logic)
-
-        else:
-            if door.get("logic") != None:
-                logic: str = preprocess_logic(True, door.get("id"), door.get("logic"))
-                conditions = build_logic_conditions(logic)
-                for condition in conditions:
-                    condition = flip_doors_in_condition(condition)
-                    stateProvider: str = get_room_from_door(door.get("id"))
-
-                    if get_state_provider_for_condition(condition) != None:
-                        stateProvider = get_state_provider_for_condition(condition)
-                        condition.remove(stateProvider)
-
-                    logic = {
-                        "StateProvider": stateProvider,
-                        "Conditions": condition,
-                        "StateModifiers": []
-                    }
-                    obj["Logic"].append(logic)
-            else:
-                logic = {
-                    "StateProvider": get_room_from_door(door.get("id")),
-                    "Conditions": [],
-                    "StateModifiers": []
-                }
-                obj["Logic"].append(logic)
-
-        logic_objects.append(obj)
-
-    for location in locations:
-        obj = {
-            "Name": location.get("id"),
-            "Logic": [],
-            "Handling": "Location"
-        }
-
-        if location.get("logic") != None:
-            for condition in build_logic_conditions(preprocess_logic(False, location.get("id"), location.get("logic"))):
-                condition = flip_doors_in_condition(condition)
-                stateProvider: str = location.get("room")
-
-                if get_state_provider_for_condition(condition) != None:
-                    stateProvider = get_state_provider_for_condition(condition)
-                    condition.remove(stateProvider)
-
-                if stateProvider == "Initial":
-                    stateProvider = None
-
-                logic = {
-                    "StateProvider": stateProvider,
-                    "Conditions": condition,
-                    "StateModifiers": []
-                }
-                obj["Logic"].append(logic)
-        else:
-            stateProvider: str = location.get("room")
-            if stateProvider == "Initial":
-                stateProvider = None
-            logic = {
-                "StateProvider": stateProvider,
-                "Conditions": [],
-                "StateModifiers": []
-            }
-            obj["Logic"].append(logic)
-
-        logic_objects.append(obj)
-
-    output["LogicObjects"] = logic_objects
-        
-    with open("StringWorldDefinition.json", "w") as file:
-        print("Writing to StringWorldDefinition.json")
-        file.write(json.dumps(output, indent=4))
-
-
-if __name__ == "__main__":
-    main(parse_args())

worlds/blasphemous/Vanilla.py

@@ -8,12 +8,12 @@ unrandomized_dict: Dict[str, str] = {
 }
 
 
-junk_locations: Set[str] = {
+junk_locations: Set[str] = [
     "Albero: Donate 50000 Tears",
     "Ossuary: 11th reward",
     "AtTotS: Miriam's gift",
     "TSC: Jocinero's final reward"
-}
+]
 
 
 thorn_set: Set[str] = {
@@ -44,4 +44,4 @@ skill_dict: Dict[str, str] = {
     "Skill 5, Tier 1": "Lunge Skill",
     "Skill 5, Tier 2": "Lunge Skill",
     "Skill 5, Tier 3": "Lunge Skill",
-}
+}

worlds/blasphemous/__init__.py

@@ -1,15 +1,15 @@
 from typing import Dict, List, Set, Any
 from collections import Counter
-from BaseClasses import Region, Location, Item, Tutorial, ItemClassification
-from Options import OptionError
+from BaseClasses import Region, Entrance, Location, Item, Tutorial, ItemClassification
 from worlds.AutoWorld import World, WebWorld
-from .Items import base_id, item_table, group_table, tears_list, reliquary_set
-from .Locations import location_names
-from .Rules import BlasRules
-from worlds.generic.Rules import set_rule
-from .Options import BlasphemousOptions, blas_option_groups
+from .Items import base_id, item_table, group_table, tears_set, reliquary_set, event_table
+from .Locations import location_table
+from .Rooms import room_table, door_table
+from .Rules import rules
+from worlds.generic.Rules import set_rule, add_rule
+from .Options import blasphemous_options
 from .Vanilla import unrandomized_dict, junk_locations, thorn_set, skill_dict
-from .region_data import regions, locations
+
 
 class BlasphemousWeb(WebWorld):
     theme = "stone"
@@ -21,33 +21,39 @@ class BlasphemousWeb(WebWorld):
         "setup/en",
         ["TRPG"]
     )]
-    option_groups = blas_option_groups
 
 
 class BlasphemousWorld(World):
     """
     Blasphemous is a challenging Metroidvania set in the cursed land of Cvstodia. Play as the Penitent One, trapped
-    in an endless cycle of death and rebirth, and free the world from its terrible fate in your quest to break
+    in an endless cycle of death and rebirth, and free the world from it's terrible fate in your quest to break
     your eternal damnation!
     """
 
-    game = "Blasphemous"
+    game: str = "Blasphemous"
     web = BlasphemousWeb()
 
     item_name_to_id = {item["name"]: (base_id + index) for index, item in enumerate(item_table)}
-    location_name_to_id = {loc: (base_id + index) for index, loc in enumerate(location_names.values())}
+    location_name_to_id = {loc["name"]: (base_id + index) for index, loc in enumerate(location_table)}
+    location_name_to_game_id = {loc["name"]: loc["game_id"] for loc in location_table}
 
     item_name_groups = group_table
-    options_dataclass = BlasphemousOptions
-    options: BlasphemousOptions
+    option_definitions = blasphemous_options
 
-    required_client_version = (0, 4, 7)
+    required_client_version = (0, 4, 2)
 
 
     def __init__(self, multiworld, player):
         super(BlasphemousWorld, self).__init__(multiworld, player)
         self.start_room: str = "D17Z01S01"
-        self.disabled_locations: List[str] = []
+        self.door_connections: Dict[str, str] = {}
+
+
+    def set_rules(self):
+        rules(self)
+        for door in door_table:
+            add_rule(self.multiworld.get_location(door["Id"], self.player),
+                lambda state: state.can_reach(self.get_connected_door(door["Id"])), self.player)
 
 
     def create_item(self, name: str) -> "BlasphemousItem":
@@ -62,56 +68,64 @@ class BlasphemousWorld(World):
 
 
     def get_filler_item_name(self) -> str:
-        return self.random.choice(tears_list)
+        return self.multiworld.random.choice(tears_set)
 
 
     def generate_early(self):
-        if not self.options.starting_location.randomized:
-            if self.options.starting_location == "mourning_havoc" and self.options.difficulty < 2:
-                raise OptionError(f"[Blasphemous - '{self.player_name}'] "
-                                f"{self.options.starting_location} cannot be chosen if Difficulty is lower than Hard.")
+        world = self.multiworld
+        player = self.player
 
-            if (self.options.starting_location == "brotherhood" or self.options.starting_location == "mourning_havoc") \
-                and self.options.dash_shuffle:
-                    raise OptionError(f"[Blasphemous - '{self.player_name}'] "
-                                    f"{self.options.starting_location} cannot be chosen if Shuffle Dash is enabled.")
+        if not world.starting_location[player].randomized:
+            if world.starting_location[player].value == 6 and world.difficulty[player].value < 2:
+                raise Exception(f"[Blasphemous - '{world.get_player_name(player)}'] {world.starting_location[player]}"
+                                " cannot be chosen if Difficulty is lower than Hard.")
+
+            if (world.starting_location[player].value == 0 or world.starting_location[player].value == 6) \
+                and world.dash_shuffle[player]:
+                    raise Exception(f"[Blasphemous - '{world.get_player_name(player)}'] {world.starting_location[player]}"
+                                    " cannot be chosen if Shuffle Dash is enabled.")
             
-            if self.options.starting_location == "grievance" and self.options.wall_climb_shuffle:
-                raise OptionError(f"[Blasphemous - '{self.player_name}'] "
-                                f"{self.options.starting_location} cannot be chosen if Shuffle Wall Climb is enabled.")
+            if world.starting_location[player].value == 3 and world.wall_climb_shuffle[player]:
+                raise Exception(f"[Blasphemous - '{world.get_player_name(player)}'] {world.starting_location[player]}"
+                                " cannot be chosen if Shuffle Wall Climb is enabled.")
         else:
             locations: List[int] = [ 0, 1, 2, 3, 4, 5, 6 ]
+            invalid: bool = False
 
-            if self.options.difficulty < 2:
+            if world.difficulty[player].value < 2:
                 locations.remove(6)
 
-            if self.options.dash_shuffle:
+            if world.dash_shuffle[player]:
                 locations.remove(0)
                 if 6 in locations:
                     locations.remove(6)
 
-            if self.options.wall_climb_shuffle:
+            if world.wall_climb_shuffle[player]:
                 locations.remove(3)
 
-            if self.options.starting_location.value not in locations:
-                self.options.starting_location.value = self.random.choice(locations)
+            if world.starting_location[player].value == 6 and world.difficulty[player].value < 2:
+                invalid = True
+
+            if (world.starting_location[player].value == 0 or world.starting_location[player].value == 6) \
+                and world.dash_shuffle[player]:
+                    invalid = True
+            
+            if world.starting_location[player].value == 3 and world.wall_climb_shuffle[player]:
+                invalid = True
+
+            if invalid:
+                world.starting_location[player].value = world.random.choice(locations)
             
         
-        if not self.options.dash_shuffle:
-            self.multiworld.push_precollected(self.create_item("Dash Ability"))
+        if not world.dash_shuffle[player]:
+            world.push_precollected(self.create_item("Dash Ability"))
 
-        if not self.options.wall_climb_shuffle:
-            self.multiworld.push_precollected(self.create_item("Wall Climb Ability"))
+        if not world.wall_climb_shuffle[player]:
+            world.push_precollected(self.create_item("Wall Climb Ability"))
 
-        if not self.options.boots_of_pleading:
-            self.disabled_locations.append("RE401")
-
-        if not self.options.purified_hand:
-            self.disabled_locations.append("RE402")
-
-        if self.options.skip_long_quests:
+        if world.skip_long_quests[player]:
             for loc in junk_locations:
-                self.options.exclude_locations.value.add(loc)
+                world.exclude_locations[player].value.add(loc)
 
         start_rooms: Dict[int, str] = {
             0: "D17Z01S01",
@@ -123,10 +137,13 @@ class BlasphemousWorld(World):
             6: "D20Z02S09"
         }
 
-        self.start_room = start_rooms[self.options.starting_location.value]
+        self.start_room = start_rooms[world.starting_location[player].value]
 
 
     def create_items(self):
+        world = self.multiworld
+        player = self.player
+
         removed: int = 0
         to_remove: List[str] = [
             "Tears of Atonement (250)",
@@ -139,46 +156,46 @@ class BlasphemousWorld(World):
         skipped_items = []
         junk: int = 0
 
-        for item, count in self.options.start_inventory.value.items():
+        for item, count in world.start_inventory[player].value.items():
             for _ in range(count):
                 skipped_items.append(item)
                 junk += 1
 
         skipped_items.extend(unrandomized_dict.values())
 
-        if self.options.thorn_shuffle == "vanilla":
-            for _ in range(8):
+        if world.thorn_shuffle[player] == 2:
+            for i in range(8):
                 skipped_items.append("Thorn Upgrade")
 
-        if self.options.dash_shuffle:
+        if world.dash_shuffle[player]:
             skipped_items.append(to_remove[removed])
             removed += 1
-        elif not self.options.dash_shuffle:
+        elif not world.dash_shuffle[player]:
             skipped_items.append("Dash Ability")
 
-        if self.options.wall_climb_shuffle:
+        if world.wall_climb_shuffle[player]:
             skipped_items.append(to_remove[removed])
             removed += 1
-        elif not self.options.wall_climb_shuffle:
+        elif not world.wall_climb_shuffle[player]:
             skipped_items.append("Wall Climb Ability")
 
-        if not self.options.reliquary_shuffle:
+        if not world.reliquary_shuffle[player]:
             skipped_items.extend(reliquary_set)
-        elif self.options.reliquary_shuffle:
-            for _ in range(3):
+        elif world.reliquary_shuffle[player]:
+            for i in range(3):
                 skipped_items.append(to_remove[removed])
                 removed += 1
 
-        if not self.options.boots_of_pleading:
+        if not world.boots_of_pleading[player]:
             skipped_items.append("Boots of Pleading")
 
-        if not self.options.purified_hand:
+        if not world.purified_hand[player]:
             skipped_items.append("Purified Hand of the Nun")
 
-        if self.options.start_wheel:
+        if world.start_wheel[player]:
             skipped_items.append("The Young Mason's Wheel")
 
-        if not self.options.skill_randomizer:
+        if not world.skill_randomizer[player]:
             skipped_items.extend(skill_dict.values())
 
         counter = Counter(skipped_items)
@@ -191,140 +208,184 @@ class BlasphemousWorld(World):
             if count <= 0:
                 continue
             else:
-                for _ in range(count):
+                for i in range(count):
                     pool.append(self.create_item(item["name"]))
 
         for _ in range(junk):
             pool.append(self.create_item(self.get_filler_item_name()))
 
-        self.multiworld.itempool += pool
+        world.itempool += pool
 
 
     def pre_fill(self):
+        world = self.multiworld
+        player = self.player
+
         self.place_items_from_dict(unrandomized_dict)
 
-        if self.options.thorn_shuffle == "vanilla":
+        if world.thorn_shuffle[player] == 2:
             self.place_items_from_set(thorn_set, "Thorn Upgrade")
 
-        if self.options.start_wheel:
-            self.get_location("Beginning gift").place_locked_item(self.create_item("The Young Mason's Wheel"))
+        if world.start_wheel[player]:
+            world.get_location("Beginning gift", player)\
+                .place_locked_item(self.create_item("The Young Mason's Wheel"))
 
-        if not self.options.skill_randomizer:
+        if not world.skill_randomizer[player]:
             self.place_items_from_dict(skill_dict)
 
-        if self.options.thorn_shuffle == "local_only":
-            self.options.local_items.value.add("Thorn Upgrade")
+        if world.thorn_shuffle[player] == 1:
+            world.local_items[player].value.add("Thorn Upgrade")
         
 
     def place_items_from_set(self, location_set: Set[str], name: str):
         for loc in location_set:
-            self.get_location(loc).place_locked_item(self.create_item(name))
+            self.multiworld.get_location(loc, self.player)\
+                .place_locked_item(self.create_item(name))
 
     
     def place_items_from_dict(self, option_dict: Dict[str, str]):
         for loc, item in option_dict.items():
-            self.get_location(loc).place_locked_item(self.create_item(item))
+            self.multiworld.get_location(loc, self.player)\
+                .place_locked_item(self.create_item(item))
 
 
     def create_regions(self) -> None:
-        multiworld = self.multiworld
         player = self.player
-
-        created_regions: List[str] = []
-
-        for r in regions:
-            multiworld.regions.append(Region(r["name"], player, multiworld))
-            created_regions.append(r["name"])
-
-        self.get_region("Menu").add_exits({self.start_room: "New Game"})
-
-        blas_logic = BlasRules(self)
-
-        for r in regions:
-            region = self.get_region(r["name"])
-
-            for e in r["exits"]:
-                region.add_exits({e["target"]}, {e["target"]: blas_logic.load_rule(True, r["name"], e)})
-
-            for l in [l for l in r["locations"] if l not in self.disabled_locations]:
-                region.add_locations({location_names[l]: self.location_name_to_id[location_names[l]]}, BlasphemousLocation)
-
-            for t in r["transitions"]:
-                if t == r["name"]:
-                    continue
-                
-                if t in created_regions:
-                    region.add_exits({t})
-                else:
-                    multiworld.regions.append(Region(t, player, multiworld))
-                    created_regions.append(t)
-                    region.add_exits({t})
-
-
-        for l in [l for l in locations if l["name"] not in self.disabled_locations]:
-            location = self.get_location(location_names[l["name"]])
-            set_rule(location, blas_logic.load_rule(False, l["name"], l))
-
-        for rname, ename in blas_logic.indirect_conditions:
-            self.multiworld.register_indirect_condition(self.get_region(rname), self.get_entrance(ename))
-        #from Utils import visualize_regions
-        #visualize_regions(self.get_region("Menu"), "blasphemous_regions.puml")
+        world = self.multiworld
         
-        victory = Location(player, "His Holiness Escribar", None, self.get_region("D07Z01S03[W]"))
-        victory.place_locked_item(self.create_event("Victory"))
-        self.get_region("D07Z01S03[W]").locations.append(victory)
+        menu_region = Region("Menu", player, world)
+        misc_region = Region("Misc", player, world)
+        world.regions += [menu_region, misc_region]
 
-        if self.options.ending == "ending_a":
+        for room in room_table:
+            region = Region(room, player, world)
+            world.regions.append(region)
+
+        menu_region.add_exits({self.start_room: "New Game"})
+        world.get_region(self.start_room, player).add_exits({"Misc": "Misc"})
+
+        for door in door_table:
+            if door.get("OriginalDoor") is None:
+                continue
+            else:
+                if not door["Id"] in self.door_connections.keys():
+                    self.door_connections[door["Id"]] = door["OriginalDoor"]
+                    self.door_connections[door["OriginalDoor"]] = door["Id"]
+
+                parent_region: Region = self.get_room_from_door(door["Id"])
+                target_region: Region = self.get_room_from_door(door["OriginalDoor"])
+                parent_region.add_exits({
+                    target_region.name: door["Id"]
+                }, {
+                    target_region.name: lambda x: door.get("VisibilityFlags") != 1
+                })
+
+        for index, loc in enumerate(location_table):
+            if not world.boots_of_pleading[player] and loc["name"] == "BotSS: 2nd meeting with Redento":
+                continue
+            if not world.purified_hand[player] and loc["name"] == "MoM: Western room ledge":
+                continue
+
+            region: Region = world.get_region(loc["room"], player)
+            region.add_locations({loc["name"]: base_id + index})
+            #id = base_id + location_table.index(loc)
+            #reg.locations.append(BlasphemousLocation(player, loc["name"], id, reg))
+
+        for e, r in event_table.items():
+            region: Region = world.get_region(r, player)
+            event = BlasphemousLocation(player, e, None, region)
+            event.show_in_spoiler = False
+            event.place_locked_item(self.create_event(e))
+            region.locations.append(event)
+
+        for door in door_table:
+            region: Region = self.get_room_from_door(self.door_connections[door["Id"]])
+            event = BlasphemousLocation(player, door["Id"], None, region)
+            event.show_in_spoiler = False
+            event.place_locked_item(self.create_event(door["Id"]))
+            region.locations.append(event)
+        
+        victory = Location(player, "His Holiness Escribar", None, world.get_region("D07Z01S03", player))
+        victory.place_locked_item(self.create_event("Victory"))
+        world.get_region("D07Z01S03", player).locations.append(victory)
+
+        if world.ending[self.player].value == 1:
             set_rule(victory, lambda state: state.has("Thorn Upgrade", player, 8))
-        elif self.options.ending == "ending_c":
+        elif world.ending[self.player].value == 2:
             set_rule(victory, lambda state: state.has("Thorn Upgrade", player, 8) and
                 state.has("Holy Wound of Abnegation", player))
 
-        multiworld.completion_condition[self.player] = lambda state: state.has("Victory", player)
+        world.completion_condition[self.player] = lambda state: state.has("Victory", player)
+        
+
+    def get_room_from_door(self, door: str) -> Region:
+        return self.multiworld.get_region(door.split("[")[0], self.player)
+
+    
+    def get_connected_door(self, door: str) -> Entrance:
+        return self.multiworld.get_entrance(self.door_connections[door], self.player)
     
     
     def fill_slot_data(self) -> Dict[str, Any]:
         slot_data: Dict[str, Any] = {}
+        locations = []
         doors: Dict[str, str] = {}
+
+        world = self.multiworld
+        player = self.player
         thorns: bool = True
 
-        if self.options.thorn_shuffle == "vanilla":
+        if world.thorn_shuffle[player].value == 2:
             thorns = False
 
+        for loc in world.get_filled_locations(player):
+            if loc.item.code == None:
+                continue
+            else:
+                data = {
+                    "id": self.location_name_to_game_id[loc.name],
+                    "ap_id": loc.address,
+                    "name": loc.item.name,
+                    "player_name": world.player_name[loc.item.player],
+                    "type": int(loc.item.classification)
+                }
+
+                locations.append(data)
+
         config = {
-            "LogicDifficulty": self.options.difficulty.value,
-            "StartingLocation": self.options.starting_location.value,
+            "LogicDifficulty": world.difficulty[player].value,
+            "StartingLocation": world.starting_location[player].value,
             "VersionCreated": "AP",
             
-            "UnlockTeleportation": bool(self.options.prie_dieu_warp.value),
-            "AllowHints": bool(self.options.corpse_hints.value),
-            "AllowPenitence": bool(self.options.penitence.value),
+            "UnlockTeleportation": bool(world.prie_dieu_warp[player].value),
+            "AllowHints": bool(world.corpse_hints[player].value),
+            "AllowPenitence": bool(world.penitence[player].value),
             
-            "ShuffleReliquaries": bool(self.options.reliquary_shuffle.value),
-            "ShuffleBootsOfPleading": bool(self.options.boots_of_pleading.value),
-            "ShufflePurifiedHand": bool(self.options.purified_hand.value),
-            "ShuffleDash": bool(self.options.dash_shuffle.value),
-            "ShuffleWallClimb": bool(self.options.wall_climb_shuffle.value),
+            "ShuffleReliquaries": bool(world.reliquary_shuffle[player].value),
+            "ShuffleBootsOfPleading": bool(world.boots_of_pleading[player].value),
+            "ShufflePurifiedHand": bool(world.purified_hand[player].value),
+            "ShuffleDash": bool(world.dash_shuffle[player].value),
+            "ShuffleWallClimb": bool(world.wall_climb_shuffle[player].value),
             
-            "ShuffleSwordSkills": bool(self.options.wall_climb_shuffle.value),
+            "ShuffleSwordSkills": bool(world.skill_randomizer[player].value),
             "ShuffleThorns": thorns,
-            "JunkLongQuests": bool(self.options.skip_long_quests.value),
-            "StartWithWheel": bool(self.options.start_wheel.value),
+            "JunkLongQuests": bool(world.skip_long_quests[player].value),
+            "StartWithWheel": bool(world.start_wheel[player].value),
 
-            "EnemyShuffleType": self.options.enemy_randomizer.value,
-            "MaintainClass": bool(self.options.enemy_groups.value),
-            "AreaScaling": bool(self.options.enemy_scaling.value),
+            "EnemyShuffleType": world.enemy_randomizer[player].value,
+            "MaintainClass": bool(world.enemy_groups[player].value),
+            "AreaScaling": bool(world.enemy_scaling[player].value),
 
             "BossShuffleType": 0,
             "DoorShuffleType": 0
         }
     
         slot_data = {
-            "locationinfo": [{"gameId": loc, "apId": (base_id + index)} for index, loc in enumerate(location_names)],
+            "locations": locations,
             "doors": doors,
             "cfg": config,
-            "ending": self.options.ending.value,
-            "death_link": bool(self.options.death_link.value)
+            "ending": world.ending[self.player].value,
+            "death_link": bool(world.death_link[self.player].value)
         }
     
         return slot_data

worlds/blasphemous/docs/setup_en.md

@@ -1,17 +1,48 @@
 # Blasphemous Multiworld Setup Guide
 
-It is recommended to use the [Mod Installer](https://github.com/BrandenEK/Blasphemous.Modding.Installer) to handle installing and updating mods. If you would prefer to install mods manually, instructions can also be found at the Mod Installer repository. 
+## Useful Links
 
-You will need the [Multiworld](https://github.com/BrandenEK/Blasphemous.Randomizer.Multiworld) mod to play an Archipelago randomizer.
+Required:
+- Blasphemous: [Steam](https://store.steampowered.com/app/774361/Blasphemous/)
+    - The GOG version of Blasphemous will also work.
+- Blasphemous Mod Installer: [GitHub](https://github.com/BrandenEK/Blasphemous-Mod-Installer)
+- Blasphemous Modding API: [GitHub](https://github.com/BrandenEK/Blasphemous-Modding-API)
+- Blasphemous Randomizer: [GitHub](https://github.com/BrandenEK/Blasphemous-Randomizer)
+- Blasphemous Multiworld: [GitHub](https://github.com/BrandenEK/Blasphemous-Multiworld)
 
-Some optional mods are also recommended:
-- [Rando Map](https://github.com/BrandenEK/Blasphemous.Randomizer.MapTracker)
-- [Boots of Pleading](https://github.com/BrandenEK/Blasphemous.BootsOfPleading) (Required if the "Boots of Pleading" option is enabled)
-- [Double Jump](https://github.com/BrandenEK/Blasphemous.DoubleJump) (Required if the "Purified Hand of the Nun" option is enabled)
+Optional:
+- In-game map tracker: [GitHub](https://github.com/BrandenEK/Blasphemous-Rando-Map)
+- Quick Prie Dieu warp mod: [GitHub](https://github.com/BadMagic100/Blasphemous-PrieWarp)
+- Boots of Pleading mod: [GitHub](https://github.com/BrandenEK/Blasphemous-Boots-of-Pleading)
+- Double Jump mod: [GitHub](https://github.com/BrandenEK/Blasphemous-Double-Jump)
 
-To connect to a multiworld: Choose a save file and enter the address, your name, and the password (if the server has one) into the menu.
+## Mod Installer (Recommended)
 
-After connecting, there are some commands you can use in the console, which can be opened by pressing backslash `\`:
-- `ap status` - Display connection status.
-- `ap say [message]` - Send a message to the server.
-- `ap hint [item]` - Request a hint for an item from the server.
+1. Download the [Mod Installer](https://github.com/BrandenEK/Blasphemous-Mod-Installer),
+and point it to your install directory for Blasphemous.
+
+2. Install the `Modding API`, `Randomizer`, and `Multiworld` mods. Optionally, you can also install the
+`Rando Map`, `PrieWarp`, `Boots of Pleading`, and `Double Jump` mods, and set up the PopTracker pack if desired.
+
+3. Start Blasphemous. To verfy that the mods are working, look for a version number for both
+the Randomizer and Multiworld on the title screen.
+
+## Manual Installation
+
+1. Download the [Modding API](https://github.com/BrandenEK/Blasphemous-Modding-API/releases), and follow
+the [installation instructions](https://github.com/BrandenEK/Blasphemous-Modding-API#installation) on the GitHub page.
+
+2. After the Modding API has been installed, download the 
+[Randomizer](https://github.com/BrandenEK/Blasphemous-Randomizer/releases) and 
+[Multiworld](https://github.com/BrandenEK/Blasphemous-Multiworld/releases) archives, and extract the contents of both
+into the `Modding` folder. Then, add any desired additional mods.
+
+3. Start Blasphemous. To verfy that the mods are working, look for a version number for both
+the Randomizer and Multiworld on the title screen.
+
+## Connecting
+
+To connect to an Archipelago server, open the in-game console by pressing backslash `\` and use
+the command `multiworld connect [address:port] [name] [password]`. 
+The port and password are both optional - if no port is provided then the default port of 38281 is used.
+**Make sure to connect to the server before attempting to start a new save file.**

worlds/blasphemous/test/__init__.py

@@ -1,7 +0,0 @@
-from test.bases import WorldTestBase
-from .. import BlasphemousWorld
-
-
-class BlasphemousTestBase(WorldTestBase):
-    game = "Blasphemous"
-    world: BlasphemousWorld

worlds/blasphemous/test/test_background_zones.py

@@ -1,56 +0,0 @@
-from . import BlasphemousTestBase
-from ..Locations import location_names
-
-
-class BotSSGauntletTest(BlasphemousTestBase):
-    options = {
-        "starting_location": "albero",
-        "wall_climb_shuffle": True,
-        "dash_shuffle": True
-    }
-
-    @property
-    def run_default_tests(self) -> bool:
-        return False
-    
-    def test_botss_gauntlet(self) -> None:
-        self.assertAccessDependency([location_names["CO25"]], [["Dash Ability", "Wall Climb Ability"]], True)
-
-
-class BackgroundZonesTest(BlasphemousTestBase):
-    @property
-    def run_default_tests(self) -> bool:
-        return False
-
-    def test_dc_shroud(self) -> None:
-        self.assertAccessDependency([location_names["RB03"]], [["Shroud of Dreamt Sins"]], True)
-
-    def test_wothp_bronze_cells(self) -> None:
-        bronze_locations = [
-            location_names["QI70"],
-            location_names["RESCUED_CHERUB_03"]
-        ]
-
-        self.assertAccessDependency(bronze_locations, [["Key of the Secular"]], True)
-
-    def test_wothp_silver_cells(self) -> None:
-        silver_locations = [
-            location_names["CO24"],
-            location_names["RESCUED_CHERUB_34"],
-            location_names["CO37"],
-            location_names["RESCUED_CHERUB_04"]
-        ]
-
-        self.assertAccessDependency(silver_locations, [["Key of the Scribe"]], True)
-
-    def test_wothp_gold_cells(self) -> None:
-        gold_locations = [
-            location_names["QI51"],
-            location_names["CO26"],
-            location_names["CO02"]
-        ]
-
-        self.assertAccessDependency(gold_locations, [["Key of the Inquisitor"]], True)
-
-    def test_wothp_quirce(self) -> None:
-        self.assertAccessDependency([location_names["BS14"]], [["Key of the Secular", "Key of the Scribe", "Key of the Inquisitor"]], True)

worlds/blasphemous/test/test_starting_locations.py

@@ -1,135 +0,0 @@
-from . import BlasphemousTestBase
-
-
-class TestBrotherhoodEasy(BlasphemousTestBase):
-    options = {
-        "starting_location": "brotherhood",
-        "difficulty": "easy"
-    }
-
-
-class TestBrotherhoodNormal(BlasphemousTestBase):
-    options = {
-        "starting_location": "brotherhood",
-        "difficulty": "normal"
-    }
-
-
-class TestBrotherhoodHard(BlasphemousTestBase):
-    options = {
-        "starting_location": "brotherhood",
-        "difficulty": "hard"
-    }
-
-
-class TestAlberoEasy(BlasphemousTestBase):
-    options = {
-        "starting_location": "albero",
-        "difficulty": "easy"
-    }
-
-
-class TestAlberoNormal(BlasphemousTestBase):
-    options = {
-        "starting_location": "albero",
-        "difficulty": "normal"
-    }
-
-
-class TestAlberoHard(BlasphemousTestBase):
-    options = {
-        "starting_location": "albero",
-        "difficulty": "hard"
-    }
-
-
-class TestConventEasy(BlasphemousTestBase):
-    options = {
-        "starting_location": "convent",
-        "difficulty": "easy"
-    }
-
-
-class TestConventNormal(BlasphemousTestBase):
-    options = {
-        "starting_location": "convent",
-        "difficulty": "normal"
-    }
-
-
-class TestConventHard(BlasphemousTestBase):
-    options = {
-        "starting_location": "convent",
-        "difficulty": "hard"
-    }
-
-
-class TestGrievanceEasy(BlasphemousTestBase):
-    options = {
-        "starting_location": "grievance",
-        "difficulty": "easy"
-    }
-
-
-class TestGrievanceNormal(BlasphemousTestBase):
-    options = {
-        "starting_location": "grievance",
-        "difficulty": "normal"
-    }
-
-
-class TestGrievanceHard(BlasphemousTestBase):
-    options = {
-        "starting_location": "grievance",
-        "difficulty": "hard"
-    }
-
-
-class TestKnotOfWordsEasy(BlasphemousTestBase):
-    options = {
-        "starting_location": "knot_of_words",
-        "difficulty": "easy"
-    }
-
-
-class TestKnotOfWordsNormal(BlasphemousTestBase):
-    options = {
-        "starting_location": "knot_of_words",
-        "difficulty": "normal"
-    }
-
-
-class TestKnotOfWordsHard(BlasphemousTestBase):
-    options = {
-        "starting_location": "knot_of_words",
-        "difficulty": "hard"
-    }
-
-
-class TestRooftopsEasy(BlasphemousTestBase):
-    options = {
-        "starting_location": "rooftops",
-        "difficulty": "easy"
-    }
-
-
-class TestRooftopsNormal(BlasphemousTestBase):
-    options = {
-        "starting_location": "rooftops",
-        "difficulty": "normal"
-    }
-
-
-class TestRooftopsHard(BlasphemousTestBase):
-    options = {
-        "starting_location": "rooftops",
-        "difficulty": "hard"
-    }
-
-
-# mourning and havoc can't be selected on easy or normal. hard only
-class TestMourningHavocHard(BlasphemousTestBase):
-    options = {
-        "starting_location": "mourning_havoc",
-        "difficulty": "hard"
-    }

worlds/bomb_rush_cyberfunk/Rules.py

@@ -1006,8 +1006,6 @@ def rules(brcworld):
         lambda state: mataan_challenge2(state, player, limit, glitched))
     set_rule(multiworld.get_location("Mataan: Score challenge reward", player),
         lambda state: mataan_challenge3(state, player))
-    set_rule(multiworld.get_location("Mataan: Coil joins the crew", player),
-        lambda state: mataan_deepest(state, player, limit, glitched))
     if photos:
         set_rule(multiworld.get_location("Mataan: Trash Polo", player),
             lambda state: camera(state, player))

worlds/celeste64/docs/guide_en.md

@@ -28,7 +28,7 @@ An Example `AP.json` file:
 
 ```
 {
-	"Url": "archipelago.gg:12345",
+	"Url": "archipelago:12345",
 	"SlotName": "Maddy",
 	"Password": ""
 }

worlds/checksfinder/Items.py

@@ -3,8 +3,8 @@ import typing
 
 
 class ItemData(typing.NamedTuple):
-    code: int
-    progression: bool = True
+    code: typing.Optional[int]
+    progression: bool
 
 
 class ChecksFinderItem(Item):
@@ -12,9 +12,16 @@ class ChecksFinderItem(Item):
 
 
 item_table = {
-    "Map Width": ItemData(80000),
-    "Map Height": ItemData(80001),
-    "Map Bombs": ItemData(80002),
+    "Map Width": ItemData(80000, True),
+    "Map Height": ItemData(80001, True),
+    "Map Bombs": ItemData(80002, True),
 }
 
-lookup_id_to_name: typing.Dict[int, str] = {data.code: item_name for item_name, data in item_table.items()}
+required_items = {
+}
+
+item_frequencies = {
+
+}
+
+lookup_id_to_name: typing.Dict[int, str] = {data.code: item_name for item_name, data in item_table.items() if data.code}

worlds/checksfinder/Locations.py

@@ -3,14 +3,46 @@ import typing
 
 
 class AdvData(typing.NamedTuple):
-    id: int
-    region: str = "Board"
+    id: typing.Optional[int]
+    region: str
 
 
-class ChecksFinderLocation(Location):
+class ChecksFinderAdvancement(Location):
     game: str = "ChecksFinder"
 
 
-base_id = 81000
-advancement_table = {f"Tile {i+1}": AdvData(base_id+i) for i in range(25)}
-lookup_id_to_name: typing.Dict[int, str] = {data.id: item_name for item_name, data in advancement_table.items()}
+advancement_table = {
+    "Tile 1": AdvData(81000, 'Board'),
+    "Tile 2": AdvData(81001, 'Board'),
+    "Tile 3": AdvData(81002, 'Board'),
+    "Tile 4": AdvData(81003, 'Board'),
+    "Tile 5": AdvData(81004, 'Board'),
+    "Tile 6": AdvData(81005, 'Board'),
+    "Tile 7": AdvData(81006, 'Board'),
+    "Tile 8": AdvData(81007, 'Board'),
+    "Tile 9": AdvData(81008, 'Board'),
+    "Tile 10": AdvData(81009, 'Board'),
+    "Tile 11": AdvData(81010, 'Board'),
+    "Tile 12": AdvData(81011, 'Board'),
+    "Tile 13": AdvData(81012, 'Board'),
+    "Tile 14": AdvData(81013, 'Board'),
+    "Tile 15": AdvData(81014, 'Board'),
+    "Tile 16": AdvData(81015, 'Board'),
+    "Tile 17": AdvData(81016, 'Board'),
+    "Tile 18": AdvData(81017, 'Board'),
+    "Tile 19": AdvData(81018, 'Board'),
+    "Tile 20": AdvData(81019, 'Board'),
+    "Tile 21": AdvData(81020, 'Board'),
+    "Tile 22": AdvData(81021, 'Board'),
+    "Tile 23": AdvData(81022, 'Board'),
+    "Tile 24": AdvData(81023, 'Board'),
+    "Tile 25": AdvData(81024, 'Board'),
+}
+
+exclusion_table = {
+}
+
+events_table = {
+}
+
+lookup_id_to_name: typing.Dict[int, str] = {data.id: item_name for item_name, data in advancement_table.items() if data.id}

worlds/checksfinder/Options.py

@@ -0,0 +1,6 @@
+import typing
+from Options import Option
+
+
+checksfinder_options: typing.Dict[str, type(Option)] = {
+}

worlds/checksfinder/Rules.py

@@ -1,24 +1,44 @@
-from worlds.generic.Rules import set_rule
-from BaseClasses import MultiWorld
+from ..generic.Rules import set_rule
+from BaseClasses import MultiWorld, CollectionState
 
 
-items = ["Map Width", "Map Height", "Map Bombs"]
+def _has_total(state: CollectionState, player: int, total: int):
+    return (state.count('Map Width', player) + state.count('Map Height', player) +
+            state.count('Map Bombs', player)) >= total
 
 
 # Sets rules on entrances and advancements that are always applied
-def set_rules(multiworld: MultiWorld, player: int):
-    for i in range(20):
-        set_rule(multiworld.get_location(f"Tile {i+6}", player), lambda state, i=i: state.has_from_list(items, player, i+1))
+def set_rules(world: MultiWorld, player: int):
+    set_rule(world.get_location("Tile 6", player), lambda state: _has_total(state, player, 1))
+    set_rule(world.get_location("Tile 7", player), lambda state: _has_total(state, player, 2))
+    set_rule(world.get_location("Tile 8", player), lambda state: _has_total(state, player, 3))
+    set_rule(world.get_location("Tile 9", player), lambda state: _has_total(state, player, 4))
+    set_rule(world.get_location("Tile 10", player), lambda state: _has_total(state, player, 5))
+    set_rule(world.get_location("Tile 11", player), lambda state: _has_total(state, player, 6))
+    set_rule(world.get_location("Tile 12", player), lambda state: _has_total(state, player, 7))
+    set_rule(world.get_location("Tile 13", player), lambda state: _has_total(state, player, 8))
+    set_rule(world.get_location("Tile 14", player), lambda state: _has_total(state, player, 9))
+    set_rule(world.get_location("Tile 15", player), lambda state: _has_total(state, player, 10))
+    set_rule(world.get_location("Tile 16", player), lambda state: _has_total(state, player, 11))
+    set_rule(world.get_location("Tile 17", player), lambda state: _has_total(state, player, 12))
+    set_rule(world.get_location("Tile 18", player), lambda state: _has_total(state, player, 13))
+    set_rule(world.get_location("Tile 19", player), lambda state: _has_total(state, player, 14))
+    set_rule(world.get_location("Tile 20", player), lambda state: _has_total(state, player, 15))
+    set_rule(world.get_location("Tile 21", player), lambda state: _has_total(state, player, 16))
+    set_rule(world.get_location("Tile 22", player), lambda state: _has_total(state, player, 17))
+    set_rule(world.get_location("Tile 23", player), lambda state: _has_total(state, player, 18))
+    set_rule(world.get_location("Tile 24", player), lambda state: _has_total(state, player, 19))
+    set_rule(world.get_location("Tile 25", player), lambda state: _has_total(state, player, 20))
 
 
 # Sets rules on completion condition
-def set_completion_rules(multiworld: MultiWorld, player: int):
-    width_req = 5  # 10 - 5
-    height_req = 5  # 10 - 5
-    bomb_req = 15  # 20 - 5
-    multiworld.completion_condition[player] = lambda state: state.has_all_counts(
-        {
-            "Map Width": width_req,
-            "Map Height": height_req,
-            "Map Bombs": bomb_req,
-        }, player)
+def set_completion_rules(world: MultiWorld, player: int):
+
+    width_req = 10-5
+    height_req = 10-5
+    bomb_req = 20-5
+    completion_requirements = lambda state: \
+        state.has("Map Width", player, width_req) and \
+        state.has("Map Height", player, height_req) and \
+        state.has("Map Bombs", player, bomb_req)
+    world.completion_condition[player] = lambda state: completion_requirements(state)

worlds/checksfinder/__init__.py

@@ -1,9 +1,9 @@
-from BaseClasses import Region, Entrance, Tutorial, ItemClassification
-from .Items import ChecksFinderItem, item_table
-from .Locations import ChecksFinderLocation, advancement_table
-from Options import PerGameCommonOptions
+from BaseClasses import Region, Entrance, Item, Tutorial, ItemClassification
+from .Items import ChecksFinderItem, item_table, required_items
+from .Locations import ChecksFinderAdvancement, advancement_table, exclusion_table
+from .Options import checksfinder_options
 from .Rules import set_rules, set_completion_rules
-from worlds.AutoWorld import World, WebWorld
+from ..AutoWorld import World, WebWorld
 
 client_version = 7
 
@@ -25,34 +25,38 @@ class ChecksFinderWorld(World):
     ChecksFinder is a game where you avoid mines and find checks inside the board
     with the mines! You win when you get all your items and beat the board!
     """
-    game = "ChecksFinder"
-    options_dataclass = PerGameCommonOptions
+    game: str = "ChecksFinder"
+    option_definitions = checksfinder_options
+    topology_present = True
     web = ChecksFinderWeb()
 
     item_name_to_id = {name: data.code for name, data in item_table.items()}
     location_name_to_id = {name: data.id for name, data in advancement_table.items()}
 
-    def create_regions(self):
-        menu = Region("Menu", self.player, self.multiworld)
-        board = Region("Board", self.player, self.multiworld)
-        board.locations += [ChecksFinderLocation(self.player, loc_name, loc_data.id, board)
-                            for loc_name, loc_data in advancement_table.items()]
-
-        connection = Entrance(self.player, "New Board", menu)
-        menu.exits.append(connection)
-        connection.connect(board)
-        self.multiworld.regions += [menu, board]
+    def _get_checksfinder_data(self):
+        return {
+            'world_seed': self.multiworld.per_slot_randoms[self.player].getrandbits(32),
+            'seed_name': self.multiworld.seed_name,
+            'player_name': self.multiworld.get_player_name(self.player),
+            'player_id': self.player,
+            'client_version': client_version,
+            'race': self.multiworld.is_race,
+        }
 
     def create_items(self):
-        # Generate list of items
-        items_to_create = []
+
+        # Generate item pool
+        itempool = []
+        # Add all required progression items
+        for (name, num) in required_items.items():
+            itempool += [name] * num
         # Add the map width and height stuff
-        items_to_create += ["Map Width"] * 5  # 10 - 5
-        items_to_create += ["Map Height"] * 5  # 10 - 5
+        itempool += ["Map Width"] * (10-5)
+        itempool += ["Map Height"] * (10-5)
         # Add the map bombs
-        items_to_create += ["Map Bombs"] * 15  # 20 - 5
-        # Convert list into real items
-        itempool = [self.create_item(item) for item in items_to_create]
+        itempool += ["Map Bombs"] * (20-5)
+        # Convert itempool into real items
+        itempool = [item for item in map(lambda name: self.create_item(name), itempool)]
 
         self.multiworld.itempool += itempool
 
@@ -60,16 +64,28 @@ class ChecksFinderWorld(World):
         set_rules(self.multiworld, self.player)
         set_completion_rules(self.multiworld, self.player)
 
-    def fill_slot_data(self):
-        return {
-            "world_seed": self.random.getrandbits(32),
-            "seed_name": self.multiworld.seed_name,
-            "player_name": self.player_name,
-            "player_id": self.player,
-            "client_version": client_version,
-            "race": self.multiworld.is_race,
-        }
+    def create_regions(self):
+        menu = Region("Menu", self.player, self.multiworld)
+        board = Region("Board", self.player, self.multiworld)
+        board.locations += [ChecksFinderAdvancement(self.player, loc_name, loc_data.id, board)
+                            for loc_name, loc_data in advancement_table.items() if loc_data.region == board.name]
 
-    def create_item(self, name: str) -> ChecksFinderItem:
+        connection = Entrance(self.player, "New Board", menu)
+        menu.exits.append(connection)
+        connection.connect(board)
+        self.multiworld.regions += [menu, board]
+
+    def fill_slot_data(self):
+        slot_data = self._get_checksfinder_data()
+        for option_name in checksfinder_options:
+            option = getattr(self.multiworld, option_name)[self.player]
+            if slot_data.get(option_name, None) is None and type(option.value) in {str, int}:
+                slot_data[option_name] = int(option.value)
+        return slot_data
+
+    def create_item(self, name: str) -> Item:
         item_data = item_table[name]
-        return ChecksFinderItem(name, ItemClassification.progression, item_data.code, self.player)
+        item = ChecksFinderItem(name,
+                                ItemClassification.progression if item_data.progression else ItemClassification.filler,
+                                item_data.code, self.player)
+        return item

worlds/checksfinder/docs/en_ChecksFinder.md

@@ -24,3 +24,8 @@ next to an icon, the number is how many you have gotten and the icon represents
 Victory is achieved when the player wins a board they were given after they have received all of their Map Width, Map
 Height, and Map Bomb items. The game will say at the bottom of the screen how many of each you have received.
 
+## Unique Local Commands
+
+The following command is only available when using the ChecksFinderClient to play with Archipelago.
+
+- `/resync` Manually trigger a resync.

worlds/checksfinder/docs/setup_en.md

@@ -4,6 +4,7 @@
 
 - ChecksFinder from
   the [Github releases Page for the game](https://github.com/jonloveslegos/ChecksFinder/releases) (latest version)
+- Archipelago from the [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases)
 
 ## Configuring your YAML file
 
@@ -16,15 +17,28 @@ guide: [Basic Multiworld Setup Guide](/tutorial/Archipelago/setup/en)
 
 You can customize your options by visiting the [ChecksFinder Player Options Page](/games/ChecksFinder/player-options)
 
-## Joining a MultiWorld Game
+### Generating a ChecksFinder game
 
-1. Start ChecksFinder
-2. Enter the following information:
-    - Enter the server url (starting from `wss://` for https connection like archipelago.gg, and starting from `ws://` for http connection and local multiserver)
-    - Enter server port
-    - Enter the name of the slot you wish to connect to
-    - Enter the room password (optional)
-    - Press `Play Online` to connect
-3. Start playing!
+**ChecksFinder is meant to be played _alongside_ another game! You may not be playing it for long periods of time if 
+you play it by itself with another person!**
+
+When you join a multiworld game, you will be asked to provide your YAML file to whoever is hosting. Once that is done,
+the host will provide you with either a link to download your data file, or with a zip file containing everyone's data
+files. You do not have a file inside that zip though!
+
+You need to start ChecksFinder client yourself, it is located within the Archipelago folder.
+
+### Connect to the MultiServer
+
+First start ChecksFinder.
+
+Once both ChecksFinder and the client are started. In the client at the top type in the spot labeled `Server` type the 
+`Ip Address` and `Port` separated with a `:` symbol.
+
+The client will then ask for the username you chose, input that in the text box at the bottom of the client.
+
+### Play the game
+
+When the console tells you that you have joined the room, you're all set. Congratulations on successfully joining a
+multiworld game!
 
-Game options and controls are described in the readme on the github repository for the game

worlds/clique/Items.py

@@ -1,9 +1,6 @@
-from typing import Callable, Dict, NamedTuple, Optional, TYPE_CHECKING
+from typing import Callable, Dict, NamedTuple, Optional
 
-from BaseClasses import Item, ItemClassification
-
-if TYPE_CHECKING:
-    from . import CliqueWorld
+from BaseClasses import Item, ItemClassification, MultiWorld
 
 
 class CliqueItem(Item):
@@ -13,7 +10,7 @@ class CliqueItem(Item):
 class CliqueItemData(NamedTuple):
     code: Optional[int] = None
     type: ItemClassification = ItemClassification.filler
-    can_create: Callable[["CliqueWorld"], bool] = lambda world: True
+    can_create: Callable[[MultiWorld, int], bool] = lambda multiworld, player: True
 
 
 item_data_table: Dict[str, CliqueItemData] = {
@@ -24,11 +21,11 @@ item_data_table: Dict[str, CliqueItemData] = {
     "Button Activation": CliqueItemData(
         code=69696968,
         type=ItemClassification.progression,
-        can_create=lambda world: world.options.hard_mode,
+        can_create=lambda multiworld, player: bool(getattr(multiworld, "hard_mode")[player]),
     ),
     "A Cool Filler Item (No Satisfaction Guaranteed)": CliqueItemData(
         code=69696967,
-        can_create=lambda world: False  # Only created from `get_filler_item_name`.
+        can_create=lambda multiworld, player: False  # Only created from `get_filler_item_name`.
     ),
     "The Urge to Push": CliqueItemData(
         type=ItemClassification.progression,

worlds/clique/Locations.py

@@ -1,9 +1,6 @@
-from typing import Callable, Dict, NamedTuple, Optional, TYPE_CHECKING
+from typing import Callable, Dict, NamedTuple, Optional
 
-from BaseClasses import Location
-
-if TYPE_CHECKING:
-    from . import CliqueWorld
+from BaseClasses import Location, MultiWorld
 
 
 class CliqueLocation(Location):
@@ -13,7 +10,7 @@ class CliqueLocation(Location):
 class CliqueLocationData(NamedTuple):
     region: str
     address: Optional[int] = None
-    can_create: Callable[["CliqueWorld"], bool] = lambda world: True
+    can_create: Callable[[MultiWorld, int], bool] = lambda multiworld, player: True
     locked_item: Optional[str] = None
 
 
@@ -25,7 +22,7 @@ location_data_table: Dict[str, CliqueLocationData] = {
     "The Item on the Desk": CliqueLocationData(
         region="The Button Realm",
         address=69696968,
-        can_create=lambda world: world.options.hard_mode,
+        can_create=lambda multiworld, player: bool(getattr(multiworld, "hard_mode")[player]),
     ),
     "In the Player's Mind": CliqueLocationData(
         region="The Button Realm",

worlds/clique/Options.py

@@ -1,5 +1,6 @@
-from dataclasses import dataclass
-from Options import Choice, Toggle, PerGameCommonOptions, StartInventoryPool
+from typing import Dict
+
+from Options import Choice, Option, Toggle
 
 
 class HardMode(Toggle):
@@ -24,11 +25,10 @@ class ButtonColor(Choice):
     option_black = 11
 
 
-@dataclass
-class CliqueOptions(PerGameCommonOptions):
-    color: ButtonColor
-    hard_mode: HardMode
-    start_inventory_from_pool: StartInventoryPool
+clique_options: Dict[str, type(Option)] = {
+    "color": ButtonColor,
+    "hard_mode": HardMode,
 
     # DeathLink is always on. Always.
-    # death_link: DeathLink
+    # "death_link": DeathLink,
+}