The simple solution

.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,7 @@
 from __future__ import annotations
 
 import collections
+import copy
 import itertools
 import functools
 import logging
@@ -11,10 +12,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 +23,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 +49,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]
@@ -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()
@@ -395,7 +389,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 +431,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 +440,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 +449,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 +542,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}
 
@@ -623,7 +617,8 @@ class MultiWorld():
 
         def location_relevant(location: Location) -> bool:
             """Determine if this location is relevant to sweep."""
-            return location.player in players["full"] or location.advancement
+            return location.progress_type != LocationProgressType.EXCLUDED \
+                and (location.player in players["full"] or location.advancement)
 
         def all_done() -> bool:
             """Check if all access rules are fulfilled"""
@@ -668,7 +663,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 +675,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()}
@@ -724,14 +719,14 @@ class CollectionState():
 
     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
@@ -762,24 +757,19 @@ class CollectionState():
         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:
         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}
+        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}
 
-        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)
+        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:
@@ -813,7 +803,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."""
@@ -828,7 +818,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)
@@ -874,16 +864,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
 
@@ -907,7 +901,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
@@ -927,6 +921,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})'
 
@@ -1052,7 +1049,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.
 
@@ -1076,7 +1073,7 @@ class Region:
         return exit_
 
     def add_exits(self, exits: Union[Iterable[str], Dict[str, Optional[str]]],
-                  rules: Dict[str, Callable[[CollectionState], bool]] = None) -> List[Entrance]:
+                  rules: Dict[str, Callable[[CollectionState], bool]] = None) -> None:
         """
         Connects current region to regions in exit dictionary. Passed region names must exist first.
 
@@ -1086,16 +1083,15 @@ class Region:
         """
         if not isinstance(exits, Dict):
             exits = dict.fromkeys(exits)
-        return [
-            self.connect(
-                self.multiworld.get_region(connecting_region, self.player),
-                name,
-                rules[connecting_region] if rules and connecting_region in rules else None,
-            )
-            for connecting_region, name in exits.items()
-        ]
+        for connecting_region, name in exits.items():
+            self.connect(self.multiworld.get_region(connecting_region, self.player),
+                         name,
+                         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})'
 
 
@@ -1114,9 +1110,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):
@@ -1125,20 +1121,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:
@@ -1148,6 +1140,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})'
 
@@ -1169,7 +1164,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:
@@ -1252,6 +1247,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})"
@@ -1329,9 +1327,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,
@@ -1349,7 +1347,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)
@@ -1430,7 +1428,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:
@@ -1502,9 +1500,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)
 
@@ -232,12 +227,15 @@ def remaining_fill(multiworld: MultiWorld,
     swapped_items: typing.Counter[typing.Tuple[int, str]] = Counter()
     total = min(len(itempool),  len(locations))
     placed = 0
+
+    state = CollectionState(multiworld)
+
     while locations and itempool:
         item_to_place = itempool.pop()
         spot_to_fill: typing.Optional[Location] = None
 
         for i, location in enumerate(locations):
-            if location.item_rule(item_to_place):
+            if location.can_fill(state, item_to_place, check_access=False):
                 # popping by index is faster than removing by content,
                 spot_to_fill = locations.pop(i)
                 # skipping a scan for the element
@@ -258,7 +256,7 @@ def remaining_fill(multiworld: MultiWorld,
 
                 location.item = None
                 placed_item.location = None
-                if location.item_rule(item_to_place):
+                if location.can_fill(state, item_to_place, check_access=False):
                     # Add this item to the existing placement, and
                     # add the old item to the back of the queue
                     spot_to_fill = placements.pop(i)
@@ -304,7 +302,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 +327,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 +361,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 +509,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 +526,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 +554,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 +592,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()
@@ -746,7 +742,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 +825,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,24 +169,20 @@ 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()
 
@@ -347,7 +341,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

@@ -1236,7 +1236,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 +1517,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/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/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 }}

_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
 
@@ -121,9 +115,6 @@
 # Ocarina of Time
 /worlds/oot/ @espeon65536
 
-# Old School Runescape
-/worlds/osrs @digiholic
-
 # Overcooked! 2
 /worlds/overcooked2/ @toasterparty
 
@@ -202,9 +193,6 @@
 # The Witness
 /worlds/witness/ @NewSoupVi @blastron
 
-# Yacht Dice
-/worlds/yachtdice/ @spinerak
-
 # Yoshi's Island
 /worlds/yoshisisland/ @PinkSwitch
 

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/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,7 +31,7 @@ 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/).

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

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

@@ -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_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,8 +66,8 @@ 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
             self.assertSteps(gen_steps)

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/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/Regions.py

@@ -968,35 +968,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

@@ -381,8 +381,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 +432,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),
@@ -855,9 +855,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 +933,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/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/Rules.py

@@ -412,7 +412,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),
@@ -547,7 +547,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.

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/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/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/__init__.py

@@ -44,15 +44,15 @@ class ChecksFinderWorld(World):
         self.multiworld.regions += [menu, board]
 
     def create_items(self):
-        # Generate list of items
-        items_to_create = []
+        # Generate item pool
+        itempool = []
         # 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"] * 5  # 10 - 5
+        itempool += ["Map Height"] * 5  # 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"] * 15  # 20 - 5
+        # Convert itempool into real items
+        itempool = [self.create_item(item) for item in itempool]
 
         self.multiworld.itempool += itempool
 

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,
+}

worlds/clique/Rules.py

@@ -1,13 +1,10 @@
-from typing import Callable, TYPE_CHECKING
+from typing import Callable
 
-from BaseClasses import CollectionState
-
-if TYPE_CHECKING:
-    from . import CliqueWorld
+from BaseClasses import CollectionState, MultiWorld
 
 
-def get_button_rule(world: "CliqueWorld") -> Callable[[CollectionState], bool]:
-    if world.options.hard_mode:
-        return lambda state: state.has("Button Activation", world.player)
+def get_button_rule(multiworld: MultiWorld, player: int) -> Callable[[CollectionState], bool]:
+    if getattr(multiworld, "hard_mode")[player]:
+        return lambda state: state.has("Button Activation", player)
 
     return lambda state: True

worlds/clique/__init__.py

@@ -1,10 +1,10 @@
-from typing import List, Dict, Any
+from typing import List
 
 from BaseClasses import Region, Tutorial
 from worlds.AutoWorld import WebWorld, World
 from .Items import CliqueItem, item_data_table, item_table
 from .Locations import CliqueLocation, location_data_table, location_table, locked_locations
-from .Options import CliqueOptions
+from .Options import clique_options
 from .Regions import region_data_table
 from .Rules import get_button_rule
 
@@ -38,8 +38,7 @@ class CliqueWorld(World):
 
     game = "Clique"
     web = CliqueWebWorld()
-    options: CliqueOptions
-    options_dataclass = CliqueOptions
+    option_definitions = clique_options
     location_name_to_id = location_table
     item_name_to_id = item_table
 
@@ -49,7 +48,7 @@ class CliqueWorld(World):
     def create_items(self) -> None:
         item_pool: List[CliqueItem] = []
         for name, item in item_data_table.items():
-            if item.code and item.can_create(self):
+            if item.code and item.can_create(self.multiworld, self.player):
                 item_pool.append(self.create_item(name))
 
         self.multiworld.itempool += item_pool
@@ -62,40 +61,41 @@ class CliqueWorld(World):
 
         # Create locations.
         for region_name, region_data in region_data_table.items():
-            region = self.get_region(region_name)
+            region = self.multiworld.get_region(region_name, self.player)
             region.add_locations({
                 location_name: location_data.address for location_name, location_data in location_data_table.items()
-                if location_data.region == region_name and location_data.can_create(self)
+                if location_data.region == region_name and location_data.can_create(self.multiworld, self.player)
             }, CliqueLocation)
             region.add_exits(region_data_table[region_name].connecting_regions)
 
         # Place locked locations.
         for location_name, location_data in locked_locations.items():
             # Ignore locations we never created.
-            if not location_data.can_create(self):
+            if not location_data.can_create(self.multiworld, self.player):
                 continue
 
             locked_item = self.create_item(location_data_table[location_name].locked_item)
-            self.get_location(location_name).place_locked_item(locked_item)
+            self.multiworld.get_location(location_name, self.player).place_locked_item(locked_item)
 
         # Set priority location for the Big Red Button!
-        self.options.priority_locations.value.add("The Big Red Button")
+        self.multiworld.priority_locations[self.player].value.add("The Big Red Button")
 
     def get_filler_item_name(self) -> str:
         return "A Cool Filler Item (No Satisfaction Guaranteed)"
 
     def set_rules(self) -> None:
-        button_rule = get_button_rule(self)
-        self.get_location("The Big Red Button").access_rule = button_rule
-        self.get_location("In the Player's Mind").access_rule = button_rule
+        button_rule = get_button_rule(self.multiworld, self.player)
+        self.multiworld.get_location("The Big Red Button", self.player).access_rule = button_rule
+        self.multiworld.get_location("In the Player's Mind", self.player).access_rule = button_rule
 
         # Do not allow button activations on buttons.
-        self.get_location("The Big Red Button").item_rule = lambda item: item.name != "Button Activation"
+        self.multiworld.get_location("The Big Red Button", self.player).item_rule =\
+            lambda item: item.name != "Button Activation"
 
         # Completion condition.
         self.multiworld.completion_condition[self.player] = lambda state: state.has("The Urge to Push", self.player)
 
-    def fill_slot_data(self) -> Dict[str, Any]:
+    def fill_slot_data(self):
         return {
-            "color": self.options.color.current_key
+            "color": getattr(self.multiworld, "color")[self.player].current_key
         }

worlds/dark_souls_3/Bosses.py

@@ -1,264 +0,0 @@
-# In almost all cases, we leave boss and enemy randomization up to the static randomizer. But for
-# Yhorm specifically we need to know where he ends up in order to ensure that the Storm Ruler is
-# available before his fight.
-
-from dataclasses import dataclass, field
-from typing import Set
-
-
-@dataclass
-class DS3BossInfo:
-    """The set of locations a given boss location blocks access to."""
-
-    name: str
-    """The boss's name."""
-
-    id: int
-    """The game's ID for this particular boss."""
-
-    dlc: bool = False
-    """This boss appears in one of the game's DLCs."""
-
-    before_storm_ruler: bool = False
-    """Whether this location appears before it's possible to get Storm Ruler in vanilla.
-
-    This is used to determine whether it's safe to place Yhorm here if weapons
-    aren't randomized.
-    """
-
-    locations: Set[str] = field(default_factory=set)
-    """Additional individual locations that can't be accessed until the boss is dead."""
-
-
-# Note: the static randomizer splits up some bosses into separate fights for separate phases, each
-# of which can be individually replaced by Yhorm.
-all_bosses = [
-    DS3BossInfo("Iudex Gundyr", 4000800, before_storm_ruler = True, locations = {
-        "CA: Coiled Sword - boss drop"
-    }),
-    DS3BossInfo("Vordt of the Boreal Valley", 3000800, before_storm_ruler = True, locations = {
-        "HWL: Soul of Boreal Valley Vordt"
-    }),
-    DS3BossInfo("Curse-rotted Greatwood", 3100800, locations = {
-        "US: Soul of the Rotted Greatwood",
-        "US: Transposing Kiln - boss drop",
-        "US: Wargod Wooden Shield - Pit of Hollows",
-        "FS: Hawkwood's Shield - gravestone after Hawkwood leaves",
-        "FS: Sunset Shield - by grave after killing Hodrick w/Sirris",
-        "US: Sunset Helm - Pit of Hollows after killing Hodrick w/Sirris",
-        "US: Sunset Armor - pit of hollows after killing Hodrick w/Sirris",
-        "US: Sunset Gauntlets - pit of hollows after killing Hodrick w/Sirris",
-        "US: Sunset Leggings - pit of hollows after killing Hodrick w/Sirris",
-        "FS: Sunless Talisman - Sirris, kill GA boss",
-        "FS: Sunless Veil - shop, Sirris quest, kill GA boss",
-        "FS: Sunless Armor - shop, Sirris quest, kill GA boss",
-        "FS: Sunless Gauntlets - shop, Sirris quest, kill GA boss",
-        "FS: Sunless Leggings - shop, Sirris quest, kill GA boss",
-    }),
-    DS3BossInfo("Crystal Sage", 3300850, locations = {
-        "RS: Soul of a Crystal Sage",
-        "FS: Sage's Big Hat - shop after killing RS boss",
-        "FS: Hawkwood's Shield - gravestone after Hawkwood leaves",
-    }),
-    DS3BossInfo("Deacons of the Deep", 3500800, locations = {
-        "CD: Soul of the Deacons of the Deep",
-        "CD: Small Doll - boss drop",
-        "FS: Hawkwood's Shield - gravestone after Hawkwood leaves",
-    }),
-    DS3BossInfo("Abyss Watchers", 3300801, before_storm_ruler = True, locations = {
-        "FK: Soul of the Blood of the Wolf",
-        "FK: Cinders of a Lord - Abyss Watcher",
-        "FS: Undead Legion Helm - shop after killing FK boss",
-        "FS: Undead Legion Armor - shop after killing FK boss",
-        "FS: Undead Legion Gauntlet - shop after killing FK boss",
-        "FS: Undead Legion Leggings - shop after killing FK boss",
-        "FS: Farron Ring - Hawkwood",
-        "FS: Hawkwood's Shield - gravestone after Hawkwood leaves",
-    }),
-    DS3BossInfo("High Lord Wolnir", 3800800, before_storm_ruler = True, locations = {
-        "CC: Soul of High Lord Wolnir",
-        "FS: Wolnir's Crown - shop after killing CC boss",
-        "CC: Homeward Bone - Irithyll bridge",
-        "CC: Pontiff's Right Eye - Irithyll bridge, miniboss drop",
-    }),
-    DS3BossInfo("Pontiff Sulyvahn", 3700850, locations = {
-        "IBV: Soul of Pontiff Sulyvahn",
-    }),
-    DS3BossInfo("Old Demon King", 3800830, locations = {
-        "SL: Soul of the Old Demon King",
-    }),
-    DS3BossInfo("Aldrich, Devourer of Gods", 3700800, locations = {
-        "AL: Soul of Aldrich",
-        "AL: Cinders of a Lord - Aldrich",
-        "FS: Smough's Helm - shop after killing AL boss",
-        "FS: Smough's Armor - shop after killing AL boss",
-        "FS: Smough's Gauntlets - shop after killing AL boss",
-        "FS: Smough's Leggings - shop after killing AL boss",
-        "AL: Sun Princess Ring - dark cathedral, after boss",
-        "FS: Leonhard's Garb - shop after killing Leonhard",
-        "FS: Leonhard's Gauntlets - shop after killing Leonhard",
-        "FS: Leonhard's Trousers - shop after killing Leonhard",
-    }),
-    DS3BossInfo("Dancer of the Boreal Valley", 3000899, locations = {
-        "HWL: Soul of the Dancer",
-        "FS: Dancer's Crown - shop after killing LC entry boss",
-        "FS: Dancer's Armor - shop after killing LC entry boss",
-        "FS: Dancer's Gauntlets - shop after killing LC entry boss",
-        "FS: Dancer's Leggings - shop after killing LC entry boss",
-    }),
-    DS3BossInfo("Dragonslayer Armour", 3010800, locations = {
-        "LC: Soul of Dragonslayer Armour",
-        "FS: Morne's Helm - shop after killing Eygon or LC boss",
-        "FS: Morne's Armor - shop after killing Eygon or LC boss",
-        "FS: Morne's Gauntlets - shop after killing Eygon or LC boss",
-        "FS: Morne's Leggings - shop after killing Eygon or LC boss",
-        "LC: Titanite Chunk - down stairs after boss",
-    }),
-    DS3BossInfo("Consumed King Oceiros", 3000830, locations = {
-        "CKG: Soul of Consumed Oceiros",
-        "CKG: Titanite Scale - tomb, chest #1",
-        "CKG: Titanite Scale - tomb, chest #2",
-        "CKG: Drakeblood Helm - tomb, after killing AP mausoleum NPC",
-        "CKG: Drakeblood Armor - tomb, after killing AP mausoleum NPC",
-        "CKG: Drakeblood Gauntlets - tomb, after killing AP mausoleum NPC",
-        "CKG: Drakeblood Leggings - tomb, after killing AP mausoleum NPC",
-    }),
-    DS3BossInfo("Champion Gundyr", 4000830, locations = {
-        "UG: Soul of Champion Gundyr",
-        "FS: Gundyr's Helm - shop after killing UG boss",
-        "FS: Gundyr's Armor - shop after killing UG boss",
-        "FS: Gundyr's Gauntlets - shop after killing UG boss",
-        "FS: Gundyr's Leggings - shop after killing UG boss",
-        "UG: Hornet Ring - environs, right of main path after killing FK boss",
-        "UG: Chaos Blade - environs, left of shrine",
-        "UG: Blacksmith Hammer - shrine, Andre's room",
-        "UG: Eyes of a Fire Keeper - shrine, Irina's room",
-        "UG: Coiled Sword Fragment - shrine, dead bonfire",
-        "UG: Soul of a Crestfallen Knight - environs, above shrine entrance",
-        "UG: Life Ring+3 - shrine, behind big throne",
-        "UG: Ring of Steel Protection+1 - environs, behind bell tower",
-        "FS: Ring of Sacrifice - Yuria shop",
-        "UG: Ember - shop",
-        "UG: Priestess Ring - shop",
-        "UG: Wolf Knight Helm - shop after killing FK boss",
-        "UG: Wolf Knight Armor - shop after killing FK boss",
-        "UG: Wolf Knight Gauntlets - shop after killing FK boss",
-        "UG: Wolf Knight Leggings - shop after killing FK boss",
-    }),
-    DS3BossInfo("Ancient Wyvern", 3200800),
-    DS3BossInfo("King of the Storm", 3200850, locations = {
-        "AP: Soul of the Nameless King",
-        "FS: Golden Crown - shop after killing AP boss",
-        "FS: Dragonscale Armor - shop after killing AP boss",
-        "FS: Golden Bracelets - shop after killing AP boss",
-        "FS: Dragonscale Waistcloth - shop after killing AP boss",
-        "AP: Titanite Slab - plaza",
-        "AP: Covetous Gold Serpent Ring+2 - plaza",
-        "AP: Dragonslayer Helm - plaza",
-        "AP: Dragonslayer Armor - plaza",
-        "AP: Dragonslayer Gauntlets - plaza",
-        "AP: Dragonslayer Leggings - plaza",
-    }),
-    DS3BossInfo("Nameless King", 3200851, locations = {
-        "AP: Soul of the Nameless King",
-        "FS: Golden Crown - shop after killing AP boss",
-        "FS: Dragonscale Armor - shop after killing AP boss",
-        "FS: Golden Bracelets - shop after killing AP boss",
-        "FS: Dragonscale Waistcloth - shop after killing AP boss",
-        "AP: Titanite Slab - plaza",
-        "AP: Covetous Gold Serpent Ring+2 - plaza",
-        "AP: Dragonslayer Helm - plaza",
-        "AP: Dragonslayer Armor - plaza",
-        "AP: Dragonslayer Gauntlets - plaza",
-        "AP: Dragonslayer Leggings - plaza",
-    }),
-    DS3BossInfo("Lothric, Younger Prince", 3410830, locations = {
-        "GA: Soul of the Twin Princes",
-        "GA: Cinders of a Lord - Lothric Prince",
-    }),
-    DS3BossInfo("Lorian, Elder Prince", 3410832, locations = {
-        "GA: Soul of the Twin Princes",
-        "GA: Cinders of a Lord - Lothric Prince",
-        "FS: Lorian's Helm - shop after killing GA boss",
-        "FS: Lorian's Armor - shop after killing GA boss",
-        "FS: Lorian's Gauntlets - shop after killing GA boss",
-        "FS: Lorian's Leggings - shop after killing GA boss",
-    }),
-    DS3BossInfo("Champion's Gravetender and Gravetender Greatwolf", 4500860, dlc = True,
-                locations = {"PW1: Valorheart - boss drop"}),
-    DS3BossInfo("Sister Friede", 4500801, dlc = True, locations = {
-        "PW2: Soul of Sister Friede",
-        "PW2: Titanite Slab - boss drop",
-        "PW1: Titanite Slab - Corvian",
-        "FS: Ordained Hood - shop after killing PW2 boss",
-        "FS: Ordained Dress - shop after killing PW2 boss",
-        "FS: Ordained Trousers - shop after killing PW2 boss",
-    }),
-    DS3BossInfo("Blackflame Friede", 4500800, dlc = True, locations = {
-        "PW2: Soul of Sister Friede",
-        "PW1: Titanite Slab - Corvian",
-        "FS: Ordained Hood - shop after killing PW2 boss",
-        "FS: Ordained Dress - shop after killing PW2 boss",
-        "FS: Ordained Trousers - shop after killing PW2 boss",
-    }),
-    DS3BossInfo("Demon Prince", 5000801, dlc = True, locations = {
-        "DH: Soul of the Demon Prince",
-        "DH: Small Envoy Banner - boss drop",
-    }),
-    DS3BossInfo("Halflight, Spear of the Church", 5100800, dlc = True, locations = {
-        "RC: Titanite Slab - mid boss drop",
-        "RC: Titanite Slab - ashes, NPC drop",
-        "RC: Titanite Slab - ashes, mob drop",
-        "RC: Filianore's Spear Ornament - mid boss drop",
-        "RC: Crucifix of the Mad King - ashes, NPC drop",
-        "RC: Shira's Crown - Shira's room after killing ashes NPC",
-        "RC: Shira's Armor - Shira's room after killing ashes NPC",
-        "RC: Shira's Gloves - Shira's room after killing ashes NPC",
-        "RC: Shira's Trousers - Shira's room after killing ashes NPC",
-    }),
-    DS3BossInfo("Darkeater Midir", 5100850, dlc = True, locations = {
-        "RC: Soul of Darkeater Midir",
-        "RC: Spears of the Church - hidden boss drop",
-    }),
-    DS3BossInfo("Slave Knight Gael 1", 5110801, dlc = True, locations = {
-        "RC: Soul of Slave Knight Gael",
-        "RC: Blood of the Dark Soul - end boss drop",
-        # These are accessible before you trigger the boss, but once you do you
-        # have to beat it before getting them.
-        "RC: Titanite Slab - ashes, mob drop",
-        "RC: Titanite Slab - ashes, NPC drop",
-        "RC: Sacred Chime of Filianore - ashes, NPC drop",
-        "RC: Crucifix of the Mad King - ashes, NPC drop",
-        "RC: Shira's Crown - Shira's room after killing ashes NPC",
-        "RC: Shira's Armor - Shira's room after killing ashes NPC",
-        "RC: Shira's Gloves - Shira's room after killing ashes NPC",
-        "RC: Shira's Trousers - Shira's room after killing ashes NPC",
-    }),
-    DS3BossInfo("Slave Knight Gael 2", 5110800, dlc = True, locations = {
-        "RC: Soul of Slave Knight Gael",
-        "RC: Blood of the Dark Soul - end boss drop",
-        # These are accessible before you trigger the boss, but once you do you
-        # have to beat it before getting them.
-        "RC: Titanite Slab - ashes, mob drop",
-        "RC: Titanite Slab - ashes, NPC drop",
-        "RC: Sacred Chime of Filianore - ashes, NPC drop",
-        "RC: Crucifix of the Mad King - ashes, NPC drop",
-        "RC: Shira's Crown - Shira's room after killing ashes NPC",
-        "RC: Shira's Armor - Shira's room after killing ashes NPC",
-        "RC: Shira's Gloves - Shira's room after killing ashes NPC",
-        "RC: Shira's Trousers - Shira's room after killing ashes NPC",
-    }),
-    DS3BossInfo("Lords of Cinder", 4100800, locations = {
-        "KFF: Soul of the Lords",
-        "FS: Billed Mask - Yuria after killing KFF boss",
-        "FS: Black Dress - Yuria after killing KFF boss",
-        "FS: Black Gauntlets - Yuria after killing KFF boss",
-        "FS: Black Leggings - Yuria after killing KFF boss"
-    }),
-]
-
-default_yhorm_location = DS3BossInfo("Yhorm the Giant", 3900800, locations = {
-    "PC: Soul of Yhorm the Giant",
-    "PC: Cinders of a Lord - Yhorm the Giant",
-    "PC: Siegbräu - Siegward after killing boss",
-})

worlds/dark_souls_3/Options.py

@@ -1,78 +1,80 @@
-from dataclasses import dataclass
-import json
-from typing import Any, Dict
+import typing
 
-from Options import Choice, DeathLink, DefaultOnToggle, ExcludeLocations, NamedRange, OptionDict, \
-    OptionGroup, PerGameCommonOptions, Range, Removed, Toggle
-
-## Game Options
+from Options import Toggle, DefaultOnToggle, Option, Range, Choice, ItemDict, DeathLink
 
 
-class EarlySmallLothricBanner(Choice):
-    """Force Small Lothric Banner into an early sphere in your world or across all worlds."""
-    display_name = "Early Small Lothric Banner"
-    option_off = 0
-    option_early_global = 1
-    option_early_local = 2
-    default = option_off
+class RandomizeWeaponLocations(DefaultOnToggle):
+    """Randomizes weapons (+76 locations)"""
+    display_name = "Randomize Weapon Locations"
 
 
-class LateBasinOfVowsOption(Choice):
-    """Guarantee that you don't need to enter Lothric Castle until later in the run.
-
-    - **Off:** You may have to enter Lothric Castle and the areas beyond it immediately after High
-      Wall of Lothric.
-    - **After Small Lothric Banner:** You may have to enter Lothric Castle after Catacombs of
-      Carthus.
-    - **After Small Doll:** You won't have to enter Lothric Castle until after Irithyll of the
-      Boreal Valley.
-    """
-    display_name = "Late Basin of Vows"
-    option_off = 0
-    alias_false = 0
-    option_after_small_lothric_banner = 1
-    alias_true = 1
-    option_after_small_doll = 2
+class RandomizeShieldLocations(DefaultOnToggle):
+    """Randomizes shields (+24 locations)"""
+    display_name = "Randomize Shield Locations"
 
 
-class LateDLCOption(Choice):
-    """Guarantee that you don't need to enter the DLC until later in the run.
-
-    - **Off:** You may have to enter the DLC after Catacombs of Carthus.
-    - **After Small Doll:** You may have to enter the DLC after Irithyll of the Boreal Valley.
-    - **After Basin:** You won't have to enter the DLC until after Lothric Castle.
-    """
-    display_name = "Late DLC"
-    option_off = 0
-    alias_false = 0
-    option_after_small_doll = 1
-    alias_true = 1
-    option_after_basin = 2
+class RandomizeArmorLocations(DefaultOnToggle):
+    """Randomizes armor pieces (+97 locations)"""
+    display_name = "Randomize Armor Locations"
 
 
-class EnableDLCOption(Toggle):
-    """Include DLC locations, items, and enemies in the randomized pools.
-
-    To use this option, you must own both the "Ashes of Ariandel" and the "Ringed City" DLCs.
-    """
-    display_name = "Enable DLC"
+class RandomizeRingLocations(DefaultOnToggle):
+    """Randomizes rings (+49 locations)"""
+    display_name = "Randomize Ring Locations"
 
 
-class EnableNGPOption(Toggle):
-    """Include items and locations exclusive to NG+ cycles."""
-    display_name = "Enable NG+"
+class RandomizeSpellLocations(DefaultOnToggle):
+    """Randomizes spells (+18 locations)"""
+    display_name = "Randomize Spell Locations"
 
 
-## Equipment
-
-class RandomizeStartingLoadout(DefaultOnToggle):
-    """Randomizes the equipment characters begin with."""
-    display_name = "Randomize Starting Loadout"
+class RandomizeKeyLocations(DefaultOnToggle):
+    """Randomizes items which unlock doors or bypass barriers"""
+    display_name = "Randomize Key Locations"
 
 
-class RequireOneHandedStartingWeapons(DefaultOnToggle):
-    """Require starting equipment to be usable one-handed."""
-    display_name = "Require One-Handed Starting Weapons"
+class RandomizeBossSoulLocations(DefaultOnToggle):
+    """Randomizes Boss Souls (+18 Locations)"""
+    display_name = "Randomize Boss Soul Locations"
+
+
+class RandomizeNPCLocations(Toggle):
+    """Randomizes friendly NPC drops (meaning you will probably have to kill them) (+14 locations)"""
+    display_name = "Randomize NPC Locations"
+
+
+class RandomizeMiscLocations(Toggle):
+    """Randomizes miscellaneous items (ashes, tomes, scrolls, etc.) to the pool. (+36 locations)"""
+    display_name = "Randomize Miscellaneous Locations"
+
+
+class RandomizeHealthLocations(Toggle):
+    """Randomizes health upgrade items. (+21 locations)"""
+    display_name = "Randomize Health Upgrade Locations"
+
+
+class RandomizeProgressiveLocationsOption(Toggle):
+    """Randomizes upgrade materials and consumables such as the titanite shards, firebombs, resin, etc...
+
+    Instead of specific locations, these are progressive, so Titanite Shard #1 is the first titanite shard
+    you pick up, regardless of whether it's from an enemy drop late in the game or an item on the ground in the
+    first 5 minutes."""
+    display_name = "Randomize Progressive Locations"
+
+
+class PoolTypeOption(Choice):
+    """Changes which non-progression items you add to the pool
+
+    Shuffle: Items are picked from the locations being randomized
+    Various: Items are picked from a list of all items in the game, but are the same type of item they replace"""
+    display_name = "Pool Type"
+    option_shuffle = 0
+    option_various = 1
+
+
+class GuaranteedItemsOption(ItemDict):
+    """Guarantees that the specified items will be in the item pool"""
+    display_name = "Guaranteed Items"
 
 
 class AutoEquipOption(Toggle):
@@ -81,56 +83,47 @@ class AutoEquipOption(Toggle):
 
 
 class LockEquipOption(Toggle):
-    """Lock the equipment slots so you cannot change your armor or your left/right weapons.
-
-    Works great with the Auto-equip option.
-    """
+    """Lock the equipment slots so you cannot change your armor or your left/right weapons. Works great with the
+    Auto-equip option."""
     display_name = "Lock Equipment Slots"
 
 
-class NoEquipLoadOption(Toggle):
-    """Disable the equip load constraint from the game."""
-    display_name = "No Equip Load"
-
-
 class NoWeaponRequirementsOption(Toggle):
-    """Disable the weapon requirements by removing any movement or damage penalties, permitting you
-    to use any weapon early.
-    """
+    """Disable the weapon requirements by removing any movement or damage penalties.
+    Permitting you to use any weapon early"""
     display_name = "No Weapon Requirements"
 
 
 class NoSpellRequirementsOption(Toggle):
-    """Disable the spell requirements permitting you to use any spell."""
+    """Disable the spell requirements permitting you to use any spell"""
     display_name = "No Spell Requirements"
 
 
-## Weapons
+class NoEquipLoadOption(Toggle):
+    """Disable the equip load constraint from the game"""
+    display_name = "No Equip Load"
+
 
 class RandomizeInfusionOption(Toggle):
     """Enable this option to infuse a percentage of the pool of weapons and shields."""
     display_name = "Randomize Infusion"
 
 
-class RandomizeInfusionPercentageOption(NamedRange):
-    """The percentage of weapons/shields in the pool to be infused if Randomize Infusion is toggled.
-    """
+class RandomizeInfusionPercentageOption(Range):
+    """The percentage of weapons/shields in the pool to be infused if Randomize Infusion is toggled"""
     display_name = "Percentage of Infused Weapons"
     range_start = 0
     range_end = 100
     default = 33
-    # 3/155 weapons are infused in the base game, or about 2%
-    special_range_names = {"similar to base game": 2}
 
 
 class RandomizeWeaponLevelOption(Choice):
-    """Enable this option to upgrade a percentage of the pool of weapons to a random value between
-    the minimum and maximum levels defined.
+    """Enable this option to upgrade a percentage of the pool of weapons to a random value between the minimum and 
+    maximum levels defined.
 
-    - **All:** All weapons are eligible, both basic and epic
-    - **Basic:** Only weapons that can be upgraded to +10
-    - **Epic:** Only weapons that can be upgraded to +5
-    """
+    All: All weapons are eligible, both basic and epic
+    Basic: Only weapons that can be upgraded to +10
+    Epic: Only weapons that can be upgraded to +5"""
     display_name = "Randomize Weapon Level"
     option_none = 0
     option_all = 1
@@ -139,7 +132,7 @@ class RandomizeWeaponLevelOption(Choice):
 
 
 class RandomizeWeaponLevelPercentageOption(Range):
-    """The percentage of weapons in the pool to be upgraded if randomize weapons level is toggled."""
+    """The percentage of weapons in the pool to be upgraded if randomize weapons level is toggled"""
     display_name = "Percentage of Randomized Weapons"
     range_start = 0
     range_end = 100
@@ -147,7 +140,7 @@ class RandomizeWeaponLevelPercentageOption(Range):
 
 
 class MinLevelsIn5WeaponPoolOption(Range):
-    """The minimum upgraded value of a weapon in the pool of weapons that can only reach +5."""
+    """The minimum upgraded value of a weapon in the pool of weapons that can only reach +5"""
     display_name = "Minimum Level of +5 Weapons"
     range_start = 0
     range_end = 5
@@ -155,7 +148,7 @@ class MinLevelsIn5WeaponPoolOption(Range):
 
 
 class MaxLevelsIn5WeaponPoolOption(Range):
-    """The maximum upgraded value of a weapon in the pool of weapons that can only reach +5."""
+    """The maximum upgraded value of a weapon in the pool of weapons that can only reach +5"""
     display_name = "Maximum Level of +5 Weapons"
     range_start = 0
     range_end = 5
@@ -163,7 +156,7 @@ class MaxLevelsIn5WeaponPoolOption(Range):
 
 
 class MinLevelsIn10WeaponPoolOption(Range):
-    """The minimum upgraded value of a weapon in the pool of weapons that can reach +10."""
+    """The minimum upgraded value of a weapon in the pool of weapons that can reach +10"""
     display_name = "Minimum Level of +10 Weapons"
     range_start = 0
     range_end = 10
@@ -171,308 +164,72 @@ class MinLevelsIn10WeaponPoolOption(Range):
 
 
 class MaxLevelsIn10WeaponPoolOption(Range):
-    """The maximum upgraded value of a weapon in the pool of weapons that can reach +10."""
+    """The maximum upgraded value of a weapon in the pool of weapons that can reach +10"""
     display_name = "Maximum Level of +10 Weapons"
     range_start = 0
     range_end = 10
     default = 10
 
 
-## Item Smoothing
-
-class SmoothSoulItemsOption(DefaultOnToggle):
-    """Distribute soul items in a similar order as the base game.
-
-    By default, soul items will be distributed totally randomly. If this is set, less valuable soul
-    items will generally appear in earlier spheres and more valuable ones will generally appear
-    later.
-    """
-    display_name = "Smooth Soul Items"
-
-
-class SmoothUpgradeItemsOption(DefaultOnToggle):
-    """Distribute upgrade items in a similar order as the base game.
-
-    By default, upgrade items will be distributed totally randomly. If this is set, lower-level
-    upgrade items will generally appear in earlier spheres and higher-level ones will generally
-    appear later.
-    """
-    display_name = "Smooth Upgrade Items"
-
-
-class SmoothUpgradedWeaponsOption(DefaultOnToggle):
-    """Distribute upgraded weapons in a similar order as the base game.
-
-    By default, upgraded weapons will be distributed totally randomly. If this is set, lower-level
-    weapons will generally appear in earlier spheres and higher-level ones will generally appear
-    later.
-    """
-    display_name = "Smooth Upgraded Weapons"
-
-
-### Enemies
-
-class RandomizeEnemiesOption(DefaultOnToggle):
-    """Randomize enemy and boss placements."""
-    display_name = "Randomize Enemies"
-
-
-class SimpleEarlyBossesOption(DefaultOnToggle):
-    """Avoid replacing Iudex Gundyr and Vordt with late bosses.
-
-    This excludes all bosses after Dancer of the Boreal Valley from these two boss fights. Disable
-    it for a chance at a much harder early game.
-
-    This is ignored unless enemies are randomized.
-    """
-    display_name = "Simple Early Bosses"
-
-
-class ScaleEnemiesOption(DefaultOnToggle):
-    """Scale randomized enemy stats to match the areas in which they appear.
-
-    Disabling this will tend to make the early game much more difficult and the late game much
-    easier.
-
-    This is ignored unless enemies are randomized.
-    """
-    display_name = "Scale Enemies"
-
-
-class RandomizeMimicsWithEnemiesOption(Toggle):
-    """Mix Mimics into the main enemy pool.
-
-    If this is enabled, Mimics will be replaced by normal enemies who drop the Mimic rewards on
-    death, and Mimics will be placed randomly in place of normal enemies. It's recommended to enable
-    Impatient Mimics as well if you enable this.
-
-    This is ignored unless enemies are randomized.
-    """
-    display_name = "Randomize Mimics With Enemies"
-
-
-class RandomizeSmallCrystalLizardsWithEnemiesOption(Toggle):
-    """Mix small Crystal Lizards into the main enemy pool.
-
-    If this is enabled, Crystal Lizards will be replaced by normal enemies who drop the Crystal
-    Lizard rewards on death, and Crystal Lizards will be placed randomly in place of normal enemies.
-
-    This is ignored unless enemies are randomized.
-    """
-    display_name = "Randomize Small Crystal Lizards With Enemies"
-
-
-class ReduceHarmlessEnemiesOption(Toggle):
-    """Reduce the frequency that "harmless" enemies appear.
-
-    Enable this to add a bit of extra challenge. This severely limits the number of enemies that are
-    slow to aggro, slow to attack, and do very little damage that appear in the enemy pool.
-
-    This is ignored unless enemies are randomized.
-    """
-    display_name = "Reduce Harmless Enemies"
-
-
-class AllChestsAreMimicsOption(Toggle):
-    """Replace all chests with mimics that drop the same items.
-
-    If "Randomize Mimics With Enemies" is set, these chests will instead be replaced with random
-    enemies that drop the same items.
-
-    This is ignored unless enemies are randomized.
-    """
-    display_name = "All Chests Are Mimics"
-
-
-class ImpatientMimicsOption(Toggle):
-    """Mimics attack as soon as you get close instead of waiting for you to open them.
-
-    This is ignored unless enemies are randomized.
-    """
-    display_name = "Impatient Mimics"
-
-
-class RandomEnemyPresetOption(OptionDict):
-    """The YAML preset for the static enemy randomizer.
-
-    See the static randomizer documentation in `randomizer\\presets\\README.txt` for details.
-    Include this as nested YAML. For example:
-
-    .. code-block:: YAML
-
-      random_enemy_preset:
-        RemoveSource: Ancient Wyvern; Darkeater Midir
-        DontRandomize: Iudex Gundyr
-    """
-    display_name = "Random Enemy Preset"
-    supports_weighting = False
-    default = {}
-
-    valid_keys = ["Description", "RecommendFullRandomization", "RecommendNoEnemyProgression",
-                  "OopsAll", "Boss", "Miniboss", "Basic", "BuffBasicEnemiesAsBosses",
-                  "DontRandomize", "RemoveSource", "Enemies"]
-
-    @classmethod
-    def get_option_name(cls, value: Dict[str, Any]) -> str:
-        return json.dumps(value)
-
-
-## Item & Location
-
-class DS3ExcludeLocations(ExcludeLocations):
-    """Prevent these locations from having an important item."""
-    default = frozenset({"Hidden", "Small Crystal Lizards", "Upgrade", "Small Souls", "Miscellaneous"})
-
-
-class ExcludedLocationBehaviorOption(Choice):
-    """How to choose items for excluded locations in DS3.
-
-    - **Allow Useful:** Excluded locations can't have progression items, but they can have useful
-      items.
-    - **Forbid Useful:** Neither progression items nor useful items can be placed in excluded
-      locations.
-    - **Do Not Randomize:** Excluded locations always contain the same item as in vanilla Dark Souls
-      III.
-
-    A "progression item" is anything that's required to unlock another location in some game. A
-    "useful item" is something each game defines individually, usually items that are quite
-    desirable but not strictly necessary.
-    """
-    display_name = "Excluded Locations Behavior"
-    option_allow_useful = 1
-    option_forbid_useful = 2
-    option_do_not_randomize = 3
-    default = 2
-
-
-class MissableLocationBehaviorOption(Choice):
-    """Which items can be placed in locations that can be permanently missed.
-
-    - **Allow Useful:** Missable locations can't have progression items, but they can have useful
-      items.
-    - **Forbid Useful:** Neither progression items nor useful items can be placed in missable
-      locations.
-    - **Do Not Randomize:** Missable locations always contain the same item as in vanilla Dark Souls
-      III.
-
-    A "progression item" is anything that's required to unlock another location in some game. A
-    "useful item" is something each game defines individually, usually items that are quite
-    desirable but not strictly necessary.
-    """
-    display_name = "Missable Locations Behavior"
-    option_allow_useful = 1
-    option_forbid_useful = 2
-    option_do_not_randomize = 3
-    default = 2
-
-
-@dataclass
-class DarkSouls3Options(PerGameCommonOptions):
-    # Game Options
-    early_banner: EarlySmallLothricBanner
-    late_basin_of_vows: LateBasinOfVowsOption
-    late_dlc: LateDLCOption
-    death_link: DeathLink
-    enable_dlc: EnableDLCOption
-    enable_ngp: EnableNGPOption
-
-    # Equipment
-    random_starting_loadout: RandomizeStartingLoadout
-    require_one_handed_starting_weapons: RequireOneHandedStartingWeapons
-    auto_equip: AutoEquipOption
-    lock_equip: LockEquipOption
-    no_equip_load: NoEquipLoadOption
-    no_weapon_requirements: NoWeaponRequirementsOption
-    no_spell_requirements: NoSpellRequirementsOption
-
-    # Weapons
-    randomize_infusion: RandomizeInfusionOption
-    randomize_infusion_percentage: RandomizeInfusionPercentageOption
-    randomize_weapon_level: RandomizeWeaponLevelOption
-    randomize_weapon_level_percentage: RandomizeWeaponLevelPercentageOption
-    min_levels_in_5: MinLevelsIn5WeaponPoolOption
-    max_levels_in_5: MaxLevelsIn5WeaponPoolOption
-    min_levels_in_10: MinLevelsIn10WeaponPoolOption
-    max_levels_in_10: MaxLevelsIn10WeaponPoolOption
-
-    # Item Smoothing
-    smooth_soul_items: SmoothSoulItemsOption
-    smooth_upgrade_items: SmoothUpgradeItemsOption
-    smooth_upgraded_weapons: SmoothUpgradedWeaponsOption
-
-    # Enemies
-    randomize_enemies: RandomizeEnemiesOption
-    simple_early_bosses: SimpleEarlyBossesOption
-    scale_enemies: ScaleEnemiesOption
-    randomize_mimics_with_enemies: RandomizeMimicsWithEnemiesOption
-    randomize_small_crystal_lizards_with_enemies: RandomizeSmallCrystalLizardsWithEnemiesOption
-    reduce_harmless_enemies: ReduceHarmlessEnemiesOption
-    all_chests_are_mimics: AllChestsAreMimicsOption
-    impatient_mimics: ImpatientMimicsOption
-    random_enemy_preset: RandomEnemyPresetOption
-
-    # Item & Location
-    exclude_locations: DS3ExcludeLocations
-    excluded_location_behavior: ExcludedLocationBehaviorOption
-    missable_location_behavior: MissableLocationBehaviorOption
-
-    # Removed
-    pool_type: Removed
-    enable_weapon_locations: Removed
-    enable_shield_locations: Removed
-    enable_armor_locations: Removed
-    enable_ring_locations: Removed
-    enable_spell_locations: Removed
-    enable_key_locations: Removed
-    enable_boss_locations: Removed
-    enable_npc_locations: Removed
-    enable_misc_locations: Removed
-    enable_health_upgrade_locations: Removed
-    enable_progressive_locations: Removed
-    guaranteed_items: Removed
-    excluded_locations: Removed
-    missable_locations: Removed
-
-
-option_groups = [
-    OptionGroup("Equipment", [
-        RandomizeStartingLoadout,
-        RequireOneHandedStartingWeapons,
-        AutoEquipOption,
-        LockEquipOption,
-        NoEquipLoadOption,
-        NoWeaponRequirementsOption,
-        NoSpellRequirementsOption,
-    ]),
-    OptionGroup("Weapons", [
-        RandomizeInfusionOption,
-        RandomizeInfusionPercentageOption,
-        RandomizeWeaponLevelOption,
-        RandomizeWeaponLevelPercentageOption,
-        MinLevelsIn5WeaponPoolOption,
-        MaxLevelsIn5WeaponPoolOption,
-        MinLevelsIn10WeaponPoolOption,
-        MaxLevelsIn10WeaponPoolOption,
-    ]),
-    OptionGroup("Item Smoothing", [
-        SmoothSoulItemsOption,
-        SmoothUpgradeItemsOption,
-        SmoothUpgradedWeaponsOption,
-    ]),
-    OptionGroup("Enemies", [
-        RandomizeEnemiesOption,
-        SimpleEarlyBossesOption,
-        ScaleEnemiesOption,
-        RandomizeMimicsWithEnemiesOption,
-        RandomizeSmallCrystalLizardsWithEnemiesOption,
-        ReduceHarmlessEnemiesOption,
-        AllChestsAreMimicsOption,
-        ImpatientMimicsOption,
-        RandomEnemyPresetOption,
-    ]),
-    OptionGroup("Item & Location Options", [
-        DS3ExcludeLocations,
-        ExcludedLocationBehaviorOption,
-        MissableLocationBehaviorOption,
-    ])
-]
+class EarlySmallLothricBanner(Choice):
+    """This option makes it so the user can choose to force the Small Lothric Banner into an early sphere in their world or
+    into an early sphere across all worlds."""
+    display_name = "Early Small Lothric Banner"
+    option_off = 0
+    option_early_global = 1
+    option_early_local = 2
+    default = option_off
+
+
+class LateBasinOfVowsOption(Toggle):
+    """This option makes it so the Basin of Vows is still randomized, but guarantees you that you wont have to venture into
+    Lothric Castle to find your Small Lothric Banner to get out of High Wall of Lothric. So you may find Basin of Vows early, 
+    but you wont have to fight Dancer to find your Small Lothric Banner."""
+    display_name = "Late Basin of Vows"
+
+
+class LateDLCOption(Toggle):
+    """This option makes it so you are guaranteed to find your Small Doll without having to venture off into the DLC, 
+    effectively putting anything in the DLC in logic after finding both Contraption Key and Small Doll, 
+    and being able to get into Irithyll of the Boreal Valley."""
+    display_name = "Late DLC"
+
+
+class EnableDLCOption(Toggle):
+    """To use this option, you must own both the ASHES OF ARIANDEL and the RINGED CITY DLC"""
+    display_name = "Enable DLC"
+
+
+dark_souls_options: typing.Dict[str, Option] = {
+    "enable_weapon_locations": RandomizeWeaponLocations,
+    "enable_shield_locations": RandomizeShieldLocations,
+    "enable_armor_locations": RandomizeArmorLocations,
+    "enable_ring_locations": RandomizeRingLocations,
+    "enable_spell_locations": RandomizeSpellLocations,
+    "enable_key_locations": RandomizeKeyLocations,
+    "enable_boss_locations": RandomizeBossSoulLocations,
+    "enable_npc_locations": RandomizeNPCLocations,
+    "enable_misc_locations": RandomizeMiscLocations,
+    "enable_health_upgrade_locations": RandomizeHealthLocations,
+    "enable_progressive_locations": RandomizeProgressiveLocationsOption,
+    "pool_type": PoolTypeOption,
+    "guaranteed_items": GuaranteedItemsOption,
+    "auto_equip": AutoEquipOption,
+    "lock_equip": LockEquipOption,
+    "no_weapon_requirements": NoWeaponRequirementsOption,
+    "randomize_infusion": RandomizeInfusionOption,
+    "randomize_infusion_percentage": RandomizeInfusionPercentageOption,
+    "randomize_weapon_level": RandomizeWeaponLevelOption,
+    "randomize_weapon_level_percentage": RandomizeWeaponLevelPercentageOption,
+    "min_levels_in_5": MinLevelsIn5WeaponPoolOption,
+    "max_levels_in_5": MaxLevelsIn5WeaponPoolOption,
+    "min_levels_in_10": MinLevelsIn10WeaponPoolOption,
+    "max_levels_in_10": MaxLevelsIn10WeaponPoolOption,
+    "early_banner": EarlySmallLothricBanner,
+    "late_basin_of_vows": LateBasinOfVowsOption,
+    "late_dlc": LateDLCOption,
+    "no_spell_requirements": NoSpellRequirementsOption,
+    "no_equip_load": NoEquipLoadOption,
+    "death_link": DeathLink,
+    "enable_dlc": EnableDLCOption,
+}

worlds/dark_souls_3/detailed_location_descriptions.py

@@ -1,97 +0,0 @@
-# python -m worlds.dark_souls_3.detailed_location_descriptions \
-#     worlds/dark_souls_3/detailed_location_descriptions.py
-#
-# This script downloads the static randomizer's descriptions for each location and adds them to
-# the location documentation.
-
-from collections import defaultdict
-import html
-import os
-import re
-import requests
-import yaml
-
-from .Locations import location_dictionary
-
-
-location_re = re.compile(r'^([A-Z0-9]+): (.*?)(?:$| - )')
-
-if __name__ == '__main__':
-    # TODO: update this to the main branch of the main randomizer once Archipelago support is merged
-    url = 'https://raw.githubusercontent.com/nex3/SoulsRandomizers/archipelago-server/dist/Base/annotations.txt'
-    response = requests.get(url)
-    if response.status_code != 200:
-        raise Exception(f"Got {response.status_code} when downloading static randomizer locations")
-    annotations = yaml.load(response.text, Loader=yaml.Loader)
-
-    static_to_archi_regions = {
-        area['Name']: area['Archipelago']
-        for area in annotations['Areas']
-    }
-
-    descriptions_by_key = {slot['Key']: slot['Text'] for slot in annotations['Slots']}
-
-    # A map from (region, item name) pairs to all the descriptions that match those pairs.
-    descriptions_by_location = defaultdict(list)
-
-    # A map from item names to all the descriptions for those item names.
-    descriptions_by_item = defaultdict(list)
-
-    for slot in annotations['Slots']:
-        region = static_to_archi_regions[slot['Area']]
-        for item in slot['DebugText']:
-            name = item.split(" - ")[0]
-            descriptions_by_location[(region, name)].append(slot['Text'])
-            descriptions_by_item[name].append(slot['Text'])
-    counts_by_location = {
-        location: len(descriptions) for (location, descriptions) in descriptions_by_location.items()
-    }
-
-    location_names_to_descriptions = {}
-    for location in location_dictionary.values():
-        if location.ap_code is None: continue
-        if location.static:
-            location_names_to_descriptions[location.name] = descriptions_by_key[location.static]
-            continue
-
-        match = location_re.match(location.name)
-        if not match:
-            raise Exception(f"Location name \"{location.name}\" doesn't match expected format.")
-
-        item_candidates = descriptions_by_item[match[2]]
-        if len(item_candidates) == 1:
-            location_names_to_descriptions[location.name] = item_candidates[0]
-            continue
-
-        key = (match[1], match[2])
-        if key not in descriptions_by_location:
-            raise Exception(f'No static randomizer location found matching "{match[1]}: {match[2]}".')
-
-        candidates = descriptions_by_location[key]
-        if len(candidates) == 0:
-            raise Exception(
-                f'There are only {counts_by_location[key]} locations in the static randomizer ' +
-                f'matching "{match[1]}: {match[2]}", but there are more in Archipelago.'
-            )
-
-        location_names_to_descriptions[location.name] = candidates.pop(0)
-
-    table = "<table><tr><th>Location name</th><th>Detailed description</th>\n"
-    for (name, description) in sorted(
-        location_names_to_descriptions.items(),
-        key = lambda pair: pair[0]
-    ):
-        table += f"<tr><td>{html.escape(name)}</td><td>{html.escape(description)}</td></tr>\n"
-    table += "</table>\n"
-
-    with open(os.path.join(os.path.dirname(__file__), 'docs/locations_en.md'), 'r+') as f:
-        original = f.read()
-        start_flag = "<!-- begin location table -->\n"
-        start = original.index(start_flag) + len(start_flag)
-        end = original.index("<!-- end location table -->")
-
-        f.seek(0)
-        f.write(original[:start] + table + original[end:])
-        f.truncate()
-
-    print("Updated docs/locations_en.md!")

worlds/dark_souls_3/docs/en_Dark Souls III.md

@@ -1,201 +1,28 @@
 # Dark Souls III
 
-Game Page | [Items] | [Locations]
-
-[Items]: /tutorial/Dark%20Souls%20III/items/en
-[Locations]: /tutorial/Dark%20Souls%20III/locations/en
-
-## What do I need to do to randomize DS3?
-
-See full instructions on [the setup page].
-
-[the setup page]: /tutorial/Dark%20Souls%20III/setup/en
-
 ## Where is the options page?
 
-The [player options page for this game][options] contains all the options you
-need to configure and export a config file.
-
-[options]: ../player-options
+The [player options page for this game](../player-options) contains all the options you need to configure and export a
+config file.
 
 ## What does randomization do to this game?
 
-1. All item locations are randomized, including those in the overworld, in
-   shops, and dropped by enemies. Most locations can contain games from other
-   worlds, and any items from your world can appear in other players' worlds.
+Items that can be picked up from static corpses, taken from chests, or earned from defeating enemies or NPCs can be
+randomized. Common pickups like titanite shards or firebombs can be randomized as "progressive" items. That is, the
+location "Titanite Shard #5" is the fifth titanite shard you pick up, no matter where it was from. This is also what
+happens when you randomize Estus Shards and Undead Bone Shards.
 
-2. By default, all enemies and bosses are randomized. This can be disabled by
-   setting "Randomize Enemies" to false.
+It's also possible to randomize the upgrade level of weapons and shields as well as their infusions (if they can have
+one). Additionally, there are options that can make the randomized experience more convenient or more interesting, such as
+removing weapon requirements or auto-equipping whatever equipment you most recently received.
 
-3. By default, the starting equipment for each class is randomized. This can be
-   disabled by setting "Randomize Starting Loadout" to false.
+The goal is to find the four "Cinders of a Lord" items randomized into the multiworld and defeat the Soul of Cinder.
 
-4. By setting the "Randomize Weapon Level" or "Randomize Infusion" options, you
-   can randomize whether the weapons you find will be upgraded or infused.
+## What Dark Souls III items can appear in other players' worlds?
 
-There are also options that can make playing the game more convenient or
-bring a new experience, like removing equip loads or auto-equipping weapons as
-you pick them up. Check out [the options page][options] for more!
+Practically anything can be found in other worlds including pieces of armor, upgraded weapons, key items, consumables,
+spells, upgrade materials, etc...
 
-## What's the goal?
+## What does another world's item look like in Dark Souls III?
 
-Your goal is to find the four "Cinders of a Lord" items randomized into the
-multiworld and defeat the boss in the Kiln of the First Flame.
-
-## Do I have to check every item in every area?
-
-Dark Souls III has about 1500 item locations, which is a lot of checks for a
-single run! But you don't necessarily need to check all of them. Locations that
-you can potentially miss, such as rewards for failable quests or soul
-transposition items, will _never_ have items required for any game to progress.
-The following types of locations are also guaranteed not to contain progression
-items by default:
-
-* **Hidden:** Locations that are particularly difficult to find, such as behind
-  illusory walls, down hidden drops, and so on. Does not include large locations
-  like Untended Graves or Archdragon Peak.
-
-* **Small Crystal Lizards:** Drops from small crystal lizards.
-
-* **Upgrade:** Locations that contain upgrade items in vanilla, including
-  titanite, gems, and Shriving Stones.
-
-* **Small Souls:** Locations that contain soul items in vanilla, not including
-  boss souls.
-
-* **Miscellaneous:** Locations that contain generic stackable items in vanilla,
-  such as arrows, firebombs, buffs, and so on.
-
-You can customize which locations are guaranteed not to contain progression
-items by setting the `exclude_locations` field in your YAML to the [location
-groups] you want to omit. For example, this is the default setting but without
-"Hidden" so that hidden locations can contain progression items:
-
-[location groups]: /tutorial/Dark%20Souls%20III/locations/en#location-groups
-
-```yaml
-Dark Souls III:
-  exclude_locations:
-  - Small Crystal Lizards
-  - Upgrade
-  - Small Souls
-  - Miscellaneous
-```
-
-This allows _all_ non-missable locations to have progression items, if you're in
-for the long haul:
-
-```yaml
-Dark Souls III:
-  exclude_locations: []
-```
-
-## What if I don't want to do the whole game?
-
-If you want a shorter DS3 randomizer experience, you can exclude entire regions
-from containing progression items. The items and enemies from those regions will
-still be included in the randomization pool, but none of them will be mandatory.
-For example, the following configuration just requires you to play the game
-through Irithyll of the Boreal Valley:
-
-```yaml
-Dark Souls III:
-  # Enable the DLC so it's included in the randomization pool
-  enable_dlc: true
-
-  exclude_locations:
-    # Exclude late-game and DLC regions
-    - Anor Londo
-    - Lothric Castle
-    - Consumed King's Garden
-    - Untended Graves
-    - Grand Archives
-    - Archdragon Peak
-    - Painted World of Ariandel
-    - Dreg Heap
-    - Ringed City
-
-    # Default exclusions
-    - Hidden
-    - Small Crystal Lizards
-    - Upgrade
-    - Small Souls
-    - Miscellaneous
-```
-
-## Where can I learn more about Dark Souls III locations?
-
-Location names have to pack a lot of information into very little space. To
-better understand them, check out the [location guide], which explains all the
-names used in locations and provides more detailed descriptions for each
-individual location.
-
-[location guide]: /tutorial/Dark%20Souls%20III/locations/en
-
-## Where can I learn more about Dark Souls III items?
-
-Check out the [item guide], which explains the named groups available for items.
-
-[item guide]: /tutorial/Dark%20Souls%20III/items/en
-
-## What's new from 2.x.x?
-
-Version 3.0.0 of the Dark Souls III Archipelago client has a number of
-substantial differences with the older 2.x.x versions. Improvements include:
-
-* Support for randomizing all item locations, not just unique items.
-
-* Support for randomizing items in shops, starting loadouts, Path of the Dragon,
-  and more.
-
-* Built-in integration with the enemy randomizer, including consistent seeding
-  for races.
-
-* Support for the latest patch for Dark Souls III, 1.15.2. Older patches are
-  *not* supported.
-
-* Optional smooth distribution for upgrade items, upgraded weapons, and soul
-  items so you're more likely to see weaker items earlier and more powerful
-  items later.
-
-* More detailed location names that indicate where a location is, not just what
-  it replaces.
-
-* Other players' item names are visible in DS3.
-
-* If you pick up items while static, they'll still send once you reconnect.
- 
-However, 2.x.x YAMLs are not compatible with 3.0.0. You'll need to [generate a
-new YAML configuration] for use with 3.x.x.
-
-[generating a new YAML configuration]: /games/Dark%20Souls%20III/player-options
-
-The following options have been removed:
-
-* `enable_boss_locations` is now controlled by the `soul_locations` option.
-
-* `enable_progressive_locations` was removed because all locations are now
-  individually randomized rather than replaced with a progressive list.
-
-* `pool_type` has been removed. Since there are no longer any non-randomized
-  items in randomized categories, there's not a meaningful distinction between
-  "shuffle" and "various" mode.
-
-* `enable_*_locations` options have all been removed. Instead, you can now add
-  [location group names] to the `exclude_locations` option to prevent them from
-  containing important items.
-
-  [location group names]: /tutorial/Dark%20Souls%20III/locations/en#location-groups
-
-  By default, the Hidden, Small Crystal Lizards, Upgrade, Small Souls, and
-  Miscellaneous groups are in `exclude_locations`. Once you've chosen your
-  excluded locations, you can set `excluded_locations: unrandomized` to preserve
-  the default vanilla item placements for all excluded locations.
-
-* `guaranteed_items`: In almost all cases, all items from the base game are now
-  included somewhere in the multiworld.
-
-In addition, the following options have changed:
-
-* The location names used in options like `exclude_locations` have changed. See
-  the [location guide] for a full description.
+In Dark Souls III, items which are sent to other worlds appear as Prism Stones.

worlds/dark_souls_3/docs/items_en.md

@@ -1,24 +0,0 @@
-# Dark Souls III Items
-
-[Game Page] | Items | [Locations]
-
-[Game Page]: /games/Dark%20Souls%20III/info/en
-[Locations]: /tutorial/Dark%20Souls%20III/locations/en
-
-## Item Groups
-
-The Dark Souls III randomizer supports a number of item group names, which can
-be used in YAML options like `local_items` to refer to many items at once:
-
-* **Progression:** Items which unlock locations.
-* **Cinders:** All four Cinders of a Lord. Once you have these four, you can
-  fight Soul of Cinder and win the game.
-* **Miscellaneous:** Generic stackable items, such as arrows, firebombs, buffs,
-  and so on.
-* **Unique:** Items that are unique per NG cycle, such as scrolls, keys, ashes,
-  and so on. Doesn't include equipment, spells, or souls.
-* **Boss Souls:** Souls that can be traded with Ludleth, including Soul of
-  Rosaria.
-* **Small Souls:** Soul items, not including boss souls.
-* **Upgrade:** Upgrade items, including titanite, gems, and Shriving Stones.
-* **Healing:** Undead Bone Shards and Estus Shards.

worlds/dark_souls_3/docs/setup_en.md

@@ -7,49 +7,48 @@
 
 ## Optional Software
 
-- Map tracker not yet updated for 3.0.0
+- [Dark Souls III Maptracker Pack](https://github.com/Br00ty/DS3_AP_Maptracker/releases/latest), for use with [Poptracker](https://github.com/black-sliver/PopTracker/releases)
 
-## Setting Up
+## General Concept
 
-First, download the client from the link above. It doesn't need to go into any particular directory;
-it'll automatically locate _Dark Souls III_ in your Steam installation folder.
+<span style="color:#ff7800">
+**This mod can ban you permanently from the FromSoftware servers if used online.** 
+</span>
+The Dark Souls III AP Client is a dinput8.dll triggered when launching Dark Souls III. This .dll file will launch a command 
+prompt where you can read information about your run and write any command to interact with the Archipelago server.
 
-Version 3.0.0 of the randomizer _only_ supports the latest version of _Dark Souls III_, 1.15.2. This
-is the latest version, so you don't need to do any downpatching! However, if you've already
-downpatched your game to use an older version of the randomizer, you'll need to reinstall the latest
-version before using this version.
+This client has only been tested with the Official Steam version of the game at version 1.15. It does not matter which DLCs are installed. However, you will have to downpatch your Dark Souls III installation from current patch.
 
-### One-Time Setup
+## Downpatching Dark Souls III
 
-Before you first connect to a multiworld, you need to generate the local data files for your world's
-randomized item and (optionally) enemy locations. You only need to do this once per multiworld.
+To downpatch DS3 for use with Archipelago, use the following instructions from the speedsouls wiki database. 
 
-1. Before you first connect to a multiworld, run `randomizer\DS3Randomizer.exe`.
+1. Launch Steam (in online mode).
+2. Press the Windows Key + R. This will open the Run window.
+3. Open the Steam console by typing the following string: `steam://open/console`. Steam should now open in Console Mode.
+4. Insert the string of the depot you wish to download. For the AP-supported v1.15, you will want to use: `download_depot 374320 374321 4471176929659548333`.
+5. Steam will now download the depot. Note: There is no progress bar for the download in Steam, but it is still downloading in the background.
+6. Back up your existing game executable (`DarkSoulsIII.exe`) found in `\Steam\steamapps\common\DARK SOULS III\Game`. Easiest way to do this is to move it to another directory. If you have file extensions enabled, you can instead rename the executable to `DarkSoulsIII.exe.bak`.
+7. Return to the Steam console. Once the download is complete, it should say so along with the temporary local directory in which the depot has been stored. This is usually something like `\Steam\steamapps\content\app_XXXXXX\depot_XXXXXX`.
+8. Take the `DarkSoulsIII.exe` from that folder and place it in `\Steam\steamapps\common\DARK SOULS III\Game`.
+9. Back up and delete your save file (`DS30000.sl2`) in AppData. AppData is hidden by default. To locate it, press Windows Key + R, type `%appdata%` and hit enter. Alternatively: open File Explorer > View > Hidden Items and follow `C:\Users\<your_username>\AppData\Roaming\DarkSoulsIII\<numbers>`.
+10. If you did all these steps correctly, you should be able to confirm your game version in the upper-left corner after launching Dark Souls III.
 
-2. Put in your Archipelago room address (usually something like `archipelago.gg:12345`), your player
-   name (also known as your "slot name"), and your password if you have one.
 
-3. Click "Load" and wait a minute or two.
+## Installing the Archipelago mod
 
-### Running and Connecting the Game
+Get the `dinput8.dll` from the [Dark Souls III AP Client](https://github.com/Marechal-L/Dark-Souls-III-Archipelago-client/releases) and 
+add it at the root folder of your game (e.g. `SteamLibrary\steamapps\common\DARK SOULS III\Game`)
 
-To run _Dark Souls III_ in Archipelago mode:
+## Joining a MultiWorld Game
 
-1. Start Steam. **Do not run in offline mode.** The mod will make sure you don't connect to the
-   DS3 servers, and running Steam in offline mode will make certain scripted invaders fail to spawn.
+1. Run Steam in offline mode to avoid being banned.
+2. Launch Dark Souls III.
+3. Type in `/connect {SERVER_IP}:{SERVER_PORT} {SLOT_NAME} password:{PASSWORD}` in the "Windows Command Prompt" that opened. For example: `/connect archipelago.gg:38281 "Example Name" password:"Example Password"`. The password parameter is only necessary if your game requires one.
+4. Once connected, create a new game, choose a class and wait for the others before starting.
+5. You can quit and launch at anytime during a game.
 
-2. Run `launchmod_darksouls3.bat`. This will start _Dark Souls III_ as well as a command prompt that
-   you can use to interact with the Archipelago server.
-
-3. Type `/connect {SERVER_IP}:{SERVER_PORT} {SLOT_NAME}` into the command prompt, with the
-   appropriate values filled in. For example: `/connect archipelago.gg:24242 PlayerName`.
-
-4. Start playing as normal. An "Archipelago connected" message will appear onscreen once you have
-   control of your character and the connection is established.
-
-## Frequently Asked Questions
-
-### Where do I get a config file?
+## Where do I get a config file?
 
 The [Player Options](/games/Dark%20Souls%20III/player-options) page on the website allows you to
 configure your personal options and export them into a config file.

worlds/dark_souls_3/test/TestDarkSouls3.py

@@ -1,27 +0,0 @@
-from test.TestBase import WorldTestBase
-
-from worlds.dark_souls_3.Items import item_dictionary
-from worlds.dark_souls_3.Locations import location_tables
-from worlds.dark_souls_3.Bosses import all_bosses
-
-class DarkSouls3Test(WorldTestBase):
-    game = "Dark Souls III"
-
-    def testLocationDefaultItems(self):
-        for locations in location_tables.values():
-            for location in locations:
-                if location.default_item_name:
-                    self.assertIn(location.default_item_name, item_dictionary)
-
-    def testLocationsUnique(self):
-        names = set()
-        for locations in location_tables.values():
-            for location in locations:
-                self.assertNotIn(location.name, names)
-                names.add(location.name)
-
-    def testBossLocations(self):
-        all_locations = {location.name for locations in location_tables.values() for location in locations}
-        for boss in all_bosses:
-            for location in boss.locations:
-                self.assertIn(location, all_locations)

worlds/doom_1993/docs/setup_en.md

@@ -2,7 +2,7 @@
 
 ## Required Software
 
-- [DOOM 1993 (e.g. Steam version)](https://store.steampowered.com/app/2280/DOOM__DOOM_II/)
+- [DOOM 1993 (e.g. Steam version)](https://store.steampowered.com/app/2280/DOOM_1993/)
 - [Archipelago Crispy DOOM](https://github.com/Daivuk/apdoom/releases)
 
 ## Optional Software

worlds/doom_ii/docs/setup_en.md

@@ -2,7 +2,7 @@
 
 ## Required Software
 
-- [DOOM II (e.g. Steam version)](https://store.steampowered.com/app/2280/DOOM__DOOM_II/)
+- [DOOM II (e.g. Steam version)](https://store.steampowered.com/app/2300/DOOM_II/)
 - [Archipelago Crispy DOOM](https://github.com/Daivuk/apdoom/releases)
 
 ## Optional Software

worlds/hk/Options.py

@@ -405,20 +405,9 @@ class Goal(Choice):
     option_radiance = 3
     option_godhome = 4
     option_godhome_flower = 5
-    option_grub_hunt = 6
     default = 0
 
 
-class GrubHuntGoal(NamedRange):
-    """The amount of grubs required to finish Grub Hunt.
-    On 'All' any grubs from item links replacements etc. will be counted"""
-    display_name = "Grub Hunt Goal"
-    range_start = 1
-    range_end = 46
-    special_range_names = {"all": -1}
-    default = 46
-
-
 class WhitePalace(Choice):
     """
     Whether or not to include White Palace or not.  Note: Even if excluded, the King Fragment check may still be
@@ -533,7 +522,7 @@ hollow_knight_options: typing.Dict[str, type(Option)] = {
     **{
         option.__name__: option
         for option in (
-            StartLocation, Goal, GrubHuntGoal, WhitePalace, ExtraPlatforms, AddUnshuffledLocations, StartingGeo,
+            StartLocation, Goal, WhitePalace, ExtraPlatforms, AddUnshuffledLocations, StartingGeo,
             DeathLink, DeathLinkShade, DeathLinkBreaksFragileCharms,
             MinimumGeoPrice, MaximumGeoPrice,
             MinimumGrubPrice, MaximumGrubPrice,

worlds/hk/__init__.py

@@ -5,7 +5,6 @@ import typing
 from copy import deepcopy
 import itertools
 import operator
-from collections import defaultdict, Counter
 
 logger = logging.getLogger("Hollow Knight")
 
@@ -13,12 +12,12 @@ from .Items import item_table, lookup_type_to_names, item_name_groups
 from .Regions import create_regions
 from .Rules import set_rules, cost_terms, _hk_can_beat_thk, _hk_siblings_ending, _hk_can_beat_radiance
 from .Options import hollow_knight_options, hollow_knight_randomize_options, Goal, WhitePalace, CostSanity, \
-    shop_to_option, HKOptions, GrubHuntGoal
+    shop_to_option, HKOptions
 from .ExtractedData import locations, starts, multi_locations, location_to_region_lookup, \
     event_names, item_effects, connectors, one_ways, vanilla_shop_costs, vanilla_location_costs
 from .Charms import names as charm_names
 
-from BaseClasses import Region, Location, MultiWorld, Item, LocationProgressType, Tutorial, ItemClassification, CollectionState
+from BaseClasses import Region, Location, MultiWorld, Item, LocationProgressType, Tutorial, ItemClassification
 from worlds.AutoWorld import World, LogicMixin, WebWorld
 
 path_of_pain_locations = {
@@ -156,7 +155,6 @@ class HKWorld(World):
     ranges: typing.Dict[str, typing.Tuple[int, int]]
     charm_costs: typing.List[int]
     cached_filler_items = {}
-    grub_count: int
 
     def __init__(self, multiworld, player):
         super(HKWorld, self).__init__(multiworld, player)
@@ -166,7 +164,6 @@ class HKWorld(World):
         self.ranges = {}
         self.created_shop_items = 0
         self.vanilla_shop_costs = deepcopy(vanilla_shop_costs)
-        self.grub_count = 0
 
     def generate_early(self):
         options = self.options
@@ -204,7 +201,7 @@ class HKWorld(World):
 
         # check for any goal that godhome events are relevant to
         all_event_names = event_names.copy()
-        if self.options.Goal in [Goal.option_godhome, Goal.option_godhome_flower, Goal.option_any]:
+        if self.options.Goal in [Goal.option_godhome, Goal.option_godhome_flower]:
             from .GodhomeData import godhome_event_names
             all_event_names.update(set(godhome_event_names))
 
@@ -444,67 +441,12 @@ class HKWorld(World):
             multiworld.completion_condition[player] = lambda state: state.count("Defeated_Pantheon_5", player)
         elif goal == Goal.option_godhome_flower:
             multiworld.completion_condition[player] = lambda state: state.count("Godhome_Flower_Quest", player)
-        elif goal == Goal.option_grub_hunt:
-            pass  # will set in stage_pre_fill()
         else:
             # Any goal
-            multiworld.completion_condition[player] = lambda state: _hk_siblings_ending(state, player) and \
-                _hk_can_beat_radiance(state, player) and state.count("Godhome_Flower_Quest", player)
+            multiworld.completion_condition[player] = lambda state: _hk_can_beat_thk(state, player) or _hk_can_beat_radiance(state, player)
 
         set_rules(self)
 
-    @classmethod
-    def stage_pre_fill(cls, multiworld: "MultiWorld"):
-        def set_goal(player, grub_rule: typing.Callable[[CollectionState], bool]):
-            world = multiworld.worlds[player]
-
-            if world.options.Goal == "grub_hunt":
-                multiworld.completion_condition[player] = grub_rule
-            else:
-                old_rule = multiworld.completion_condition[player]
-                multiworld.completion_condition[player] = lambda state: old_rule(state) and grub_rule(state)
-
-        worlds = [world for world in multiworld.get_game_worlds(cls.game) if world.options.Goal in ["any", "grub_hunt"]]
-        if worlds:
-            grubs = [item for item in multiworld.get_items() if item.name == "Grub"]
-        all_grub_players = [world.player for world in worlds if world.options.GrubHuntGoal == GrubHuntGoal.special_range_names["all"]]
-
-        if all_grub_players:
-            group_lookup = defaultdict(set)
-            for group_id, group in multiworld.groups.items():
-                for player in group["players"]:
-                    group_lookup[group_id].add(player)
-
-            grub_count_per_player = Counter()
-            per_player_grubs_per_player = defaultdict(Counter)
-
-            for grub in grubs:
-                player = grub.player
-                if player in group_lookup:
-                    for real_player in group_lookup[player]:
-                        per_player_grubs_per_player[real_player][player] += 1
-                else:
-                    per_player_grubs_per_player[player][player] += 1
-
-                if grub.location and grub.location.player in group_lookup.keys():
-                    for real_player in group_lookup[grub.location.player]:
-                        grub_count_per_player[real_player] += 1
-                else:
-                    grub_count_per_player[player] += 1
-
-            for player, count in grub_count_per_player.items():
-                multiworld.worlds[player].grub_count = count
-
-            for player, grub_player_count in per_player_grubs_per_player.items():
-                if player in all_grub_players:
-                    set_goal(player, lambda state, g=grub_player_count: all(state.has("Grub", owner, count) for owner, count in g.items()))
-
-        for world in worlds:
-            if world.player not in all_grub_players:
-                world.grub_count = world.options.GrubHuntGoal.value
-                player = world.player
-                set_goal(player, lambda state, p=player, c=world.grub_count: state.has("Grub", p, c))
-
     def fill_slot_data(self):
         slot_data = {}
 
@@ -542,8 +484,6 @@ class HKWorld(World):
 
         slot_data["notch_costs"] = self.charm_costs
 
-        slot_data["grub_count"] = self.grub_count
-
         return slot_data
 
     def create_item(self, name: str) -> HKItem:

worlds/kdl3/Aesthetics.py

@@ -1,9 +1,5 @@
 import struct
-from .options import KirbyFlavorPreset, GooeyFlavorPreset
-from typing import TYPE_CHECKING, Optional, Dict, List, Tuple
-
-if TYPE_CHECKING:
-    from . import KDL3World
+from .Options import KirbyFlavorPreset, GooeyFlavorPreset
 
 kirby_flavor_presets = {
     1: {
@@ -227,23 +223,6 @@ kirby_flavor_presets = {
         "14": "E6E6FA",
         "15": "976FBD",
     },
-    14: {
-      "1": "373B3E",
-      "2": "98d5d3",
-      "3": "1aa5ab",
-      "4": "168f95",
-      "5": "4f5559",
-      "6": "1dbac2",
-      "7": "137a7f",
-      "8": "093a3c",
-      "9": "86cecb",
-      "10": "a0afbc",
-      "11": "62bfbb",
-      "12": "50b8b4",
-      "13": "bec8d1",
-      "14": "bce4e2",
-      "15": "91a2b1",
-  }
 }
 
 gooey_flavor_presets = {
@@ -419,21 +398,21 @@ gooey_target_palettes = {
 }
 
 
-def get_kirby_palette(world: "KDL3World") -> Optional[Dict[str, str]]:
+def get_kirby_palette(world):
     palette = world.options.kirby_flavor_preset.value
     if palette == KirbyFlavorPreset.option_custom:
         return world.options.kirby_flavor.value
     return kirby_flavor_presets.get(palette, None)
 
 
-def get_gooey_palette(world: "KDL3World") -> Optional[Dict[str, str]]:
+def get_gooey_palette(world):
     palette = world.options.gooey_flavor_preset.value
     if palette == GooeyFlavorPreset.option_custom:
         return world.options.gooey_flavor.value
     return gooey_flavor_presets.get(palette, None)
 
 
-def rgb888_to_bgr555(red: int, green: int, blue: int) -> bytes:
+def rgb888_to_bgr555(red, green, blue) -> bytes:
     red = red >> 3
     green = green >> 3
     blue = blue >> 3
@@ -441,15 +420,15 @@ def rgb888_to_bgr555(red: int, green: int, blue: int) -> bytes:
     return struct.pack("H", outcol)
 
 
-def get_palette_bytes(palette: Dict[str, str], target: List[str], offset: int, factor: float) -> bytes:
+def get_palette_bytes(palette, target, offset, factor):
     output_data = bytearray()
     for color in target:
         hexcol = palette[color]
         if hexcol.startswith("#"):
             hexcol = hexcol.replace("#", "")
         colint = int(hexcol, 16)
-        col: Tuple[int, ...] = ((colint & 0xFF0000) >> 16, (colint & 0xFF00) >> 8, colint & 0xFF)
+        col = ((colint & 0xFF0000) >> 16, (colint & 0xFF00) >> 8, colint & 0xFF)
         col = tuple(int(int(factor*x) + offset) for x in col)
         byte_data = rgb888_to_bgr555(col[0], col[1], col[2])
         output_data.extend(bytearray(byte_data))
-    return bytes(output_data)
+    return output_data

worlds/kdl3/Client.py

@@ -11,13 +11,13 @@ from MultiServer import mark_raw
 from NetUtils import ClientStatus, color
 from Utils import async_start
 from worlds.AutoSNIClient import SNIClient
-from .locations import boss_locations
-from .gifting import kdl3_gifting_options, kdl3_trap_gifts, kdl3_gifts, update_object, pop_object, initialize_giftboxes
-from .client_addrs import consumable_addrs, star_addrs
+from .Locations import boss_locations
+from .Gifting import kdl3_gifting_options, kdl3_trap_gifts, kdl3_gifts, update_object, pop_object, initialize_giftboxes
+from .ClientAddrs import consumable_addrs, star_addrs
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from SNIClient import SNIClientCommandProcessor, SNIContext
+    from SNIClient import SNIClientCommandProcessor
 
 snes_logger = logging.getLogger("SNES")
 
@@ -81,16 +81,17 @@ deathlink_messages = defaultdict(lambda: " was defeated.", {
 
 
 @mark_raw
-def cmd_gift(self: "SNIClientCommandProcessor") -> None:
+def cmd_gift(self: "SNIClientCommandProcessor"):
     """Toggles gifting for the current game."""
-    handler = self.ctx.client_handler
-    assert isinstance(handler, KDL3SNIClient)
-    handler.gifting = not handler.gifting
-    self.output(f"Gifting set to {handler.gifting}")
+    if not getattr(self.ctx, "gifting", None):
+        self.ctx.gifting = True
+    else:
+        self.ctx.gifting = not self.ctx.gifting
+    self.output(f"Gifting set to {self.ctx.gifting}")
     async_start(update_object(self.ctx, f"Giftboxes;{self.ctx.team}", {
         f"{self.ctx.slot}":
             {
-                "IsOpen": handler.gifting,
+                "IsOpen": self.ctx.gifting,
                 **kdl3_gifting_options
             }
     }))
@@ -99,17 +100,16 @@ def cmd_gift(self: "SNIClientCommandProcessor") -> None:
 class KDL3SNIClient(SNIClient):
     game = "Kirby's Dream Land 3"
     patch_suffix = ".apkdl3"
-    levels: typing.Dict[int, typing.List[int]] = {}
-    consumables: typing.Optional[bool] = None
-    stars: typing.Optional[bool] = None
-    item_queue: typing.List[int] = []
-    initialize_gifting: bool = False
-    gifting: bool = False
+    levels = None
+    consumables = None
+    stars = None
+    item_queue: typing.List = []
+    initialize_gifting = False
     giftbox_key: str = ""
     motherbox_key: str = ""
     client_random: random.Random = random.Random()
 
-    async def deathlink_kill_player(self, ctx: "SNIContext") -> None:
+    async def deathlink_kill_player(self, ctx) -> None:
         from SNIClient import DeathState, snes_buffered_write, snes_flush_writes, snes_read
         game_state = await snes_read(ctx, KDL3_GAME_STATE, 1)
         if game_state[0] == 0xFF:
@@ -131,7 +131,7 @@ class KDL3SNIClient(SNIClient):
         ctx.death_state = DeathState.dead
         ctx.last_death_link = time.time()
 
-    async def validate_rom(self, ctx: "SNIContext") -> bool:
+    async def validate_rom(self, ctx) -> bool:
         from SNIClient import snes_read
         rom_name = await snes_read(ctx, KDL3_ROMNAME, 0x15)
         if rom_name is None or rom_name == bytes([0] * 0x15) or rom_name[:4] != b"KDL3":
@@ -141,7 +141,7 @@ class KDL3SNIClient(SNIClient):
 
         ctx.game = self.game
         ctx.rom = rom_name
-        ctx.items_handling = 0b101  # default local items with remote start inventory
+        ctx.items_handling = 0b111  # always remote items
         ctx.allow_collect = True
         if "gift" not in ctx.command_processor.commands:
             ctx.command_processor.commands["gift"] = cmd_gift
@@ -149,10 +149,9 @@ class KDL3SNIClient(SNIClient):
         death_link = await snes_read(ctx, KDL3_DEATH_LINK_ADDR, 1)
         if death_link:
             await ctx.update_death_link(bool(death_link[0] & 0b1))
-            ctx.items_handling |= (death_link[0] & 0b10)  # set local items if enabled
         return True
 
-    async def pop_item(self, ctx: "SNIContext", in_stage: bool) -> None:
+    async def pop_item(self, ctx, in_stage):
         from SNIClient import snes_buffered_write, snes_read
         if len(self.item_queue) > 0:
             item = self.item_queue.pop()
@@ -169,8 +168,8 @@ class KDL3SNIClient(SNIClient):
             else:
                 self.item_queue.append(item)  # no more slots, get it next go around
 
-    async def pop_gift(self, ctx: "SNIContext") -> None:
-        if self.giftbox_key in ctx.stored_data and ctx.stored_data[self.giftbox_key]:
+    async def pop_gift(self, ctx):
+        if ctx.stored_data[self.giftbox_key]:
             from SNIClient import snes_read, snes_buffered_write
             key, gift = ctx.stored_data[self.giftbox_key].popitem()
             await pop_object(ctx, self.giftbox_key, key)
@@ -215,7 +214,7 @@ class KDL3SNIClient(SNIClient):
                     quality = min(10, quality * 2)
                 else:
                     # it's not really edible, but he'll eat it anyway
-                    quality = self.client_random.choices(range(0, 2), [75, 25])[0]
+                    quality = self.client_random.choices(range(0, 2), {0: 75, 1: 25})[0]
                 kirby_hp = await snes_read(ctx, KDL3_KIRBY_HP, 1)
                 gooey_hp = await snes_read(ctx, KDL3_KIRBY_HP + 2, 1)
                 snes_buffered_write(ctx, KDL3_SOUND_FX, bytes([0x26]))
@@ -225,8 +224,7 @@ class KDL3SNIClient(SNIClient):
                 else:
                     snes_buffered_write(ctx, KDL3_KIRBY_HP, struct.pack("H", min(kirby_hp[0] + quality, 10)))
 
-    async def pick_gift_recipient(self, ctx: "SNIContext", gift: int) -> None:
-        assert ctx.slot
+    async def pick_gift_recipient(self, ctx, gift):
         if gift != 4:
             gift_base = kdl3_gifts[gift]
         else:
@@ -240,7 +238,7 @@ class KDL3SNIClient(SNIClient):
             if desire > most_applicable:
                 most_applicable = desire
                 most_applicable_slot = int(slot)
-            elif most_applicable_slot != ctx.slot and most_applicable == -1 and info["AcceptsAnyGift"]:
+            elif most_applicable_slot == ctx.slot and info["AcceptsAnyGift"]:
                 # only send to ourselves if no one else will take it
                 most_applicable_slot = int(slot)
         # print(most_applicable, most_applicable_slot)
@@ -259,7 +257,7 @@ class KDL3SNIClient(SNIClient):
             item_uuid: item,
         })
 
-    async def game_watcher(self, ctx: "SNIContext") -> None:
+    async def game_watcher(self, ctx) -> None:
         try:
             from SNIClient import snes_buffered_write, snes_flush_writes, snes_read
             rom = await snes_read(ctx, KDL3_ROMNAME, 0x15)
@@ -280,12 +278,11 @@ class KDL3SNIClient(SNIClient):
                 await initialize_giftboxes(ctx, self.giftbox_key, self.motherbox_key, bool(enable_gifting[0]))
                 self.initialize_gifting = True
             # can't check debug anymore, without going and copying the value. might be important later.
-            if not self.levels:
+            if self.levels is None:
                 self.levels = dict()
                 for i in range(5):
                     level_data = await snes_read(ctx, KDL3_LEVEL_ADDR + (14 * i), 14)
-                    self.levels[i] = [int.from_bytes(level_data[idx:idx+1], "little")
-                                      for idx in range(0, len(level_data), 2)]
+                    self.levels[i] = unpack("HHHHHHH", level_data)
                 self.levels[5] = [0x0205,  # Hyper Zone
                                   0,  # MG-5, can't send from here
                                   0x0300,  # Boss Butch
@@ -374,7 +371,7 @@ class KDL3SNIClient(SNIClient):
             stages_raw = await snes_read(ctx, KDL3_COMPLETED_STAGES, 60)
             stages = struct.unpack("HHHHHHHHHHHHHHHHHHHHHHHHHHHHHH", stages_raw)
             for i in range(30):
-                loc_id = 0x770000 + i
+                loc_id = 0x770000 + i + 1
                 if stages[i] == 1 and loc_id not in ctx.checked_locations:
                     new_checks.append(loc_id)
                 elif loc_id in ctx.checked_locations:
@@ -384,8 +381,8 @@ class KDL3SNIClient(SNIClient):
             heart_stars = await snes_read(ctx, KDL3_HEART_STARS, 35)
             for i in range(5):
                 start_ind = i * 7
-                for j in range(6):
-                    level_ind = start_ind + j
+                for j in range(1, 7):
+                    level_ind = start_ind + j - 1
                     loc_id = 0x770100 + (6 * i) + j
                     if heart_stars[level_ind] and loc_id not in ctx.checked_locations:
                         new_checks.append(loc_id)
@@ -404,9 +401,6 @@ class KDL3SNIClient(SNIClient):
                     if star not in ctx.checked_locations and stars[star_addrs[star]] == 0x01:
                         new_checks.append(star)
 
-            if not game_state:
-                return
-
             if game_state[0] != 0xFF:
                 await self.pop_gift(ctx)
             await self.pop_item(ctx, game_state[0] != 0xFF)
@@ -414,7 +408,7 @@ class KDL3SNIClient(SNIClient):
 
             # boss status
             boss_flag_bytes = await snes_read(ctx, KDL3_BOSS_STATUS, 2)
-            boss_flag = int.from_bytes(boss_flag_bytes, "little")
+            boss_flag = unpack("H", boss_flag_bytes)[0]
             for bitmask, boss in zip(range(1, 11, 2), boss_locations.keys()):
                 if boss_flag & (1 << bitmask) > 0 and boss not in ctx.checked_locations:
                     new_checks.append(boss)

worlds/kdl3/Gifting.py

@@ -1,11 +1,8 @@
 # Small subfile to handle gifting info such as desired traits and giftbox management
 import typing
 
-if typing.TYPE_CHECKING:
-    from SNIClient import SNIContext
 
-
-async def update_object(ctx: "SNIContext", key: str, value: typing.Dict[str, typing.Any]) -> None:
+async def update_object(ctx, key: str, value: typing.Dict):
     await ctx.send_msgs([
         {
             "cmd": "Set",
@@ -19,7 +16,7 @@ async def update_object(ctx: "SNIContext", key: str, value: typing.Dict[str, typ
     ])
 
 
-async def pop_object(ctx: "SNIContext", key: str, value: str) -> None:
+async def pop_object(ctx, key: str, value: str):
     await ctx.send_msgs([
         {
             "cmd": "Set",
@@ -33,14 +30,14 @@ async def pop_object(ctx: "SNIContext", key: str, value: str) -> None:
     ])
 
 
-async def initialize_giftboxes(ctx: "SNIContext", giftbox_key: str, motherbox_key: str, is_open: bool) -> None:
+async def initialize_giftboxes(ctx, giftbox_key: str, motherbox_key: str, is_open: bool):
     ctx.set_notify(motherbox_key, giftbox_key)
     await update_object(ctx, f"Giftboxes;{ctx.team}", {f"{ctx.slot}":
-                                                       {
-                                                           "IsOpen": is_open,
-                                                           **kdl3_gifting_options
-                                                       }})
-    ctx.client_handler.gifting = is_open
+        {
+            "IsOpen": is_open,
+            **kdl3_gifting_options
+        }})
+    ctx.gifting = is_open
 
 
 kdl3_gifting_options = {

worlds/kdl3/Items.py

@@ -77,9 +77,9 @@ filler_item_weights = {
 }
 
 star_item_weights = {
-    "Little Star": 16,
-    "Medium Star": 8,
-    "Big Star": 4
+    "Little Star": 4,
+    "Medium Star": 2,
+    "Big Star": 1
 }
 
 total_filler_weights = {
@@ -102,4 +102,4 @@ item_names = {
     "Animal Friend": set(animal_friend_table),
 }
 
-lookup_item_to_id: typing.Dict[str, int] = {item_name: data.code for item_name, data in item_table.items() if data.code}
+lookup_name_to_id: typing.Dict[str, int] = {item_name: data.code for item_name, data in item_table.items() if data.code}

worlds/kdl3/Locations.py

@@ -0,0 +1,940 @@
+import typing
+from BaseClasses import Location, Region
+from .Names import LocationName
+
+if typing.TYPE_CHECKING:
+    from .Room import KDL3Room
+
+
+class KDL3Location(Location):
+    game: str = "Kirby's Dream Land 3"
+    room: typing.Optional["KDL3Room"] = None
+
+    def __init__(self, player: int, name: str, address: typing.Optional[int], parent: typing.Union[Region, None]):
+        super().__init__(player, name, address, parent)
+        if not address:
+            self.show_in_spoiler = False
+
+
+stage_locations = {
+    0x770001: LocationName.grass_land_1,
+    0x770002: LocationName.grass_land_2,
+    0x770003: LocationName.grass_land_3,
+    0x770004: LocationName.grass_land_4,
+    0x770005: LocationName.grass_land_5,
+    0x770006: LocationName.grass_land_6,
+    0x770007: LocationName.ripple_field_1,
+    0x770008: LocationName.ripple_field_2,
+    0x770009: LocationName.ripple_field_3,
+    0x77000A: LocationName.ripple_field_4,
+    0x77000B: LocationName.ripple_field_5,
+    0x77000C: LocationName.ripple_field_6,
+    0x77000D: LocationName.sand_canyon_1,
+    0x77000E: LocationName.sand_canyon_2,
+    0x77000F: LocationName.sand_canyon_3,
+    0x770010: LocationName.sand_canyon_4,
+    0x770011: LocationName.sand_canyon_5,
+    0x770012: LocationName.sand_canyon_6,
+    0x770013: LocationName.cloudy_park_1,
+    0x770014: LocationName.cloudy_park_2,
+    0x770015: LocationName.cloudy_park_3,
+    0x770016: LocationName.cloudy_park_4,
+    0x770017: LocationName.cloudy_park_5,
+    0x770018: LocationName.cloudy_park_6,
+    0x770019: LocationName.iceberg_1,
+    0x77001A: LocationName.iceberg_2,
+    0x77001B: LocationName.iceberg_3,
+    0x77001C: LocationName.iceberg_4,
+    0x77001D: LocationName.iceberg_5,
+    0x77001E: LocationName.iceberg_6,
+}
+
+heart_star_locations = {
+    0x770101: LocationName.grass_land_tulip,
+    0x770102: LocationName.grass_land_muchi,
+    0x770103: LocationName.grass_land_pitcherman,
+    0x770104: LocationName.grass_land_chao,
+    0x770105: LocationName.grass_land_mine,
+    0x770106: LocationName.grass_land_pierre,
+    0x770107: LocationName.ripple_field_kamuribana,
+    0x770108: LocationName.ripple_field_bakasa,
+    0x770109: LocationName.ripple_field_elieel,
+    0x77010A: LocationName.ripple_field_toad,
+    0x77010B: LocationName.ripple_field_mama_pitch,
+    0x77010C: LocationName.ripple_field_hb002,
+    0x77010D: LocationName.sand_canyon_mushrooms,
+    0x77010E: LocationName.sand_canyon_auntie,
+    0x77010F: LocationName.sand_canyon_caramello,
+    0x770110: LocationName.sand_canyon_hikari,
+    0x770111: LocationName.sand_canyon_nyupun,
+    0x770112: LocationName.sand_canyon_rob,
+    0x770113: LocationName.cloudy_park_hibanamodoki,
+    0x770114: LocationName.cloudy_park_piyokeko,
+    0x770115: LocationName.cloudy_park_mrball,
+    0x770116: LocationName.cloudy_park_mikarin,
+    0x770117: LocationName.cloudy_park_pick,
+    0x770118: LocationName.cloudy_park_hb007,
+    0x770119: LocationName.iceberg_kogoesou,
+    0x77011A: LocationName.iceberg_samus,
+    0x77011B: LocationName.iceberg_kawasaki,
+    0x77011C: LocationName.iceberg_name,
+    0x77011D: LocationName.iceberg_shiro,
+    0x77011E: LocationName.iceberg_angel,
+}
+
+boss_locations = {
+    0x770200: LocationName.grass_land_whispy,
+    0x770201: LocationName.ripple_field_acro,
+    0x770202: LocationName.sand_canyon_poncon,
+    0x770203: LocationName.cloudy_park_ado,
+    0x770204: LocationName.iceberg_dedede,
+}
+
+consumable_locations = {
+    0x770300: LocationName.grass_land_1_u1,
+    0x770301: LocationName.grass_land_1_m1,
+    0x770302: LocationName.grass_land_2_u1,
+    0x770303: LocationName.grass_land_3_u1,
+    0x770304: LocationName.grass_land_3_m1,
+    0x770305: LocationName.grass_land_4_m1,
+    0x770306: LocationName.grass_land_4_u1,
+    0x770307: LocationName.grass_land_4_m2,
+    0x770308: LocationName.grass_land_4_m3,
+    0x770309: LocationName.grass_land_6_u1,
+    0x77030A: LocationName.grass_land_6_u2,
+    0x77030B: LocationName.ripple_field_2_u1,
+    0x77030C: LocationName.ripple_field_2_m1,
+    0x77030D: LocationName.ripple_field_3_m1,
+    0x77030E: LocationName.ripple_field_3_u1,
+    0x77030F: LocationName.ripple_field_4_m2,
+    0x770310: LocationName.ripple_field_4_u1,
+    0x770311: LocationName.ripple_field_4_m1,
+    0x770312: LocationName.ripple_field_5_u1,
+    0x770313: LocationName.ripple_field_5_m2,
+    0x770314: LocationName.ripple_field_5_m1,
+    0x770315: LocationName.sand_canyon_1_u1,
+    0x770316: LocationName.sand_canyon_2_u1,
+    0x770317: LocationName.sand_canyon_2_m1,
+    0x770318: LocationName.sand_canyon_4_m1,
+    0x770319: LocationName.sand_canyon_4_u1,
+    0x77031A: LocationName.sand_canyon_4_m2,
+    0x77031B: LocationName.sand_canyon_5_u1,
+    0x77031C: LocationName.sand_canyon_5_u3,
+    0x77031D: LocationName.sand_canyon_5_m1,
+    0x77031E: LocationName.sand_canyon_5_u4,
+    0x77031F: LocationName.sand_canyon_5_u2,
+    0x770320: LocationName.cloudy_park_1_m1,
+    0x770321: LocationName.cloudy_park_1_u1,
+    0x770322: LocationName.cloudy_park_4_u1,
+    0x770323: LocationName.cloudy_park_4_m1,
+    0x770324: LocationName.cloudy_park_5_m1,
+    0x770325: LocationName.cloudy_park_6_u1,
+    0x770326: LocationName.iceberg_3_m1,
+    0x770327: LocationName.iceberg_5_u1,
+    0x770328: LocationName.iceberg_5_u2,
+    0x770329: LocationName.iceberg_5_u3,
+    0x77032A: LocationName.iceberg_6_m1,
+    0x77032B: LocationName.iceberg_6_u1,
+}
+
+level_consumables = {
+    1: [0, 1],
+    2: [2],
+    3: [3, 4],
+    4: [5, 6, 7, 8],
+    6: [9, 10],
+    8: [11, 12],
+    9: [13, 14],
+    10: [15, 16, 17],
+    11: [18, 19, 20],
+    13: [21],
+    14: [22, 23],
+    16: [24, 25, 26],
+    17: [27, 28, 29, 30, 31],
+    19: [32, 33],
+    22: [34, 35],
+    23: [36],
+    24: [37],
+    27: [38],
+    29: [39, 40, 41],
+    30: [42, 43],
+}
+
+star_locations = {
+    0x770401: LocationName.grass_land_1_s1,
+    0x770402: LocationName.grass_land_1_s2,
+    0x770403: LocationName.grass_land_1_s3,
+    0x770404: LocationName.grass_land_1_s4,
+    0x770405: LocationName.grass_land_1_s5,
+    0x770406: LocationName.grass_land_1_s6,
+    0x770407: LocationName.grass_land_1_s7,
+    0x770408: LocationName.grass_land_1_s8,
+    0x770409: LocationName.grass_land_1_s9,
+    0x77040a: LocationName.grass_land_1_s10,
+    0x77040b: LocationName.grass_land_1_s11,
+    0x77040c: LocationName.grass_land_1_s12,
+    0x77040d: LocationName.grass_land_1_s13,
+    0x77040e: LocationName.grass_land_1_s14,
+    0x77040f: LocationName.grass_land_1_s15,
+    0x770410: LocationName.grass_land_1_s16,
+    0x770411: LocationName.grass_land_1_s17,
+    0x770412: LocationName.grass_land_1_s18,
+    0x770413: LocationName.grass_land_1_s19,
+    0x770414: LocationName.grass_land_1_s20,
+    0x770415: LocationName.grass_land_1_s21,
+    0x770416: LocationName.grass_land_1_s22,
+    0x770417: LocationName.grass_land_1_s23,
+    0x770418: LocationName.grass_land_2_s1,
+    0x770419: LocationName.grass_land_2_s2,
+    0x77041a: LocationName.grass_land_2_s3,
+    0x77041b: LocationName.grass_land_2_s4,
+    0x77041c: LocationName.grass_land_2_s5,
+    0x77041d: LocationName.grass_land_2_s6,
+    0x77041e: LocationName.grass_land_2_s7,
+    0x77041f: LocationName.grass_land_2_s8,
+    0x770420: LocationName.grass_land_2_s9,
+    0x770421: LocationName.grass_land_2_s10,
+    0x770422: LocationName.grass_land_2_s11,
+    0x770423: LocationName.grass_land_2_s12,
+    0x770424: LocationName.grass_land_2_s13,
+    0x770425: LocationName.grass_land_2_s14,
+    0x770426: LocationName.grass_land_2_s15,
+    0x770427: LocationName.grass_land_2_s16,
+    0x770428: LocationName.grass_land_2_s17,
+    0x770429: LocationName.grass_land_2_s18,
+    0x77042a: LocationName.grass_land_2_s19,
+    0x77042b: LocationName.grass_land_2_s20,
+    0x77042c: LocationName.grass_land_2_s21,
+    0x77042d: LocationName.grass_land_3_s1,
+    0x77042e: LocationName.grass_land_3_s2,
+    0x77042f: LocationName.grass_land_3_s3,
+    0x770430: LocationName.grass_land_3_s4,
+    0x770431: LocationName.grass_land_3_s5,
+    0x770432: LocationName.grass_land_3_s6,
+    0x770433: LocationName.grass_land_3_s7,
+    0x770434: LocationName.grass_land_3_s8,
+    0x770435: LocationName.grass_land_3_s9,
+    0x770436: LocationName.grass_land_3_s10,
+    0x770437: LocationName.grass_land_3_s11,
+    0x770438: LocationName.grass_land_3_s12,
+    0x770439: LocationName.grass_land_3_s13,
+    0x77043a: LocationName.grass_land_3_s14,
+    0x77043b: LocationName.grass_land_3_s15,
+    0x77043c: LocationName.grass_land_3_s16,
+    0x77043d: LocationName.grass_land_3_s17,
+    0x77043e: LocationName.grass_land_3_s18,
+    0x77043f: LocationName.grass_land_3_s19,
+    0x770440: LocationName.grass_land_3_s20,
+    0x770441: LocationName.grass_land_3_s21,
+    0x770442: LocationName.grass_land_3_s22,
+    0x770443: LocationName.grass_land_3_s23,
+    0x770444: LocationName.grass_land_3_s24,
+    0x770445: LocationName.grass_land_3_s25,
+    0x770446: LocationName.grass_land_3_s26,
+    0x770447: LocationName.grass_land_3_s27,
+    0x770448: LocationName.grass_land_3_s28,
+    0x770449: LocationName.grass_land_3_s29,
+    0x77044a: LocationName.grass_land_3_s30,
+    0x77044b: LocationName.grass_land_3_s31,
+    0x77044c: LocationName.grass_land_4_s1,
+    0x77044d: LocationName.grass_land_4_s2,
+    0x77044e: LocationName.grass_land_4_s3,
+    0x77044f: LocationName.grass_land_4_s4,
+    0x770450: LocationName.grass_land_4_s5,
+    0x770451: LocationName.grass_land_4_s6,
+    0x770452: LocationName.grass_land_4_s7,
+    0x770453: LocationName.grass_land_4_s8,
+    0x770454: LocationName.grass_land_4_s9,
+    0x770455: LocationName.grass_land_4_s10,
+    0x770456: LocationName.grass_land_4_s11,
+    0x770457: LocationName.grass_land_4_s12,
+    0x770458: LocationName.grass_land_4_s13,
+    0x770459: LocationName.grass_land_4_s14,
+    0x77045a: LocationName.grass_land_4_s15,
+    0x77045b: LocationName.grass_land_4_s16,
+    0x77045c: LocationName.grass_land_4_s17,
+    0x77045d: LocationName.grass_land_4_s18,
+    0x77045e: LocationName.grass_land_4_s19,
+    0x77045f: LocationName.grass_land_4_s20,
+    0x770460: LocationName.grass_land_4_s21,
+    0x770461: LocationName.grass_land_4_s22,
+    0x770462: LocationName.grass_land_4_s23,
+    0x770463: LocationName.grass_land_4_s24,
+    0x770464: LocationName.grass_land_4_s25,
+    0x770465: LocationName.grass_land_4_s26,
+    0x770466: LocationName.grass_land_4_s27,
+    0x770467: LocationName.grass_land_4_s28,
+    0x770468: LocationName.grass_land_4_s29,
+    0x770469: LocationName.grass_land_4_s30,
+    0x77046a: LocationName.grass_land_4_s31,
+    0x77046b: LocationName.grass_land_4_s32,
+    0x77046c: LocationName.grass_land_4_s33,
+    0x77046d: LocationName.grass_land_4_s34,
+    0x77046e: LocationName.grass_land_4_s35,
+    0x77046f: LocationName.grass_land_4_s36,
+    0x770470: LocationName.grass_land_4_s37,
+    0x770471: LocationName.grass_land_5_s1,
+    0x770472: LocationName.grass_land_5_s2,
+    0x770473: LocationName.grass_land_5_s3,
+    0x770474: LocationName.grass_land_5_s4,
+    0x770475: LocationName.grass_land_5_s5,
+    0x770476: LocationName.grass_land_5_s6,
+    0x770477: LocationName.grass_land_5_s7,
+    0x770478: LocationName.grass_land_5_s8,
+    0x770479: LocationName.grass_land_5_s9,
+    0x77047a: LocationName.grass_land_5_s10,
+    0x77047b: LocationName.grass_land_5_s11,
+    0x77047c: LocationName.grass_land_5_s12,
+    0x77047d: LocationName.grass_land_5_s13,
+    0x77047e: LocationName.grass_land_5_s14,
+    0x77047f: LocationName.grass_land_5_s15,
+    0x770480: LocationName.grass_land_5_s16,
+    0x770481: LocationName.grass_land_5_s17,
+    0x770482: LocationName.grass_land_5_s18,
+    0x770483: LocationName.grass_land_5_s19,
+    0x770484: LocationName.grass_land_5_s20,
+    0x770485: LocationName.grass_land_5_s21,
+    0x770486: LocationName.grass_land_5_s22,
+    0x770487: LocationName.grass_land_5_s23,
+    0x770488: LocationName.grass_land_5_s24,
+    0x770489: LocationName.grass_land_5_s25,
+    0x77048a: LocationName.grass_land_5_s26,
+    0x77048b: LocationName.grass_land_5_s27,
+    0x77048c: LocationName.grass_land_5_s28,
+    0x77048d: LocationName.grass_land_5_s29,
+    0x77048e: LocationName.grass_land_6_s1,
+    0x77048f: LocationName.grass_land_6_s2,
+    0x770490: LocationName.grass_land_6_s3,
+    0x770491: LocationName.grass_land_6_s4,
+    0x770492: LocationName.grass_land_6_s5,
+    0x770493: LocationName.grass_land_6_s6,
+    0x770494: LocationName.grass_land_6_s7,
+    0x770495: LocationName.grass_land_6_s8,
+    0x770496: LocationName.grass_land_6_s9,
+    0x770497: LocationName.grass_land_6_s10,
+    0x770498: LocationName.grass_land_6_s11,
+    0x770499: LocationName.grass_land_6_s12,
+    0x77049a: LocationName.grass_land_6_s13,
+    0x77049b: LocationName.grass_land_6_s14,
+    0x77049c: LocationName.grass_land_6_s15,
+    0x77049d: LocationName.grass_land_6_s16,
+    0x77049e: LocationName.grass_land_6_s17,
+    0x77049f: LocationName.grass_land_6_s18,
+    0x7704a0: LocationName.grass_land_6_s19,
+    0x7704a1: LocationName.grass_land_6_s20,
+    0x7704a2: LocationName.grass_land_6_s21,
+    0x7704a3: LocationName.grass_land_6_s22,
+    0x7704a4: LocationName.grass_land_6_s23,
+    0x7704a5: LocationName.grass_land_6_s24,
+    0x7704a6: LocationName.grass_land_6_s25,
+    0x7704a7: LocationName.grass_land_6_s26,
+    0x7704a8: LocationName.grass_land_6_s27,
+    0x7704a9: LocationName.grass_land_6_s28,
+    0x7704aa: LocationName.grass_land_6_s29,
+    0x7704ab: LocationName.ripple_field_1_s1,
+    0x7704ac: LocationName.ripple_field_1_s2,
+    0x7704ad: LocationName.ripple_field_1_s3,
+    0x7704ae: LocationName.ripple_field_1_s4,
+    0x7704af: LocationName.ripple_field_1_s5,
+    0x7704b0: LocationName.ripple_field_1_s6,
+    0x7704b1: LocationName.ripple_field_1_s7,
+    0x7704b2: LocationName.ripple_field_1_s8,
+    0x7704b3: LocationName.ripple_field_1_s9,
+    0x7704b4: LocationName.ripple_field_1_s10,
+    0x7704b5: LocationName.ripple_field_1_s11,
+    0x7704b6: LocationName.ripple_field_1_s12,
+    0x7704b7: LocationName.ripple_field_1_s13,
+    0x7704b8: LocationName.ripple_field_1_s14,
+    0x7704b9: LocationName.ripple_field_1_s15,
+    0x7704ba: LocationName.ripple_field_1_s16,
+    0x7704bb: LocationName.ripple_field_1_s17,
+    0x7704bc: LocationName.ripple_field_1_s18,
+    0x7704bd: LocationName.ripple_field_1_s19,
+    0x7704be: LocationName.ripple_field_2_s1,
+    0x7704bf: LocationName.ripple_field_2_s2,
+    0x7704c0: LocationName.ripple_field_2_s3,
+    0x7704c1: LocationName.ripple_field_2_s4,
+    0x7704c2: LocationName.ripple_field_2_s5,
+    0x7704c3: LocationName.ripple_field_2_s6,
+    0x7704c4: LocationName.ripple_field_2_s7,
+    0x7704c5: LocationName.ripple_field_2_s8,
+    0x7704c6: LocationName.ripple_field_2_s9,
+    0x7704c7: LocationName.ripple_field_2_s10,
+    0x7704c8: LocationName.ripple_field_2_s11,
+    0x7704c9: LocationName.ripple_field_2_s12,
+    0x7704ca: LocationName.ripple_field_2_s13,
+    0x7704cb: LocationName.ripple_field_2_s14,
+    0x7704cc: LocationName.ripple_field_2_s15,
+    0x7704cd: LocationName.ripple_field_2_s16,
+    0x7704ce: LocationName.ripple_field_2_s17,
+    0x7704cf: LocationName.ripple_field_3_s1,
+    0x7704d0: LocationName.ripple_field_3_s2,
+    0x7704d1: LocationName.ripple_field_3_s3,
+    0x7704d2: LocationName.ripple_field_3_s4,
+    0x7704d3: LocationName.ripple_field_3_s5,
+    0x7704d4: LocationName.ripple_field_3_s6,
+    0x7704d5: LocationName.ripple_field_3_s7,
+    0x7704d6: LocationName.ripple_field_3_s8,
+    0x7704d7: LocationName.ripple_field_3_s9,
+    0x7704d8: LocationName.ripple_field_3_s10,
+    0x7704d9: LocationName.ripple_field_3_s11,
+    0x7704da: LocationName.ripple_field_3_s12,
+    0x7704db: LocationName.ripple_field_3_s13,
+    0x7704dc: LocationName.ripple_field_3_s14,
+    0x7704dd: LocationName.ripple_field_3_s15,
+    0x7704de: LocationName.ripple_field_3_s16,
+    0x7704df: LocationName.ripple_field_3_s17,
+    0x7704e0: LocationName.ripple_field_3_s18,
+    0x7704e1: LocationName.ripple_field_3_s19,
+    0x7704e2: LocationName.ripple_field_3_s20,
+    0x7704e3: LocationName.ripple_field_3_s21,
+    0x7704e4: LocationName.ripple_field_4_s1,
+    0x7704e5: LocationName.ripple_field_4_s2,
+    0x7704e6: LocationName.ripple_field_4_s3,
+    0x7704e7: LocationName.ripple_field_4_s4,
+    0x7704e8: LocationName.ripple_field_4_s5,
+    0x7704e9: LocationName.ripple_field_4_s6,
+    0x7704ea: LocationName.ripple_field_4_s7,
+    0x7704eb: LocationName.ripple_field_4_s8,
+    0x7704ec: LocationName.ripple_field_4_s9,
+    0x7704ed: LocationName.ripple_field_4_s10,
+    0x7704ee: LocationName.ripple_field_4_s11,
+    0x7704ef: LocationName.ripple_field_4_s12,
+    0x7704f0: LocationName.ripple_field_4_s13,
+    0x7704f1: LocationName.ripple_field_4_s14,
+    0x7704f2: LocationName.ripple_field_4_s15,
+    0x7704f3: LocationName.ripple_field_4_s16,
+    0x7704f4: LocationName.ripple_field_4_s17,
+    0x7704f5: LocationName.ripple_field_4_s18,
+    0x7704f6: LocationName.ripple_field_4_s19,
+    0x7704f7: LocationName.ripple_field_4_s20,
+    0x7704f8: LocationName.ripple_field_4_s21,
+    0x7704f9: LocationName.ripple_field_4_s22,
+    0x7704fa: LocationName.ripple_field_4_s23,
+    0x7704fb: LocationName.ripple_field_4_s24,
+    0x7704fc: LocationName.ripple_field_4_s25,
+    0x7704fd: LocationName.ripple_field_4_s26,
+    0x7704fe: LocationName.ripple_field_4_s27,
+    0x7704ff: LocationName.ripple_field_4_s28,
+    0x770500: LocationName.ripple_field_4_s29,
+    0x770501: LocationName.ripple_field_4_s30,
+    0x770502: LocationName.ripple_field_4_s31,
+    0x770503: LocationName.ripple_field_4_s32,
+    0x770504: LocationName.ripple_field_4_s33,
+    0x770505: LocationName.ripple_field_4_s34,
+    0x770506: LocationName.ripple_field_4_s35,
+    0x770507: LocationName.ripple_field_4_s36,
+    0x770508: LocationName.ripple_field_4_s37,
+    0x770509: LocationName.ripple_field_4_s38,
+    0x77050a: LocationName.ripple_field_4_s39,
+    0x77050b: LocationName.ripple_field_4_s40,
+    0x77050c: LocationName.ripple_field_4_s41,
+    0x77050d: LocationName.ripple_field_4_s42,
+    0x77050e: LocationName.ripple_field_4_s43,
+    0x77050f: LocationName.ripple_field_4_s44,
+    0x770510: LocationName.ripple_field_4_s45,
+    0x770511: LocationName.ripple_field_4_s46,
+    0x770512: LocationName.ripple_field_4_s47,
+    0x770513: LocationName.ripple_field_4_s48,
+    0x770514: LocationName.ripple_field_4_s49,
+    0x770515: LocationName.ripple_field_4_s50,
+    0x770516: LocationName.ripple_field_4_s51,
+    0x770517: LocationName.ripple_field_5_s1,
+    0x770518: LocationName.ripple_field_5_s2,
+    0x770519: LocationName.ripple_field_5_s3,
+    0x77051a: LocationName.ripple_field_5_s4,
+    0x77051b: LocationName.ripple_field_5_s5,
+    0x77051c: LocationName.ripple_field_5_s6,
+    0x77051d: LocationName.ripple_field_5_s7,
+    0x77051e: LocationName.ripple_field_5_s8,
+    0x77051f: LocationName.ripple_field_5_s9,
+    0x770520: LocationName.ripple_field_5_s10,
+    0x770521: LocationName.ripple_field_5_s11,
+    0x770522: LocationName.ripple_field_5_s12,
+    0x770523: LocationName.ripple_field_5_s13,
+    0x770524: LocationName.ripple_field_5_s14,
+    0x770525: LocationName.ripple_field_5_s15,
+    0x770526: LocationName.ripple_field_5_s16,
+    0x770527: LocationName.ripple_field_5_s17,
+    0x770528: LocationName.ripple_field_5_s18,
+    0x770529: LocationName.ripple_field_5_s19,
+    0x77052a: LocationName.ripple_field_5_s20,
+    0x77052b: LocationName.ripple_field_5_s21,
+    0x77052c: LocationName.ripple_field_5_s22,
+    0x77052d: LocationName.ripple_field_5_s23,
+    0x77052e: LocationName.ripple_field_5_s24,
+    0x77052f: LocationName.ripple_field_5_s25,
+    0x770530: LocationName.ripple_field_5_s26,
+    0x770531: LocationName.ripple_field_5_s27,
+    0x770532: LocationName.ripple_field_5_s28,
+    0x770533: LocationName.ripple_field_5_s29,
+    0x770534: LocationName.ripple_field_5_s30,
+    0x770535: LocationName.ripple_field_5_s31,
+    0x770536: LocationName.ripple_field_5_s32,
+    0x770537: LocationName.ripple_field_5_s33,
+    0x770538: LocationName.ripple_field_5_s34,
+    0x770539: LocationName.ripple_field_5_s35,
+    0x77053a: LocationName.ripple_field_5_s36,
+    0x77053b: LocationName.ripple_field_5_s37,
+    0x77053c: LocationName.ripple_field_5_s38,
+    0x77053d: LocationName.ripple_field_5_s39,
+    0x77053e: LocationName.ripple_field_5_s40,
+    0x77053f: LocationName.ripple_field_5_s41,
+    0x770540: LocationName.ripple_field_5_s42,
+    0x770541: LocationName.ripple_field_5_s43,
+    0x770542: LocationName.ripple_field_5_s44,
+    0x770543: LocationName.ripple_field_5_s45,
+    0x770544: LocationName.ripple_field_5_s46,
+    0x770545: LocationName.ripple_field_5_s47,
+    0x770546: LocationName.ripple_field_5_s48,
+    0x770547: LocationName.ripple_field_5_s49,
+    0x770548: LocationName.ripple_field_5_s50,
+    0x770549: LocationName.ripple_field_5_s51,
+    0x77054a: LocationName.ripple_field_6_s1,
+    0x77054b: LocationName.ripple_field_6_s2,
+    0x77054c: LocationName.ripple_field_6_s3,
+    0x77054d: LocationName.ripple_field_6_s4,
+    0x77054e: LocationName.ripple_field_6_s5,
+    0x77054f: LocationName.ripple_field_6_s6,
+    0x770550: LocationName.ripple_field_6_s7,
+    0x770551: LocationName.ripple_field_6_s8,
+    0x770552: LocationName.ripple_field_6_s9,
+    0x770553: LocationName.ripple_field_6_s10,
+    0x770554: LocationName.ripple_field_6_s11,
+    0x770555: LocationName.ripple_field_6_s12,
+    0x770556: LocationName.ripple_field_6_s13,
+    0x770557: LocationName.ripple_field_6_s14,
+    0x770558: LocationName.ripple_field_6_s15,
+    0x770559: LocationName.ripple_field_6_s16,
+    0x77055a: LocationName.ripple_field_6_s17,
+    0x77055b: LocationName.ripple_field_6_s18,
+    0x77055c: LocationName.ripple_field_6_s19,
+    0x77055d: LocationName.ripple_field_6_s20,
+    0x77055e: LocationName.ripple_field_6_s21,
+    0x77055f: LocationName.ripple_field_6_s22,
+    0x770560: LocationName.ripple_field_6_s23,
+    0x770561: LocationName.sand_canyon_1_s1,
+    0x770562: LocationName.sand_canyon_1_s2,
+    0x770563: LocationName.sand_canyon_1_s3,
+    0x770564: LocationName.sand_canyon_1_s4,
+    0x770565: LocationName.sand_canyon_1_s5,
+    0x770566: LocationName.sand_canyon_1_s6,
+    0x770567: LocationName.sand_canyon_1_s7,
+    0x770568: LocationName.sand_canyon_1_s8,
+    0x770569: LocationName.sand_canyon_1_s9,
+    0x77056a: LocationName.sand_canyon_1_s10,
+    0x77056b: LocationName.sand_canyon_1_s11,
+    0x77056c: LocationName.sand_canyon_1_s12,
+    0x77056d: LocationName.sand_canyon_1_s13,
+    0x77056e: LocationName.sand_canyon_1_s14,
+    0x77056f: LocationName.sand_canyon_1_s15,
+    0x770570: LocationName.sand_canyon_1_s16,
+    0x770571: LocationName.sand_canyon_1_s17,
+    0x770572: LocationName.sand_canyon_1_s18,
+    0x770573: LocationName.sand_canyon_1_s19,
+    0x770574: LocationName.sand_canyon_1_s20,
+    0x770575: LocationName.sand_canyon_1_s21,
+    0x770576: LocationName.sand_canyon_1_s22,
+    0x770577: LocationName.sand_canyon_2_s1,
+    0x770578: LocationName.sand_canyon_2_s2,
+    0x770579: LocationName.sand_canyon_2_s3,
+    0x77057a: LocationName.sand_canyon_2_s4,
+    0x77057b: LocationName.sand_canyon_2_s5,
+    0x77057c: LocationName.sand_canyon_2_s6,
+    0x77057d: LocationName.sand_canyon_2_s7,
+    0x77057e: LocationName.sand_canyon_2_s8,
+    0x77057f: LocationName.sand_canyon_2_s9,
+    0x770580: LocationName.sand_canyon_2_s10,
+    0x770581: LocationName.sand_canyon_2_s11,
+    0x770582: LocationName.sand_canyon_2_s12,
+    0x770583: LocationName.sand_canyon_2_s13,
+    0x770584: LocationName.sand_canyon_2_s14,
+    0x770585: LocationName.sand_canyon_2_s15,
+    0x770586: LocationName.sand_canyon_2_s16,
+    0x770587: LocationName.sand_canyon_2_s17,
+    0x770588: LocationName.sand_canyon_2_s18,
+    0x770589: LocationName.sand_canyon_2_s19,
+    0x77058a: LocationName.sand_canyon_2_s20,
+    0x77058b: LocationName.sand_canyon_2_s21,
+    0x77058c: LocationName.sand_canyon_2_s22,
+    0x77058d: LocationName.sand_canyon_2_s23,
+    0x77058e: LocationName.sand_canyon_2_s24,
+    0x77058f: LocationName.sand_canyon_2_s25,
+    0x770590: LocationName.sand_canyon_2_s26,
+    0x770591: LocationName.sand_canyon_2_s27,
+    0x770592: LocationName.sand_canyon_2_s28,
+    0x770593: LocationName.sand_canyon_2_s29,
+    0x770594: LocationName.sand_canyon_2_s30,
+    0x770595: LocationName.sand_canyon_2_s31,
+    0x770596: LocationName.sand_canyon_2_s32,
+    0x770597: LocationName.sand_canyon_2_s33,
+    0x770598: LocationName.sand_canyon_2_s34,
+    0x770599: LocationName.sand_canyon_2_s35,
+    0x77059a: LocationName.sand_canyon_2_s36,
+    0x77059b: LocationName.sand_canyon_2_s37,
+    0x77059c: LocationName.sand_canyon_2_s38,
+    0x77059d: LocationName.sand_canyon_2_s39,
+    0x77059e: LocationName.sand_canyon_2_s40,
+    0x77059f: LocationName.sand_canyon_2_s41,
+    0x7705a0: LocationName.sand_canyon_2_s42,
+    0x7705a1: LocationName.sand_canyon_2_s43,
+    0x7705a2: LocationName.sand_canyon_2_s44,
+    0x7705a3: LocationName.sand_canyon_2_s45,
+    0x7705a4: LocationName.sand_canyon_2_s46,
+    0x7705a5: LocationName.sand_canyon_2_s47,
+    0x7705a6: LocationName.sand_canyon_2_s48,
+    0x7705a7: LocationName.sand_canyon_3_s1,
+    0x7705a8: LocationName.sand_canyon_3_s2,
+    0x7705a9: LocationName.sand_canyon_3_s3,
+    0x7705aa: LocationName.sand_canyon_3_s4,
+    0x7705ab: LocationName.sand_canyon_3_s5,
+    0x7705ac: LocationName.sand_canyon_3_s6,
+    0x7705ad: LocationName.sand_canyon_3_s7,
+    0x7705ae: LocationName.sand_canyon_3_s8,
+    0x7705af: LocationName.sand_canyon_3_s9,
+    0x7705b0: LocationName.sand_canyon_3_s10,
+    0x7705b1: LocationName.sand_canyon_4_s1,
+    0x7705b2: LocationName.sand_canyon_4_s2,
+    0x7705b3: LocationName.sand_canyon_4_s3,
+    0x7705b4: LocationName.sand_canyon_4_s4,
+    0x7705b5: LocationName.sand_canyon_4_s5,
+    0x7705b6: LocationName.sand_canyon_4_s6,
+    0x7705b7: LocationName.sand_canyon_4_s7,
+    0x7705b8: LocationName.sand_canyon_4_s8,
+    0x7705b9: LocationName.sand_canyon_4_s9,
+    0x7705ba: LocationName.sand_canyon_4_s10,
+    0x7705bb: LocationName.sand_canyon_4_s11,
+    0x7705bc: LocationName.sand_canyon_4_s12,
+    0x7705bd: LocationName.sand_canyon_4_s13,
+    0x7705be: LocationName.sand_canyon_4_s14,
+    0x7705bf: LocationName.sand_canyon_4_s15,
+    0x7705c0: LocationName.sand_canyon_4_s16,
+    0x7705c1: LocationName.sand_canyon_4_s17,
+    0x7705c2: LocationName.sand_canyon_4_s18,
+    0x7705c3: LocationName.sand_canyon_4_s19,
+    0x7705c4: LocationName.sand_canyon_4_s20,
+    0x7705c5: LocationName.sand_canyon_4_s21,
+    0x7705c6: LocationName.sand_canyon_4_s22,
+    0x7705c7: LocationName.sand_canyon_4_s23,
+    0x7705c8: LocationName.sand_canyon_5_s1,
+    0x7705c9: LocationName.sand_canyon_5_s2,
+    0x7705ca: LocationName.sand_canyon_5_s3,
+    0x7705cb: LocationName.sand_canyon_5_s4,
+    0x7705cc: LocationName.sand_canyon_5_s5,
+    0x7705cd: LocationName.sand_canyon_5_s6,
+    0x7705ce: LocationName.sand_canyon_5_s7,
+    0x7705cf: LocationName.sand_canyon_5_s8,
+    0x7705d0: LocationName.sand_canyon_5_s9,
+    0x7705d1: LocationName.sand_canyon_5_s10,
+    0x7705d2: LocationName.sand_canyon_5_s11,
+    0x7705d3: LocationName.sand_canyon_5_s12,
+    0x7705d4: LocationName.sand_canyon_5_s13,
+    0x7705d5: LocationName.sand_canyon_5_s14,
+    0x7705d6: LocationName.sand_canyon_5_s15,
+    0x7705d7: LocationName.sand_canyon_5_s16,
+    0x7705d8: LocationName.sand_canyon_5_s17,
+    0x7705d9: LocationName.sand_canyon_5_s18,
+    0x7705da: LocationName.sand_canyon_5_s19,
+    0x7705db: LocationName.sand_canyon_5_s20,
+    0x7705dc: LocationName.sand_canyon_5_s21,
+    0x7705dd: LocationName.sand_canyon_5_s22,
+    0x7705de: LocationName.sand_canyon_5_s23,
+    0x7705df: LocationName.sand_canyon_5_s24,
+    0x7705e0: LocationName.sand_canyon_5_s25,
+    0x7705e1: LocationName.sand_canyon_5_s26,
+    0x7705e2: LocationName.sand_canyon_5_s27,
+    0x7705e3: LocationName.sand_canyon_5_s28,
+    0x7705e4: LocationName.sand_canyon_5_s29,
+    0x7705e5: LocationName.sand_canyon_5_s30,
+    0x7705e6: LocationName.sand_canyon_5_s31,
+    0x7705e7: LocationName.sand_canyon_5_s32,
+    0x7705e8: LocationName.sand_canyon_5_s33,
+    0x7705e9: LocationName.sand_canyon_5_s34,
+    0x7705ea: LocationName.sand_canyon_5_s35,
+    0x7705eb: LocationName.sand_canyon_5_s36,
+    0x7705ec: LocationName.sand_canyon_5_s37,
+    0x7705ed: LocationName.sand_canyon_5_s38,
+    0x7705ee: LocationName.sand_canyon_5_s39,
+    0x7705ef: LocationName.sand_canyon_5_s40,
+    0x7705f0: LocationName.cloudy_park_1_s1,
+    0x7705f1: LocationName.cloudy_park_1_s2,
+    0x7705f2: LocationName.cloudy_park_1_s3,
+    0x7705f3: LocationName.cloudy_park_1_s4,
+    0x7705f4: LocationName.cloudy_park_1_s5,
+    0x7705f5: LocationName.cloudy_park_1_s6,
+    0x7705f6: LocationName.cloudy_park_1_s7,
+    0x7705f7: LocationName.cloudy_park_1_s8,
+    0x7705f8: LocationName.cloudy_park_1_s9,
+    0x7705f9: LocationName.cloudy_park_1_s10,
+    0x7705fa: LocationName.cloudy_park_1_s11,
+    0x7705fb: LocationName.cloudy_park_1_s12,
+    0x7705fc: LocationName.cloudy_park_1_s13,
+    0x7705fd: LocationName.cloudy_park_1_s14,
+    0x7705fe: LocationName.cloudy_park_1_s15,
+    0x7705ff: LocationName.cloudy_park_1_s16,
+    0x770600: LocationName.cloudy_park_1_s17,
+    0x770601: LocationName.cloudy_park_1_s18,
+    0x770602: LocationName.cloudy_park_1_s19,
+    0x770603: LocationName.cloudy_park_1_s20,
+    0x770604: LocationName.cloudy_park_1_s21,
+    0x770605: LocationName.cloudy_park_1_s22,
+    0x770606: LocationName.cloudy_park_1_s23,
+    0x770607: LocationName.cloudy_park_2_s1,
+    0x770608: LocationName.cloudy_park_2_s2,
+    0x770609: LocationName.cloudy_park_2_s3,
+    0x77060a: LocationName.cloudy_park_2_s4,
+    0x77060b: LocationName.cloudy_park_2_s5,
+    0x77060c: LocationName.cloudy_park_2_s6,
+    0x77060d: LocationName.cloudy_park_2_s7,
+    0x77060e: LocationName.cloudy_park_2_s8,
+    0x77060f: LocationName.cloudy_park_2_s9,
+    0x770610: LocationName.cloudy_park_2_s10,
+    0x770611: LocationName.cloudy_park_2_s11,
+    0x770612: LocationName.cloudy_park_2_s12,
+    0x770613: LocationName.cloudy_park_2_s13,
+    0x770614: LocationName.cloudy_park_2_s14,
+    0x770615: LocationName.cloudy_park_2_s15,
+    0x770616: LocationName.cloudy_park_2_s16,
+    0x770617: LocationName.cloudy_park_2_s17,
+    0x770618: LocationName.cloudy_park_2_s18,
+    0x770619: LocationName.cloudy_park_2_s19,
+    0x77061a: LocationName.cloudy_park_2_s20,
+    0x77061b: LocationName.cloudy_park_2_s21,
+    0x77061c: LocationName.cloudy_park_2_s22,
+    0x77061d: LocationName.cloudy_park_2_s23,
+    0x77061e: LocationName.cloudy_park_2_s24,
+    0x77061f: LocationName.cloudy_park_2_s25,
+    0x770620: LocationName.cloudy_park_2_s26,
+    0x770621: LocationName.cloudy_park_2_s27,
+    0x770622: LocationName.cloudy_park_2_s28,
+    0x770623: LocationName.cloudy_park_2_s29,
+    0x770624: LocationName.cloudy_park_2_s30,
+    0x770625: LocationName.cloudy_park_2_s31,
+    0x770626: LocationName.cloudy_park_2_s32,
+    0x770627: LocationName.cloudy_park_2_s33,
+    0x770628: LocationName.cloudy_park_2_s34,
+    0x770629: LocationName.cloudy_park_2_s35,
+    0x77062a: LocationName.cloudy_park_2_s36,
+    0x77062b: LocationName.cloudy_park_2_s37,
+    0x77062c: LocationName.cloudy_park_2_s38,
+    0x77062d: LocationName.cloudy_park_2_s39,
+    0x77062e: LocationName.cloudy_park_2_s40,
+    0x77062f: LocationName.cloudy_park_2_s41,
+    0x770630: LocationName.cloudy_park_2_s42,
+    0x770631: LocationName.cloudy_park_2_s43,
+    0x770632: LocationName.cloudy_park_2_s44,
+    0x770633: LocationName.cloudy_park_2_s45,
+    0x770634: LocationName.cloudy_park_2_s46,
+    0x770635: LocationName.cloudy_park_2_s47,
+    0x770636: LocationName.cloudy_park_2_s48,
+    0x770637: LocationName.cloudy_park_2_s49,
+    0x770638: LocationName.cloudy_park_2_s50,
+    0x770639: LocationName.cloudy_park_2_s51,
+    0x77063a: LocationName.cloudy_park_2_s52,
+    0x77063b: LocationName.cloudy_park_2_s53,
+    0x77063c: LocationName.cloudy_park_2_s54,
+    0x77063d: LocationName.cloudy_park_3_s1,
+    0x77063e: LocationName.cloudy_park_3_s2,
+    0x77063f: LocationName.cloudy_park_3_s3,
+    0x770640: LocationName.cloudy_park_3_s4,
+    0x770641: LocationName.cloudy_park_3_s5,
+    0x770642: LocationName.cloudy_park_3_s6,
+    0x770643: LocationName.cloudy_park_3_s7,
+    0x770644: LocationName.cloudy_park_3_s8,
+    0x770645: LocationName.cloudy_park_3_s9,
+    0x770646: LocationName.cloudy_park_3_s10,
+    0x770647: LocationName.cloudy_park_3_s11,
+    0x770648: LocationName.cloudy_park_3_s12,
+    0x770649: LocationName.cloudy_park_3_s13,
+    0x77064a: LocationName.cloudy_park_3_s14,
+    0x77064b: LocationName.cloudy_park_3_s15,
+    0x77064c: LocationName.cloudy_park_3_s16,
+    0x77064d: LocationName.cloudy_park_3_s17,
+    0x77064e: LocationName.cloudy_park_3_s18,
+    0x77064f: LocationName.cloudy_park_3_s19,
+    0x770650: LocationName.cloudy_park_3_s20,
+    0x770651: LocationName.cloudy_park_3_s21,
+    0x770652: LocationName.cloudy_park_3_s22,
+    0x770653: LocationName.cloudy_park_4_s1,
+    0x770654: LocationName.cloudy_park_4_s2,
+    0x770655: LocationName.cloudy_park_4_s3,
+    0x770656: LocationName.cloudy_park_4_s4,
+    0x770657: LocationName.cloudy_park_4_s5,
+    0x770658: LocationName.cloudy_park_4_s6,
+    0x770659: LocationName.cloudy_park_4_s7,
+    0x77065a: LocationName.cloudy_park_4_s8,
+    0x77065b: LocationName.cloudy_park_4_s9,
+    0x77065c: LocationName.cloudy_park_4_s10,
+    0x77065d: LocationName.cloudy_park_4_s11,
+    0x77065e: LocationName.cloudy_park_4_s12,
+    0x77065f: LocationName.cloudy_park_4_s13,
+    0x770660: LocationName.cloudy_park_4_s14,
+    0x770661: LocationName.cloudy_park_4_s15,
+    0x770662: LocationName.cloudy_park_4_s16,
+    0x770663: LocationName.cloudy_park_4_s17,
+    0x770664: LocationName.cloudy_park_4_s18,
+    0x770665: LocationName.cloudy_park_4_s19,
+    0x770666: LocationName.cloudy_park_4_s20,
+    0x770667: LocationName.cloudy_park_4_s21,
+    0x770668: LocationName.cloudy_park_4_s22,
+    0x770669: LocationName.cloudy_park_4_s23,
+    0x77066a: LocationName.cloudy_park_4_s24,
+    0x77066b: LocationName.cloudy_park_4_s25,
+    0x77066c: LocationName.cloudy_park_4_s26,
+    0x77066d: LocationName.cloudy_park_4_s27,
+    0x77066e: LocationName.cloudy_park_4_s28,
+    0x77066f: LocationName.cloudy_park_4_s29,
+    0x770670: LocationName.cloudy_park_4_s30,
+    0x770671: LocationName.cloudy_park_4_s31,
+    0x770672: LocationName.cloudy_park_4_s32,
+    0x770673: LocationName.cloudy_park_4_s33,
+    0x770674: LocationName.cloudy_park_4_s34,
+    0x770675: LocationName.cloudy_park_4_s35,
+    0x770676: LocationName.cloudy_park_4_s36,
+    0x770677: LocationName.cloudy_park_4_s37,
+    0x770678: LocationName.cloudy_park_4_s38,
+    0x770679: LocationName.cloudy_park_4_s39,
+    0x77067a: LocationName.cloudy_park_4_s40,
+    0x77067b: LocationName.cloudy_park_4_s41,
+    0x77067c: LocationName.cloudy_park_4_s42,
+    0x77067d: LocationName.cloudy_park_4_s43,
+    0x77067e: LocationName.cloudy_park_4_s44,
+    0x77067f: LocationName.cloudy_park_4_s45,
+    0x770680: LocationName.cloudy_park_4_s46,
+    0x770681: LocationName.cloudy_park_4_s47,
+    0x770682: LocationName.cloudy_park_4_s48,
+    0x770683: LocationName.cloudy_park_4_s49,
+    0x770684: LocationName.cloudy_park_4_s50,
+    0x770685: LocationName.cloudy_park_5_s1,
+    0x770686: LocationName.cloudy_park_5_s2,
+    0x770687: LocationName.cloudy_park_5_s3,
+    0x770688: LocationName.cloudy_park_5_s4,
+    0x770689: LocationName.cloudy_park_5_s5,
+    0x77068a: LocationName.cloudy_park_5_s6,
+    0x77068b: LocationName.cloudy_park_6_s1,
+    0x77068c: LocationName.cloudy_park_6_s2,
+    0x77068d: LocationName.cloudy_park_6_s3,
+    0x77068e: LocationName.cloudy_park_6_s4,
+    0x77068f: LocationName.cloudy_park_6_s5,
+    0x770690: LocationName.cloudy_park_6_s6,
+    0x770691: LocationName.cloudy_park_6_s7,
+    0x770692: LocationName.cloudy_park_6_s8,
+    0x770693: LocationName.cloudy_park_6_s9,
+    0x770694: LocationName.cloudy_park_6_s10,
+    0x770695: LocationName.cloudy_park_6_s11,
+    0x770696: LocationName.cloudy_park_6_s12,
+    0x770697: LocationName.cloudy_park_6_s13,
+    0x770698: LocationName.cloudy_park_6_s14,
+    0x770699: LocationName.cloudy_park_6_s15,
+    0x77069a: LocationName.cloudy_park_6_s16,
+    0x77069b: LocationName.cloudy_park_6_s17,
+    0x77069c: LocationName.cloudy_park_6_s18,
+    0x77069d: LocationName.cloudy_park_6_s19,
+    0x77069e: LocationName.cloudy_park_6_s20,
+    0x77069f: LocationName.cloudy_park_6_s21,
+    0x7706a0: LocationName.cloudy_park_6_s22,
+    0x7706a1: LocationName.cloudy_park_6_s23,
+    0x7706a2: LocationName.cloudy_park_6_s24,
+    0x7706a3: LocationName.cloudy_park_6_s25,
+    0x7706a4: LocationName.cloudy_park_6_s26,
+    0x7706a5: LocationName.cloudy_park_6_s27,
+    0x7706a6: LocationName.cloudy_park_6_s28,
+    0x7706a7: LocationName.cloudy_park_6_s29,
+    0x7706a8: LocationName.cloudy_park_6_s30,
+    0x7706a9: LocationName.cloudy_park_6_s31,
+    0x7706aa: LocationName.cloudy_park_6_s32,
+    0x7706ab: LocationName.cloudy_park_6_s33,
+    0x7706ac: LocationName.iceberg_1_s1,
+    0x7706ad: LocationName.iceberg_1_s2,
+    0x7706ae: LocationName.iceberg_1_s3,
+    0x7706af: LocationName.iceberg_1_s4,
+    0x7706b0: LocationName.iceberg_1_s5,
+    0x7706b1: LocationName.iceberg_1_s6,
+    0x7706b2: LocationName.iceberg_2_s1,
+    0x7706b3: LocationName.iceberg_2_s2,
+    0x7706b4: LocationName.iceberg_2_s3,
+    0x7706b5: LocationName.iceberg_2_s4,
+    0x7706b6: LocationName.iceberg_2_s5,
+    0x7706b7: LocationName.iceberg_2_s6,
+    0x7706b8: LocationName.iceberg_2_s7,
+    0x7706b9: LocationName.iceberg_2_s8,
+    0x7706ba: LocationName.iceberg_2_s9,
+    0x7706bb: LocationName.iceberg_2_s10,
+    0x7706bc: LocationName.iceberg_2_s11,
+    0x7706bd: LocationName.iceberg_2_s12,
+    0x7706be: LocationName.iceberg_2_s13,
+    0x7706bf: LocationName.iceberg_2_s14,
+    0x7706c0: LocationName.iceberg_2_s15,
+    0x7706c1: LocationName.iceberg_2_s16,
+    0x7706c2: LocationName.iceberg_2_s17,
+    0x7706c3: LocationName.iceberg_2_s18,
+    0x7706c4: LocationName.iceberg_2_s19,
+    0x7706c5: LocationName.iceberg_3_s1,
+    0x7706c6: LocationName.iceberg_3_s2,
+    0x7706c7: LocationName.iceberg_3_s3,
+    0x7706c8: LocationName.iceberg_3_s4,
+    0x7706c9: LocationName.iceberg_3_s5,
+    0x7706ca: LocationName.iceberg_3_s6,
+    0x7706cb: LocationName.iceberg_3_s7,
+    0x7706cc: LocationName.iceberg_3_s8,
+    0x7706cd: LocationName.iceberg_3_s9,
+    0x7706ce: LocationName.iceberg_3_s10,
+    0x7706cf: LocationName.iceberg_3_s11,
+    0x7706d0: LocationName.iceberg_3_s12,
+    0x7706d1: LocationName.iceberg_3_s13,
+    0x7706d2: LocationName.iceberg_3_s14,
+    0x7706d3: LocationName.iceberg_3_s15,
+    0x7706d4: LocationName.iceberg_3_s16,
+    0x7706d5: LocationName.iceberg_3_s17,
+    0x7706d6: LocationName.iceberg_3_s18,
+    0x7706d7: LocationName.iceberg_3_s19,
+    0x7706d8: LocationName.iceberg_3_s20,
+    0x7706d9: LocationName.iceberg_3_s21,
+    0x7706da: LocationName.iceberg_4_s1,
+    0x7706db: LocationName.iceberg_4_s2,
+    0x7706dc: LocationName.iceberg_4_s3,
+    0x7706dd: LocationName.iceberg_5_s1,
+    0x7706de: LocationName.iceberg_5_s2,
+    0x7706df: LocationName.iceberg_5_s3,
+    0x7706e0: LocationName.iceberg_5_s4,
+    0x7706e1: LocationName.iceberg_5_s5,
+    0x7706e2: LocationName.iceberg_5_s6,
+    0x7706e3: LocationName.iceberg_5_s7,
+    0x7706e4: LocationName.iceberg_5_s8,
+    0x7706e5: LocationName.iceberg_5_s9,
+    0x7706e6: LocationName.iceberg_5_s10,
+    0x7706e7: LocationName.iceberg_5_s11,
+    0x7706e8: LocationName.iceberg_5_s12,
+    0x7706e9: LocationName.iceberg_5_s13,
+    0x7706ea: LocationName.iceberg_5_s14,
+    0x7706eb: LocationName.iceberg_5_s15,
+    0x7706ec: LocationName.iceberg_5_s16,
+    0x7706ed: LocationName.iceberg_5_s17,
+    0x7706ee: LocationName.iceberg_5_s18,
+    0x7706ef: LocationName.iceberg_5_s19,
+    0x7706f0: LocationName.iceberg_5_s20,
+    0x7706f1: LocationName.iceberg_5_s21,
+    0x7706f2: LocationName.iceberg_5_s22,
+    0x7706f3: LocationName.iceberg_5_s23,
+    0x7706f4: LocationName.iceberg_5_s24,
+    0x7706f5: LocationName.iceberg_5_s25,
+    0x7706f6: LocationName.iceberg_5_s26,
+    0x7706f7: LocationName.iceberg_5_s27,
+    0x7706f8: LocationName.iceberg_5_s28,
+    0x7706f9: LocationName.iceberg_5_s29,
+    0x7706fa: LocationName.iceberg_5_s30,
+    0x7706fb: LocationName.iceberg_5_s31,
+    0x7706fc: LocationName.iceberg_5_s32,
+    0x7706fd: LocationName.iceberg_5_s33,
+    0x7706fe: LocationName.iceberg_5_s34,
+    0x7706ff: LocationName.iceberg_6_s1,
+
+}
+
+location_table = {
+    **stage_locations,
+    **heart_star_locations,
+    **boss_locations,
+    **consumable_locations,
+    **star_locations
+}

worlds/kdl3/Names/AnimalFriendSpawns.py

@@ -1,5 +1,3 @@
-from typing import List
-
 grass_land_1_a1 = "Grass Land 1 - Animal 1"  # Nago
 grass_land_1_a2 = "Grass Land 1 - Animal 2"  # Rick
 grass_land_2_a1 = "Grass Land 2 - Animal 1"  # ChuChu
@@ -199,12 +197,3 @@ animal_friend_spawns = {
     iceberg_6_a5: "ChuChu Spawn",
     iceberg_6_a6: "Nago Spawn",
 }
-
-problematic_sets: List[List[str]] = [
-    # Animal groups that must be guaranteed unique. Potential for softlocks on future-ER if not.
-    [ripple_field_4_a1, ripple_field_4_a2, ripple_field_4_a3],
-    [sand_canyon_3_a1, sand_canyon_3_a2, sand_canyon_3_a3],
-    [cloudy_park_6_a1, cloudy_park_6_a2, cloudy_park_6_a3],
-    [iceberg_6_a1, iceberg_6_a2, iceberg_6_a3],
-    [iceberg_6_a4, iceberg_6_a5, iceberg_6_a6]
-]

worlds/kdl3/Names/EnemyAbilities.py

@@ -809,7 +809,7 @@ vanilla_enemies = {'Waddle Dee': 'No Ability',
 
 enemy_restrictive: List[Tuple[List[str], List[str]]] = [
     # abilities, enemies, set_all (False to set any)
-    (["Stone Ability"], ["Rocky", "Sparky", "Babut", "Squishy", ]),  # Ribbon Field 5 - 7
+    (["Burning Ability", "Stone Ability"], ["Rocky", "Sparky", "Babut", "Squishy", ]),  # Ribbon Field 5 - 7
     # Sand Canyon 6
     (["Parasol Ability", "Cutter Ability"], ['Bukiset (Parasol)', 'Bukiset (Cutter)']),
     (["Spark Ability", "Clean Ability"], ['Bukiset (Spark)', 'Bukiset (Clean)']),