diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 000000000000..17a60ad125f7 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,5 @@ +[report] +exclude_lines = + pragma: no cover + if TYPE_CHECKING: + if typing.TYPE_CHECKING: diff --git a/.github/workflows/analyze-modified-files.yml b/.github/workflows/analyze-modified-files.yml index ba2660809aaa..d01365745c96 100644 --- a/.github/workflows/analyze-modified-files.yml +++ b/.github/workflows/analyze-modified-files.yml @@ -71,7 +71,7 @@ jobs: continue-on-error: true if: env.diff != '' && matrix.task == 'flake8' run: | - flake8 --count --max-complexity=10 --max-doc-length=120 --max-line-length=120 --statistics ${{ env.diff }} + flake8 --count --max-complexity=14 --max-doc-length=120 --max-line-length=120 --statistics ${{ env.diff }} - name: "mypy: Type check modified files" continue-on-error: true diff --git a/.run/Archipelago Unittests.run.xml b/.run/Archipelago Unittests.run.xml new file mode 100644 index 000000000000..24fea0f73fec --- /dev/null +++ b/.run/Archipelago Unittests.run.xml @@ -0,0 +1,18 @@ + + + + + \ No newline at end of file diff --git a/BaseClasses.py b/BaseClasses.py index 855e69c5d48c..38598d42d999 100644 --- a/BaseClasses.py +++ b/BaseClasses.py @@ -1056,9 +1056,6 @@ def native_item(self) -> bool: @property def hint_text(self) -> str: - hint_text = getattr(self, "_hint_text", None) - if hint_text: - return hint_text return "at " + self.name.replace("_", " ").replace("-", " ") diff --git a/CommonClient.py b/CommonClient.py index c4d80f341611..736cf4922f40 100644 --- a/CommonClient.py +++ b/CommonClient.py @@ -460,7 +460,7 @@ async def prepare_data_package(self, relevant_games: typing.Set[str], else: self.update_game(cached_game) if needed_updates: - await self.send_msgs([{"cmd": "GetDataPackage", "games": list(needed_updates)}]) + await self.send_msgs([{"cmd": "GetDataPackage", "games": [game_name]} for game_name in needed_updates]) def update_game(self, game_package: dict): for item_name, item_id in game_package["item_name_to_id"].items(): @@ -477,6 +477,7 @@ def consume_network_data_package(self, data_package: dict): current_cache = Utils.persistent_load().get("datapackage", {}).get("games", {}) current_cache.update(data_package["games"]) Utils.persistent_store("datapackage", "games", current_cache) + logger.info(f"Got new ID/Name DataPackage for {', '.join(data_package['games'])}") for game, game_data in data_package["games"].items(): Utils.store_data_package_for_checksum(game, game_data) @@ -727,7 +728,6 @@ async def process_server_cmd(ctx: CommonContext, args: dict): await ctx.server_auth(args['password']) elif cmd == 'DataPackage': - logger.info("Got new ID/Name DataPackage") ctx.consume_network_data_package(args['data']) elif cmd == 'ConnectionRefused': diff --git a/Main.py b/Main.py index 8dac8f7d20eb..e49d8e781df9 100644 --- a/Main.py +++ b/Main.py @@ -114,7 +114,9 @@ def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = No for _ in range(count): world.push_precollected(world.create_item(item_name, player)) - for item_name, count in world.start_inventory_from_pool.setdefault(player, StartInventoryPool({})).value.items(): + for item_name, count in getattr(world.worlds[player].options, + "start_inventory_from_pool", + StartInventoryPool({})).value.items(): for _ in range(count): world.push_precollected(world.create_item(item_name, player)) # remove from_pool items also from early items handling, as starting is plenty early. @@ -167,10 +169,14 @@ def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = No # remove starting inventory from pool items. # Because some worlds don't actually create items during create_items this has to be as late as possible. - if any(world.start_inventory_from_pool[player].value for player in world.player_ids): + if any(getattr(world.worlds[player].options, "start_inventory_from_pool", None) for player in world.player_ids): new_items: List[Item] = [] depletion_pool: Dict[int, Dict[str, int]] = { - player: world.start_inventory_from_pool[player].value.copy() for player in world.player_ids} + player: getattr(world.worlds[player].options, + "start_inventory_from_pool", + StartInventoryPool({})).value.copy() + for player in world.player_ids + } for player, items in depletion_pool.items(): player_world: AutoWorld.World = world.worlds[player] for count in items.values(): diff --git a/ModuleUpdate.py b/ModuleUpdate.py index c33e894e8b5f..c3dc8c8a87b2 100644 --- a/ModuleUpdate.py +++ b/ModuleUpdate.py @@ -4,14 +4,29 @@ import multiprocessing import warnings -local_dir = os.path.dirname(__file__) -requirements_files = {os.path.join(local_dir, 'requirements.txt')} if sys.version_info < (3, 8, 6): raise RuntimeError("Incompatible Python Version. 3.8.7+ is supported.") # don't run update if environment is frozen/compiled or if not the parent process (skip in subprocess) -update_ran = getattr(sys, "frozen", False) or multiprocessing.parent_process() +_skip_update = bool(getattr(sys, "frozen", False) or multiprocessing.parent_process()) +update_ran = _skip_update + + +class RequirementsSet(set): + def add(self, e): + global update_ran + update_ran &= _skip_update + super().add(e) + + def update(self, *s): + global update_ran + update_ran &= _skip_update + super().update(*s) + + +local_dir = os.path.dirname(__file__) +requirements_files = RequirementsSet((os.path.join(local_dir, 'requirements.txt'),)) if not update_ran: for entry in os.scandir(os.path.join(local_dir, "worlds")): diff --git a/MultiServer.py b/MultiServer.py index 9d2e9b564e75..15ed22d715e8 100644 --- a/MultiServer.py +++ b/MultiServer.py @@ -2210,25 +2210,24 @@ def parse_args() -> argparse.Namespace: async def auto_shutdown(ctx, to_cancel=None): await asyncio.sleep(ctx.auto_shutdown) + + def inactivity_shutdown(): + ctx.server.ws_server.close() + ctx.exit_event.set() + if to_cancel: + for task in to_cancel: + task.cancel() + logging.info("Shutting down due to inactivity.") + while not ctx.exit_event.is_set(): if not ctx.client_activity_timers.values(): - ctx.server.ws_server.close() - ctx.exit_event.set() - if to_cancel: - for task in to_cancel: - task.cancel() - logging.info("Shutting down due to inactivity.") + inactivity_shutdown() else: newest_activity = max(ctx.client_activity_timers.values()) delta = datetime.datetime.now(datetime.timezone.utc) - newest_activity seconds = ctx.auto_shutdown - delta.total_seconds() if seconds < 0: - ctx.server.ws_server.close() - ctx.exit_event.set() - if to_cancel: - for task in to_cancel: - task.cancel() - logging.info("Shutting down due to inactivity.") + inactivity_shutdown() else: await asyncio.sleep(seconds) diff --git a/README.md b/README.md index a1e03293d587..ce2130ce8e7c 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ Currently, the following games are supported: * Heretic * Landstalker: The Treasures of King Nole * Final Fantasy Mystic Quest +* TUNIC 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 diff --git a/WebHostLib/api/generate.py b/WebHostLib/api/generate.py index 61e9164e2652..5a66d1e69331 100644 --- a/WebHostLib/api/generate.py +++ b/WebHostLib/api/generate.py @@ -20,8 +20,8 @@ def generate_api(): race = False meta_options_source = {} if 'file' in request.files: - file = request.files['file'] - options = get_yaml_data(file) + files = request.files.getlist('file') + options = get_yaml_data(files) if isinstance(options, Markup): return {"text": options.striptags()}, 400 if isinstance(options, str): diff --git a/WebHostLib/templates/generate.html b/WebHostLib/templates/generate.html index 33f8dbc09e6c..53d98dfae6ba 100644 --- a/WebHostLib/templates/generate.html +++ b/WebHostLib/templates/generate.html @@ -69,8 +69,8 @@

Generate Game{% if race %} (Race Mode){% endif %}

@@ -185,12 +185,12 @@

Generate Game{% if race %} (Race Mode){% endif %}

+ +
+
- -
-
diff --git a/WebHostLib/tracker.py b/WebHostLib/tracker.py index 8a7155afec6b..e8b1ae5b3171 100644 --- a/WebHostLib/tracker.py +++ b/WebHostLib/tracker.py @@ -1,4 +1,5 @@ import datetime +import collections from dataclasses import dataclass from typing import Any, Callable, Dict, List, Optional, Set, Tuple from uuid import UUID @@ -8,7 +9,7 @@ from MultiServer import Context, get_saving_second from NetUtils import ClientStatus, Hint, NetworkItem, NetworkSlot, SlotType -from Utils import restricted_loads +from Utils import restricted_loads, KeyedDefaultDict from . import app, cache from .models import GameDataPackage, Room @@ -62,12 +63,18 @@ def __init__(self, room: Room): self.location_name_to_id: Dict[str, Dict[str, int]] = {} # Generate inverse lookup tables from data package, useful for trackers. - self.item_id_to_name: Dict[str, Dict[int, str]] = {} - self.location_id_to_name: Dict[str, Dict[int, str]] = {} + self.item_id_to_name: Dict[str, Dict[int, str]] = KeyedDefaultDict(lambda game_name: { + game_name: KeyedDefaultDict(lambda code: f"Unknown Game {game_name} - Item (ID: {code})") + }) + self.location_id_to_name: Dict[str, Dict[int, str]] = KeyedDefaultDict(lambda game_name: { + game_name: KeyedDefaultDict(lambda code: f"Unknown Game {game_name} - Location (ID: {code})") + }) for game, game_package in self._multidata["datapackage"].items(): game_package = restricted_loads(GameDataPackage.get(checksum=game_package["checksum"]).data) - self.item_id_to_name[game] = {id: name for name, id in game_package["item_name_to_id"].items()} - self.location_id_to_name[game] = {id: name for name, id in game_package["location_name_to_id"].items()} + self.item_id_to_name[game] = KeyedDefaultDict(lambda code: f"Unknown Item (ID: {code})", { + id: name for name, id in game_package["item_name_to_id"].items()}) + self.location_id_to_name[game] = KeyedDefaultDict(lambda code: f"Unknown Location (ID: {code})", { + id: name for name, id in game_package["location_name_to_id"].items()}) # Normal lookup tables as well. self.item_name_to_id[game] = game_package["item_name_to_id"] @@ -115,10 +122,10 @@ def get_player_received_items(self, team: int, player: int) -> List[NetworkItem] return self._multisave.get("received_items", {}).get((team, player, True), []) @_cache_results - def get_player_inventory_counts(self, team: int, player: int) -> Dict[int, int]: + def get_player_inventory_counts(self, team: int, player: int) -> collections.Counter: """Retrieves a dictionary of all items received by their id and their received count.""" items = self.get_player_received_items(team, player) - inventory = {item: 0 for item in self.item_id_to_name[self.get_player_game(team, player)]} + inventory = collections.Counter() for item in items: inventory[item.item] += 1 @@ -149,16 +156,15 @@ def get_team_completed_worlds_count(self) -> Dict[int, int]: """Retrieves a dictionary of number of completed worlds per team.""" return { team: sum( - self.get_player_client_status(team, player) == ClientStatus.CLIENT_GOAL - for player in players if self.get_slot_info(team, player).type == SlotType.player - ) for team, players in self.get_team_players().items() + self.get_player_client_status(team, player) == ClientStatus.CLIENT_GOAL for player in players + ) for team, players in self.get_all_players().items() } @_cache_results def get_team_hints(self) -> Dict[int, Set[Hint]]: """Retrieves a dictionary of all hints per team.""" hints = {} - for team, players in self.get_team_players().items(): + for team, players in self.get_all_slots().items(): hints[team] = set() for player in players: hints[team] |= self.get_player_hints(team, player) @@ -170,7 +176,7 @@ def get_team_locations_total_count(self) -> Dict[int, int]: """Retrieves a dictionary of total player locations each team has.""" return { team: sum(len(self.get_player_locations(team, player)) for player in players) - for team, players in self.get_team_players().items() + for team, players in self.get_all_players().items() } @_cache_results @@ -178,16 +184,30 @@ def get_team_locations_checked_count(self) -> Dict[int, int]: """Retrieves a dictionary of checked player locations each team has.""" return { team: sum(len(self.get_player_checked_locations(team, player)) for player in players) - for team, players in self.get_team_players().items() + for team, players in self.get_all_players().items() } # TODO: Change this method to properly build for each team once teams are properly implemented, as they don't # currently exist in multidata to easily look up, so these are all assuming only 1 team: Team #0 @_cache_results - def get_team_players(self) -> Dict[int, List[int]]: + def get_all_slots(self) -> Dict[int, List[int]]: """Retrieves a dictionary of all players ids on each team.""" return { - 0: [player for player, slot_info in self._multidata["slot_info"].items()] + 0: [ + player for player, slot_info in self._multidata["slot_info"].items() + ] + } + + # TODO: Change this method to properly build for each team once teams are properly implemented, as they don't + # currently exist in multidata to easily look up, so these are all assuming only 1 team: Team #0 + @_cache_results + def get_all_players(self) -> Dict[int, List[int]]: + """Retrieves a dictionary of all player slot-type players ids on each team.""" + return { + 0: [ + player for player, slot_info in self._multidata["slot_info"].items() + if self.get_slot_info(0, player).type == SlotType.player + ] } @_cache_results @@ -203,7 +223,7 @@ def get_room_locations(self) -> Dict[TeamPlayer, Dict[int, ItemMetadata]]: """Retrieves a dictionary of all locations and their associated item metadata per player.""" return { (team, player): self.get_player_locations(team, player) - for team, players in self.get_team_players().items() for player in players + for team, players in self.get_all_players().items() for player in players } @_cache_results @@ -211,7 +231,7 @@ def get_room_games(self) -> Dict[TeamPlayer, str]: """Retrieves a dictionary of games for each player.""" return { (team, player): self.get_player_game(team, player) - for team, players in self.get_team_players().items() for player in players + for team, players in self.get_all_slots().items() for player in players } @_cache_results @@ -219,7 +239,7 @@ def get_room_locations_complete(self) -> Dict[TeamPlayer, int]: """Retrieves a dictionary of all locations complete per player.""" return { (team, player): len(self.get_player_checked_locations(team, player)) - for team, players in self.get_team_players().items() for player in players + for team, players in self.get_all_players().items() for player in players } @_cache_results @@ -227,14 +247,14 @@ def get_room_client_statuses(self) -> Dict[TeamPlayer, ClientStatus]: """Retrieves a dictionary of all ClientStatus values per player.""" return { (team, player): self.get_player_client_status(team, player) - for team, players in self.get_team_players().items() for player in players + for team, players in self.get_all_players().items() for player in players } @_cache_results def get_room_long_player_names(self) -> Dict[TeamPlayer, str]: """Retrieves a dictionary of names with aliases for each player.""" long_player_names = {} - for team, players in self.get_team_players().items(): + for team, players in self.get_all_slots().items(): for player in players: alias = self.get_player_alias(team, player) if alias: @@ -370,7 +390,8 @@ def render_generic_multiworld_tracker(tracker_data: TrackerData, enabled_tracker enabled_trackers=enabled_trackers, current_tracker="Generic", room=tracker_data.room, - room_players=tracker_data.get_team_players(), + all_slots=tracker_data.get_all_slots(), + room_players=tracker_data.get_all_players(), locations=tracker_data.get_room_locations(), locations_complete=tracker_data.get_room_locations_complete(), total_team_locations=tracker_data.get_team_locations_total_count(), @@ -389,7 +410,6 @@ def render_generic_multiworld_tracker(tracker_data: TrackerData, enabled_tracker # TODO: This is a temporary solution until a proper Tracker API can be implemented for tracker templates and data to # live in their respective world folders. -import collections from worlds import network_data_package @@ -400,7 +420,7 @@ def render_Factorio_multiworld_tracker(tracker_data: TrackerData, enabled_tracke (team, player): { tracker_data.item_id_to_name["Factorio"][item_id]: count for item_id, count in tracker_data.get_player_inventory_counts(team, player).items() - } for team, players in tracker_data.get_team_players().items() for player in players + } for team, players in tracker_data.get_all_slots().items() for player in players if tracker_data.get_player_game(team, player) == "Factorio" } @@ -409,7 +429,8 @@ def render_Factorio_multiworld_tracker(tracker_data: TrackerData, enabled_tracke enabled_trackers=enabled_trackers, current_tracker="Factorio", room=tracker_data.room, - room_players=tracker_data.get_team_players(), + all_slots=tracker_data.get_all_slots(), + room_players=tracker_data.get_all_players(), locations=tracker_data.get_room_locations(), locations_complete=tracker_data.get_room_locations_complete(), total_team_locations=tracker_data.get_team_locations_total_count(), @@ -547,7 +568,7 @@ def render_ALinkToThePast_multiworld_tracker(tracker_data: TrackerData, enabled_ if area_name != "Total" else tracker_data._multidata["checks_in_area"][player]["Total"] for area_name in ordered_areas } - for team, players in tracker_data.get_team_players().items() + for team, players in tracker_data.get_all_slots().items() for player in players if tracker_data.get_slot_info(team, player).type != SlotType.group and tracker_data.get_slot_info(team, player).game == "A Link to the Past" @@ -585,7 +606,7 @@ def _get_location_table(checks_table: dict) -> dict: player_location_to_area = { (team, player): _get_location_table(tracker_data._multidata["checks_in_area"][player]) - for team, players in tracker_data.get_team_players().items() + for team, players in tracker_data.get_all_slots().items() for player in players if tracker_data.get_slot_info(team, player).type != SlotType.group and tracker_data.get_slot_info(team, player).game == "A Link to the Past" @@ -593,15 +614,15 @@ def _get_location_table(checks_table: dict) -> dict: checks_done: Dict[TeamPlayer, Dict[str: int]] = { (team, player): {location_name: 0 for location_name in default_locations} - for team, players in tracker_data.get_team_players().items() + for team, players in tracker_data.get_all_slots().items() for player in players if tracker_data.get_slot_info(team, player).type != SlotType.group and tracker_data.get_slot_info(team, player).game == "A Link to the Past" } inventories: Dict[TeamPlayer, Dict[int, int]] = {} - player_big_key_locations = {(player): set() for player in tracker_data.get_team_players()[0]} - player_small_key_locations = {player: set() for player in tracker_data.get_team_players()[0]} + player_big_key_locations = {(player): set() for player in tracker_data.get_all_slots()[0]} + player_small_key_locations = {player: set() for player in tracker_data.get_all_slots()[0]} group_big_key_locations = set() group_key_locations = set() @@ -639,7 +660,8 @@ def _get_location_table(checks_table: dict) -> dict: enabled_trackers=enabled_trackers, current_tracker="A Link to the Past", room=tracker_data.room, - room_players=tracker_data.get_team_players(), + all_slots=tracker_data.get_all_slots(), + room_players=tracker_data.get_all_players(), locations=tracker_data.get_room_locations(), locations_complete=tracker_data.get_room_locations_complete(), total_team_locations=tracker_data.get_team_locations_total_count(), diff --git a/docs/CODEOWNERS b/docs/CODEOWNERS index e221371b2417..95c0baea3a1f 100644 --- a/docs/CODEOWNERS +++ b/docs/CODEOWNERS @@ -164,6 +164,9 @@ # The Legend of Zelda (1) /worlds/tloz/ @Rosalie-A @t3hf1gm3nt +# TUNIC +/worlds/tunic/ @silent-destroyer + # Undertale /worlds/undertale/ @jonloveslegos diff --git a/docs/network protocol.md b/docs/network protocol.md index 274b6e3716bc..d10e6519a93b 100644 --- a/docs/network protocol.md +++ b/docs/network protocol.md @@ -675,8 +675,8 @@ Tags are represented as a list of strings, the common Client tags follow: ### 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: -| Name | Type | Notes | -| ---- | ---- | ---- | -| time | float | Unix Time Stamp of time of death. | -| cause | str | Optional. Text to explain the cause of death, ex. "Berserker was run over by a train." | -| source | str | Name of the player who first died. Can be a slot name, but can also be a name from within a multiplayer game. | +| Name | Type | Notes | +|--------|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| time | float | Unix Time Stamp of time of death. | +| cause | str | Optional. Text to explain the cause of death. When provided, or checked, this should contain the player name, ex. "Berserker was run over by a train." | +| source | str | Name of the player who first died. Can be a slot name, but can also be a name from within a multiplayer game. | diff --git a/requirements.txt b/requirements.txt index 0db55a803591..f604556809f1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,7 +4,7 @@ PyYAML>=6.0.1 jellyfish>=1.0.3 jinja2>=3.1.2 schema>=0.7.5 -kivy>=2.2.1 +kivy>=2.3.0 bsdiff4>=1.2.4 platformdirs>=4.0.0 certifi>=2023.11.17 diff --git a/settings.py b/settings.py index acae86095cda..c58eadf155d7 100644 --- a/settings.py +++ b/settings.py @@ -597,8 +597,8 @@ class LogNetwork(IntEnum): disable_item_cheat: Union[DisableItemCheat, bool] = False location_check_points: LocationCheckPoints = LocationCheckPoints(1) hint_cost: HintCost = HintCost(10) - release_mode: ReleaseMode = ReleaseMode("goal") - collect_mode: CollectMode = CollectMode("goal") + release_mode: ReleaseMode = ReleaseMode("auto") + collect_mode: CollectMode = CollectMode("auto") remaining_mode: RemainingMode = RemainingMode("goal") auto_shutdown: AutoShutdown = AutoShutdown(0) compatibility: Compatibility = Compatibility(2) @@ -673,7 +673,7 @@ class Race(IntEnum): spoiler: Spoiler = Spoiler(3) glitch_triforce_room: GlitchTriforceRoom = GlitchTriforceRoom(1) # why is this here? race: Race = Race(0) - plando_options: PlandoOptions = PlandoOptions("bosses") + plando_options: PlandoOptions = PlandoOptions("bosses, connections, texts") class SNIOptions(Group): diff --git a/setup.py b/setup.py index c864a8cc9d39..05e923ed3f01 100644 --- a/setup.py +++ b/setup.py @@ -54,7 +54,6 @@ # TODO: move stuff to not require this import ModuleUpdate ModuleUpdate.update(yes="--yes" in sys.argv or "-y" in sys.argv) - ModuleUpdate.update_ran = False # restore for later from worlds.LauncherComponents import components, icon_paths from Utils import version_tuple, is_windows, is_linux @@ -76,7 +75,6 @@ "Ocarina of Time", "Overcooked! 2", "Raft", - "Secret of Evermore", "Slay the Spire", "Sudoku", "Super Mario 64", @@ -305,7 +303,6 @@ def run(self): print(f"Outputting to: {self.buildfolder}") os.makedirs(self.buildfolder, exist_ok=True) import ModuleUpdate - ModuleUpdate.requirements_files.add(os.path.join("WebHostLib", "requirements.txt")) ModuleUpdate.update(yes=self.yes) # auto-build cython modules diff --git a/test/bases.py b/test/bases.py index d6a43c598ffb..7ce12cc7b787 100644 --- a/test/bases.py +++ b/test/bases.py @@ -285,7 +285,7 @@ def test_all_state_can_reach_everything(self): if not (self.run_default_tests and self.constructed): return with self.subTest("Game", game=self.game): - excluded = self.multiworld.exclude_locations[1].value + excluded = self.multiworld.worlds[1].options.exclude_locations.value state = self.multiworld.get_all_state(False) for location in self.multiworld.get_locations(): if location.name not in excluded: diff --git a/test/benchmark/__init__.py b/test/benchmark/__init__.py new file mode 100644 index 000000000000..5f890e85300d --- /dev/null +++ b/test/benchmark/__init__.py @@ -0,0 +1,127 @@ +import time + + +class TimeIt: + def __init__(self, name: str, time_logger=None): + self.name = name + self.logger = time_logger + self.timer = None + self.end_timer = None + + def __enter__(self): + self.timer = time.perf_counter() + return self + + @property + def dif(self): + return self.end_timer - self.timer + + def __exit__(self, exc_type, exc_val, exc_tb): + if not self.end_timer: + self.end_timer = time.perf_counter() + if self.logger: + self.logger.info(f"{self.dif:.4f} seconds in {self.name}.") + + +if __name__ == "__main__": + import argparse + import logging + import gc + import collections + import typing + + # makes this module runnable from its folder. + import sys + import os + sys.path.remove(os.path.dirname(__file__)) + new_home = os.path.normpath(os.path.join(os.path.dirname(__file__), os.pardir, os.pardir)) + os.chdir(new_home) + sys.path.append(new_home) + + from Utils import init_logging, local_path + local_path.cached_path = new_home + from BaseClasses import MultiWorld, CollectionState, Location + from worlds import AutoWorld + from worlds.AutoWorld import call_all + + init_logging("Benchmark Runner") + logger = logging.getLogger("Benchmark") + + + class BenchmarkRunner: + gen_steps: typing.Tuple[str, ...] = ( + "generate_early", "create_regions", "create_items", "set_rules", "generate_basic", "pre_fill") + rule_iterations: int = 100_000 + + if sys.version_info >= (3, 9): + @staticmethod + def format_times_from_counter(counter: collections.Counter[str], top: int = 5) -> str: + return "\n".join(f" {time:.4f} in {name}" for name, time in counter.most_common(top)) + else: + @staticmethod + def format_times_from_counter(counter: collections.Counter, top: int = 5) -> str: + return "\n".join(f" {time:.4f} in {name}" for name, time in counter.most_common(top)) + + def location_test(self, test_location: Location, state: CollectionState, state_name: str) -> float: + with TimeIt(f"{test_location.game} {self.rule_iterations} " + f"runs of {test_location}.access_rule({state_name})", logger) as t: + for _ in range(self.rule_iterations): + test_location.access_rule(state) + # if time is taken to disentangle complex ref chains, + # this time should be attributed to the rule. + gc.collect() + return t.dif + + def main(self): + for game in sorted(AutoWorld.AutoWorldRegister.world_types): + summary_data: typing.Dict[str, collections.Counter[str]] = { + "empty_state": collections.Counter(), + "all_state": collections.Counter(), + } + try: + multiworld = MultiWorld(1) + multiworld.game[1] = game + multiworld.player_name = {1: "Tester"} + multiworld.set_seed(0) + multiworld.state = CollectionState(multiworld) + args = argparse.Namespace() + for name, option in AutoWorld.AutoWorldRegister.world_types[game].options_dataclass.type_hints.items(): + setattr(args, name, { + 1: option.from_any(getattr(option, "default")) + }) + multiworld.set_options(args) + + gc.collect() + for step in self.gen_steps: + with TimeIt(f"{game} step {step}", logger): + call_all(multiworld, step) + gc.collect() + + locations = sorted(multiworld.get_unfilled_locations()) + if not locations: + continue + + all_state = multiworld.get_all_state(False) + for location in locations: + time_taken = self.location_test(location, multiworld.state, "empty_state") + summary_data["empty_state"][location.name] = time_taken + + time_taken = self.location_test(location, all_state, "all_state") + summary_data["all_state"][location.name] = time_taken + + total_empty_state = sum(summary_data["empty_state"].values()) + total_all_state = sum(summary_data["all_state"].values()) + + logger.info(f"{game} took {total_empty_state/len(locations):.4f} " + f"seconds per location in empty_state and {total_all_state/len(locations):.4f} " + f"in all_state. (all times summed for {self.rule_iterations} runs.)") + logger.info(f"Top times in empty_state:\n" + f"{self.format_times_from_counter(summary_data['empty_state'])}") + logger.info(f"Top times in all_state:\n" + f"{self.format_times_from_counter(summary_data['all_state'])}") + + except Exception as e: + logger.exception(e) + + runner = BenchmarkRunner() + runner.main() diff --git a/test/general/test_items.py b/test/general/test_items.py index 2d8775d535b6..bd6c3fd85305 100644 --- a/test/general/test_items.py +++ b/test/general/test_items.py @@ -1,5 +1,6 @@ import unittest -from worlds.AutoWorld import AutoWorldRegister + +from worlds.AutoWorld import AutoWorldRegister, call_all from . import setup_solo_multiworld @@ -53,7 +54,7 @@ def test_item_count_greater_equal_locations(self): f"{game_name} Item count MUST meet or exceed the number of locations", ) - def testItemsInDatapackage(self): + def test_items_in_datapackage(self): """Test that any created items in the itempool are in the datapackage""" for game_name, world_type in AutoWorldRegister.world_types.items(): with self.subTest("Game", game=game_name): @@ -69,3 +70,20 @@ def test_item_descriptions_have_valid_names(self): with self.subTest("Name should be valid", game=game_name, item=name): self.assertIn(name, valid_names, "All item descriptions must match defined item names") + + def test_itempool_not_modified(self): + """Test that worlds don't modify the itempool after `create_items`""" + gen_steps = ("generate_early", "create_regions", "create_items") + additional_steps = ("set_rules", "generate_basic", "pre_fill") + excluded_games = ("Links Awakening DX", "Ocarina of Time", "SMZ3") + worlds_to_test = {game: world + for game, world in AutoWorldRegister.world_types.items() if game not in excluded_games} + for game_name, world_type in worlds_to_test.items(): + with self.subTest("Game", game=game_name): + multiworld = setup_solo_multiworld(world_type, gen_steps) + created_items = multiworld.itempool.copy() + for step in additional_steps: + with self.subTest("step", step=step): + call_all(multiworld, step) + self.assertEqual(created_items, multiworld.itempool, + f"{game_name} modified the itempool during {step}") diff --git a/test/general/test_options.py b/test/general/test_options.py index e1136f93c96f..211704dfe6ba 100644 --- a/test/general/test_options.py +++ b/test/general/test_options.py @@ -10,3 +10,10 @@ def test_options_have_doc_string(self): for option_key, option in world_type.options_dataclass.type_hints.items(): with self.subTest(game=gamename, option=option_key): self.assertTrue(option.__doc__) + + def test_options_are_not_set_by_world(self): + """Test that options attribute is not already set""" + for gamename, world_type in AutoWorldRegister.world_types.items(): + with self.subTest(game=gamename): + self.assertFalse(hasattr(world_type, "options"), + f"Unexpected assignment to {world_type.__name__}.options!") diff --git a/test/general/test_reachability.py b/test/general/test_reachability.py index 828912ee35a3..cfd83c940463 100644 --- a/test/general/test_reachability.py +++ b/test/general/test_reachability.py @@ -37,7 +37,7 @@ def test_default_all_state_can_reach_everything(self): unreachable_regions = self.default_settings_unreachable_regions.get(game_name, set()) with self.subTest("Game", game=game_name): world = setup_solo_multiworld(world_type) - excluded = world.exclude_locations[1].value + excluded = world.worlds[1].options.exclude_locations.value state = world.get_all_state(False) for location in world.get_locations(): if location.name not in excluded: diff --git a/test/webhost/test_api_generate.py b/test/webhost/test_api_generate.py index b8bdcb38c764..bd78edd9c700 100644 --- a/test/webhost/test_api_generate.py +++ b/test/webhost/test_api_generate.py @@ -1,5 +1,7 @@ +import io import unittest import json +import yaml class TestDocs(unittest.TestCase): @@ -23,7 +25,7 @@ def test_correct_error_empty_request(self): response = self.client.post("/api/generate") self.assertIn("No options found. Expected file attachment or json weights.", response.text) - def test_generation_queued(self): + def test_generation_queued_weights(self): options = { "Tester1": { @@ -40,3 +42,19 @@ def test_generation_queued(self): json_data = response.get_json() self.assertTrue(json_data["text"].startswith("Generation of seed ")) self.assertTrue(json_data["text"].endswith(" started successfully.")) + + def test_generation_queued_file(self): + options = { + "game": "Archipelago", + "name": "Tester", + "Archipelago": {} + } + response = self.client.post( + "/api/generate", + data={ + 'file': (io.BytesIO(yaml.dump(options, encoding="utf-8")), "test.yaml") + }, + ) + json_data = response.get_json() + self.assertTrue(json_data["text"].startswith("Generation of seed ")) + self.assertTrue(json_data["text"].endswith(" started successfully.")) diff --git a/typings/kivy/graphics.pyi b/typings/kivy/graphics/__init__.pyi similarity index 54% rename from typings/kivy/graphics.pyi rename to typings/kivy/graphics/__init__.pyi index 1950910661f4..a1a5bc02f68e 100644 --- a/typings/kivy/graphics.pyi +++ b/typings/kivy/graphics/__init__.pyi @@ -1,24 +1,12 @@ -""" FillType_* is not a real kivy type - just something to fill unknown typing. """ - -from typing import Sequence - -FillType_Vec = Sequence[int] - - -class FillType_Drawable: - def __init__(self, *, pos: FillType_Vec = ..., size: FillType_Vec = ...) -> None: ... - - -class FillType_Texture(FillType_Drawable): - pass +from .texture import FillType_Drawable, FillType_Vec, Texture class FillType_Shape(FillType_Drawable): - texture: FillType_Texture + texture: Texture def __init__(self, *, - texture: FillType_Texture = ..., + texture: Texture = ..., pos: FillType_Vec = ..., size: FillType_Vec = ...) -> None: ... @@ -35,6 +23,6 @@ class Rectangle(FillType_Shape): def __init__(self, *, source: str = ..., - texture: FillType_Texture = ..., + texture: Texture = ..., pos: FillType_Vec = ..., size: FillType_Vec = ...) -> None: ... diff --git a/typings/kivy/graphics/texture.pyi b/typings/kivy/graphics/texture.pyi new file mode 100644 index 000000000000..19e03aad69dd --- /dev/null +++ b/typings/kivy/graphics/texture.pyi @@ -0,0 +1,13 @@ +""" FillType_* is not a real kivy type - just something to fill unknown typing. """ + +from typing import Sequence + +FillType_Vec = Sequence[int] + + +class FillType_Drawable: + def __init__(self, *, pos: FillType_Vec = ..., size: FillType_Vec = ...) -> None: ... + + +class Texture: + pass diff --git a/typings/kivy/uix/image.pyi b/typings/kivy/uix/image.pyi new file mode 100644 index 000000000000..fa014baec7c2 --- /dev/null +++ b/typings/kivy/uix/image.pyi @@ -0,0 +1,9 @@ +import io + +from kivy.graphics.texture import Texture + + +class CoreImage: + texture: Texture + + def __init__(self, data: io.BytesIO, ext: str) -> None: ... diff --git a/worlds/AutoWorld.py b/worlds/AutoWorld.py index f56c39f69086..fdc50acc5581 100644 --- a/worlds/AutoWorld.py +++ b/worlds/AutoWorld.py @@ -79,8 +79,8 @@ def __new__(mcs, name: str, bases: Tuple[type, ...], dct: Dict[str, Any]) -> Aut if "options_dataclass" not in dct and "option_definitions" in dct: # TODO - switch to deprecate after a version if __debug__: - from warnings import warn - warn("Assigning options through option_definitions is now deprecated. Use options_dataclass instead.") + logging.warning(f"{name} Assigned options through option_definitions which is now deprecated. " + "Please use options_dataclass instead.") dct["options_dataclass"] = make_dataclass(f"{name}Options", dct["option_definitions"].items(), bases=(PerGameCommonOptions,)) @@ -328,7 +328,7 @@ def create_regions(self) -> None: def create_items(self) -> None: """ - Method for creating and submitting items to the itempool. Items and Regions should *not* be created and submitted + Method for creating and submitting items to the itempool. Items and Regions must *not* be created and submitted to the MultiWorld after this step. If items need to be placed during pre_fill use `get_prefill_items`. """ pass diff --git a/worlds/adventure/docs/setup_en.md b/worlds/adventure/docs/setup_en.md index 10fc564aba51..7378a018c7c1 100644 --- a/worlds/adventure/docs/setup_en.md +++ b/worlds/adventure/docs/setup_en.md @@ -10,8 +10,7 @@ As we are using BizHawk, this guide is only applicable to Windows and Linux syst - Version 2.3.1 and later are supported. Version 2.7 is recommended for stability. - Detailed installation instructions for BizHawk can be found at the above link. - Windows users must run the prereq installer first, which can also be found at the above link. -- The built-in Archipelago client, which can be installed [here](https://github.com/ArchipelagoMW/Archipelago/releases) - (select `Adventure Client` during installation). +- The built-in Archipelago client, which can be installed [here](https://github.com/ArchipelagoMW/Archipelago/releases). - An Adventure NTSC ROM file. The Archipelago community cannot provide these. ## Configuring BizHawk diff --git a/worlds/alttp/SubClasses.py b/worlds/alttp/SubClasses.py index 64e4adaec9a2..22eeebe181e5 100644 --- a/worlds/alttp/SubClasses.py +++ b/worlds/alttp/SubClasses.py @@ -26,6 +26,13 @@ def __init__(self, player: int, name: str, address: Optional[int] = None, crysta self.player_address = player_address self._hint_text = hint_text + @property + def hint_text(self) -> str: + hint_text = getattr(self, "_hint_text", None) + if hint_text: + return hint_text + return "at " + self.name.replace("_", " ").replace("-", " ") + class ALttPItem(Item): game: str = "A Link to the Past" diff --git a/worlds/alttp/docs/multiworld_en.md b/worlds/alttp/docs/multiworld_en.md index 3d27a7f7ffe0..7521def36ea1 100644 --- a/worlds/alttp/docs/multiworld_en.md +++ b/worlds/alttp/docs/multiworld_en.md @@ -2,8 +2,7 @@ ## Required Software -- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). Make sure to check the box for -`SNI Client - A Link to the Past Patch Setup` +- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). - [SNI](https://github.com/alttpo/sni/releases). This is automatically included with your Archipelago installation above. - SNI is not compatible with (Q)Usb2Snes. - Hardware or software capable of loading and playing SNES ROM files @@ -18,11 +17,12 @@ but it is not supported.** ## Installation Procedures -1. Download and install SNIClient from the link above, making sure to install the most recent version. - **The installer file is located in the assets section at the bottom of the version information**. - - During setup, you will be asked to locate your base ROM file. This is your Japanese Link to the Past ROM file. +1. Download and install [Archipelago](). **The installer + file is located in the assets section at the bottom of the version information.** +2. The first time you do local generation or patch your game, you will be asked to locate your base ROM file. + This is your Japanese Link to the Past ROM file. This only needs to be done once. -2. If you are using an emulator, you should assign your Lua capable emulator as your default program for launching ROM +3. If you are using an emulator, you should assign your Lua capable emulator as your default program for launching ROM files. 1. Extract your emulator's folder to your Desktop, or somewhere you will remember. 2. Right-click on a ROM file and select **Open with...** diff --git a/worlds/bk_sudoku/__init__.py b/worlds/bk_sudoku/__init__.py index 36d863bb4475..195339c38070 100644 --- a/worlds/bk_sudoku/__init__.py +++ b/worlds/bk_sudoku/__init__.py @@ -7,16 +7,25 @@ class Bk_SudokuWebWorld(WebWorld): options_page = "games/Sudoku/info/en" theme = 'partyTime' - tutorials = [ - Tutorial( - tutorial_name='Setup Guide', - description='A guide to playing BK Sudoku', - language='English', - file_name='setup_en.md', - link='setup/en', - authors=['Jarno'] - ) - ] + + setup_en = Tutorial( + tutorial_name='Setup Guide', + description='A guide to playing BK Sudoku', + language='English', + file_name='setup_en.md', + link='setup/en', + authors=['Jarno'] + ) + setup_de = Tutorial( + tutorial_name='Setup Anleitung', + description='Eine Anleitung um BK-Sudoku zu spielen', + language='Deutsch', + file_name='setup_de.md', + link='setup/de', + authors=['Held_der_Zeit'] + ) + + tutorials = [setup_en, setup_de] class Bk_SudokuWorld(World): diff --git a/worlds/bk_sudoku/docs/de_Sudoku.md b/worlds/bk_sudoku/docs/de_Sudoku.md new file mode 100644 index 000000000000..abb50c5498d1 --- /dev/null +++ b/worlds/bk_sudoku/docs/de_Sudoku.md @@ -0,0 +1,21 @@ +# BK-Sudoku + +## Was ist das für ein Spiel? + +BK-Sudoku ist kein typisches Archipelago-Spiel; stattdessen ist es ein gewöhnlicher Sudoku-Client der sich zu jeder +beliebigen Multiworld verbinden kann. Einmal verbunden kannst du ein 9x9 Sudoku spielen um einen zufälligen Hinweis +für dein Spiel zu erhalten. Es ist zwar langsam, aber es gibt dir etwas zu tun, solltest du mal nicht in der Lage sein +weitere „Checks” zu erreichen. +(Wer mag kann auch einfach so Sudoku spielen. Man muss nicht mit einer Multiworld verbunden sein, um ein Sudoku zu +spielen/generieren.) + +## Wie werden Hinweise freigeschalten? + +Nach dem Lösen eines Sudokus wird für den verbundenen Slot ein zufällig ausgewählter Hinweis freigegeben, für einen +Gegenstand der noch nicht gefunden wurde. + +## Wo ist die Seite für die Einstellungen? + +Es gibt keine Seite für die Einstellungen. Dieses Spiel kann nicht in deinen YAML-Dateien benutzt werden. Stattdessen +kann sich der Client mit einem beliebigen Slot einer Multiworld verbinden. In dem Client selbst kann aber der +Schwierigkeitsgrad des Sudoku ausgewählt werden. diff --git a/worlds/bk_sudoku/docs/setup_de.md b/worlds/bk_sudoku/docs/setup_de.md new file mode 100644 index 000000000000..71a8e5f6245d --- /dev/null +++ b/worlds/bk_sudoku/docs/setup_de.md @@ -0,0 +1,27 @@ +# BK-Sudoku Setup Anleitung + +## Benötigte Software +- [Bk-Sudoku](https://github.com/Jarno458/sudoku) +- Windows 8 oder höher + +## Generelles Konzept + +Dies ist ein Client, der sich mit jedem beliebigen Slot einer Multiworld verbinden kann. Er lässt dich ein (9x9) Sudoku +spielen, um zufällige Hinweise für den verbundenen Slot freizuschalten. + +Aufgrund des Fakts, dass der Sudoku-Client sich zu jedem beliebigen Slot verbinden kann, ist es daher nicht notwendig +eine YAML für dieses Spiel zu generieren, da es keinen neuen Slot zur Multiworld-Session hinzufügt. + +## Installationsprozess + +Gehe zu der aktuellsten (latest) Veröffentlichung der [BK-Sudoku Releases](https://github.com/Jarno458/sudoku/releases). +Downloade und extrahiere/entpacke die `Bk_Sudoku.zip`-Datei. + +## Verbinden mit einer Multiworld + +1. Starte `Bk_Sudoku.exe` +2. Trage den Namen des Slots ein, mit dem du dich verbinden möchtest +3. Trage die Server-URL und den Port ein +4. Drücke auf Verbinden (connect) +5. Wähle deinen Schwierigkeitsgrad +6. Versuche das Sudoku zu Lösen diff --git a/worlds/checksfinder/docs/setup_en.md b/worlds/checksfinder/docs/setup_en.md index 28c7c32580c3..77eca6f71b34 100644 --- a/worlds/checksfinder/docs/setup_en.md +++ b/worlds/checksfinder/docs/setup_en.md @@ -5,7 +5,6 @@ - ChecksFinder from the [Github releases Page for the game](https://github.com/jonloveslegos/ChecksFinder/releases) (latest version) - Archipelago from the [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases) - - (select `ChecksFinder Client` during installation.) ## Configuring your YAML file diff --git a/worlds/clique/__init__.py b/worlds/clique/__init__.py index 583838904726..30c0e47f818e 100644 --- a/worlds/clique/__init__.py +++ b/worlds/clique/__init__.py @@ -11,16 +11,26 @@ class CliqueWebWorld(WebWorld): theme = "partyTime" - tutorials = [ - Tutorial( - tutorial_name="Start Guide", - description="A guide to playing Clique.", - language="English", - file_name="guide_en.md", - link="guide/en", - authors=["Phar"] - ) - ] + + setup_en = Tutorial( + tutorial_name="Start Guide", + description="A guide to playing Clique.", + language="English", + file_name="guide_en.md", + link="guide/en", + authors=["Phar"] + ) + + setup_de = Tutorial( + tutorial_name="Anleitung zum Anfangen", + description="Eine Anleitung um Clique zu spielen.", + language="Deutsch", + file_name="guide_de.md", + link="guide/de", + authors=["Held_der_Zeit"] + ) + + tutorials = [setup_en, setup_de] class CliqueWorld(World): diff --git a/worlds/clique/docs/de_Clique.md b/worlds/clique/docs/de_Clique.md new file mode 100644 index 000000000000..cde0a23cf6fe --- /dev/null +++ b/worlds/clique/docs/de_Clique.md @@ -0,0 +1,18 @@ +# Clique + +## Was ist das für ein Spiel? + +~~Clique ist ein psychologisches Überlebens-Horror Spiel, in dem der Spieler der Versuchung wiederstehen muss große~~ +~~(rote) Knöpfe zu drücken.~~ + +Clique ist ein scherzhaftes Spiel, welches für Archipelago im März 2023 entwickelt wurde, um zu zeigen, wie einfach +es sein kann eine Welt für Archipelago zu entwicklen. Das Ziel des Spiels ist es den großen (standardmäßig) roten +Knopf zu drücken. Wenn ein Spieler auf dem `hard_mode` (schwieriger Modus) spielt, muss dieser warten bis jemand +anderes in der Multiworld den Knopf aktiviert, damit er gedrückt werden kann. + +Clique kann auf den meisten modernen, HTML5-fähigen Browsern gespielt werden. + +## Wo ist die Seite für die Einstellungen? + +Die [Seite für die Spielereinstellungen dieses Spiels](../player-options) enthält alle Optionen die man benötigt um +eine YAML-Datei zu konfigurieren und zu exportieren. diff --git a/worlds/clique/docs/guide_de.md b/worlds/clique/docs/guide_de.md new file mode 100644 index 000000000000..26e08dbbdd7e --- /dev/null +++ b/worlds/clique/docs/guide_de.md @@ -0,0 +1,25 @@ +# Clique Anleitung + +Nachdem dein Seed generiert wurde, gehe auf die Website von [Clique dem Spiel](http://clique.pharware.com/) und gib +Server-Daten, deinen Slot-Namen und ein Passwort (falls vorhanden) ein. Klicke dann auf "Connect" (Verbinden). + +Wenn du auf "Einfach" spielst, kannst du unbedenklich den Knopf drücken und deine "Befriedigung" erhalten. + +Wenn du auf "Schwer" spielst, ist es sehr wahrscheinlich, dass du warten musst bevor du dein Ziel erreichen kannst. +Glücklicherweise läuft Click auf den meißten großen Browsern, die HTML5 unterstützen. Das heißt du kannst Clique auf +deinem Handy starten und produktiv sein während du wartest! + +Falls du einige Ideen brauchst was du tun kannst, während du wartest bis der Knopf aktiviert wurde, versuche +(mindestens) eins der Folgenden: + +- Dein Zimmer aufräumen. +- Die Wäsche machen. +- Etwas Essen von einem X-Belieben Fast Food Restaruant holen. +- Das tägliche Wordle machen. +- ~~Deine Seele an **Phar** verkaufen.~~ +- Deine Hausaufgaben erledigen. +- Deine Post abholen. + + +~~Solltest du auf irgendwelche Probleme in diesem Spiel stoßen, solltest du keinesfalls nicht **thephar** auf~~ +~~Discord kontaktieren. *zwinker* *zwinker*~~ diff --git a/worlds/dkc3/docs/setup_en.md b/worlds/dkc3/docs/setup_en.md index 9c4197286eb9..236d1cb8ad32 100644 --- a/worlds/dkc3/docs/setup_en.md +++ b/worlds/dkc3/docs/setup_en.md @@ -2,7 +2,7 @@ ## Required Software -- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). Make sure to check the box for `SNI Client - Donkey Kong Country 3 Patch Setup` +- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). - Hardware or software capable of loading and playing SNES ROM files @@ -23,9 +23,10 @@ ### Windows Setup -1. During the installation of Archipelago, you will have been asked to install the SNI Client. If you did not do this, - or you are on an older version, you may run the installer again to install the SNI Client. -2. During setup, you will be asked to locate your base ROM file. This is your Donkey Kong Country 3 ROM file. +1. Download and install [Archipelago](). **The installer + file is located in the assets section at the bottom of the version information.** +2. The first time you do local generation or patch your game, you will be asked to locate your base ROM file. + This is your Donkey Kong Country 3 ROM file. This only needs to be done once. 3. If you are using an emulator, you should assign your Lua capable emulator as your default program for launching ROM files. 1. Extract your emulator's folder to your Desktop, or somewhere you will remember. diff --git a/worlds/dlcquest/__init__.py b/worlds/dlcquest/__init__.py index c22b7cd9847b..ca7a0157cb5c 100644 --- a/worlds/dlcquest/__init__.py +++ b/worlds/dlcquest/__init__.py @@ -13,14 +13,23 @@ class DLCqwebworld(WebWorld): - tutorials = [Tutorial( + setup_en = Tutorial( "Multiworld Setup Tutorial", "A guide to setting up the Archipelago DLCQuest game on your computer.", "English", "setup_en.md", "setup/en", ["axe_y"] - )] + ) + setup_fr = Tutorial( + "Guide de configuration MultiWorld", + "Un guide pour configurer DLCQuest sur votre PC.", + "Français", + "setup_fr.md", + "setup/fr", + ["Deoxis"] + ) + tutorials = [setup_en, setup_fr] class DLCqworld(World): diff --git a/worlds/dlcquest/docs/fr_DLCQuest.md b/worlds/dlcquest/docs/fr_DLCQuest.md new file mode 100644 index 000000000000..95a8048dfe5e --- /dev/null +++ b/worlds/dlcquest/docs/fr_DLCQuest.md @@ -0,0 +1,49 @@ +# DLC Quest + +## Où se trouve la page des paramètres ? + +La [page des paramètres du joueur pour ce jeu](../player-settings) contient tous les paramètres dont vous avez besoin pour configurer et exporter le fichier. + + +## Quel est l'effet de la randomisation sur ce jeu ? + +Les DLC seront obtenus en tant que check pour le multiworld. Il existe également d'autres checks optionnels dans DLC Quest. + +## Quel est le but de DLC Quest ? + +DLC Quest a deux campagnes, et le joueur peut choisir celle qu'il veut jouer pour sa partie. +Il peut également choisir de faire les deux campagnes. + + +## Quels sont les emplacements dans DLC quest ? + +Les emplacements dans DLC Quest comprennent toujours +- les achats de DLC auprès du commerçant +- Les objectifs liés aux récompenses + - Tuer des moutons dans DLC Quest + - Objectifs spécifiques de l'attribution dans Live Freemium or Die + +Il existe également un certain nombres de critères de localisation qui sont optionnels et que les joueurs peuvent choisir d'inclure ou non dans leur sélection : +- Objets que votre personnage peut obtenir de différentes manières + - Swords + - Gun + - Box of Various Supplies + - Humble Indie Bindle + - Pickaxe +- Coinsanity : Pièces de monnaie, soit individuellement, soit sous forme de lots personnalisés + +## Quels objets peuvent se trouver dans le monde d'un autre joueur ? + +Tous les DLC du jeu sont mélangés dans le stock d'objets. Les objets liés aux contrôles optionnels décrits ci-dessus sont également dans le stock + +Il y a aussi de nouveaux objets pièges, utilisés comme substituts, basés sur les désagréments du jeu vanille. +- Zombie Sheep +- Loading Screens +- Temporary Spikes + +## Que se passe-t-il lorsque le joueur reçoit un objet ? + +Chaque fois qu'un objet est reçu en ligne, une notification apparaît à l'écran pour en informer le joueur. +Certains objets sont accompagnés d'une animation ou d'une scène qui se déroule immédiatement après leur réception. + +Les objets reçus hors ligne ne sont pas accompagnés d'une animation ou d'une scène, et sont simplement activés lors de la connexion. \ No newline at end of file diff --git a/worlds/dlcquest/docs/setup_fr.md b/worlds/dlcquest/docs/setup_fr.md new file mode 100644 index 000000000000..78c69eb5a729 --- /dev/null +++ b/worlds/dlcquest/docs/setup_fr.md @@ -0,0 +1,55 @@ +# # Guide de configuration MultiWorld de DLCQuest + +## Logiciels requis + +- DLC Quest sur PC (Recommandé: [Version Steam](https://store.steampowered.com/app/230050/DLC_Quest/)) +- [DLCQuestipelago](https://github.com/agilbert1412/DLCQuestipelago/releases) +- BepinEx (utilisé comme un modloader pour DLCQuest. La version du mod ci-dessus inclut BepInEx si vous choisissez la version d'installation complète) + +## Logiciels optionnels +- [Archipelago] (https://github.com/ArchipelagoMW/Archipelago/releases) + - (Uniquement pour le TextClient) + +## Créer un fichier de configuration (.yaml) + +### Qu'est-ce qu'un fichier YAML et pourquoi en ai-je besoin ? + +Voir le guide d'Archipelago sur la mise en place d'un YAML de base : [Basic Multiworld Setup Guide](/tutorial/Archipelago/setup/en) + +### Où puis-je obtenir un fichier YAML ? + +Vous pouvez personnaliser vos paramètres en visitant la [page des paramètres du joueur DLC Quest] (/games/DLCQuest/player-settings). + +## Rejoindre une partie multi-monde + +### Installer le mod + +- Télécharger le [DLCQuestipelago mod release](https://github.com/agilbert1412/DLCQuestipelago/releases). Si c'est la première fois que vous installez le mod, ou si vous n'êtes pas à l'aise avec l'édition manuelle de fichiers, vous devriez choisir l'Installateur. Il se chargera de la plus grande partie du travail pour vous + + +- Extraire l'archive .zip à l'emplacement de votre choix + + +- Exécutez "DLCQuestipelagoInstaller.exe". + +![image](https://i.imgur.com/2sPhMgs.png) +- Le programme d'installation devrait décrire ce qu'il fait à chaque étape, et vous demandera votre avis si nécessaire. + - Il vous permettra de choisir l'emplacement d'installation de votre jeu moddé et vous proposera un emplacement par défaut + - Il **essayera** de trouver votre jeu DLCQuest sur votre ordinateur et, en cas d'échec, vous demandera d'indiquer le chemin d'accès. + - Il vous offrira la possibilité de créer un raccourci sur le bureau pour le lanceur moddé. + +### Se connecter au MultiServer + +- Localisez le fichier "ArchipelagoConnectionInfo.json", qui se situe dans le même emplacement que votre installation moddée. Vous pouvez éditer ce fichier avec n'importe quel éditeur de texte, et vous devez entrer l'adresse IP du serveur, le port et votre nom de joueur dans les champs appropriés. + +- Exécutez BepInEx.NET.Framework.Launcher.exe. Si vous avez opté pour un raccourci sur le bureau, vous le trouverez avec une icône et un nom plus reconnaissable. +![image](https://i.imgur.com/ZUiFrhf.png) + +- Votre jeu devrait se lancer en même temps qu'une console de modloader, qui contiendra des informations de débogage importantes si vous rencontrez des problèmes. +- Le jeu devrait se connecter automatiquement, et tenter de se reconnecter si votre internet ou le serveur se déconnecte, pendant que vous jouez. + +### Interagir avec le MultiWorld depuis le jeu + +Vous ne pouvez pas envoyer de commandes au serveur ou discuter avec les autres joueurs depuis DLC Quest, car le jeu ne dispose pas d'un moyen approprié pour saisir du texte. +Vous pouvez suivre l'activité du serveur dans votre console BepInEx, car les messages de chat d'Archipelago y seront affichés. +Vous devrez utiliser [Archipelago Text Client] (https://github.com/ArchipelagoMW/Archipelago/releases) si vous voulez envoyer des commandes. \ No newline at end of file diff --git a/worlds/ffmq/Client.py b/worlds/ffmq/Client.py index c53f275017af..7de486314c6c 100644 --- a/worlds/ffmq/Client.py +++ b/worlds/ffmq/Client.py @@ -71,7 +71,7 @@ async def game_watcher(self, ctx): received = await snes_read(ctx, RECEIVED_DATA[0], RECEIVED_DATA[1]) data = await snes_read(ctx, READ_DATA_START, READ_DATA_END - READ_DATA_START) check_2 = await snes_read(ctx, 0xF53749, 1) - if check_1 == b'\x00' or check_2 == b'\x00': + if check_1 in (b'\x00', b'\x55') or check_2 in (b'\x00', b'\x55'): return def get_range(data_range): diff --git a/worlds/ffmq/Items.py b/worlds/ffmq/Items.py index 3eab5dd532a6..d0898d7e81c8 100644 --- a/worlds/ffmq/Items.py +++ b/worlds/ffmq/Items.py @@ -223,11 +223,6 @@ def yaml_item(text): def create_items(self) -> None: items = [] starting_weapon = self.multiworld.starting_weapon[self.player].current_key.title().replace("_", " ") - if self.multiworld.progressive_gear[self.player]: - for item_group in prog_map: - if starting_weapon in self.item_name_groups[item_group]: - starting_weapon = prog_map[item_group] - break self.multiworld.push_precollected(self.create_item(starting_weapon)) self.multiworld.push_precollected(self.create_item("Steel Armor")) if self.multiworld.sky_coin_mode[self.player] == "start_with": diff --git a/worlds/ffmq/docs/setup_en.md b/worlds/ffmq/docs/setup_en.md index 9d9088dbc232..61b8d7e306bf 100644 --- a/worlds/ffmq/docs/setup_en.md +++ b/worlds/ffmq/docs/setup_en.md @@ -2,7 +2,7 @@ ## Required Software -- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). Make sure to check the box for `SNI Client` +- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). - Hardware or software capable of loading and playing SNES ROM files - An emulator capable of connecting to SNI such as: @@ -19,8 +19,8 @@ The Archipelago community cannot supply you with this. ### Windows Setup -1. During the installation of Archipelago, you will have been asked to install the SNI Client. If you did not do this, - or you are on an older version, you may run the installer again to install the SNI Client. +1. Download and install [Archipelago](). **The installer + file is located in the assets section at the bottom of the version information.** 2. If you are using an emulator, you should assign your Lua capable emulator as your default program for launching ROM files. 1. Extract your emulator's folder to your Desktop, or somewhere you will remember. diff --git a/worlds/generic/docs/setup_en.md b/worlds/generic/docs/setup_en.md index 93ae217e0d33..b99cdbc0fe54 100644 --- a/worlds/generic/docs/setup_en.md +++ b/worlds/generic/docs/setup_en.md @@ -17,19 +17,22 @@ The most recent public release of Archipelago can be found on the GitHub Release Run the exe file, and after accepting the license agreement you will be asked which components you would like to install. -The generator allows you to generate multiworld games on your computer. The ROM setups are required if anyone in the -game that you generate wants to play any of those games as they are needed to generate the relevant patch files. If you -do not own the game, uncheck the relevant box. If you gain the game later, the installer can be run again to install and -set up new components. +Archipelago installations are automatically bundled with some programs. These include a launcher, a generator, a +server and some clients. -The server will allow you to host the multiworld on your machine. Hosting on your machine requires forwarding the port +- The launcher lets you quickly access Archipelago's different components and programs. It is found under the name + `ArchipelagoLauncher` and can be found in the main directory of your Archipelago installation. + +- The generator allows you to generate multiworld games on your computer. Please refer to the 'Generating a game' + section of this guide for more information about it. + +- The server will allow you to host the multiworld on your machine. Hosting on your machine requires forwarding the port you are hosting on. The default port for Archipelago is `38281`. If you are unsure how to do this there are plenty of other guides on the internet that will be more suited to your hardware. -The `Clients` are what are used to connect your game to the multiworld. If the game you plan to play is available -here, go ahead and install its client as well. If the game you choose to play is supported by Archipelago but not listed -in the installation, check the setup guide for that game. Installing a client for a ROM based game requires you to have -a legally obtained ROM for that game as well. +- The clients are what are used to connect your game to the multiworld. Some games use a client that is automatically +installed with an Archipelago installation. You can access those clients via the launcher or by navigating +to your Archipelago installation. ## Generating a game @@ -72,14 +75,18 @@ If you have downloaded the settings, or have created a settings file manually, t #### On your local installation -To generate a game on your local machine, make sure to install the Archipelago software, and ensure to select the -`Generator` component, as well as the `ROM setup` for any games you will want to play. Navigate to your Archipelago +To generate a game on your local machine, make sure to install the Archipelago software. Navigate to your Archipelago installation (usually C:\ProgramData\Archipelago), and place the settings file you have either created or downloaded from the website in the `Players` folder. -Run `ArchipelagoGenerate.exe`, and it will inform you whether the generation was successful or not. If successful, there -will be an output zip in the `output` folder (usually named something like `AP_XXXXX.zip`). This will contain all -relevant information to the session, including the spoiler log, if one was generated. +Run `ArchipelagoGenerate.exe`, or click on `Generate` in the launcher, and it will inform you whether the generation +was successful or not. If successful, there will be an output zip in the `output` folder +(usually named something like `AP_XXXXX.zip`). This will contain all relevant information to the session, including the +spoiler log, if one was generated. + +Please note that some games require you to own their ROM files to generate with them as they are needed to generate the +relevant patch files. When you generate with a ROM game for the first time, you will be asked to locate its base ROM file. +This step only needs to be done once. ### Generating a multiplayer game @@ -97,12 +104,9 @@ player name. #### On the website -Gather all player YAML files into a single place, and compress them into a zip file. This can be done by pressing -ctrl/cmd + clicking on each file until all are selected, right-clicking one of the files, and clicking -`compress to ZIP file` or `send to > compressed folder`. - -Navigate to the [Generate Page](/generate), select the host settings you would like, click on `Upload File`, and -select the newly created zip from the opened window. +Gather all player YAML files into a single place, then navigate to the [Generate Page](/generate). Select the host settings +you would like, click on `Upload File(s)`, and select all player YAML files. The site also accepts `zip` archives containing YAML +files. After some time, you will be redirected to a seed info page that will display the generated seed, the time it was created, the number of players, the spoiler (if one was created) and all rooms created from this seed. @@ -114,8 +118,11 @@ It is possible to generate the multiworld locally, using a local Archipelago ins Archipelago installation folder (usually C:\ProgramData\Archipelago) and placing each YAML file in the `Players` folder. If the folder does not exist then it must be created manually. The files here should not be compressed. -After filling the `Players` folder, the `ArchipelagoGenerate.exe` program should be run in order to generate a -multiworld. The output of this process is placed in the `output` folder (usually named something like `AP_XXXXX.zip`). +After filling the `Players` folder, run`ArchipelagoGenerate.exe` or click `Generate` in the launcher. The output of +the generation is placed in the `output` folder (usually named something like `AP_XXXXX.zip`). + +Please note that if any player in the game you want to generate plays a game that needs a ROM file to generate, you will +need the corresponding ROM files. ##### Changing local host settings for generation @@ -123,10 +130,12 @@ Sometimes there are various settings that you may want to change before rolling auto-release, plando support, or setting a password. All of these settings, plus other options, may be changed by modifying the `host.yaml` file in the Archipelago -installation folder. The settings chosen here are baked into the `.archipelago` file that gets output with the other -files after generation, so if you are rolling locally, ensure this file is edited to your liking **before** rolling the -seed. This file is overwritten when running the Archipelago Installation software. If you have changed settings in this -file, and would like to retain them, you may rename the file to `options.yaml`. +installation folder. You can quickly access this file by clicking on `Open host.yaml` in the launcher. The settings +chosen here are baked into the `.archipelago` file that gets output with the other files after generation, so if you +are rolling locally, ensure this file is edited to your liking **before** rolling the seed. This file is overwritten +when running the Archipelago Installation software. If you have changed settings in this file, and would like to retain +them, you may rename the file to `options.yaml`. + ## Hosting an Archipelago Server diff --git a/worlds/hk/ExtractedData.py b/worlds/hk/ExtractedData.py index cf796050e47f..0cbbc8bf8558 100644 --- a/worlds/hk/ExtractedData.py +++ b/worlds/hk/ExtractedData.py @@ -3,7 +3,7 @@ connectors = {'Room_temple[left1]': 'Crossroads_02[door1]', 'Tutorial_01[right1]': 'Town[left1]', 'Tutorial_01[top1]': None, 'Tutorial_01[top2]': 'Cliffs_02[bot1]', 'Town[left1]': 'Tutorial_01[right1]', 'Town[bot1]': 'Crossroads_01[top1]', 'Town[right1]': 'Mines_10[left1]', 'Town[top1]': None, 'Town[door_station]': 'Room_Town_Stag_Station[left1]', 'Town[door_sly]': 'Room_shop[left1]', 'Town[door_mapper]': 'Room_mapper[left1]', 'Town[door_jiji]': 'Room_Ouiji[left1]', 'Town[door_bretta]': 'Room_Bretta[right1]', 'Town[room_divine]': 'Grimm_Divine[left1]', 'Town[room_grimm]': 'Grimm_Main_Tent[left1]', 'Room_shop[left1]': 'Town[door_sly]', 'Room_Town_Stag_Station[left1]': 'Town[door_station]', 'Room_mapper[left1]': 'Town[door_mapper]', 'Room_Bretta[right1]': 'Town[door_bretta]', 'Room_Ouiji[left1]': 'Town[door_jiji]', 'Grimm_Divine[left1]': 'Town[room_divine]', 'Grimm_Main_Tent[left1]': 'Town[room_grimm]', 'Crossroads_01[top1]': 'Town[bot1]', 'Crossroads_01[left1]': 'Crossroads_07[right1]', 'Crossroads_01[right1]': 'Crossroads_02[left1]', 'Crossroads_02[left1]': 'Crossroads_01[right1]', 'Crossroads_02[door1]': 'Room_temple[left1]', 'Crossroads_02[right1]': 'Crossroads_39[left1]', 'Crossroads_03[right1]': 'Crossroads_15[left1]', 'Crossroads_03[right2]': 'Mines_33[left1]', 'Crossroads_03[left1]': 'Crossroads_21[right1]', 'Crossroads_03[left2]': 'Crossroads_47[right1]', 'Crossroads_03[bot1]': 'Crossroads_19[top1]', 'Crossroads_03[top1]': 'Crossroads_16[bot1]', 'Crossroads_04[left1]': 'Crossroads_19[right1]', 'Crossroads_04[top1]': 'Crossroads_27[bot1]', 'Crossroads_04[door_Mender_House]': 'Room_Mender_House[left1]', 'Crossroads_04[door1]': 'Room_ruinhouse[left1]', 'Crossroads_04[door_charmshop]': 'Room_Charm_Shop[left1]', 'Crossroads_04[right1]': 'Crossroads_50[left1]', 'Crossroads_05[left1]': 'Crossroads_07[right2]', 'Crossroads_05[right1]': 'Crossroads_40[left1]', 'Crossroads_06[left1]': 'Crossroads_33[right1]', 'Crossroads_06[door1]': 'Crossroads_ShamanTemple[left1]', 'Crossroads_06[right1]': 'Crossroads_10[left1]', 'Crossroads_07[left1]': 'Crossroads_38[right1]', 'Crossroads_07[left2]': 'Crossroads_11_alt[right1]', 'Crossroads_07[left3]': 'Crossroads_25[right1]', 'Crossroads_07[right1]': 'Crossroads_01[left1]', 'Crossroads_07[right2]': 'Crossroads_05[left1]', 'Crossroads_07[bot1]': 'Crossroads_33[top1]', 'Crossroads_08[left1]': 'Crossroads_33[right2]', 'Crossroads_08[left2]': 'Crossroads_18[right1]', 'Crossroads_08[right1]': 'Crossroads_30[left1]', 'Crossroads_08[right2]': 'Crossroads_13[left1]', 'Crossroads_09[left1]': 'Crossroads_36[right2]', 'Crossroads_09[right1]': 'Crossroads_33[left1]', 'Crossroads_10[left1]': 'Crossroads_06[right1]', 'Crossroads_10[right1]': 'Crossroads_21[left1]', 'Crossroads_11_alt[left1]': 'Fungus1_01[right1]', 'Crossroads_11_alt[right1]': 'Crossroads_07[left2]', 'Crossroads_12[left1]': 'Crossroads_35[right1]', 'Crossroads_12[right1]': 'Crossroads_33[left2]', 'Crossroads_13[left1]': 'Crossroads_08[right2]', 'Crossroads_13[right1]': 'Crossroads_42[left1]', 'Crossroads_14[left1]': 'Crossroads_39[right1]', 'Crossroads_14[left2]': 'Crossroads_16[right1]', 'Crossroads_14[right1]': 'Crossroads_48[left1]', 'Crossroads_14[right2]': 'Crossroads_45[left1]', 'Crossroads_15[left1]': 'Crossroads_03[right1]', 'Crossroads_15[right1]': 'Crossroads_27[left1]', 'Crossroads_16[left1]': 'Crossroads_40[right1]', 'Crossroads_16[right1]': 'Crossroads_14[left2]', 'Crossroads_16[bot1]': 'Crossroads_03[top1]', 'Crossroads_18[right1]': 'Crossroads_08[left2]', 'Crossroads_18[right2]': 'Crossroads_52[left1]', 'Crossroads_18[bot1]': 'Fungus2_06[top1]', 'Crossroads_19[right1]': 'Crossroads_04[left1]', 'Crossroads_19[top1]': 'Crossroads_03[bot1]', 'Crossroads_19[left1]': 'Crossroads_42[right1]', 'Crossroads_19[left2]': 'Crossroads_43[right1]', 'Crossroads_21[left1]': 'Crossroads_10[right1]', 'Crossroads_21[right1]': 'Crossroads_03[left1]', 'Crossroads_21[top1]': 'Crossroads_22[bot1]', 'Crossroads_22[bot1]': 'Crossroads_21[top1]', 'Crossroads_25[right1]': 'Crossroads_07[left3]', 'Crossroads_25[left1]': 'Crossroads_36[right1]', 'Crossroads_27[right1]': 'Crossroads_46[left1]', 'Crossroads_27[bot1]': 'Crossroads_04[top1]', 'Crossroads_27[left1]': 'Crossroads_15[right1]', 'Crossroads_27[left2]': 'Crossroads_31[right1]', 'Crossroads_30[left1]': 'Crossroads_08[right1]', 'Crossroads_31[right1]': 'Crossroads_27[left2]', 'Crossroads_33[top1]': 'Crossroads_07[bot1]', 'Crossroads_33[left1]': 'Crossroads_09[right1]', 'Crossroads_33[left2]': 'Crossroads_12[right1]', 'Crossroads_33[right1]': 'Crossroads_06[left1]', 'Crossroads_33[right2]': 'Crossroads_08[left1]', 'Crossroads_35[bot1]': 'Fungus3_26[top1]', 'Crossroads_35[right1]': 'Crossroads_12[left1]', 'Crossroads_36[right1]': 'Crossroads_25[left1]', 'Crossroads_36[right2]': 'Crossroads_09[left1]', 'Crossroads_37[right1]': 'Crossroads_49[left1]', 'Crossroads_38[right1]': 'Crossroads_07[left1]', 'Crossroads_39[right1]': 'Crossroads_14[left1]', 'Crossroads_39[left1]': 'Crossroads_02[right1]', 'Crossroads_40[right1]': 'Crossroads_16[left1]', 'Crossroads_40[left1]': 'Crossroads_05[right1]', 'Crossroads_42[left1]': 'Crossroads_13[right1]', 'Crossroads_42[right1]': 'Crossroads_19[left1]', 'Crossroads_43[left1]': 'Crossroads_49[right1]', 'Crossroads_43[right1]': 'Crossroads_19[left2]', 'Crossroads_45[right1]': 'Mines_01[left1]', 'Crossroads_45[left1]': 'Crossroads_14[right2]', 'Crossroads_46[left1]': 'Crossroads_27[right1]', 'Crossroads_46b[right1]': 'RestingGrounds_02[left1]', 'Crossroads_ShamanTemple[left1]': 'Crossroads_06[door1]', 'Crossroads_47[right1]': 'Crossroads_03[left2]', 'Crossroads_48[left1]': 'Crossroads_14[right1]', 'Crossroads_49[right1]': 'Crossroads_43[left1]', 'Crossroads_49[left1]': 'Crossroads_37[right1]', 'Crossroads_49b[right1]': 'Ruins1_28[left1]', 'Crossroads_50[right1]': 'RestingGrounds_06[left1]', 'Crossroads_50[left1]': 'Crossroads_04[right1]', 'Crossroads_52[left1]': 'Crossroads_18[right2]', 'Room_ruinhouse[left1]': 'Crossroads_04[door1]', 'Room_Charm_Shop[left1]': 'Crossroads_04[door_charmshop]', 'Room_Mender_House[left1]': 'Crossroads_04[door_Mender_House]', 'Fungus1_01[left1]': 'Fungus1_01b[right1]', 'Fungus1_01[right1]': 'Crossroads_11_alt[left1]', 'Fungus1_01b[left1]': 'Fungus1_02[right1]', 'Fungus1_01b[right1]': 'Fungus1_01[left1]', 'Fungus1_02[left1]': 'Fungus1_17[right1]', 'Fungus1_02[right1]': 'Fungus1_01b[left1]', 'Fungus1_02[right2]': 'Fungus1_06[left1]', 'Fungus1_03[left1]': 'Fungus1_31[right1]', 'Fungus1_03[right1]': 'Fungus1_17[left1]', 'Fungus1_03[bot1]': 'Fungus1_05[top1]', 'Fungus1_04[left1]': 'Fungus1_25[right1]', 'Fungus1_04[right1]': 'Fungus1_21[left1]', 'Fungus1_05[right1]': 'Fungus1_14[left1]', 'Fungus1_05[bot1]': 'Fungus1_10[top1]', 'Fungus1_05[top1]': 'Fungus1_03[bot1]', 'Fungus1_06[left1]': 'Fungus1_02[right2]', 'Fungus1_06[bot1]': 'Fungus1_07[top1]', 'Fungus1_07[top1]': 'Fungus1_06[bot1]', 'Fungus1_07[left1]': 'Fungus1_19[right1]', 'Fungus1_07[right1]': 'Fungus1_08[left1]', 'Fungus1_08[left1]': 'Fungus1_07[right1]', 'Fungus1_09[left1]': 'Fungus1_15[right1]', 'Fungus1_09[right1]': 'Fungus1_30[left1]', 'Fungus1_10[left1]': 'Fungus1_30[right1]', 'Fungus1_10[right1]': 'Fungus1_19[left1]', 'Fungus1_10[top1]': 'Fungus1_05[bot1]', 'Fungus1_11[top1]': 'Fungus1_19[bot1]', 'Fungus1_11[right1]': 'Fungus1_34[left1]', 'Fungus1_11[right2]': 'Fungus1_37[left1]', 'Fungus1_11[left1]': 'Fungus1_29[right1]', 'Fungus1_11[bot1]': 'Fungus3_01[top1]', 'Fungus1_12[left1]': 'Fungus1_13[right1]', 'Fungus1_12[right1]': 'Fungus1_29[left1]', 'Fungus1_13[right1]': 'Fungus1_12[left1]', 'Fungus1_13[left1]': 'Fungus3_22[right1]', 'Fungus1_14[left1]': 'Fungus1_05[right1]', 'Fungus1_15[door1]': 'Room_nailmaster_02[left1]', 'Fungus1_15[right1]': 'Fungus1_09[left1]', 'Fungus1_16_alt[right1]': 'Fungus1_22[left1]', 'Fungus1_17[left1]': 'Fungus1_03[right1]', 'Fungus1_17[right1]': 'Fungus1_02[left1]', 'Fungus1_19[left1]': 'Fungus1_10[right1]', 'Fungus1_19[right1]': 'Fungus1_07[left1]', 'Fungus1_19[bot1]': 'Fungus1_11[top1]', 'Fungus1_20_v02[bot1]': 'Fungus1_21[top1]', 'Fungus1_20_v02[bot2]': 'Fungus1_32[top1]', 'Fungus1_20_v02[right1]': 'Fungus1_28[left2]', 'Fungus1_21[bot1]': 'Fungus1_22[top1]', 'Fungus1_21[top1]': 'Fungus1_20_v02[bot1]', 'Fungus1_21[left1]': 'Fungus1_04[right1]', 'Fungus1_21[right1]': 'Fungus1_32[left1]', 'Fungus1_22[bot1]': 'Fungus1_30[top1]', 'Fungus1_22[top1]': 'Fungus1_21[bot1]', 'Fungus1_22[left1]': 'Fungus1_16_alt[right1]', 'Fungus1_23[left1]': 'Fungus3_48[right2]', 'Fungus1_23[right1]': 'Fungus3_13[left1]', 'Fungus1_24[left1]': 'Fungus3_05[right1]', 'Fungus1_25[right1]': 'Fungus1_04[left1]', 'Fungus1_25[left1]': 'Fungus1_26[right1]', 'Fungus1_26[right1]': 'Fungus1_25[left1]', 'Fungus1_26[left1]': 'Fungus1_Slug[right1]', 'Fungus1_26[door_SlugShrine]': 'Room_Slug_Shrine[left1]', 'Fungus1_28[left1]': 'Cliffs_01[right3]', 'Fungus1_28[left2]': 'Fungus1_20_v02[right1]', 'Fungus1_29[left1]': 'Fungus1_12[right1]', 'Fungus1_29[right1]': 'Fungus1_11[left1]', 'Fungus1_30[top1]': 'Fungus1_22[bot1]', 'Fungus1_30[top3]': 'Fungus1_31[bot1]', 'Fungus1_30[left1]': 'Fungus1_09[right1]', 'Fungus1_30[right1]': 'Fungus1_10[left1]', 'Fungus1_31[top1]': 'Fungus1_32[bot1]', 'Fungus1_31[bot1]': 'Fungus1_30[top3]', 'Fungus1_31[right1]': 'Fungus1_03[left1]', 'Fungus1_32[bot1]': 'Fungus1_31[top1]', 'Fungus1_32[top1]': 'Fungus1_20_v02[bot2]', 'Fungus1_32[left1]': 'Fungus1_21[right1]', 'Fungus1_34[door1]': 'Fungus1_35[left1]', 'Fungus1_34[left1]': 'Fungus1_11[right1]', 'Fungus1_35[left1]': 'Fungus1_34[door1]', 'Fungus1_35[right1]': 'Fungus1_36[left1]', 'Fungus1_36[left1]': 'Fungus1_35[right1]', 'Fungus1_37[left1]': 'Fungus1_11[right2]', 'Fungus1_Slug[right1]': 'Fungus1_26[left1]', 'Room_Slug_Shrine[left1]': 'Fungus1_26[door_SlugShrine]', 'Room_nailmaster_02[left1]': 'Fungus1_15[door1]', 'Fungus3_01[top1]': 'Fungus1_11[bot1]', 'Fungus3_01[right1]': 'Fungus3_25[left1]', 'Fungus3_01[left1]': 'Fungus3_24[right1]', 'Fungus3_01[right2]': 'Fungus3_02[left1]', 'Fungus3_02[left1]': 'Fungus3_01[right2]', 'Fungus3_02[left2]': 'Fungus3_03[right1]', 'Fungus3_02[left3]': 'Fungus3_35[right1]', 'Fungus3_02[right1]': 'Fungus3_47[left1]', 'Fungus3_02[right2]': 'Fungus2_01[left1]', 'Fungus3_03[right1]': 'Fungus3_02[left2]', 'Fungus3_03[left1]': 'Fungus3_34[right1]', 'Fungus3_24[right1]': 'Fungus3_01[left1]', 'Fungus3_24[left1]': 'Fungus3_44[right1]', 'Fungus3_24[top1]': 'Fungus3_30[bot1]', 'Fungus3_25[right1]': 'Fungus3_25b[left1]', 'Fungus3_25[left1]': 'Fungus3_01[right1]', 'Fungus3_25b[right1]': 'Fungus3_26[left2]', 'Fungus3_25b[left1]': 'Fungus3_25[right1]', 'Fungus3_26[top1]': 'Crossroads_35[bot1]', 'Fungus3_26[left1]': 'Fungus3_28[right1]', 'Fungus3_26[left2]': 'Fungus3_25b[right1]', 'Fungus3_26[left3]': 'Fungus3_27[right1]', 'Fungus3_26[right1]': 'Fungus2_33[left1]', 'Fungus3_27[left1]': 'Fungus3_47[right1]', 'Fungus3_27[right1]': 'Fungus3_26[left3]', 'Fungus3_28[right1]': 'Fungus3_26[left1]', 'Fungus3_30[bot1]': 'Fungus3_24[top1]', 'Fungus3_35[right1]': 'Fungus3_02[left3]', 'Fungus3_44[bot1]': 'Fungus3_34[top1]', 'Fungus3_44[door1]': 'Room_Fungus_Shaman[left1]', 'Fungus3_44[right1]': 'Fungus3_24[left1]', 'Fungus3_47[left1]': 'Fungus3_02[right1]', 'Fungus3_47[right1]': 'Fungus3_27[left1]', 'Fungus3_47[door1]': 'Fungus3_archive[left1]', 'Room_Fungus_Shaman[left1]': 'Fungus3_44[door1]', 'Fungus3_archive[left1]': 'Fungus3_47[door1]', 'Fungus3_archive[bot1]': 'Fungus3_archive_02[top1]', 'Fungus3_archive_02[top1]': 'Fungus3_archive[bot1]', 'Fungus2_01[left1]': 'Fungus3_02[right2]', 'Fungus2_01[left2]': 'Fungus2_02[right1]', 'Fungus2_01[left3]': 'Fungus2_34[right1]', 'Fungus2_01[right1]': 'Fungus2_03[left1]', 'Fungus2_02[right1]': 'Fungus2_01[left2]', 'Fungus2_34[right1]': 'Fungus2_01[left3]', 'Fungus2_03[left1]': 'Fungus2_01[right1]', 'Fungus2_03[bot1]': 'Fungus2_18[top1]', 'Fungus2_03[right1]': 'Fungus2_04[left1]', 'Fungus2_04[top1]': 'Fungus2_05[bot1]', 'Fungus2_04[right1]': 'Fungus2_28[left1]', 'Fungus2_04[left1]': 'Fungus2_03[right1]', 'Fungus2_04[right2]': 'Fungus2_28[left2]', 'Fungus2_05[bot1]': 'Fungus2_04[top1]', 'Fungus2_05[right1]': 'Fungus2_06[left1]', 'Fungus2_06[top1]': 'Crossroads_18[bot1]', 'Fungus2_06[left1]': 'Fungus2_05[right1]', 'Fungus2_06[left2]': 'Fungus2_33[right1]', 'Fungus2_06[right1]': 'Fungus2_26[left1]', 'Fungus2_06[right2]': 'Fungus2_07[left1]', 'Fungus2_07[left1]': 'Fungus2_06[right2]', 'Fungus2_07[right1]': 'Fungus2_08[left1]', 'Fungus2_08[left1]': 'Fungus2_07[right1]', 'Fungus2_08[left2]': 'Fungus2_09[right1]', 'Fungus2_08[right1]': 'Fungus2_32[left1]', 'Fungus2_09[left1]': 'Fungus2_10[right1]', 'Fungus2_09[right1]': 'Fungus2_08[left2]', 'Fungus2_10[right1]': 'Fungus2_09[left1]', 'Fungus2_10[right2]': 'Fungus2_21[left1]', 'Fungus2_10[bot1]': 'Fungus2_11[top1]', 'Fungus2_11[top1]': 'Fungus2_10[bot1]', 'Fungus2_11[left1]': 'Fungus2_18[right1]', 'Fungus2_11[left2]': 'Fungus2_17[right1]', 'Fungus2_11[right1]': 'Fungus2_12[left1]', 'Fungus2_12[left1]': 'Fungus2_11[right1]', 'Fungus2_12[bot1]': 'Fungus2_13[top1]', 'Fungus2_13[top1]': 'Fungus2_12[bot1]', 'Fungus2_13[left2]': 'Fungus2_14[right1]', 'Fungus2_13[left3]': 'Fungus2_23[right1]', 'Fungus2_14[top1]': 'Fungus2_17[bot1]', 'Fungus2_14[right1]': 'Fungus2_13[left2]', 'Fungus2_14[bot3]': 'Fungus2_15[top3]', 'Fungus2_15[top3]': 'Fungus2_14[bot3]', 'Fungus2_15[right1]': 'Fungus2_31[left1]', 'Fungus2_15[left1]': 'Fungus2_25[right1]', 'Fungus2_17[left1]': 'Fungus2_29[right1]', 'Fungus2_17[right1]': 'Fungus2_11[left2]', 'Fungus2_17[bot1]': 'Fungus2_14[top1]', 'Fungus2_18[right1]': 'Fungus2_11[left1]', 'Fungus2_18[bot1]': 'Fungus2_19[top1]', 'Fungus2_18[top1]': 'Fungus2_03[bot1]', 'Fungus2_19[top1]': 'Fungus2_18[bot1]', 'Fungus2_19[left1]': 'Fungus2_20[right1]', 'Fungus2_20[right1]': 'Fungus2_19[left1]', 'Fungus2_20[left1]': 'Deepnest_01[right1]', 'Fungus2_21[right1]': 'Ruins1_01[left1]', 'Fungus2_21[left1]': 'Fungus2_10[right2]', 'Fungus2_23[right1]': 'Fungus2_13[left3]', 'Fungus2_23[right2]': 'Waterways_09[left1]', 'Fungus2_26[left1]': 'Fungus2_06[right1]', 'Fungus2_28[left1]': 'Fungus2_04[right1]', 'Fungus2_28[left2]': 'Fungus2_04[right2]', 'Fungus2_29[right1]': 'Fungus2_17[left1]', 'Fungus2_29[bot1]': 'Fungus2_30[top1]', 'Fungus2_30[bot1]': 'Fungus2_25[top2]', 'Fungus2_30[top1]': 'Fungus2_29[bot1]', 'Fungus2_31[left1]': 'Fungus2_15[right1]', 'Fungus2_32[left1]': 'Fungus2_08[right1]', 'Fungus2_33[right1]': 'Fungus2_06[left2]', 'Fungus2_33[left1]': 'Fungus3_26[right1]', 'Deepnest_01[right1]': 'Fungus2_20[left1]', 'Deepnest_01[bot1]': 'Deepnest_01b[top1]', 'Deepnest_01[bot2]': 'Deepnest_01b[top2]', 'Deepnest_01[left1]': 'Fungus3_39[right1]', 'Deepnest_01b[top1]': 'Deepnest_01[bot1]', 'Deepnest_01b[top2]': None, 'Deepnest_01b[right1]': 'Deepnest_02[left1]', 'Deepnest_01b[right2]': 'Deepnest_02[left2]', 'Deepnest_01b[bot1]': 'Deepnest_17[top1]', 'Deepnest_02[left1]': 'Deepnest_01b[right1]', 'Deepnest_02[left2]': 'Deepnest_01b[right2]', 'Deepnest_02[right1]': 'Deepnest_36[left1]', 'Deepnest_03[right1]': 'Deepnest_30[left1]', 'Deepnest_03[left1]': 'Deepnest_34[right1]', 'Deepnest_03[top1]': 'Deepnest_33[bot1]', 'Deepnest_03[left2]': 'Deepnest_31[right1]', 'Deepnest_09[left1]': 'Deepnest_10[right1]', 'Deepnest_10[right1]': 'Deepnest_09[left1]', 'Deepnest_10[right2]': 'Deepnest_41[left1]', 'Deepnest_10[right3]': 'Deepnest_41[left2]', 'Deepnest_10[door1]': 'Deepnest_Spider_Town[left1]', 'Deepnest_10[door2]': 'Room_spider_small[left1]', 'Room_spider_small[left1]': 'Deepnest_10[door2]', 'Deepnest_Spider_Town[left1]': 'Deepnest_10[door1]', 'Deepnest_14[right1]': 'Deepnest_17[left1]', 'Deepnest_14[left1]': 'Deepnest_26[right1]', 'Deepnest_14[bot1]': 'Deepnest_33[top1]', 'Deepnest_14[bot2]': 'Deepnest_33[top2]', 'Deepnest_16[left1]': 'Deepnest_17[right1]', 'Deepnest_16[bot1]': 'Fungus2_25[top1]', 'Deepnest_17[left1]': 'Deepnest_14[right1]', 'Deepnest_17[right1]': 'Deepnest_16[left1]', 'Deepnest_17[top1]': 'Deepnest_01b[bot1]', 'Deepnest_17[bot1]': 'Deepnest_30[top1]', 'Fungus2_25[top1]': 'Deepnest_16[bot1]', 'Fungus2_25[top2]': None, 'Fungus2_25[right1]': 'Fungus2_15[left1]', 'Deepnest_26[left1]': 'Deepnest_26b[right1]', 'Deepnest_26[left2]': 'Deepnest_26b[right2]', 'Deepnest_26[right1]': 'Deepnest_14[left1]', 'Deepnest_26[bot1]': 'Deepnest_35[top1]', 'Deepnest_26b[right2]': 'Deepnest_26[left2]', 'Deepnest_26b[right1]': 'Deepnest_26[left1]', 'Deepnest_30[left1]': 'Deepnest_03[right1]', 'Deepnest_30[top1]': 'Deepnest_17[bot1]', 'Deepnest_30[right1]': 'Deepnest_37[left1]', 'Deepnest_31[right1]': 'Deepnest_03[left2]', 'Deepnest_31[right2]': 'Deepnest_32[left1]', 'Deepnest_32[left1]': 'Deepnest_31[right2]', 'Deepnest_33[top1]': 'Deepnest_14[bot1]', 'Deepnest_33[top2]': 'Deepnest_14[bot2]', 'Deepnest_33[bot1]': 'Deepnest_03[top1]', 'Deepnest_34[left1]': 'Deepnest_39[right1]', 'Deepnest_34[right1]': 'Deepnest_03[left1]', 'Deepnest_34[top1]': 'Deepnest_35[bot1]', 'Deepnest_35[left1]': 'Deepnest_40[right1]', 'Deepnest_35[top1]': 'Deepnest_26[bot1]', 'Deepnest_35[bot1]': 'Deepnest_34[top1]', 'Deepnest_36[left1]': 'Deepnest_02[right1]', 'Deepnest_37[left1]': 'Deepnest_30[right1]', 'Deepnest_37[right1]': 'Abyss_03_b[left1]', 'Deepnest_37[top1]': 'Deepnest_38[bot1]', 'Deepnest_37[bot1]': 'Deepnest_44[top1]', 'Deepnest_38[bot1]': 'Deepnest_37[top1]', 'Deepnest_39[left1]': 'Deepnest_41[right1]', 'Deepnest_39[top1]': 'Deepnest_42[bot1]', 'Deepnest_39[door1]': 'Deepnest_45_v02[left1]', 'Deepnest_39[right1]': 'Deepnest_34[left1]', 'Deepnest_40[right1]': 'Deepnest_35[left1]', 'Deepnest_41[right1]': 'Deepnest_39[left1]', 'Deepnest_41[left1]': 'Deepnest_10[right2]', 'Deepnest_41[left2]': 'Deepnest_10[right3]', 'Deepnest_42[bot1]': 'Deepnest_39[top1]', 'Deepnest_42[left1]': 'Room_Mask_Maker[right1]', 'Deepnest_42[top1]': 'Deepnest_43[bot1]', 'Deepnest_43[bot1]': 'Deepnest_42[top1]', 'Deepnest_43[left1]': 'Fungus3_50[right1]', 'Deepnest_43[right1]': 'Fungus3_08[left1]', 'Deepnest_44[top1]': 'Deepnest_37[bot1]', 'Deepnest_45_v02[left1]': 'Deepnest_39[door1]', 'Room_Mask_Maker[right1]': 'Deepnest_42[left1]', 'Deepnest_East_01[bot1]': 'Abyss_03_c[top1]', 'Deepnest_East_01[right1]': 'Hive_03_c[left1]', 'Deepnest_East_01[top1]': 'Deepnest_East_02[bot1]', 'Deepnest_East_02[bot1]': 'Deepnest_East_01[top1]', 'Deepnest_East_02[bot2]': 'Hive_03[top1]', 'Deepnest_East_02[top1]': 'Waterways_14[bot2]', 'Deepnest_East_02[right1]': 'Deepnest_East_03[left2]', 'Deepnest_East_03[left1]': 'Ruins2_07[right1]', 'Deepnest_East_03[left2]': 'Deepnest_East_02[right1]', 'Deepnest_East_03[top1]': 'Deepnest_East_07[bot1]', 'Deepnest_East_03[top2]': None, 'Deepnest_East_03[right1]': 'Deepnest_East_04[left1]', 'Deepnest_East_03[right2]': 'Deepnest_East_06[left1]', 'Deepnest_East_04[left1]': 'Deepnest_East_03[right1]', 'Deepnest_East_04[left2]': 'Deepnest_East_07[right1]', 'Deepnest_East_04[right2]': 'Deepnest_East_15[left1]', 'Deepnest_East_04[right1]': 'Deepnest_East_11[left1]', 'Deepnest_East_06[top1]': 'Deepnest_East_18[bot1]', 'Deepnest_East_06[left1]': 'Deepnest_East_03[right2]', 'Deepnest_East_06[bot1]': 'Deepnest_East_14b[top1]', 'Deepnest_East_06[door1]': 'Room_nailmaster_03[left1]', 'Deepnest_East_06[right1]': 'Deepnest_East_16[left1]', 'Deepnest_East_07[bot1]': 'Deepnest_East_03[top1]', 'Deepnest_East_07[bot2]': 'Deepnest_East_03[top2]', 'Deepnest_East_07[left1]': 'Deepnest_East_08[right1]', 'Deepnest_East_07[left2]': 'Ruins2_11_b[right1]', 'Deepnest_East_07[right1]': 'Deepnest_East_04[left2]', 'Deepnest_East_08[right1]': 'Deepnest_East_07[left1]', 'Deepnest_East_08[top1]': 'Deepnest_East_09[bot1]', 'Deepnest_East_09[right1]': 'Room_Colosseum_01[left1]', 'Deepnest_East_09[left1]': 'Ruins2_10b[right1]', 'Deepnest_East_09[bot1]': 'Deepnest_East_08[top1]', 'Deepnest_East_10[left1]': 'Deepnest_East_18[right2]', 'Deepnest_East_11[right1]': 'Deepnest_East_12[left1]', 'Deepnest_East_11[left1]': 'Deepnest_East_04[right1]', 'Deepnest_East_11[top1]': 'Deepnest_East_13[bot1]', 'Deepnest_East_11[bot1]': 'Deepnest_East_18[top1]', 'Deepnest_East_12[right1]': 'Deepnest_East_Hornet[left1]', 'Deepnest_East_12[left1]': 'Deepnest_East_11[right1]', 'Deepnest_East_13[bot1]': 'Deepnest_East_11[top1]', 'Deepnest_East_14[top2]': 'Deepnest_East_16[bot1]', 'Deepnest_East_14[left1]': 'Deepnest_East_14b[right1]', 'Deepnest_East_14[door1]': 'Deepnest_East_17[left1]', 'Deepnest_East_14b[right1]': 'Deepnest_East_14[left1]', 'Deepnest_East_14b[top1]': 'Deepnest_East_06[bot1]', 'Deepnest_East_15[left1]': 'Deepnest_East_04[right2]', 'Deepnest_East_16[left1]': 'Deepnest_East_06[right1]', 'Deepnest_East_16[bot1]': 'Deepnest_East_14[top2]', 'Deepnest_East_17[left1]': 'Deepnest_East_14[door1]', 'Deepnest_East_18[top1]': 'Deepnest_East_11[bot1]', 'Deepnest_East_18[bot1]': 'Deepnest_East_06[top1]', 'Deepnest_East_18[right2]': 'Deepnest_East_10[left1]', 'Room_nailmaster_03[left1]': 'Deepnest_East_06[door1]', 'Deepnest_East_Hornet[left1]': 'Deepnest_East_12[right1]', 'Deepnest_East_Hornet[left2]': 'Room_Wyrm[right1]', 'Room_Wyrm[right1]': 'Deepnest_East_Hornet[left2]', 'GG_Lurker[left1]': 'Room_Colosseum_Spectate[right1]', 'Hive_01[left1]': 'Abyss_03_c[right1]', 'Hive_01[right1]': 'Hive_02[left2]', 'Hive_01[right2]': 'Hive_02[left3]', 'Hive_02[left1]': 'Hive_03_c[right3]', 'Hive_02[left2]': 'Hive_01[right1]', 'Hive_02[left3]': 'Hive_01[right2]', 'Hive_03_c[left1]': 'Deepnest_East_01[right1]', 'Hive_03_c[right2]': 'Hive_04[left2]', 'Hive_03_c[right3]': 'Hive_02[left1]', 'Hive_03_c[top1]': 'Hive_03[bot1]', 'Hive_03[bot1]': 'Hive_03_c[top1]', 'Hive_03[right1]': 'Hive_04[left1]', 'Hive_03[top1]': 'Deepnest_East_02[bot2]', 'Hive_04[left1]': 'Hive_03[right1]', 'Hive_04[left2]': 'Hive_03_c[right2]', 'Hive_04[right1]': 'Hive_05[left1]', 'Hive_05[left1]': 'Hive_04[right1]', 'Room_Colosseum_01[left1]': 'Deepnest_East_09[right1]', 'Room_Colosseum_01[bot1]': 'Room_Colosseum_02[top1]', 'Room_Colosseum_02[top1]': 'Room_Colosseum_01[bot1]', 'Room_Colosseum_02[top2]': 'Room_Colosseum_Spectate[bot1]', 'Room_Colosseum_Spectate[bot1]': 'Room_Colosseum_02[top2]', 'Room_Colosseum_Spectate[right1]': 'GG_Lurker[left1]', 'Abyss_01[left1]': 'Waterways_05[right1]', 'Abyss_01[left2]': 'Waterways_06[right1]', 'Abyss_01[left3]': 'Abyss_02[right1]', 'Abyss_01[right1]': 'Ruins2_04[left2]', 'Abyss_01[right2]': 'Waterways_07[left1]', 'Abyss_02[right1]': 'Abyss_01[left3]', 'Abyss_02[bot1]': 'Abyss_03[top1]', 'Abyss_03[bot1]': 'Abyss_17[top1]', 'Abyss_03[bot2]': 'Abyss_04[top1]', 'Abyss_03[top1]': 'Abyss_02[bot1]', 'Abyss_03_b[left1]': 'Deepnest_37[right1]', 'Abyss_03_c[right1]': 'Hive_01[left1]', 'Abyss_03_c[top1]': 'Deepnest_East_01[bot1]', 'Abyss_04[top1]': 'Abyss_03[bot2]', 'Abyss_04[left1]': 'Abyss_18[right1]', 'Abyss_04[bot1]': 'Abyss_06_Core[top1]', 'Abyss_04[right1]': 'Abyss_05[left1]', 'Abyss_05[left1]': 'Abyss_04[right1]', 'Abyss_05[right1]': 'Abyss_22[left1]', 'Abyss_06_Core[top1]': 'Abyss_04[bot1]', 'Abyss_06_Core[left1]': 'Abyss_08[right1]', 'Abyss_06_Core[left3]': 'Abyss_12[right1]', 'Abyss_06_Core[right2]': 'Abyss_16[left1]', 'Abyss_06_Core[bot1]': 'Abyss_15[top1]', 'Abyss_08[right1]': 'Abyss_06_Core[left1]', 'Abyss_09[right1]': 'Abyss_10[left1]', 'Abyss_09[right2]': 'Abyss_Lighthouse_room[left1]', 'Abyss_09[right3]': 'Abyss_10[left2]', 'Abyss_09[left1]': 'Abyss_16[right1]', 'Abyss_10[left1]': 'Abyss_09[right1]', 'Abyss_10[left2]': 'Abyss_09[right3]', 'Abyss_12[right1]': 'Abyss_06_Core[left3]', 'Abyss_15[top1]': 'Abyss_06_Core[bot1]', 'Abyss_16[left1]': 'Abyss_06_Core[right2]', 'Abyss_16[right1]': 'Abyss_09[left1]', 'Abyss_17[top1]': 'Abyss_03[bot1]', 'Abyss_18[left1]': 'Abyss_19[right1]', 'Abyss_18[right1]': 'Abyss_04[left1]', 'Abyss_19[left1]': 'Abyss_21[right1]', 'Abyss_19[right1]': 'Abyss_18[left1]', 'Abyss_19[bot1]': 'Abyss_20[top1]', 'Abyss_19[bot2]': 'Abyss_20[top2]', 'Abyss_20[top1]': 'Abyss_19[bot1]', 'Abyss_20[top2]': 'Abyss_19[bot2]', 'Abyss_21[right1]': 'Abyss_19[left1]', 'Abyss_22[left1]': 'Abyss_05[right1]', 'Abyss_Lighthouse_room[left1]': 'Abyss_09[right2]', 'Waterways_01[top1]': 'Ruins1_05b[bot1]', 'Waterways_01[left1]': 'Waterways_04[right1]', 'Waterways_01[right1]': 'Waterways_03[left1]', 'Waterways_01[bot1]': 'Waterways_02[top1]', 'Waterways_02[top1]': 'Waterways_01[bot1]', 'Waterways_02[top2]': 'Waterways_05[bot1]', 'Waterways_02[top3]': 'Waterways_04[bot1]', 'Waterways_02[bot1]': 'Waterways_08[top1]', 'Waterways_02[bot2]': 'Waterways_06[top1]', 'Waterways_03[left1]': 'Waterways_01[right1]', 'Waterways_04[bot1]': 'Waterways_02[top3]', 'Waterways_04[right1]': 'Waterways_01[left1]', 'Waterways_04[left1]': 'Waterways_04b[right1]', 'Waterways_04[left2]': 'Waterways_04b[right2]', 'Waterways_04b[right1]': 'Waterways_04[left1]', 'Waterways_04b[right2]': 'Waterways_04[left2]', 'Waterways_04b[left1]': 'Waterways_09[right1]', 'Waterways_05[right1]': 'Abyss_01[left1]', 'Waterways_05[bot1]': 'Waterways_02[top2]', 'Waterways_05[bot2]': 'Waterways_15[top1]', 'Waterways_06[right1]': 'Abyss_01[left2]', 'Waterways_06[top1]': 'Waterways_02[bot2]', 'Waterways_07[right1]': 'Waterways_13[left1]', 'Waterways_07[right2]': 'Waterways_13[left2]', 'Waterways_07[left1]': 'Abyss_01[right2]', 'Waterways_07[door1]': 'Ruins_House_03[left2]', 'Waterways_07[top1]': 'Waterways_14[bot1]', 'Waterways_08[top1]': 'Waterways_02[bot1]', 'Waterways_08[left1]': 'Waterways_12[right1]', 'Waterways_08[left2]': 'GG_Pipeway[right1]', 'Waterways_09[right1]': 'Waterways_04b[left1]', 'Waterways_09[left1]': 'Fungus2_23[right2]', 'Waterways_12[right1]': 'Waterways_08[left1]', 'Waterways_13[left1]': 'Waterways_07[right1]', 'Waterways_13[left2]': 'Waterways_07[right2]', 'Waterways_14[bot1]': 'Waterways_07[top1]', 'Waterways_14[bot2]': 'Deepnest_East_02[top1]', 'Waterways_15[top1]': 'Waterways_05[bot2]', 'GG_Pipeway[right1]': 'Waterways_08[left2]', 'GG_Pipeway[left1]': 'GG_Waterways[right1]', 'GG_Waterways[right1]': 'GG_Pipeway[left1]', 'GG_Waterways[door1]': 'Room_GG_Shortcut[left1]', 'Room_GG_Shortcut[left1]': 'GG_Waterways[door1]', 'Room_GG_Shortcut[top1]': 'Ruins1_04[bot1]', 'Ruins1_01[left1]': 'Fungus2_21[right1]', 'Ruins1_01[top1]': 'Ruins1_17[bot1]', 'Ruins1_01[bot1]': 'Ruins1_02[top1]', 'Ruins1_02[top1]': 'Ruins1_01[bot1]', 'Ruins1_02[bot1]': 'Ruins1_03[top1]', 'Ruins1_03[top1]': 'Ruins1_02[bot1]', 'Ruins1_03[left1]': 'Ruins1_04[right1]', 'Ruins1_03[right1]': 'Ruins1_05c[left2]', 'Ruins1_03[right2]': 'Ruins1_05b[left1]', 'Ruins1_04[right1]': 'Ruins1_03[left1]', 'Ruins1_04[door1]': 'Room_nailsmith[left1]', 'Ruins1_04[bot1]': 'Room_GG_Shortcut[top1]', 'Ruins1_05b[left1]': 'Ruins1_03[right2]', 'Ruins1_05b[top1]': 'Ruins1_05c[bot1]', 'Ruins1_05b[bot1]': 'Waterways_01[top1]', 'Ruins1_05b[right1]': 'Ruins1_27[left1]', 'Ruins1_05c[left2]': 'Ruins1_03[right1]', 'Ruins1_05c[bot1]': 'Ruins1_05b[top1]', 'Ruins1_05c[top1]': 'Ruins1_05[bot1]', 'Ruins1_05c[top2]': 'Ruins1_05[bot2]', 'Ruins1_05c[top3]': 'Ruins1_05[bot3]', 'Ruins1_05[bot1]': 'Ruins1_05c[top1]', 'Ruins1_05[bot2]': 'Ruins1_05c[top2]', 'Ruins1_05[bot3]': 'Ruins1_05c[top3]', 'Ruins1_05[right1]': 'Ruins1_09[left1]', 'Ruins1_05[right2]': 'Ruins1_18[left1]', 'Ruins1_05[top1]': 'Ruins1_31[bot1]', 'Ruins1_06[left1]': 'Ruins1_17[right1]', 'Ruins1_06[right1]': 'Ruins1_31[left1]', 'Ruins1_09[top1]': 'Ruins1_23[bot1]', 'Ruins1_09[left1]': 'Ruins1_05[right1]', 'Ruins1_17[top1]': 'Ruins1_28[bot1]', 'Ruins1_17[right1]': 'Ruins1_06[left1]', 'Ruins1_17[bot1]': 'Ruins1_01[top1]', 'Ruins1_18[left1]': 'Ruins1_05[right2]', 'Ruins1_18[right1]': 'Ruins2_03b[left1]', 'Ruins1_18[right2]': 'Ruins2_01[left2]', 'Ruins1_23[top1]': 'Ruins1_30[bot1]', 'Ruins1_23[right1]': 'Ruins1_25[left2]', 'Ruins1_23[right2]': 'Ruins1_25[left3]', 'Ruins1_23[bot1]': 'Ruins1_09[top1]', 'Ruins1_23[left1]': 'Ruins1_31[right1]', 'Ruins1_24[left1]': 'Ruins1_32[right1]', 'Ruins1_24[right1]': 'Ruins1_30[left1]', 'Ruins1_24[left2]': 'Ruins1_32[right2]', 'Ruins1_24[right2]': 'Ruins1_30[left2]', 'Ruins1_25[left1]': 'Ruins1_30[right1]', 'Ruins1_25[left2]': 'Ruins1_23[right1]', 'Ruins1_25[left3]': 'Ruins1_23[right2]', 'Ruins1_27[left1]': 'Ruins1_05b[right1]', 'Ruins1_27[right1]': 'Ruins2_01_b[left1]', 'Ruins1_28[left1]': 'Crossroads_49b[right1]', 'Ruins1_28[right1]': 'Ruins1_29[left1]', 'Ruins1_28[bot1]': 'Ruins1_17[top1]', 'Ruins1_29[left1]': 'Ruins1_28[right1]', 'Ruins1_30[left1]': 'Ruins1_24[right1]', 'Ruins1_30[left2]': 'Ruins1_24[right2]', 'Ruins1_30[bot1]': 'Ruins1_23[top1]', 'Ruins1_30[right1]': 'Ruins1_25[left1]', 'Ruins1_31[bot1]': 'Ruins1_05[top1]', 'Ruins1_31[left1]': 'Ruins1_06[right1]', 'Ruins1_31[left2]': 'Ruins1_31b[right1]', 'Ruins1_31[left3]': 'Ruins1_31b[right2]', 'Ruins1_31[right1]': 'Ruins1_23[left1]', 'Ruins1_31b[right1]': 'Ruins1_31[left2]', 'Ruins1_31b[right2]': 'Ruins1_31[left3]', 'Ruins1_32[right1]': 'Ruins1_24[left1]', 'Ruins1_32[right2]': 'Ruins1_24[left2]', 'Room_nailsmith[left1]': 'Ruins1_04[door1]', 'Ruins2_01[top1]': 'Ruins2_03b[bot1]', 'Ruins2_01[bot1]': 'Ruins2_01_b[top1]', 'Ruins2_01[left2]': 'Ruins1_18[right2]', 'Ruins2_01_b[top1]': 'Ruins2_01[bot1]', 'Ruins2_01_b[left1]': 'Ruins1_27[right1]', 'Ruins2_01_b[right1]': 'Ruins2_04[left1]', 'Ruins2_03b[top1]': 'Ruins2_03[bot1]', 'Ruins2_03b[top2]': 'Ruins2_03[bot2]', 'Ruins2_03b[left1]': 'Ruins1_18[right1]', 'Ruins2_03b[bot1]': 'Ruins2_01[top1]', 'Ruins2_03[top1]': 'Ruins2_Watcher_Room[bot1]', 'Ruins2_03[bot1]': 'Ruins2_03b[top1]', 'Ruins2_03[bot2]': 'Ruins2_03b[top2]', 'Ruins2_04[left1]': 'Ruins2_01_b[right1]', 'Ruins2_04[left2]': 'Abyss_01[right1]', 'Ruins2_04[right1]': 'Ruins2_06[left1]', 'Ruins2_04[right2]': 'Ruins2_06[left2]', 'Ruins2_04[door_Ruin_House_01]': 'Ruins_House_01[left1]', 'Ruins2_04[door_Ruin_House_02]': 'Ruins_House_02[left1]', 'Ruins2_04[door_Ruin_House_03]': 'Ruins_House_03[left1]', 'Ruins2_04[door_Ruin_Elevator]': 'Ruins_Elevator[left1]', 'Ruins2_05[left1]': 'Ruins2_10b[right2]', 'Ruins2_05[top1]': 'Ruins2_09[bot1]', 'Ruins2_05[bot1]': 'Ruins2_06[top1]', 'Ruins2_06[left1]': 'Ruins2_04[right1]', 'Ruins2_06[left2]': 'Ruins2_04[right2]', 'Ruins2_06[right1]': 'Ruins2_08[left1]', 'Ruins2_06[right2]': 'Ruins2_07[left1]', 'Ruins2_06[top1]': 'Ruins2_05[bot1]', 'Ruins2_07[right1]': 'Deepnest_East_03[left1]', 'Ruins2_07[left1]': 'Ruins2_06[right2]', 'Ruins2_07[top1]': 'Ruins2_11_b[bot1]', 'Ruins2_08[left1]': 'Ruins2_06[right1]', 'Ruins2_09[bot1]': 'Ruins2_05[top1]', 'Ruins2_10[right1]': 'RestingGrounds_10[left1]', 'Ruins2_10[left1]': 'RestingGrounds_06[right1]', 'Ruins2_10b[right1]': 'Deepnest_East_09[left1]', 'Ruins2_10b[right2]': 'Ruins2_05[left1]', 'Ruins2_10b[left1]': 'Ruins_Bathhouse[right1]', 'Ruins2_11_b[right1]': 'Deepnest_East_07[left2]', 'Ruins2_11_b[left1]': 'Ruins2_11[right1]', 'Ruins2_11_b[bot1]': 'Ruins2_07[top1]', 'Ruins2_11[right1]': 'Ruins2_11_b[left1]', 'Ruins2_Watcher_Room[bot1]': 'Ruins2_03[top1]', 'Ruins_House_01[left1]': 'Ruins2_04[door_Ruin_House_01]', 'Ruins_House_02[left1]': 'Ruins2_04[door_Ruin_House_02]', 'Ruins_House_03[left1]': 'Ruins2_04[door_Ruin_House_03]', 'Ruins_House_03[left2]': 'Waterways_07[door1]', 'Ruins_Elevator[left1]': 'Ruins2_04[door_Ruin_Elevator]', 'Ruins_Elevator[left2]': 'Ruins_Bathhouse[door1]', 'Ruins_Bathhouse[door1]': 'Ruins_Elevator[left2]', 'Ruins_Bathhouse[right1]': 'Ruins2_10b[left1]', 'RestingGrounds_02[right1]': 'RestingGrounds_04[left1]', 'RestingGrounds_02[left1]': 'Crossroads_46b[right1]', 'RestingGrounds_02[bot1]': 'RestingGrounds_06[top1]', 'RestingGrounds_02[top1]': None, 'RestingGrounds_04[left1]': 'RestingGrounds_02[right1]', 'RestingGrounds_04[right1]': 'RestingGrounds_05[left1]', 'RestingGrounds_05[left1]': 'RestingGrounds_04[right1]', 'RestingGrounds_05[left2]': 'RestingGrounds_07[right1]', 'RestingGrounds_05[left3]': 'RestingGrounds_17[right1]', 'RestingGrounds_05[right1]': 'RestingGrounds_08[left1]', 'RestingGrounds_05[right2]': 'RestingGrounds_09[left1]', 'RestingGrounds_05[bot1]': 'RestingGrounds_10[top1]', 'RestingGrounds_06[left1]': 'Crossroads_50[right1]', 'RestingGrounds_06[right1]': 'Ruins2_10[left1]', 'RestingGrounds_06[top1]': 'RestingGrounds_02[bot1]', 'RestingGrounds_07[right1]': 'RestingGrounds_05[left2]', 'RestingGrounds_08[left1]': 'RestingGrounds_05[right1]', 'RestingGrounds_09[left1]': 'RestingGrounds_05[right2]', 'RestingGrounds_10[left1]': 'Ruins2_10[right1]', 'RestingGrounds_10[top1]': 'RestingGrounds_05[bot1]', 'RestingGrounds_10[top2]': 'RestingGrounds_12[bot1]', 'RestingGrounds_12[bot1]': 'RestingGrounds_10[top2]', 'RestingGrounds_12[door_Mansion]': 'Room_Mansion[left1]', 'RestingGrounds_17[right1]': 'RestingGrounds_05[left3]', 'Room_Mansion[left1]': 'RestingGrounds_12[door_Mansion]', 'Mines_01[bot1]': 'Mines_02[top1]', 'Mines_01[left1]': 'Crossroads_45[right1]', 'Mines_02[top1]': 'Mines_01[bot1]', 'Mines_02[top2]': 'Mines_03[bot1]', 'Mines_02[left1]': 'Mines_33[right1]', 'Mines_02[right1]': 'Mines_29[left1]', 'Mines_03[right1]': 'Mines_17[left1]', 'Mines_03[bot1]': 'Mines_02[top2]', 'Mines_03[top1]': 'Mines_05[bot1]', 'Mines_04[right1]': 'Mines_07[left1]', 'Mines_04[top1]': 'Mines_37[bot1]', 'Mines_04[left1]': 'Mines_17[right1]', 'Mines_04[left2]': 'Mines_29[right1]', 'Mines_04[left3]': 'Mines_29[right2]', 'Mines_05[right1]': 'Mines_19[left1]', 'Mines_05[top1]': 'Mines_11[bot1]', 'Mines_05[bot1]': 'Mines_03[top1]', 'Mines_05[left1]': 'Mines_30[right1]', 'Mines_05[left2]': 'Mines_06[right1]', 'Mines_06[right1]': 'Mines_05[left2]', 'Mines_06[left1]': 'Mines_36[right1]', 'Mines_07[right1]': 'Mines_28[left1]', 'Mines_07[left1]': 'Mines_04[right1]', 'Mines_10[right1]': 'Mines_30[left1]', 'Mines_10[left1]': 'Town[right1]', 'Mines_10[bot1]': 'Mines_16[top1]', 'Mines_11[right1]': 'Mines_18[left1]', 'Mines_11[top1]': 'Mines_13[bot1]', 'Mines_11[bot1]': 'Mines_05[top1]', 'Mines_13[right1]': 'Mines_20[left1]', 'Mines_13[top1]': None, 'Mines_13[bot1]': 'Mines_11[top1]', 'Mines_16[top1]': 'Mines_10[bot1]', 'Mines_17[right1]': 'Mines_04[left1]', 'Mines_17[left1]': 'Mines_03[right1]', 'Mines_18[top1]': 'Mines_32[bot1]', 'Mines_18[left1]': 'Mines_11[right1]', 'Mines_18[right1]': 'Mines_20[left2]', 'Mines_19[left1]': 'Mines_05[right1]', 'Mines_19[right1]': 'Mines_20[left3]', 'Mines_20[left1]': 'Mines_13[right1]', 'Mines_20[left2]': 'Mines_18[right1]', 'Mines_20[left3]': 'Mines_19[right1]', 'Mines_20[bot1]': 'Mines_37[top1]', 'Mines_20[right1]': 'Mines_23[left1]', 'Mines_20[right2]': 'Mines_31[left1]', 'Mines_23[left1]': 'Mines_20[right1]', 'Mines_23[right1]': 'Mines_25[left1]', 'Mines_23[right2]': 'Mines_24[left1]', 'Mines_23[top1]': None, 'Mines_24[left1]': 'Mines_23[right2]', 'Mines_25[left1]': 'Mines_23[right1]', 'Mines_25[top1]': 'Mines_34[bot1]', 'Mines_28[left1]': 'Mines_07[right1]', 'Mines_28[bot1]': 'RestingGrounds_02[top1]', 'Mines_28[door1]': 'Mines_35[left1]', 'Mines_29[left1]': 'Mines_02[right1]', 'Mines_29[right1]': 'Mines_04[left2]', 'Mines_29[right2]': 'Mines_04[left3]', 'Mines_30[left1]': 'Mines_10[right1]', 'Mines_30[right1]': 'Mines_05[left1]', 'Mines_31[left1]': 'Mines_20[right2]', 'Mines_32[bot1]': 'Mines_18[top1]', 'Mines_33[right1]': 'Mines_02[left1]', 'Mines_33[left1]': 'Crossroads_03[right2]', 'Mines_34[bot1]': 'Mines_25[top1]', 'Mines_34[bot2]': 'Mines_23[top1]', 'Mines_34[left1]': 'Mines_13[top1]', 'Mines_35[left1]': 'Mines_28[door1]', 'Mines_36[right1]': 'Mines_06[left1]', 'Mines_37[bot1]': 'Mines_04[top1]', 'Mines_37[top1]': 'Mines_20[bot1]', 'Fungus3_04[left1]': 'Fungus3_21[right1]', 'Fungus3_04[left2]': 'Fungus3_13[right1]', 'Fungus3_04[right1]': 'Fungus3_34[left1]', 'Fungus3_04[right2]': 'Fungus3_05[left1]', 'Fungus3_05[left1]': 'Fungus3_04[right2]', 'Fungus3_05[right1]': 'Fungus1_24[left1]', 'Fungus3_05[right2]': 'Fungus3_11[left1]', 'Fungus3_08[left1]': 'Deepnest_43[right1]', 'Fungus3_08[right1]': 'Fungus3_11[left2]', 'Fungus3_08[top1]': 'Fungus3_10[bot1]', 'Fungus3_10[top1]': 'Fungus3_13[bot1]', 'Fungus3_10[bot1]': 'Fungus3_08[top1]', 'Fungus3_11[left1]': 'Fungus3_05[right2]', 'Fungus3_11[left2]': 'Fungus3_08[right1]', 'Fungus3_11[right1]': 'Fungus3_39[left1]', 'Fungus3_13[left1]': 'Fungus1_23[right1]', 'Fungus3_13[left2]': 'Fungus3_40[right1]', 'Fungus3_13[left3]': 'Fungus3_49[right1]', 'Fungus3_13[bot1]': 'Fungus3_10[top1]', 'Fungus3_13[right1]': 'Fungus3_04[left2]', 'Fungus3_21[right1]': 'Fungus3_04[left1]', 'Fungus3_21[top1]': 'Fungus3_22[bot1]', 'Fungus3_22[right1]': 'Fungus1_13[left1]', 'Fungus3_22[left1]': 'Fungus3_23[right1]', 'Fungus3_22[bot1]': 'Fungus3_21[top1]', 'Fungus3_23[right1]': 'Fungus3_22[left1]', 'Fungus3_23[left1]': 'Fungus3_48[right1]', 'Fungus3_34[right1]': 'Fungus3_03[left1]', 'Fungus3_34[left1]': 'Fungus3_04[right1]', 'Fungus3_34[top1]': 'Fungus3_44[bot1]', 'Fungus3_39[right1]': 'Deepnest_01[left1]', 'Fungus3_39[left1]': 'Fungus3_11[right1]', 'Fungus3_40[right1]': 'Fungus3_13[left2]', 'Fungus3_40[top1]': 'Fungus3_48[bot1]', 'Fungus3_48[right1]': 'Fungus3_23[left1]', 'Fungus3_48[right2]': 'Fungus1_23[left1]', 'Fungus3_48[door1]': 'Room_Queen[left1]', 'Fungus3_48[bot1]': 'Fungus3_40[top1]', 'Fungus3_49[right1]': 'Fungus3_13[left3]', 'Fungus3_50[right1]': 'Deepnest_43[left1]', 'Room_Queen[left1]': 'Fungus3_48[door1]', 'Cliffs_01[right1]': 'Cliffs_02[left1]', 'Cliffs_01[right2]': 'Cliffs_04[left1]', 'Cliffs_01[right3]': 'Fungus1_28[left1]', 'Cliffs_01[right4]': 'Cliffs_06[left1]', 'Cliffs_02[right1]': 'Town[top1]', 'Cliffs_02[bot1]': 'Tutorial_01[top2]', 'Cliffs_02[bot2]': 'Tutorial_01[top1]', 'Cliffs_02[door1]': 'Room_nailmaster[left1]', 'Cliffs_02[left1]': 'Cliffs_01[right1]', 'Cliffs_02[left2]': 'Cliffs_03[right1]', 'Cliffs_03[right1]': 'Cliffs_02[left2]', 'Cliffs_04[right1]': 'Cliffs_05[left1]', 'Cliffs_04[left1]': 'Cliffs_01[right2]', 'Cliffs_05[left1]': 'Cliffs_04[right1]', 'Cliffs_06[left1]': 'Cliffs_01[right4]', 'Room_nailmaster[left1]': 'Cliffs_02[door1]', 'White_Palace_01[left1]': 'White_Palace_11[door2]', 'White_Palace_01[right1]': 'White_Palace_02[left1]', 'White_Palace_01[top1]': 'White_Palace_03_hub[bot1]', 'White_Palace_02[left1]': 'White_Palace_01[right1]', 'White_Palace_03_hub[left1]': 'White_Palace_14[right1]', 'White_Palace_03_hub[left2]': 'White_Palace_04[right2]', 'White_Palace_03_hub[right1]': 'White_Palace_15[left1]', 'White_Palace_03_hub[top1]': 'White_Palace_06[bot1]', 'White_Palace_03_hub[bot1]': 'White_Palace_01[top1]', 'White_Palace_04[top1]': 'White_Palace_14[bot1]', 'White_Palace_04[right2]': 'White_Palace_03_hub[left2]', 'White_Palace_05[left1]': 'White_Palace_15[right1]', 'White_Palace_05[left2]': 'White_Palace_15[right2]', 'White_Palace_05[right1]': 'White_Palace_16[left1]', 'White_Palace_05[right2]': 'White_Palace_16[left2]', 'White_Palace_06[left1]': 'White_Palace_18[right1]', 'White_Palace_06[top1]': 'White_Palace_07[bot1]', 'White_Palace_06[bot1]': 'White_Palace_03_hub[top1]', 'White_Palace_07[top1]': 'White_Palace_12[bot1]', 'White_Palace_07[bot1]': 'White_Palace_06[top1]', 'White_Palace_08[left1]': 'White_Palace_13[right1]', 'White_Palace_08[right1]': 'White_Palace_13[left3]', 'White_Palace_09[right1]': 'White_Palace_13[left1]', 'White_Palace_11[door2]': 'White_Palace_01[left1]', 'White_Palace_12[right1]': 'White_Palace_13[left2]', 'White_Palace_12[bot1]': 'White_Palace_07[top1]', 'White_Palace_13[right1]': 'White_Palace_08[left1]', 'White_Palace_13[left1]': 'White_Palace_09[right1]', 'White_Palace_13[left2]': 'White_Palace_12[right1]', 'White_Palace_13[left3]': 'White_Palace_08[right1]', 'White_Palace_14[bot1]': 'White_Palace_04[top1]', 'White_Palace_14[right1]': 'White_Palace_03_hub[left1]', 'White_Palace_15[left1]': 'White_Palace_03_hub[right1]', 'White_Palace_15[right1]': 'White_Palace_05[left1]', 'White_Palace_15[right2]': 'White_Palace_05[left2]', 'White_Palace_16[left1]': 'White_Palace_05[right1]', 'White_Palace_16[left2]': 'White_Palace_05[right2]', 'White_Palace_17[right1]': 'White_Palace_19[left1]', 'White_Palace_17[bot1]': 'White_Palace_18[top1]', 'White_Palace_18[top1]': 'White_Palace_17[bot1]', 'White_Palace_18[right1]': 'White_Palace_06[left1]', 'White_Palace_19[top1]': 'White_Palace_20[bot1]', 'White_Palace_19[left1]': 'White_Palace_17[right1]', 'White_Palace_20[bot1]': 'White_Palace_19[top1]'} event_names = {'Abyss_01', 'Abyss_03', 'Abyss_03_b', 'Abyss_03_c', 'Abyss_04', 'Abyss_05', 'Abyss_06_Core', 'Abyss_09', 'Abyss_19', 'Broke_Sanctum_Glass_Floor', 'Can_Bench', 'Can_Repair_Fragile_Charms', 'Can_Replenish_Geo', 'Can_Replenish_Geo-Crossroads', 'Can_Stag', 'Cliffs_01', 'Cliffs_02', 'Completed_Path_of_Pain', 'Crossroads_03', 'Crossroads_07', 'Crossroads_08', 'Crossroads_14', 'Crossroads_18', 'Crossroads_19', 'Crossroads_21', 'Crossroads_27', 'Crossroads_33', 'Deepnest_01', 'Deepnest_01b', 'Deepnest_02', 'Deepnest_03', 'Deepnest_10', 'Deepnest_14', 'Deepnest_17', 'Deepnest_26', 'Deepnest_34', 'Deepnest_35', 'Deepnest_37', 'Deepnest_39', 'Deepnest_41', 'Deepnest_42', 'Deepnest_East_02', 'Deepnest_East_03', 'Deepnest_East_04', 'Deepnest_East_07', 'Deepnest_East_11', 'Deepnest_East_18', 'Defeated_Broken_Vessel', 'Defeated_Brooding_Mawlek', 'Defeated_Collector', 'Defeated_Colosseum_1', 'Defeated_Colosseum_2', 'Defeated_Colosseum_Zote', 'Defeated_Crystal_Guardian', 'Defeated_Dung_Defender', 'Defeated_Elder_Hu', 'Defeated_Elegant_Warrior', 'Defeated_Enraged_Guardian', 'Defeated_Failed_Champion', 'Defeated_False_Knight', 'Defeated_Flukemarm', 'Defeated_Galien', 'Defeated_Gorb', 'Defeated_Grey_Prince_Zote', 'Defeated_Grimm', 'Defeated_Gruz_Mother', 'Defeated_Hive_Knight', 'Defeated_Hornet_1', 'Defeated_Hornet_2', "Defeated_King's_Station_Arena", 'Defeated_Lost_Kin', 'Defeated_Mantis_Lords', 'Defeated_Markoth', 'Defeated_Marmu', 'Defeated_No_Eyes', 'Defeated_Nosk', 'Defeated_Pale_Lurker', 'Defeated_Path_of_Pain_Arena', 'Defeated_Sanctum_Warrior', 'Defeated_Shrumal_Ogre_Arena', 'Defeated_Soul_Master', 'Defeated_Soul_Tyrant', 'Defeated_Traitor_Lord', 'Defeated_Uumuu', 'Defeated_Watcher_Knights', "Defeated_West_Queen's_Gardens_Arena", 'Defeated_White_Defender', 'Defeated_Xero', 'First_Grimmchild_Upgrade', 'Fungus1_11', 'Fungus1_21', 'Fungus1_30', 'Fungus2_01', 'Fungus2_03', 'Fungus2_04', 'Fungus2_06', 'Fungus2_11', 'Fungus2_13', 'Fungus2_14', 'Fungus2_17', 'Fungus2_20', 'Fungus2_23', 'Fungus3_01', 'Fungus3_02', 'Fungus3_04', 'Fungus3_11', 'Fungus3_13', 'Fungus3_22', 'Fungus3_26', 'Fungus3_34', 'Fungus3_40', 'Fungus3_44', 'Fungus3_47', 'Hive_03_c', 'Left_Elevator', 'Lever-Dung_Defender', 'Lever-Shade_Soul', 'Lit_Abyss_Lighthouse', 'Lower_Tram', 'Mines_02', 'Mines_03', 'Mines_04', 'Mines_05', 'Mines_10', 'Mines_11', 'Mines_18', 'Mines_20', 'Mines_23', 'Nightmare_Lantern_Lit', 'Opened_Archives_Exit_Wall', 'Opened_Black_Egg_Temple', 'Opened_Dung_Defender_Wall', 'Opened_Emilitia_Door', 'Opened_Gardens_Stag_Exit', 'Opened_Glade_Door', "Opened_Lower_Kingdom's_Edge_Wall", 'Opened_Mawlek_Wall', 'Opened_Pleasure_House_Wall', 'Opened_Resting_Grounds_Catacombs_Wall', 'Opened_Resting_Grounds_Floor', 'Opened_Shaman_Pillar', 'Opened_Tramway_Exit_Gate', 'Opened_Waterways_Exit', 'Opened_Waterways_Manhole', 'Palace_Atrium_Gates_Opened', 'Palace_Entrance_Lantern_Lit', 'Palace_Left_Lantern_Lit', 'Palace_Right_Lantern_Lit', 'Rescued_Bretta', 'Rescued_Deepnest_Zote', 'Rescued_Sly', 'RestingGrounds_02', 'RestingGrounds_05', 'RestingGrounds_10', 'Right_Elevator', 'Ruins1_03', 'Ruins1_05', 'Ruins1_05b', 'Ruins1_05c', 'Ruins1_23', 'Ruins1_28', 'Ruins1_30', 'Ruins1_31', 'Ruins2_01', 'Ruins2_01_b', 'Ruins2_03b', 'Ruins2_04', 'Ruins2_10', 'Second_Grimmchild_Upgrade', 'Town', 'Tutorial_01', 'Upper_Tram', 'Warp-Lifeblood_Core_to_Abyss', 'Warp-Palace_Grounds_to_White_Palace', 'Warp-Path_of_Pain_Complete', 'Warp-White_Palace_Atrium_to_Palace_Grounds', 'Warp-White_Palace_Entrance_to_Palace_Grounds', 'Waterways_01', 'Waterways_02', 'Waterways_04', 'Waterways_04b', 'Waterways_07', 'White_Palace_01', 'White_Palace_03_hub', 'White_Palace_13'} exits = {'Room_temple': ['Room_temple[left1]'], 'Tutorial_01': ['Tutorial_01[right1]', 'Tutorial_01[top1]', 'Tutorial_01[top2]'], 'Town': ['Town[left1]', 'Town[bot1]', 'Town[right1]', 'Town[top1]', 'Town[door_station]', 'Town[door_sly]', 'Town[door_mapper]', 'Town[door_jiji]', 'Town[door_bretta]', 'Town[room_divine]', 'Town[room_grimm]'], 'Room_shop': ['Room_shop[left1]'], 'Room_Town_Stag_Station': ['Room_Town_Stag_Station[left1]'], 'Room_mapper': ['Room_mapper[left1]'], 'Room_Bretta': ['Room_Bretta[right1]'], 'Room_Ouiji': ['Room_Ouiji[left1]'], 'Grimm_Divine': ['Grimm_Divine[left1]'], 'Grimm_Main_Tent': ['Grimm_Main_Tent[left1]'], 'Crossroads_01': ['Crossroads_01[top1]', 'Crossroads_01[left1]', 'Crossroads_01[right1]'], 'Crossroads_02': ['Crossroads_02[left1]', 'Crossroads_02[door1]', 'Crossroads_02[right1]'], 'Crossroads_03': ['Crossroads_03[right1]', 'Crossroads_03[right2]', 'Crossroads_03[left1]', 'Crossroads_03[left2]', 'Crossroads_03[bot1]', 'Crossroads_03[top1]'], 'Crossroads_04': ['Crossroads_04[left1]', 'Crossroads_04[top1]', 'Crossroads_04[door_Mender_House]', 'Crossroads_04[door1]', 'Crossroads_04[door_charmshop]', 'Crossroads_04[right1]'], 'Crossroads_05': ['Crossroads_05[left1]', 'Crossroads_05[right1]'], 'Crossroads_06': ['Crossroads_06[left1]', 'Crossroads_06[door1]', 'Crossroads_06[right1]'], 'Crossroads_07': ['Crossroads_07[left1]', 'Crossroads_07[left2]', 'Crossroads_07[left3]', 'Crossroads_07[right1]', 'Crossroads_07[right2]', 'Crossroads_07[bot1]'], 'Crossroads_08': ['Crossroads_08[left1]', 'Crossroads_08[left2]', 'Crossroads_08[right1]', 'Crossroads_08[right2]'], 'Crossroads_09': ['Crossroads_09[left1]', 'Crossroads_09[right1]'], 'Crossroads_10': ['Crossroads_10[left1]', 'Crossroads_10[right1]'], 'Crossroads_11_alt': ['Crossroads_11_alt[left1]', 'Crossroads_11_alt[right1]'], 'Crossroads_12': ['Crossroads_12[left1]', 'Crossroads_12[right1]'], 'Crossroads_13': ['Crossroads_13[left1]', 'Crossroads_13[right1]'], 'Crossroads_14': ['Crossroads_14[left1]', 'Crossroads_14[left2]', 'Crossroads_14[right1]', 'Crossroads_14[right2]'], 'Crossroads_15': ['Crossroads_15[left1]', 'Crossroads_15[right1]'], 'Crossroads_16': ['Crossroads_16[left1]', 'Crossroads_16[right1]', 'Crossroads_16[bot1]'], 'Crossroads_18': ['Crossroads_18[right1]', 'Crossroads_18[right2]', 'Crossroads_18[bot1]'], 'Crossroads_19': ['Crossroads_19[right1]', 'Crossroads_19[top1]', 'Crossroads_19[left1]', 'Crossroads_19[left2]'], 'Crossroads_21': ['Crossroads_21[left1]', 'Crossroads_21[right1]', 'Crossroads_21[top1]'], 'Crossroads_22': ['Crossroads_22[bot1]'], 'Crossroads_25': ['Crossroads_25[right1]', 'Crossroads_25[left1]'], 'Crossroads_27': ['Crossroads_27[right1]', 'Crossroads_27[bot1]', 'Crossroads_27[left1]', 'Crossroads_27[left2]'], 'Crossroads_30': ['Crossroads_30[left1]'], 'Crossroads_31': ['Crossroads_31[right1]'], 'Crossroads_33': ['Crossroads_33[top1]', 'Crossroads_33[left1]', 'Crossroads_33[left2]', 'Crossroads_33[right1]', 'Crossroads_33[right2]'], 'Crossroads_35': ['Crossroads_35[bot1]', 'Crossroads_35[right1]'], 'Crossroads_36': ['Crossroads_36[right1]', 'Crossroads_36[right2]'], 'Crossroads_37': ['Crossroads_37[right1]'], 'Crossroads_38': ['Crossroads_38[right1]'], 'Crossroads_39': ['Crossroads_39[right1]', 'Crossroads_39[left1]'], 'Crossroads_40': ['Crossroads_40[right1]', 'Crossroads_40[left1]'], 'Crossroads_42': ['Crossroads_42[left1]', 'Crossroads_42[right1]'], 'Crossroads_43': ['Crossroads_43[left1]', 'Crossroads_43[right1]'], 'Crossroads_45': ['Crossroads_45[right1]', 'Crossroads_45[left1]'], 'Crossroads_46': ['Crossroads_46[left1]'], 'Crossroads_46b': ['Crossroads_46b[right1]'], 'Crossroads_ShamanTemple': ['Crossroads_ShamanTemple[left1]'], 'Crossroads_47': ['Crossroads_47[right1]'], 'Crossroads_48': ['Crossroads_48[left1]'], 'Crossroads_49': ['Crossroads_49[right1]', 'Crossroads_49[left1]'], 'Crossroads_49b': ['Crossroads_49b[right1]'], 'Crossroads_50': ['Crossroads_50[right1]', 'Crossroads_50[left1]'], 'Crossroads_52': ['Crossroads_52[left1]'], 'Room_ruinhouse': ['Room_ruinhouse[left1]'], 'Room_Charm_Shop': ['Room_Charm_Shop[left1]'], 'Room_Mender_House': ['Room_Mender_House[left1]'], 'Fungus1_01': ['Fungus1_01[left1]', 'Fungus1_01[right1]'], 'Fungus1_01b': ['Fungus1_01b[left1]', 'Fungus1_01b[right1]'], 'Fungus1_02': ['Fungus1_02[left1]', 'Fungus1_02[right1]', 'Fungus1_02[right2]'], 'Fungus1_03': ['Fungus1_03[left1]', 'Fungus1_03[right1]', 'Fungus1_03[bot1]'], 'Fungus1_04': ['Fungus1_04[left1]', 'Fungus1_04[right1]'], 'Fungus1_05': ['Fungus1_05[right1]', 'Fungus1_05[bot1]', 'Fungus1_05[top1]'], 'Fungus1_06': ['Fungus1_06[left1]', 'Fungus1_06[bot1]'], 'Fungus1_07': ['Fungus1_07[top1]', 'Fungus1_07[left1]', 'Fungus1_07[right1]'], 'Fungus1_08': ['Fungus1_08[left1]'], 'Fungus1_09': ['Fungus1_09[left1]', 'Fungus1_09[right1]'], 'Fungus1_10': ['Fungus1_10[left1]', 'Fungus1_10[right1]', 'Fungus1_10[top1]'], 'Fungus1_11': ['Fungus1_11[top1]', 'Fungus1_11[right1]', 'Fungus1_11[right2]', 'Fungus1_11[left1]', 'Fungus1_11[bot1]'], 'Fungus1_12': ['Fungus1_12[left1]', 'Fungus1_12[right1]'], 'Fungus1_13': ['Fungus1_13[right1]', 'Fungus1_13[left1]'], 'Fungus1_14': ['Fungus1_14[left1]'], 'Fungus1_15': ['Fungus1_15[door1]', 'Fungus1_15[right1]'], 'Fungus1_16_alt': ['Fungus1_16_alt[right1]'], 'Fungus1_17': ['Fungus1_17[left1]', 'Fungus1_17[right1]'], 'Fungus1_19': ['Fungus1_19[left1]', 'Fungus1_19[right1]', 'Fungus1_19[bot1]'], 'Fungus1_20_v02': ['Fungus1_20_v02[bot1]', 'Fungus1_20_v02[bot2]', 'Fungus1_20_v02[right1]'], 'Fungus1_21': ['Fungus1_21[bot1]', 'Fungus1_21[top1]', 'Fungus1_21[left1]', 'Fungus1_21[right1]'], 'Fungus1_22': ['Fungus1_22[bot1]', 'Fungus1_22[top1]', 'Fungus1_22[left1]'], 'Fungus1_23': ['Fungus1_23[left1]', 'Fungus1_23[right1]'], 'Fungus1_24': ['Fungus1_24[left1]'], 'Fungus1_25': ['Fungus1_25[right1]', 'Fungus1_25[left1]'], 'Fungus1_26': ['Fungus1_26[right1]', 'Fungus1_26[left1]', 'Fungus1_26[door_SlugShrine]'], 'Fungus1_28': ['Fungus1_28[left1]', 'Fungus1_28[left2]'], 'Fungus1_29': ['Fungus1_29[left1]', 'Fungus1_29[right1]'], 'Fungus1_30': ['Fungus1_30[top1]', 'Fungus1_30[top3]', 'Fungus1_30[left1]', 'Fungus1_30[right1]'], 'Fungus1_31': ['Fungus1_31[top1]', 'Fungus1_31[bot1]', 'Fungus1_31[right1]'], 'Fungus1_32': ['Fungus1_32[bot1]', 'Fungus1_32[top1]', 'Fungus1_32[left1]'], 'Fungus1_34': ['Fungus1_34[door1]', 'Fungus1_34[left1]'], 'Fungus1_35': ['Fungus1_35[left1]', 'Fungus1_35[right1]'], 'Fungus1_36': ['Fungus1_36[left1]'], 'Fungus1_37': ['Fungus1_37[left1]'], 'Fungus1_Slug': ['Fungus1_Slug[right1]'], 'Room_Slug_Shrine': ['Room_Slug_Shrine[left1]'], 'Room_nailmaster_02': ['Room_nailmaster_02[left1]'], 'Fungus3_01': ['Fungus3_01[top1]', 'Fungus3_01[right1]', 'Fungus3_01[left1]', 'Fungus3_01[right2]'], 'Fungus3_02': ['Fungus3_02[left1]', 'Fungus3_02[left2]', 'Fungus3_02[left3]', 'Fungus3_02[right1]', 'Fungus3_02[right2]'], 'Fungus3_03': ['Fungus3_03[right1]', 'Fungus3_03[left1]'], 'Fungus3_24': ['Fungus3_24[right1]', 'Fungus3_24[left1]', 'Fungus3_24[top1]'], 'Fungus3_25': ['Fungus3_25[right1]', 'Fungus3_25[left1]'], 'Fungus3_25b': ['Fungus3_25b[right1]', 'Fungus3_25b[left1]'], 'Fungus3_26': ['Fungus3_26[top1]', 'Fungus3_26[left1]', 'Fungus3_26[left2]', 'Fungus3_26[left3]', 'Fungus3_26[right1]'], 'Fungus3_27': ['Fungus3_27[left1]', 'Fungus3_27[right1]'], 'Fungus3_28': ['Fungus3_28[right1]'], 'Fungus3_30': ['Fungus3_30[bot1]'], 'Fungus3_35': ['Fungus3_35[right1]'], 'Fungus3_44': ['Fungus3_44[bot1]', 'Fungus3_44[door1]', 'Fungus3_44[right1]'], 'Fungus3_47': ['Fungus3_47[left1]', 'Fungus3_47[right1]', 'Fungus3_47[door1]'], 'Room_Fungus_Shaman': ['Room_Fungus_Shaman[left1]'], 'Fungus3_archive': ['Fungus3_archive[left1]', 'Fungus3_archive[bot1]'], 'Fungus3_archive_02': ['Fungus3_archive_02[top1]'], 'Fungus2_01': ['Fungus2_01[left1]', 'Fungus2_01[left2]', 'Fungus2_01[left3]', 'Fungus2_01[right1]'], 'Fungus2_02': ['Fungus2_02[right1]'], 'Fungus2_34': ['Fungus2_34[right1]'], 'Fungus2_03': ['Fungus2_03[left1]', 'Fungus2_03[bot1]', 'Fungus2_03[right1]'], 'Fungus2_04': ['Fungus2_04[top1]', 'Fungus2_04[right1]', 'Fungus2_04[left1]', 'Fungus2_04[right2]'], 'Fungus2_05': ['Fungus2_05[bot1]', 'Fungus2_05[right1]'], 'Fungus2_06': ['Fungus2_06[top1]', 'Fungus2_06[left1]', 'Fungus2_06[left2]', 'Fungus2_06[right1]', 'Fungus2_06[right2]'], 'Fungus2_07': ['Fungus2_07[left1]', 'Fungus2_07[right1]'], 'Fungus2_08': ['Fungus2_08[left1]', 'Fungus2_08[left2]', 'Fungus2_08[right1]'], 'Fungus2_09': ['Fungus2_09[left1]', 'Fungus2_09[right1]'], 'Fungus2_10': ['Fungus2_10[right1]', 'Fungus2_10[right2]', 'Fungus2_10[bot1]'], 'Fungus2_11': ['Fungus2_11[top1]', 'Fungus2_11[left1]', 'Fungus2_11[left2]', 'Fungus2_11[right1]'], 'Fungus2_12': ['Fungus2_12[left1]', 'Fungus2_12[bot1]'], 'Fungus2_13': ['Fungus2_13[top1]', 'Fungus2_13[left2]', 'Fungus2_13[left3]'], 'Fungus2_14': ['Fungus2_14[top1]', 'Fungus2_14[right1]', 'Fungus2_14[bot3]'], 'Fungus2_15': ['Fungus2_15[top3]', 'Fungus2_15[right1]', 'Fungus2_15[left1]'], 'Fungus2_17': ['Fungus2_17[left1]', 'Fungus2_17[right1]', 'Fungus2_17[bot1]'], 'Fungus2_18': ['Fungus2_18[right1]', 'Fungus2_18[bot1]', 'Fungus2_18[top1]'], 'Fungus2_19': ['Fungus2_19[top1]', 'Fungus2_19[left1]'], 'Fungus2_20': ['Fungus2_20[right1]', 'Fungus2_20[left1]'], 'Fungus2_21': ['Fungus2_21[right1]', 'Fungus2_21[left1]'], 'Fungus2_23': ['Fungus2_23[right1]', 'Fungus2_23[right2]'], 'Fungus2_26': ['Fungus2_26[left1]'], 'Fungus2_28': ['Fungus2_28[left1]', 'Fungus2_28[left2]'], 'Fungus2_29': ['Fungus2_29[right1]', 'Fungus2_29[bot1]'], 'Fungus2_30': ['Fungus2_30[bot1]', 'Fungus2_30[top1]'], 'Fungus2_31': ['Fungus2_31[left1]'], 'Fungus2_32': ['Fungus2_32[left1]'], 'Fungus2_33': ['Fungus2_33[right1]', 'Fungus2_33[left1]'], 'Deepnest_01': ['Deepnest_01[right1]', 'Deepnest_01[bot1]', 'Deepnest_01[bot2]', 'Deepnest_01[left1]'], 'Deepnest_01b': ['Deepnest_01b[top1]', 'Deepnest_01b[top2]', 'Deepnest_01b[right1]', 'Deepnest_01b[right2]', 'Deepnest_01b[bot1]'], 'Deepnest_02': ['Deepnest_02[left1]', 'Deepnest_02[left2]', 'Deepnest_02[right1]'], 'Deepnest_03': ['Deepnest_03[right1]', 'Deepnest_03[left1]', 'Deepnest_03[top1]', 'Deepnest_03[left2]'], 'Deepnest_09': ['Deepnest_09[left1]'], 'Deepnest_10': ['Deepnest_10[right1]', 'Deepnest_10[right2]', 'Deepnest_10[right3]', 'Deepnest_10[door1]', 'Deepnest_10[door2]'], 'Room_spider_small': ['Room_spider_small[left1]'], 'Deepnest_Spider_Town': ['Deepnest_Spider_Town[left1]'], 'Deepnest_14': ['Deepnest_14[right1]', 'Deepnest_14[left1]', 'Deepnest_14[bot1]', 'Deepnest_14[bot2]'], 'Deepnest_16': ['Deepnest_16[left1]', 'Deepnest_16[bot1]'], 'Deepnest_17': ['Deepnest_17[left1]', 'Deepnest_17[right1]', 'Deepnest_17[top1]', 'Deepnest_17[bot1]'], 'Fungus2_25': ['Fungus2_25[top1]', 'Fungus2_25[top2]', 'Fungus2_25[right1]'], 'Deepnest_26': ['Deepnest_26[left1]', 'Deepnest_26[left2]', 'Deepnest_26[right1]', 'Deepnest_26[bot1]'], 'Deepnest_26b': ['Deepnest_26b[right2]', 'Deepnest_26b[right1]'], 'Deepnest_30': ['Deepnest_30[left1]', 'Deepnest_30[top1]', 'Deepnest_30[right1]'], 'Deepnest_31': ['Deepnest_31[right1]', 'Deepnest_31[right2]'], 'Deepnest_32': ['Deepnest_32[left1]'], 'Deepnest_33': ['Deepnest_33[top1]', 'Deepnest_33[top2]', 'Deepnest_33[bot1]'], 'Deepnest_34': ['Deepnest_34[left1]', 'Deepnest_34[right1]', 'Deepnest_34[top1]'], 'Deepnest_35': ['Deepnest_35[left1]', 'Deepnest_35[top1]', 'Deepnest_35[bot1]'], 'Deepnest_36': ['Deepnest_36[left1]'], 'Deepnest_37': ['Deepnest_37[left1]', 'Deepnest_37[right1]', 'Deepnest_37[top1]', 'Deepnest_37[bot1]'], 'Deepnest_38': ['Deepnest_38[bot1]'], 'Deepnest_39': ['Deepnest_39[left1]', 'Deepnest_39[top1]', 'Deepnest_39[door1]', 'Deepnest_39[right1]'], 'Deepnest_40': ['Deepnest_40[right1]'], 'Deepnest_41': ['Deepnest_41[right1]', 'Deepnest_41[left1]', 'Deepnest_41[left2]'], 'Deepnest_42': ['Deepnest_42[bot1]', 'Deepnest_42[left1]', 'Deepnest_42[top1]'], 'Deepnest_43': ['Deepnest_43[bot1]', 'Deepnest_43[left1]', 'Deepnest_43[right1]'], 'Deepnest_44': ['Deepnest_44[top1]'], 'Deepnest_45_v02': ['Deepnest_45_v02[left1]'], 'Room_Mask_Maker': ['Room_Mask_Maker[right1]'], 'Deepnest_East_01': ['Deepnest_East_01[bot1]', 'Deepnest_East_01[right1]', 'Deepnest_East_01[top1]'], 'Deepnest_East_02': ['Deepnest_East_02[bot1]', 'Deepnest_East_02[bot2]', 'Deepnest_East_02[top1]', 'Deepnest_East_02[right1]'], 'Deepnest_East_03': ['Deepnest_East_03[left1]', 'Deepnest_East_03[left2]', 'Deepnest_East_03[top1]', 'Deepnest_East_03[top2]', 'Deepnest_East_03[right1]', 'Deepnest_East_03[right2]'], 'Deepnest_East_04': ['Deepnest_East_04[left1]', 'Deepnest_East_04[left2]', 'Deepnest_East_04[right2]', 'Deepnest_East_04[right1]'], 'Deepnest_East_06': ['Deepnest_East_06[top1]', 'Deepnest_East_06[left1]', 'Deepnest_East_06[bot1]', 'Deepnest_East_06[door1]', 'Deepnest_East_06[right1]'], 'Deepnest_East_07': ['Deepnest_East_07[bot1]', 'Deepnest_East_07[bot2]', 'Deepnest_East_07[left1]', 'Deepnest_East_07[left2]', 'Deepnest_East_07[right1]'], 'Deepnest_East_08': ['Deepnest_East_08[right1]', 'Deepnest_East_08[top1]'], 'Deepnest_East_09': ['Deepnest_East_09[right1]', 'Deepnest_East_09[left1]', 'Deepnest_East_09[bot1]'], 'Deepnest_East_10': ['Deepnest_East_10[left1]'], 'Deepnest_East_11': ['Deepnest_East_11[right1]', 'Deepnest_East_11[left1]', 'Deepnest_East_11[top1]', 'Deepnest_East_11[bot1]'], 'Deepnest_East_12': ['Deepnest_East_12[right1]', 'Deepnest_East_12[left1]'], 'Deepnest_East_13': ['Deepnest_East_13[bot1]'], 'Deepnest_East_14': ['Deepnest_East_14[top2]', 'Deepnest_East_14[left1]', 'Deepnest_East_14[door1]'], 'Deepnest_East_14b': ['Deepnest_East_14b[right1]', 'Deepnest_East_14b[top1]'], 'Deepnest_East_15': ['Deepnest_East_15[left1]'], 'Deepnest_East_16': ['Deepnest_East_16[left1]', 'Deepnest_East_16[bot1]'], 'Deepnest_East_17': ['Deepnest_East_17[left1]'], 'Deepnest_East_18': ['Deepnest_East_18[top1]', 'Deepnest_East_18[bot1]', 'Deepnest_East_18[right2]'], 'Room_nailmaster_03': ['Room_nailmaster_03[left1]'], 'Deepnest_East_Hornet': ['Deepnest_East_Hornet[left1]', 'Deepnest_East_Hornet[left2]'], 'Room_Wyrm': ['Room_Wyrm[right1]'], 'GG_Lurker': ['GG_Lurker[left1]'], 'Hive_01': ['Hive_01[left1]', 'Hive_01[right1]', 'Hive_01[right2]'], 'Hive_02': ['Hive_02[left1]', 'Hive_02[left2]', 'Hive_02[left3]'], 'Hive_03_c': ['Hive_03_c[left1]', 'Hive_03_c[right2]', 'Hive_03_c[right3]', 'Hive_03_c[top1]'], 'Hive_03': ['Hive_03[bot1]', 'Hive_03[right1]', 'Hive_03[top1]'], 'Hive_04': ['Hive_04[left1]', 'Hive_04[left2]', 'Hive_04[right1]'], 'Hive_05': ['Hive_05[left1]'], 'Room_Colosseum_01': ['Room_Colosseum_01[left1]', 'Room_Colosseum_01[bot1]'], 'Room_Colosseum_02': ['Room_Colosseum_02[top1]', 'Room_Colosseum_02[top2]'], 'Room_Colosseum_Spectate': ['Room_Colosseum_Spectate[bot1]', 'Room_Colosseum_Spectate[right1]'], 'Abyss_01': ['Abyss_01[left1]', 'Abyss_01[left2]', 'Abyss_01[left3]', 'Abyss_01[right1]', 'Abyss_01[right2]'], 'Abyss_02': ['Abyss_02[right1]', 'Abyss_02[bot1]'], 'Abyss_03': ['Abyss_03[bot1]', 'Abyss_03[bot2]', 'Abyss_03[top1]'], 'Abyss_03_b': ['Abyss_03_b[left1]'], 'Abyss_03_c': ['Abyss_03_c[right1]', 'Abyss_03_c[top1]'], 'Abyss_04': ['Abyss_04[top1]', 'Abyss_04[left1]', 'Abyss_04[bot1]', 'Abyss_04[right1]'], 'Abyss_05': ['Abyss_05[left1]', 'Abyss_05[right1]'], 'Abyss_06_Core': ['Abyss_06_Core[top1]', 'Abyss_06_Core[left1]', 'Abyss_06_Core[left3]', 'Abyss_06_Core[right2]', 'Abyss_06_Core[bot1]'], 'Abyss_08': ['Abyss_08[right1]'], 'Abyss_09': ['Abyss_09[right1]', 'Abyss_09[right2]', 'Abyss_09[right3]', 'Abyss_09[left1]'], 'Abyss_10': ['Abyss_10[left1]', 'Abyss_10[left2]'], 'Abyss_12': ['Abyss_12[right1]'], 'Abyss_15': ['Abyss_15[top1]'], 'Abyss_16': ['Abyss_16[left1]', 'Abyss_16[right1]'], 'Abyss_17': ['Abyss_17[top1]'], 'Abyss_18': ['Abyss_18[left1]', 'Abyss_18[right1]'], 'Abyss_19': ['Abyss_19[left1]', 'Abyss_19[right1]', 'Abyss_19[bot1]', 'Abyss_19[bot2]'], 'Abyss_20': ['Abyss_20[top1]', 'Abyss_20[top2]'], 'Abyss_21': ['Abyss_21[right1]'], 'Abyss_22': ['Abyss_22[left1]'], 'Abyss_Lighthouse_room': ['Abyss_Lighthouse_room[left1]'], 'Waterways_01': ['Waterways_01[top1]', 'Waterways_01[left1]', 'Waterways_01[right1]', 'Waterways_01[bot1]'], 'Waterways_02': ['Waterways_02[top1]', 'Waterways_02[top2]', 'Waterways_02[top3]', 'Waterways_02[bot1]', 'Waterways_02[bot2]'], 'Waterways_03': ['Waterways_03[left1]'], 'Waterways_04': ['Waterways_04[bot1]', 'Waterways_04[right1]', 'Waterways_04[left1]', 'Waterways_04[left2]'], 'Waterways_04b': ['Waterways_04b[right1]', 'Waterways_04b[right2]', 'Waterways_04b[left1]'], 'Waterways_05': ['Waterways_05[right1]', 'Waterways_05[bot1]', 'Waterways_05[bot2]'], 'Waterways_06': ['Waterways_06[right1]', 'Waterways_06[top1]'], 'Waterways_07': ['Waterways_07[right1]', 'Waterways_07[right2]', 'Waterways_07[left1]', 'Waterways_07[door1]', 'Waterways_07[top1]'], 'Waterways_08': ['Waterways_08[top1]', 'Waterways_08[left1]', 'Waterways_08[left2]'], 'Waterways_09': ['Waterways_09[right1]', 'Waterways_09[left1]'], 'Waterways_12': ['Waterways_12[right1]'], 'Waterways_13': ['Waterways_13[left1]', 'Waterways_13[left2]'], 'Waterways_14': ['Waterways_14[bot1]', 'Waterways_14[bot2]'], 'Waterways_15': ['Waterways_15[top1]'], 'GG_Pipeway': ['GG_Pipeway[right1]', 'GG_Pipeway[left1]'], 'GG_Waterways': ['GG_Waterways[right1]', 'GG_Waterways[door1]'], 'Room_GG_Shortcut': ['Room_GG_Shortcut[left1]', 'Room_GG_Shortcut[top1]'], 'Ruins1_01': ['Ruins1_01[left1]', 'Ruins1_01[top1]', 'Ruins1_01[bot1]'], 'Ruins1_02': ['Ruins1_02[top1]', 'Ruins1_02[bot1]'], 'Ruins1_03': ['Ruins1_03[top1]', 'Ruins1_03[left1]', 'Ruins1_03[right1]', 'Ruins1_03[right2]'], 'Ruins1_04': ['Ruins1_04[right1]', 'Ruins1_04[door1]', 'Ruins1_04[bot1]'], 'Ruins1_05b': ['Ruins1_05b[left1]', 'Ruins1_05b[top1]', 'Ruins1_05b[bot1]', 'Ruins1_05b[right1]'], 'Ruins1_05c': ['Ruins1_05c[left2]', 'Ruins1_05c[bot1]', 'Ruins1_05c[top1]', 'Ruins1_05c[top2]', 'Ruins1_05c[top3]'], 'Ruins1_05': ['Ruins1_05[bot1]', 'Ruins1_05[bot2]', 'Ruins1_05[bot3]', 'Ruins1_05[right1]', 'Ruins1_05[right2]', 'Ruins1_05[top1]'], 'Ruins1_06': ['Ruins1_06[left1]', 'Ruins1_06[right1]'], 'Ruins1_09': ['Ruins1_09[top1]', 'Ruins1_09[left1]'], 'Ruins1_17': ['Ruins1_17[top1]', 'Ruins1_17[right1]', 'Ruins1_17[bot1]'], 'Ruins1_18': ['Ruins1_18[left1]', 'Ruins1_18[right1]', 'Ruins1_18[right2]'], 'Ruins1_23': ['Ruins1_23[top1]', 'Ruins1_23[right1]', 'Ruins1_23[right2]', 'Ruins1_23[bot1]', 'Ruins1_23[left1]'], 'Ruins1_24': ['Ruins1_24[left1]', 'Ruins1_24[right1]', 'Ruins1_24[left2]', 'Ruins1_24[right2]'], 'Ruins1_25': ['Ruins1_25[left1]', 'Ruins1_25[left2]', 'Ruins1_25[left3]'], 'Ruins1_27': ['Ruins1_27[left1]', 'Ruins1_27[right1]'], 'Ruins1_28': ['Ruins1_28[left1]', 'Ruins1_28[right1]', 'Ruins1_28[bot1]'], 'Ruins1_29': ['Ruins1_29[left1]'], 'Ruins1_30': ['Ruins1_30[left1]', 'Ruins1_30[left2]', 'Ruins1_30[bot1]', 'Ruins1_30[right1]'], 'Ruins1_31': ['Ruins1_31[bot1]', 'Ruins1_31[left1]', 'Ruins1_31[left2]', 'Ruins1_31[left3]', 'Ruins1_31[right1]'], 'Ruins1_31b': ['Ruins1_31b[right1]', 'Ruins1_31b[right2]'], 'Ruins1_32': ['Ruins1_32[right1]', 'Ruins1_32[right2]'], 'Room_nailsmith': ['Room_nailsmith[left1]'], 'Ruins2_01': ['Ruins2_01[top1]', 'Ruins2_01[bot1]', 'Ruins2_01[left2]'], 'Ruins2_01_b': ['Ruins2_01_b[top1]', 'Ruins2_01_b[left1]', 'Ruins2_01_b[right1]'], 'Ruins2_03b': ['Ruins2_03b[top1]', 'Ruins2_03b[top2]', 'Ruins2_03b[left1]', 'Ruins2_03b[bot1]'], 'Ruins2_03': ['Ruins2_03[top1]', 'Ruins2_03[bot1]', 'Ruins2_03[bot2]'], 'Ruins2_04': ['Ruins2_04[left1]', 'Ruins2_04[left2]', 'Ruins2_04[right1]', 'Ruins2_04[right2]', 'Ruins2_04[door_Ruin_House_01]', 'Ruins2_04[door_Ruin_House_02]', 'Ruins2_04[door_Ruin_House_03]', 'Ruins2_04[door_Ruin_Elevator]'], 'Ruins2_05': ['Ruins2_05[left1]', 'Ruins2_05[top1]', 'Ruins2_05[bot1]'], 'Ruins2_06': ['Ruins2_06[left1]', 'Ruins2_06[left2]', 'Ruins2_06[right1]', 'Ruins2_06[right2]', 'Ruins2_06[top1]'], 'Ruins2_07': ['Ruins2_07[right1]', 'Ruins2_07[left1]', 'Ruins2_07[top1]'], 'Ruins2_08': ['Ruins2_08[left1]'], 'Ruins2_09': ['Ruins2_09[bot1]'], 'Ruins2_10': ['Ruins2_10[right1]', 'Ruins2_10[left1]'], 'Ruins2_10b': ['Ruins2_10b[right1]', 'Ruins2_10b[right2]', 'Ruins2_10b[left1]'], 'Ruins2_11_b': ['Ruins2_11_b[right1]', 'Ruins2_11_b[left1]', 'Ruins2_11_b[bot1]'], 'Ruins2_11': ['Ruins2_11[right1]'], 'Ruins2_Watcher_Room': ['Ruins2_Watcher_Room[bot1]'], 'Ruins_House_01': ['Ruins_House_01[left1]'], 'Ruins_House_02': ['Ruins_House_02[left1]'], 'Ruins_House_03': ['Ruins_House_03[left1]', 'Ruins_House_03[left2]'], 'Ruins_Elevator': ['Ruins_Elevator[left1]', 'Ruins_Elevator[left2]'], 'Ruins_Bathhouse': ['Ruins_Bathhouse[door1]', 'Ruins_Bathhouse[right1]'], 'RestingGrounds_02': ['RestingGrounds_02[right1]', 'RestingGrounds_02[left1]', 'RestingGrounds_02[bot1]', 'RestingGrounds_02[top1]'], 'RestingGrounds_04': ['RestingGrounds_04[left1]', 'RestingGrounds_04[right1]'], 'RestingGrounds_05': ['RestingGrounds_05[left1]', 'RestingGrounds_05[left2]', 'RestingGrounds_05[left3]', 'RestingGrounds_05[right1]', 'RestingGrounds_05[right2]', 'RestingGrounds_05[bot1]'], 'RestingGrounds_06': ['RestingGrounds_06[left1]', 'RestingGrounds_06[right1]', 'RestingGrounds_06[top1]'], 'RestingGrounds_07': ['RestingGrounds_07[right1]'], 'RestingGrounds_08': ['RestingGrounds_08[left1]'], 'RestingGrounds_09': ['RestingGrounds_09[left1]'], 'RestingGrounds_10': ['RestingGrounds_10[left1]', 'RestingGrounds_10[top1]', 'RestingGrounds_10[top2]'], 'RestingGrounds_12': ['RestingGrounds_12[bot1]', 'RestingGrounds_12[door_Mansion]'], 'RestingGrounds_17': ['RestingGrounds_17[right1]'], 'Room_Mansion': ['Room_Mansion[left1]'], 'Mines_01': ['Mines_01[bot1]', 'Mines_01[left1]'], 'Mines_02': ['Mines_02[top1]', 'Mines_02[top2]', 'Mines_02[left1]', 'Mines_02[right1]'], 'Mines_03': ['Mines_03[right1]', 'Mines_03[bot1]', 'Mines_03[top1]'], 'Mines_04': ['Mines_04[right1]', 'Mines_04[top1]', 'Mines_04[left1]', 'Mines_04[left2]', 'Mines_04[left3]'], 'Mines_05': ['Mines_05[right1]', 'Mines_05[top1]', 'Mines_05[bot1]', 'Mines_05[left1]', 'Mines_05[left2]'], 'Mines_06': ['Mines_06[right1]', 'Mines_06[left1]'], 'Mines_07': ['Mines_07[right1]', 'Mines_07[left1]'], 'Mines_10': ['Mines_10[right1]', 'Mines_10[left1]', 'Mines_10[bot1]'], 'Mines_11': ['Mines_11[right1]', 'Mines_11[top1]', 'Mines_11[bot1]'], 'Mines_13': ['Mines_13[right1]', 'Mines_13[top1]', 'Mines_13[bot1]'], 'Mines_16': ['Mines_16[top1]'], 'Mines_17': ['Mines_17[right1]', 'Mines_17[left1]'], 'Mines_18': ['Mines_18[top1]', 'Mines_18[left1]', 'Mines_18[right1]'], 'Mines_19': ['Mines_19[left1]', 'Mines_19[right1]'], 'Mines_20': ['Mines_20[left1]', 'Mines_20[left2]', 'Mines_20[left3]', 'Mines_20[bot1]', 'Mines_20[right1]', 'Mines_20[right2]'], 'Mines_23': ['Mines_23[left1]', 'Mines_23[right1]', 'Mines_23[right2]', 'Mines_23[top1]'], 'Mines_24': ['Mines_24[left1]'], 'Mines_25': ['Mines_25[left1]', 'Mines_25[top1]'], 'Mines_28': ['Mines_28[left1]', 'Mines_28[bot1]', 'Mines_28[door1]'], 'Mines_29': ['Mines_29[left1]', 'Mines_29[right1]', 'Mines_29[right2]'], 'Mines_30': ['Mines_30[left1]', 'Mines_30[right1]'], 'Mines_31': ['Mines_31[left1]'], 'Mines_32': ['Mines_32[bot1]'], 'Mines_33': ['Mines_33[right1]', 'Mines_33[left1]'], 'Mines_34': ['Mines_34[bot1]', 'Mines_34[bot2]', 'Mines_34[left1]'], 'Mines_35': ['Mines_35[left1]'], 'Mines_36': ['Mines_36[right1]'], 'Mines_37': ['Mines_37[bot1]', 'Mines_37[top1]'], 'Fungus3_04': ['Fungus3_04[left1]', 'Fungus3_04[left2]', 'Fungus3_04[right1]', 'Fungus3_04[right2]'], 'Fungus3_05': ['Fungus3_05[left1]', 'Fungus3_05[right1]', 'Fungus3_05[right2]'], 'Fungus3_08': ['Fungus3_08[left1]', 'Fungus3_08[right1]', 'Fungus3_08[top1]'], 'Fungus3_10': ['Fungus3_10[top1]', 'Fungus3_10[bot1]'], 'Fungus3_11': ['Fungus3_11[left1]', 'Fungus3_11[left2]', 'Fungus3_11[right1]'], 'Fungus3_13': ['Fungus3_13[left1]', 'Fungus3_13[left2]', 'Fungus3_13[left3]', 'Fungus3_13[bot1]', 'Fungus3_13[right1]'], 'Fungus3_21': ['Fungus3_21[right1]', 'Fungus3_21[top1]'], 'Fungus3_22': ['Fungus3_22[right1]', 'Fungus3_22[left1]', 'Fungus3_22[bot1]'], 'Fungus3_23': ['Fungus3_23[right1]', 'Fungus3_23[left1]'], 'Fungus3_34': ['Fungus3_34[right1]', 'Fungus3_34[left1]', 'Fungus3_34[top1]'], 'Fungus3_39': ['Fungus3_39[right1]', 'Fungus3_39[left1]'], 'Fungus3_40': ['Fungus3_40[right1]', 'Fungus3_40[top1]'], 'Fungus3_48': ['Fungus3_48[right1]', 'Fungus3_48[right2]', 'Fungus3_48[door1]', 'Fungus3_48[bot1]'], 'Fungus3_49': ['Fungus3_49[right1]'], 'Fungus3_50': ['Fungus3_50[right1]'], 'Room_Queen': ['Room_Queen[left1]'], 'Cliffs_01': ['Cliffs_01[right1]', 'Cliffs_01[right2]', 'Cliffs_01[right3]', 'Cliffs_01[right4]'], 'Cliffs_02': ['Cliffs_02[right1]', 'Cliffs_02[bot1]', 'Cliffs_02[bot2]', 'Cliffs_02[door1]', 'Cliffs_02[left1]', 'Cliffs_02[left2]'], 'Cliffs_03': ['Cliffs_03[right1]'], 'Cliffs_04': ['Cliffs_04[right1]', 'Cliffs_04[left1]'], 'Cliffs_05': ['Cliffs_05[left1]'], 'Cliffs_06': ['Cliffs_06[left1]'], 'Room_nailmaster': ['Room_nailmaster[left1]'], 'White_Palace_01': ['White_Palace_01[left1]', 'White_Palace_01[right1]', 'White_Palace_01[top1]'], 'White_Palace_02': ['White_Palace_02[left1]'], 'White_Palace_03_hub': ['White_Palace_03_hub[left1]', 'White_Palace_03_hub[left2]', 'White_Palace_03_hub[right1]', 'White_Palace_03_hub[top1]', 'White_Palace_03_hub[bot1]'], 'White_Palace_04': ['White_Palace_04[top1]', 'White_Palace_04[right2]'], 'White_Palace_05': ['White_Palace_05[left1]', 'White_Palace_05[left2]', 'White_Palace_05[right1]', 'White_Palace_05[right2]'], 'White_Palace_06': ['White_Palace_06[left1]', 'White_Palace_06[top1]', 'White_Palace_06[bot1]'], 'White_Palace_07': ['White_Palace_07[top1]', 'White_Palace_07[bot1]'], 'White_Palace_08': ['White_Palace_08[left1]', 'White_Palace_08[right1]'], 'White_Palace_09': ['White_Palace_09[right1]'], 'White_Palace_11': ['White_Palace_11[door2]'], 'White_Palace_12': ['White_Palace_12[right1]', 'White_Palace_12[bot1]'], 'White_Palace_13': ['White_Palace_13[right1]', 'White_Palace_13[left1]', 'White_Palace_13[left2]', 'White_Palace_13[left3]'], 'White_Palace_14': ['White_Palace_14[bot1]', 'White_Palace_14[right1]'], 'White_Palace_15': ['White_Palace_15[left1]', 'White_Palace_15[right1]', 'White_Palace_15[right2]'], 'White_Palace_16': ['White_Palace_16[left1]', 'White_Palace_16[left2]'], 'White_Palace_17': ['White_Palace_17[right1]', 'White_Palace_17[bot1]'], 'White_Palace_18': ['White_Palace_18[top1]', 'White_Palace_18[right1]'], 'White_Palace_19': ['White_Palace_19[top1]', 'White_Palace_19[left1]'], 'White_Palace_20': ['White_Palace_20[bot1]']} -item_effects = {'Lurien': {'DREAMER': 1}, 'Monomon': {'DREAMER': 1}, 'Herrah': {'DREAMER': 1}, 'Dreamer': {'DREAMER': 1}, 'Mothwing_Cloak': {'LEFTDASH': 1, 'RIGHTDASH': 1}, 'Mantis_Claw': {'LEFTCLAW': 1, 'RIGHTCLAW': 1}, 'Crystal_Heart': {'LEFTSUPERDASH': 1, 'RIGHTSUPERDASH': 1}, 'Monarch_Wings': {'WINGS': 1}, 'Shade_Cloak': {'LEFTDASH': 1, 'RIGHTDASH': 1}, "Isma's_Tear": {'ACID': 1}, 'Dream_Nail': {'DREAMNAIL': 1}, 'Dream_Gate': {'DREAMNAIL': 1}, 'Awoken_Dream_Nail': {'DREAMNAIL': 1}, 'Vengeful_Spirit': {'FIREBALL': 1, 'SPELLS': 1}, 'Shade_Soul': {'FIREBALL': 1, 'SPELLS': 1}, 'Desolate_Dive': {'QUAKE': 1, 'SPELLS': 1}, 'Descending_Dark': {'QUAKE': 1, 'SPELLS': 1}, 'Howling_Wraiths': {'SCREAM': 1, 'SPELLS': 1}, 'Abyss_Shriek': {'SCREAM': 1, 'SPELLS': 1}, 'Cyclone_Slash': {'CYCLONE': 1}, 'Focus': {'FOCUS': 1}, 'Swim': {'SWIM': 1}, 'Gathering_Swarm': {'CHARMS': 1}, 'Wayward_Compass': {'CHARMS': 1}, 'Grubsong': {'CHARMS': 1}, 'Stalwart_Shell': {'CHARMS': 1}, 'Baldur_Shell': {'CHARMS': 1}, 'Fury_of_the_Fallen': {'CHARMS': 1}, 'Quick_Focus': {'CHARMS': 1}, 'Lifeblood_Heart': {'CHARMS': 1}, 'Lifeblood_Core': {'CHARMS': 1}, "Defender's_Crest": {'CHARMS': 1}, 'Flukenest': {'CHARMS': 1}, 'Thorns_of_Agony': {'CHARMS': 1}, 'Mark_of_Pride': {'CHARMS': 1}, 'Steady_Body': {'CHARMS': 1}, 'Heavy_Blow': {'CHARMS': 1}, 'Sharp_Shadow': {'CHARMS': 1}, 'Spore_Shroom': {'CHARMS': 1}, 'Longnail': {'CHARMS': 1}, 'Shaman_Stone': {'CHARMS': 1}, 'Soul_Catcher': {'CHARMS': 1}, 'Soul_Eater': {'CHARMS': 1}, 'Glowing_Womb': {'CHARMS': 1}, 'Fragile_Heart': {'CHARMS': 1}, 'Unbreakable_Heart': {'Fragile_Heart': 1, 'CHARMS': 1}, 'Fragile_Greed': {'CHARMS': 1}, 'Unbreakable_Greed': {'Fragile_Greed': 1, 'CHARMS': 1}, 'Fragile_Strength': {'CHARMS': 1}, 'Unbreakable_Strength': {'Fragile_Strength': 1, 'CHARMS': 1}, "Nailmaster's_Glory": {'CHARMS': 1}, "Joni's_Blessing": {'CHARMS': 1}, 'Shape_of_Unn': {'CHARMS': 1}, 'Hiveblood': {'CHARMS': 1}, 'Dream_Wielder': {'CHARMS': 1}, 'Dashmaster': {'CHARMS': 1}, 'Quick_Slash': {'CHARMS': 1}, 'Spell_Twister': {'CHARMS': 1}, 'Deep_Focus': {'CHARMS': 1}, "Grubberfly's_Elegy": {'CHARMS': 1}, 'Queen_Fragment': {'WHITEFRAGMENT': 1}, 'King_Fragment': {'WHITEFRAGMENT': 1}, 'Void_Heart': {'WHITEFRAGMENT': 1}, 'Sprintmaster': {'CHARMS': 1}, 'Dreamshield': {'CHARMS': 1}, 'Weaversong': {'CHARMS': 1}, 'Grimmchild1': {'GRIMMCHILD': 1, 'CHARMS': 1}, 'Grimmchild2': {'GRIMMCHILD': 1, 'CHARMS': 1, 'FLAMES': 6, 'First_Grimmchild_Upgrade': 1}, 'City_Crest': {'CREST': 1}, 'Lumafly_Lantern': {'LANTERN': 1}, 'Tram_Pass': {'TRAM': 1}, 'Simple_Key': {'SIMPLE': 1}, "Shopkeeper's_Key": {'SHOPKEY': 1}, 'Elegant_Key': {'ELEGANT': 1}, 'Love_Key': {'LOVE': 1}, "King's_Brand": {'BRAND': 1}, 'Mask_Shard': {'MASKSHARDS': 1}, 'Double_Mask_Shard': {'MASKSHARDS': 2}, 'Full_Mask': {'MASKSHARDS': 4}, 'Vessel_Fragment': {'VESSELFRAGMENTS': 1}, 'Double_Vessel_Fragment': {'VESSELFRAGMENTS': 2}, 'Full_Soul_Vessel': {'VESSELFRAGMENTS': 3}, 'Charm_Notch': {'NOTCHES': 1}, 'Pale_Ore': {'PALEORE': 1}, 'Rancid_Egg': {'RANCIDEGGS': 1}, 'Whispering_Root-Crossroads': {'ESSENCE': 29}, 'Whispering_Root-Greenpath': {'ESSENCE': 44}, 'Whispering_Root-Leg_Eater': {'ESSENCE': 20}, 'Whispering_Root-Mantis_Village': {'ESSENCE': 18}, 'Whispering_Root-Deepnest': {'ESSENCE': 45}, 'Whispering_Root-Queens_Gardens': {'ESSENCE': 29}, 'Whispering_Root-Kingdoms_Edge': {'ESSENCE': 51}, 'Whispering_Root-Waterways': {'ESSENCE': 35}, 'Whispering_Root-City': {'ESSENCE': 28}, 'Whispering_Root-Resting_Grounds': {'ESSENCE': 20}, 'Whispering_Root-Spirits_Glade': {'ESSENCE': 34}, 'Whispering_Root-Crystal_Peak': {'ESSENCE': 21}, 'Whispering_Root-Howling_Cliffs': {'ESSENCE': 46}, 'Whispering_Root-Ancestral_Mound': {'ESSENCE': 42}, 'Whispering_Root-Hive': {'ESSENCE': 20}, 'Boss_Essence-Elder_Hu': {'ESSENCE': 100}, 'Boss_Essence-Xero': {'ESSENCE': 100}, 'Boss_Essence-Gorb': {'ESSENCE': 100}, 'Boss_Essence-Marmu': {'ESSENCE': 150}, 'Boss_Essence-No_Eyes': {'ESSENCE': 200}, 'Boss_Essence-Galien': {'ESSENCE': 200}, 'Boss_Essence-Markoth': {'ESSENCE': 250}, 'Boss_Essence-Failed_Champion': {'ESSENCE': 300}, 'Boss_Essence-Soul_Tyrant': {'ESSENCE': 300}, 'Boss_Essence-Lost_Kin': {'ESSENCE': 400}, 'Boss_Essence-White_Defender': {'ESSENCE': 300}, 'Boss_Essence-Grey_Prince_Zote': {'ESSENCE': 300}, 'Grub': {'GRUBS': 1}, 'Quill': {'QUILL': 1}, 'Crossroads_Stag': {'STAGS': 1}, 'Greenpath_Stag': {'STAGS': 1}, "Queen's_Station_Stag": {'STAGS': 1}, "Queen's_Gardens_Stag": {'STAGS': 1}, 'City_Storerooms_Stag': {'STAGS': 1}, "King's_Station_Stag": {'STAGS': 1}, 'Resting_Grounds_Stag': {'STAGS': 1}, 'Distant_Village_Stag': {'STAGS': 1}, 'Hidden_Station_Stag': {'STAGS': 1}, 'Stag_Nest_Stag': {'STAGS': 1}, 'Grimmkin_Flame': {'FLAMES': 1}, "Hunter's_Journal": {'JOURNAL': 1}, 'Right_Mantis_Claw': {'RIGHTCLAW': 1}, 'Left_Mantis_Claw': {'LEFTCLAW': 1}, 'Leftslash': {'LEFTSLASH': 1}, 'Rightslash': {'RIGHTSLASH': 1}, 'Upslash': {'UPSLASH': 1}, 'Downslash': {'DOWNSLASH': 1}, 'Left_Crystal_Heart': {'LEFTSUPERDASH': 1}, 'Right_Crystal_Heart': {'RIGHTSUPERDASH': 1}, 'Left_Mothwing_Cloak': {'LEFTDASH': 1}, 'Right_Mothwing_Cloak': {'RIGHTDASH': 1}} +item_effects = {'Lurien': {'DREAMER': 1}, 'Monomon': {'DREAMER': 1}, 'Herrah': {'DREAMER': 1}, 'Dreamer': {'DREAMER': 1}, 'Mothwing_Cloak': {'LEFTDASH': 1, 'RIGHTDASH': 1}, 'Mantis_Claw': {'LEFTCLAW': 1, 'RIGHTCLAW': 1}, 'Crystal_Heart': {'LEFTSUPERDASH': 1, 'RIGHTSUPERDASH': 1}, 'Monarch_Wings': {'WINGS': 1}, 'Shade_Cloak': {'LEFTDASH': 1, 'RIGHTDASH': 1}, "Isma's_Tear": {'ACID': 1}, 'Dream_Nail': {'DREAMNAIL': 1}, 'Dream_Gate': {'DREAMNAIL': 1}, 'Awoken_Dream_Nail': {'DREAMNAIL': 1}, 'Vengeful_Spirit': {'FIREBALL': 1, 'SPELLS': 1}, 'Shade_Soul': {'FIREBALL': 1, 'SPELLS': 1}, 'Desolate_Dive': {'QUAKE': 1, 'SPELLS': 1}, 'Descending_Dark': {'QUAKE': 1, 'SPELLS': 1}, 'Howling_Wraiths': {'SCREAM': 1, 'SPELLS': 1}, 'Abyss_Shriek': {'SCREAM': 1, 'SPELLS': 1}, 'Cyclone_Slash': {'CYCLONE': 1}, 'Focus': {'FOCUS': 1}, 'Swim': {'SWIM': 1}, 'Gathering_Swarm': {'CHARMS': 1}, 'Wayward_Compass': {'CHARMS': 1}, 'Grubsong': {'CHARMS': 1}, 'Stalwart_Shell': {'CHARMS': 1}, 'Baldur_Shell': {'CHARMS': 1}, 'Fury_of_the_Fallen': {'CHARMS': 1}, 'Quick_Focus': {'CHARMS': 1}, 'Lifeblood_Heart': {'CHARMS': 1}, 'Lifeblood_Core': {'CHARMS': 1}, "Defender's_Crest": {'CHARMS': 1}, 'Flukenest': {'CHARMS': 1}, 'Thorns_of_Agony': {'CHARMS': 1}, 'Mark_of_Pride': {'CHARMS': 1}, 'Steady_Body': {'CHARMS': 1}, 'Heavy_Blow': {'CHARMS': 1}, 'Sharp_Shadow': {'CHARMS': 1}, 'Spore_Shroom': {'CHARMS': 1}, 'Longnail': {'CHARMS': 1}, 'Shaman_Stone': {'CHARMS': 1}, 'Soul_Catcher': {'CHARMS': 1}, 'Soul_Eater': {'CHARMS': 1}, 'Glowing_Womb': {'CHARMS': 1}, 'Fragile_Heart': {'CHARMS': 1}, 'Fragile_Greed': {'CHARMS': 1}, 'Fragile_Strength': {'CHARMS': 1}, "Nailmaster's_Glory": {'CHARMS': 1}, "Joni's_Blessing": {'CHARMS': 1}, 'Shape_of_Unn': {'CHARMS': 1}, 'Hiveblood': {'CHARMS': 1}, 'Dream_Wielder': {'CHARMS': 1}, 'Dashmaster': {'CHARMS': 1}, 'Quick_Slash': {'CHARMS': 1}, 'Spell_Twister': {'CHARMS': 1}, 'Deep_Focus': {'CHARMS': 1}, "Grubberfly's_Elegy": {'CHARMS': 1}, 'Queen_Fragment': {'CHARMS': 0.5, 'WHITEFRAGMENT': 1}, 'King_Fragment': {'CHARMS': 0.5, 'WHITEFRAGMENT': 1}, 'Void_Heart': {'CHARMS': 0.5, 'WHITEFRAGMENT': 1}, 'Sprintmaster': {'CHARMS': 1}, 'Dreamshield': {'CHARMS': 1}, 'Weaversong': {'CHARMS': 1}, 'Grimmchild1': {'GRIMMCHILD': 1, 'CHARMS': 1}, 'Grimmchild2': {'GRIMMCHILD': 1, 'CHARMS': 1, 'FLAMES': 6, 'First_Grimmchild_Upgrade': 1}, 'City_Crest': {'CREST': 1}, 'Lumafly_Lantern': {'LANTERN': 1}, 'Tram_Pass': {'TRAM': 1}, 'Simple_Key': {'SIMPLE': 1}, "Shopkeeper's_Key": {'SHOPKEY': 1}, 'Elegant_Key': {'ELEGANT': 1}, 'Love_Key': {'LOVE': 1}, "King's_Brand": {'BRAND': 1}, 'Mask_Shard': {'MASKSHARDS': 1}, 'Double_Mask_Shard': {'MASKSHARDS': 2}, 'Full_Mask': {'MASKSHARDS': 4}, 'Vessel_Fragment': {'VESSELFRAGMENTS': 1}, 'Double_Vessel_Fragment': {'VESSELFRAGMENTS': 2}, 'Full_Soul_Vessel': {'VESSELFRAGMENTS': 3}, 'Charm_Notch': {'NOTCHES': 1}, 'Pale_Ore': {'PALEORE': 1}, 'Rancid_Egg': {'RANCIDEGGS': 1}, 'Whispering_Root-Crossroads': {'ESSENCE': 29}, 'Whispering_Root-Greenpath': {'ESSENCE': 44}, 'Whispering_Root-Leg_Eater': {'ESSENCE': 20}, 'Whispering_Root-Mantis_Village': {'ESSENCE': 18}, 'Whispering_Root-Deepnest': {'ESSENCE': 45}, 'Whispering_Root-Queens_Gardens': {'ESSENCE': 29}, 'Whispering_Root-Kingdoms_Edge': {'ESSENCE': 51}, 'Whispering_Root-Waterways': {'ESSENCE': 35}, 'Whispering_Root-City': {'ESSENCE': 28}, 'Whispering_Root-Resting_Grounds': {'ESSENCE': 20}, 'Whispering_Root-Spirits_Glade': {'ESSENCE': 34}, 'Whispering_Root-Crystal_Peak': {'ESSENCE': 21}, 'Whispering_Root-Howling_Cliffs': {'ESSENCE': 46}, 'Whispering_Root-Ancestral_Mound': {'ESSENCE': 42}, 'Whispering_Root-Hive': {'ESSENCE': 20}, 'Boss_Essence-Elder_Hu': {'ESSENCE': 100}, 'Boss_Essence-Xero': {'ESSENCE': 100}, 'Boss_Essence-Gorb': {'ESSENCE': 100}, 'Boss_Essence-Marmu': {'ESSENCE': 150}, 'Boss_Essence-No_Eyes': {'ESSENCE': 200}, 'Boss_Essence-Galien': {'ESSENCE': 200}, 'Boss_Essence-Markoth': {'ESSENCE': 250}, 'Boss_Essence-Failed_Champion': {'ESSENCE': 300}, 'Boss_Essence-Soul_Tyrant': {'ESSENCE': 300}, 'Boss_Essence-Lost_Kin': {'ESSENCE': 400}, 'Boss_Essence-White_Defender': {'ESSENCE': 300}, 'Boss_Essence-Grey_Prince_Zote': {'ESSENCE': 300}, 'Grub': {'GRUBS': 1}, 'Quill': {'QUILL': 1}, 'Crossroads_Stag': {'STAGS': 1}, 'Greenpath_Stag': {'STAGS': 1}, "Queen's_Station_Stag": {'STAGS': 1}, "Queen's_Gardens_Stag": {'STAGS': 1}, 'City_Storerooms_Stag': {'STAGS': 1}, "King's_Station_Stag": {'STAGS': 1}, 'Resting_Grounds_Stag': {'STAGS': 1}, 'Distant_Village_Stag': {'STAGS': 1}, 'Hidden_Station_Stag': {'STAGS': 1}, 'Stag_Nest_Stag': {'STAGS': 1}, 'Grimmkin_Flame': {'FLAMES': 1}, "Hunter's_Journal": {'JOURNAL': 1}, 'Right_Mantis_Claw': {'RIGHTCLAW': 1}, 'Left_Mantis_Claw': {'LEFTCLAW': 1}, 'Leftslash': {'LEFTSLASH': 1}, 'Rightslash': {'RIGHTSLASH': 1}, 'Upslash': {'UPSLASH': 1}, 'Downslash': {'DOWNSLASH': 1}, 'Left_Crystal_Heart': {'LEFTSUPERDASH': 1}, 'Right_Crystal_Heart': {'RIGHTSUPERDASH': 1}, 'Left_Mothwing_Cloak': {'LEFTDASH': 1}, 'Right_Mothwing_Cloak': {'RIGHTDASH': 1}} items = {'Lurien': 'Dreamer', 'Monomon': 'Dreamer', 'Herrah': 'Dreamer', 'World_Sense': 'Dreamer', 'Dreamer': 'Fake', 'Mothwing_Cloak': 'Skill', 'Mantis_Claw': 'Skill', 'Crystal_Heart': 'Skill', 'Monarch_Wings': 'Skill', 'Shade_Cloak': 'Skill', "Isma's_Tear": 'Skill', 'Dream_Nail': 'Skill', 'Dream_Gate': 'Skill', 'Awoken_Dream_Nail': 'Skill', 'Vengeful_Spirit': 'Skill', 'Shade_Soul': 'Skill', 'Desolate_Dive': 'Skill', 'Descending_Dark': 'Skill', 'Howling_Wraiths': 'Skill', 'Abyss_Shriek': 'Skill', 'Cyclone_Slash': 'Skill', 'Dash_Slash': 'Skill', 'Great_Slash': 'Skill', 'Focus': 'Focus', 'Swim': 'Swim', 'Gathering_Swarm': 'Charm', 'Wayward_Compass': 'Charm', 'Grubsong': 'Charm', 'Stalwart_Shell': 'Charm', 'Baldur_Shell': 'Charm', 'Fury_of_the_Fallen': 'Charm', 'Quick_Focus': 'Charm', 'Lifeblood_Heart': 'Charm', 'Lifeblood_Core': 'Charm', "Defender's_Crest": 'Charm', 'Flukenest': 'Charm', 'Thorns_of_Agony': 'Charm', 'Mark_of_Pride': 'Charm', 'Steady_Body': 'Charm', 'Heavy_Blow': 'Charm', 'Sharp_Shadow': 'Charm', 'Spore_Shroom': 'Charm', 'Longnail': 'Charm', 'Shaman_Stone': 'Charm', 'Soul_Catcher': 'Charm', 'Soul_Eater': 'Charm', 'Glowing_Womb': 'Charm', 'Fragile_Heart': 'Charm', 'Unbreakable_Heart': 'Charm', 'Fragile_Greed': 'Charm', 'Unbreakable_Greed': 'Charm', 'Fragile_Strength': 'Charm', 'Unbreakable_Strength': 'Charm', "Nailmaster's_Glory": 'Charm', "Joni's_Blessing": 'Charm', 'Shape_of_Unn': 'Charm', 'Hiveblood': 'Charm', 'Dream_Wielder': 'Charm', 'Dashmaster': 'Charm', 'Quick_Slash': 'Charm', 'Spell_Twister': 'Charm', 'Deep_Focus': 'Charm', "Grubberfly's_Elegy": 'Charm', 'Queen_Fragment': 'Charm', 'King_Fragment': 'Charm', 'Void_Heart': 'Charm', 'Sprintmaster': 'Charm', 'Dreamshield': 'Charm', 'Weaversong': 'Charm', 'Grimmchild1': 'Charm', 'Grimmchild2': 'Charm', 'City_Crest': 'Key', 'Lumafly_Lantern': 'Key', 'Tram_Pass': 'Key', 'Simple_Key': 'Key', "Shopkeeper's_Key": 'Key', 'Elegant_Key': 'Key', 'Love_Key': 'Key', "King's_Brand": 'Key', 'Godtuner': 'Key', "Collector's_Map": 'Key', 'Mask_Shard': 'Mask', 'Double_Mask_Shard': 'Mask', 'Full_Mask': 'Mask', 'Vessel_Fragment': 'Vessel', 'Double_Vessel_Fragment': 'Vessel', 'Full_Soul_Vessel': 'Vessel', 'Charm_Notch': 'Notch', "Salubra's_Blessing": 'Notch', 'Pale_Ore': 'Ore', 'Geo_Chest-False_Knight': 'Geo', 'Geo_Chest-Soul_Master': 'Geo', 'Geo_Chest-Watcher_Knights': 'Geo', 'Geo_Chest-Greenpath': 'Geo', 'Geo_Chest-Mantis_Lords': 'Geo', 'Geo_Chest-Resting_Grounds': 'Geo', 'Geo_Chest-Crystal_Peak': 'Geo', 'Geo_Chest-Weavers_Den': 'Geo', 'Geo_Chest-Junk_Pit_1': 'JunkPitChest', 'Geo_Chest-Junk_Pit_2': 'JunkPitChest', 'Geo_Chest-Junk_Pit_3': 'JunkPitChest', 'Geo_Chest-Junk_Pit_5': 'JunkPitChest', 'Lumafly_Escape': 'JunkPitChest', 'One_Geo': 'Fake', 'Rancid_Egg': 'Egg', "Wanderer's_Journal": 'Relic', 'Hallownest_Seal': 'Relic', "King's_Idol": 'Relic', 'Arcane_Egg': 'Relic', 'Whispering_Root-Crossroads': 'Root', 'Whispering_Root-Greenpath': 'Root', 'Whispering_Root-Leg_Eater': 'Root', 'Whispering_Root-Mantis_Village': 'Root', 'Whispering_Root-Deepnest': 'Root', 'Whispering_Root-Queens_Gardens': 'Root', 'Whispering_Root-Kingdoms_Edge': 'Root', 'Whispering_Root-Waterways': 'Root', 'Whispering_Root-City': 'Root', 'Whispering_Root-Resting_Grounds': 'Root', 'Whispering_Root-Spirits_Glade': 'Root', 'Whispering_Root-Crystal_Peak': 'Root', 'Whispering_Root-Howling_Cliffs': 'Root', 'Whispering_Root-Ancestral_Mound': 'Root', 'Whispering_Root-Hive': 'Root', 'Boss_Essence-Elder_Hu': 'DreamWarrior', 'Boss_Essence-Xero': 'DreamWarrior', 'Boss_Essence-Gorb': 'DreamWarrior', 'Boss_Essence-Marmu': 'DreamWarrior', 'Boss_Essence-No_Eyes': 'DreamWarrior', 'Boss_Essence-Galien': 'DreamWarrior', 'Boss_Essence-Markoth': 'DreamWarrior', 'Boss_Essence-Failed_Champion': 'DreamBoss', 'Boss_Essence-Soul_Tyrant': 'DreamBoss', 'Boss_Essence-Lost_Kin': 'DreamBoss', 'Boss_Essence-White_Defender': 'DreamBoss', 'Boss_Essence-Grey_Prince_Zote': 'DreamBoss', 'Grub': 'Grub', 'Mimic_Grub': 'Mimic', 'Quill': 'Map', 'Crossroads_Map': 'Map', 'Greenpath_Map': 'Map', 'Fog_Canyon_Map': 'Map', 'Fungal_Wastes_Map': 'Map', 'Deepnest_Map': 'Map', 'Ancient_Basin_Map': 'Map', "Kingdom's_Edge_Map": 'Map', 'City_of_Tears_Map': 'Map', 'Royal_Waterways_Map': 'Map', 'Howling_Cliffs_Map': 'Map', 'Crystal_Peak_Map': 'Map', "Queen's_Gardens_Map": 'Map', 'Resting_Grounds_Map': 'Map', 'Dirtmouth_Stag': 'Stag', 'Crossroads_Stag': 'Stag', 'Greenpath_Stag': 'Stag', "Queen's_Station_Stag": 'Stag', "Queen's_Gardens_Stag": 'Stag', 'City_Storerooms_Stag': 'Stag', "King's_Station_Stag": 'Stag', 'Resting_Grounds_Stag': 'Stag', 'Distant_Village_Stag': 'Stag', 'Hidden_Station_Stag': 'Stag', 'Stag_Nest_Stag': 'Stag', 'Lifeblood_Cocoon_Small': 'Cocoon', 'Lifeblood_Cocoon_Large': 'Cocoon', 'Grimmkin_Flame': 'Flame', "Hunter's_Journal": 'Journal', 'Journal_Entry-Void_Tendrils': 'Journal', 'Journal_Entry-Charged_Lumafly': 'Journal', 'Journal_Entry-Goam': 'Journal', 'Journal_Entry-Garpede': 'Journal', 'Journal_Entry-Seal_of_Binding': 'Journal', 'Elevator_Pass': 'ElevatorPass', 'Left_Mothwing_Cloak': 'SplitCloak', 'Right_Mothwing_Cloak': 'SplitCloak', 'Split_Shade_Cloak': 'SplitCloak', 'Left_Mantis_Claw': 'SplitClaw', 'Right_Mantis_Claw': 'SplitClaw', 'Leftslash': 'CursedNail', 'Rightslash': 'CursedNail', 'Upslash': 'CursedNail', 'Downslash': 'CursedNail', 'Left_Crystal_Heart': 'SplitSuperdash', 'Right_Crystal_Heart': 'SplitSuperdash', 'Geo_Rock-Default': 'Rock', 'Geo_Rock-Deepnest': 'Rock', 'Geo_Rock-Abyss': 'Rock', 'Geo_Rock-GreenPath01': 'Rock', 'Geo_Rock-Outskirts': 'Rock', 'Geo_Rock-Outskirts420': 'Rock', 'Geo_Rock-GreenPath02': 'Rock', 'Geo_Rock-Fung01': 'Rock', 'Geo_Rock-Fung02': 'Rock', 'Geo_Rock-City': 'Rock', 'Geo_Rock-Hive': 'Rock', 'Geo_Rock-Mine': 'Rock', 'Geo_Rock-Grave02': 'Rock', 'Geo_Rock-Grave01': 'Rock', 'Boss_Geo-Massive_Moss_Charger': 'Boss_Geo', 'Boss_Geo-Gorgeous_Husk': 'Boss_Geo', 'Boss_Geo-Sanctum_Soul_Warrior': 'Boss_Geo', 'Boss_Geo-Elegant_Soul_Warrior': 'Boss_Geo', 'Boss_Geo-Crystal_Guardian': 'Boss_Geo', 'Boss_Geo-Enraged_Guardian': 'Boss_Geo', 'Boss_Geo-Gruz_Mother': 'Boss_Geo', 'Boss_Geo-Vengefly_King': 'Boss_Geo', 'Soul_Refill': 'Soul', 'Soul_Totem-A': 'Soul', 'Soul_Totem-B': 'Soul', 'Soul_Totem-C': 'Soul', 'Soul_Totem-D': 'Soul', 'Soul_Totem-E': 'Soul', 'Soul_Totem-F': 'Soul', 'Soul_Totem-G': 'Soul', 'Soul_Totem-Palace': 'Soul', 'Soul_Totem-Path_of_Pain': 'Soul', 'Lore_Tablet-City_Entrance': 'Lore', 'Lore_Tablet-Pleasure_House': 'Lore', 'Lore_Tablet-Sanctum_Entrance': 'Lore', 'Lore_Tablet-Sanctum_Past_Soul_Master': 'Lore', "Lore_Tablet-Watcher's_Spire": 'Lore', 'Lore_Tablet-Archives_Upper': 'Lore', 'Lore_Tablet-Archives_Left': 'Lore', 'Lore_Tablet-Archives_Right': 'Lore', "Lore_Tablet-Pilgrim's_Way_1": 'Lore', "Lore_Tablet-Pilgrim's_Way_2": 'Lore', 'Lore_Tablet-Mantis_Outskirts': 'Lore', 'Lore_Tablet-Mantis_Village': 'Lore', 'Lore_Tablet-Greenpath_Upper_Hidden': 'Lore', 'Lore_Tablet-Greenpath_Below_Toll': 'Lore', 'Lore_Tablet-Greenpath_Lifeblood': 'Lore', 'Lore_Tablet-Greenpath_Stag': 'Lore', 'Lore_Tablet-Greenpath_QG': 'Lore', 'Lore_Tablet-Greenpath_Lower_Hidden': 'Lore', 'Lore_Tablet-Dung_Defender': 'Lore', 'Lore_Tablet-Spore_Shroom': 'Lore', 'Lore_Tablet-Fungal_Wastes_Hidden': 'Lore', 'Lore_Tablet-Fungal_Wastes_Below_Shrumal_Ogres': 'Lore', 'Lore_Tablet-Fungal_Core': 'Lore', 'Lore_Tablet-Ancient_Basin': 'Lore', "Lore_Tablet-King's_Pass_Focus": 'Lore', "Lore_Tablet-King's_Pass_Fury": 'Lore', "Lore_Tablet-King's_Pass_Exit": 'Lore', 'Lore_Tablet-World_Sense': 'Lore', 'Lore_Tablet-Howling_Cliffs': 'Lore', "Lore_Tablet-Kingdom's_Edge": 'Lore', 'Lore_Tablet-Palace_Workshop': 'PalaceLore', 'Lore_Tablet-Palace_Throne': 'PalaceLore', 'Lore_Tablet-Path_of_Pain_Entrance': 'PalaceLore'} location_to_region_lookup = {'Sly_1': 'Room_shop', 'Sly_2': 'Room_shop', 'Sly_3': 'Room_shop', 'Sly_4': 'Room_shop', 'Sly_5': 'Room_shop', 'Sly_6': 'Room_shop', 'Sly_7': 'Room_shop', 'Sly_8': 'Room_shop', 'Sly_9': 'Room_shop', 'Sly_10': 'Room_shop', 'Sly_11': 'Room_shop', 'Sly_12': 'Room_shop', 'Sly_13': 'Room_shop', 'Sly_14': 'Room_shop', 'Sly_15': 'Room_shop', 'Sly_16': 'Room_shop', 'Sly_(Key)_1': 'Room_shop', 'Sly_(Key)_2': 'Room_shop', 'Sly_(Key)_3': 'Room_shop', 'Sly_(Key)_4': 'Room_shop', 'Sly_(Key)_5': 'Room_shop', 'Sly_(Key)_6': 'Room_shop', 'Sly_(Key)_7': 'Room_shop', 'Sly_(Key)_8': 'Room_shop', 'Sly_(Key)_9': 'Room_shop', 'Sly_(Key)_10': 'Room_shop', 'Sly_(Key)_11': 'Room_shop', 'Sly_(Key)_12': 'Room_shop', 'Sly_(Key)_13': 'Room_shop', 'Sly_(Key)_14': 'Room_shop', 'Sly_(Key)_15': 'Room_shop', 'Sly_(Key)_16': 'Room_shop', 'Iselda_1': 'Room_mapper', 'Iselda_2': 'Room_mapper', 'Iselda_3': 'Room_mapper', 'Iselda_4': 'Room_mapper', 'Iselda_5': 'Room_mapper', 'Iselda_6': 'Room_mapper', 'Iselda_7': 'Room_mapper', 'Iselda_8': 'Room_mapper', 'Iselda_9': 'Room_mapper', 'Iselda_10': 'Room_mapper', 'Iselda_11': 'Room_mapper', 'Iselda_12': 'Room_mapper', 'Iselda_13': 'Room_mapper', 'Iselda_14': 'Room_mapper', 'Iselda_15': 'Room_mapper', 'Iselda_16': 'Room_mapper', 'Salubra_1': 'Room_Charm_Shop', 'Salubra_2': 'Room_Charm_Shop', 'Salubra_3': 'Room_Charm_Shop', 'Salubra_4': 'Room_Charm_Shop', 'Salubra_5': 'Room_Charm_Shop', 'Salubra_6': 'Room_Charm_Shop', 'Salubra_7': 'Room_Charm_Shop', 'Salubra_8': 'Room_Charm_Shop', 'Salubra_9': 'Room_Charm_Shop', 'Salubra_10': 'Room_Charm_Shop', 'Salubra_11': 'Room_Charm_Shop', 'Salubra_12': 'Room_Charm_Shop', 'Salubra_13': 'Room_Charm_Shop', 'Salubra_14': 'Room_Charm_Shop', 'Salubra_15': 'Room_Charm_Shop', 'Salubra_16': 'Room_Charm_Shop', 'Salubra_(Requires_Charms)_1': 'Room_Charm_Shop', 'Salubra_(Requires_Charms)_2': 'Room_Charm_Shop', 'Salubra_(Requires_Charms)_3': 'Room_Charm_Shop', 'Salubra_(Requires_Charms)_4': 'Room_Charm_Shop', 'Salubra_(Requires_Charms)_5': 'Room_Charm_Shop', 'Salubra_(Requires_Charms)_6': 'Room_Charm_Shop', 'Salubra_(Requires_Charms)_7': 'Room_Charm_Shop', 'Salubra_(Requires_Charms)_8': 'Room_Charm_Shop', 'Salubra_(Requires_Charms)_9': 'Room_Charm_Shop', 'Salubra_(Requires_Charms)_10': 'Room_Charm_Shop', 'Salubra_(Requires_Charms)_11': 'Room_Charm_Shop', 'Salubra_(Requires_Charms)_12': 'Room_Charm_Shop', 'Salubra_(Requires_Charms)_13': 'Room_Charm_Shop', 'Salubra_(Requires_Charms)_14': 'Room_Charm_Shop', 'Salubra_(Requires_Charms)_15': 'Room_Charm_Shop', 'Salubra_(Requires_Charms)_16': 'Room_Charm_Shop', 'Leg_Eater_1': 'Fungus2_26', 'Leg_Eater_2': 'Fungus2_26', 'Leg_Eater_3': 'Fungus2_26', 'Leg_Eater_4': 'Fungus2_26', 'Leg_Eater_5': 'Fungus2_26', 'Leg_Eater_6': 'Fungus2_26', 'Leg_Eater_7': 'Fungus2_26', 'Leg_Eater_8': 'Fungus2_26', 'Leg_Eater_9': 'Fungus2_26', 'Leg_Eater_10': 'Fungus2_26', 'Leg_Eater_11': 'Fungus2_26', 'Leg_Eater_12': 'Fungus2_26', 'Leg_Eater_13': 'Fungus2_26', 'Leg_Eater_14': 'Fungus2_26', 'Leg_Eater_15': 'Fungus2_26', 'Leg_Eater_16': 'Fungus2_26', 'Grubfather_1': 'Crossroads_38', 'Grubfather_2': 'Crossroads_38', 'Grubfather_3': 'Crossroads_38', 'Grubfather_4': 'Crossroads_38', 'Grubfather_5': 'Crossroads_38', 'Grubfather_6': 'Crossroads_38', 'Grubfather_7': 'Crossroads_38', 'Grubfather_8': 'Crossroads_38', 'Grubfather_9': 'Crossroads_38', 'Grubfather_10': 'Crossroads_38', 'Grubfather_11': 'Crossroads_38', 'Grubfather_12': 'Crossroads_38', 'Grubfather_13': 'Crossroads_38', 'Grubfather_14': 'Crossroads_38', 'Grubfather_15': 'Crossroads_38', 'Grubfather_16': 'Crossroads_38', 'Seer_1': 'RestingGrounds_07', 'Seer_2': 'RestingGrounds_07', 'Seer_3': 'RestingGrounds_07', 'Seer_4': 'RestingGrounds_07', 'Seer_5': 'RestingGrounds_07', 'Seer_6': 'RestingGrounds_07', 'Seer_7': 'RestingGrounds_07', 'Seer_8': 'RestingGrounds_07', 'Seer_9': 'RestingGrounds_07', 'Seer_10': 'RestingGrounds_07', 'Seer_11': 'RestingGrounds_07', 'Seer_12': 'RestingGrounds_07', 'Seer_13': 'RestingGrounds_07', 'Seer_14': 'RestingGrounds_07', 'Seer_15': 'RestingGrounds_07', 'Seer_16': 'RestingGrounds_07', 'Egg_Shop_1': 'Room_Ouiji', 'Egg_Shop_2': 'Room_Ouiji', 'Egg_Shop_3': 'Room_Ouiji', 'Egg_Shop_4': 'Room_Ouiji', 'Egg_Shop_5': 'Room_Ouiji', 'Egg_Shop_6': 'Room_Ouiji', 'Egg_Shop_7': 'Room_Ouiji', 'Egg_Shop_8': 'Room_Ouiji', 'Egg_Shop_9': 'Room_Ouiji', 'Egg_Shop_10': 'Room_Ouiji', 'Egg_Shop_11': 'Room_Ouiji', 'Egg_Shop_12': 'Room_Ouiji', 'Egg_Shop_13': 'Room_Ouiji', 'Egg_Shop_14': 'Room_Ouiji', 'Egg_Shop_15': 'Room_Ouiji', 'Egg_Shop_16': 'Room_Ouiji', 'Lurien': 'Ruins2_Watcher_Room', 'Monomon': 'Fungus3_archive_02', 'Herrah': 'Deepnest_Spider_Town', 'World_Sense': 'Room_temple', 'Mothwing_Cloak': 'Fungus1_04', 'Mantis_Claw': 'Fungus2_14', 'Crystal_Heart': 'Mines_31', 'Monarch_Wings': 'Abyss_21', 'Shade_Cloak': 'Abyss_10', "Isma's_Tear": 'Waterways_13', 'Dream_Nail': 'RestingGrounds_04', 'Vengeful_Spirit': 'Crossroads_ShamanTemple', 'Shade_Soul': 'Ruins1_31b', 'Desolate_Dive': 'Ruins1_24', 'Descending_Dark': 'Mines_35', 'Howling_Wraiths': 'Room_Fungus_Shaman', 'Abyss_Shriek': 'Abyss_12', 'Cyclone_Slash': 'Room_nailmaster', 'Dash_Slash': 'Room_nailmaster_03', 'Great_Slash': 'Room_nailmaster_02', 'Focus': 'Tutorial_01', 'Baldur_Shell': 'Fungus1_28', 'Fury_of_the_Fallen': 'Tutorial_01', 'Lifeblood_Core': 'Abyss_08', "Defender's_Crest": 'Waterways_05', 'Flukenest': 'Waterways_12', 'Thorns_of_Agony': 'Fungus1_14', 'Mark_of_Pride': 'Fungus2_31', 'Sharp_Shadow': 'Deepnest_44', 'Spore_Shroom': 'Fungus2_20', 'Soul_Catcher': 'Crossroads_ShamanTemple', 'Soul_Eater': 'RestingGrounds_10', 'Glowing_Womb': 'Crossroads_22', "Nailmaster's_Glory": 'Room_shop', "Joni's_Blessing": 'Cliffs_05', 'Shape_of_Unn': 'Fungus1_Slug', 'Hiveblood': 'Hive_05', 'Dashmaster': 'Fungus2_23', 'Quick_Slash': 'Deepnest_East_14b', 'Spell_Twister': 'Ruins1_30', 'Deep_Focus': 'Mines_36', 'Queen_Fragment': 'Room_Queen', 'King_Fragment': 'White_Palace_09', 'Void_Heart': 'Abyss_15', 'Dreamshield': 'RestingGrounds_17', 'Weaversong': 'Deepnest_45_v02', 'Grimmchild': 'Grimm_Main_Tent', 'Unbreakable_Heart': 'Grimm_Divine', 'Unbreakable_Greed': 'Grimm_Divine', 'Unbreakable_Strength': 'Grimm_Divine', 'City_Crest': 'Crossroads_10', 'Tram_Pass': 'Deepnest_26b', 'Simple_Key-Basin': 'Abyss_20', 'Simple_Key-City': 'Ruins1_17', 'Simple_Key-Lurker': 'GG_Lurker', "Shopkeeper's_Key": 'Mines_11', 'Love_Key': 'Fungus3_39', "King's_Brand": 'Room_Wyrm', 'Godtuner': 'GG_Waterways', "Collector's_Map": 'Ruins2_11', 'Mask_Shard-Brooding_Mawlek': 'Crossroads_09', 'Mask_Shard-Crossroads_Goam': 'Crossroads_13', 'Mask_Shard-Stone_Sanctuary': 'Fungus1_36', "Mask_Shard-Queen's_Station": 'Fungus2_01', 'Mask_Shard-Deepnest': 'Fungus2_25', 'Mask_Shard-Waterways': 'Waterways_04b', 'Mask_Shard-Enraged_Guardian': 'Mines_32', 'Mask_Shard-Hive': 'Hive_04', 'Mask_Shard-Grey_Mourner': 'Room_Mansion', 'Mask_Shard-Bretta': 'Room_Bretta', 'Vessel_Fragment-Greenpath': 'Fungus1_13', 'Vessel_Fragment-City': 'Ruins2_09', 'Vessel_Fragment-Crossroads': 'Crossroads_37', 'Vessel_Fragment-Basin': 'Abyss_04', 'Vessel_Fragment-Deepnest': 'Deepnest_38', 'Vessel_Fragment-Stag_Nest': 'Cliffs_03', 'Charm_Notch-Shrumal_Ogres': 'Fungus2_05', 'Charm_Notch-Fog_Canyon': 'Fungus3_28', 'Charm_Notch-Colosseum': 'Room_Colosseum_01', 'Charm_Notch-Grimm': 'Grimm_Main_Tent', 'Pale_Ore-Basin': 'Abyss_17', 'Pale_Ore-Crystal_Peak': 'Mines_34', 'Pale_Ore-Nosk': 'Deepnest_32', 'Pale_Ore-Colosseum': 'Room_Colosseum_01', 'Geo_Chest-False_Knight': 'Crossroads_10', 'Geo_Chest-Soul_Master': 'Ruins1_32', 'Geo_Chest-Watcher_Knights': 'Ruins2_03', 'Geo_Chest-Greenpath': 'Fungus1_13', 'Geo_Chest-Mantis_Lords': 'Fungus2_31', 'Geo_Chest-Resting_Grounds': 'RestingGrounds_10', 'Geo_Chest-Crystal_Peak': 'Mines_37', 'Geo_Chest-Weavers_Den': 'Deepnest_45_v02', 'Geo_Chest-Junk_Pit_1': 'GG_Waterways', 'Geo_Chest-Junk_Pit_2': 'GG_Waterways', 'Geo_Chest-Junk_Pit_3': 'GG_Waterways', 'Geo_Chest-Junk_Pit_5': 'GG_Waterways', 'Lumafly_Escape-Junk_Pit_Chest_4': 'GG_Waterways', 'Rancid_Egg-Sheo': 'Fungus1_15', 'Rancid_Egg-Fungal_Core': 'Fungus2_29', "Rancid_Egg-Queen's_Gardens": 'Fungus3_34', 'Rancid_Egg-Blue_Lake': 'Crossroads_50', 'Rancid_Egg-Crystal_Peak_Dive_Entrance': 'Mines_01', 'Rancid_Egg-Crystal_Peak_Dark_Room': 'Mines_29', 'Rancid_Egg-Crystal_Peak_Tall_Room': 'Mines_20', 'Rancid_Egg-City_of_Tears_Left': 'Ruins1_05c', 'Rancid_Egg-City_of_Tears_Pleasure_House': 'Ruins_Elevator', "Rancid_Egg-Beast's_Den": 'Deepnest_Spider_Town', 'Rancid_Egg-Dark_Deepnest': 'Deepnest_39', "Rancid_Egg-Weaver's_Den": 'Deepnest_45_v02', 'Rancid_Egg-Near_Quick_Slash': 'Deepnest_East_14', "Rancid_Egg-Upper_Kingdom's_Edge": 'Deepnest_East_07', 'Rancid_Egg-Waterways_East': 'Waterways_07', 'Rancid_Egg-Waterways_Main': 'Waterways_02', 'Rancid_Egg-Waterways_West_Bluggsac': 'Waterways_04', 'Rancid_Egg-Waterways_West_Pickup': 'Waterways_04b', "Rancid_Egg-Tuk_Defender's_Crest": 'Waterways_03', "Wanderer's_Journal-Cliffs": 'Cliffs_01', "Wanderer's_Journal-Greenpath_Stag": 'Fungus1_22', "Wanderer's_Journal-Greenpath_Lower": 'Fungus1_11', "Wanderer's_Journal-Fungal_Wastes_Thorns_Gauntlet": 'Fungus2_04', "Wanderer's_Journal-Above_Mantis_Village": 'Fungus2_17', "Wanderer's_Journal-Crystal_Peak_Crawlers": 'Mines_20', "Wanderer's_Journal-Resting_Grounds_Catacombs": 'RestingGrounds_10', "Wanderer's_Journal-King's_Station": 'Ruins2_05', "Wanderer's_Journal-Pleasure_House": 'Ruins_Elevator', "Wanderer's_Journal-City_Storerooms": 'Ruins1_28', "Wanderer's_Journal-Ancient_Basin": 'Abyss_02', "Wanderer's_Journal-Kingdom's_Edge_Entrance": 'Deepnest_East_07', "Wanderer's_Journal-Kingdom's_Edge_Camp": 'Deepnest_East_13', "Wanderer's_Journal-Kingdom's_Edge_Requires_Dive": 'Deepnest_East_18', 'Hallownest_Seal-Crossroads_Well': 'Crossroads_01', 'Hallownest_Seal-Greenpath': 'Fungus1_10', 'Hallownest_Seal-Fog_Canyon_West': 'Fungus3_30', 'Hallownest_Seal-Fog_Canyon_East': 'Fungus3_26', "Hallownest_Seal-Queen's_Station": 'Fungus2_34', 'Hallownest_Seal-Fungal_Wastes_Sporgs': 'Fungus2_03', 'Hallownest_Seal-Mantis_Lords': 'Fungus2_31', 'Hallownest_Seal-Resting_Grounds_Catacombs': 'RestingGrounds_10', "Hallownest_Seal-King's_Station": 'Ruins2_08', 'Hallownest_Seal-City_Rafters': 'Ruins1_03', 'Hallownest_Seal-Soul_Sanctum': 'Ruins1_32', 'Hallownest_Seal-Watcher_Knight': 'Ruins2_03', 'Hallownest_Seal-Deepnest_By_Mantis_Lords': 'Deepnest_16', "Hallownest_Seal-Beast's_Den": 'Deepnest_Spider_Town', "Hallownest_Seal-Queen's_Gardens": 'Fungus3_48', "King's_Idol-Cliffs": 'Cliffs_01', "King's_Idol-Crystal_Peak": 'Mines_30', "King's_Idol-Glade_of_Hope": 'RestingGrounds_08', "King's_Idol-Dung_Defender": 'Waterways_15', "King's_Idol-Great_Hopper": 'Deepnest_East_08', "King's_Idol-Pale_Lurker": 'GG_Lurker', "King's_Idol-Deepnest": 'Deepnest_33', 'Arcane_Egg-Lifeblood_Core': 'Abyss_08', 'Arcane_Egg-Shade_Cloak': 'Abyss_10', 'Arcane_Egg-Birthplace': 'Abyss_15', 'Whispering_Root-Crossroads': 'Crossroads_07', 'Whispering_Root-Greenpath': 'Fungus1_13', 'Whispering_Root-Leg_Eater': 'Fungus2_33', 'Whispering_Root-Mantis_Village': 'Fungus2_17', 'Whispering_Root-Deepnest': 'Deepnest_39', 'Whispering_Root-Queens_Gardens': 'Fungus3_11', 'Whispering_Root-Kingdoms_Edge': 'Deepnest_East_07', 'Whispering_Root-Waterways': 'Abyss_01', 'Whispering_Root-City': 'Ruins1_17', 'Whispering_Root-Resting_Grounds': 'RestingGrounds_05', 'Whispering_Root-Spirits_Glade': 'RestingGrounds_08', 'Whispering_Root-Crystal_Peak': 'Mines_23', 'Whispering_Root-Howling_Cliffs': 'Cliffs_01', 'Whispering_Root-Ancestral_Mound': 'Crossroads_ShamanTemple', 'Whispering_Root-Hive': 'Hive_02', 'Boss_Essence-Elder_Hu': 'Fungus2_32', 'Boss_Essence-Xero': 'RestingGrounds_02', 'Boss_Essence-Gorb': 'Cliffs_02', 'Boss_Essence-Marmu': 'Fungus3_40', 'Boss_Essence-No_Eyes': 'Fungus1_35', 'Boss_Essence-Galien': 'Deepnest_40', 'Boss_Essence-Markoth': 'Deepnest_East_10', 'Boss_Essence-Failed_Champion': 'Crossroads_10', 'Boss_Essence-Soul_Tyrant': 'Ruins1_24', 'Boss_Essence-Lost_Kin': 'Abyss_19', 'Boss_Essence-White_Defender': 'Waterways_15', 'Boss_Essence-Grey_Prince_Zote': 'Room_Bretta', 'Grub-Crossroads_Acid': 'Crossroads_35', 'Grub-Crossroads_Center': 'Crossroads_05', 'Grub-Crossroads_Stag': 'Crossroads_03', 'Grub-Crossroads_Spike': 'Crossroads_31', 'Grub-Crossroads_Guarded': 'Crossroads_48', 'Grub-Greenpath_Cornifer': 'Fungus1_06', 'Grub-Greenpath_Journal': 'Fungus1_07', 'Grub-Greenpath_MMC': 'Fungus1_13', 'Grub-Greenpath_Stag': 'Fungus1_21', 'Grub-Fog_Canyon': 'Fungus3_47', 'Grub-Fungal_Bouncy': 'Fungus2_18', 'Grub-Fungal_Spore_Shroom': 'Fungus2_20', 'Grub-Deepnest_Mimic': 'Deepnest_36', 'Grub-Deepnest_Nosk': 'Deepnest_31', 'Grub-Deepnest_Spike': 'Deepnest_03', 'Grub-Dark_Deepnest': 'Deepnest_39', "Grub-Beast's_Den": 'Deepnest_Spider_Town', "Grub-Kingdom's_Edge_Oro": 'Deepnest_East_14', "Grub-Kingdom's_Edge_Camp": 'Deepnest_East_11', 'Grub-Hive_External': 'Hive_03', 'Grub-Hive_Internal': 'Hive_04', 'Grub-Basin_Requires_Wings': 'Abyss_19', 'Grub-Basin_Requires_Dive': 'Abyss_17', 'Grub-Waterways_Main': 'Waterways_04', "Grub-Isma's_Grove": 'Waterways_13', 'Grub-Waterways_Requires_Tram': 'Waterways_14', 'Grub-City_of_Tears_Left': 'Ruins1_05', 'Grub-Soul_Sanctum': 'Ruins1_32', "Grub-Watcher's_Spire": 'Ruins2_03', 'Grub-City_of_Tears_Guarded': 'Ruins_House_01', "Grub-King's_Station": 'Ruins2_07', 'Grub-Resting_Grounds': 'RestingGrounds_10', 'Grub-Crystal_Peak_Below_Chest': 'Mines_04', 'Grub-Crystallized_Mound': 'Mines_35', 'Grub-Crystal_Peak_Spike': 'Mines_03', 'Grub-Crystal_Peak_Mimic': 'Mines_16', 'Grub-Crystal_Peak_Crushers': 'Mines_19', 'Grub-Crystal_Heart': 'Mines_31', 'Grub-Hallownest_Crown': 'Mines_24', 'Grub-Howling_Cliffs': 'Fungus1_28', "Grub-Queen's_Gardens_Stag": 'Fungus3_10', "Grub-Queen's_Gardens_Marmu": 'Fungus3_48', "Grub-Queen's_Gardens_Top": 'Fungus3_22', 'Grub-Collector_1': 'Ruins2_11', 'Grub-Collector_2': 'Ruins2_11', 'Grub-Collector_3': 'Ruins2_11', 'Mimic_Grub-Deepnest_1': 'Deepnest_36', 'Mimic_Grub-Deepnest_2': 'Deepnest_36', 'Mimic_Grub-Deepnest_3': 'Deepnest_36', 'Mimic_Grub-Crystal_Peak': 'Mines_16', 'Crossroads_Map': 'Crossroads_33', 'Greenpath_Map': 'Fungus1_06', 'Fog_Canyon_Map': 'Fungus3_25', 'Fungal_Wastes_Map': 'Fungus2_18', 'Deepnest_Map-Upper': 'Deepnest_01b', 'Deepnest_Map-Right': 'Fungus2_25', 'Ancient_Basin_Map': 'Abyss_04', "Kingdom's_Edge_Map": 'Deepnest_East_03', 'City_of_Tears_Map': 'Ruins1_31', 'Royal_Waterways_Map': 'Waterways_09', 'Howling_Cliffs_Map': 'Cliffs_01', 'Crystal_Peak_Map': 'Mines_30', "Queen's_Gardens_Map": 'Fungus1_24', 'Resting_Grounds_Map': 'RestingGrounds_09', 'Dirtmouth_Stag': 'Room_Town_Stag_Station', 'Crossroads_Stag': 'Crossroads_47', 'Greenpath_Stag': 'Fungus1_16_alt', "Queen's_Station_Stag": 'Fungus2_02', "Queen's_Gardens_Stag": 'Fungus3_40', 'City_Storerooms_Stag': 'Ruins1_29', "King's_Station_Stag": 'Ruins2_08', 'Resting_Grounds_Stag': 'RestingGrounds_09', 'Distant_Village_Stag': 'Deepnest_09', 'Hidden_Station_Stag': 'Abyss_22', 'Stag_Nest_Stag': 'Cliffs_03', "Lifeblood_Cocoon-King's_Pass": 'Tutorial_01', 'Lifeblood_Cocoon-Ancestral_Mound': 'Crossroads_ShamanTemple', 'Lifeblood_Cocoon-Greenpath': 'Fungus1_32', 'Lifeblood_Cocoon-Fog_Canyon_West': 'Fungus3_30', 'Lifeblood_Cocoon-Mantis_Village': 'Fungus2_15', 'Lifeblood_Cocoon-Failed_Tramway': 'Deepnest_26', 'Lifeblood_Cocoon-Galien': 'Deepnest_40', "Lifeblood_Cocoon-Kingdom's_Edge": 'Deepnest_East_15', 'Grimmkin_Flame-City_Storerooms': 'Ruins1_28', 'Grimmkin_Flame-Greenpath': 'Fungus1_10', 'Grimmkin_Flame-Crystal_Peak': 'Mines_10', "Grimmkin_Flame-King's_Pass": 'Tutorial_01', 'Grimmkin_Flame-Resting_Grounds': 'RestingGrounds_06', "Grimmkin_Flame-Kingdom's_Edge": 'Deepnest_East_03', 'Grimmkin_Flame-Fungal_Core': 'Fungus2_30', 'Grimmkin_Flame-Ancient_Basin': 'Abyss_02', 'Grimmkin_Flame-Hive': 'Hive_03', 'Grimmkin_Flame-Brumm': 'Room_spider_small', "Hunter's_Journal": 'Fungus1_08', 'Journal_Entry-Void_Tendrils': 'Abyss_09', 'Journal_Entry-Charged_Lumafly': 'Fungus3_archive_02', 'Journal_Entry-Goam': 'Crossroads_52', 'Journal_Entry-Garpede': 'Deepnest_44', 'Journal_Entry-Seal_of_Binding': 'White_Palace_20', 'Elevator_Pass': 'Crossroads_49b', 'Split_Mothwing_Cloak': 'Fungus1_04', 'Left_Mantis_Claw': 'Fungus2_14', 'Right_Mantis_Claw': 'Fungus2_14', 'Leftslash': 'Tutorial_01', 'Rightslash': 'Tutorial_01', 'Upslash': 'Tutorial_01', 'Split_Crystal_Heart': 'Mines_31', 'Geo_Rock-Broken_Elevator_1': 'Abyss_01', 'Geo_Rock-Broken_Elevator_2': 'Abyss_01', 'Geo_Rock-Broken_Elevator_3': 'Abyss_01', 'Geo_Rock-Broken_Bridge_Upper': 'Abyss_02', 'Geo_Rock-Broken_Bridge_Lower': 'Abyss_02', 'Geo_Rock-Broken_Bridge_Lower_Dupe': 'Abyss_02', 'Geo_Rock-Abyss_1': 'Abyss_06_Core', 'Geo_Rock-Abyss_2': 'Abyss_06_Core', 'Geo_Rock-Abyss_3': 'Abyss_06_Core', 'Geo_Rock-Basin_Tunnel': 'Abyss_18', 'Geo_Rock-Basin_Grub': 'Abyss_19', 'Geo_Rock-Basin_Before_Broken_Vessel': 'Abyss_19', 'Geo_Rock-Cliffs_Main_1': 'Cliffs_01', 'Geo_Rock-Cliffs_Main_2': 'Cliffs_01', 'Geo_Rock-Cliffs_Main_3': 'Cliffs_01', 'Geo_Rock-Cliffs_Main_4': 'Cliffs_01', 'Geo_Rock-Below_Gorb_Dupe': 'Cliffs_02', 'Geo_Rock-Below_Gorb': 'Cliffs_02', 'Geo_Rock-Crossroads_Well': 'Crossroads_01', 'Geo_Rock-Crossroads_Center_Grub': 'Crossroads_05', 'Geo_Rock-Crossroads_Root': 'Crossroads_07', 'Geo_Rock-Crossroads_Root_Dupe_1': 'Crossroads_07', 'Geo_Rock-Crossroads_Root_Dupe_2': 'Crossroads_07', 'Geo_Rock-Crossroads_Aspid_Arena': 'Crossroads_08', 'Geo_Rock-Crossroads_Aspid_Arena_Dupe_1': 'Crossroads_08', 'Geo_Rock-Crossroads_Aspid_Arena_Dupe_2': 'Crossroads_08', 'Geo_Rock-Crossroads_Aspid_Arena_Hidden': 'Crossroads_08', 'Geo_Rock-Crossroads_Above_False_Knight': 'Crossroads_10', 'Geo_Rock-Crossroads_Before_Acid_Grub': 'Crossroads_12', 'Geo_Rock-Crossroads_Below_Goam_Mask_Shard': 'Crossroads_13', 'Geo_Rock-Crossroads_After_Goam_Mask_Shard': 'Crossroads_13', 'Geo_Rock-Crossroads_Above_Lever': 'Crossroads_16', 'Geo_Rock-Crossroads_Before_Fungal': 'Crossroads_18', 'Geo_Rock-Crossroads_Before_Fungal_Dupe_1': 'Crossroads_18', 'Geo_Rock-Crossroads_Before_Fungal_Dupe_2': 'Crossroads_18', 'Geo_Rock-Crossroads_Before_Shops': 'Crossroads_19', 'Geo_Rock-Crossroads_Before_Glowing_Womb': 'Crossroads_21', 'Geo_Rock-Crossroads_Above_Tram': 'Crossroads_27', 'Geo_Rock-Crossroads_Above_Mawlek': 'Crossroads_36', 'Geo_Rock-Crossroads_Vessel_Fragment': 'Crossroads_37', 'Geo_Rock-Crossroads_Goam_Alcove': 'Crossroads_42', 'Geo_Rock-Crossroads_Goam_Damage_Boost': 'Crossroads_42', 'Geo_Rock-Crossroads_Tram': 'Crossroads_46', 'Geo_Rock-Crossroads_Goam_Journal': 'Crossroads_52', 'Geo_Rock-Crossroads_Goam_Journal_Dupe': 'Crossroads_52', 'Geo_Rock-Ancestral_Mound': 'Crossroads_ShamanTemple', 'Geo_Rock-Ancestral_Mound_Dupe': 'Crossroads_ShamanTemple', 'Geo_Rock-Ancestral_Mound_Tree': 'Crossroads_ShamanTemple', 'Geo_Rock-Ancestral_Mound_Tree_Dupe': 'Crossroads_ShamanTemple', 'Geo_Rock-Moss_Prophet': 'Deepnest_01', 'Geo_Rock-Moss_Prophet_Dupe': 'Deepnest_01', 'Geo_Rock-Deepnest_Below_Mimics': 'Deepnest_02', 'Geo_Rock-Deepnest_Below_Mimics_Dupe': 'Deepnest_02', 'Geo_Rock-Deepnest_Below_Spike_Grub': 'Deepnest_03', 'Geo_Rock-Deepnest_Below_Spike_Grub_Dupe': 'Deepnest_03', 'Geo_Rock-Deepnest_Spike_Grub_Right': 'Deepnest_03', 'Geo_Rock-Deepnest_By_Mantis_Lords_Garpede_Pogo': 'Deepnest_16', 'Geo_Rock-Deepnest_By_Mantis_Lords_Garpede_Pogo_Dupe': 'Deepnest_16', 'Geo_Rock-Deepnest_By_Mantis_Lords_Requires_Claw_1': 'Deepnest_16', 'Geo_Rock-Deepnest_By_Mantis_Lords_Requires_Claw_2': 'Deepnest_16', 'Geo_Rock-Deepnest_By_Mantis_Lords_Requires_Claw_3': 'Deepnest_16', 'Geo_Rock-Deepnest_Nosk_1': 'Deepnest_31', 'Geo_Rock-Deepnest_Nosk_2': 'Deepnest_31', 'Geo_Rock-Deepnest_Nosk_3': 'Deepnest_31', 'Geo_Rock-Deepnest_Above_Galien': 'Deepnest_35', 'Geo_Rock-Deepnest_Galien_Spike': 'Deepnest_35', 'Geo_Rock-Deepnest_Garpede_1': 'Deepnest_37', 'Geo_Rock-Deepnest_Garpede_2': 'Deepnest_37', 'Geo_Rock-Dark_Deepnest_Above_Grub_1': 'Deepnest_39', 'Geo_Rock-Dark_Deepnest_Above_Grub_2': 'Deepnest_39', 'Geo_Rock-Dark_Deepnest_Bottom_Left': 'Deepnest_39', 'Geo_Rock-Above_Mask_Maker_1': 'Deepnest_43', 'Geo_Rock-Above_Mask_Maker_2': 'Deepnest_43', "Geo_Rock-Lower_Kingdom's_Edge_1": 'Deepnest_East_01', "Geo_Rock-Lower_Kingdom's_Edge_2": 'Deepnest_East_01', "Geo_Rock-Lower_Kingdom's_Edge_3": 'Deepnest_East_02', "Geo_Rock-Lower_Kingdom's_Edge_Dive": 'Deepnest_East_02', "Geo_Rock-Kingdom's_Edge_Below_Bardoon": 'Deepnest_East_04', "Geo_Rock-Kingdom's_Edge_Oro_Far_Left": 'Deepnest_East_06', "Geo_Rock-Kingdom's_Edge_Oro_Middle_Left": 'Deepnest_East_06', "Geo_Rock-Kingdom's_Edge_Above_Root": 'Deepnest_East_07', "Geo_Rock-Kingdom's_Edge_Above_Tower": 'Deepnest_East_07', "Geo_Rock-Kingdom's_Edge_Below_Colosseum": 'Deepnest_East_08', "Geo_Rock-Kingdom's_Edge_Above_420_Geo_Rock": 'Deepnest_East_17', "Geo_Rock-Kingdom's_Edge_420_Geo_Rock": 'Deepnest_East_17', "Geo_Rock-Beast's_Den_Above_Trilobite": 'Deepnest_Spider_Town', "Geo_Rock-Beast's_Den_Above_Trilobite_Dupe": 'Deepnest_Spider_Town', "Geo_Rock-Beast's_Den_Below_Herrah": 'Deepnest_Spider_Town', "Geo_Rock-Beast's_Den_Below_Egg": 'Deepnest_Spider_Town', "Geo_Rock-Beast's_Den_Below_Egg_Dupe": 'Deepnest_Spider_Town', "Geo_Rock-Beast's_Den_Bottom": 'Deepnest_Spider_Town', "Geo_Rock-Beast's_Den_Bottom_Dupe": 'Deepnest_Spider_Town', "Geo_Rock-Beast's_Den_After_Herrah": 'Deepnest_Spider_Town', 'Geo_Rock-Greenpath_Entrance': 'Fungus1_01', 'Geo_Rock-Greenpath_Waterfall': 'Fungus1_01b', 'Geo_Rock-Greenpath_Below_Skip_Squit': 'Fungus1_02', 'Geo_Rock-Greenpath_Skip_Squit': 'Fungus1_02', 'Geo_Rock-Greenpath_Second_Skip_Fool_Eater': 'Fungus1_03', 'Geo_Rock-Greenpath_Second_Skip_Fool_Eater_Dupe': 'Fungus1_03', 'Geo_Rock-Greenpath_Second_Skip_Lower': 'Fungus1_03', 'Geo_Rock-Greenpath_Below_Hornet': 'Fungus1_04', 'Geo_Rock-Greenpath_Above_Thorns': 'Fungus1_05', "Geo_Rock-Greenpath_Hunter's_Journal": 'Fungus1_07', 'Geo_Rock-Greenpath_Acid_Bridge': 'Fungus1_10', 'Geo_Rock-Greenpath_After_MMC_Hidden': 'Fungus1_12', 'Geo_Rock-Greenpath_After_MMC': 'Fungus1_12', 'Geo_Rock-Greenpath_After_MMC_Dupe': 'Fungus1_12', 'Geo_Rock-Greenpath_Obbles_Fool_Eater': 'Fungus1_19', 'Geo_Rock-Greenpath_Moss_Knights': 'Fungus1_21', 'Geo_Rock-Greenpath_Moss_Knights_Dupe_1': 'Fungus1_21', 'Geo_Rock-Greenpath_Moss_Knights_Dupe_2': 'Fungus1_21', 'Geo_Rock-Greenpath_Below_Stag': 'Fungus1_22', 'Geo_Rock-Greenpath_Below_Stag_Fool_Eater': 'Fungus1_22', 'Geo_Rock-Baldur_Shell_Top_Left': 'Fungus1_28', 'Geo_Rock-Baldur_Shell_Alcove': 'Fungus1_28', 'Geo_Rock-Greenpath_MMC': 'Fungus1_29', 'Geo_Rock-Greenpath_Below_Toll': 'Fungus1_31', 'Geo_Rock-Greenpath_Toll_Hidden': 'Fungus1_31', 'Geo_Rock-Greenpath_Toll_Hidden_Dupe': 'Fungus1_31', 'Geo_Rock-Fungal_Below_Shrumal_Ogres': 'Fungus2_04', 'Geo_Rock-Fungal_Above_Cloth': 'Fungus2_08', 'Geo_Rock-Fungal_After_Cloth': 'Fungus2_10', "Geo_Rock-Fungal_Below_Pilgrim's_Way": 'Fungus2_11', "Geo_Rock-Fungal_Below_Pilgrim's_Way_Dupe": 'Fungus2_11', 'Geo_Rock-Mantis_Outskirts_Guarded': 'Fungus2_13', 'Geo_Rock-Mantis_Outskirts_Guarded_Dupe': 'Fungus2_13', 'Geo_Rock-Mantis_Outskirts_Alcove': 'Fungus2_13', 'Geo_Rock-Mantis_Village_After_Lever': 'Fungus2_14', 'Geo_Rock-Mantis_Village_Above_Claw': 'Fungus2_14', 'Geo_Rock-Mantis_Village_Above_Claw_Dupe': 'Fungus2_14', 'Geo_Rock-Mantis_Village_Below_Lore': 'Fungus2_14', 'Geo_Rock-Mantis_Village_Above_Lever': 'Fungus2_14', 'Geo_Rock-Above_Mantis_Lords_1': 'Fungus2_15', 'Geo_Rock-Above_Mantis_Lords_2': 'Fungus2_15', 'Geo_Rock-Fungal_After_Bouncy_Grub': 'Fungus2_18', 'Geo_Rock-Fungal_After_Bouncy_Grub_Dupe': 'Fungus2_18', 'Geo_Rock-Fungal_Bouncy_Grub_Lever': 'Fungus2_18', 'Geo_Rock-Fungal_After_Cornifer': 'Fungus2_18', 'Geo_Rock-Fungal_Above_City_Entrance': 'Fungus2_21', 'Geo_Rock-Deepnest_By_Mantis_Lords_1': 'Fungus2_25', 'Geo_Rock-Deepnest_By_Mantis_Lords_2': 'Fungus2_25', 'Geo_Rock-Deepnest_Lower_Cornifer': 'Fungus2_25', 'Geo_Rock-Fungal_Core_Entrance': 'Fungus2_29', 'Geo_Rock-Fungal_Core_Hidden': 'Fungus2_30', 'Geo_Rock-Fungal_Core_Above_Elder': 'Fungus2_30', "Geo_Rock-Queen's_Gardens_Acid_Entrance": 'Fungus3_03', "Geo_Rock-Queen's_Gardens_Below_Stag": 'Fungus3_10', 'Geo_Rock-Fog_Canyon_East': 'Fungus3_26', 'Geo_Rock-Love_Key': 'Fungus3_39', 'Geo_Rock-Love_Key_Dupe': 'Fungus3_39', "Geo_Rock-Queen's_Gardens_Above_Marmu": 'Fungus3_48', 'Geo_Rock-Pale_Lurker': 'GG_Lurker', 'Geo_Rock-Godhome_Pipeway': 'GG_Pipeway', 'Geo_Rock-Hive_Entrance': 'Hive_01', 'Geo_Rock-Hive_Outside_Bench': 'Hive_02', 'Geo_Rock-Hive_Below_Root': 'Hive_02', 'Geo_Rock-Hive_After_Root': 'Hive_02', 'Geo_Rock-Hive_Below_Stash': 'Hive_03', 'Geo_Rock-Hive_Stash': 'Hive_03', 'Geo_Rock-Hive_Stash_Dupe': 'Hive_03', 'Geo_Rock-Hive_Below_Grub': 'Hive_04', 'Geo_Rock-Hive_Above_Mask': 'Hive_04', 'Geo_Rock-Crystal_Peak_Lower_Middle': 'Mines_02', 'Geo_Rock-Crystal_Peak_Lower_Conveyer_1': 'Mines_02', 'Geo_Rock-Crystal_Peak_Lower_Conveyer_2': 'Mines_02', 'Geo_Rock-Crystal_Peak_Before_Dark_Room': 'Mines_04', 'Geo_Rock-Crystal_Peak_Before_Dark_Room_Dupe': 'Mines_04', 'Geo_Rock-Crystal_Peak_Above_Spike_Grub': 'Mines_05', 'Geo_Rock-Crystal_Peak_Mimic_Grub': 'Mines_16', 'Geo_Rock-Crystal_Peak_Dive_Egg': 'Mines_20', 'Geo_Rock-Crystal_Peak_Dive_Egg_Dupe': 'Mines_20', 'Geo_Rock-Crystal_Peak_Conga_Line': 'Mines_20', 'Geo_Rock-Hallownest_Crown_Dive': 'Mines_25', 'Geo_Rock-Hallownest_Crown_Dive_Dupe': 'Mines_25', 'Geo_Rock-Hallownest_Crown_Hidden': 'Mines_25', 'Geo_Rock-Hallownest_Crown_Hidden_Dupe_1': 'Mines_25', 'Geo_Rock-Hallownest_Crown_Hidden_Dupe_2': 'Mines_25', 'Geo_Rock-Crystal_Peak_Before_Crystal_Heart': 'Mines_31', 'Geo_Rock-Crystal_Peak_Entrance': 'Mines_33', 'Geo_Rock-Crystal_Peak_Entrance_Dupe_1': 'Mines_33', 'Geo_Rock-Crystal_Peak_Entrance_Dupe_2': 'Mines_33', 'Geo_Rock-Crystal_Peak_Above_Crushers_Lower': 'Mines_37', 'Geo_Rock-Crystal_Peak_Above_Crushers_Higher': 'Mines_37', 'Geo_Rock-Resting_Grounds_Catacombs_Grub': 'RestingGrounds_10', 'Geo_Rock-Resting_Grounds_Catacombs_Left_Dupe': 'RestingGrounds_10', 'Geo_Rock-Resting_Grounds_Catacombs_Left': 'RestingGrounds_10', 'Geo_Rock-Overgrown_Mound': 'Room_Fungus_Shaman', 'Geo_Rock-Fluke_Hermit_Dupe': 'Room_GG_Shortcut', 'Geo_Rock-Fluke_Hermit': 'Room_GG_Shortcut', 'Geo_Rock-Pleasure_House': 'Ruins_Elevator', 'Geo_Rock-City_of_Tears_Quirrel': 'Ruins1_03', 'Geo_Rock-City_of_Tears_Lemm': 'Ruins1_05b', 'Geo_Rock-City_of_Tears_Above_Lemm': 'Ruins1_05c', 'Geo_Rock-Soul_Sanctum': 'Ruins1_32', "Geo_Rock-Watcher's_Spire": 'Ruins2_01', "Geo_Rock-Above_King's_Station": 'Ruins2_05', "Geo_Rock-King's_Station": 'Ruins2_06', "Geo_Rock-King's_Pass_Left": 'Tutorial_01', "Geo_Rock-King's_Pass_Below_Fury": 'Tutorial_01', "Geo_Rock-King's_Pass_Hidden": 'Tutorial_01', "Geo_Rock-King's_Pass_Collapse": 'Tutorial_01', "Geo_Rock-King's_Pass_Above_Fury": 'Tutorial_01', 'Geo_Rock-Waterways_Tuk': 'Waterways_01', 'Geo_Rock-Waterways_Tuk_Alcove': 'Waterways_01', 'Geo_Rock-Waterways_Left': 'Waterways_04b', 'Geo_Rock-Waterways_East': 'Waterways_07', 'Geo_Rock-Waterways_Flukemarm': 'Waterways_08', 'Boss_Geo-Massive_Moss_Charger': 'Fungus1_29', 'Boss_Geo-Gorgeous_Husk': 'Ruins_House_02', 'Boss_Geo-Sanctum_Soul_Warrior': 'Ruins1_23', 'Boss_Geo-Elegant_Soul_Warrior': 'Ruins1_31b', 'Boss_Geo-Crystal_Guardian': 'Mines_18', 'Boss_Geo-Enraged_Guardian': 'Mines_32', 'Boss_Geo-Gruz_Mother': 'Crossroads_04', 'Boss_Geo-Vengefly_King': 'Fungus1_20_v02', 'Soul_Totem-Basin': 'Abyss_04', 'Soul_Totem-Cliffs_Main': 'Cliffs_01', 'Soul_Totem-Cliffs_Gorb': 'Cliffs_02', "Soul_Totem-Cliffs_Joni's": 'Cliffs_04', 'Soul_Totem-Crossroads_Goam_Journal': 'Crossroads_18', 'Soul_Totem-Crossroads_Shops': 'Crossroads_19', 'Soul_Totem-Crossroads_Mawlek_Upper': 'Crossroads_25', 'Soul_Totem-Crossroads_Acid': 'Crossroads_35', 'Soul_Totem-Crossroads_Mawlek_Lower': 'Crossroads_36', 'Soul_Totem-Crossroads_Myla': 'Crossroads_45', 'Soul_Totem-Ancestral_Mound': 'Crossroads_ShamanTemple', 'Soul_Totem-Distant_Village': 'Deepnest_10', 'Soul_Totem-Deepnest_Vessel': 'Deepnest_38', 'Soul_Totem-Mask_Maker': 'Deepnest_42', "Soul_Totem-Lower_Kingdom's_Edge_1": 'Deepnest_East_01', "Soul_Totem-Lower_Kingdom's_Edge_2": 'Deepnest_East_02', "Soul_Totem-Upper_Kingdom's_Edge": 'Deepnest_East_07', "Soul_Totem-Kingdom's_Edge_Camp": 'Deepnest_East_11', 'Soul_Totem-Oro_Dive_2': 'Deepnest_East_14', 'Soul_Totem-Oro_Dive_1': 'Deepnest_East_14', 'Soul_Totem-Oro': 'Deepnest_East_16', 'Soul_Totem-420_Geo_Rock': 'Deepnest_East_17', "Soul_Totem-Beast's_Den": 'Deepnest_Spider_Town', "Soul_Totem-Greenpath_Hunter's_Journal": 'Fungus1_07', 'Soul_Totem-Greenpath_MMC': 'Fungus1_29', 'Soul_Totem-Greenpath_Below_Toll': 'Fungus1_30', "Soul_Totem-Before_Pilgrim's_Way": 'Fungus2_10', "Soul_Totem-Pilgrim's_Way": 'Fungus2_21', 'Soul_Totem-Fungal_Core': 'Fungus2_29', "Soul_Totem-Top_Left_Queen's_Gardens": 'Fungus3_21', 'Soul_Totem-Below_Marmu': 'Fungus3_40', 'Soul_Totem-Upper_Crystal_Peak': 'Mines_20', 'Soul_Totem-Hallownest_Crown': 'Mines_25', 'Soul_Totem-Outside_Crystallized_Mound': 'Mines_28', 'Soul_Totem-Crystal_Heart_1': 'Mines_31', 'Soul_Totem-Crystal_Heart_2': 'Mines_31', 'Soul_Totem-Crystallized_Mound': 'Mines_35', 'Soul_Totem-Resting_Grounds': 'RestingGrounds_05', 'Soul_Totem-Below_Xero': 'RestingGrounds_06', 'Soul_Totem-Sanctum_Below_Soul_Master': 'Ruins1_24', 'Soul_Totem-Sanctum_Below_Chest': 'Ruins1_32', 'Soul_Totem-Sanctum_Above_Grub': 'Ruins1_32', 'Soul_Totem-Waterways_Entrance': 'Waterways_01', 'Soul_Totem-Top_Left_Waterways': 'Waterways_04b', 'Soul_Totem-Waterways_East': 'Waterways_07', 'Soul_Totem-Waterways_Flukemarm': 'Waterways_08', 'Soul_Totem-White_Palace_Entrance': 'White_Palace_02', 'Soul_Totem-White_Palace_Hub': 'White_Palace_03_hub', 'Soul_Totem-White_Palace_Left': 'White_Palace_04', 'Soul_Totem-White_Palace_Final': 'White_Palace_09', 'Soul_Totem-White_Palace_Right': 'White_Palace_15', 'Soul_Totem-Path_of_Pain_Below_Lever': 'White_Palace_17', 'Soul_Totem-Path_of_Pain_Left_of_Lever': 'White_Palace_17', 'Soul_Totem-Path_of_Pain_Entrance': 'White_Palace_18', 'Soul_Totem-Path_of_Pain_Second': 'White_Palace_18', 'Soul_Totem-Path_of_Pain_Hidden': 'White_Palace_19', 'Soul_Totem-Path_of_Pain_Below_Thornskip': 'White_Palace_19', 'Soul_Totem-Path_of_Pain_Final': 'White_Palace_20', 'Soul_Totem-Pale_Lurker': 'GG_Lurker', 'Lore_Tablet-City_Entrance': 'Ruins1_02', 'Lore_Tablet-Pleasure_House': 'Ruins_Elevator', 'Lore_Tablet-Sanctum_Entrance': 'Ruins1_23', 'Lore_Tablet-Sanctum_Past_Soul_Master': 'Ruins1_32', "Lore_Tablet-Watcher's_Spire": 'Ruins2_Watcher_Room', 'Lore_Tablet-Archives_Upper': 'Fungus3_archive_02', 'Lore_Tablet-Archives_Left': 'Fungus3_archive_02', 'Lore_Tablet-Archives_Right': 'Fungus3_archive_02', "Lore_Tablet-Pilgrim's_Way_1": 'Crossroads_11_alt', "Lore_Tablet-Pilgrim's_Way_2": 'Fungus2_21', 'Lore_Tablet-Mantis_Outskirts': 'Fungus2_12', 'Lore_Tablet-Mantis_Village': 'Fungus2_14', 'Lore_Tablet-Greenpath_Upper_Hidden': 'Fungus1_17', 'Lore_Tablet-Greenpath_Below_Toll': 'Fungus1_30', 'Lore_Tablet-Greenpath_Lifeblood': 'Fungus1_32', 'Lore_Tablet-Greenpath_Stag': 'Fungus1_21', 'Lore_Tablet-Greenpath_QG': 'Fungus1_13', 'Lore_Tablet-Greenpath_Lower_Hidden': 'Fungus1_19', 'Lore_Tablet-Dung_Defender': 'Waterways_07', 'Lore_Tablet-Spore_Shroom': 'Fungus2_20', 'Lore_Tablet-Fungal_Wastes_Hidden': 'Fungus2_07', 'Lore_Tablet-Fungal_Wastes_Below_Shrumal_Ogres': 'Fungus2_04', 'Lore_Tablet-Fungal_Core': 'Fungus2_30', 'Lore_Tablet-Ancient_Basin': 'Abyss_06_Core', "Lore_Tablet-King's_Pass_Focus": 'Tutorial_01', "Lore_Tablet-King's_Pass_Fury": 'Tutorial_01', "Lore_Tablet-King's_Pass_Exit": 'Tutorial_01', 'Lore_Tablet-World_Sense': 'Room_temple', 'Lore_Tablet-Howling_Cliffs': 'Cliffs_01', "Lore_Tablet-Kingdom's_Edge": 'Deepnest_East_17', 'Lore_Tablet-Palace_Workshop': 'White_Palace_08', 'Lore_Tablet-Palace_Throne': 'White_Palace_09', 'Lore_Tablet-Path_of_Pain_Entrance': 'White_Palace_18'} locations = ['Sly_1', 'Sly_2', 'Sly_3', 'Sly_4', 'Sly_5', 'Sly_6', 'Sly_7', 'Sly_8', 'Sly_9', 'Sly_10', 'Sly_11', 'Sly_12', 'Sly_13', 'Sly_14', 'Sly_15', 'Sly_16', 'Sly_(Key)_1', 'Sly_(Key)_2', 'Sly_(Key)_3', 'Sly_(Key)_4', 'Sly_(Key)_5', 'Sly_(Key)_6', 'Sly_(Key)_7', 'Sly_(Key)_8', 'Sly_(Key)_9', 'Sly_(Key)_10', 'Sly_(Key)_11', 'Sly_(Key)_12', 'Sly_(Key)_13', 'Sly_(Key)_14', 'Sly_(Key)_15', 'Sly_(Key)_16', 'Iselda_1', 'Iselda_2', 'Iselda_3', 'Iselda_4', 'Iselda_5', 'Iselda_6', 'Iselda_7', 'Iselda_8', 'Iselda_9', 'Iselda_10', 'Iselda_11', 'Iselda_12', 'Iselda_13', 'Iselda_14', 'Iselda_15', 'Iselda_16', 'Salubra_1', 'Salubra_2', 'Salubra_3', 'Salubra_4', 'Salubra_5', 'Salubra_6', 'Salubra_7', 'Salubra_8', 'Salubra_9', 'Salubra_10', 'Salubra_11', 'Salubra_12', 'Salubra_13', 'Salubra_14', 'Salubra_15', 'Salubra_16', 'Salubra_(Requires_Charms)_1', 'Salubra_(Requires_Charms)_2', 'Salubra_(Requires_Charms)_3', 'Salubra_(Requires_Charms)_4', 'Salubra_(Requires_Charms)_5', 'Salubra_(Requires_Charms)_6', 'Salubra_(Requires_Charms)_7', 'Salubra_(Requires_Charms)_8', 'Salubra_(Requires_Charms)_9', 'Salubra_(Requires_Charms)_10', 'Salubra_(Requires_Charms)_11', 'Salubra_(Requires_Charms)_12', 'Salubra_(Requires_Charms)_13', 'Salubra_(Requires_Charms)_14', 'Salubra_(Requires_Charms)_15', 'Salubra_(Requires_Charms)_16', 'Leg_Eater_1', 'Leg_Eater_2', 'Leg_Eater_3', 'Leg_Eater_4', 'Leg_Eater_5', 'Leg_Eater_6', 'Leg_Eater_7', 'Leg_Eater_8', 'Leg_Eater_9', 'Leg_Eater_10', 'Leg_Eater_11', 'Leg_Eater_12', 'Leg_Eater_13', 'Leg_Eater_14', 'Leg_Eater_15', 'Leg_Eater_16', 'Grubfather_1', 'Grubfather_2', 'Grubfather_3', 'Grubfather_4', 'Grubfather_5', 'Grubfather_6', 'Grubfather_7', 'Grubfather_8', 'Grubfather_9', 'Grubfather_10', 'Grubfather_11', 'Grubfather_12', 'Grubfather_13', 'Grubfather_14', 'Grubfather_15', 'Grubfather_16', 'Seer_1', 'Seer_2', 'Seer_3', 'Seer_4', 'Seer_5', 'Seer_6', 'Seer_7', 'Seer_8', 'Seer_9', 'Seer_10', 'Seer_11', 'Seer_12', 'Seer_13', 'Seer_14', 'Seer_15', 'Seer_16', 'Egg_Shop_1', 'Egg_Shop_2', 'Egg_Shop_3', 'Egg_Shop_4', 'Egg_Shop_5', 'Egg_Shop_6', 'Egg_Shop_7', 'Egg_Shop_8', 'Egg_Shop_9', 'Egg_Shop_10', 'Egg_Shop_11', 'Egg_Shop_12', 'Egg_Shop_13', 'Egg_Shop_14', 'Egg_Shop_15', 'Egg_Shop_16', 'Lurien', 'Monomon', 'Herrah', 'World_Sense', 'Mothwing_Cloak', 'Mantis_Claw', 'Crystal_Heart', 'Monarch_Wings', 'Shade_Cloak', "Isma's_Tear", 'Dream_Nail', 'Vengeful_Spirit', 'Shade_Soul', 'Desolate_Dive', 'Descending_Dark', 'Howling_Wraiths', 'Abyss_Shriek', 'Cyclone_Slash', 'Dash_Slash', 'Great_Slash', 'Focus', 'Baldur_Shell', 'Fury_of_the_Fallen', 'Lifeblood_Core', "Defender's_Crest", 'Flukenest', 'Thorns_of_Agony', 'Mark_of_Pride', 'Sharp_Shadow', 'Spore_Shroom', 'Soul_Catcher', 'Soul_Eater', 'Glowing_Womb', "Nailmaster's_Glory", "Joni's_Blessing", 'Shape_of_Unn', 'Hiveblood', 'Dashmaster', 'Quick_Slash', 'Spell_Twister', 'Deep_Focus', 'Queen_Fragment', 'King_Fragment', 'Void_Heart', 'Dreamshield', 'Weaversong', 'Grimmchild', 'Unbreakable_Heart', 'Unbreakable_Greed', 'Unbreakable_Strength', 'City_Crest', 'Tram_Pass', 'Simple_Key-Basin', 'Simple_Key-City', 'Simple_Key-Lurker', "Shopkeeper's_Key", 'Love_Key', "King's_Brand", 'Godtuner', "Collector's_Map", 'Mask_Shard-Brooding_Mawlek', 'Mask_Shard-Crossroads_Goam', 'Mask_Shard-Stone_Sanctuary', "Mask_Shard-Queen's_Station", 'Mask_Shard-Deepnest', 'Mask_Shard-Waterways', 'Mask_Shard-Enraged_Guardian', 'Mask_Shard-Hive', 'Mask_Shard-Grey_Mourner', 'Mask_Shard-Bretta', 'Vessel_Fragment-Greenpath', 'Vessel_Fragment-City', 'Vessel_Fragment-Crossroads', 'Vessel_Fragment-Basin', 'Vessel_Fragment-Deepnest', 'Vessel_Fragment-Stag_Nest', 'Charm_Notch-Shrumal_Ogres', 'Charm_Notch-Fog_Canyon', 'Charm_Notch-Colosseum', 'Charm_Notch-Grimm', 'Pale_Ore-Basin', 'Pale_Ore-Crystal_Peak', 'Pale_Ore-Nosk', 'Pale_Ore-Colosseum', 'Geo_Chest-False_Knight', 'Geo_Chest-Soul_Master', 'Geo_Chest-Watcher_Knights', 'Geo_Chest-Greenpath', 'Geo_Chest-Mantis_Lords', 'Geo_Chest-Resting_Grounds', 'Geo_Chest-Crystal_Peak', 'Geo_Chest-Weavers_Den', 'Geo_Chest-Junk_Pit_1', 'Geo_Chest-Junk_Pit_2', 'Geo_Chest-Junk_Pit_3', 'Geo_Chest-Junk_Pit_5', 'Lumafly_Escape-Junk_Pit_Chest_4', 'Rancid_Egg-Sheo', 'Rancid_Egg-Fungal_Core', "Rancid_Egg-Queen's_Gardens", 'Rancid_Egg-Blue_Lake', 'Rancid_Egg-Crystal_Peak_Dive_Entrance', 'Rancid_Egg-Crystal_Peak_Dark_Room', 'Rancid_Egg-Crystal_Peak_Tall_Room', 'Rancid_Egg-City_of_Tears_Left', 'Rancid_Egg-City_of_Tears_Pleasure_House', "Rancid_Egg-Beast's_Den", 'Rancid_Egg-Dark_Deepnest', "Rancid_Egg-Weaver's_Den", 'Rancid_Egg-Near_Quick_Slash', "Rancid_Egg-Upper_Kingdom's_Edge", 'Rancid_Egg-Waterways_East', 'Rancid_Egg-Waterways_Main', 'Rancid_Egg-Waterways_West_Bluggsac', 'Rancid_Egg-Waterways_West_Pickup', "Rancid_Egg-Tuk_Defender's_Crest", "Wanderer's_Journal-Cliffs", "Wanderer's_Journal-Greenpath_Stag", "Wanderer's_Journal-Greenpath_Lower", "Wanderer's_Journal-Fungal_Wastes_Thorns_Gauntlet", "Wanderer's_Journal-Above_Mantis_Village", "Wanderer's_Journal-Crystal_Peak_Crawlers", "Wanderer's_Journal-Resting_Grounds_Catacombs", "Wanderer's_Journal-King's_Station", "Wanderer's_Journal-Pleasure_House", "Wanderer's_Journal-City_Storerooms", "Wanderer's_Journal-Ancient_Basin", "Wanderer's_Journal-Kingdom's_Edge_Entrance", "Wanderer's_Journal-Kingdom's_Edge_Camp", "Wanderer's_Journal-Kingdom's_Edge_Requires_Dive", 'Hallownest_Seal-Crossroads_Well', 'Hallownest_Seal-Greenpath', 'Hallownest_Seal-Fog_Canyon_West', 'Hallownest_Seal-Fog_Canyon_East', "Hallownest_Seal-Queen's_Station", 'Hallownest_Seal-Fungal_Wastes_Sporgs', 'Hallownest_Seal-Mantis_Lords', 'Hallownest_Seal-Resting_Grounds_Catacombs', "Hallownest_Seal-King's_Station", 'Hallownest_Seal-City_Rafters', 'Hallownest_Seal-Soul_Sanctum', 'Hallownest_Seal-Watcher_Knight', 'Hallownest_Seal-Deepnest_By_Mantis_Lords', "Hallownest_Seal-Beast's_Den", "Hallownest_Seal-Queen's_Gardens", "King's_Idol-Cliffs", "King's_Idol-Crystal_Peak", "King's_Idol-Glade_of_Hope", "King's_Idol-Dung_Defender", "King's_Idol-Great_Hopper", "King's_Idol-Pale_Lurker", "King's_Idol-Deepnest", 'Arcane_Egg-Lifeblood_Core', 'Arcane_Egg-Shade_Cloak', 'Arcane_Egg-Birthplace', 'Whispering_Root-Crossroads', 'Whispering_Root-Greenpath', 'Whispering_Root-Leg_Eater', 'Whispering_Root-Mantis_Village', 'Whispering_Root-Deepnest', 'Whispering_Root-Queens_Gardens', 'Whispering_Root-Kingdoms_Edge', 'Whispering_Root-Waterways', 'Whispering_Root-City', 'Whispering_Root-Resting_Grounds', 'Whispering_Root-Spirits_Glade', 'Whispering_Root-Crystal_Peak', 'Whispering_Root-Howling_Cliffs', 'Whispering_Root-Ancestral_Mound', 'Whispering_Root-Hive', 'Boss_Essence-Elder_Hu', 'Boss_Essence-Xero', 'Boss_Essence-Gorb', 'Boss_Essence-Marmu', 'Boss_Essence-No_Eyes', 'Boss_Essence-Galien', 'Boss_Essence-Markoth', 'Boss_Essence-Failed_Champion', 'Boss_Essence-Soul_Tyrant', 'Boss_Essence-Lost_Kin', 'Boss_Essence-White_Defender', 'Boss_Essence-Grey_Prince_Zote', 'Grub-Crossroads_Acid', 'Grub-Crossroads_Center', 'Grub-Crossroads_Stag', 'Grub-Crossroads_Spike', 'Grub-Crossroads_Guarded', 'Grub-Greenpath_Cornifer', 'Grub-Greenpath_Journal', 'Grub-Greenpath_MMC', 'Grub-Greenpath_Stag', 'Grub-Fog_Canyon', 'Grub-Fungal_Bouncy', 'Grub-Fungal_Spore_Shroom', 'Grub-Deepnest_Mimic', 'Grub-Deepnest_Nosk', 'Grub-Deepnest_Spike', 'Grub-Dark_Deepnest', "Grub-Beast's_Den", "Grub-Kingdom's_Edge_Oro", "Grub-Kingdom's_Edge_Camp", 'Grub-Hive_External', 'Grub-Hive_Internal', 'Grub-Basin_Requires_Wings', 'Grub-Basin_Requires_Dive', 'Grub-Waterways_Main', "Grub-Isma's_Grove", 'Grub-Waterways_Requires_Tram', 'Grub-City_of_Tears_Left', 'Grub-Soul_Sanctum', "Grub-Watcher's_Spire", 'Grub-City_of_Tears_Guarded', "Grub-King's_Station", 'Grub-Resting_Grounds', 'Grub-Crystal_Peak_Below_Chest', 'Grub-Crystallized_Mound', 'Grub-Crystal_Peak_Spike', 'Grub-Crystal_Peak_Mimic', 'Grub-Crystal_Peak_Crushers', 'Grub-Crystal_Heart', 'Grub-Hallownest_Crown', 'Grub-Howling_Cliffs', "Grub-Queen's_Gardens_Stag", "Grub-Queen's_Gardens_Marmu", "Grub-Queen's_Gardens_Top", 'Grub-Collector_1', 'Grub-Collector_2', 'Grub-Collector_3', 'Mimic_Grub-Deepnest_1', 'Mimic_Grub-Deepnest_2', 'Mimic_Grub-Deepnest_3', 'Mimic_Grub-Crystal_Peak', 'Crossroads_Map', 'Greenpath_Map', 'Fog_Canyon_Map', 'Fungal_Wastes_Map', 'Deepnest_Map-Upper', 'Deepnest_Map-Right', 'Ancient_Basin_Map', "Kingdom's_Edge_Map", 'City_of_Tears_Map', 'Royal_Waterways_Map', 'Howling_Cliffs_Map', 'Crystal_Peak_Map', "Queen's_Gardens_Map", 'Resting_Grounds_Map', 'Dirtmouth_Stag', 'Crossroads_Stag', 'Greenpath_Stag', "Queen's_Station_Stag", "Queen's_Gardens_Stag", 'City_Storerooms_Stag', "King's_Station_Stag", 'Resting_Grounds_Stag', 'Distant_Village_Stag', 'Hidden_Station_Stag', 'Stag_Nest_Stag', "Lifeblood_Cocoon-King's_Pass", 'Lifeblood_Cocoon-Ancestral_Mound', 'Lifeblood_Cocoon-Greenpath', 'Lifeblood_Cocoon-Fog_Canyon_West', 'Lifeblood_Cocoon-Mantis_Village', 'Lifeblood_Cocoon-Failed_Tramway', 'Lifeblood_Cocoon-Galien', "Lifeblood_Cocoon-Kingdom's_Edge", 'Grimmkin_Flame-City_Storerooms', 'Grimmkin_Flame-Greenpath', 'Grimmkin_Flame-Crystal_Peak', "Grimmkin_Flame-King's_Pass", 'Grimmkin_Flame-Resting_Grounds', "Grimmkin_Flame-Kingdom's_Edge", 'Grimmkin_Flame-Fungal_Core', 'Grimmkin_Flame-Ancient_Basin', 'Grimmkin_Flame-Hive', 'Grimmkin_Flame-Brumm', "Hunter's_Journal", 'Journal_Entry-Void_Tendrils', 'Journal_Entry-Charged_Lumafly', 'Journal_Entry-Goam', 'Journal_Entry-Garpede', 'Journal_Entry-Seal_of_Binding', 'Elevator_Pass', 'Split_Mothwing_Cloak', 'Left_Mantis_Claw', 'Right_Mantis_Claw', 'Leftslash', 'Rightslash', 'Upslash', 'Split_Crystal_Heart', 'Geo_Rock-Broken_Elevator_1', 'Geo_Rock-Broken_Elevator_2', 'Geo_Rock-Broken_Elevator_3', 'Geo_Rock-Broken_Bridge_Upper', 'Geo_Rock-Broken_Bridge_Lower', 'Geo_Rock-Broken_Bridge_Lower_Dupe', 'Geo_Rock-Abyss_1', 'Geo_Rock-Abyss_2', 'Geo_Rock-Abyss_3', 'Geo_Rock-Basin_Tunnel', 'Geo_Rock-Basin_Grub', 'Geo_Rock-Basin_Before_Broken_Vessel', 'Geo_Rock-Cliffs_Main_1', 'Geo_Rock-Cliffs_Main_2', 'Geo_Rock-Cliffs_Main_3', 'Geo_Rock-Cliffs_Main_4', 'Geo_Rock-Below_Gorb_Dupe', 'Geo_Rock-Below_Gorb', 'Geo_Rock-Crossroads_Well', 'Geo_Rock-Crossroads_Center_Grub', 'Geo_Rock-Crossroads_Root', 'Geo_Rock-Crossroads_Root_Dupe_1', 'Geo_Rock-Crossroads_Root_Dupe_2', 'Geo_Rock-Crossroads_Aspid_Arena', 'Geo_Rock-Crossroads_Aspid_Arena_Dupe_1', 'Geo_Rock-Crossroads_Aspid_Arena_Dupe_2', 'Geo_Rock-Crossroads_Aspid_Arena_Hidden', 'Geo_Rock-Crossroads_Above_False_Knight', 'Geo_Rock-Crossroads_Before_Acid_Grub', 'Geo_Rock-Crossroads_Below_Goam_Mask_Shard', 'Geo_Rock-Crossroads_After_Goam_Mask_Shard', 'Geo_Rock-Crossroads_Above_Lever', 'Geo_Rock-Crossroads_Before_Fungal', 'Geo_Rock-Crossroads_Before_Fungal_Dupe_1', 'Geo_Rock-Crossroads_Before_Fungal_Dupe_2', 'Geo_Rock-Crossroads_Before_Shops', 'Geo_Rock-Crossroads_Before_Glowing_Womb', 'Geo_Rock-Crossroads_Above_Tram', 'Geo_Rock-Crossroads_Above_Mawlek', 'Geo_Rock-Crossroads_Vessel_Fragment', 'Geo_Rock-Crossroads_Goam_Alcove', 'Geo_Rock-Crossroads_Goam_Damage_Boost', 'Geo_Rock-Crossroads_Tram', 'Geo_Rock-Crossroads_Goam_Journal', 'Geo_Rock-Crossroads_Goam_Journal_Dupe', 'Geo_Rock-Ancestral_Mound', 'Geo_Rock-Ancestral_Mound_Dupe', 'Geo_Rock-Ancestral_Mound_Tree', 'Geo_Rock-Ancestral_Mound_Tree_Dupe', 'Geo_Rock-Moss_Prophet', 'Geo_Rock-Moss_Prophet_Dupe', 'Geo_Rock-Deepnest_Below_Mimics', 'Geo_Rock-Deepnest_Below_Mimics_Dupe', 'Geo_Rock-Deepnest_Below_Spike_Grub', 'Geo_Rock-Deepnest_Below_Spike_Grub_Dupe', 'Geo_Rock-Deepnest_Spike_Grub_Right', 'Geo_Rock-Deepnest_By_Mantis_Lords_Garpede_Pogo', 'Geo_Rock-Deepnest_By_Mantis_Lords_Garpede_Pogo_Dupe', 'Geo_Rock-Deepnest_By_Mantis_Lords_Requires_Claw_1', 'Geo_Rock-Deepnest_By_Mantis_Lords_Requires_Claw_2', 'Geo_Rock-Deepnest_By_Mantis_Lords_Requires_Claw_3', 'Geo_Rock-Deepnest_Nosk_1', 'Geo_Rock-Deepnest_Nosk_2', 'Geo_Rock-Deepnest_Nosk_3', 'Geo_Rock-Deepnest_Above_Galien', 'Geo_Rock-Deepnest_Galien_Spike', 'Geo_Rock-Deepnest_Garpede_1', 'Geo_Rock-Deepnest_Garpede_2', 'Geo_Rock-Dark_Deepnest_Above_Grub_1', 'Geo_Rock-Dark_Deepnest_Above_Grub_2', 'Geo_Rock-Dark_Deepnest_Bottom_Left', 'Geo_Rock-Above_Mask_Maker_1', 'Geo_Rock-Above_Mask_Maker_2', "Geo_Rock-Lower_Kingdom's_Edge_1", "Geo_Rock-Lower_Kingdom's_Edge_2", "Geo_Rock-Lower_Kingdom's_Edge_3", "Geo_Rock-Lower_Kingdom's_Edge_Dive", "Geo_Rock-Kingdom's_Edge_Below_Bardoon", "Geo_Rock-Kingdom's_Edge_Oro_Far_Left", "Geo_Rock-Kingdom's_Edge_Oro_Middle_Left", "Geo_Rock-Kingdom's_Edge_Above_Root", "Geo_Rock-Kingdom's_Edge_Above_Tower", "Geo_Rock-Kingdom's_Edge_Below_Colosseum", "Geo_Rock-Kingdom's_Edge_Above_420_Geo_Rock", "Geo_Rock-Kingdom's_Edge_420_Geo_Rock", "Geo_Rock-Beast's_Den_Above_Trilobite", "Geo_Rock-Beast's_Den_Above_Trilobite_Dupe", "Geo_Rock-Beast's_Den_Below_Herrah", "Geo_Rock-Beast's_Den_Below_Egg", "Geo_Rock-Beast's_Den_Below_Egg_Dupe", "Geo_Rock-Beast's_Den_Bottom", "Geo_Rock-Beast's_Den_Bottom_Dupe", "Geo_Rock-Beast's_Den_After_Herrah", 'Geo_Rock-Greenpath_Entrance', 'Geo_Rock-Greenpath_Waterfall', 'Geo_Rock-Greenpath_Below_Skip_Squit', 'Geo_Rock-Greenpath_Skip_Squit', 'Geo_Rock-Greenpath_Second_Skip_Fool_Eater', 'Geo_Rock-Greenpath_Second_Skip_Fool_Eater_Dupe', 'Geo_Rock-Greenpath_Second_Skip_Lower', 'Geo_Rock-Greenpath_Below_Hornet', 'Geo_Rock-Greenpath_Above_Thorns', "Geo_Rock-Greenpath_Hunter's_Journal", 'Geo_Rock-Greenpath_Acid_Bridge', 'Geo_Rock-Greenpath_After_MMC_Hidden', 'Geo_Rock-Greenpath_After_MMC', 'Geo_Rock-Greenpath_After_MMC_Dupe', 'Geo_Rock-Greenpath_Obbles_Fool_Eater', 'Geo_Rock-Greenpath_Moss_Knights', 'Geo_Rock-Greenpath_Moss_Knights_Dupe_1', 'Geo_Rock-Greenpath_Moss_Knights_Dupe_2', 'Geo_Rock-Greenpath_Below_Stag', 'Geo_Rock-Greenpath_Below_Stag_Fool_Eater', 'Geo_Rock-Baldur_Shell_Top_Left', 'Geo_Rock-Baldur_Shell_Alcove', 'Geo_Rock-Greenpath_MMC', 'Geo_Rock-Greenpath_Below_Toll', 'Geo_Rock-Greenpath_Toll_Hidden', 'Geo_Rock-Greenpath_Toll_Hidden_Dupe', 'Geo_Rock-Fungal_Below_Shrumal_Ogres', 'Geo_Rock-Fungal_Above_Cloth', 'Geo_Rock-Fungal_After_Cloth', "Geo_Rock-Fungal_Below_Pilgrim's_Way", "Geo_Rock-Fungal_Below_Pilgrim's_Way_Dupe", 'Geo_Rock-Mantis_Outskirts_Guarded', 'Geo_Rock-Mantis_Outskirts_Guarded_Dupe', 'Geo_Rock-Mantis_Outskirts_Alcove', 'Geo_Rock-Mantis_Village_After_Lever', 'Geo_Rock-Mantis_Village_Above_Claw', 'Geo_Rock-Mantis_Village_Above_Claw_Dupe', 'Geo_Rock-Mantis_Village_Below_Lore', 'Geo_Rock-Mantis_Village_Above_Lever', 'Geo_Rock-Above_Mantis_Lords_1', 'Geo_Rock-Above_Mantis_Lords_2', 'Geo_Rock-Fungal_After_Bouncy_Grub', 'Geo_Rock-Fungal_After_Bouncy_Grub_Dupe', 'Geo_Rock-Fungal_Bouncy_Grub_Lever', 'Geo_Rock-Fungal_After_Cornifer', 'Geo_Rock-Fungal_Above_City_Entrance', 'Geo_Rock-Deepnest_By_Mantis_Lords_1', 'Geo_Rock-Deepnest_By_Mantis_Lords_2', 'Geo_Rock-Deepnest_Lower_Cornifer', 'Geo_Rock-Fungal_Core_Entrance', 'Geo_Rock-Fungal_Core_Hidden', 'Geo_Rock-Fungal_Core_Above_Elder', "Geo_Rock-Queen's_Gardens_Acid_Entrance", "Geo_Rock-Queen's_Gardens_Below_Stag", 'Geo_Rock-Fog_Canyon_East', 'Geo_Rock-Love_Key', 'Geo_Rock-Love_Key_Dupe', "Geo_Rock-Queen's_Gardens_Above_Marmu", 'Geo_Rock-Pale_Lurker', 'Geo_Rock-Godhome_Pipeway', 'Geo_Rock-Hive_Entrance', 'Geo_Rock-Hive_Outside_Bench', 'Geo_Rock-Hive_Below_Root', 'Geo_Rock-Hive_After_Root', 'Geo_Rock-Hive_Below_Stash', 'Geo_Rock-Hive_Stash', 'Geo_Rock-Hive_Stash_Dupe', 'Geo_Rock-Hive_Below_Grub', 'Geo_Rock-Hive_Above_Mask', 'Geo_Rock-Crystal_Peak_Lower_Middle', 'Geo_Rock-Crystal_Peak_Lower_Conveyer_1', 'Geo_Rock-Crystal_Peak_Lower_Conveyer_2', 'Geo_Rock-Crystal_Peak_Before_Dark_Room', 'Geo_Rock-Crystal_Peak_Before_Dark_Room_Dupe', 'Geo_Rock-Crystal_Peak_Above_Spike_Grub', 'Geo_Rock-Crystal_Peak_Mimic_Grub', 'Geo_Rock-Crystal_Peak_Dive_Egg', 'Geo_Rock-Crystal_Peak_Dive_Egg_Dupe', 'Geo_Rock-Crystal_Peak_Conga_Line', 'Geo_Rock-Hallownest_Crown_Dive', 'Geo_Rock-Hallownest_Crown_Dive_Dupe', 'Geo_Rock-Hallownest_Crown_Hidden', 'Geo_Rock-Hallownest_Crown_Hidden_Dupe_1', 'Geo_Rock-Hallownest_Crown_Hidden_Dupe_2', 'Geo_Rock-Crystal_Peak_Before_Crystal_Heart', 'Geo_Rock-Crystal_Peak_Entrance', 'Geo_Rock-Crystal_Peak_Entrance_Dupe_1', 'Geo_Rock-Crystal_Peak_Entrance_Dupe_2', 'Geo_Rock-Crystal_Peak_Above_Crushers_Lower', 'Geo_Rock-Crystal_Peak_Above_Crushers_Higher', 'Geo_Rock-Resting_Grounds_Catacombs_Grub', 'Geo_Rock-Resting_Grounds_Catacombs_Left_Dupe', 'Geo_Rock-Resting_Grounds_Catacombs_Left', 'Geo_Rock-Overgrown_Mound', 'Geo_Rock-Fluke_Hermit_Dupe', 'Geo_Rock-Fluke_Hermit', 'Geo_Rock-Pleasure_House', 'Geo_Rock-City_of_Tears_Quirrel', 'Geo_Rock-City_of_Tears_Lemm', 'Geo_Rock-City_of_Tears_Above_Lemm', 'Geo_Rock-Soul_Sanctum', "Geo_Rock-Watcher's_Spire", "Geo_Rock-Above_King's_Station", "Geo_Rock-King's_Station", "Geo_Rock-King's_Pass_Left", "Geo_Rock-King's_Pass_Below_Fury", "Geo_Rock-King's_Pass_Hidden", "Geo_Rock-King's_Pass_Collapse", "Geo_Rock-King's_Pass_Above_Fury", 'Geo_Rock-Waterways_Tuk', 'Geo_Rock-Waterways_Tuk_Alcove', 'Geo_Rock-Waterways_Left', 'Geo_Rock-Waterways_East', 'Geo_Rock-Waterways_Flukemarm', 'Boss_Geo-Massive_Moss_Charger', 'Boss_Geo-Gorgeous_Husk', 'Boss_Geo-Sanctum_Soul_Warrior', 'Boss_Geo-Elegant_Soul_Warrior', 'Boss_Geo-Crystal_Guardian', 'Boss_Geo-Enraged_Guardian', 'Boss_Geo-Gruz_Mother', 'Boss_Geo-Vengefly_King', 'Soul_Totem-Basin', 'Soul_Totem-Cliffs_Main', 'Soul_Totem-Cliffs_Gorb', "Soul_Totem-Cliffs_Joni's", 'Soul_Totem-Crossroads_Goam_Journal', 'Soul_Totem-Crossroads_Shops', 'Soul_Totem-Crossroads_Mawlek_Upper', 'Soul_Totem-Crossroads_Acid', 'Soul_Totem-Crossroads_Mawlek_Lower', 'Soul_Totem-Crossroads_Myla', 'Soul_Totem-Ancestral_Mound', 'Soul_Totem-Distant_Village', 'Soul_Totem-Deepnest_Vessel', 'Soul_Totem-Mask_Maker', "Soul_Totem-Lower_Kingdom's_Edge_1", "Soul_Totem-Lower_Kingdom's_Edge_2", "Soul_Totem-Upper_Kingdom's_Edge", "Soul_Totem-Kingdom's_Edge_Camp", 'Soul_Totem-Oro_Dive_2', 'Soul_Totem-Oro_Dive_1', 'Soul_Totem-Oro', 'Soul_Totem-420_Geo_Rock', "Soul_Totem-Beast's_Den", "Soul_Totem-Greenpath_Hunter's_Journal", 'Soul_Totem-Greenpath_MMC', 'Soul_Totem-Greenpath_Below_Toll', "Soul_Totem-Before_Pilgrim's_Way", "Soul_Totem-Pilgrim's_Way", 'Soul_Totem-Fungal_Core', "Soul_Totem-Top_Left_Queen's_Gardens", 'Soul_Totem-Below_Marmu', 'Soul_Totem-Upper_Crystal_Peak', 'Soul_Totem-Hallownest_Crown', 'Soul_Totem-Outside_Crystallized_Mound', 'Soul_Totem-Crystal_Heart_1', 'Soul_Totem-Crystal_Heart_2', 'Soul_Totem-Crystallized_Mound', 'Soul_Totem-Resting_Grounds', 'Soul_Totem-Below_Xero', 'Soul_Totem-Sanctum_Below_Soul_Master', 'Soul_Totem-Sanctum_Below_Chest', 'Soul_Totem-Sanctum_Above_Grub', 'Soul_Totem-Waterways_Entrance', 'Soul_Totem-Top_Left_Waterways', 'Soul_Totem-Waterways_East', 'Soul_Totem-Waterways_Flukemarm', 'Soul_Totem-White_Palace_Entrance', 'Soul_Totem-White_Palace_Hub', 'Soul_Totem-White_Palace_Left', 'Soul_Totem-White_Palace_Final', 'Soul_Totem-White_Palace_Right', 'Soul_Totem-Path_of_Pain_Below_Lever', 'Soul_Totem-Path_of_Pain_Left_of_Lever', 'Soul_Totem-Path_of_Pain_Entrance', 'Soul_Totem-Path_of_Pain_Second', 'Soul_Totem-Path_of_Pain_Hidden', 'Soul_Totem-Path_of_Pain_Below_Thornskip', 'Soul_Totem-Path_of_Pain_Final', 'Soul_Totem-Pale_Lurker', 'Lore_Tablet-City_Entrance', 'Lore_Tablet-Pleasure_House', 'Lore_Tablet-Sanctum_Entrance', 'Lore_Tablet-Sanctum_Past_Soul_Master', "Lore_Tablet-Watcher's_Spire", 'Lore_Tablet-Archives_Upper', 'Lore_Tablet-Archives_Left', 'Lore_Tablet-Archives_Right', "Lore_Tablet-Pilgrim's_Way_1", "Lore_Tablet-Pilgrim's_Way_2", 'Lore_Tablet-Mantis_Outskirts', 'Lore_Tablet-Mantis_Village', 'Lore_Tablet-Greenpath_Upper_Hidden', 'Lore_Tablet-Greenpath_Below_Toll', 'Lore_Tablet-Greenpath_Lifeblood', 'Lore_Tablet-Greenpath_Stag', 'Lore_Tablet-Greenpath_QG', 'Lore_Tablet-Greenpath_Lower_Hidden', 'Lore_Tablet-Dung_Defender', 'Lore_Tablet-Spore_Shroom', 'Lore_Tablet-Fungal_Wastes_Hidden', 'Lore_Tablet-Fungal_Wastes_Below_Shrumal_Ogres', 'Lore_Tablet-Fungal_Core', 'Lore_Tablet-Ancient_Basin', "Lore_Tablet-King's_Pass_Focus", "Lore_Tablet-King's_Pass_Fury", "Lore_Tablet-King's_Pass_Exit", 'Lore_Tablet-World_Sense', 'Lore_Tablet-Howling_Cliffs', "Lore_Tablet-Kingdom's_Edge", 'Lore_Tablet-Palace_Workshop', 'Lore_Tablet-Palace_Throne', 'Lore_Tablet-Path_of_Pain_Entrance'] diff --git a/worlds/kh2/Client.py b/worlds/kh2/Client.py index 544e710741b4..513d85257b97 100644 --- a/worlds/kh2/Client.py +++ b/worlds/kh2/Client.py @@ -821,7 +821,8 @@ async def verifyItems(self): def finishedGame(ctx: KH2Context, message): if ctx.kh2slotdata['FinalXemnas'] == 1: - if not ctx.final_xemnas and ctx.kh2_loc_name_to_id[LocationName.FinalXemnas] in ctx.locations_checked: + if not ctx.final_xemnas and ctx.kh2_read_byte(ctx.Save + all_world_locations[LocationName.FinalXemnas].addrObtained) \ + & 0x1 << all_world_locations[LocationName.FinalXemnas].bitIndex > 0: ctx.final_xemnas = True # three proofs if ctx.kh2slotdata['Goal'] == 0: diff --git a/worlds/kh2/Items.py b/worlds/kh2/Items.py index 3e656b418bfc..cb3d7c8d85ed 100644 --- a/worlds/kh2/Items.py +++ b/worlds/kh2/Items.py @@ -2,22 +2,7 @@ from BaseClasses import Item from .Names import ItemName - - -class KH2Item(Item): - game: str = "Kingdom Hearts 2" - - -class ItemData(typing.NamedTuple): - quantity: int = 0 - kh2id: int = 0 - # Save+ mem addr - memaddr: int = 0 - # some items have bitmasks. if bitmask>0 bitor to give item else - bitmask: int = 0 - # if ability then - ability: bool = False - +from .Subclasses import ItemData # 0x130000 Reports_Table = { @@ -209,7 +194,7 @@ class ItemData(typing.NamedTuple): ItemName.GrandRibbon: ItemData(1, 157, 0x35D4), } Usefull_Table = { - ItemName.MickeyMunnyPouch: ItemData(1, 535, 0x3695), # 5000 munny per + ItemName.MickeyMunnyPouch: ItemData(1, 535, 0x3695), # 5000 munny per ItemName.OletteMunnyPouch: ItemData(2, 362, 0x363C), # 2500 munny per ItemName.HadesCupTrophy: ItemData(1, 537, 0x3696), ItemName.UnknownDisk: ItemData(1, 462, 0x365F), @@ -349,7 +334,7 @@ class ItemData(typing.NamedTuple): Wincon_Table = { ItemName.LuckyEmblem: ItemData(kh2id=367, memaddr=0x3641), # letter item - ItemName.Victory: ItemData(kh2id=263, memaddr=0x111), + # ItemName.Victory: ItemData(kh2id=263, memaddr=0x111), ItemName.Bounty: ItemData(kh2id=461, memaddr=0x365E), # Dummy 14 # ItemName.UniversalKey:ItemData(,365,0x363F,0)#Tournament Poster } diff --git a/worlds/kh2/Locations.py b/worlds/kh2/Locations.py index 9d7d948443cd..61fafe909412 100644 --- a/worlds/kh2/Locations.py +++ b/worlds/kh2/Locations.py @@ -1,19 +1,9 @@ import typing from BaseClasses import Location -from .Names import LocationName, ItemName - - -class KH2Location(Location): - game: str = "Kingdom Hearts 2" - - -class LocationData(typing.NamedTuple): - locid: int - yml: str - charName: str = "Sora" - charNumber: int = 1 - +from .Names import LocationName, ItemName, RegionName +from .Subclasses import LocationData +from .Regions import KH2REGIONS # data's addrcheck sys3 addr obtained roomid bit index is eventid LoD_Checks = { @@ -541,7 +531,7 @@ class LocationData(typing.NamedTuple): LocationName.Xemnas1: LocationData(26, "Double Get Bonus"), LocationName.Xemnas1GetBonus: LocationData(26, "Second Get Bonus"), LocationName.Xemnas1SecretAnsemReport13: LocationData(537, "Chest"), - LocationName.FinalXemnas: LocationData(71, "Get Bonus"), + # LocationName.FinalXemnas: LocationData(71, "Get Bonus"), LocationName.XemnasDataPowerBoost: LocationData(554, "Chest"), } @@ -806,74 +796,75 @@ class LocationData(typing.NamedTuple): } event_location_to_item = { - LocationName.HostileProgramEventLocation: ItemName.HostileProgramEvent, - LocationName.McpEventLocation: ItemName.McpEvent, + LocationName.HostileProgramEventLocation: ItemName.HostileProgramEvent, + LocationName.McpEventLocation: ItemName.McpEvent, # LocationName.ASLarxeneEventLocation: ItemName.ASLarxeneEvent, - LocationName.DataLarxeneEventLocation: ItemName.DataLarxeneEvent, - LocationName.BarbosaEventLocation: ItemName.BarbosaEvent, - LocationName.GrimReaper1EventLocation: ItemName.GrimReaper1Event, - LocationName.GrimReaper2EventLocation: ItemName.GrimReaper2Event, - LocationName.DataLuxordEventLocation: ItemName.DataLuxordEvent, - LocationName.DataAxelEventLocation: ItemName.DataAxelEvent, - LocationName.CerberusEventLocation: ItemName.CerberusEvent, - LocationName.OlympusPeteEventLocation: ItemName.OlympusPeteEvent, - LocationName.HydraEventLocation: ItemName.HydraEvent, + LocationName.DataLarxeneEventLocation: ItemName.DataLarxeneEvent, + LocationName.BarbosaEventLocation: ItemName.BarbosaEvent, + LocationName.GrimReaper1EventLocation: ItemName.GrimReaper1Event, + LocationName.GrimReaper2EventLocation: ItemName.GrimReaper2Event, + LocationName.DataLuxordEventLocation: ItemName.DataLuxordEvent, + LocationName.DataAxelEventLocation: ItemName.DataAxelEvent, + LocationName.CerberusEventLocation: ItemName.CerberusEvent, + LocationName.OlympusPeteEventLocation: ItemName.OlympusPeteEvent, + LocationName.HydraEventLocation: ItemName.HydraEvent, LocationName.OcPainAndPanicCupEventLocation: ItemName.OcPainAndPanicCupEvent, - LocationName.OcCerberusCupEventLocation: ItemName.OcCerberusCupEvent, - LocationName.HadesEventLocation: ItemName.HadesEvent, + LocationName.OcCerberusCupEventLocation: ItemName.OcCerberusCupEvent, + LocationName.HadesEventLocation: ItemName.HadesEvent, # LocationName.ASZexionEventLocation: ItemName.ASZexionEvent, - LocationName.DataZexionEventLocation: ItemName.DataZexionEvent, - LocationName.Oc2TitanCupEventLocation: ItemName.Oc2TitanCupEvent, - LocationName.Oc2GofCupEventLocation: ItemName.Oc2GofCupEvent, + LocationName.DataZexionEventLocation: ItemName.DataZexionEvent, + LocationName.Oc2TitanCupEventLocation: ItemName.Oc2TitanCupEvent, + LocationName.Oc2GofCupEventLocation: ItemName.Oc2GofCupEvent, # LocationName.Oc2CupsEventLocation: ItemName.Oc2CupsEventLocation, - LocationName.HadesCupEventLocations: ItemName.HadesCupEvents, - LocationName.PrisonKeeperEventLocation: ItemName.PrisonKeeperEvent, - LocationName.OogieBoogieEventLocation: ItemName.OogieBoogieEvent, - LocationName.ExperimentEventLocation: ItemName.ExperimentEvent, + LocationName.HadesCupEventLocations: ItemName.HadesCupEvents, + LocationName.PrisonKeeperEventLocation: ItemName.PrisonKeeperEvent, + LocationName.OogieBoogieEventLocation: ItemName.OogieBoogieEvent, + LocationName.ExperimentEventLocation: ItemName.ExperimentEvent, # LocationName.ASVexenEventLocation: ItemName.ASVexenEvent, - LocationName.DataVexenEventLocation: ItemName.DataVexenEvent, - LocationName.ShanYuEventLocation: ItemName.ShanYuEvent, - LocationName.AnsemRikuEventLocation: ItemName.AnsemRikuEvent, - LocationName.StormRiderEventLocation: ItemName.StormRiderEvent, - LocationName.DataXigbarEventLocation: ItemName.DataXigbarEvent, - LocationName.RoxasEventLocation: ItemName.RoxasEvent, - LocationName.XigbarEventLocation: ItemName.XigbarEvent, - LocationName.LuxordEventLocation: ItemName.LuxordEvent, - LocationName.SaixEventLocation: ItemName.SaixEvent, - LocationName.XemnasEventLocation: ItemName.XemnasEvent, - LocationName.ArmoredXemnasEventLocation: ItemName.ArmoredXemnasEvent, - LocationName.ArmoredXemnas2EventLocation: ItemName.ArmoredXemnas2Event, + LocationName.DataVexenEventLocation: ItemName.DataVexenEvent, + LocationName.ShanYuEventLocation: ItemName.ShanYuEvent, + LocationName.AnsemRikuEventLocation: ItemName.AnsemRikuEvent, + LocationName.StormRiderEventLocation: ItemName.StormRiderEvent, + LocationName.DataXigbarEventLocation: ItemName.DataXigbarEvent, + LocationName.RoxasEventLocation: ItemName.RoxasEvent, + LocationName.XigbarEventLocation: ItemName.XigbarEvent, + LocationName.LuxordEventLocation: ItemName.LuxordEvent, + LocationName.SaixEventLocation: ItemName.SaixEvent, + LocationName.XemnasEventLocation: ItemName.XemnasEvent, + LocationName.ArmoredXemnasEventLocation: ItemName.ArmoredXemnasEvent, + LocationName.ArmoredXemnas2EventLocation: ItemName.ArmoredXemnas2Event, # LocationName.FinalXemnasEventLocation: ItemName.FinalXemnasEvent, - LocationName.DataXemnasEventLocation: ItemName.DataXemnasEvent, - LocationName.ThresholderEventLocation: ItemName.ThresholderEvent, - LocationName.BeastEventLocation: ItemName.BeastEvent, - LocationName.DarkThornEventLocation: ItemName.DarkThornEvent, - LocationName.XaldinEventLocation: ItemName.XaldinEvent, - LocationName.DataXaldinEventLocation: ItemName.DataXaldinEvent, - LocationName.TwinLordsEventLocation: ItemName.TwinLordsEvent, - LocationName.GenieJafarEventLocation: ItemName.GenieJafarEvent, + LocationName.DataXemnasEventLocation: ItemName.DataXemnasEvent, + LocationName.ThresholderEventLocation: ItemName.ThresholderEvent, + LocationName.BeastEventLocation: ItemName.BeastEvent, + LocationName.DarkThornEventLocation: ItemName.DarkThornEvent, + LocationName.XaldinEventLocation: ItemName.XaldinEvent, + LocationName.DataXaldinEventLocation: ItemName.DataXaldinEvent, + LocationName.TwinLordsEventLocation: ItemName.TwinLordsEvent, + LocationName.GenieJafarEventLocation: ItemName.GenieJafarEvent, # LocationName.ASLexaeusEventLocation: ItemName.ASLexaeusEvent, - LocationName.DataLexaeusEventLocation: ItemName.DataLexaeusEvent, - LocationName.ScarEventLocation: ItemName.ScarEvent, - LocationName.GroundShakerEventLocation: ItemName.GroundShakerEvent, - LocationName.DataSaixEventLocation: ItemName.DataSaixEvent, - LocationName.HBDemyxEventLocation: ItemName.HBDemyxEvent, - LocationName.ThousandHeartlessEventLocation: ItemName.ThousandHeartlessEvent, - LocationName.Mushroom13EventLocation: ItemName.Mushroom13Event, - LocationName.SephiEventLocation: ItemName.SephiEvent, - LocationName.DataDemyxEventLocation: ItemName.DataDemyxEvent, - LocationName.CorFirstFightEventLocation: ItemName.CorFirstFightEvent, - LocationName.CorSecondFightEventLocation: ItemName.CorSecondFightEvent, - LocationName.TransportEventLocation: ItemName.TransportEvent, - LocationName.OldPeteEventLocation: ItemName.OldPeteEvent, - LocationName.FuturePeteEventLocation: ItemName.FuturePeteEvent, + LocationName.DataLexaeusEventLocation: ItemName.DataLexaeusEvent, + LocationName.ScarEventLocation: ItemName.ScarEvent, + LocationName.GroundShakerEventLocation: ItemName.GroundShakerEvent, + LocationName.DataSaixEventLocation: ItemName.DataSaixEvent, + LocationName.HBDemyxEventLocation: ItemName.HBDemyxEvent, + LocationName.ThousandHeartlessEventLocation: ItemName.ThousandHeartlessEvent, + LocationName.Mushroom13EventLocation: ItemName.Mushroom13Event, + LocationName.SephiEventLocation: ItemName.SephiEvent, + LocationName.DataDemyxEventLocation: ItemName.DataDemyxEvent, + LocationName.CorFirstFightEventLocation: ItemName.CorFirstFightEvent, + LocationName.CorSecondFightEventLocation: ItemName.CorSecondFightEvent, + LocationName.TransportEventLocation: ItemName.TransportEvent, + LocationName.OldPeteEventLocation: ItemName.OldPeteEvent, + LocationName.FuturePeteEventLocation: ItemName.FuturePeteEvent, # LocationName.ASMarluxiaEventLocation: ItemName.ASMarluxiaEvent, - LocationName.DataMarluxiaEventLocation: ItemName.DataMarluxiaEvent, - LocationName.TerraEventLocation: ItemName.TerraEvent, - LocationName.TwilightThornEventLocation: ItemName.TwilightThornEvent, - LocationName.Axel1EventLocation: ItemName.Axel1Event, - LocationName.Axel2EventLocation: ItemName.Axel2Event, - LocationName.DataRoxasEventLocation: ItemName.DataRoxasEvent, + LocationName.DataMarluxiaEventLocation: ItemName.DataMarluxiaEvent, + LocationName.TerraEventLocation: ItemName.TerraEvent, + LocationName.TwilightThornEventLocation: ItemName.TwilightThornEvent, + LocationName.Axel1EventLocation: ItemName.Axel1Event, + LocationName.Axel2EventLocation: ItemName.Axel2Event, + LocationName.DataRoxasEventLocation: ItemName.DataRoxasEvent, + LocationName.FinalXemnasEventLocation: ItemName.Victory, } all_weapon_slot = { LocationName.FAKESlot, @@ -1361,3 +1352,9 @@ class LocationData(typing.NamedTuple): location for location, data in all_locations.items() if location not in event_location_to_item.keys() and location not in popups_set and location != LocationName.StationofSerenityPotion and data.yml == "Chest" } } + +location_groups: typing.Dict[str, list] +location_groups = { + Region_Name: [loc for loc in Region_Locs if "Event" not in loc] + for Region_Name, Region_Locs in KH2REGIONS.items() if Region_Locs +} diff --git a/worlds/kh2/Options.py b/worlds/kh2/Options.py index 7ba7c0082d17..b7caf7437007 100644 --- a/worlds/kh2/Options.py +++ b/worlds/kh2/Options.py @@ -2,7 +2,7 @@ from Options import Choice, Range, Toggle, ItemDict, PerGameCommonOptions, StartInventoryPool -from worlds.kh2 import default_itempool_option +from . import default_itempool_option class SoraEXP(Range): diff --git a/worlds/kh2/Regions.py b/worlds/kh2/Regions.py index 6dd8313107fe..235500ec89e4 100644 --- a/worlds/kh2/Regions.py +++ b/worlds/kh2/Regions.py @@ -1,9 +1,11 @@ import typing from BaseClasses import MultiWorld, Region +from . import Locations -from .Locations import KH2Location, event_location_to_item -from . import LocationName, RegionName, Events_Table +from .Subclasses import KH2Location +from .Names import LocationName, RegionName +from .Items import Events_Table KH2REGIONS: typing.Dict[str, typing.List[str]] = { "Menu": [], @@ -788,7 +790,7 @@ LocationName.ArmoredXemnas2EventLocation ], RegionName.FinalXemnas: [ - LocationName.FinalXemnas + LocationName.FinalXemnasEventLocation ], RegionName.DataXemnas: [ LocationName.XemnasDataPowerBoost, @@ -1020,7 +1022,8 @@ def create_regions(self): multiworld.regions += [create_region(multiworld, player, active_locations, region, locations) for region, locations in KH2REGIONS.items()] # fill the event locations with events - for location, item in event_location_to_item.items(): + + for location, item in Locations.event_location_to_item.items(): multiworld.get_location(location, player).place_locked_item( multiworld.worlds[player].create_event_item(item)) diff --git a/worlds/kh2/Rules.py b/worlds/kh2/Rules.py index 7c5551dbd563..1124f8109c54 100644 --- a/worlds/kh2/Rules.py +++ b/worlds/kh2/Rules.py @@ -1,7 +1,7 @@ from typing import Dict, Callable, TYPE_CHECKING from BaseClasses import CollectionState -from .Items import exclusion_item_table, visit_locking_dict, DonaldAbility_Table, GoofyAbility_Table +from .Items import exclusion_item_table, visit_locking_dict, DonaldAbility_Table, GoofyAbility_Table, SupportAbility_Table from .Locations import exclusion_table, popups_set, Goofy_Checks, Donald_Checks from .Names import LocationName, ItemName, RegionName from worlds.generic.Rules import add_rule, forbid_items, add_item_rule @@ -83,6 +83,8 @@ def hundred_acre_unlocked(self, state: CollectionState, amount) -> bool: return state.has(ItemName.TornPages, self.player, amount) def level_locking_unlock(self, state: CollectionState, amount): + if self.world.options.Promise_Charm and state.has(ItemName.PromiseCharm, self.player): + return True return amount <= sum([state.count(item_name, self.player) for item_name in visit_locking_dict["2VisitLocking"]]) def summon_levels_unlocked(self, state: CollectionState, amount) -> bool: @@ -224,7 +226,7 @@ def __init__(self, kh2world: KH2World) -> None: RegionName.Pl2: lambda state: self.pl_unlocked(state, 2), RegionName.Ag: lambda state: self.ag_unlocked(state, 1), - RegionName.Ag2: lambda state: self.ag_unlocked(state, 2) and self.kh2_has_all([ItemName.FireElement,ItemName.BlizzardElement,ItemName.ThunderElement],state), + RegionName.Ag2: lambda state: self.ag_unlocked(state, 2) and self.kh2_has_all([ItemName.FireElement, ItemName.BlizzardElement, ItemName.ThunderElement], state), RegionName.Bc: lambda state: self.bc_unlocked(state, 1), RegionName.Bc2: lambda state: self.bc_unlocked(state, 2), @@ -266,9 +268,11 @@ def set_kh2_rules(self) -> None: add_item_rule(location, lambda item: item.player == self.player and item.name in GoofyAbility_Table.keys()) elif location.name in Donald_Checks: add_item_rule(location, lambda item: item.player == self.player and item.name in DonaldAbility_Table.keys()) + else: + add_item_rule(location, lambda item: item.player == self.player and item.name in SupportAbility_Table.keys()) def set_kh2_goal(self): - final_xemnas_location = self.multiworld.get_location(LocationName.FinalXemnas, self.player) + final_xemnas_location = self.multiworld.get_location(LocationName.FinalXemnasEventLocation, self.player) if self.multiworld.Goal[self.player] == "three_proofs": final_xemnas_location.access_rule = lambda state: self.kh2_has_all(three_proofs, state) if self.multiworld.FinalXemnas[self.player]: @@ -417,7 +421,7 @@ def __init__(self, world: KH2World) -> None: RegionName.DataLexaeus: lambda state: self.get_data_lexaeus_rules(state), RegionName.OldPete: lambda state: self.get_old_pete_rules(), RegionName.FuturePete: lambda state: self.get_future_pete_rules(state), - RegionName.Terra: lambda state: self.get_terra_rules(state), + RegionName.Terra: lambda state: self.get_terra_rules(state) and state.has(ItemName.ProofofConnection, self.player), RegionName.DataMarluxia: lambda state: self.get_data_marluxia_rules(state), RegionName.Barbosa: lambda state: self.get_barbosa_rules(state), RegionName.GrimReaper1: lambda state: self.get_grim_reaper1_rules(), diff --git a/worlds/kh2/Subclasses.py b/worlds/kh2/Subclasses.py new file mode 100644 index 000000000000..79f52c41c02a --- /dev/null +++ b/worlds/kh2/Subclasses.py @@ -0,0 +1,29 @@ +import typing + +from BaseClasses import Location, Item + + +class KH2Location(Location): + game: str = "Kingdom Hearts 2" + + +class LocationData(typing.NamedTuple): + locid: int + yml: str + charName: str = "Sora" + charNumber: int = 1 + + +class KH2Item(Item): + game: str = "Kingdom Hearts 2" + + +class ItemData(typing.NamedTuple): + quantity: int = 0 + kh2id: int = 0 + # Save+ mem addr + memaddr: int = 0 + # some items have bitmasks. if bitmask>0 bitor to give item else + bitmask: int = 0 + # if ability then + ability: bool = False diff --git a/worlds/kh2/__init__.py b/worlds/kh2/__init__.py index 2bddbd5ec30e..d02614d3802e 100644 --- a/worlds/kh2/__init__.py +++ b/worlds/kh2/__init__.py @@ -12,6 +12,7 @@ from .Options import KingdomHearts2Options from .Regions import create_regions, connect_regions from .Rules import * +from .Subclasses import KH2Item def launch_client(): @@ -49,7 +50,9 @@ class KH2World(World): for item_id, item in enumerate(item_dictionary_table.keys(), 0x130000)} location_name_to_id = {item: location for location, item in enumerate(all_locations.keys(), 0x130000)} + item_name_groups = item_groups + location_name_groups = location_groups visitlocking_dict: Dict[str, int] plando_locations: Dict[str, str] @@ -253,11 +256,8 @@ def generate_early(self) -> None: self.goofy_gen_early() self.keyblade_gen_early() - if self.multiworld.FinalXemnas[self.player]: - self.plando_locations[LocationName.FinalXemnas] = ItemName.Victory - else: - self.plando_locations[LocationName.FinalXemnas] = self.create_filler().name - self.total_locations -= 1 + # final xemnas isn't a location anymore + # self.total_locations -= 1 if self.options.WeaponSlotStartHint: for location in all_weapon_slot: diff --git a/worlds/kh2/docs/en_Kingdom Hearts 2.md b/worlds/kh2/docs/en_Kingdom Hearts 2.md index a07f29be54b9..f08a1fc51fc0 100644 --- a/worlds/kh2/docs/en_Kingdom Hearts 2.md +++ b/worlds/kh2/docs/en_Kingdom Hearts 2.md @@ -16,6 +16,7 @@ The [player settings page for this game](../player-settings) contains all the op - Popups - Get Bonuses - Form Levels +- Summon Levels - Sora's Levels - Keyblade Stats - Keyblade Abilities @@ -23,7 +24,7 @@ The [player settings page for this game](../player-settings) contains all the op

What Kingdom Hearts 2 items can appear in other players' worlds?

-Every item in the game except for party members' abilities. +Every item in the game except for abilities on weapons.

What is The Garden of Assemblage "GoA"?

@@ -73,6 +74,8 @@ The list of possible locations that can contain a bounty: - Each of the 13 Data Fights - Max level (7) for each Drive Form +- Max level (7) of Summons +- Last song of Atlantica - Sephiroth - Lingering Will - Starry Hill @@ -87,6 +90,7 @@ With the help of Shananas, Num, and ZakTheRobot we have many QoL features such a - Faster Wardrobe. - Faster Water Jafar Chase. +- Faster Bulky Vendors - Carpet Skip. - Start with Lion Dash. - Faster Urns. diff --git a/worlds/kh2/docs/setup_en.md b/worlds/kh2/docs/setup_en.md index e0c8330632ef..96b3b936f338 100644 --- a/worlds/kh2/docs/setup_en.md +++ b/worlds/kh2/docs/setup_en.md @@ -7,14 +7,14 @@

Required Software:

`Kingdom Hearts II Final Mix` from the [Epic Games Store](https://store.epicgames.com/en-US/discover/kingdom-hearts) - Follow this Guide to set up these requirements [KH2Rando.com](https://tommadness.github.io/KH2Randomizer/setup/Panacea-ModLoader/)
- 1. `3.0.0 OpenKH Mod Manager with Panacea`
- 2. `Install mod from KH2FM-Mods-Num/GoA-ROM-Edition`
- 3. `Setup Lua Backend From the 3.0.0 KH2Randomizer.exe per the setup guide linked above`
+ 1. `3.2.0 OpenKH Mod Manager with Panacea`
+ 2. `Lua Backend from the OpenKH Mod Manager` + 3. `Install the mod KH2FM-Mods-Num/GoA-ROM-Edition using OpenKH Mod Manager`
- Needed for Archipelago 1. [`ArchipelagoKH2Client.exe`](https://github.com/ArchipelagoMW/Archipelago/releases)
- 2. `Install mod from JaredWeakStrike/APCompanion`
- 3. `Install mod from KH2FM-Mods-equations19/auto-save`
+ 2. `Install the mod from JaredWeakStrike/APCompanion using OpenKH Mod Manager`
+ 3. `Install the mod from KH2FM-Mods-equations19/auto-save using OpenKH Mod Manager`
4. `AP Randomizer Seed`

Required: Archipelago Companion Mod

@@ -68,8 +68,8 @@ Enter `The room's port number` into the top box where the x's are and pr - Run the game in windows/borderless windowed mode. Fullscreen is stable but the game can crash if you alt-tab out. - Make sure to save in a different save slot when playing in an async or disconnecting from the server to play a different seed -

Requirement/logic sheet

-Have any questions on what's in logic? This spreadsheet has the answer [Requirements/logic sheet](https://docs.google.com/spreadsheets/d/1Embae0t7pIrbzvX-NRywk7bTHHEvuFzzQBUUpSUL7Ak/edit?usp=sharing) +

Logic Sheet

+Have any questions on what's in logic? This spreadsheet made by Bulcon has the answer [Requirements/logic sheet](https://docs.google.com/spreadsheets/d/1nNi8ohEs1fv-sDQQRaP45o6NoRcMlLJsGckBonweDMY/edit?usp=sharing)

F.A.Q.

- Why is my HP/MP continuously increasing without stopping? diff --git a/worlds/ladx/docs/setup_en.md b/worlds/ladx/docs/setup_en.md index e21c5bddc489..aad077d73037 100644 --- a/worlds/ladx/docs/setup_en.md +++ b/worlds/ladx/docs/setup_en.md @@ -2,7 +2,7 @@ ## Required Software -- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). Make sure to check the box for `Links Awakening DX` +- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). - Software capable of loading and playing GBC ROM files - [RetroArch](https://retroarch.com?page=platforms) 1.10.3 or newer. - [BizHawk](https://tasvideos.org/BizHawk) 2.8 or newer. @@ -10,11 +10,12 @@ ## Installation Procedures -1. Download and install LinksAwakeningClient from the link above, making sure to install the most recent version. - **The installer file is located in the assets section at the bottom of the version information**. - - During setup, you will be asked to locate your base ROM file. This is your Links Awakening DX ROM file. +1. Download and install [Archipelago](). **The installer + file is located in the assets section at the bottom of the version information.** +2. The first time you do local generation or patch your game, you will be asked to locate your base ROM file. + This is your Links Awakening DX ROM file. This only needs to be done once.. -2. You should assign your emulator as your default program for launching ROM +3. You should assign your emulator as your default program for launching ROM files. 1. Extract your emulator's folder to your Desktop, or somewhere you will remember. 2. Right-click on a ROM file and select **Open with...** diff --git a/worlds/landstalker/docs/landstalker_setup_en.md b/worlds/landstalker/docs/landstalker_setup_en.md index 9f453c146de3..32e46a4b3354 100644 --- a/worlds/landstalker/docs/landstalker_setup_en.md +++ b/worlds/landstalker/docs/landstalker_setup_en.md @@ -30,8 +30,8 @@ guide: [Basic Multiworld Setup Guide](/tutorial/Archipelago/setup/en) ### Where do I get a config file? -The [Player Settings Page](../player-settings) on the website allows you to easily configure your personal settings -and export a config file from them. +The [Player Settings Page](/games/Landstalker%20-%20The%20Treasures%20of%20King%20Nole/player-settings) on the website allows +you to easily configure your personal settings ## How-to-play diff --git a/worlds/lingo/data/LL1.yaml b/worlds/lingo/data/LL1.yaml index ea5886fea00e..32a7659b826e 100644 --- a/worlds/lingo/data/LL1.yaml +++ b/worlds/lingo/data/LL1.yaml @@ -2635,12 +2635,6 @@ panels: - OBSTACLE The Colorful: - # The set of required_doors in the achievement panel should prevent - # generation from asking you to solve The Colorful before opening all of the - # doors. Access from the roof is included so that the painting here could be - # an entrance. The client will have to be hardcoded to not open the door to - # the achievement until all of the doors are open, whether by solving the - # panels or through receiving items. entrances: The Colorful (Gray): room: The Colorful (Gray) @@ -2651,31 +2645,53 @@ id: Countdown Panels/Panel_colorful_colorful check: True tag: forbid - required_door: + required_panel: - room: The Colorful (White) - door: Progress Door + panel: BEGIN - room: The Colorful (Black) - door: Progress Door + panel: FOUND - room: The Colorful (Red) - door: Progress Door + panel: LOAF - room: The Colorful (Yellow) - door: Progress Door + panel: CREAM - room: The Colorful (Blue) - door: Progress Door + panel: SUN - room: The Colorful (Purple) - door: Progress Door + panel: SPOON - room: The Colorful (Orange) - door: Progress Door + panel: LETTERS - room: The Colorful (Green) - door: Progress Door + panel: WALLS - room: The Colorful (Brown) - door: Progress Door + panel: IRON - room: The Colorful (Gray) - door: Progress Door + panel: OBSTACLE achievement: The Colorful paintings: - id: arrows_painting_12 orientation: north + progression: + Progressive Colorful: + - room: The Colorful (White) + door: Progress Door + - room: The Colorful (Black) + door: Progress Door + - room: The Colorful (Red) + door: Progress Door + - room: The Colorful (Yellow) + door: Progress Door + - room: The Colorful (Blue) + door: Progress Door + - room: The Colorful (Purple) + door: Progress Door + - room: The Colorful (Orange) + door: Progress Door + - room: The Colorful (Green) + door: Progress Door + - room: The Colorful (Brown) + door: Progress Door + - room: The Colorful (Gray) + door: Progress Door Welcome Back Area: entrances: Starting Room: @@ -4202,9 +4218,6 @@ SIX: id: Backside Room/Panel_six_six_5 tag: midwhite - colors: - - red - - yellow hunt: True required_door: room: Number Hunt @@ -4280,9 +4293,6 @@ SIX: id: Backside Room/Panel_six_six_6 tag: midwhite - colors: - - red - - yellow hunt: True required_door: room: Number Hunt diff --git a/worlds/lingo/data/ids.yaml b/worlds/lingo/data/ids.yaml index 3239f21854c4..2b9e7f3d8ca0 100644 --- a/worlds/lingo/data/ids.yaml +++ b/worlds/lingo/data/ids.yaml @@ -1452,3 +1452,4 @@ progression: Progressive Fearless: 444470 Progressive Orange Tower: 444482 Progressive Art Gallery: 444563 + Progressive Colorful: 444580 diff --git a/worlds/lingo/items.py b/worlds/lingo/items.py index af24570f278e..7b1a65056178 100644 --- a/worlds/lingo/items.py +++ b/worlds/lingo/items.py @@ -28,6 +28,10 @@ def should_include(self, world: "LingoWorld") -> bool: # door shuffle is on and tower isn't progressive return world.options.shuffle_doors != ShuffleDoors.option_none \ and not world.options.progressive_orange_tower + elif self.mode == "the colorful": + # complex door shuffle is on and colorful isn't progressive + return world.options.shuffle_doors == ShuffleDoors.option_complex \ + and not world.options.progressive_colorful elif self.mode == "complex door": return world.options.shuffle_doors == ShuffleDoors.option_complex elif self.mode == "door group": @@ -70,6 +74,8 @@ def load_item_data(): if room_name in PROGRESSION_BY_ROOM and door_name in PROGRESSION_BY_ROOM[room_name]: if room_name == "Orange Tower": door_mode = "orange tower" + elif room_name == "The Colorful": + door_mode = "the colorful" else: door_mode = "special" diff --git a/worlds/lingo/options.py b/worlds/lingo/options.py index c00208621f9e..ec6158fab5ae 100644 --- a/worlds/lingo/options.py +++ b/worlds/lingo/options.py @@ -21,6 +21,13 @@ class ProgressiveOrangeTower(DefaultOnToggle): display_name = "Progressive Orange Tower" +class ProgressiveColorful(DefaultOnToggle): + """When "Shuffle Doors" is on "complex", this setting governs the manner in which The Colorful opens up. + If off, there is an item for each room of The Colorful, meaning that random rooms in the middle of the sequence can open up without giving you access to them. + If on, there are ten progressive items, which open up the sequence from White forward.""" + display_name = "Progressive Colorful" + + class LocationChecks(Choice): """On "normal", there will be a location check for each panel set that would ordinarily open a door, as well as for achievement panels and a small handful of other panels. @@ -117,6 +124,7 @@ class DeathLink(Toggle): class LingoOptions(PerGameCommonOptions): shuffle_doors: ShuffleDoors progressive_orange_tower: ProgressiveOrangeTower + progressive_colorful: ProgressiveColorful location_checks: LocationChecks shuffle_colors: ShuffleColors shuffle_panels: ShufflePanels diff --git a/worlds/lingo/player_logic.py b/worlds/lingo/player_logic.py index fa497c59bd45..f3efc2914c3d 100644 --- a/worlds/lingo/player_logic.py +++ b/worlds/lingo/player_logic.py @@ -83,7 +83,8 @@ def set_door_item(self, room: str, door: str, item: str): def handle_non_grouped_door(self, room_name: str, door_data: Door, world: "LingoWorld"): if room_name in PROGRESSION_BY_ROOM and door_data.name in PROGRESSION_BY_ROOM[room_name]: - if room_name == "Orange Tower" and not world.options.progressive_orange_tower: + if (room_name == "Orange Tower" and not world.options.progressive_orange_tower)\ + or (room_name == "The Colorful" and not world.options.progressive_colorful): self.set_door_item(room_name, door_data.name, door_data.item_name) else: progressive_item_name = PROGRESSION_BY_ROOM[room_name][door_data.name].item_name @@ -223,7 +224,7 @@ def __init__(self, world: "LingoWorld"): "kind of logic error.") if door_shuffle != ShuffleDoors.option_none and location_classification != LocationClassification.insanity \ - and not early_color_hallways is False: + and not early_color_hallways: # If shuffle doors is on, force a useful item onto the HI panel. This may not necessarily get you out of BK, # but the goal is to allow you to reach at least one more check. The non-painting ones are hardcoded right # now. We only allow the entrance to the Pilgrim Room if color shuffle is off, because otherwise there are diff --git a/worlds/lufia2ac/docs/setup_en.md b/worlds/lufia2ac/docs/setup_en.md index 3762f32fb4a8..4d4ea811abcf 100644 --- a/worlds/lufia2ac/docs/setup_en.md +++ b/worlds/lufia2ac/docs/setup_en.md @@ -2,7 +2,7 @@ ## Required Software -- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). Make sure to check the box for `SNI Client - Lufia II Ancient Cave Patch Setup` +- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). - Hardware or software capable of loading and playing SNES ROM files - An emulator capable of connecting to SNI ([snes9x rr](https://github.com/gocha/snes9x-rr/releases), @@ -14,11 +14,12 @@ modded SNES minis are currently not supported by SNI** ## Installation Procedures -1. Download and install SNIClient from the link above, making sure to install the most recent version. - **The installer file is located in the assets section at the bottom of the version information**. - - During setup, you will be asked to locate your base ROM file. This is your American Lufia II - Rise of the Sinistrals ROM file. +1. Download and install [Archipelago](). **The installer + file is located in the assets section at the bottom of the version information.** +2. The first time you do local generation or patch your game, you will be asked to locate your base ROM file. + This is your American Lufia II - Rise of the Sinistrals ROM file. This only needs to be done once. -2. If you are using an emulator, you should assign your Lua capable emulator as your default program for launching ROM +3. If you are using an emulator, you should assign your Lua capable emulator as your default program for launching ROM files. 1. Extract your emulator's folder to your Desktop, or somewhere you will remember. 2. Right-click on a ROM file and select **Open with...** diff --git a/worlds/minecraft/docs/minecraft_en.md b/worlds/minecraft/docs/minecraft_en.md index e8b1a3642ee0..b71ed930a5d8 100644 --- a/worlds/minecraft/docs/minecraft_en.md +++ b/worlds/minecraft/docs/minecraft_en.md @@ -5,7 +5,6 @@ - Minecraft Java Edition from the [Minecraft Java Edition Store Page](https://www.minecraft.net/en-us/store/minecraft-java-edition) - Archipelago from the [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases) - - (select `Minecraft Client` during installation.) ## Configuring your YAML file diff --git a/worlds/mmbn3/docs/setup_en.md b/worlds/mmbn3/docs/setup_en.md index b5ff1625c819..e9181ea54881 100644 --- a/worlds/mmbn3/docs/setup_en.md +++ b/worlds/mmbn3/docs/setup_en.md @@ -10,8 +10,7 @@ As we are using Bizhawk, this guide is only applicable to Windows and Linux syst - Version 2.7.0 and later are supported. - Detailed installation instructions for Bizhawk can be found at the above link. - Windows users must run the prereq installer first, which can also be found at the above link. -- The built-in Archipelago client, which can be installed [here](https://github.com/ArchipelagoMW/Archipelago/releases) - (select `MegaMan Battle Network 3 Client` during installation). +- The built-in Archipelago client, which can be installed [here](https://github.com/ArchipelagoMW/Archipelago/releases). - A US MegaMan Battle Network 3 Blue Rom. If you have the [MegaMan Battle Network Legacy Collection Vol. 1](https://store.steampowered.com/app/1798010/Mega_Man_Battle_Network_Legacy_Collection_Vol_1/) on Steam, you can obtain a copy of this ROM from the game's files, see instructions below. diff --git a/worlds/musedash/MuseDashCollection.py b/worlds/musedash/MuseDashCollection.py index 55523542d7df..6cd27c696c93 100644 --- a/worlds/musedash/MuseDashCollection.py +++ b/worlds/musedash/MuseDashCollection.py @@ -34,6 +34,7 @@ class MuseDashCollections: "Rush-Hour", "Find this Month's Featured Playlist", "PeroPero in the Universe", + "umpopoff" ] album_items: Dict[str, AlbumData] = {} @@ -81,11 +82,22 @@ def __init__(self) -> None: steamer_mode = sections[3] == "True" if song_name in self.DIFF_OVERRIDES: - # Note: These difficulties may not actually be representative of these songs. - # The game does not provide these difficulties so they have to be filled in. - diff_of_easy = 4 - diff_of_hard = 7 - diff_of_master = 10 + # These songs use non-standard difficulty values. Which are being overriden with standard values. + # But also avoid filling any missing difficulties (i.e. 0s) with a difficulty value. + if sections[4] != '0': + diff_of_easy = 4 + else: + diff_of_easy = None + + if sections[5] != '0': + diff_of_hard = 7 + else: + diff_of_hard = None + + if sections[6] != '0': + diff_of_master = 10 + else: + diff_of_master = None else: diff_of_easy = self.parse_song_difficulty(sections[4]) diff_of_hard = self.parse_song_difficulty(sections[5]) diff --git a/worlds/musedash/MuseDashData.txt b/worlds/musedash/MuseDashData.txt index 54a0124474c6..fe3574f31b67 100644 --- a/worlds/musedash/MuseDashData.txt +++ b/worlds/musedash/MuseDashData.txt @@ -119,7 +119,7 @@ Prestige and Vestige|56-4|Give Up TREATMENT Vol.11|True|6|8|11| Tiny Fate|56-5|Give Up TREATMENT Vol.11|False|7|9|11| Tsuki ni Murakumo Hana ni Kaze|55-0|Touhou Mugakudan -2-|False|3|5|7| Patchouli's - Best Hit GSK|55-1|Touhou Mugakudan -2-|False|3|5|8| -Monosugoi Space Shuttle de Koishi ga Monosugoi uta|55-2|Touhou Mugakudan -2-|False|3|5|7| +Monosugoi Space Shuttle de Koishi ga Monosugoi uta|55-2|Touhou Mugakudan -2-|False|3|5|7|11 Kakoinaki Yo wa Ichigo no Tsukikage|55-3|Touhou Mugakudan -2-|False|3|6|8| Psychedelic Kizakura Doumei|55-4|Touhou Mugakudan -2-|False|4|7|10| Mischievous Sensation|55-5|Touhou Mugakudan -2-|False|5|7|9| @@ -501,4 +501,12 @@ slic.hertz|68-1|Gambler's Tricks|True|5|7|9| Fuzzy-Navel|68-2|Gambler's Tricks|True|6|8|10|11 Swing Edge|68-3|Gambler's Tricks|True|4|8|10| Twisted Escape|68-4|Gambler's Tricks|True|5|8|10|11 -Swing Sweet Twee Dance|68-5|Gambler's Tricks|False|4|7|10| \ No newline at end of file +Swing Sweet Twee Dance|68-5|Gambler's Tricks|False|4|7|10| +Sanyousei SAY YA!!!|43-42|MD Plus Project|False|4|6|8| +YUKEMURI TAMAONSEN II|43-43|MD Plus Project|False|3|6|9| +Samayoi no mei Amatsu|69-0|Touhou Mugakudan -3-|False|4|6|9| +INTERNET SURVIVOR|69-1|Touhou Mugakudan -3-|False|5|8|10| +Shuki*RaiRai|69-2|Touhou Mugakudan -3-|False|5|7|9| +HELLOHELL|69-3|Touhou Mugakudan -3-|False|4|7|10| +Calamity Fortune|69-4|Touhou Mugakudan -3-|True|6|8|10|11 +Tsurupettan|69-5|Touhou Mugakudan -3-|True|2|5|8| \ No newline at end of file diff --git a/worlds/musedash/Options.py b/worlds/musedash/Options.py index 3fe28187fae6..d5ce313f8f03 100644 --- a/worlds/musedash/Options.py +++ b/worlds/musedash/Options.py @@ -36,7 +36,7 @@ class AdditionalSongs(Range): - The final song count may be lower due to other settings. """ range_start = 15 - range_end = 500 # Note will probably not reach this high if any other settings are done. + range_end = 508 # Note will probably not reach this high if any other settings are done. default = 40 display_name = "Additional Song Count" diff --git a/worlds/musedash/__init__.py b/worlds/musedash/__init__.py index a68fd2853def..af2d4cc207da 100644 --- a/worlds/musedash/__init__.py +++ b/worlds/musedash/__init__.py @@ -328,5 +328,6 @@ def fill_slot_data(self): "victoryLocation": self.victory_song_name, "deathLink": self.options.death_link.value, "musicSheetWinCount": self.get_music_sheet_win_count(), - "gradeNeeded": self.options.grade_needed.value + "gradeNeeded": self.options.grade_needed.value, + "hasFiller": True, } diff --git a/worlds/musedash/test/TestDifficultyRanges.py b/worlds/musedash/test/TestDifficultyRanges.py index 01420347af15..af3469aa080f 100644 --- a/worlds/musedash/test/TestDifficultyRanges.py +++ b/worlds/musedash/test/TestDifficultyRanges.py @@ -66,5 +66,11 @@ def test_songs_have_difficulty(self) -> None: for song_name in muse_dash_world.md_collection.DIFF_OVERRIDES: song = muse_dash_world.md_collection.song_items[song_name] - self.assertTrue(song.easy is not None and song.hard is not None and song.master is not None, + # umpopoff is a one time weird song. Its currently the only song in the game + # with non-standard difficulties and also doesn't have 3 or more difficulties. + if song_name == 'umpopoff': + self.assertTrue(song.easy is None and song.hard is not None and song.master is None, + f"Song '{song_name}' difficulty not set when it should be.") + else: + self.assertTrue(song.easy is not None and song.hard is not None and song.master is not None, f"Song '{song_name}' difficulty not set when it should be.") diff --git a/worlds/oot/__init__.py b/worlds/oot/__init__.py index e9c889d6f653..eb9c41f0b032 100644 --- a/worlds/oot/__init__.py +++ b/worlds/oot/__init__.py @@ -118,7 +118,16 @@ class OOTWeb(WebWorld): ["TheLynk"] ) - tutorials = [setup, setup_es, setup_fr] + setup_de = Tutorial( + setup.tutorial_name, + setup.description, + "Deutsch", + "setup_de.md", + "setup/de", + ["Held_der_Zeit"] + ) + + tutorials = [setup, setup_es, setup_fr, setup_de] class OOTWorld(World): diff --git a/worlds/oot/docs/MultiWorld-Room_oot.png b/worlds/oot/docs/MultiWorld-Room_oot.png new file mode 100644 index 000000000000..f0f224e5e1af Binary files /dev/null and b/worlds/oot/docs/MultiWorld-Room_oot.png differ diff --git a/worlds/oot/docs/de_Ocarina of Time.md b/worlds/oot/docs/de_Ocarina of Time.md new file mode 100644 index 000000000000..4d9fd2ea14bd --- /dev/null +++ b/worlds/oot/docs/de_Ocarina of Time.md @@ -0,0 +1,41 @@ +# The Legend of Zelda: Ocarina of Time + +## Wo ist die Seite für die Einstellungen? + +Die [Seite für die Spielereinstellungen dieses Spiels](../player-options) enthält alle Optionen die man benötigt um +eine YAML-Datei zu konfigurieren und zu exportieren. + +## Was macht der Randomizer in diesem Spiel? + +Items, welche der Spieler für gewöhnlich im Verlauf des Spiels erhalten würde, wurden umhergemischt. Die Logik bleit +bestehen, damit ist das Spiel immer durchspielbar. Doch weil die Items durch das ganze Spiel gemischt wurden, müssen + manche Bereiche früher bescuht werden, als man es in Vanilla tun würde. +Eine Liste von implementierter Logik, die unoffensichtlich erscheinen kann, kann +[hier (Englisch)](https://wiki.ootrandomizer.com/index.php?title=Logic) gefunden werden. + +## Welche Items und Bereiche werden gemischt? + +Alle ausrüstbare und sammelbare Gegenstände, sowie Munition können gemischt werden. Und alle Bereiche, die einen +dieser Items enthalten könnten, haben (sehr wahrscheinlich) ihren Inhalt verändert. Goldene Skulltulas können ebenfalls +dazugezählt werden, je nach Wunsch des Spielers. + +## Welche Items können in sich in der Welt eines anderen Spielers befinden? + +Jedes dieser Items, die gemicht werden können, können in einer Multiworld auch in der Welt eines anderen Spielers +fallen. Es ist jedoch möglich ausgewählte Items auf deine eigene Welt zu beschränken. + +## Wie sieht ein Item einer anderen Welt in OoT aus? + +Items, die zu einer anderen Welt gehören, werden repräsentiert durch Zelda's Brief. + +## Was passiert, wenn der Spieler ein Item erhält? + +Sobald der Spieler ein Item erhält, wird Link das Item über seinen Kopf halten und der ganzen Welt präsentieren. +Gut für's Geschäft! + +## Einzigartige Lokale Befehle + +Die folgenden Befehle stehen nur im OoTClient, um mit Archipelago zu spielen, zur Verfügung: + +- `/n64` Überprüffe den Verbindungsstatus deiner N64 +- `/deathlink` Schalte den "Deathlink" des Clients um. Überschreibt die zuvor konfigurierten Einstellungen. diff --git a/worlds/oot/docs/setup_de.md b/worlds/oot/docs/setup_de.md new file mode 100644 index 000000000000..92c3150a7d2f --- /dev/null +++ b/worlds/oot/docs/setup_de.md @@ -0,0 +1,108 @@ +# Setup Anleitung für Ocarina of Time: Archipelago Edition + +## WICHTIG + +Da wir BizHawk benutzen, gilt diese Anleitung nur für Windows und Linux. + +## Benötigte Software + +- BizHawk: [BizHawk Veröffentlichungen von TASVideos](https://tasvideos.org/BizHawk/ReleaseHistory) + - Version 2.3.1 und später werden unterstützt. Version 2.9 ist empfohlen. + - Detailierte Installtionsanweisungen für BizHawk können über den obrigen Link gefunden werden. + - Windows-Benutzer müssen die Prerequisiten installiert haben. Diese können ebenfalls über + den obrigen Link gefunden werden. +- Der integrierte Archipelago-Client, welcher [hier](https://github.com/ArchipelagoMW/Archipelago/releases) installiert + werden kann. +- Eine `Ocarina of Time v1.0 US(?) ROM`. (Nicht aus Europa und keine Master-Quest oder Debug-Rom!) + +## Konfigurieren von BizHawk + +Sobald Bizhawk einmal installiert wurde, öffne **EmuHawk** und ändere die folgenen Einsteluungen: + +- (≤ 2.8) Gehe zu `Config > Customize`. Wechlse zu dem `Advanced`-Reiter, wechsle dann den `Lua Core` von "NLua+KopiLua" zu + `"Lua+LuaInterface"`. Starte danach EmuHawk neu. Dies ist zwingend notwendig, damit die Lua-Scripts, mit denen man sich mit dem Client verbindet, ordnungsgemäß funktionieren. + **ANMERKUNG: Selbst wenn "Lua+LuaInterface" bereits ausgewählt ist, wechsle zwischen den beiden Optionen umher und** + **wähle es erneut aus. Neue Installationen oder Versionen von EmuHawk neigen dazu "Lua+LuaInterface" als die** + **Standard-Option anzuzeigen, aber laden dennoch "NLua+KopiLua", bis dieser Schritt getan ist.** +- Unter `Config > Customize > Advanced`, gehe sicher dass der Haken bei `AutoSaveRAM` ausgeählt ist, und klicke dann + den 5s-Knopf. Dies verringert die Wahrscheinlichkeit den Speicherfrotschritt zu verlieren, sollte der Emulator mal + abstürzen. +- **(Optional)** Unter `Config > Customize` kannst du die Haken in den "Run in background" + (Laufe weiter im Hintergrund) und "Accept background input" (akzeptiere Tastendruck im Hintergrund) Kästchen setzen. + Dies erlaubt dir das Spiel im Hintergrund weiter zu spielen, selbst wenn ein anderes Fenster aktiv ist. (Nützlich bei + mehreren oder eher großen Bildschrimen/Monitoren.) +- Unter `Config > Hotkeys` sind viele Hotkeys, die mit oft genuten Tasten belegt worden sind. Es wird empfohlen die + meisten (oder alle) Hotkeys zu deaktivieren. Dies kann schnell mit `Esc` erledigt werden. +- Wird mit einem Kontroller gespielt, bei der Tastenbelegung (bei einem Laufendem Spiel, unter + `Config > Controllers...`), deaktiviere "P1 A Up", "P1 A Down", "P1 A Left", and "P1 A Right" und gehe stattdessen in + den Reiter `Analog Controls` um den Stick zu belegen, da sonst Probleme beim Zielen auftreten (mit dem Bogen oder + ähnliches). Y-Axis ist für Oben und Unten, und die X-Axis ist für Links und Rechts. +- Unter `N64` setze einen Haken bei "Use Expansion Slot" (Benutze Erweiterungs-Slot). Dies wird benötigt damit + savestates/schnellspeichern funktioniert. (Das N64-Menü taucht nur **nach** dem laden einer N64-ROM auf.) + +Es wird sehr empfohlen N64 Rom-Erweiterungen (\*.n64, \*.z64) mit dem Emuhawk - welcher zuvor installiert wurde - zu +verknüpfen. +Um dies zu tun, muss eine beliebige N64 Rom aufgefunden werden, welche in deinem Besitz ist, diese Rechtsklicken und +dann auf "Öffnen mit..." gehen. Gehe dann auf "Andere App auswählen" und suche nach deinen BizHawk-Ordner, in der +sich der Emulator befindet, und wähle dann `EmuHawk.exe` **(NICHT "DiscoHawk.exe"!)** aus. + +Eine Alternative BizHawk Setup Anleitung (auf Englisch), sowie weitere Hilfe bei Problemen kann +[hier](https://wiki.ootrandomizer.com/index.php?title=Bizhawk) gefunden werden. + +## Erstelle eine YAML-Datei + +### Was ist eine YAML-Datei und Warum brauch ich eine? + +Eine YAML-Datie enthält einen Satz an einstellbaren Optionen, die dem Generator mitteilen, wie +dein Spiel generiert werden soll. In einer Multiworld stellt jeder Spieler eine eigene YAML-Datei zur Verfügung. Dies +erlaubt jeden Spieler eine personalisierte Erfahrung nach derem Geschmack. Damit kann auch jeder Spieler in einer +Multiworld (des gleichen Spiels) völlig unterschiedliche Einstellungen haben. + +Für weitere Informationen, besuche die allgemeine Anleitung zum Erstellen einer +YAML-Datei: [Archipelago Setup Anleitung](/tutorial/Archipelago/setup/en) + +### Woher bekomme ich eine YAML-Datei? + +Die Seite für die Spielereinstellungen auf dieser Website erlaubt es dir deine persönlichen Einstellungen nach +vorlieben zu konfigurieren und eine YAML-Datei zu exportieren. +Seite für die Spielereinstellungen: +[Seite für die Spielereinstellungen von Ocarina of Time](/games/Ocarina%20of%20Time/player-options) + +### Überprüfen deiner YAML-Datei + +Wenn du deine YAML-Datei überprüfen möchtest, um sicher zu gehen, dass sie funktioniert, kannst du dies auf der +YAML-Überprüfungsseite tun. +YAML-Überprüfungsseite: [YAML-Überprüfungsseite](/check) + +## Beitreten einer Multiworld + +### Erhalte deinen OoT-Patch + +(Der folgende Prozess ist bei den meisten ROM-basierenden Spielen sehr ähnlich.) + +Wenn du einer Multiworld beitrittst, wirst du gefordert eine YAML-Datei bei dem Host abzugeben. Ist dies getan, +erhälst du (in der Regel) einen Link vom Host der Multiworld. Dieser führt dich zu einem Raum, in dem alle +teilnehmenden Spieler (bzw. Welten) aufgelistet sind. Du solltest dich dann auf **deine** Welt konzentrieren +und klicke dann auf `Download APZ5 File...`. +![Screenshot of a Multiworld Room with an Ocarina of Time Player](/static/generated/docs/Ocarina%20of%20Time/MultiWorld-room_oot.png) + +Führe die `.apz5`-Datei mit einem Doppelklick aus, um deinen Ocarina Of Time-Client zu starten, sowie das patchen +deiner ROM. Ist dieser Prozess fertig (kann etwas dauern), startet sich der Client und der Emulator automatisch +(sofern das "Öffnen mit..." ausgewählt wurde). + +### Verbinde zum Multiserver + +Sind einmal der Client und der Emulator gestartet, müssen sie nur noch miteinander verbunden werden. Gehe dazu in +deinen Archipelago-Ordner, dann zu `data/lua`, und füge das `connector_oot.lua` Script per Drag&Drop (ziehen und +fallen lassen) auf das EmuHawk-Fenster. (Alternativ kannst du die Lua-Konsole manuell öffnen, gehe dazu auf +`Script > Open Script` und durchsuche die Ordner nach `data/lua/connector_oot.lua`.) + +Um den Client mit dem Multiserver zu verbinden, füge einfach `:` in das Textfeld ganz oben im +Client ein und drücke Enter oder "Connect" (verbinden). Wird ein Passwort benötigt, musst du es danach unten in das +Textfeld (für den Chat und Befehle) eingeben. +Alternativ kannst du auch in dem unterem Textfeld den folgenden Befehl schreiben: +`/connect : [Passwort]` (wie die Adresse und der Port lautet steht in dem Raum, oder wird von deinem +Host an dich weitergegeben.) +Beispiel: `/connect archipelago.gg:12345 Passw123` + +Du bist nun bereit für dein Zeitreise-Abenteuer in Hyrule. diff --git a/worlds/oot/docs/setup_en.md b/worlds/oot/docs/setup_en.md index 72f15fa6c768..4d27019fa771 100644 --- a/worlds/oot/docs/setup_en.md +++ b/worlds/oot/docs/setup_en.md @@ -10,8 +10,7 @@ As we are using BizHawk, this guide is only applicable to Windows and Linux syst - Version 2.3.1 and later are supported. Version 2.7 is recommended for stability. - Detailed installation instructions for BizHawk can be found at the above link. - Windows users must run the prereq installer first, which can also be found at the above link. -- The built-in Archipelago client, which can be installed [here](https://github.com/ArchipelagoMW/Archipelago/releases) - (select `Ocarina of Time Client` during installation). +- The built-in Archipelago client, which can be installed [here](https://github.com/ArchipelagoMW/Archipelago/releases). - An Ocarina of Time v1.0 ROM. ## Configuring BizHawk diff --git a/worlds/pokemon_emerald/__init__.py b/worlds/pokemon_emerald/__init__.py index b7730fbdf785..5d50e0db96dc 100644 --- a/worlds/pokemon_emerald/__init__.py +++ b/worlds/pokemon_emerald/__init__.py @@ -7,7 +7,7 @@ import os from typing import Any, Set, List, Dict, Optional, Tuple, ClassVar -from BaseClasses import ItemClassification, MultiWorld, Tutorial +from BaseClasses import ItemClassification, MultiWorld, Tutorial, LocationProgressType from Fill import FillError, fill_restrictive from Options import Toggle import settings @@ -20,7 +20,7 @@ offset_item_value) from .locations import (LOCATION_GROUPS, PokemonEmeraldLocation, create_location_label_to_id_map, create_locations_with_tags) -from .options import (ItemPoolType, RandomizeWildPokemon, RandomizeBadges, RandomizeTrainerParties, RandomizeHms, +from .options import (Goal, ItemPoolType, RandomizeWildPokemon, RandomizeBadges, RandomizeTrainerParties, RandomizeHms, RandomizeStarters, LevelUpMoves, RandomizeAbilities, RandomizeTypes, TmCompatibility, HmCompatibility, RandomizeStaticEncounters, NormanRequirement, PokemonEmeraldOptions) from .pokemon import get_random_species, get_random_move, get_random_damaging_move, get_random_type @@ -146,6 +146,60 @@ def create_regions(self) -> None: self.multiworld.regions.extend(regions.values()) + # Exclude locations which are always locked behind the player's goal + def exclude_locations(location_names: List[str]): + for location_name in location_names: + try: + self.multiworld.get_location(location_name, + self.player).progress_type = LocationProgressType.EXCLUDED + except KeyError: + continue # Location not in multiworld + + if self.options.goal == Goal.option_champion: + # Always required to beat champion before receiving this + exclude_locations([ + "Littleroot Town - S.S. Ticket from Norman" + ]) + + # S.S. Ticket requires beating champion, so ferry is not accessible until after goal + if not self.options.enable_ferry: + exclude_locations([ + "SS Tidal - Hidden Item in Lower Deck Trash Can", + "SS Tidal - TM49 from Thief" + ]) + + # Construction workers don't move until champion is defeated + if "Safari Zone Construction Workers" not in self.options.remove_roadblocks.value: + exclude_locations([ + "Safari Zone NE - Hidden Item North", + "Safari Zone NE - Hidden Item East", + "Safari Zone NE - Item on Ledge", + "Safari Zone SE - Hidden Item in South Grass 1", + "Safari Zone SE - Hidden Item in South Grass 2", + "Safari Zone SE - Item in Grass" + ]) + elif self.options.goal == Goal.option_norman: + # If the player sets their options such that Surf or the Balance + # Badge is vanilla, a very large number of locations become + # "post-Norman". Similarly, access to the E4 may require you to + # defeat Norman as an event or to get his badge, making postgame + # locations inaccessible. Detecting these situations isn't trivial + # and excluding all locations requiring Surf would be a bad idea. + # So for now we just won't touch it and blame the user for + # constructing their options in this way. Players usually expect + # to only partially complete their world when playing this goal + # anyway. + + # Locations which are directly unlocked by defeating Norman. + exclude_locations([ + "Petalburg Gym - Balance Badge", + "Petalburg Gym - TM42 from Norman", + "Petalburg City - HM03 from Wally's Uncle", + "Dewford Town - TM36 from Sludge Bomb Man", + "Mauville City - Basement Key from Wattson", + "Mauville City - TM24 from Wattson" + ]) + def create_items(self) -> None: item_locations: List[PokemonEmeraldLocation] = [ location diff --git a/worlds/pokemon_rb/__init__.py b/worlds/pokemon_rb/__init__.py index 5a94a8b5ff26..169ff1d59f1e 100644 --- a/worlds/pokemon_rb/__init__.py +++ b/worlds/pokemon_rb/__init__.py @@ -353,7 +353,9 @@ def pre_fill(self) -> None: location.show_in_spoiler = False def intervene(move, test_state): - if self.multiworld.randomize_wild_pokemon[self.player]: + move_bit = pow(2, poke_data.hm_moves.index(move) + 2) + viable_mons = [mon for mon in self.local_poke_data if self.local_poke_data[mon]["tms"][6] & move_bit] + if self.multiworld.randomize_wild_pokemon[self.player] and viable_mons: accessible_slots = [loc for loc in self.multiworld.get_reachable_locations(test_state, self.player) if loc.type == "Wild Encounter"] @@ -363,8 +365,6 @@ def number_of_zones(mon): zones.add(loc.name.split(" - ")[0]) return len(zones) - move_bit = pow(2, poke_data.hm_moves.index(move) + 2) - viable_mons = [mon for mon in self.local_poke_data if self.local_poke_data[mon]["tms"][6] & move_bit] placed_mons = [slot.item.name for slot in accessible_slots] if self.multiworld.area_1_to_1_mapping[self.player]: diff --git a/worlds/sc2wol/Client.py b/worlds/sc2wol/Client.py index 3dbd2047debd..83b7b62d2977 100644 --- a/worlds/sc2wol/Client.py +++ b/worlds/sc2wol/Client.py @@ -3,7 +3,6 @@ import asyncio import copy import ctypes -import json import logging import multiprocessing import os.path @@ -15,6 +14,7 @@ import zipfile import io import random +import concurrent.futures from pathlib import Path # CommonClient import first to trigger ModuleUpdater @@ -42,6 +42,7 @@ from NetUtils import ClientStatus, NetworkItem, RawJSONtoTextParser, JSONtoTextParser, JSONMessagePart from MultiServer import mark_raw +pool = concurrent.futures.ThreadPoolExecutor(1) loop = asyncio.get_event_loop_policy().new_event_loop() nest_asyncio.apply(loop) max_bonus: int = 13 @@ -210,6 +211,11 @@ def _cmd_set_path(self, path: str = '') -> bool: def _cmd_download_data(self) -> bool: """Download the most recent release of the necessary files for playing SC2 with Archipelago. Will overwrite existing files.""" + pool.submit(self._download_data) + return True + + @staticmethod + def _download_data() -> bool: if "SC2PATH" not in os.environ: check_game_install_path() @@ -220,7 +226,7 @@ def _cmd_download_data(self) -> bool: metadata = None tempzip, metadata = download_latest_release_zip(DATA_REPO_OWNER, DATA_REPO_NAME, DATA_API_VERSION, - metadata=metadata, force_download=True) + metadata=metadata, force_download=True) if tempzip != '': try: diff --git a/worlds/shivers/Rules.py b/worlds/shivers/Rules.py index 4e1058fecfc8..57488ff33314 100644 --- a/worlds/shivers/Rules.py +++ b/worlds/shivers/Rules.py @@ -151,14 +151,14 @@ def get_rules_lookup(player: int): "Puzzle Solved Maze Door": lambda state: state.can_reach("Projector Room", "Region", player), "Puzzle Solved Theater Door": lambda state: state.can_reach("Underground Lake", "Region", player), "Puzzle Solved Columns of RA": lambda state: state.can_reach("Underground Lake", "Region", player), - "Final Riddle: Guillotine Dropped": lambda state: state.can_reach("Underground Lake", "Region", player) + "Final Riddle: Guillotine Dropped": lambda state: (beths_body_available(state, player) and state.can_reach("Underground Lake", "Region", player)) }, "elevators": { - "Puzzle Solved Underground Elevator": lambda state: ((state.can_reach("Underground Lake", "Region", player) or state.can_reach("Office", "Region", player) - and state.has("Key for Office Elevator", player))), + "Puzzle Solved Office Elevator": lambda state: ((state.can_reach("Underground Lake", "Region", player) or state.can_reach("Office", "Region", player)) + and state.has("Key for Office Elevator", player)), "Puzzle Solved Bedroom Elevator": lambda state: (state.can_reach("Office", "Region", player) and state.has_all({"Key for Bedroom Elevator","Crawling"}, player)), - "Puzzle Solved Three Floor Elevator": lambda state: (((state.can_reach("Maintenance Tunnels", "Region", player) or state.can_reach("Blue Maze", "Region", player)) - and state.has("Key for Three Floor Elevator", player))) + "Puzzle Solved Three Floor Elevator": lambda state: ((state.can_reach("Maintenance Tunnels", "Region", player) or state.can_reach("Blue Maze", "Region", player)) + and state.has("Key for Three Floor Elevator", player)) }, "lightning": { "Ixupi Captured Lightning": lambda state: lightning_capturable(state, player) diff --git a/worlds/shivers/data/excluded_locations.json b/worlds/shivers/data/excluded_locations.json index 6ed625077af8..a37285eb1d29 100644 --- a/worlds/shivers/data/excluded_locations.json +++ b/worlds/shivers/data/excluded_locations.json @@ -42,7 +42,7 @@ "Information Plaque: Aliens (UFO)" ], "elevators": [ - "Puzzle Solved Underground Elevator", + "Puzzle Solved Office Elevator", "Puzzle Solved Bedroom Elevator", "Puzzle Solved Three Floor Elevator" ], diff --git a/worlds/shivers/data/locations.json b/worlds/shivers/data/locations.json index 7d031b886bff..fdf8ed69d1e5 100644 --- a/worlds/shivers/data/locations.json +++ b/worlds/shivers/data/locations.json @@ -110,7 +110,7 @@ "Information Plaque: Astronomical Construction (UFO)", "Information Plaque: Guillotine (Torture)", "Information Plaque: Aliens (UFO)", - "Puzzle Solved Underground Elevator", + "Puzzle Solved Office Elevator", "Puzzle Solved Bedroom Elevator", "Puzzle Solved Three Floor Elevator", "Ixupi Captured Lightning" @@ -129,7 +129,7 @@ "Ixupi Captured Sand", "Ixupi Captured Metal", "Ixupi Captured Lightning", - "Puzzle Solved Underground Elevator", + "Puzzle Solved Office Elevator", "Puzzle Solved Three Floor Elevator", "Puzzle Hint Found: Combo Lock in Mailbox", "Puzzle Hint Found: Orange Symbol", diff --git a/worlds/sm/docs/multiworld_en.md b/worlds/sm/docs/multiworld_en.md index 129150774341..0e82be769571 100644 --- a/worlds/sm/docs/multiworld_en.md +++ b/worlds/sm/docs/multiworld_en.md @@ -2,7 +2,7 @@ ## Required Software -- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). Make sure to check the box for `SNI Client - Super Metroid Patch Setup` +- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). - Hardware or software capable of loading and playing SNES ROM files @@ -18,9 +18,10 @@ ### Windows Setup -1. During the installation of Archipelago, you will have been asked to install the SNI Client. If you did not do this, - or you are on an older version, you may run the installer again to install the SNI Client. -2. During setup, you will be asked to locate your base ROM file. This is your Super Metroid ROM file. +1. Download and install [Archipelago](). **The installer + file is located in the assets section at the bottom of the version information.** +2. The first time you do local generation or patch your game, you will be asked to locate your base ROM file. + This is your Super Metroid ROM file. This only needs to be done once. 3. If you are using an emulator, you should assign your Lua capable emulator as your default program for launching ROM files. 1. Extract your emulator's folder to your Desktop, or somewhere you will remember. diff --git a/worlds/smw/docs/setup_en.md b/worlds/smw/docs/setup_en.md index 3967f544a056..c8f408d6e256 100644 --- a/worlds/smw/docs/setup_en.md +++ b/worlds/smw/docs/setup_en.md @@ -2,8 +2,7 @@ ## Required Software -- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). Make sure to check the box for `SNI Client - Super Mario World Patch Setup` - +- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). - Hardware or software capable of loading and playing SNES ROM files - An emulator capable of connecting to SNI such as: @@ -23,9 +22,10 @@ ### Windows Setup -1. During the installation of Archipelago, you will have been asked to install the SNI Client. If you did not do this, - or you are on an older version, you may run the installer again to install the SNI Client. -2. During setup, you will be asked to locate your base ROM file. This is your Super Mario World ROM file. +1. Download and install [Archipelago](). **The installer + file is located in the assets section at the bottom of the version information.** +2. The first time you do local generation or patch your game, you will be asked to locate your base ROM file. + This is your Super Mario World ROM file. This only needs to be done once. 3. If you are using an emulator, you should assign your Lua capable emulator as your default program for launching ROM files. 1. Extract your emulator's folder to your Desktop, or somewhere you will remember. diff --git a/worlds/smz3/Client.py b/worlds/smz3/Client.py index 859cf234eb95..b07aa850c31d 100644 --- a/worlds/smz3/Client.py +++ b/worlds/smz3/Client.py @@ -40,6 +40,7 @@ async def validate_rom(self, ctx): if rom_name is None or rom_name == bytes([0] * ROMNAME_SIZE) or rom_name[:3] != b"ZSM": return False + ctx.smz3_new_message_queue = rom_name[7] in b"1234567890" ctx.game = self.game ctx.items_handling = 0b101 # local items and remote start inventory @@ -53,6 +54,22 @@ async def game_watcher(self, ctx): if ctx.server is None or ctx.slot is None: # not successfully connected to a multiworld server, cannot process the game sending items return + + send_progress_addr_ptr_offset = 0x680 + send_progress_size = 8 + send_progress_message_byte_offset = 4 + send_progress_addr_table_offset = 0x700 + recv_progress_addr_ptr_offset = 0x600 + recv_progress_size = 4 + recv_progress_addr_table_offset = 0x602 + if ctx.smz3_new_message_queue: + send_progress_addr_ptr_offset = 0xD3C + send_progress_size = 2 + send_progress_message_byte_offset = 0 + send_progress_addr_table_offset = 0xDA0 + recv_progress_addr_ptr_offset = 0xD36 + recv_progress_size = 2 + recv_progress_addr_table_offset = 0xD38 currentGame = await snes_read(ctx, SRAM_START + 0x33FE, 2) if (currentGame is not None): @@ -69,7 +86,7 @@ async def game_watcher(self, ctx): ctx.finished_game = True return - data = await snes_read(ctx, SMZ3_RECV_PROGRESS_ADDR + 0xD3C, 4) + data = await snes_read(ctx, SMZ3_RECV_PROGRESS_ADDR + send_progress_addr_ptr_offset, 4) if data is None: return @@ -77,14 +94,14 @@ async def game_watcher(self, ctx): recv_item = data[2] | (data[3] << 8) while (recv_index < recv_item): - item_address = recv_index * 2 - message = await snes_read(ctx, SMZ3_RECV_PROGRESS_ADDR + 0xDA0 + item_address, 2) - is_z3_item = ((message[1] & 0x80) != 0) - masked_part = (message[1] & 0x7F) if is_z3_item else message[1] - item_index = ((message[0] | (masked_part << 8)) >> 3) + (256 if is_z3_item else 0) + item_address = recv_index * send_progress_size + message = await snes_read(ctx, SMZ3_RECV_PROGRESS_ADDR + send_progress_addr_table_offset + item_address, send_progress_size) + is_z3_item = ((message[send_progress_message_byte_offset+1] & 0x80) != 0) + masked_part = (message[send_progress_message_byte_offset+1] & 0x7F) if is_z3_item else message[send_progress_message_byte_offset+1] + item_index = ((message[send_progress_message_byte_offset] | (masked_part << 8)) >> 3) + (256 if is_z3_item else 0) recv_index += 1 - snes_buffered_write(ctx, SMZ3_RECV_PROGRESS_ADDR + 0xD3C, bytes([recv_index & 0xFF, (recv_index >> 8) & 0xFF])) + snes_buffered_write(ctx, SMZ3_RECV_PROGRESS_ADDR + send_progress_addr_ptr_offset, bytes([recv_index & 0xFF, (recv_index >> 8) & 0xFF])) from .TotalSMZ3.Location import locations_start_id from . import convertLocSMZ3IDToAPID @@ -95,7 +112,7 @@ async def game_watcher(self, ctx): snes_logger.info(f'New Check: {location} ({len(ctx.locations_checked)}/{len(ctx.missing_locations) + len(ctx.checked_locations)})') await ctx.send_msgs([{"cmd": 'LocationChecks', "locations": [location_id]}]) - data = await snes_read(ctx, SMZ3_RECV_PROGRESS_ADDR + 0xD36, 4) + data = await snes_read(ctx, SMZ3_RECV_PROGRESS_ADDR + recv_progress_addr_ptr_offset, 4) if data is None: return @@ -107,9 +124,12 @@ async def game_watcher(self, ctx): item_id = item.item - items_start_id player_id = item.player if item.player < SMZ3_ROM_PLAYER_LIMIT else 0 - snes_buffered_write(ctx, SMZ3_RECV_PROGRESS_ADDR + item_out_ptr * 2, bytes([player_id, item_id])) + snes_buffered_write(ctx, + SMZ3_RECV_PROGRESS_ADDR + item_out_ptr * recv_progress_size, + bytes([player_id, item_id]) if ctx.smz3_new_message_queue else + bytes([player_id & 0xFF, (player_id >> 8) & 0xFF, item_id & 0xFF, (item_id >> 8) & 0xFF])) item_out_ptr += 1 - snes_buffered_write(ctx, SMZ3_RECV_PROGRESS_ADDR + 0xD38, bytes([item_out_ptr & 0xFF, (item_out_ptr >> 8) & 0xFF])) + snes_buffered_write(ctx, SMZ3_RECV_PROGRESS_ADDR + recv_progress_addr_table_offset, bytes([item_out_ptr & 0xFF, (item_out_ptr >> 8) & 0xFF])) logging.info('Received %s from %s (%s) (%d/%d in list)' % ( color(ctx.item_names[item.item], 'red', 'bold'), color(ctx.player_names[item.player], 'yellow'), ctx.location_names[item.location], item_out_ptr, len(ctx.items_received))) diff --git a/worlds/smz3/TotalSMZ3/Patch.py b/worlds/smz3/TotalSMZ3/Patch.py index c137442d9bd0..27fd8dcc3535 100644 --- a/worlds/smz3/TotalSMZ3/Patch.py +++ b/worlds/smz3/TotalSMZ3/Patch.py @@ -616,7 +616,8 @@ def WriteGameTitle(self): "H" if self.myWorld.Config.SMLogic == Config.SMLogic.Hard else \ "X" - self.title = f"ZSM{Patch.Major}{Patch.Minor}{Patch.Patch}{z3Glitch}{smGlitch}{self.myWorld.Id}{self.seed:08x}".ljust(21)[:21] + from Utils import __version__ + self.title = f"ZSM{Patch.Major}{Patch.Minor}{Patch.Patch}{__version__.replace('.', '')[0:3]}{z3Glitch}{smGlitch}{self.myWorld.Id}{self.seed:08x}".ljust(21)[:21] self.patches.append((Snes(0x00FFC0), bytearray(self.title, 'utf8'))) self.patches.append((Snes(0x80FFC0), bytearray(self.title, 'utf8'))) diff --git a/worlds/smz3/docs/multiworld_en.md b/worlds/smz3/docs/multiworld_en.md index 53842a3c6fa4..fadd55028fe1 100644 --- a/worlds/smz3/docs/multiworld_en.md +++ b/worlds/smz3/docs/multiworld_en.md @@ -4,8 +4,7 @@ - One of the client programs: - [SNIClient](https://github.com/ArchipelagoMW/Archipelago/releases), included with the main - Archipelago install. Make sure to check the box for `SNI Client - Super Metroid Patch Setup` and - `SNI Client - A Link to the Past Patch Setup` + Archipelago install. - Hardware or software capable of loading and playing SNES ROM files - An emulator capable of connecting to SNI such as: - snes9x-rr from: [snes9x rr](https://github.com/gocha/snes9x-rr/releases), @@ -20,9 +19,10 @@ ### Windows Setup -1. During the installation of Archipelago, you will have been asked to install the SNI Client. If you did not do this, - or you are on an older version, you may run the installer again to install the SNI Client. -2. During setup, you will be asked to locate your base ROM files. This is your Super Metroid and Zelda3 ROM files. +1. Download and install [Archipelago](). **The installer + file is located in the assets section at the bottom of the version information.** +2. The first time you do local generation or patch your game, you will be asked to locate your base ROM file. + This is your Super Metroid and Zelda3 ROM files. This only needs to be done once. 3. If you are using an emulator, you should assign your Lua capable emulator as your default program for launching ROM files. 1. Extract your emulator's folder to your Desktop, or somewhere you will remember. diff --git a/worlds/soe/Logic.py b/worlds/soe/Logic.py deleted file mode 100644 index fe5339c955b9..000000000000 --- a/worlds/soe/Logic.py +++ /dev/null @@ -1,70 +0,0 @@ -from typing import Protocol, Set - -from BaseClasses import MultiWorld -from worlds.AutoWorld import LogicMixin -from . import pyevermizer -from .Options import EnergyCore, OutOfBounds, SequenceBreaks - -# TODO: Options may preset certain progress steps (i.e. P_ROCK_SKIP), set in generate_early? - -# TODO: resolve/flatten/expand rules to get rid of recursion below where possible -# Logic.rules are all rules including locations, excluding those with no progress (i.e. locations that only drop items) -rules = [rule for rule in pyevermizer.get_logic() if len(rule.provides) > 0] -# Logic.items are all items and extra items excluding non-progression items and duplicates -item_names: Set[str] = set() -items = [item for item in filter(lambda item: item.progression, pyevermizer.get_items() + pyevermizer.get_extra_items()) - if item.name not in item_names and not item_names.add(item.name)] - - -class LogicProtocol(Protocol): - def has(self, name: str, player: int) -> bool: ... - def count(self, name: str, player: int) -> int: ... - def soe_has(self, progress: int, world: MultiWorld, player: int, count: int) -> bool: ... - def _soe_count(self, progress: int, world: MultiWorld, player: int, max_count: int) -> int: ... - - -# when this module is loaded, this mixin will extend BaseClasses.CollectionState -class SecretOfEvermoreLogic(LogicMixin): - def _soe_count(self: LogicProtocol, progress: int, world: MultiWorld, player: int, max_count: int = 0) -> int: - """ - Returns reached count of one of evermizer's progress steps based on collected items. - i.e. returns 0-3 for P_DE based on items providing CHECK_BOSS,DIAMOND_EYE_DROP - """ - n = 0 - for item in items: - for pvd in item.provides: - if pvd[1] == progress: - if self.has(item.name, player): - n += self.count(item.name, player) * pvd[0] - if n >= max_count > 0: - return n - for rule in rules: - for pvd in rule.provides: - if pvd[1] == progress and pvd[0] > 0: - has = True - for req in rule.requires: - if not self.soe_has(req[1], world, player, req[0]): - has = False - break - if has: - n += pvd[0] - if n >= max_count > 0: - return n - return n - - def soe_has(self: LogicProtocol, progress: int, world: MultiWorld, player: int, count: int = 1) -> bool: - """ - Returns True if count of one of evermizer's progress steps is reached based on collected items. i.e. 2 * P_DE - """ - if progress == pyevermizer.P_ENERGY_CORE: # logic is shared between worlds, so we override in the call - w = world.worlds[player] - if w.energy_core == EnergyCore.option_fragments: - progress = pyevermizer.P_CORE_FRAGMENT - count = w.required_fragments - elif progress == pyevermizer.P_ALLOW_OOB: - if world.worlds[player].out_of_bounds == OutOfBounds.option_logic: - return True - elif progress == pyevermizer.P_ALLOW_SEQUENCE_BREAKS: - if world.worlds[player].sequence_breaks == SequenceBreaks.option_logic: - return True - return self._soe_count(progress, world, player, count) >= count diff --git a/worlds/soe/__init__.py b/worlds/soe/__init__.py index d02a8d02ee97..74387fb1be80 100644 --- a/worlds/soe/__init__.py +++ b/worlds/soe/__init__.py @@ -4,18 +4,23 @@ import threading import typing +# from . import pyevermizer # as part of the source tree +import pyevermizer # from package + import settings +from BaseClasses import Item, ItemClassification, Location, LocationProgressType, Region, Tutorial +from Utils import output_path from worlds.AutoWorld import WebWorld, World from worlds.generic.Rules import add_item_rule, set_rule -from BaseClasses import Entrance, Item, ItemClassification, Location, LocationProgressType, Region, Tutorial -from Utils import output_path +from .logic import SoEPlayerLogic +from .options import Difficulty, EnergyCore, SoEOptions +from .patch import SoEDeltaPatch, get_base_rom_path -import pyevermizer # from package -# from . import pyevermizer # as part of the source tree +if typing.TYPE_CHECKING: + from BaseClasses import MultiWorld, CollectionState + +__all__ = ["pyevermizer", "SoEWorld"] -from . import Logic # load logic mixin -from .Options import soe_options, Difficulty, EnergyCore, RequiredFragments, AvailableFragments -from .Patch import SoEDeltaPatch, get_base_rom_path """ In evermizer: @@ -24,17 +29,17 @@ For most items this is their vanilla location (i.e. CHECK_GOURD, number). Items have `provides`, which give the actual progression -instead of providing multiple events per item, we iterate through them in Logic.py +instead of providing multiple events per item, we iterate through them in logic.py e.g. Found any weapon Locations have `requires` and `provides`. Requirements have to be converted to (access) rules for AP e.g. Chest locked behind having a weapon -Provides could be events, but instead we iterate through the entire logic in Logic.py +Provides could be events, but instead we iterate through the entire logic in logic.py e.g. NPC available after fighting a Boss Rules are special locations that don't have a physical location -instead of implementing virtual locations and virtual items, we simply use them in Logic.py +instead of implementing virtual locations and virtual items, we simply use them in logic.py e.g. 2DEs+Wheel+Gauge = Rocket Rules and Locations live on the same logic tree returned by pyevermizer.get_logic() @@ -84,8 +89,8 @@ ) -def _match_item_name(item, substr: str) -> bool: - sub = item.name.split(' ', 1)[1] if item.name[0].isdigit() else item.name +def _match_item_name(item: pyevermizer.Item, substr: str) -> bool: + sub: str = item.name.split(' ', 1)[1] if item.name[0].isdigit() else item.name return sub == substr or sub == substr+'s' @@ -156,10 +161,11 @@ class RomFile(settings.SNESRomPath): class SoEWorld(World): """ Secret of Evermore is a SNES action RPG. You learn alchemy spells, fight bosses and gather rocket parts to visit a - space station where the final boss must be defeated. + space station where the final boss must be defeated. """ - game: str = "Secret of Evermore" - option_definitions = soe_options + game: typing.ClassVar[str] = "Secret of Evermore" + options_dataclass = SoEOptions + options: SoEOptions settings: typing.ClassVar[SoESettings] topology_present = False data_version = 4 @@ -170,31 +176,21 @@ class SoEWorld(World): location_name_to_id, location_id_to_raw = _get_location_mapping() item_name_groups = _get_item_grouping() - trap_types = [name[12:] for name in option_definitions if name.startswith('trap_chance_')] - + logic: SoEPlayerLogic evermizer_seed: int connect_name: str - energy_core: int - sequence_breaks: int - out_of_bounds: int - available_fragments: int - required_fragments: int _halls_ne_chest_names: typing.List[str] = [loc.name for loc in _locations if 'Halls NE' in loc.name] - def __init__(self, *args, **kwargs): + def __init__(self, multiworld: "MultiWorld", player: int): self.connect_name_available_event = threading.Event() - super(SoEWorld, self).__init__(*args, **kwargs) + super(SoEWorld, self).__init__(multiworld, player) def generate_early(self) -> None: - # store option values that change logic - self.energy_core = self.multiworld.energy_core[self.player].value - self.sequence_breaks = self.multiworld.sequence_breaks[self.player].value - self.out_of_bounds = self.multiworld.out_of_bounds[self.player].value - self.required_fragments = self.multiworld.required_fragments[self.player].value - if self.required_fragments > self.multiworld.available_fragments[self.player].value: - self.multiworld.available_fragments[self.player].value = self.required_fragments - self.available_fragments = self.multiworld.available_fragments[self.player].value + # create logic from options + if self.options.required_fragments.value > self.options.available_fragments.value: + self.options.available_fragments.value = self.options.required_fragments.value + self.logic = SoEPlayerLogic(self.player, self.options) def create_event(self, event: str) -> Item: return SoEItem(event, ItemClassification.progression, None, self.player) @@ -214,20 +210,20 @@ def create_item(self, item: typing.Union[pyevermizer.Item, str]) -> Item: return SoEItem(item.name, classification, self.item_name_to_id[item.name], self.player) @classmethod - def stage_assert_generate(cls, multiworld): + def stage_assert_generate(cls, _: "MultiWorld") -> None: rom_file = get_base_rom_path() if not os.path.exists(rom_file): raise FileNotFoundError(rom_file) - def create_regions(self): + def create_regions(self) -> None: # exclude 'hidden' on easy - max_difficulty = 1 if self.multiworld.difficulty[self.player] == Difficulty.option_easy else 256 + max_difficulty = 1 if self.options.difficulty == Difficulty.option_easy else 256 # TODO: generate *some* regions from locations' requirements? menu = Region('Menu', self.player, self.multiworld) self.multiworld.regions += [menu] - def get_sphere_index(evermizer_loc): + def get_sphere_index(evermizer_loc: pyevermizer.Location) -> int: """Returns 0, 1 or 2 for locations in spheres 1, 2, 3+""" if len(evermizer_loc.requires) == 1 and evermizer_loc.requires[0][1] != pyevermizer.P_WEAPON: return 2 @@ -252,18 +248,18 @@ def get_sphere_index(evermizer_loc): # mark some as excluded based on numbers above for trash_sphere, fills in trash_fills.items(): for typ, counts in fills.items(): - count = counts[self.multiworld.difficulty[self.player].value] - for location in self.multiworld.random.sample(spheres[trash_sphere][typ], count): + count = counts[self.options.difficulty.value] + for location in self.random.sample(spheres[trash_sphere][typ], count): assert location.name != "Energy Core #285", "Error in sphere generation" location.progress_type = LocationProgressType.EXCLUDED - def sphere1_blocked_items_rule(item): + def sphere1_blocked_items_rule(item: pyevermizer.Item) -> bool: if isinstance(item, SoEItem): # disable certain items in sphere 1 if item.name in {"Gauge", "Wheel"}: return False # and some more for non-easy, non-mystery - if self.multiworld.difficulty[item.player] not in (Difficulty.option_easy, Difficulty.option_mystery): + if self.options.difficulty not in (Difficulty.option_easy, Difficulty.option_mystery): if item.name in {"Laser Lance", "Atom Smasher", "Diamond Eye"}: return False return True @@ -273,13 +269,13 @@ def sphere1_blocked_items_rule(item): add_item_rule(location, sphere1_blocked_items_rule) # make some logically late(r) bosses priority locations to increase complexity - if self.multiworld.difficulty[self.player] == Difficulty.option_mystery: - late_count = self.multiworld.random.randint(0, 2) + if self.options.difficulty == Difficulty.option_mystery: + late_count = self.random.randint(0, 2) else: - late_count = self.multiworld.difficulty[self.player].value + late_count = self.options.difficulty.value late_bosses = ("Tiny", "Aquagoth", "Megataur", "Rimsala", "Mungola", "Lightning Storm", "Magmar", "Volcano Viper") - late_locations = self.multiworld.random.sample(late_bosses, late_count) + late_locations = self.random.sample(late_bosses, late_count) # add locations to the world for sphere in spheres.values(): @@ -293,17 +289,17 @@ def sphere1_blocked_items_rule(item): menu.connect(ingame, "New Game") self.multiworld.regions += [ingame] - def create_items(self): + def create_items(self) -> None: # add regular items to the pool exclusions: typing.List[str] = [] - if self.energy_core != EnergyCore.option_shuffle: + if self.options.energy_core != EnergyCore.option_shuffle: exclusions.append("Energy Core") # will be placed in generate_basic or replaced by a fragment below items = list(map(lambda item: self.create_item(item), (item for item in _items if item.name not in exclusions))) # remove one pair of wings that will be placed in generate_basic items.remove(self.create_item("Wings")) - def is_ingredient(item): + def is_ingredient(item: pyevermizer.Item) -> bool: for ingredient in _ingredients: if _match_item_name(item, ingredient): return True @@ -311,84 +307,72 @@ def is_ingredient(item): # add energy core fragments to the pool ingredients = [n for n, item in enumerate(items) if is_ingredient(item)] - if self.energy_core == EnergyCore.option_fragments: + if self.options.energy_core == EnergyCore.option_fragments: items.append(self.create_item("Energy Core Fragment")) # replaces the vanilla energy core - for _ in range(self.available_fragments - 1): + for _ in range(self.options.available_fragments - 1): if len(ingredients) < 1: break # out of ingredients to replace - r = self.multiworld.random.choice(ingredients) + r = self.random.choice(ingredients) ingredients.remove(r) items[r] = self.create_item("Energy Core Fragment") # add traps to the pool - trap_count = self.multiworld.trap_count[self.player].value - trap_chances = {} - trap_names = {} + trap_count = self.options.trap_count.value + trap_names: typing.List[str] = [] + trap_weights: typing.List[int] = [] if trap_count > 0: - for trap_type in self.trap_types: - trap_option = getattr(self.multiworld, f'trap_chance_{trap_type}')[self.player] - trap_chances[trap_type] = trap_option.value - trap_names[trap_type] = trap_option.item_name - trap_chances_total = sum(trap_chances.values()) - if trap_chances_total == 0: - for trap_type in trap_chances: - trap_chances[trap_type] = 1 - trap_chances_total = len(trap_chances) + for trap_option in self.options.trap_chances: + trap_names.append(trap_option.item_name) + trap_weights.append(trap_option.value) + if sum(trap_weights) == 0: + trap_weights = [1 for _ in trap_weights] def create_trap() -> Item: - v = self.multiworld.random.randrange(trap_chances_total) - for t, c in trap_chances.items(): - if v < c: - return self.create_item(trap_names[t]) - v -= c - assert False, "Bug in create_trap" + return self.create_item(self.random.choices(trap_names, trap_weights)[0]) for _ in range(trap_count): if len(ingredients) < 1: break # out of ingredients to replace - r = self.multiworld.random.choice(ingredients) + r = self.random.choice(ingredients) ingredients.remove(r) items[r] = create_trap() self.multiworld.itempool += items - def set_rules(self): + def set_rules(self) -> None: self.multiworld.completion_condition[self.player] = lambda state: state.has('Victory', self.player) # set Done from goal option once we have multiple goals set_rule(self.multiworld.get_location('Done', self.player), - lambda state: state.soe_has(pyevermizer.P_FINAL_BOSS, self.multiworld, self.player)) + lambda state: self.logic.has(state, pyevermizer.P_FINAL_BOSS)) set_rule(self.multiworld.get_entrance('New Game', self.player), lambda state: True) for loc in _locations: location = self.multiworld.get_location(loc.name, self.player) set_rule(location, self.make_rule(loc.requires)) def make_rule(self, requires: typing.List[typing.Tuple[int, int]]) -> typing.Callable[[typing.Any], bool]: - def rule(state) -> bool: + def rule(state: "CollectionState") -> bool: for count, progress in requires: - if not state.soe_has(progress, self.multiworld, self.player, count): + if not self.logic.has(state, progress, count): return False return True return rule - def make_item_type_limit_rule(self, item_type: int): - return lambda item: item.player != self.player or self.item_id_to_raw[item.code].type == item_type - - def generate_basic(self): + def generate_basic(self) -> None: # place Victory event self.multiworld.get_location('Done', self.player).place_locked_item(self.create_event('Victory')) # place wings in halls NE to avoid softlock - wings_location = self.multiworld.random.choice(self._halls_ne_chest_names) + wings_location = self.random.choice(self._halls_ne_chest_names) wings_item = self.create_item('Wings') self.multiworld.get_location(wings_location, self.player).place_locked_item(wings_item) # place energy core at vanilla location for vanilla mode - if self.energy_core == EnergyCore.option_vanilla: + if self.options.energy_core == EnergyCore.option_vanilla: energy_core = self.create_item('Energy Core') self.multiworld.get_location('Energy Core #285', self.player).place_locked_item(energy_core) # generate stuff for later - self.evermizer_seed = self.multiworld.random.randint(0, 2 ** 16 - 1) # TODO: make this an option for "full" plando? + self.evermizer_seed = self.random.randint(0, 2 ** 16 - 1) # TODO: make this an option for "full" plando? - def generate_output(self, output_directory: str): + def generate_output(self, output_directory: str) -> None: player_name = self.multiworld.get_player_name(self.player) self.connect_name = player_name[:32] while len(self.connect_name.encode('utf-8')) > 32: @@ -397,24 +381,21 @@ def generate_output(self, output_directory: str): placement_file = "" out_file = "" try: - money = self.multiworld.money_modifier[self.player].value - exp = self.multiworld.exp_modifier[self.player].value + money = self.options.money_modifier.value + exp = self.options.exp_modifier.value switches: typing.List[str] = [] - if self.multiworld.death_link[self.player].value: + if self.options.death_link.value: switches.append("--death-link") - if self.energy_core == EnergyCore.option_fragments: - switches.extend(('--available-fragments', str(self.available_fragments), - '--required-fragments', str(self.required_fragments))) + if self.options.energy_core == EnergyCore.option_fragments: + switches.extend(('--available-fragments', str(self.options.available_fragments.value), + '--required-fragments', str(self.options.required_fragments.value))) rom_file = get_base_rom_path() out_base = output_path(output_directory, self.multiworld.get_out_file_name_base(self.player)) out_file = out_base + '.sfc' placement_file = out_base + '.txt' patch_file = out_base + '.apsoe' flags = 'l' # spoiler log - for option_name in self.option_definitions: - option = getattr(self.multiworld, option_name)[self.player] - if hasattr(option, 'to_flag'): - flags += option.to_flag() + flags += self.options.flags with open(placement_file, "wb") as f: # generate placement file for location in self.multiworld.get_locations(self.player): @@ -448,7 +429,7 @@ def generate_output(self, output_directory: str): except FileNotFoundError: pass - def modify_multidata(self, multidata: dict): + def modify_multidata(self, multidata: typing.Dict[str, typing.Any]) -> None: # wait for self.connect_name to be available. self.connect_name_available_event.wait() # we skip in case of error, so that the original error in the output thread is the one that gets raised @@ -457,7 +438,7 @@ def modify_multidata(self, multidata: dict): multidata["connect_names"][self.connect_name] = payload def get_filler_item_name(self) -> str: - return self.multiworld.random.choice(list(self.item_name_groups["Ingredients"])) + return self.random.choice(list(self.item_name_groups["Ingredients"])) class SoEItem(Item): diff --git a/worlds/soe/logic.py b/worlds/soe/logic.py new file mode 100644 index 000000000000..ee81c76e58de --- /dev/null +++ b/worlds/soe/logic.py @@ -0,0 +1,85 @@ +import typing +from typing import Callable, Set + +from . import pyevermizer +from .options import EnergyCore, OutOfBounds, SequenceBreaks, SoEOptions + +if typing.TYPE_CHECKING: + from BaseClasses import CollectionState + +# TODO: Options may preset certain progress steps (i.e. P_ROCK_SKIP), set in generate_early? + +# TODO: resolve/flatten/expand rules to get rid of recursion below where possible +# Logic.rules are all rules including locations, excluding those with no progress (i.e. locations that only drop items) +rules = [rule for rule in pyevermizer.get_logic() if len(rule.provides) > 0] +# Logic.items are all items and extra items excluding non-progression items and duplicates +item_names: Set[str] = set() +items = [item for item in filter(lambda item: item.progression, pyevermizer.get_items() + pyevermizer.get_extra_items()) + if item.name not in item_names and not item_names.add(item.name)] # type: ignore[func-returns-value] + + +class SoEPlayerLogic: + __slots__ = "player", "out_of_bounds", "sequence_breaks", "has" + player: int + out_of_bounds: bool + sequence_breaks: bool + + has: Callable[..., bool] + """ + Returns True if count of one of evermizer's progress steps is reached based on collected items. i.e. 2 * P_DE + """ + + def __init__(self, player: int, options: "SoEOptions"): + self.player = player + self.out_of_bounds = options.out_of_bounds == OutOfBounds.option_logic + self.sequence_breaks = options.sequence_breaks == SequenceBreaks.option_logic + + if options.energy_core == EnergyCore.option_fragments: + # override logic for energy core fragments + required_fragments = options.required_fragments.value + + def fragmented_has(state: "CollectionState", progress: int, count: int = 1) -> bool: + if progress == pyevermizer.P_ENERGY_CORE: + progress = pyevermizer.P_CORE_FRAGMENT + count = required_fragments + return self._has(state, progress, count) + + self.has = fragmented_has + else: + # default (energy core) logic + self.has = self._has + + def _count(self, state: "CollectionState", progress: int, max_count: int = 0) -> int: + """ + Returns reached count of one of evermizer's progress steps based on collected items. + i.e. returns 0-3 for P_DE based on items providing CHECK_BOSS,DIAMOND_EYE_DROP + """ + n = 0 + for item in items: + for pvd in item.provides: + if pvd[1] == progress: + if state.has(item.name, self.player): + n += state.count(item.name, self.player) * pvd[0] + if n >= max_count > 0: + return n + for rule in rules: + for pvd in rule.provides: + if pvd[1] == progress and pvd[0] > 0: + has = True + for req in rule.requires: + if not self.has(state, req[1], req[0]): + has = False + break + if has: + n += pvd[0] + if n >= max_count > 0: + return n + return n + + def _has(self, state: "CollectionState", progress: int, count: int = 1) -> bool: + """Default implementation of has""" + if self.out_of_bounds is True and progress == pyevermizer.P_ALLOW_OOB: + return True + if self.sequence_breaks is True and progress == pyevermizer.P_ALLOW_SEQUENCE_BREAKS: + return True + return self._count(state, progress, count) >= count diff --git a/worlds/soe/Options.py b/worlds/soe/options.py similarity index 70% rename from worlds/soe/Options.py rename to worlds/soe/options.py index 3de2de34ac67..cb9e9bb6de23 100644 --- a/worlds/soe/Options.py +++ b/worlds/soe/options.py @@ -1,16 +1,18 @@ -import typing +from dataclasses import dataclass, fields +from typing import Any, cast, Dict, Iterator, List, Tuple, Protocol -from Options import Range, Choice, Toggle, DefaultOnToggle, AssembleOptions, DeathLink, ProgressionBalancing +from Options import AssembleOptions, Choice, DeathLink, DefaultOnToggle, Option, PerGameCommonOptions, \ + ProgressionBalancing, Range, Toggle # typing boilerplate -class FlagsProtocol(typing.Protocol): +class FlagsProtocol(Protocol): value: int default: int - flags: typing.List[str] + flags: List[str] -class FlagProtocol(typing.Protocol): +class FlagProtocol(Protocol): value: int default: int flag: str @@ -18,7 +20,7 @@ class FlagProtocol(typing.Protocol): # meta options class EvermizerFlags: - flags: typing.List[str] + flags: List[str] def to_flag(self: FlagsProtocol) -> str: return self.flags[self.value] @@ -200,13 +202,13 @@ class TrapCount(Range): # more meta options class ItemChanceMeta(AssembleOptions): - def __new__(mcs, name, bases, attrs): + def __new__(mcs, name: str, bases: Tuple[type], attrs: Dict[Any, Any]) -> "ItemChanceMeta": if 'item_name' in attrs: attrs["display_name"] = f"{attrs['item_name']} Chance" attrs["range_start"] = 0 attrs["range_end"] = 100 - - return super(ItemChanceMeta, mcs).__new__(mcs, name, bases, attrs) + cls = super(ItemChanceMeta, mcs).__new__(mcs, name, bases, attrs) + return cast(ItemChanceMeta, cls) class TrapChance(Range, metaclass=ItemChanceMeta): @@ -247,33 +249,52 @@ class SoEProgressionBalancing(ProgressionBalancing): special_range_names = {**ProgressionBalancing.special_range_names, "normal": default} -soe_options: typing.Dict[str, AssembleOptions] = { - "difficulty": Difficulty, - "energy_core": EnergyCore, - "required_fragments": RequiredFragments, - "available_fragments": AvailableFragments, - "money_modifier": MoneyModifier, - "exp_modifier": ExpModifier, - "sequence_breaks": SequenceBreaks, - "out_of_bounds": OutOfBounds, - "fix_cheats": FixCheats, - "fix_infinite_ammo": FixInfiniteAmmo, - "fix_atlas_glitch": FixAtlasGlitch, - "fix_wings_glitch": FixWingsGlitch, - "shorter_dialogs": ShorterDialogs, - "short_boss_rush": ShortBossRush, - "ingredienizer": Ingredienizer, - "sniffamizer": Sniffamizer, - "callbeadamizer": Callbeadamizer, - "musicmizer": Musicmizer, - "doggomizer": Doggomizer, - "turdo_mode": TurdoMode, - "death_link": DeathLink, - "trap_count": TrapCount, - "trap_chance_quake": TrapChanceQuake, - "trap_chance_poison": TrapChancePoison, - "trap_chance_confound": TrapChanceConfound, - "trap_chance_hud": TrapChanceHUD, - "trap_chance_ohko": TrapChanceOHKO, - "progression_balancing": SoEProgressionBalancing, -} +# noinspection SpellCheckingInspection +@dataclass +class SoEOptions(PerGameCommonOptions): + difficulty: Difficulty + energy_core: EnergyCore + required_fragments: RequiredFragments + available_fragments: AvailableFragments + money_modifier: MoneyModifier + exp_modifier: ExpModifier + sequence_breaks: SequenceBreaks + out_of_bounds: OutOfBounds + fix_cheats: FixCheats + fix_infinite_ammo: FixInfiniteAmmo + fix_atlas_glitch: FixAtlasGlitch + fix_wings_glitch: FixWingsGlitch + shorter_dialogs: ShorterDialogs + short_boss_rush: ShortBossRush + ingredienizer: Ingredienizer + sniffamizer: Sniffamizer + callbeadamizer: Callbeadamizer + musicmizer: Musicmizer + doggomizer: Doggomizer + turdo_mode: TurdoMode + death_link: DeathLink + trap_count: TrapCount + trap_chance_quake: TrapChanceQuake + trap_chance_poison: TrapChancePoison + trap_chance_confound: TrapChanceConfound + trap_chance_hud: TrapChanceHUD + trap_chance_ohko: TrapChanceOHKO + progression_balancing: SoEProgressionBalancing + + @property + def trap_chances(self) -> Iterator[TrapChance]: + for field in fields(self): + option = getattr(self, field.name) + if isinstance(option, TrapChance): + yield option + + @property + def flags(self) -> str: + flags = '' + for field in fields(self): + option = getattr(self, field.name) + if isinstance(option, (EvermizerFlag, EvermizerFlags)): + assert isinstance(option, Option) + # noinspection PyUnresolvedReferences + flags += option.to_flag() + return flags diff --git a/worlds/soe/Patch.py b/worlds/soe/patch.py similarity index 86% rename from worlds/soe/Patch.py rename to worlds/soe/patch.py index f4de5d06ead1..a322de2af65f 100644 --- a/worlds/soe/Patch.py +++ b/worlds/soe/patch.py @@ -1,5 +1,5 @@ import os -from typing import Optional +from typing import BinaryIO, Optional import Utils from worlds.Files import APDeltaPatch @@ -30,7 +30,7 @@ def get_base_rom_path(file_name: Optional[str] = None) -> str: return file_name -def read_rom(stream, strip_header=True) -> bytes: +def read_rom(stream: BinaryIO, strip_header: bool = True) -> bytes: """Reads rom into bytearray and optionally strips off any smc header""" data = stream.read() if strip_header and len(data) % 0x400 == 0x200: @@ -40,5 +40,5 @@ def read_rom(stream, strip_header=True) -> bytes: if __name__ == '__main__': import sys - print('Please use ../../Patch.py', file=sys.stderr) + print('Please use ../../patch.py', file=sys.stderr) sys.exit(1) diff --git a/worlds/soe/test/__init__.py b/worlds/soe/test/__init__.py index 27d38605aae4..1ab852163053 100644 --- a/worlds/soe/test/__init__.py +++ b/worlds/soe/test/__init__.py @@ -1,4 +1,4 @@ -from test.TestBase import WorldTestBase +from test.bases import WorldTestBase from typing import Iterable @@ -6,7 +6,7 @@ class SoETestBase(WorldTestBase): game = "Secret of Evermore" def assertLocationReachability(self, reachable: Iterable[str] = (), unreachable: Iterable[str] = (), - satisfied=True) -> None: + satisfied: bool = True) -> None: """ Tests that unreachable can't be reached. Tests that reachable can be reached if satisfied=True. Usage: test with satisfied=False, collect requirements into state, test again with satisfied=True @@ -18,3 +18,14 @@ def assertLocationReachability(self, reachable: Iterable[str] = (), unreachable: for location in unreachable: self.assertFalse(self.can_reach_location(location), f"{location} is reachable but shouldn't be") + + def testRocketPartsExist(self) -> None: + """Tests that rocket parts exist and are unique""" + self.assertEqual(len(self.get_items_by_name("Gauge")), 1) + self.assertEqual(len(self.get_items_by_name("Wheel")), 1) + diamond_eyes = self.get_items_by_name("Diamond Eye") + self.assertEqual(len(diamond_eyes), 3) + # verify diamond eyes are individual items + self.assertFalse(diamond_eyes[0] is diamond_eyes[1]) + self.assertFalse(diamond_eyes[0] is diamond_eyes[2]) + self.assertFalse(diamond_eyes[1] is diamond_eyes[2]) diff --git a/worlds/soe/test/test_access.py b/worlds/soe/test/test_access.py index c7da7b889627..f1d6ee993b34 100644 --- a/worlds/soe/test/test_access.py +++ b/worlds/soe/test/test_access.py @@ -4,10 +4,10 @@ class AccessTest(SoETestBase): @staticmethod - def _resolveGourds(gourds: typing.Dict[str, typing.Iterable[int]]): + def _resolveGourds(gourds: typing.Mapping[str, typing.Iterable[int]]) -> typing.List[str]: return [f"{name} #{number}" for name, numbers in gourds.items() for number in numbers] - def testBronzeAxe(self): + def test_bronze_axe(self) -> None: gourds = { "Pyramid bottom": (118, 121, 122, 123, 124, 125), "Pyramid top": (140,) @@ -16,7 +16,7 @@ def testBronzeAxe(self): items = [["Bronze Axe"]] self.assertAccessDependency(locations, items) - def testBronzeSpearPlus(self): + def test_bronze_spear_plus(self) -> None: locations = ["Megataur"] items = [["Bronze Spear"], ["Lance (Weapon)"], ["Laser Lance"]] self.assertAccessDependency(locations, items) diff --git a/worlds/soe/test/test_goal.py b/worlds/soe/test/test_goal.py index d127d3899869..bb64b8eca759 100644 --- a/worlds/soe/test/test_goal.py +++ b/worlds/soe/test/test_goal.py @@ -8,7 +8,7 @@ class TestFragmentGoal(SoETestBase): "required_fragments": 20, } - def testFragments(self): + def test_fragments(self) -> None: self.collect_by_name(["Gladiator Sword", "Diamond Eye", "Wheel", "Gauge"]) self.assertBeatable(False) # 0 fragments fragments = self.get_items_by_name("Energy Core Fragment") @@ -24,11 +24,11 @@ def testFragments(self): self.assertEqual(self.count("Energy Core Fragment"), 21) self.assertBeatable(True) - def testNoWeapon(self): + def test_no_weapon(self) -> None: self.collect_by_name(["Diamond Eye", "Wheel", "Gauge", "Energy Core Fragment"]) self.assertBeatable(False) - def testNoRocket(self): + def test_no_rocket(self) -> None: self.collect_by_name(["Gladiator Sword", "Diamond Eye", "Wheel", "Energy Core Fragment"]) self.assertBeatable(False) @@ -38,16 +38,16 @@ class TestShuffleGoal(SoETestBase): "energy_core": "shuffle", } - def testCore(self): + def test_core(self) -> None: self.collect_by_name(["Gladiator Sword", "Diamond Eye", "Wheel", "Gauge"]) self.assertBeatable(False) self.collect_by_name(["Energy Core"]) self.assertBeatable(True) - def testNoWeapon(self): + def test_no_weapon(self) -> None: self.collect_by_name(["Diamond Eye", "Wheel", "Gauge", "Energy Core"]) self.assertBeatable(False) - def testNoRocket(self): + def test_no_rocket(self) -> None: self.collect_by_name(["Gladiator Sword", "Diamond Eye", "Wheel", "Energy Core"]) self.assertBeatable(False) diff --git a/worlds/soe/test/test_oob.py b/worlds/soe/test/test_oob.py index 27e00cd3e764..3c1a2829de8e 100644 --- a/worlds/soe/test/test_oob.py +++ b/worlds/soe/test/test_oob.py @@ -6,7 +6,7 @@ class OoBTest(SoETestBase): """Tests that 'on' doesn't put out-of-bounds in logic. This is also the test base for OoB in logic.""" options: typing.Dict[str, typing.Any] = {"out_of_bounds": "on"} - def testOoBAccess(self): + def test_oob_access(self) -> None: in_logic = self.options["out_of_bounds"] == "logic" # some locations that just need a weapon + OoB @@ -37,7 +37,7 @@ def testOoBAccess(self): self.collect_by_name("Diamond Eye") self.assertLocationReachability(reachable=de_reachable, unreachable=de_unreachable, satisfied=in_logic) - def testOoBGoal(self): + def test_oob_goal(self) -> None: # still need Energy Core with OoB if sequence breaks are not in logic for item in ["Gladiator Sword", "Diamond Eye", "Wheel", "Gauge"]: self.collect_by_name(item) diff --git a/worlds/soe/test/test_sequence_breaks.py b/worlds/soe/test/test_sequence_breaks.py index 4248f9b47d97..2da8c9242cb9 100644 --- a/worlds/soe/test/test_sequence_breaks.py +++ b/worlds/soe/test/test_sequence_breaks.py @@ -6,7 +6,7 @@ class SequenceBreaksTest(SoETestBase): """Tests that 'on' doesn't put sequence breaks in logic. This is also the test base for in-logic.""" options: typing.Dict[str, typing.Any] = {"sequence_breaks": "on"} - def testSequenceBreaksAccess(self): + def test_sequence_breaks_access(self) -> None: in_logic = self.options["sequence_breaks"] == "logic" # some locations that just need any weapon + sequence break @@ -30,7 +30,7 @@ def testSequenceBreaksAccess(self): self.collect_by_name("Bronze Spear") # Escape now just needs either Megataur or Rimsala dead self.assertEqual(self.can_reach_location("Escape"), in_logic) - def testSequenceBreaksGoal(self): + def test_sequence_breaks_goal(self) -> None: in_logic = self.options["sequence_breaks"] == "logic" # don't need Energy Core with sequence breaks in logic diff --git a/worlds/soe/test/test_traps.py b/worlds/soe/test/test_traps.py new file mode 100644 index 000000000000..7babd4522b30 --- /dev/null +++ b/worlds/soe/test/test_traps.py @@ -0,0 +1,56 @@ +import typing +from dataclasses import fields + +from . import SoETestBase +from ..options import SoEOptions + +if typing.TYPE_CHECKING: + from .. import SoEWorld + + +class Bases: + # class in class to avoid running tests for TrapTest class + class TrapTestBase(SoETestBase): + """Test base for trap tests""" + option_name_to_item_name = { + # filtering by name here validates that there is no confusion between name and type + field.name: field.type.item_name for field in fields(SoEOptions) if field.name.startswith("trap_chance_") + } + + def test_dataclass(self) -> None: + """Test that the dataclass helper property returns the expected sequence""" + self.assertGreater(len(self.option_name_to_item_name), 0, "Expected more than 0 trap types") + world: "SoEWorld" = typing.cast("SoEWorld", self.multiworld.worlds[1]) + item_name_to_rolled_option = {option.item_name: option for option in world.options.trap_chances} + # compare that all fields are present - that is property in dataclass and selector code in test line up + self.assertEqual(sorted(self.option_name_to_item_name.values()), sorted(item_name_to_rolled_option), + "field names probably do not match field types") + # sanity check that chances are correctly set and returned by property + for option_name, item_name in self.option_name_to_item_name.items(): + self.assertEqual(item_name_to_rolled_option[item_name].value, + self.options.get(option_name, item_name_to_rolled_option[item_name].default)) + + def test_trap_count(self) -> None: + """Test that total trap count is correct""" + self.assertEqual(self.options["trap_count"], + len(self.get_items_by_name(self.option_name_to_item_name.values()))) + + +class TestTrapAllZeroChance(Bases.TrapTestBase): + """Tests all zero chances still gives traps if trap_count is set.""" + options: typing.Dict[str, typing.Any] = { + "trap_count": 1, + **{name: 0 for name in Bases.TrapTestBase.option_name_to_item_name} + } + + +class TestTrapNoConfound(Bases.TrapTestBase): + """Tests that one zero chance does not give that trap.""" + options: typing.Dict[str, typing.Any] = { + "trap_count": 99, + "trap_chance_confound": 0, + } + + def test_no_confound_trap(self) -> None: + self.assertEqual(self.option_name_to_item_name["trap_chance_confound"], "Confound Trap") + self.assertEqual(len(self.get_items_by_name("Confound Trap")), 0) diff --git a/worlds/stardew_valley/rules.py b/worlds/stardew_valley/rules.py index f56dec39a1f0..88aa13f31471 100644 --- a/worlds/stardew_valley/rules.py +++ b/worlds/stardew_valley/rules.py @@ -170,6 +170,8 @@ def set_entrance_rules(logic, multiworld, player, world_options: StardewValleyOp logic.received("Bus Repair").simplify()) MultiWorldRules.set_rule(multiworld.get_entrance(Entrance.enter_skull_cavern, player), logic.received(Wallet.skull_key).simplify()) + MultiWorldRules.set_rule(multiworld.get_entrance(Entrance.enter_casino, player), + logic.received("Club Card").simplify()) for floor in range(25, 200 + 25, 25): MultiWorldRules.set_rule(multiworld.get_entrance(dig_to_skull_floor(floor), player), logic.can_mine_to_skull_cavern_floor(floor).simplify()) diff --git a/worlds/tloz/ItemPool.py b/worlds/tloz/ItemPool.py index 456598edecef..5b90e99722df 100644 --- a/worlds/tloz/ItemPool.py +++ b/worlds/tloz/ItemPool.py @@ -94,17 +94,17 @@ def get_pool_core(world): # Starting Weapon start_weapon_locations = starting_weapon_locations.copy() final_starting_weapons = [weapon for weapon in starting_weapons - if weapon not in world.multiworld.non_local_items[world.player]] + if weapon not in world.options.non_local_items] if not final_starting_weapons: final_starting_weapons = starting_weapons starting_weapon = random.choice(final_starting_weapons) - if world.multiworld.StartingPosition[world.player] == StartingPosition.option_safe: + if world.options.StartingPosition == StartingPosition.option_safe: placed_items[start_weapon_locations[0]] = starting_weapon - elif world.multiworld.StartingPosition[world.player] in \ + elif world.options.StartingPosition in \ [StartingPosition.option_unsafe, StartingPosition.option_dangerous]: - if world.multiworld.StartingPosition[world.player] == StartingPosition.option_dangerous: + if world.options.StartingPosition == StartingPosition.option_dangerous: for location in dangerous_weapon_locations: - if world.multiworld.ExpandedPool[world.player] or "Drop" not in location: + if world.options.ExpandedPool or "Drop" not in location: start_weapon_locations.append(location) placed_items[random.choice(start_weapon_locations)] = starting_weapon else: @@ -115,7 +115,7 @@ def get_pool_core(world): # Triforce Fragments fragment = "Triforce Fragment" - if world.multiworld.ExpandedPool[world.player]: + if world.options.ExpandedPool: possible_level_locations = [location for location in all_level_locations if location not in level_locations[8]] else: @@ -125,15 +125,15 @@ def get_pool_core(world): if location in possible_level_locations: possible_level_locations.remove(location) for level in range(1, 9): - if world.multiworld.TriforceLocations[world.player] == TriforceLocations.option_vanilla: + if world.options.TriforceLocations == TriforceLocations.option_vanilla: placed_items[f"Level {level} Triforce"] = fragment - elif world.multiworld.TriforceLocations[world.player] == TriforceLocations.option_dungeons: + elif world.options.TriforceLocations == TriforceLocations.option_dungeons: placed_items[possible_level_locations.pop(random.randint(0, len(possible_level_locations) - 1))] = fragment else: pool.append(fragment) # Level 9 junk fill - if world.multiworld.ExpandedPool[world.player] > 0: + if world.options.ExpandedPool > 0: spots = random.sample(level_locations[8], len(level_locations[8]) // 2) for spot in spots: junk = random.choice(list(minor_items.keys())) @@ -142,7 +142,7 @@ def get_pool_core(world): # Finish Pool final_pool = basic_pool - if world.multiworld.ExpandedPool[world.player]: + if world.options.ExpandedPool: final_pool = { item: basic_pool.get(item, 0) + minor_items.get(item, 0) + take_any_items.get(item, 0) for item in set(basic_pool) | set(minor_items) | set(take_any_items) diff --git a/worlds/tloz/Options.py b/worlds/tloz/Options.py index 96bd3e296dca..58a50ec35929 100644 --- a/worlds/tloz/Options.py +++ b/worlds/tloz/Options.py @@ -1,5 +1,6 @@ import typing -from Options import Option, DefaultOnToggle, Choice +from dataclasses import dataclass +from Options import Option, DefaultOnToggle, Choice, PerGameCommonOptions class ExpandedPool(DefaultOnToggle): @@ -32,9 +33,8 @@ class StartingPosition(Choice): option_dangerous = 2 option_very_dangerous = 3 - -tloz_options: typing.Dict[str, type(Option)] = { - "ExpandedPool": ExpandedPool, - "TriforceLocations": TriforceLocations, - "StartingPosition": StartingPosition -} +@dataclass +class TlozOptions(PerGameCommonOptions): + ExpandedPool: ExpandedPool + TriforceLocations: TriforceLocations + StartingPosition: StartingPosition diff --git a/worlds/tloz/Rules.py b/worlds/tloz/Rules.py index 12bf466bce99..b94002f25da2 100644 --- a/worlds/tloz/Rules.py +++ b/worlds/tloz/Rules.py @@ -11,6 +11,7 @@ def set_rules(tloz_world: "TLoZWorld"): player = tloz_world.player world = tloz_world.multiworld + options = tloz_world.options # Boss events for a nicer spoiler log play through for level in range(1, 9): @@ -23,7 +24,7 @@ def set_rules(tloz_world: "TLoZWorld"): # No dungeons without weapons except for the dangerous weapon locations if we're dangerous, no unsafe dungeons for i, level in enumerate(tloz_world.levels[1:10]): for location in level.locations: - if world.StartingPosition[player] < StartingPosition.option_dangerous \ + if options.StartingPosition < StartingPosition.option_dangerous \ or location.name not in dangerous_weapon_locations: add_rule(world.get_location(location.name, player), lambda state: state.has_group("weapons", player)) @@ -66,7 +67,7 @@ def set_rules(tloz_world: "TLoZWorld"): lambda state: state.has("Recorder", player)) add_rule(world.get_location("Level 7 Boss", player), lambda state: state.has("Recorder", player)) - if world.ExpandedPool[player]: + if options.ExpandedPool: add_rule(world.get_location("Level 7 Key Drop (Stalfos)", player), lambda state: state.has("Recorder", player)) add_rule(world.get_location("Level 7 Bomb Drop (Digdogger)", player), @@ -75,13 +76,13 @@ def set_rules(tloz_world: "TLoZWorld"): lambda state: state.has("Recorder", player)) for location in food_locations: - if world.ExpandedPool[player] or "Drop" not in location: + if options.ExpandedPool or "Drop" not in location: add_rule(world.get_location(location, player), lambda state: state.has("Food", player)) add_rule(world.get_location("Level 8 Item (Magical Key)", player), lambda state: state.has("Bow", player) and state.has_group("arrows", player)) - if world.ExpandedPool[player]: + if options.ExpandedPool: add_rule(world.get_location("Level 8 Bomb Drop (Darknuts North)", player), lambda state: state.has("Bow", player) and state.has_group("arrows", player)) @@ -106,13 +107,13 @@ def set_rules(tloz_world: "TLoZWorld"): for location in stepladder_locations: add_rule(world.get_location(location, player), lambda state: state.has("Stepladder", player)) - if world.ExpandedPool[player]: + if options.ExpandedPool: for location in stepladder_locations_expanded: add_rule(world.get_location(location, player), lambda state: state.has("Stepladder", player)) # Don't allow Take Any Items until we can actually get in one - if world.ExpandedPool[player]: + if options.ExpandedPool: add_rule(world.get_location("Take Any Item Left", player), lambda state: state.has_group("candles", player) or state.has("Raft", player)) diff --git a/worlds/tloz/__init__.py b/worlds/tloz/__init__.py index 6e8927c4e7b9..259bfe204716 100644 --- a/worlds/tloz/__init__.py +++ b/worlds/tloz/__init__.py @@ -13,7 +13,7 @@ from .Items import item_table, item_prices, item_game_ids from .Locations import location_table, level_locations, major_locations, shop_locations, all_level_locations, \ standard_level_locations, shop_price_location_ids, secret_money_ids, location_ids, food_locations -from .Options import tloz_options +from .Options import TlozOptions from .Rom import TLoZDeltaPatch, get_base_rom_path, first_quest_dungeon_items_early, first_quest_dungeon_items_late from .Rules import set_rules from worlds.AutoWorld import World, WebWorld @@ -63,7 +63,8 @@ class TLoZWorld(World): This randomizer shuffles all the items in the game around, leading to a new adventure every time. """ - option_definitions = tloz_options + options_dataclass = TlozOptions + options: TlozOptions settings: typing.ClassVar[TLoZSettings] game = "The Legend of Zelda" topology_present = False @@ -132,7 +133,7 @@ def create_regions(self): for i, level in enumerate(level_locations): for location in level: - if self.multiworld.ExpandedPool[self.player] or "Drop" not in location: + if self.options.ExpandedPool or "Drop" not in location: self.levels[i + 1].locations.append( self.create_location(location, self.location_name_to_id[location], self.levels[i + 1])) @@ -144,7 +145,7 @@ def create_regions(self): self.levels[level].locations.append(boss_event) for location in major_locations: - if self.multiworld.ExpandedPool[self.player] or "Take Any" not in location: + if self.options.ExpandedPool or "Take Any" not in location: overworld.locations.append( self.create_location(location, self.location_name_to_id[location], overworld)) @@ -311,7 +312,7 @@ def get_filler_item_name(self) -> str: return self.multiworld.random.choice(self.filler_items) def fill_slot_data(self) -> Dict[str, Any]: - if self.multiworld.ExpandedPool[self.player]: + if self.options.ExpandedPool: take_any_left = self.multiworld.get_location("Take Any Item Left", self.player).item take_any_middle = self.multiworld.get_location("Take Any Item Middle", self.player).item take_any_right = self.multiworld.get_location("Take Any Item Right", self.player).item diff --git a/worlds/tunic/__init__.py b/worlds/tunic/__init__.py new file mode 100644 index 000000000000..b946ea8e3039 --- /dev/null +++ b/worlds/tunic/__init__.py @@ -0,0 +1,279 @@ +from typing import Dict, List, Any + +from BaseClasses import Region, Location, Item, Tutorial, ItemClassification +from .items import item_name_to_id, item_table, item_name_groups, fool_tiers, filler_items, slot_data_item_names +from .locations import location_table, location_name_groups, location_name_to_id, hexagon_locations +from .rules import set_location_rules, set_region_rules, randomize_ability_unlocks, gold_hexagon +from .er_rules import set_er_location_rules +from .regions import tunic_regions +from .er_scripts import create_er_regions +from .options import TunicOptions +from worlds.AutoWorld import WebWorld, World +from decimal import Decimal, ROUND_HALF_UP + + +class TunicWeb(WebWorld): + tutorials = [ + Tutorial( + tutorial_name="Multiworld Setup Guide", + description="A guide to setting up the TUNIC Randomizer for Archipelago multiworld games.", + language="English", + file_name="setup_en.md", + link="setup/en", + authors=["SilentDestroyer"] + ) + ] + theme = "grassFlowers" + game = "Tunic" + + +class TunicItem(Item): + game: str = "Tunic" + + +class TunicLocation(Location): + game: str = "Tunic" + + +class TunicWorld(World): + """ + Explore a land filled with lost legends, ancient powers, and ferocious monsters in TUNIC, an isometric action game + about a small fox on a big adventure. Stranded on a mysterious beach, armed with only your own curiosity, you will + confront colossal beasts, collect strange and powerful items, and unravel long-lost secrets. Be brave, tiny fox! + """ + game = "Tunic" + web = TunicWeb() + + data_version = 2 + options: TunicOptions + options_dataclass = TunicOptions + item_name_groups = item_name_groups + location_name_groups = location_name_groups + + item_name_to_id = item_name_to_id + location_name_to_id = location_name_to_id + + ability_unlocks: Dict[str, int] + slot_data_items: List[TunicItem] + tunic_portal_pairs: Dict[str, str] + er_portal_hints: Dict[int, str] + + def generate_early(self) -> None: + if self.options.start_with_sword and "Sword" not in self.options.start_inventory: + self.options.start_inventory.value["Sword"] = 1 + + def create_item(self, name: str) -> TunicItem: + item_data = item_table[name] + return TunicItem(name, item_data.classification, self.item_name_to_id[name], self.player) + + def create_items(self) -> None: + keys_behind_bosses = self.options.keys_behind_bosses + hexagon_quest = self.options.hexagon_quest + sword_progression = self.options.sword_progression + + tunic_items: List[TunicItem] = [] + self.slot_data_items = [] + + items_to_create: Dict[str, int] = {item: data.quantity_in_item_pool for item, data in item_table.items()} + + for money_fool in fool_tiers[self.options.fool_traps]: + items_to_create["Fool Trap"] += items_to_create[money_fool] + items_to_create[money_fool] = 0 + + if sword_progression: + items_to_create["Stick"] = 0 + items_to_create["Sword"] = 0 + else: + items_to_create["Sword Upgrade"] = 0 + + if self.options.laurels_location: + laurels = self.create_item("Hero's Laurels") + if self.options.laurels_location == "6_coins": + self.multiworld.get_location("Coins in the Well - 6 Coins", self.player).place_locked_item(laurels) + elif self.options.laurels_location == "10_coins": + self.multiworld.get_location("Coins in the Well - 10 Coins", self.player).place_locked_item(laurels) + elif self.options.laurels_location == "10_fairies": + self.multiworld.get_location("Secret Gathering Place - 10 Fairy Reward", self.player).place_locked_item(laurels) + self.slot_data_items.append(laurels) + items_to_create["Hero's Laurels"] = 0 + + if keys_behind_bosses: + for rgb_hexagon, location in hexagon_locations.items(): + hex_item = self.create_item(gold_hexagon if hexagon_quest else rgb_hexagon) + self.multiworld.get_location(location, self.player).place_locked_item(hex_item) + self.slot_data_items.append(hex_item) + items_to_create[rgb_hexagon] = 0 + items_to_create[gold_hexagon] -= 3 + + if hexagon_quest: + # Calculate number of hexagons in item pool + hexagon_goal = self.options.hexagon_goal + extra_hexagons = self.options.extra_hexagon_percentage + items_to_create[gold_hexagon] += int((Decimal(100 + extra_hexagons) / 100 * hexagon_goal).to_integral_value(rounding=ROUND_HALF_UP)) + + # Replace pages and normal hexagons with filler + for replaced_item in list(filter(lambda item: "Pages" in item or item in hexagon_locations, items_to_create)): + items_to_create[self.get_filler_item_name()] += items_to_create[replaced_item] + items_to_create[replaced_item] = 0 + + # Filler items that are still in the item pool to swap out + available_filler: List[str] = [filler for filler in items_to_create if items_to_create[filler] > 0 and + item_table[filler].classification == ItemClassification.filler] + + # Remove filler to make room for extra hexagons + for i in range(0, items_to_create[gold_hexagon]): + fill = self.random.choice(available_filler) + items_to_create[fill] -= 1 + if items_to_create[fill] == 0: + available_filler.remove(fill) + + if self.options.maskless: + mask_item = TunicItem("Scavenger Mask", ItemClassification.useful, self.item_name_to_id["Scavenger Mask"], self.player) + tunic_items.append(mask_item) + items_to_create["Scavenger Mask"] = 0 + + if self.options.lanternless: + mask_item = TunicItem("Lantern", ItemClassification.useful, self.item_name_to_id["Lantern"], self.player) + tunic_items.append(mask_item) + items_to_create["Lantern"] = 0 + + for item, quantity in items_to_create.items(): + for i in range(0, quantity): + tunic_item: TunicItem = self.create_item(item) + if item in slot_data_item_names: + self.slot_data_items.append(tunic_item) + tunic_items.append(tunic_item) + + self.multiworld.itempool += tunic_items + + def create_regions(self) -> None: + self.tunic_portal_pairs = {} + self.er_portal_hints = {} + self.ability_unlocks = randomize_ability_unlocks(self.random, self.options) + if self.options.entrance_rando: + portal_pairs, portal_hints = create_er_regions(self) + for portal1, portal2 in portal_pairs.items(): + self.tunic_portal_pairs[portal1.scene_destination()] = portal2.scene_destination() + self.er_portal_hints = portal_hints + + else: + for region_name in tunic_regions: + region = Region(region_name, self.player, self.multiworld) + self.multiworld.regions.append(region) + + for region_name, exits in tunic_regions.items(): + region = self.multiworld.get_region(region_name, self.player) + region.add_exits(exits) + + for location_name, location_id in self.location_name_to_id.items(): + region = self.multiworld.get_region(location_table[location_name].region, self.player) + location = TunicLocation(self.player, location_name, location_id, region) + region.locations.append(location) + + victory_region = self.multiworld.get_region("Spirit Arena", self.player) + victory_location = TunicLocation(self.player, "The Heir", None, victory_region) + victory_location.place_locked_item(TunicItem("Victory", ItemClassification.progression, None, self.player)) + self.multiworld.completion_condition[self.player] = lambda state: state.has("Victory", self.player) + victory_region.locations.append(victory_location) + + def set_rules(self) -> None: + if self.options.entrance_rando: + set_er_location_rules(self, self.ability_unlocks) + else: + set_region_rules(self, self.ability_unlocks) + set_location_rules(self, self.ability_unlocks) + + def get_filler_item_name(self) -> str: + return self.random.choice(filler_items) + + def extend_hint_information(self, hint_data: Dict[int, Dict[int, str]]): + if self.options.entrance_rando: + hint_data[self.player] = self.er_portal_hints + + def fill_slot_data(self) -> Dict[str, Any]: + slot_data: Dict[str, Any] = { + "seed": self.random.randint(0, 2147483647), + "start_with_sword": self.options.start_with_sword.value, + "keys_behind_bosses": self.options.keys_behind_bosses.value, + "sword_progression": self.options.sword_progression.value, + "ability_shuffling": self.options.ability_shuffling.value, + "hexagon_quest": self.options.hexagon_quest.value, + "fool_traps": self.options.fool_traps.value, + "entrance_rando": self.options.entrance_rando.value, + "Hexagon Quest Prayer": self.ability_unlocks["Pages 24-25 (Prayer)"], + "Hexagon Quest Holy Cross": self.ability_unlocks["Pages 42-43 (Holy Cross)"], + "Hexagon Quest Ice Rod": self.ability_unlocks["Pages 52-53 (Ice Rod)"], + "Hexagon Quest Goal": self.options.hexagon_goal.value, + "Entrance Rando": self.tunic_portal_pairs + } + + for tunic_item in filter(lambda item: item.location is not None and item.code is not None, self.slot_data_items): + if tunic_item.name not in slot_data: + slot_data[tunic_item.name] = [] + if tunic_item.name == gold_hexagon and len(slot_data[gold_hexagon]) >= 6: + continue + slot_data[tunic_item.name].extend([tunic_item.location.name, tunic_item.location.player]) + + for start_item in self.options.start_inventory_from_pool: + if start_item in slot_data_item_names: + if start_item not in slot_data: + slot_data[start_item] = [] + for i in range(0, self.options.start_inventory_from_pool[start_item]): + slot_data[start_item].extend(["Your Pocket", self.player]) + + for plando_item in self.multiworld.plando_items[self.player]: + if plando_item["from_pool"]: + items_to_find = set() + for item_type in [key for key in ["item", "items"] if key in plando_item]: + for item in plando_item[item_type]: + items_to_find.add(item) + for item in items_to_find: + if item in slot_data_item_names: + slot_data[item] = [] + for item_location in self.multiworld.find_item_locations(item, self.player): + slot_data[item].extend([item_location.name, item_location.player]) + + return slot_data + + # for the universal tracker, doesn't get called in standard gen + def interpret_slot_data(self, slot_data: Dict[str, Any]) -> None: + # bypassing random yaml settings + self.options.start_with_sword.value = slot_data["start_with_sword"] + self.options.keys_behind_bosses.value = slot_data["keys_behind_bosses"] + self.options.sword_progression.value = slot_data["sword_progression"] + self.options.ability_shuffling.value = slot_data["ability_shuffling"] + self.options.hexagon_quest.value = slot_data["hexagon_quest"] + self.ability_unlocks["Pages 24-25 (Prayer)"] = slot_data["Hexagon Quest Prayer"] + self.ability_unlocks["Pages 42-43 (Holy Cross)"] = slot_data["Hexagon Quest Holy Cross"] + self.ability_unlocks["Pages 52-53 (Ice Rod)"] = slot_data["Hexagon Quest Ice Rod"] + + # swapping entrances around so the mapping matches what was generated + if slot_data["entrance_rando"]: + from BaseClasses import Entrance + from .er_data import portal_mapping + entrance_dict: Dict[str, Entrance] = {entrance.name: entrance + for region in self.multiworld.get_regions(self.player) + for entrance in region.entrances} + slot_portals: Dict[str, str] = slot_data["Entrance Rando"] + for portal1, portal2 in slot_portals.items(): + portal_name1: str = "" + portal_name2: str = "" + entrance1 = None + entrance2 = None + for portal in portal_mapping: + if portal.scene_destination() == portal1: + portal_name1 = portal.name + if portal.scene_destination() == portal2: + portal_name2 = portal.name + + for entrance_name, entrance in entrance_dict.items(): + if entrance_name.startswith(portal_name1): + entrance1 = entrance + if entrance_name.startswith(portal_name2): + entrance2 = entrance + if entrance1 is None: + raise Exception("entrance1 not found, portal1 is " + portal1) + if entrance2 is None: + raise Exception("entrance2 not found, portal2 is " + portal2) + entrance1.connected_region = entrance2.parent_region + entrance2.connected_region = entrance1.parent_region diff --git a/worlds/tunic/docs/en_Tunic.md b/worlds/tunic/docs/en_Tunic.md new file mode 100644 index 000000000000..e957f9eafaf5 --- /dev/null +++ b/worlds/tunic/docs/en_Tunic.md @@ -0,0 +1,64 @@ +# TUNIC + +## Where is the options page? + +The [player options page for this game](../player-options) contains all the options you need to configure and export a config file. + +## I haven't played TUNIC before. + +**Play vanilla first.** It is **_heavily discouraged_** to play this randomizer before playing the vanilla game. +It is recommended that you achieve both endings in the vanilla game before playing the randomizer. + +## What does randomization do to this game? + +In the TUNIC Randomizer, every item in the game is randomized. All chests, key item pickups, instruction manual pages, hero relics, +and other unique items are shuffled.
+ +Ability shuffling is an option available from the options page to shuffle certain abilities (prayer, holy cross, and the ice rod combo), +preventing them from being used until they are unlocked.
+ +Enemy randomization and other options are also available and can be turned on in the client mod. + +## What is the goal of TUNIC when randomized? +The standard goal is the same as the vanilla game, which is to find the three hexagon keys, at which point you may either Take Your +Rightful Place or seek another path and Share Your Wisdom. + +Alternatively, Hexagon Quest is a mode that shuffles a certain number of Gold Questagons into the item pool, with the goal +being to find the required amount of them and then Share Your Wisdom. + +## What items from TUNIC can appear in another player's world? +Every item has a chance to appear in another player's world. + +## How many checks are in TUNIC? +There are 302 checks located across the world of TUNIC. + +## What do items from other worlds look like in TUNIC? +Items belonging to other TUNIC players will either appear as that item directly (if in a freestanding location) or in a +chest with the original chest texture for that item. + +Items belonging to non-TUNIC players will either appear as a question-mark block (if in a freestanding location) or in a chest with +a question mark symbol on it. Additionally, non-TUNIC items are color-coded by classification, with green for filler, blue for useful, and gold for progression. + +## Is there a tracker pack? +There is a [tracker pack](https://github.com/SapphireSapphic/TunicTracker/releases/latest). It is compatible with both Poptracker and Emotracker. Using Poptracker, it will automatically track checked locations and important items received. It can also automatically tab between maps as you traverse the world. This tracker was originally created by SapphireSapphic and ScoutJD, and has been extensively updated by Br00ty. + +There is also a [standalone item tracker](https://github.com/radicoon/tunic-rando-tracker/releases/latest), which tracks what items you have received. It is great for adding an item overlay to streaming setups. This item tracker was created by Radicoon. + +## What should I know regarding logic? +- Nighttime is not considered in logic. Every check in the game is obtainable during the day. +- The Cathedral is accessible during the day by using the Hero's Laurels to reach the Overworld fuse near the Swamp entrance. +- The Secret Legend chest at the Cathedral can be obtained during the day by opening the Holy Cross door from the outside. + +For Entrance Rando specifically: +- Activating a fuse to turn on a yellow teleporter pad also activates its counterpart in the Far Shore. +- The West Garden fuse can be activated from below. +- You can pray at the tree at the exterior of the Library. +- The elevators in the Rooted Ziggurat only go down. +- The portal in the trophy room of the Old House is active from the start. +- The elevator in Cathedral is immediately usable without activating the fuse. Activating the fuse does nothing. + +## What item groups are there? +Bombs, consumables (non-bomb ones), weapons, melee weapons (stick and sword), keys, hexagons, offerings, hero relics, cards, golden treasures, money, pages, and abilities (the three ability pages). There are also a few groups being used for singular items: laurels, orb, dagger, magic rod, holy cross, prayer, ice rod, and progressive sword. + +## What location groups are there? +Holy cross (for all holy cross checks), fairies (for the two fairy checks), well (for the coin well checks), and shop. Additionally, for checks that do not fall into the above categories, the name of the region is the name of the location group. diff --git a/worlds/tunic/docs/setup_en.md b/worlds/tunic/docs/setup_en.md new file mode 100644 index 000000000000..3c13331fe5f1 --- /dev/null +++ b/worlds/tunic/docs/setup_en.md @@ -0,0 +1,65 @@ +# TUNIC Setup Guide + +## Installation + +### Required Software + +- [TUNIC](https://tunicgame.com/) for PC (Steam Deck also supported) +- [BepInEx](https://builds.bepinex.dev/projects/bepinex_be/572/BepInEx_UnityIL2CPP_x64_9c2b17f_6.0.0-be.572.zip) +- [TUNIC Randomizer Archipelago Mod](https://github.com/silent-destroyer/tunic-randomizer-archipelago/releases/latest) + +### Optional Software +- [TUNIC Randomizer Map Tracker](https://github.com/SapphireSapphic/TunicTracker/releases/latest) (For use with EmoTracker/PopTracker) +- [TUNIC Randomizer Item Auto-tracker](https://github.com/radicoon/tunic-rando-tracker/releases/latest) + +### Find Your Relevant Game Directories + +Find your TUNIC game installation directory: + +- **Steam**: Right click TUNIC in your Steam Library, then *Manage → Browse local files*.
+ - **Steam Deck**: Hold down the power button, tap "Switch to Desktop", then launch Steam from Desktop Mode to access the above option. +- **PC Game Pass**: In the Xbox PC app, go to the TUNIC game page from your library, click the [...] button next to "Play", then +*Manage → Files → Browse...*
+- **Other platforms**: Follow a similar pattern of steps as above to locate your specific game directory. + +### Install BepInEx + +BepInEx is a general purpose framework for modding Unity games, and is used by the TUNIC Randomizer. + +Download [BepInEx](https://builds.bepinex.dev/projects/bepinex_be/572/BepInEx_UnityIL2CPP_x64_9c2b17f_6.0.0-be.572.zip). + +If playing on Steam Deck, follow this [guide to set up BepInEx via Proton](https://docs.bepinex.dev/articles/advanced/proton_wine.html). + +Extract the contents of the BepInEx .zip file into your TUNIC game directory:
+- **Steam**: Steam\steamapps\common\TUNIC
+- **PC Game Pass**: XboxGames\Tunic\Content
+- **Other platforms**: Place into the same folder that the Tunic_Data/Secret Legend_Data folder is found. + +Launch the game once and close it to finish the BepInEx installation. + +### Install The TUNIC Randomizer Archipelago Client Mod + +Download the latest release of the [TUNIC Randomizer Archipelago Mod](https://github.com/silent-destroyer/tunic-randomizer-archipelago/releases/latest). + +The downloaded .zip will contain a folder called `Tunic Archipelago`. + +Copy the `Tunic Archipelago` folder into `BepInEx/plugins` in your TUNIC game installation directory. +The filepath to the mod should look like `BepInEx/plugins/Tunic Archipelago/TunicArchipelago.dll`
+ +Launch the game, and if everything was installed correctly you should see `Randomizer + Archipelago Mod Ver. x.y.z` in the top left corner of the title screen! + +## Configure Archipelago Options + +### Configure Your YAML File + +Visit the [TUNIC options page](/games/Tunic/player-options) to generate a YAML with your selected options. + +### Configure Your Mod Settings +Launch the game and click the button labeled `Open AP Config` on the Title Screen. +In the menu that opens, fill in *Player*, *Hostname*, *Port*, and *Password* (if required) with the correct information for your room. + +Once you've input your information, click on Close. If everything was configured properly, you should see `Status: Connected!` and your chosen game options will be shown under `World Settings`. + +An error message will display if the game fails to connect to the server. + +Be sure to also look at the in-game options menu for a variety of additional settings, such as enemy randomization! diff --git a/worlds/tunic/er_data.py b/worlds/tunic/er_data.py new file mode 100644 index 000000000000..2d3bcc025f4b --- /dev/null +++ b/worlds/tunic/er_data.py @@ -0,0 +1,1001 @@ +from typing import Dict, NamedTuple, List, Tuple +from enum import IntEnum + + +class Portal(NamedTuple): + name: str # human-readable name + region: str # AP region + destination: str # vanilla destination scene and tag + + def scene(self) -> str: # the actual scene name in Tunic + return tunic_er_regions[self.region].game_scene + + def scene_destination(self) -> str: # full, nonchanging name to interpret by the mod + return self.scene() + ", " + self.destination + + +portal_mapping: List[Portal] = [ + Portal(name="Stick House Entrance", region="Overworld", + destination="Sword Cave_"), + Portal(name="Windmill Entrance", region="Overworld", + destination="Windmill_"), + Portal(name="Well Ladder Entrance", region="Overworld", + destination="Sewer_entrance"), + Portal(name="Entrance to Well from Well Rail", region="Overworld Well to Furnace Rail", + destination="Sewer_west_aqueduct"), + Portal(name="Old House Door Entrance", region="Overworld Old House Door", + destination="Overworld Interiors_house"), + Portal(name="Old House Waterfall Entrance", region="Overworld", + destination="Overworld Interiors_under_checkpoint"), + Portal(name="Entrance to Furnace from Well Rail", region="Overworld Well to Furnace Rail", + destination="Furnace_gyro_upper_north"), + Portal(name="Entrance to Furnace under Windmill", region="Overworld", + destination="Furnace_gyro_upper_east"), + Portal(name="Entrance to Furnace near West Garden", region="Overworld to West Garden from Furnace", + destination="Furnace_gyro_west"), + Portal(name="Entrance to Furnace from Beach", region="Overworld", + destination="Furnace_gyro_lower"), + Portal(name="Caustic Light Cave Entrance", region="Overworld", + destination="Overworld Cave_"), + Portal(name="Swamp Upper Entrance", region="Overworld Laurels", + destination="Swamp Redux 2_wall"), + Portal(name="Swamp Lower Entrance", region="Overworld", + destination="Swamp Redux 2_conduit"), + Portal(name="Ruined Passage Not-Door Entrance", region="Overworld", + destination="Ruins Passage_east"), + Portal(name="Ruined Passage Door Entrance", region="Overworld Ruined Passage Door", + destination="Ruins Passage_west"), + Portal(name="Atoll Upper Entrance", region="Overworld", + destination="Atoll Redux_upper"), + Portal(name="Atoll Lower Entrance", region="Overworld", + destination="Atoll Redux_lower"), + Portal(name="Special Shop Entrance", region="Overworld Laurels", + destination="ShopSpecial_"), + Portal(name="Maze Cave Entrance", region="Overworld", + destination="Maze Room_"), + Portal(name="West Garden Entrance near Belltower", region="Overworld Belltower", + destination="Archipelagos Redux_upper"), + Portal(name="West Garden Entrance from Furnace", region="Overworld to West Garden from Furnace", + destination="Archipelagos Redux_lower"), + Portal(name="West Garden Laurels Entrance", region="Overworld Laurels", + destination="Archipelagos Redux_lowest"), + Portal(name="Temple Door Entrance", region="Overworld Temple Door", + destination="Temple_main"), + Portal(name="Temple Rafters Entrance", region="Overworld", + destination="Temple_rafters"), + Portal(name="Ruined Shop Entrance", region="Overworld", + destination="Ruined Shop_"), + Portal(name="Patrol Cave Entrance", region="Overworld", + destination="PatrolCave_"), + Portal(name="Hourglass Cave Entrance", region="Overworld", + destination="Town Basement_beach"), + Portal(name="Changing Room Entrance", region="Overworld", + destination="Changing Room_"), + Portal(name="Cube Cave Entrance", region="Overworld", + destination="CubeRoom_"), + Portal(name="Stairs from Overworld to Mountain", region="Overworld", + destination="Mountain_"), + Portal(name="Overworld to Fortress", region="Overworld", + destination="Fortress Courtyard_"), + Portal(name="Fountain HC Door Entrance", region="Overworld Fountain Cross Door", + destination="Town_FiligreeRoom_"), + Portal(name="Southeast HC Door Entrance", region="Overworld Southeast Cross Door", + destination="EastFiligreeCache_"), + Portal(name="Overworld to Quarry Connector", region="Overworld", + destination="Darkwoods Tunnel_"), + Portal(name="Dark Tomb Main Entrance", region="Overworld", + destination="Crypt Redux_"), + Portal(name="Overworld to Forest Belltower", region="Overworld", + destination="Forest Belltower_"), + Portal(name="Town to Far Shore", region="Overworld Town Portal", + destination="Transit_teleporter_town"), + Portal(name="Spawn to Far Shore", region="Overworld Spawn Portal", + destination="Transit_teleporter_starting island"), + Portal(name="Secret Gathering Place Entrance", region="Overworld", + destination="Waterfall_"), + + Portal(name="Secret Gathering Place Exit", region="Secret Gathering Place", + destination="Overworld Redux_"), + + Portal(name="Windmill Exit", region="Windmill", + destination="Overworld Redux_"), + Portal(name="Windmill Shop", region="Windmill", + destination="Shop_"), + + Portal(name="Old House Door Exit", region="Old House Front", + destination="Overworld Redux_house"), + Portal(name="Old House to Glyph Tower", region="Old House Front", + destination="g_elements_"), + Portal(name="Old House Waterfall Exit", region="Old House Back", + destination="Overworld Redux_under_checkpoint"), + + Portal(name="Glyph Tower Exit", region="Relic Tower", + destination="Overworld Interiors_"), + + Portal(name="Changing Room Exit", region="Changing Room", + destination="Overworld Redux_"), + + Portal(name="Fountain HC Room Exit", region="Fountain Cross Room", + destination="Overworld Redux_"), + + Portal(name="Cube Cave Exit", region="Cube Cave", + destination="Overworld Redux_"), + + Portal(name="Guard Patrol Cave Exit", region="Patrol Cave", + destination="Overworld Redux_"), + + Portal(name="Ruined Shop Exit", region="Ruined Shop", + destination="Overworld Redux_"), + + Portal(name="Furnace Exit towards Well", region="Furnace Fuse", + destination="Overworld Redux_gyro_upper_north"), + Portal(name="Furnace Exit to Dark Tomb", region="Furnace Walking Path", + destination="Crypt Redux_"), + Portal(name="Furnace Exit towards West Garden", region="Furnace Walking Path", + destination="Overworld Redux_gyro_west"), + Portal(name="Furnace Exit to Beach", region="Furnace Ladder Area", + destination="Overworld Redux_gyro_lower"), + Portal(name="Furnace Exit under Windmill", region="Furnace Ladder Area", + destination="Overworld Redux_gyro_upper_east"), + + Portal(name="Stick House Exit", region="Stick House", + destination="Overworld Redux_"), + + Portal(name="Ruined Passage Not-Door Exit", region="Ruined Passage", + destination="Overworld Redux_east"), + Portal(name="Ruined Passage Door Exit", region="Ruined Passage", + destination="Overworld Redux_west"), + + Portal(name="Southeast HC Room Exit", region="Southeast Cross Room", + destination="Overworld Redux_"), + + Portal(name="Caustic Light Cave Exit", region="Caustic Light Cave", + destination="Overworld Redux_"), + + Portal(name="Maze Cave Exit", region="Maze Cave", + destination="Overworld Redux_"), + + Portal(name="Hourglass Cave Exit", region="Hourglass Cave", + destination="Overworld Redux_beach"), + + Portal(name="Special Shop Exit", region="Special Shop", + destination="Overworld Redux_"), + + Portal(name="Temple Rafters Exit", region="Sealed Temple Rafters", + destination="Overworld Redux_rafters"), + Portal(name="Temple Door Exit", region="Sealed Temple", + destination="Overworld Redux_main"), + + Portal(name="Well Ladder Exit", region="Beneath the Well Front", + destination="Overworld Redux_entrance"), + Portal(name="Well to Well Boss", region="Beneath the Well Back", + destination="Sewer_Boss_"), + Portal(name="Well Exit towards Furnace", region="Beneath the Well Back", + destination="Overworld Redux_west_aqueduct"), + + Portal(name="Well Boss to Well", region="Well Boss", + destination="Sewer_"), + Portal(name="Checkpoint to Dark Tomb", region="Dark Tomb Checkpoint", + destination="Crypt Redux_"), + + Portal(name="Dark Tomb to Overworld", region="Dark Tomb Entry Point", + destination="Overworld Redux_"), + Portal(name="Dark Tomb to Furnace", region="Dark Tomb Dark Exit", + destination="Furnace_"), + Portal(name="Dark Tomb to Checkpoint", region="Dark Tomb Entry Point", + destination="Sewer_Boss_"), + + Portal(name="West Garden Exit near Hero's Grave", region="West Garden", + destination="Overworld Redux_lower"), + Portal(name="West Garden to Magic Dagger House", region="West Garden", + destination="archipelagos_house_"), + Portal(name="West Garden Exit after Boss", region="West Garden after Boss", + destination="Overworld Redux_upper"), + Portal(name="West Garden Shop", region="West Garden", + destination="Shop_"), + Portal(name="West Garden Laurels Exit", region="West Garden Laurels Exit", + destination="Overworld Redux_lowest"), + Portal(name="West Garden Hero's Grave", region="West Garden Hero's Grave", + destination="RelicVoid_teleporter_relic plinth"), + Portal(name="West Garden to Far Shore", region="West Garden Portal", + destination="Transit_teleporter_archipelagos_teleporter"), + + Portal(name="Magic Dagger House Exit", region="Magic Dagger House", + destination="Archipelagos Redux_"), + + Portal(name="Atoll Upper Exit", region="Ruined Atoll", + destination="Overworld Redux_upper"), + Portal(name="Atoll Lower Exit", region="Ruined Atoll Lower Entry Area", + destination="Overworld Redux_lower"), + Portal(name="Atoll Shop", region="Ruined Atoll", + destination="Shop_"), + Portal(name="Atoll to Far Shore", region="Ruined Atoll Portal", + destination="Transit_teleporter_atoll"), + Portal(name="Atoll Statue Teleporter", region="Ruined Atoll Portal", + destination="Library Exterior_"), + Portal(name="Frog Stairs Eye Entrance", region="Ruined Atoll", + destination="Frog Stairs_eye"), + Portal(name="Frog Stairs Mouth Entrance", region="Ruined Atoll Frog Mouth", + destination="Frog Stairs_mouth"), + + Portal(name="Frog Stairs Eye Exit", region="Frog's Domain Entry", + destination="Atoll Redux_eye"), + Portal(name="Frog Stairs Mouth Exit", region="Frog's Domain Entry", + destination="Atoll Redux_mouth"), + Portal(name="Frog Stairs to Frog's Domain's Entrance", region="Frog's Domain Entry", + destination="frog cave main_Entrance"), + Portal(name="Frog Stairs to Frog's Domain's Exit", region="Frog's Domain Entry", + destination="frog cave main_Exit"), + + Portal(name="Frog's Domain Ladder Exit", region="Frog's Domain", + destination="Frog Stairs_Entrance"), + Portal(name="Frog's Domain Orb Exit", region="Frog's Domain Back", + destination="Frog Stairs_Exit"), + + Portal(name="Library Exterior Tree", region="Library Exterior Tree", + destination="Atoll Redux_"), + Portal(name="Library Exterior Ladder", region="Library Exterior Ladder", + destination="Library Hall_"), + + Portal(name="Library Hall Bookshelf Exit", region="Library Hall", + destination="Library Exterior_"), + Portal(name="Library Hero's Grave", region="Library Hero's Grave", + destination="RelicVoid_teleporter_relic plinth"), + Portal(name="Library Hall to Rotunda", region="Library Hall", + destination="Library Rotunda_"), + + Portal(name="Library Rotunda Lower Exit", region="Library Rotunda", + destination="Library Hall_"), + Portal(name="Library Rotunda Upper Exit", region="Library Rotunda", + destination="Library Lab_"), + + Portal(name="Library Lab to Rotunda", region="Library Lab Lower", + destination="Library Rotunda_"), + Portal(name="Library to Far Shore", region="Library Portal", + destination="Transit_teleporter_library teleporter"), + Portal(name="Library Lab to Librarian Arena", region="Library Lab", + destination="Library Arena_"), + + Portal(name="Librarian Arena Exit", region="Library Arena", + destination="Library Lab_"), + + Portal(name="Forest to Belltower", region="East Forest", + destination="Forest Belltower_"), + Portal(name="Forest Guard House 1 Lower Entrance", region="East Forest", + destination="East Forest Redux Laddercave_lower"), + Portal(name="Forest Guard House 1 Gate Entrance", region="East Forest", + destination="East Forest Redux Laddercave_gate"), + Portal(name="Forest Dance Fox Outside Doorway", region="East Forest Dance Fox Spot", + destination="East Forest Redux Laddercave_upper"), + Portal(name="Forest to Far Shore", region="East Forest Portal", + destination="Transit_teleporter_forest teleporter"), + Portal(name="Forest Guard House 2 Lower Entrance", region="East Forest", + destination="East Forest Redux Interior_lower"), + Portal(name="Forest Guard House 2 Upper Entrance", region="East Forest", + destination="East Forest Redux Interior_upper"), + Portal(name="Forest Grave Path Lower Entrance", region="East Forest", + destination="Sword Access_lower"), + Portal(name="Forest Grave Path Upper Entrance", region="East Forest", + destination="Sword Access_upper"), + + Portal(name="Guard House 1 Dance Fox Exit", region="Guard House 1 West", + destination="East Forest Redux_upper"), + Portal(name="Guard House 1 Lower Exit", region="Guard House 1 West", + destination="East Forest Redux_lower"), + Portal(name="Guard House 1 Upper Forest Exit", region="Guard House 1 East", + destination="East Forest Redux_gate"), + Portal(name="Guard House 1 to Guard Captain Room", region="Guard House 1 East", + destination="Forest Boss Room_"), + + Portal(name="Forest Grave Path Upper Exit", region="Forest Grave Path Upper", + destination="East Forest Redux_upper"), + Portal(name="Forest Grave Path Lower Exit", region="Forest Grave Path Main", + destination="East Forest Redux_lower"), + Portal(name="East Forest Hero's Grave", region="Forest Hero's Grave", + destination="RelicVoid_teleporter_relic plinth"), + + Portal(name="Guard House 2 Lower Exit", region="Guard House 2", + destination="East Forest Redux_lower"), + Portal(name="Guard House 2 Upper Exit", region="Guard House 2", + destination="East Forest Redux_upper"), + + Portal(name="Guard Captain Room Non-Gate Exit", region="Forest Boss Room", + destination="East Forest Redux Laddercave_"), + Portal(name="Guard Captain Room Gate Exit", region="Forest Boss Room", + destination="Forest Belltower_"), + + Portal(name="Forest Belltower to Fortress", region="Forest Belltower Main", + destination="Fortress Courtyard_"), + Portal(name="Forest Belltower to Forest", region="Forest Belltower Lower", + destination="East Forest Redux_"), + Portal(name="Forest Belltower to Overworld", region="Forest Belltower Main", + destination="Overworld Redux_"), + Portal(name="Forest Belltower to Guard Captain Room", region="Forest Belltower Upper", + destination="Forest Boss Room_"), + + Portal(name="Fortress Courtyard to Fortress Grave Path Lower", region="Fortress Courtyard", + destination="Fortress Reliquary_Lower"), + Portal(name="Fortress Courtyard to Fortress Grave Path Upper", region="Fortress Courtyard Upper", + destination="Fortress Reliquary_Upper"), + Portal(name="Fortress Courtyard to Fortress Interior", region="Fortress Courtyard", + destination="Fortress Main_Big Door"), + Portal(name="Fortress Courtyard to East Fortress", region="Fortress Courtyard Upper", + destination="Fortress East_"), + Portal(name="Fortress Courtyard to Beneath the Earth", region="Fortress Exterior near cave", + destination="Fortress Basement_"), + Portal(name="Fortress Courtyard to Forest Belltower", region="Fortress Exterior from East Forest", + destination="Forest Belltower_"), + Portal(name="Fortress Courtyard to Overworld", region="Fortress Exterior from Overworld", + destination="Overworld Redux_"), + Portal(name="Fortress Courtyard Shop", region="Fortress Exterior near cave", + destination="Shop_"), + + Portal(name="Beneath the Earth to Fortress Interior", region="Beneath the Vault Back", + destination="Fortress Main_"), + Portal(name="Beneath the Earth to Fortress Courtyard", region="Beneath the Vault Front", + destination="Fortress Courtyard_"), + + Portal(name="Fortress Interior Main Exit", region="Eastern Vault Fortress", + destination="Fortress Courtyard_Big Door"), + Portal(name="Fortress Interior to Beneath the Earth", region="Eastern Vault Fortress", + destination="Fortress Basement_"), + Portal(name="Fortress Interior to Siege Engine Arena", region="Eastern Vault Fortress Gold Door", + destination="Fortress Arena_"), + Portal(name="Fortress Interior Shop", region="Eastern Vault Fortress", + destination="Shop_"), + Portal(name="Fortress Interior to East Fortress Upper", region="Eastern Vault Fortress", + destination="Fortress East_upper"), + Portal(name="Fortress Interior to East Fortress Lower", region="Eastern Vault Fortress", + destination="Fortress East_lower"), + + Portal(name="East Fortress to Interior Lower", region="Fortress East Shortcut Lower", + destination="Fortress Main_lower"), + Portal(name="East Fortress to Courtyard", region="Fortress East Shortcut Upper", + destination="Fortress Courtyard_"), + Portal(name="East Fortress to Interior Upper", region="Fortress East Shortcut Upper", + destination="Fortress Main_upper"), + + Portal(name="Fortress Grave Path Lower Exit", region="Fortress Grave Path", + destination="Fortress Courtyard_Lower"), + Portal(name="Fortress Hero's Grave", region="Fortress Grave Path", + destination="RelicVoid_teleporter_relic plinth"), + Portal(name="Fortress Grave Path Upper Exit", region="Fortress Grave Path Upper", + destination="Fortress Courtyard_Upper"), + Portal(name="Fortress Grave Path Dusty Entrance", region="Fortress Grave Path Dusty Entrance", + destination="Dusty_"), + + Portal(name="Dusty Exit", region="Fortress Leaf Piles", + destination="Fortress Reliquary_"), + + Portal(name="Siege Engine Arena to Fortress", region="Fortress Arena", + destination="Fortress Main_"), + Portal(name="Fortress to Far Shore", region="Fortress Arena Portal", + destination="Transit_teleporter_spidertank"), + + Portal(name="Stairs to Top of the Mountain", region="Lower Mountain Stairs", + destination="Mountaintop_"), + Portal(name="Mountain to Quarry", region="Lower Mountain", + destination="Quarry Redux_"), + Portal(name="Mountain to Overworld", region="Lower Mountain", + destination="Overworld Redux_"), + + Portal(name="Top of the Mountain Exit", region="Top of the Mountain", + destination="Mountain_"), + + Portal(name="Quarry Connector to Overworld", region="Quarry Connector", + destination="Overworld Redux_"), + Portal(name="Quarry Connector to Quarry", region="Quarry Connector", + destination="Quarry Redux_"), + + Portal(name="Quarry to Overworld Exit", region="Quarry Entry", + destination="Darkwoods Tunnel_"), + Portal(name="Quarry Shop", region="Quarry Entry", + destination="Shop_"), + Portal(name="Quarry to Monastery Front", region="Quarry Monastery Entry", + destination="Monastery_front"), + Portal(name="Quarry to Monastery Back", region="Monastery Rope", + destination="Monastery_back"), + Portal(name="Quarry to Mountain", region="Quarry Back", + destination="Mountain_"), + Portal(name="Quarry to Ziggurat", region="Lower Quarry Zig Door", + destination="ziggurat2020_0_"), + Portal(name="Quarry to Far Shore", region="Quarry Portal", + destination="Transit_teleporter_quarry teleporter"), + + Portal(name="Monastery Rear Exit", region="Monastery Back", + destination="Quarry Redux_back"), + Portal(name="Monastery Front Exit", region="Monastery Front", + destination="Quarry Redux_front"), + Portal(name="Monastery Hero's Grave", region="Monastery Hero's Grave", + destination="RelicVoid_teleporter_relic plinth"), + + Portal(name="Ziggurat Entry Hallway to Ziggurat Upper", region="Rooted Ziggurat Entry", + destination="ziggurat2020_1_"), + Portal(name="Ziggurat Entry Hallway to Quarry", region="Rooted Ziggurat Entry", + destination="Quarry Redux_"), + + Portal(name="Ziggurat Upper to Ziggurat Entry Hallway", region="Rooted Ziggurat Upper Entry", + destination="ziggurat2020_0_"), + Portal(name="Ziggurat Upper to Ziggurat Tower", region="Rooted Ziggurat Upper Back", + destination="ziggurat2020_2_"), + + Portal(name="Ziggurat Tower to Ziggurat Upper", region="Rooted Ziggurat Middle Top", + destination="ziggurat2020_1_"), + Portal(name="Ziggurat Tower to Ziggurat Lower", region="Rooted Ziggurat Middle Bottom", + destination="ziggurat2020_3_"), + + Portal(name="Ziggurat Lower to Ziggurat Tower", region="Rooted Ziggurat Lower Front", + destination="ziggurat2020_2_"), + Portal(name="Ziggurat Portal Room Entrance", region="Rooted Ziggurat Portal Room Entrance", + destination="ziggurat2020_FTRoom_"), + + Portal(name="Ziggurat Portal Room Exit", region="Rooted Ziggurat Portal Room Exit", + destination="ziggurat2020_3_"), + Portal(name="Ziggurat to Far Shore", region="Rooted Ziggurat Portal", + destination="Transit_teleporter_ziggurat teleporter"), + + Portal(name="Swamp Lower Exit", region="Swamp", + destination="Overworld Redux_conduit"), + Portal(name="Swamp to Cathedral Main Entrance", region="Swamp to Cathedral Main Entrance", + destination="Cathedral Redux_main"), + Portal(name="Swamp to Cathedral Secret Legend Room Entrance", region="Swamp to Cathedral Treasure Room", + destination="Cathedral Redux_secret"), + Portal(name="Swamp to Gauntlet", region="Back of Swamp", + destination="Cathedral Arena_"), + Portal(name="Swamp Shop", region="Swamp", + destination="Shop_"), + Portal(name="Swamp Upper Exit", region="Back of Swamp Laurels Area", + destination="Overworld Redux_wall"), + Portal(name="Swamp Hero's Grave", region="Swamp Hero's Grave", + destination="RelicVoid_teleporter_relic plinth"), + + Portal(name="Cathedral Main Exit", region="Cathedral", + destination="Swamp Redux 2_main"), + Portal(name="Cathedral Elevator", region="Cathedral", + destination="Cathedral Arena_"), + Portal(name="Cathedral Secret Legend Room Exit", region="Cathedral Secret Legend Room", + destination="Swamp Redux 2_secret"), + + Portal(name="Gauntlet to Swamp", region="Cathedral Gauntlet Exit", + destination="Swamp Redux 2_"), + Portal(name="Gauntlet Elevator", region="Cathedral Gauntlet Checkpoint", + destination="Cathedral Redux_"), + Portal(name="Gauntlet Shop", region="Cathedral Gauntlet Checkpoint", + destination="Shop_"), + + Portal(name="Hero's Grave to Fortress", region="Hero Relic - Fortress", + destination="Fortress Reliquary_teleporter_relic plinth"), + Portal(name="Hero's Grave to Monastery", region="Hero Relic - Quarry", + destination="Monastery_teleporter_relic plinth"), + Portal(name="Hero's Grave to West Garden", region="Hero Relic - West Garden", + destination="Archipelagos Redux_teleporter_relic plinth"), + Portal(name="Hero's Grave to East Forest", region="Hero Relic - East Forest", + destination="Sword Access_teleporter_relic plinth"), + Portal(name="Hero's Grave to Library", region="Hero Relic - Library", + destination="Library Hall_teleporter_relic plinth"), + Portal(name="Hero's Grave to Swamp", region="Hero Relic - Swamp", + destination="Swamp Redux 2_teleporter_relic plinth"), + + Portal(name="Far Shore to West Garden", region="Far Shore to West Garden", + destination="Archipelagos Redux_teleporter_archipelagos_teleporter"), + Portal(name="Far Shore to Library", region="Far Shore to Library", + destination="Library Lab_teleporter_library teleporter"), + Portal(name="Far Shore to Quarry", region="Far Shore to Quarry", + destination="Quarry Redux_teleporter_quarry teleporter"), + Portal(name="Far Shore to East Forest", region="Far Shore to East Forest", + destination="East Forest Redux_teleporter_forest teleporter"), + Portal(name="Far Shore to Fortress", region="Far Shore to Fortress", + destination="Fortress Arena_teleporter_spidertank"), + Portal(name="Far Shore to Atoll", region="Far Shore", + destination="Atoll Redux_teleporter_atoll"), + Portal(name="Far Shore to Ziggurat", region="Far Shore", + destination="ziggurat2020_FTRoom_teleporter_ziggurat teleporter"), + Portal(name="Far Shore to Heir", region="Far Shore", + destination="Spirit Arena_teleporter_spirit arena"), + Portal(name="Far Shore to Town", region="Far Shore", + destination="Overworld Redux_teleporter_town"), + Portal(name="Far Shore to Spawn", region="Far Shore to Spawn", + destination="Overworld Redux_teleporter_starting island"), + + Portal(name="Heir Arena Exit", region="Spirit Arena", + destination="Transit_teleporter_spirit arena"), + + Portal(name="Purgatory Bottom Exit", region="Purgatory", + destination="Purgatory_bottom"), + Portal(name="Purgatory Top Exit", region="Purgatory", + destination="Purgatory_top"), +] + + +class RegionInfo(NamedTuple): + game_scene: str # the name of the scene in the actual game + dead_end: int = 0 # if a region has only one exit + hint: int = 0 # what kind of hint text you should have + + +class DeadEnd(IntEnum): + free = 0 # not a dead end + all_cats = 1 # dead end in every logic category + restricted = 2 # dead end only in restricted + # there's no dead ends that are only in unrestricted + + +class Hint(IntEnum): + none = 0 # big areas, empty hallways, etc. + region = 1 # at least one of the portals must not be a dead end + scene = 2 # multiple regions in the scene, so using region could mean no valid hints + special = 3 # for if there's a weird case of specific regions being viable + + +# key is the AP region name. "Fake" in region info just means the mod won't receive that info at all +tunic_er_regions: Dict[str, RegionInfo] = { + "Menu": RegionInfo("Fake", dead_end=DeadEnd.all_cats), + "Overworld": RegionInfo("Overworld Redux"), + "Overworld Holy Cross": RegionInfo("Fake", dead_end=DeadEnd.all_cats), + "Overworld Belltower": RegionInfo("Overworld Redux"), # the area with the belltower and chest + "Overworld Laurels": RegionInfo("Overworld Redux"), # all spots in Overworld that you need laurels to reach + "Overworld to West Garden from Furnace": RegionInfo("Overworld Redux", hint=Hint.region), + "Overworld Well to Furnace Rail": RegionInfo("Overworld Redux"), # the tiny rail passageway + "Overworld Ruined Passage Door": RegionInfo("Overworld Redux"), # the small space betweeen the door and the portal + "Overworld Old House Door": RegionInfo("Overworld Redux"), # the too-small space between the door and the portal + "Overworld Southeast Cross Door": RegionInfo("Overworld Redux"), # the small space betweeen the door and the portal + "Overworld Fountain Cross Door": RegionInfo("Overworld Redux"), + "Overworld Temple Door": RegionInfo("Overworld Redux"), # the small space betweeen the door and the portal + "Overworld Town Portal": RegionInfo("Overworld Redux"), + "Overworld Spawn Portal": RegionInfo("Overworld Redux"), + "Stick House": RegionInfo("Sword Cave", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Windmill": RegionInfo("Windmill"), + "Old House Back": RegionInfo("Overworld Interiors"), # part with the hc door + "Old House Front": RegionInfo("Overworld Interiors"), # part with the bedroom + "Relic Tower": RegionInfo("g_elements", dead_end=DeadEnd.all_cats), + "Furnace Fuse": RegionInfo("Furnace"), # top of the furnace + "Furnace Ladder Area": RegionInfo("Furnace"), # the two portals accessible by the ladder + "Furnace Walking Path": RegionInfo("Furnace"), # dark tomb to west garden + "Secret Gathering Place": RegionInfo("Waterfall", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Changing Room": RegionInfo("Changing Room", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Patrol Cave": RegionInfo("PatrolCave", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Ruined Shop": RegionInfo("Ruined Shop", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Ruined Passage": RegionInfo("Ruins Passage", hint=Hint.region), + "Special Shop": RegionInfo("ShopSpecial", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Caustic Light Cave": RegionInfo("Overworld Cave", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Maze Cave": RegionInfo("Maze Room", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Cube Cave": RegionInfo("CubeRoom", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Southeast Cross Room": RegionInfo("EastFiligreeCache", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Fountain Cross Room": RegionInfo("Town_FiligreeRoom", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Hourglass Cave": RegionInfo("Town Basement", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Sealed Temple": RegionInfo("Temple", hint=Hint.scene), + "Sealed Temple Rafters": RegionInfo("Temple", hint=Hint.scene), + "Forest Belltower Upper": RegionInfo("Forest Belltower", hint=Hint.region), + "Forest Belltower Main": RegionInfo("Forest Belltower"), + "Forest Belltower Lower": RegionInfo("Forest Belltower"), + "East Forest": RegionInfo("East Forest Redux"), + "East Forest Dance Fox Spot": RegionInfo("East Forest Redux"), + "East Forest Portal": RegionInfo("East Forest Redux"), + "Guard House 1 East": RegionInfo("East Forest Redux Laddercave"), + "Guard House 1 West": RegionInfo("East Forest Redux Laddercave"), + "Guard House 2": RegionInfo("East Forest Redux Interior"), + "Forest Boss Room": RegionInfo("Forest Boss Room"), + "Forest Grave Path Main": RegionInfo("Sword Access"), + "Forest Grave Path Upper": RegionInfo("Sword Access"), + "Forest Grave Path by Grave": RegionInfo("Sword Access"), + "Forest Hero's Grave": RegionInfo("Sword Access"), + "Dark Tomb Entry Point": RegionInfo("Crypt Redux"), # both upper exits + "Dark Tomb Main": RegionInfo("Crypt Redux"), + "Dark Tomb Dark Exit": RegionInfo("Crypt Redux"), + "Dark Tomb Checkpoint": RegionInfo("Sewer_Boss"), # can laurels backwards + "Well Boss": RegionInfo("Sewer_Boss"), # can walk through (with bombs at least) + "Beneath the Well Front": RegionInfo("Sewer"), + "Beneath the Well Main": RegionInfo("Sewer"), + "Beneath the Well Back": RegionInfo("Sewer"), + "West Garden": RegionInfo("Archipelagos Redux"), + "Magic Dagger House": RegionInfo("archipelagos_house", dead_end=DeadEnd.all_cats, hint=Hint.region), + "West Garden Portal": RegionInfo("Archipelagos Redux", dead_end=DeadEnd.restricted), + "West Garden Portal Item": RegionInfo("Archipelagos Redux", dead_end=DeadEnd.restricted, hint=Hint.special), + "West Garden Laurels Exit": RegionInfo("Archipelagos Redux"), + "West Garden after Boss": RegionInfo("Archipelagos Redux"), + "West Garden Hero's Grave": RegionInfo("Archipelagos Redux"), + "Ruined Atoll": RegionInfo("Atoll Redux"), + "Ruined Atoll Lower Entry Area": RegionInfo("Atoll Redux"), + "Ruined Atoll Frog Mouth": RegionInfo("Atoll Redux"), + "Ruined Atoll Portal": RegionInfo("Atoll Redux"), + "Frog's Domain Entry": RegionInfo("Frog Stairs"), + "Frog's Domain": RegionInfo("frog cave main", hint=Hint.region), + "Frog's Domain Back": RegionInfo("frog cave main", hint=Hint.scene), + "Library Exterior Tree": RegionInfo("Library Exterior"), + "Library Exterior Ladder": RegionInfo("Library Exterior"), + "Library Hall": RegionInfo("Library Hall"), + "Library Hero's Grave": RegionInfo("Library Hall"), + "Library Rotunda": RegionInfo("Library Rotunda"), + "Library Lab": RegionInfo("Library Lab"), + "Library Lab Lower": RegionInfo("Library Lab"), + "Library Portal": RegionInfo("Library Lab"), + "Library Arena": RegionInfo("Library Arena", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Fortress Exterior from East Forest": RegionInfo("Fortress Courtyard"), + "Fortress Exterior from Overworld": RegionInfo("Fortress Courtyard"), + "Fortress Exterior near cave": RegionInfo("Fortress Courtyard"), # where the shop and beneath the earth entry are + "Fortress Courtyard": RegionInfo("Fortress Courtyard"), + "Fortress Courtyard Upper": RegionInfo("Fortress Courtyard"), + "Beneath the Vault Front": RegionInfo("Fortress Basement", hint=Hint.scene), # the vanilla entry point + "Beneath the Vault Back": RegionInfo("Fortress Basement", hint=Hint.scene), # the vanilla exit point + "Eastern Vault Fortress": RegionInfo("Fortress Main"), + "Eastern Vault Fortress Gold Door": RegionInfo("Fortress Main"), + "Fortress East Shortcut Upper": RegionInfo("Fortress East"), + "Fortress East Shortcut Lower": RegionInfo("Fortress East"), + "Fortress Grave Path": RegionInfo("Fortress Reliquary"), + "Fortress Grave Path Upper": RegionInfo("Fortress Reliquary", dead_end=DeadEnd.restricted, hint=Hint.region), + "Fortress Grave Path Dusty Entrance": RegionInfo("Fortress Reliquary"), + "Fortress Hero's Grave": RegionInfo("Fortress Reliquary"), + "Fortress Leaf Piles": RegionInfo("Dusty", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Fortress Arena": RegionInfo("Fortress Arena"), + "Fortress Arena Portal": RegionInfo("Fortress Arena"), + "Lower Mountain": RegionInfo("Mountain"), + "Lower Mountain Stairs": RegionInfo("Mountain"), + "Top of the Mountain": RegionInfo("Mountaintop", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Quarry Connector": RegionInfo("Darkwoods Tunnel"), + "Quarry Entry": RegionInfo("Quarry Redux"), + "Quarry": RegionInfo("Quarry Redux"), + "Quarry Portal": RegionInfo("Quarry Redux"), + "Quarry Back": RegionInfo("Quarry Redux"), + "Quarry Monastery Entry": RegionInfo("Quarry Redux"), + "Monastery Front": RegionInfo("Monastery"), + "Monastery Back": RegionInfo("Monastery"), + "Monastery Hero's Grave": RegionInfo("Monastery"), + "Monastery Rope": RegionInfo("Quarry Redux"), + "Lower Quarry": RegionInfo("Quarry Redux"), + "Lower Quarry Zig Door": RegionInfo("Quarry Redux"), + "Rooted Ziggurat Entry": RegionInfo("ziggurat2020_0"), + "Rooted Ziggurat Upper Entry": RegionInfo("ziggurat2020_1"), + "Rooted Ziggurat Upper Front": RegionInfo("ziggurat2020_1"), + "Rooted Ziggurat Upper Back": RegionInfo("ziggurat2020_1"), # after the administrator + "Rooted Ziggurat Middle Top": RegionInfo("ziggurat2020_2"), + "Rooted Ziggurat Middle Bottom": RegionInfo("ziggurat2020_2"), + "Rooted Ziggurat Lower Front": RegionInfo("ziggurat2020_3"), # the vanilla entry point side + "Rooted Ziggurat Lower Back": RegionInfo("ziggurat2020_3"), # the boss side + "Rooted Ziggurat Portal Room Entrance": RegionInfo("ziggurat2020_3"), # the door itself on the zig 3 side + "Rooted Ziggurat Portal": RegionInfo("ziggurat2020_FTRoom"), + "Rooted Ziggurat Portal Room Exit": RegionInfo("ziggurat2020_FTRoom"), + "Swamp": RegionInfo("Swamp Redux 2"), + "Swamp to Cathedral Treasure Room": RegionInfo("Swamp Redux 2"), + "Swamp to Cathedral Main Entrance": RegionInfo("Swamp Redux 2"), + "Back of Swamp": RegionInfo("Swamp Redux 2"), # the area with hero grave and gauntlet entrance + "Swamp Hero's Grave": RegionInfo("Swamp Redux 2"), + "Back of Swamp Laurels Area": RegionInfo("Swamp Redux 2"), # the spots you need laurels to traverse + "Cathedral": RegionInfo("Cathedral Redux"), + "Cathedral Secret Legend Room": RegionInfo("Cathedral Redux", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Cathedral Gauntlet Checkpoint": RegionInfo("Cathedral Arena"), + "Cathedral Gauntlet": RegionInfo("Cathedral Arena"), + "Cathedral Gauntlet Exit": RegionInfo("Cathedral Arena"), + "Far Shore": RegionInfo("Transit"), + "Far Shore to Spawn": RegionInfo("Transit"), + "Far Shore to East Forest": RegionInfo("Transit"), + "Far Shore to Quarry": RegionInfo("Transit"), + "Far Shore to Fortress": RegionInfo("Transit"), + "Far Shore to Library": RegionInfo("Transit"), + "Far Shore to West Garden": RegionInfo("Transit"), + "Hero Relic - Fortress": RegionInfo("RelicVoid", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Hero Relic - Quarry": RegionInfo("RelicVoid", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Hero Relic - West Garden": RegionInfo("RelicVoid", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Hero Relic - East Forest": RegionInfo("RelicVoid", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Hero Relic - Library": RegionInfo("RelicVoid", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Hero Relic - Swamp": RegionInfo("RelicVoid", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Purgatory": RegionInfo("Purgatory"), + "Shop Entrance 1": RegionInfo("Shop", dead_end=DeadEnd.all_cats), + "Shop Entrance 2": RegionInfo("Shop", dead_end=DeadEnd.all_cats), + "Shop Entrance 3": RegionInfo("Shop", dead_end=DeadEnd.all_cats), + "Shop Entrance 4": RegionInfo("Shop", dead_end=DeadEnd.all_cats), + "Shop Entrance 5": RegionInfo("Shop", dead_end=DeadEnd.all_cats), + "Shop Entrance 6": RegionInfo("Shop", dead_end=DeadEnd.all_cats), + "Shop": RegionInfo("Shop", dead_end=DeadEnd.all_cats), + "Spirit Arena": RegionInfo("Spirit Arena", dead_end=DeadEnd.all_cats, hint=Hint.region), + "Spirit Arena Victory": RegionInfo("Spirit Arena", dead_end=DeadEnd.all_cats) +} + + +# so we can just loop over this instead of doing some complicated thing to deal with hallways in the hints +hallways: Dict[str, str] = { + "Overworld Redux, Furnace_gyro_west": "Overworld Redux, Archipelagos Redux_lower", + "Overworld Redux, Furnace_gyro_upper_north": "Overworld Redux, Sewer_west_aqueduct", + "Ruins Passage, Overworld Redux_east": "Ruins Passage, Overworld Redux_west", + "East Forest Redux Interior, East Forest Redux_upper": "East Forest Redux Interior, East Forest Redux_lower", + "Forest Boss Room, East Forest Redux Laddercave_": "Forest Boss Room, Forest Belltower_", + "Library Exterior, Atoll Redux_": "Library Exterior, Library Hall_", + "Library Rotunda, Library Lab_": "Library Rotunda, Library Hall_", + "Darkwoods Tunnel, Quarry Redux_": "Darkwoods Tunnel, Overworld Redux_", + "ziggurat2020_0, Quarry Redux_": "ziggurat2020_0, ziggurat2020_1_", + "Purgatory, Purgatory_bottom": "Purgatory, Purgatory_top", +} +hallway_helper: Dict[str, str] = {} +for p1, p2 in hallways.items(): + hallway_helper[p1] = p2 + hallway_helper[p2] = p1 + +# so we can just loop over this instead of doing some complicated thing to deal with hallways in the hints +hallways_nmg: Dict[str, str] = { + "Ruins Passage, Overworld Redux_east": "Ruins Passage, Overworld Redux_west", + "East Forest Redux Interior, East Forest Redux_upper": "East Forest Redux Interior, East Forest Redux_lower", + "Forest Boss Room, East Forest Redux Laddercave_": "Forest Boss Room, Forest Belltower_", + "Library Exterior, Atoll Redux_": "Library Exterior, Library Hall_", + "Library Rotunda, Library Lab_": "Library Rotunda, Library Hall_", + "Darkwoods Tunnel, Quarry Redux_": "Darkwoods Tunnel, Overworld Redux_", + "ziggurat2020_0, Quarry Redux_": "ziggurat2020_0, ziggurat2020_1_", + "Purgatory, Purgatory_bottom": "Purgatory, Purgatory_top", +} +hallway_helper_nmg: Dict[str, str] = {} +for p1, p2 in hallways.items(): + hallway_helper[p1] = p2 + hallway_helper[p2] = p1 + + +# the key is the region you have, the value is the regions you get for having that region +# this is mostly so we don't have to do something overly complex to get this information +dependent_regions: Dict[Tuple[str, ...], List[str]] = { + ("Overworld", "Overworld Belltower", "Overworld Laurels", "Overworld Southeast Cross Door", "Overworld Temple Door", + "Overworld Fountain Cross Door", "Overworld Town Portal", "Overworld Spawn Portal"): + ["Overworld", "Overworld Belltower", "Overworld Laurels", "Overworld Ruined Passage Door", + "Overworld Southeast Cross Door", "Overworld Old House Door", "Overworld Temple Door", + "Overworld Fountain Cross Door", "Overworld Town Portal", "Overworld Spawn Portal"], + ("Old House Front",): + ["Old House Front", "Old House Back"], + ("Furnace Fuse", "Furnace Ladder Area", "Furnace Walking Path"): + ["Furnace Fuse", "Furnace Ladder Area", "Furnace Walking Path"], + ("Sealed Temple", "Sealed Temple Rafters"): ["Sealed Temple", "Sealed Temple Rafters"], + ("Forest Belltower Upper",): + ["Forest Belltower Upper", "Forest Belltower Main", "Forest Belltower Lower"], + ("Forest Belltower Main",): + ["Forest Belltower Main", "Forest Belltower Lower"], + ("East Forest", "East Forest Dance Fox Spot", "East Forest Portal"): + ["East Forest", "East Forest Dance Fox Spot", "East Forest Portal"], + ("Forest Grave Path Main", "Forest Grave Path Upper"): + ["Forest Grave Path Main", "Forest Grave Path Upper", "Forest Grave Path by Grave", "Forest Hero's Grave"], + ("Forest Grave Path by Grave", "Forest Hero's Grave"): + ["Forest Grave Path by Grave", "Forest Hero's Grave"], + ("Beneath the Well Front", "Beneath the Well Main", "Beneath the Well Back"): + ["Beneath the Well Front", "Beneath the Well Main", "Beneath the Well Back"], + ("Dark Tomb Entry Point", "Dark Tomb Main", "Dark Tomb Dark Exit"): + ["Dark Tomb Entry Point", "Dark Tomb Main", "Dark Tomb Dark Exit"], + ("Well Boss",): + ["Dark Tomb Checkpoint", "Well Boss"], + ("West Garden", "West Garden Laurels Exit", "West Garden after Boss", "West Garden Hero's Grave"): + ["West Garden", "West Garden Laurels Exit", "West Garden after Boss", "West Garden Hero's Grave"], + ("West Garden Portal", "West Garden Portal Item"): ["West Garden Portal", "West Garden Portal Item"], + ("Ruined Atoll", "Ruined Atoll Lower Entry Area", "Ruined Atoll Frog Mouth", "Ruined Atoll Portal"): + ["Ruined Atoll", "Ruined Atoll Lower Entry Area", "Ruined Atoll Frog Mouth", "Ruined Atoll Portal"], + ("Frog's Domain",): + ["Frog's Domain", "Frog's Domain Back"], + ("Library Exterior Ladder", "Library Exterior Tree"): + ["Library Exterior Ladder", "Library Exterior Tree"], + ("Library Hall", "Library Hero's Grave"): + ["Library Hall", "Library Hero's Grave"], + ("Library Lab", "Library Lab Lower", "Library Portal"): + ["Library Lab", "Library Lab Lower", "Library Portal"], + ("Fortress Courtyard Upper",): + ["Fortress Courtyard Upper", "Fortress Exterior from East Forest", "Fortress Exterior from Overworld", + "Fortress Exterior near cave", "Fortress Courtyard"], + ("Fortress Exterior from East Forest", "Fortress Exterior from Overworld", + "Fortress Exterior near cave", "Fortress Courtyard"): + ["Fortress Exterior from East Forest", "Fortress Exterior from Overworld", + "Fortress Exterior near cave", "Fortress Courtyard"], + ("Beneath the Vault Front", "Beneath the Vault Back"): + ["Beneath the Vault Front", "Beneath the Vault Back"], + ("Fortress East Shortcut Upper",): + ["Fortress East Shortcut Upper", "Fortress East Shortcut Lower"], + ("Eastern Vault Fortress",): + ["Eastern Vault Fortress", "Eastern Vault Fortress Gold Door"], + ("Fortress Grave Path", "Fortress Grave Path Dusty Entrance", "Fortress Hero's Grave"): + ["Fortress Grave Path", "Fortress Grave Path Dusty Entrance", "Fortress Hero's Grave"], + ("Fortress Arena", "Fortress Arena Portal"): + ["Fortress Arena", "Fortress Arena Portal"], + ("Lower Mountain", "Lower Mountain Stairs"): + ["Lower Mountain", "Lower Mountain Stairs"], + ("Monastery Front",): + ["Monastery Front", "Monastery Back", "Monastery Hero's Grave"], + ("Monastery Back", "Monastery Hero's Grave"): + ["Monastery Back", "Monastery Hero's Grave"], + ("Quarry", "Quarry Portal", "Lower Quarry", "Quarry Entry", "Quarry Back", "Quarry Monastery Entry"): + ["Quarry", "Quarry Portal", "Lower Quarry", "Quarry Entry", "Quarry Back", "Quarry Monastery Entry", + "Lower Quarry Zig Door"], + ("Monastery Rope",): ["Monastery Rope", "Quarry", "Quarry Entry", "Quarry Back", "Quarry Portal", "Lower Quarry", + "Lower Quarry Zig Door"], + ("Rooted Ziggurat Upper Entry", "Rooted Ziggurat Upper Front"): + ["Rooted Ziggurat Upper Entry", "Rooted Ziggurat Upper Front", "Rooted Ziggurat Upper Back"], + ("Rooted Ziggurat Middle Top",): + ["Rooted Ziggurat Middle Top", "Rooted Ziggurat Middle Bottom"], + ("Rooted Ziggurat Lower Front", "Rooted Ziggurat Lower Back", "Rooted Ziggurat Portal Room Entrance"): + ["Rooted Ziggurat Lower Front", "Rooted Ziggurat Lower Back", "Rooted Ziggurat Portal Room Entrance"], + ("Rooted Ziggurat Portal", "Rooted Ziggurat Portal Room Exit"): + ["Rooted Ziggurat Portal", "Rooted Ziggurat Portal Room Exit"], + ("Swamp", "Swamp to Cathedral Treasure Room"): + ["Swamp", "Swamp to Cathedral Treasure Room", "Swamp to Cathedral Main Entrance"], + ("Back of Swamp", "Back of Swamp Laurels Area", "Swamp Hero's Grave"): + ["Back of Swamp", "Back of Swamp Laurels Area", "Swamp Hero's Grave"], + ("Cathedral Gauntlet Checkpoint",): + ["Cathedral Gauntlet Checkpoint", "Cathedral Gauntlet Exit", "Cathedral Gauntlet"], + ("Far Shore", "Far Shore to Spawn", "Far Shore to East Forest", "Far Shore to Quarry", + "Far Shore to Fortress", "Far Shore to Library", "Far Shore to West Garden"): + ["Far Shore", "Far Shore to Spawn", "Far Shore to East Forest", "Far Shore to Quarry", + "Far Shore to Fortress", "Far Shore to Library", "Far Shore to West Garden"] +} + + +dependent_regions_nmg: Dict[Tuple[str, ...], List[str]] = { + ("Overworld", "Overworld Belltower", "Overworld Laurels", "Overworld Southeast Cross Door", "Overworld Temple Door", + "Overworld Fountain Cross Door", "Overworld Town Portal", "Overworld Spawn Portal", + "Overworld Ruined Passage Door"): + ["Overworld", "Overworld Belltower", "Overworld Laurels", "Overworld Ruined Passage Door", + "Overworld Southeast Cross Door", "Overworld Old House Door", "Overworld Temple Door", + "Overworld Fountain Cross Door", "Overworld Town Portal", "Overworld Spawn Portal"], + # can laurels through the gate + ("Old House Front", "Old House Back"): + ["Old House Front", "Old House Back"], + ("Furnace Fuse", "Furnace Ladder Area", "Furnace Walking Path"): + ["Furnace Fuse", "Furnace Ladder Area", "Furnace Walking Path"], + ("Sealed Temple", "Sealed Temple Rafters"): ["Sealed Temple", "Sealed Temple Rafters"], + ("Forest Belltower Upper",): + ["Forest Belltower Upper", "Forest Belltower Main", "Forest Belltower Lower"], + ("Forest Belltower Main",): + ["Forest Belltower Main", "Forest Belltower Lower"], + ("East Forest", "East Forest Dance Fox Spot", "East Forest Portal"): + ["East Forest", "East Forest Dance Fox Spot", "East Forest Portal"], + ("Forest Grave Path Main", "Forest Grave Path Upper", "Forest Grave Path by Grave", "Forest Hero's Grave"): + ["Forest Grave Path Main", "Forest Grave Path Upper", "Forest Grave Path by Grave", "Forest Hero's Grave"], + ("Beneath the Well Front", "Beneath the Well Main", "Beneath the Well Back"): + ["Beneath the Well Front", "Beneath the Well Main", "Beneath the Well Back"], + ("Dark Tomb Entry Point", "Dark Tomb Main", "Dark Tomb Dark Exit"): + ["Dark Tomb Entry Point", "Dark Tomb Main", "Dark Tomb Dark Exit"], + ("Dark Tomb Checkpoint", "Well Boss"): + ["Dark Tomb Checkpoint", "Well Boss"], + ("West Garden", "West Garden Laurels Exit", "West Garden after Boss", "West Garden Hero's Grave", + "West Garden Portal", "West Garden Portal Item"): + ["West Garden", "West Garden Laurels Exit", "West Garden after Boss", "West Garden Hero's Grave", + "West Garden Portal", "West Garden Portal Item"], + ("Ruined Atoll", "Ruined Atoll Lower Entry Area", "Ruined Atoll Frog Mouth", "Ruined Atoll Portal"): + ["Ruined Atoll", "Ruined Atoll Lower Entry Area", "Ruined Atoll Frog Mouth", "Ruined Atoll Portal"], + ("Frog's Domain",): + ["Frog's Domain", "Frog's Domain Back"], + ("Library Exterior Ladder", "Library Exterior Tree"): + ["Library Exterior Ladder", "Library Exterior Tree"], + ("Library Hall", "Library Hero's Grave"): + ["Library Hall", "Library Hero's Grave"], + ("Library Lab", "Library Lab Lower", "Library Portal"): + ["Library Lab", "Library Lab Lower", "Library Portal"], + ("Fortress Exterior from East Forest", "Fortress Exterior from Overworld", + "Fortress Exterior near cave", "Fortress Courtyard", "Fortress Courtyard Upper"): + ["Fortress Exterior from East Forest", "Fortress Exterior from Overworld", + "Fortress Exterior near cave", "Fortress Courtyard", "Fortress Courtyard Upper"], + ("Beneath the Vault Front", "Beneath the Vault Back"): + ["Beneath the Vault Front", "Beneath the Vault Back"], + ("Fortress East Shortcut Upper", "Fortress East Shortcut Lower"): + ["Fortress East Shortcut Upper", "Fortress East Shortcut Lower"], + ("Eastern Vault Fortress", "Eastern Vault Fortress Gold Door"): + ["Eastern Vault Fortress", "Eastern Vault Fortress Gold Door"], + ("Fortress Grave Path", "Fortress Grave Path Dusty Entrance", "Fortress Hero's Grave"): + ["Fortress Grave Path", "Fortress Grave Path Dusty Entrance", "Fortress Hero's Grave"], + ("Fortress Grave Path Upper",): + ["Fortress Grave Path Upper", "Fortress Grave Path", "Fortress Grave Path Dusty Entrance", + "Fortress Hero's Grave"], + ("Fortress Arena", "Fortress Arena Portal"): + ["Fortress Arena", "Fortress Arena Portal"], + ("Lower Mountain", "Lower Mountain Stairs"): + ["Lower Mountain", "Lower Mountain Stairs"], + ("Monastery Front", "Monastery Back", "Monastery Hero's Grave"): + ["Monastery Front", "Monastery Back", "Monastery Hero's Grave"], + ("Quarry", "Quarry Portal", "Lower Quarry", "Quarry Entry", "Quarry Back", "Quarry Monastery Entry"): + ["Quarry", "Quarry Portal", "Lower Quarry", "Quarry Entry", "Quarry Back", "Quarry Monastery Entry", + "Lower Quarry Zig Door"], + ("Monastery Rope",): ["Monastery Rope", "Quarry", "Quarry Entry", "Quarry Back", "Quarry Portal", "Lower Quarry", + "Lower Quarry Zig Door"], + ("Rooted Ziggurat Upper Entry", "Rooted Ziggurat Upper Front"): + ["Rooted Ziggurat Upper Entry", "Rooted Ziggurat Upper Front", "Rooted Ziggurat Upper Back"], + ("Rooted Ziggurat Middle Top",): + ["Rooted Ziggurat Middle Top", "Rooted Ziggurat Middle Bottom"], + ("Rooted Ziggurat Lower Front", "Rooted Ziggurat Lower Back", "Rooted Ziggurat Portal Room Entrance"): + ["Rooted Ziggurat Lower Front", "Rooted Ziggurat Lower Back", "Rooted Ziggurat Portal Room Entrance"], + ("Rooted Ziggurat Portal", "Rooted Ziggurat Portal Room Exit"): + ["Rooted Ziggurat Portal", "Rooted Ziggurat Portal Room Exit"], + ("Swamp", "Swamp to Cathedral Treasure Room", "Swamp to Cathedral Main Entrance"): + ["Swamp", "Swamp to Cathedral Treasure Room", "Swamp to Cathedral Main Entrance"], + ("Back of Swamp", "Back of Swamp Laurels Area", "Swamp Hero's Grave"): + ["Back of Swamp", "Back of Swamp Laurels Area", "Swamp Hero's Grave", "Swamp", + "Swamp to Cathedral Treasure Room", "Swamp to Cathedral Main Entrance"], + ("Cathedral Gauntlet Checkpoint",): + ["Cathedral Gauntlet Checkpoint", "Cathedral Gauntlet Exit", "Cathedral Gauntlet"], + ("Far Shore", "Far Shore to Spawn", "Far Shore to East Forest", "Far Shore to Quarry", + "Far Shore to Fortress", "Far Shore to Library", "Far Shore to West Garden"): + ["Far Shore", "Far Shore to Spawn", "Far Shore to East Forest", "Far Shore to Quarry", + "Far Shore to Fortress", "Far Shore to Library", "Far Shore to West Garden"] +} + + +dependent_regions_ur: Dict[Tuple[str, ...], List[str]] = { + # can use ladder storage to get to the well rail + ("Overworld", "Overworld Belltower", "Overworld Laurels", "Overworld Southeast Cross Door", "Overworld Temple Door", + "Overworld Fountain Cross Door", "Overworld Town Portal", "Overworld Spawn Portal", + "Overworld Ruined Passage Door"): + ["Overworld", "Overworld Belltower", "Overworld Laurels", "Overworld Ruined Passage Door", + "Overworld Southeast Cross Door", "Overworld Old House Door", "Overworld Temple Door", + "Overworld Fountain Cross Door", "Overworld Town Portal", "Overworld Spawn Portal", + "Overworld Well to Furnace Rail"], + # can laurels through the gate + ("Old House Front", "Old House Back"): + ["Old House Front", "Old House Back"], + ("Furnace Fuse", "Furnace Ladder Area", "Furnace Walking Path"): + ["Furnace Fuse", "Furnace Ladder Area", "Furnace Walking Path"], + ("Sealed Temple", "Sealed Temple Rafters"): ["Sealed Temple", "Sealed Temple Rafters"], + ("Forest Belltower Upper",): + ["Forest Belltower Upper", "Forest Belltower Main", "Forest Belltower Lower"], + ("Forest Belltower Main",): + ["Forest Belltower Main", "Forest Belltower Lower"], + ("East Forest", "East Forest Dance Fox Spot", "East Forest Portal"): + ["East Forest", "East Forest Dance Fox Spot", "East Forest Portal"], + # can use laurels, ice grapple, or ladder storage to traverse + ("Forest Grave Path Main", "Forest Grave Path Upper", "Forest Grave Path by Grave", "Forest Hero's Grave"): + ["Forest Grave Path Main", "Forest Grave Path Upper", "Forest Grave Path by Grave", "Forest Hero's Grave"], + ("Beneath the Well Front", "Beneath the Well Main", "Beneath the Well Back"): + ["Beneath the Well Front", "Beneath the Well Main", "Beneath the Well Back"], + ("Dark Tomb Entry Point", "Dark Tomb Main", "Dark Tomb Dark Exit"): + ["Dark Tomb Entry Point", "Dark Tomb Main", "Dark Tomb Dark Exit"], + ("Dark Tomb Checkpoint", "Well Boss"): + ["Dark Tomb Checkpoint", "Well Boss"], + # can ice grapple from portal area to the rest, and vice versa + ("West Garden", "West Garden Laurels Exit", "West Garden after Boss", "West Garden Hero's Grave", + "West Garden Portal", "West Garden Portal Item"): + ["West Garden", "West Garden Laurels Exit", "West Garden after Boss", "West Garden Hero's Grave", + "West Garden Portal", "West Garden Portal Item"], + ("Ruined Atoll", "Ruined Atoll Lower Entry Area", "Ruined Atoll Frog Mouth", "Ruined Atoll Portal"): + ["Ruined Atoll", "Ruined Atoll Lower Entry Area", "Ruined Atoll Frog Mouth", "Ruined Atoll Portal"], + ("Frog's Domain",): + ["Frog's Domain", "Frog's Domain Back"], + ("Library Exterior Ladder", "Library Exterior Tree"): + ["Library Exterior Ladder", "Library Exterior Tree"], + ("Library Hall", "Library Hero's Grave"): + ["Library Hall", "Library Hero's Grave"], + ("Library Lab", "Library Lab Lower", "Library Portal"): + ["Library Lab", "Library Lab Lower", "Library Portal"], + # can use ice grapple or ladder storage to get from any ladder to upper + ("Fortress Exterior from East Forest", "Fortress Exterior from Overworld", + "Fortress Exterior near cave", "Fortress Courtyard", "Fortress Courtyard Upper"): + ["Fortress Exterior from East Forest", "Fortress Exterior from Overworld", + "Fortress Exterior near cave", "Fortress Courtyard", "Fortress Courtyard Upper"], + ("Beneath the Vault Front", "Beneath the Vault Back"): + ["Beneath the Vault Front", "Beneath the Vault Back"], + # can ice grapple up + ("Fortress East Shortcut Upper", "Fortress East Shortcut Lower"): + ["Fortress East Shortcut Upper", "Fortress East Shortcut Lower"], + ("Eastern Vault Fortress", "Eastern Vault Fortress Gold Door"): + ["Eastern Vault Fortress", "Eastern Vault Fortress Gold Door"], + ("Fortress Grave Path", "Fortress Grave Path Dusty Entrance", "Fortress Hero's Grave"): + ["Fortress Grave Path", "Fortress Grave Path Dusty Entrance", "Fortress Hero's Grave"], + # can ice grapple down + ("Fortress Grave Path Upper",): + ["Fortress Grave Path Upper", "Fortress Grave Path", "Fortress Grave Path Dusty Entrance", + "Fortress Hero's Grave"], + ("Fortress Arena", "Fortress Arena Portal"): + ["Fortress Arena", "Fortress Arena Portal"], + ("Lower Mountain", "Lower Mountain Stairs"): + ["Lower Mountain", "Lower Mountain Stairs"], + ("Monastery Front", "Monastery Back", "Monastery Hero's Grave"): + ["Monastery Front", "Monastery Back", "Monastery Hero's Grave"], + # can use ladder storage at any of the Quarry ladders to get to Monastery Rope + ("Quarry", "Quarry Portal", "Lower Quarry", "Quarry Entry", "Quarry Back", "Quarry Monastery Entry", + "Monastery Rope"): + ["Quarry", "Quarry Portal", "Lower Quarry", "Quarry Entry", "Quarry Back", "Quarry Monastery Entry", + "Monastery Rope", "Lower Quarry Zig Door"], + ("Rooted Ziggurat Upper Entry", "Rooted Ziggurat Upper Front"): + ["Rooted Ziggurat Upper Entry", "Rooted Ziggurat Upper Front", "Rooted Ziggurat Upper Back"], + ("Rooted Ziggurat Middle Top",): + ["Rooted Ziggurat Middle Top", "Rooted Ziggurat Middle Bottom"], + ("Rooted Ziggurat Lower Front", "Rooted Ziggurat Lower Back", "Rooted Ziggurat Portal Room Entrance"): + ["Rooted Ziggurat Lower Front", "Rooted Ziggurat Lower Back", "Rooted Ziggurat Portal Room Entrance"], + ("Rooted Ziggurat Portal", "Rooted Ziggurat Portal Room Exit"): + ["Rooted Ziggurat Portal", "Rooted Ziggurat Portal Room Exit"], + ("Swamp", "Swamp to Cathedral Treasure Room", "Swamp to Cathedral Main Entrance", "Back of Swamp", + "Back of Swamp Laurels Area", "Swamp Hero's Grave"): + ["Swamp", "Swamp to Cathedral Treasure Room", "Swamp to Cathedral Main Entrance", "Back of Swamp", + "Back of Swamp Laurels Area", "Swamp Hero's Grave"], + ("Cathedral Gauntlet Checkpoint",): + ["Cathedral Gauntlet Checkpoint", "Cathedral Gauntlet Exit", "Cathedral Gauntlet"], + ("Far Shore", "Far Shore to Spawn", "Far Shore to East Forest", "Far Shore to Quarry", + "Far Shore to Fortress", "Far Shore to Library", "Far Shore to West Garden"): + ["Far Shore", "Far Shore to Spawn", "Far Shore to East Forest", "Far Shore to Quarry", + "Far Shore to Fortress", "Far Shore to Library", "Far Shore to West Garden"] +} diff --git a/worlds/tunic/er_rules.py b/worlds/tunic/er_rules.py new file mode 100644 index 000000000000..5d88022dc159 --- /dev/null +++ b/worlds/tunic/er_rules.py @@ -0,0 +1,984 @@ +from typing import Dict, TYPE_CHECKING +from worlds.generic.Rules import set_rule, forbid_item +from .rules import has_ability, has_sword, has_stick, has_ice_grapple_logic, has_lantern, has_mask, can_ladder_storage +from .er_data import Portal +from BaseClasses import Region + +if TYPE_CHECKING: + from . import TunicWorld + +laurels = "Hero's Laurels" +grapple = "Magic Orb" +ice_dagger = "Magic Dagger" +fire_wand = "Magic Wand" +lantern = "Lantern" +fairies = "Fairy" +coins = "Golden Coin" +prayer = "Pages 24-25 (Prayer)" +holy_cross = "Pages 42-43 (Holy Cross)" +ice_rod = "Pages 52-53 (Ice Rod)" +key = "Key" +house_key = "Old House Key" +vault_key = "Fortress Vault Key" +mask = "Scavenger Mask" +red_hexagon = "Red Questagon" +green_hexagon = "Green Questagon" +blue_hexagon = "Blue Questagon" +gold_hexagon = "Gold Questagon" + + +def set_er_region_rules(world: "TunicWorld", ability_unlocks: Dict[str, int], regions: Dict[str, Region], + portal_pairs: Dict[Portal, Portal]) -> None: + player = world.player + options = world.options + + regions["Menu"].connect( + connecting_region=regions["Overworld"]) + + # Overworld + regions["Overworld"].connect( + connecting_region=regions["Overworld Holy Cross"], + rule=lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + + regions["Overworld"].connect( + connecting_region=regions["Overworld Belltower"], + rule=lambda state: state.has(laurels, player)) + regions["Overworld Belltower"].connect( + connecting_region=regions["Overworld"]) + + # nmg: can laurels through the ruined passage door + regions["Overworld"].connect( + connecting_region=regions["Overworld Ruined Passage Door"], + rule=lambda state: state.has(key, player, 2) + or (state.has(laurels, player) and options.logic_rules)) + + regions["Overworld"].connect( + connecting_region=regions["Overworld Laurels"], + rule=lambda state: state.has(laurels, player)) + regions["Overworld Laurels"].connect( + connecting_region=regions["Overworld"], + rule=lambda state: state.has(laurels, player)) + + # nmg: can ice grapple through the door + regions["Overworld"].connect( + connecting_region=regions["Overworld Old House Door"], + rule=lambda state: state.has(house_key, player) + or has_ice_grapple_logic(False, state, player, options, ability_unlocks)) + + # not including ice grapple through this because it's very tedious to get an enemy here + regions["Overworld"].connect( + connecting_region=regions["Overworld Southeast Cross Door"], + rule=lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + regions["Overworld Southeast Cross Door"].connect( + connecting_region=regions["Overworld"], + rule=lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + + # not including ice grapple through this because we're not including it on the other door + regions["Overworld"].connect( + connecting_region=regions["Overworld Fountain Cross Door"], + rule=lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + regions["Overworld Fountain Cross Door"].connect( + connecting_region=regions["Overworld"]) + + regions["Overworld"].connect( + connecting_region=regions["Overworld Town Portal"], + rule=lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + regions["Overworld Town Portal"].connect( + connecting_region=regions["Overworld"]) + + regions["Overworld"].connect( + connecting_region=regions["Overworld Spawn Portal"], + rule=lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + regions["Overworld Spawn Portal"].connect( + connecting_region=regions["Overworld"]) + + # nmg: ice grapple through temple door + regions["Overworld"].connect( + connecting_region=regions["Overworld Temple Door"], + name="Overworld Temple Door", + rule=lambda state: state.has_all({"Ring Eastern Bell", "Ring Western Bell"}, player) + or has_ice_grapple_logic(False, state, player, options, ability_unlocks)) + + # Overworld side areas + regions["Old House Front"].connect( + connecting_region=regions["Old House Back"]) + # nmg: laurels through the gate + regions["Old House Back"].connect( + connecting_region=regions["Old House Front"], + rule=lambda state: state.has(laurels, player) and options.logic_rules) + + regions["Sealed Temple"].connect( + connecting_region=regions["Sealed Temple Rafters"]) + regions["Sealed Temple Rafters"].connect( + connecting_region=regions["Sealed Temple"], + rule=lambda state: state.has(laurels, player)) + + regions["Furnace Walking Path"].connect( + connecting_region=regions["Furnace Ladder Area"], + rule=lambda state: state.has(laurels, player)) + regions["Furnace Ladder Area"].connect( + connecting_region=regions["Furnace Walking Path"], + rule=lambda state: state.has(laurels, player)) + + regions["Furnace Walking Path"].connect( + connecting_region=regions["Furnace Fuse"], + rule=lambda state: state.has(laurels, player)) + regions["Furnace Fuse"].connect( + connecting_region=regions["Furnace Walking Path"], + rule=lambda state: state.has(laurels, player)) + + regions["Furnace Fuse"].connect( + connecting_region=regions["Furnace Ladder Area"], + rule=lambda state: state.has(laurels, player)) + regions["Furnace Ladder Area"].connect( + connecting_region=regions["Furnace Fuse"], + rule=lambda state: state.has(laurels, player)) + + # East Forest + regions["Forest Belltower Upper"].connect( + connecting_region=regions["Forest Belltower Main"]) + + regions["Forest Belltower Main"].connect( + connecting_region=regions["Forest Belltower Lower"]) + + # nmg: ice grapple up to dance fox spot, and vice versa + regions["East Forest"].connect( + connecting_region=regions["East Forest Dance Fox Spot"], + rule=lambda state: state.has(laurels, player) + or has_ice_grapple_logic(True, state, player, options, ability_unlocks)) + regions["East Forest Dance Fox Spot"].connect( + connecting_region=regions["East Forest"], + rule=lambda state: state.has(laurels, player) + or has_ice_grapple_logic(True, state, player, options, ability_unlocks)) + + regions["East Forest"].connect( + connecting_region=regions["East Forest Portal"], + rule=lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + regions["East Forest Portal"].connect( + connecting_region=regions["East Forest"]) + + regions["Guard House 1 East"].connect( + connecting_region=regions["Guard House 1 West"]) + regions["Guard House 1 West"].connect( + connecting_region=regions["Guard House 1 East"], + rule=lambda state: state.has(laurels, player)) + + # nmg: ice grapple from upper grave path exit to the rest of it + regions["Forest Grave Path Upper"].connect( + connecting_region=regions["Forest Grave Path Main"], + rule=lambda state: state.has(laurels, player) + or has_ice_grapple_logic(True, state, player, options, ability_unlocks)) + regions["Forest Grave Path Main"].connect( + connecting_region=regions["Forest Grave Path Upper"], + rule=lambda state: state.has(laurels, player)) + + regions["Forest Grave Path Main"].connect( + connecting_region=regions["Forest Grave Path by Grave"]) + # nmg: ice grapple or laurels through the gate + regions["Forest Grave Path by Grave"].connect( + connecting_region=regions["Forest Grave Path Main"], + rule=lambda state: has_ice_grapple_logic(False, state, player, options, ability_unlocks) + or (state.has(laurels, player) and options.logic_rules)) + + regions["Forest Grave Path by Grave"].connect( + connecting_region=regions["Forest Hero's Grave"], + rule=lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + regions["Forest Hero's Grave"].connect( + connecting_region=regions["Forest Grave Path by Grave"]) + + # Beneath the Well and Dark Tomb + regions["Beneath the Well Front"].connect( + connecting_region=regions["Beneath the Well Main"], + rule=lambda state: has_stick(state, player) or state.has(fire_wand, player)) + regions["Beneath the Well Main"].connect( + connecting_region=regions["Beneath the Well Front"], + rule=lambda state: has_stick(state, player) or state.has(fire_wand, player)) + + regions["Beneath the Well Back"].connect( + connecting_region=regions["Beneath the Well Main"], + rule=lambda state: has_stick(state, player) or state.has(fire_wand, player)) + regions["Beneath the Well Main"].connect( + connecting_region=regions["Beneath the Well Back"], + rule=lambda state: has_stick(state, player) or state.has(fire_wand, player)) + + regions["Well Boss"].connect( + connecting_region=regions["Dark Tomb Checkpoint"]) + # nmg: can laurels through the gate + regions["Dark Tomb Checkpoint"].connect( + connecting_region=regions["Well Boss"], + rule=lambda state: state.has(laurels, player) and options.logic_rules) + + regions["Dark Tomb Entry Point"].connect( + connecting_region=regions["Dark Tomb Main"], + rule=lambda state: has_lantern(state, player, options)) + regions["Dark Tomb Main"].connect( + connecting_region=regions["Dark Tomb Entry Point"], + rule=lambda state: has_lantern(state, player, options)) + + regions["Dark Tomb Main"].connect( + connecting_region=regions["Dark Tomb Dark Exit"], + rule=lambda state: has_lantern(state, player, options)) + regions["Dark Tomb Dark Exit"].connect( + connecting_region=regions["Dark Tomb Main"], + rule=lambda state: has_lantern(state, player, options)) + + # West Garden + regions["West Garden Laurels Exit"].connect( + connecting_region=regions["West Garden"], + rule=lambda state: state.has(laurels, player)) + regions["West Garden"].connect( + connecting_region=regions["West Garden Laurels Exit"], + rule=lambda state: state.has(laurels, player)) + + # todo: can you wake the boss, then grapple to it, then kill it? + regions["West Garden after Boss"].connect( + connecting_region=regions["West Garden"], + rule=lambda state: state.has(laurels, player)) + regions["West Garden"].connect( + connecting_region=regions["West Garden after Boss"], + rule=lambda state: state.has(laurels, player) or has_sword(state, player)) + + regions["West Garden"].connect( + connecting_region=regions["West Garden Hero's Grave"], + rule=lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + regions["West Garden Hero's Grave"].connect( + connecting_region=regions["West Garden"]) + + regions["West Garden Portal"].connect( + connecting_region=regions["West Garden Portal Item"], + rule=lambda state: state.has(laurels, player)) + regions["West Garden Portal Item"].connect( + connecting_region=regions["West Garden Portal"], + rule=lambda state: state.has(laurels, player) and has_ability(state, player, prayer, options, ability_unlocks)) + + # nmg: can ice grapple to and from the item behind the magic dagger house + regions["West Garden Portal Item"].connect( + connecting_region=regions["West Garden"], + rule=lambda state: has_ice_grapple_logic(True, state, player, options, ability_unlocks)) + regions["West Garden"].connect( + connecting_region=regions["West Garden Portal Item"], + rule=lambda state: has_ice_grapple_logic(True, state, player, options, ability_unlocks)) + + # Atoll and Frog's Domain + # nmg: ice grapple the bird below the portal + regions["Ruined Atoll"].connect( + connecting_region=regions["Ruined Atoll Lower Entry Area"], + rule=lambda state: state.has(laurels, player) + or has_ice_grapple_logic(True, state, player, options, ability_unlocks)) + regions["Ruined Atoll Lower Entry Area"].connect( + connecting_region=regions["Ruined Atoll"], + rule=lambda state: state.has(laurels, player) or state.has(grapple, player)) + + regions["Ruined Atoll"].connect( + connecting_region=regions["Ruined Atoll Frog Mouth"], + rule=lambda state: state.has(laurels, player) or state.has(grapple, player)) + regions["Ruined Atoll Frog Mouth"].connect( + connecting_region=regions["Ruined Atoll"], + rule=lambda state: state.has(laurels, player) or state.has(grapple, player)) + + regions["Ruined Atoll"].connect( + connecting_region=regions["Ruined Atoll Portal"], + rule=lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + regions["Ruined Atoll Portal"].connect( + connecting_region=regions["Ruined Atoll"]) + + regions["Frog's Domain"].connect( + connecting_region=regions["Frog's Domain Back"], + rule=lambda state: state.has(grapple, player)) + + # Library + regions["Library Exterior Tree"].connect( + connecting_region=regions["Library Exterior Ladder"], + rule=lambda state: state.has(grapple, player) or state.has(laurels, player)) + regions["Library Exterior Ladder"].connect( + connecting_region=regions["Library Exterior Tree"], + rule=lambda state: has_ability(state, player, prayer, options, ability_unlocks) + and (state.has(grapple, player) or state.has(laurels, player))) + + regions["Library Hall"].connect( + connecting_region=regions["Library Hero's Grave"], + rule=lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + regions["Library Hero's Grave"].connect( + connecting_region=regions["Library Hall"]) + + regions["Library Lab Lower"].connect( + connecting_region=regions["Library Lab"], + rule=lambda state: state.has(laurels, player) or state.has(grapple, player)) + regions["Library Lab"].connect( + connecting_region=regions["Library Lab Lower"], + rule=lambda state: state.has(laurels, player)) + + regions["Library Lab"].connect( + connecting_region=regions["Library Portal"], + rule=lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + regions["Library Portal"].connect( + connecting_region=regions["Library Lab"]) + + # Eastern Vault Fortress + regions["Fortress Exterior from East Forest"].connect( + connecting_region=regions["Fortress Exterior from Overworld"], + rule=lambda state: state.has(laurels, player) or state.has(grapple, player)) + regions["Fortress Exterior from Overworld"].connect( + connecting_region=regions["Fortress Exterior from East Forest"], + rule=lambda state: state.has(laurels, player)) + + regions["Fortress Exterior near cave"].connect( + connecting_region=regions["Fortress Exterior from Overworld"], + rule=lambda state: state.has(laurels, player)) + regions["Fortress Exterior from Overworld"].connect( + connecting_region=regions["Fortress Exterior near cave"], + rule=lambda state: state.has(laurels, player) or has_ability(state, player, prayer, options, ability_unlocks)) + + regions["Fortress Courtyard"].connect( + connecting_region=regions["Fortress Exterior from Overworld"], + rule=lambda state: state.has(laurels, player)) + # nmg: can ice grapple an enemy in the courtyard + regions["Fortress Exterior from Overworld"].connect( + connecting_region=regions["Fortress Courtyard"], + rule=lambda state: state.has(laurels, player) + or has_ice_grapple_logic(True, state, player, options, ability_unlocks)) + + regions["Fortress Courtyard Upper"].connect( + connecting_region=regions["Fortress Courtyard"]) + # nmg: can ice grapple to the upper ledge + regions["Fortress Courtyard"].connect( + connecting_region=regions["Fortress Courtyard Upper"], + rule=lambda state: has_ice_grapple_logic(True, state, player, options, ability_unlocks)) + + regions["Fortress Courtyard Upper"].connect( + connecting_region=regions["Fortress Exterior from Overworld"]) + + regions["Beneath the Vault Front"].connect( + connecting_region=regions["Beneath the Vault Back"], + rule=lambda state: has_lantern(state, player, options)) + regions["Beneath the Vault Back"].connect( + connecting_region=regions["Beneath the Vault Front"]) + + regions["Fortress East Shortcut Upper"].connect( + connecting_region=regions["Fortress East Shortcut Lower"]) + # nmg: can ice grapple upwards + regions["Fortress East Shortcut Lower"].connect( + connecting_region=regions["Fortress East Shortcut Upper"], + rule=lambda state: has_ice_grapple_logic(True, state, player, options, ability_unlocks)) + + # nmg: ice grapple through the big gold door, can do it both ways + regions["Eastern Vault Fortress"].connect( + connecting_region=regions["Eastern Vault Fortress Gold Door"], + name="Fortress Gold Door", + rule=lambda state: state.has_all({"Activate Eastern Vault West Fuses", + "Activate Eastern Vault East Fuse"}, player) + or has_ice_grapple_logic(False, state, player, options, ability_unlocks)) + regions["Eastern Vault Fortress Gold Door"].connect( + connecting_region=regions["Eastern Vault Fortress"], + name="Fortress Gold Door", + rule=lambda state: has_ice_grapple_logic(True, state, player, options, ability_unlocks)) + + regions["Fortress Grave Path"].connect( + connecting_region=regions["Fortress Grave Path Dusty Entrance"], + rule=lambda state: state.has(laurels, player)) + regions["Fortress Grave Path Dusty Entrance"].connect( + connecting_region=regions["Fortress Grave Path"], + rule=lambda state: state.has(laurels, player)) + + regions["Fortress Grave Path"].connect( + connecting_region=regions["Fortress Hero's Grave"], + rule=lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + regions["Fortress Hero's Grave"].connect( + connecting_region=regions["Fortress Grave Path"]) + + # nmg: ice grapple from upper grave path to lower + regions["Fortress Grave Path Upper"].connect( + connecting_region=regions["Fortress Grave Path"], + rule=lambda state: has_ice_grapple_logic(True, state, player, options, ability_unlocks)) + + regions["Fortress Arena"].connect( + connecting_region=regions["Fortress Arena Portal"], + name="Fortress Arena to Fortress Portal", + rule=lambda state: state.has("Activate Eastern Vault West Fuses", player)) + regions["Fortress Arena Portal"].connect( + connecting_region=regions["Fortress Arena"]) + + # Quarry + regions["Lower Mountain"].connect( + connecting_region=regions["Lower Mountain Stairs"], + rule=lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + regions["Lower Mountain Stairs"].connect( + connecting_region=regions["Lower Mountain"], + rule=lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + + regions["Quarry Entry"].connect( + connecting_region=regions["Quarry Portal"], + name="Quarry to Quarry Portal", + rule=lambda state: state.has("Activate Quarry Fuse", player)) + regions["Quarry Portal"].connect( + connecting_region=regions["Quarry Entry"]) + + regions["Quarry Entry"].connect( + connecting_region=regions["Quarry"], + rule=lambda state: state.has(fire_wand, player) or has_sword(state, player)) + regions["Quarry"].connect( + connecting_region=regions["Quarry Entry"]) + + regions["Quarry Back"].connect( + connecting_region=regions["Quarry"], + rule=lambda state: state.has(fire_wand, player) or has_sword(state, player)) + regions["Quarry"].connect( + connecting_region=regions["Quarry Back"]) + + regions["Quarry Monastery Entry"].connect( + connecting_region=regions["Quarry"], + rule=lambda state: state.has(fire_wand, player) or has_sword(state, player)) + regions["Quarry"].connect( + connecting_region=regions["Quarry Monastery Entry"]) + + regions["Monastery Rope"].connect( + connecting_region=regions["Quarry Back"]) + + regions["Quarry"].connect( + connecting_region=regions["Lower Quarry"], + rule=lambda state: has_mask(state, player, options)) + + # nmg: bring a scav over, then ice grapple through the door + regions["Lower Quarry"].connect( + connecting_region=regions["Lower Quarry Zig Door"], + name="Quarry to Zig Door", + rule=lambda state: state.has("Activate Quarry Fuse", player) + or has_ice_grapple_logic(False, state, player, options, ability_unlocks)) + + # nmg: use ice grapple to get from the beginning of Quarry to the door without really needing mask + regions["Quarry"].connect( + connecting_region=regions["Lower Quarry Zig Door"], + rule=lambda state: has_ice_grapple_logic(True, state, player, options, ability_unlocks)) + + regions["Monastery Front"].connect( + connecting_region=regions["Monastery Back"]) + # nmg: can laurels through the gate + regions["Monastery Back"].connect( + connecting_region=regions["Monastery Front"], + rule=lambda state: state.has(laurels, player) and options.logic_rules) + + regions["Monastery Back"].connect( + connecting_region=regions["Monastery Hero's Grave"], + rule=lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + regions["Monastery Hero's Grave"].connect( + connecting_region=regions["Monastery Back"]) + + # Ziggurat + regions["Rooted Ziggurat Upper Entry"].connect( + connecting_region=regions["Rooted Ziggurat Upper Front"]) + + regions["Rooted Ziggurat Upper Front"].connect( + connecting_region=regions["Rooted Ziggurat Upper Back"], + rule=lambda state: state.has(laurels, player) or has_sword(state, player)) + regions["Rooted Ziggurat Upper Back"].connect( + connecting_region=regions["Rooted Ziggurat Upper Front"], + rule=lambda state: state.has(laurels, player)) + + regions["Rooted Ziggurat Middle Top"].connect( + connecting_region=regions["Rooted Ziggurat Middle Bottom"]) + + regions["Rooted Ziggurat Lower Front"].connect( + connecting_region=regions["Rooted Ziggurat Lower Back"], + rule=lambda state: state.has(laurels, player) + or (has_sword(state, player) and has_ability(state, player, prayer, options, ability_unlocks))) + # unrestricted: use ladder storage to get to the front, get hit by one of the many enemies + regions["Rooted Ziggurat Lower Back"].connect( + connecting_region=regions["Rooted Ziggurat Lower Front"], + rule=lambda state: state.has(laurels, player) or can_ladder_storage(state, player, options)) + + regions["Rooted Ziggurat Lower Back"].connect( + connecting_region=regions["Rooted Ziggurat Portal Room Entrance"], + rule=lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + regions["Rooted Ziggurat Portal Room Entrance"].connect( + connecting_region=regions["Rooted Ziggurat Lower Back"]) + + regions["Rooted Ziggurat Portal"].connect( + connecting_region=regions["Rooted Ziggurat Portal Room Exit"], + name="Zig Portal Room Exit", + rule=lambda state: state.has("Activate Ziggurat Fuse", player)) + regions["Rooted Ziggurat Portal Room Exit"].connect( + connecting_region=regions["Rooted Ziggurat Portal"], + rule=lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + + # Swamp and Cathedral + # nmg: ice grapple through cathedral door, can do it both ways + regions["Swamp"].connect( + connecting_region=regions["Swamp to Cathedral Main Entrance"], + rule=lambda state: has_ability(state, player, prayer, options, ability_unlocks) + or has_ice_grapple_logic(False, state, player, options, ability_unlocks)) + regions["Swamp to Cathedral Main Entrance"].connect( + connecting_region=regions["Swamp"], + rule=lambda state: has_ice_grapple_logic(False, state, player, options, ability_unlocks)) + + regions["Swamp"].connect( + connecting_region=regions["Swamp to Cathedral Treasure Room"], + rule=lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + regions["Swamp to Cathedral Treasure Room"].connect( + connecting_region=regions["Swamp"]) + + regions["Back of Swamp"].connect( + connecting_region=regions["Back of Swamp Laurels Area"], + rule=lambda state: state.has(laurels, player)) + regions["Back of Swamp Laurels Area"].connect( + connecting_region=regions["Back of Swamp"], + rule=lambda state: state.has(laurels, player)) + + # nmg: can ice grapple down while you're on the pillars + regions["Back of Swamp Laurels Area"].connect( + connecting_region=regions["Swamp"], + rule=lambda state: state.has(laurels, player) + and has_ice_grapple_logic(True, state, player, options, ability_unlocks)) + + regions["Back of Swamp"].connect( + connecting_region=regions["Swamp Hero's Grave"], + rule=lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + regions["Swamp Hero's Grave"].connect( + connecting_region=regions["Back of Swamp"]) + + regions["Cathedral Gauntlet Checkpoint"].connect( + connecting_region=regions["Cathedral Gauntlet"]) + + regions["Cathedral Gauntlet"].connect( + connecting_region=regions["Cathedral Gauntlet Exit"], + rule=lambda state: state.has(laurels, player)) + regions["Cathedral Gauntlet Exit"].connect( + connecting_region=regions["Cathedral Gauntlet"], + rule=lambda state: state.has(laurels, player)) + + # Far Shore + regions["Far Shore"].connect( + connecting_region=regions["Far Shore to Spawn"], + rule=lambda state: state.has(laurels, player)) + regions["Far Shore to Spawn"].connect( + connecting_region=regions["Far Shore"], + rule=lambda state: state.has(laurels, player)) + + regions["Far Shore"].connect( + connecting_region=regions["Far Shore to East Forest"], + rule=lambda state: state.has(laurels, player)) + regions["Far Shore to East Forest"].connect( + connecting_region=regions["Far Shore"], + rule=lambda state: state.has(laurels, player)) + + regions["Far Shore"].connect( + connecting_region=regions["Far Shore to West Garden"], + name="Far Shore to West Garden", + rule=lambda state: state.has("Activate West Garden Fuse", player)) + regions["Far Shore to West Garden"].connect( + connecting_region=regions["Far Shore"]) + + regions["Far Shore"].connect( + connecting_region=regions["Far Shore to Quarry"], + name="Far Shore to Quarry", + rule=lambda state: state.has("Activate Quarry Fuse", player)) + regions["Far Shore to Quarry"].connect( + connecting_region=regions["Far Shore"]) + + regions["Far Shore"].connect( + connecting_region=regions["Far Shore to Fortress"], + name="Far Shore to Fortress", + rule=lambda state: state.has("Activate Eastern Vault West Fuses", player)) + regions["Far Shore to Fortress"].connect( + connecting_region=regions["Far Shore"]) + + regions["Far Shore"].connect( + connecting_region=regions["Far Shore to Library"], + name="Far Shore to Library", + rule=lambda state: state.has("Activate Library Fuse", player)) + regions["Far Shore to Library"].connect( + connecting_region=regions["Far Shore"]) + + # Misc + regions["Shop Entrance 1"].connect( + connecting_region=regions["Shop"]) + regions["Shop Entrance 2"].connect( + connecting_region=regions["Shop"]) + regions["Shop Entrance 3"].connect( + connecting_region=regions["Shop"]) + regions["Shop Entrance 4"].connect( + connecting_region=regions["Shop"]) + regions["Shop Entrance 5"].connect( + connecting_region=regions["Shop"]) + regions["Shop Entrance 6"].connect( + connecting_region=regions["Shop"]) + + regions["Spirit Arena"].connect( + connecting_region=regions["Spirit Arena Victory"], + rule=lambda state: (state.has(gold_hexagon, player, world.options.hexagon_goal.value) if + world.options.hexagon_quest else + state.has_all({red_hexagon, green_hexagon, blue_hexagon}, player))) + + # connecting the regions portals are in to other portals you can access via ladder storage + # using has_stick instead of can_ladder_storage since it's already checking the logic rules + if options.logic_rules == "unrestricted": + def get_paired_region(portal_sd: str) -> str: + for portal1, portal2 in portal_pairs.items(): + if portal1.scene_destination() == portal_sd: + return portal2.region + if portal2.scene_destination() == portal_sd: + return portal1.region + raise Exception("no matches found in get_paired_region") + + # The upper Swamp entrance + regions["Overworld"].connect( + regions[get_paired_region("Overworld Redux, Swamp Redux 2_wall")], + rule=lambda state: has_stick(state, player)) + # Western Furnace entrance, next to the sign that leads to West Garden + regions["Overworld"].connect( + regions[get_paired_region("Overworld Redux, Furnace_gyro_west")], + rule=lambda state: has_stick(state, player)) + # Upper West Garden entry, by the belltower + regions["Overworld"].connect( + regions[get_paired_region("Overworld Redux, Archipelagos Redux_upper")], + rule=lambda state: has_stick(state, player)) + # West Garden entry by the Furnace + regions["Overworld"].connect( + regions[get_paired_region("Overworld Redux, Archipelagos Redux_lower")], + rule=lambda state: has_stick(state, player)) + # West Garden laurels entrance, by the beach + regions["Overworld"].connect( + regions[get_paired_region("Overworld Redux, Archipelagos Redux_lowest")], + rule=lambda state: has_stick(state, player)) + # Well rail, west side. Can ls in town, get extra height by going over the portal pad + regions["Overworld"].connect( + regions[get_paired_region("Overworld Redux, Sewer_west_aqueduct")], + rule=lambda state: has_stick(state, player)) + # Well rail, east side. Need some height from the temple stairs + regions["Overworld"].connect( + regions[get_paired_region("Overworld Redux, Furnace_gyro_upper_north")], + rule=lambda state: has_stick(state, player)) + + # Furnace ladder to the fuse entrance + regions["Furnace Ladder Area"].connect( + regions[get_paired_region("Furnace, Overworld Redux_gyro_upper_north")], + rule=lambda state: has_stick(state, player)) + # Furnace ladder to Dark Tomb + regions["Furnace Ladder Area"].connect( + regions[get_paired_region("Furnace, Crypt Redux_")], + rule=lambda state: has_stick(state, player)) + # Furnace ladder to the West Garden connector + regions["Furnace Ladder Area"].connect( + regions[get_paired_region("Furnace, Overworld Redux_gyro_west")], + rule=lambda state: has_stick(state, player)) + + # West Garden exit after Garden Knight + regions["West Garden"].connect( + regions[get_paired_region("Archipelagos Redux, Overworld Redux_upper")], + rule=lambda state: has_stick(state, player)) + # West Garden laurels exit + regions["West Garden"].connect( + regions[get_paired_region("Archipelagos Redux, Overworld Redux_lowest")], + rule=lambda state: has_stick(state, player)) + + # Frog mouth entrance + regions["Ruined Atoll"].connect( + regions[get_paired_region("Atoll Redux, Frog Stairs_mouth")], + rule=lambda state: has_stick(state, player)) + + # Entrance by the dancing fox holy cross spot + regions["East Forest"].connect( + regions[get_paired_region("East Forest Redux, East Forest Redux Laddercave_upper")], + rule=lambda state: has_stick(state, player)) + + # From the west side of guard house 1 to the east side + regions["Guard House 1 West"].connect( + regions[get_paired_region("East Forest Redux Laddercave, East Forest Redux_gate")], + rule=lambda state: has_stick(state, player)) + regions["Guard House 1 West"].connect( + regions[get_paired_region("East Forest Redux Laddercave, Forest Boss Room_")], + rule=lambda state: has_stick(state, player)) + + # Upper exit from the Forest Grave Path, use ls at the ladder by the gate switch + regions["Forest Grave Path Main"].connect( + regions[get_paired_region("Sword Access, East Forest Redux_upper")], + rule=lambda state: has_stick(state, player)) + + # Fortress exterior shop, ls at the ladder by the telescope + regions["Fortress Exterior from Overworld"].connect( + regions[get_paired_region("Fortress Courtyard, Shop_")], + rule=lambda state: has_stick(state, player)) + # Fortress main entry and grave path lower entry, ls at the ladder by the telescope + regions["Fortress Exterior from Overworld"].connect( + regions[get_paired_region("Fortress Courtyard, Fortress Main_Big Door")], + rule=lambda state: has_stick(state, player)) + regions["Fortress Exterior from Overworld"].connect( + regions[get_paired_region("Fortress Courtyard, Fortress Reliquary_Lower")], + rule=lambda state: has_stick(state, player)) + # Upper exits from the courtyard. Use the ramp in the courtyard, then the blocks north of the first fuse + regions["Fortress Exterior from Overworld"].connect( + regions[get_paired_region("Fortress Courtyard, Fortress Reliquary_Upper")], + rule=lambda state: has_stick(state, player)) + regions["Fortress Exterior from Overworld"].connect( + regions[get_paired_region("Fortress Courtyard, Fortress East_")], + rule=lambda state: has_stick(state, player)) + + # same as above, except from the east side of the area + regions["Fortress Exterior from East Forest"].connect( + regions[get_paired_region("Fortress Courtyard, Overworld Redux_")], + rule=lambda state: has_stick(state, player)) + regions["Fortress Exterior from East Forest"].connect( + regions[get_paired_region("Fortress Courtyard, Shop_")], + rule=lambda state: has_stick(state, player)) + regions["Fortress Exterior from East Forest"].connect( + regions[get_paired_region("Fortress Courtyard, Fortress Main_Big Door")], + rule=lambda state: has_stick(state, player)) + regions["Fortress Exterior from East Forest"].connect( + regions[get_paired_region("Fortress Courtyard, Fortress Reliquary_Lower")], + rule=lambda state: has_stick(state, player)) + regions["Fortress Exterior from East Forest"].connect( + regions[get_paired_region("Fortress Courtyard, Fortress Reliquary_Upper")], + rule=lambda state: has_stick(state, player)) + regions["Fortress Exterior from East Forest"].connect( + regions[get_paired_region("Fortress Courtyard, Fortress East_")], + rule=lambda state: has_stick(state, player)) + + # same as above, except from the Beneath the Vault entrance ladder + regions["Fortress Exterior near cave"].connect( + regions[get_paired_region("Fortress Courtyard, Overworld Redux_")], + rule=lambda state: has_stick(state, player)) + regions["Fortress Exterior near cave"].connect( + regions[get_paired_region("Fortress Courtyard, Fortress Main_Big Door")], + rule=lambda state: has_stick(state, player)) + regions["Fortress Exterior near cave"].connect( + regions[get_paired_region("Fortress Courtyard, Fortress Reliquary_Lower")], + rule=lambda state: has_stick(state, player)) + regions["Fortress Exterior near cave"].connect( + regions[get_paired_region("Fortress Courtyard, Fortress Reliquary_Upper")], + rule=lambda state: has_stick(state, player)) + regions["Fortress Exterior near cave"].connect( + regions[get_paired_region("Fortress Courtyard, Fortress East_")], + rule=lambda state: has_stick(state, player)) + + # ls at the ladder, need to gain a little height to get up the stairs + regions["Lower Mountain"].connect( + regions[get_paired_region("Mountain, Mountaintop_")], + rule=lambda state: has_stick(state, player)) + + # Where the rope is behind Monastery. Connecting here since, if you have this region, you don't need a sword + regions["Quarry Monastery Entry"].connect( + regions[get_paired_region("Quarry Redux, Monastery_back")], + rule=lambda state: has_stick(state, player)) + + # Swamp to Gauntlet + regions["Swamp"].connect( + regions[get_paired_region("Swamp Redux 2, Cathedral Arena_")], + rule=lambda state: has_stick(state, player)) + # Swamp to Overworld upper + regions["Swamp"].connect( + regions[get_paired_region("Swamp Redux 2, Overworld Redux_wall")], + rule=lambda state: has_stick(state, player)) + # Ladder by the hero grave + regions["Back of Swamp"].connect( + regions[get_paired_region("Swamp Redux 2, Overworld Redux_conduit")], + rule=lambda state: has_stick(state, player)) + regions["Back of Swamp"].connect( + regions[get_paired_region("Swamp Redux 2, Shop_")], + rule=lambda state: has_stick(state, player)) + # Need to put the cathedral HC code mid-flight + regions["Back of Swamp"].connect( + regions[get_paired_region("Swamp Redux 2, Cathedral Redux_secret")], + rule=lambda state: has_stick(state, player) + and has_ability(state, player, holy_cross, options, ability_unlocks)) + + +def set_er_location_rules(world: "TunicWorld", ability_unlocks: Dict[str, int]) -> None: + player = world.player + multiworld = world.multiworld + options = world.options + forbid_item(multiworld.get_location("Secret Gathering Place - 20 Fairy Reward", player), fairies, player) + + # Ability Shuffle Exclusive Rules + set_rule(multiworld.get_location("East Forest - Dancing Fox Spirit Holy Cross", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Forest Grave Path - Holy Cross Code by Grave", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("East Forest - Golden Obelisk Holy Cross", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Beneath the Well - [Powered Secret Room] Chest", player), + lambda state: state.has("Activate Furnace Fuse", player)) + set_rule(multiworld.get_location("West Garden - [North] Behind Holy Cross Door", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Library Hall - Holy Cross Chest", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Eastern Vault Fortress - [West Wing] Candles Holy Cross", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("West Garden - [Central Highlands] Holy Cross (Blue Lines)", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Quarry - [Back Entrance] Bushes Holy Cross", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Cathedral - Secret Legend Trophy Chest", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + + # Overworld + set_rule(multiworld.get_location("Overworld - [Southwest] Grapple Chest Over Walkway", player), + lambda state: state.has_any({grapple, laurels}, player)) + set_rule(multiworld.get_location("Overworld - [Southwest] West Beach Guarded By Turret 2", player), + lambda state: state.has_any({grapple, laurels}, player)) + set_rule(multiworld.get_location("Overworld - [Southwest] From West Garden", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Overworld - [Southeast] Page on Pillar by Swamp", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Overworld - [Southwest] Fountain Page", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Overworld - [Northwest] Page on Pillar by Dark Tomb", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Old House - Holy Cross Chest", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Overworld - [East] Grapple Chest", player), + lambda state: state.has(grapple, player)) + set_rule(multiworld.get_location("Sealed Temple - Holy Cross Chest", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Caustic Light Cave - Holy Cross Chest", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Cube Cave - Holy Cross Chest", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Old House - Holy Cross Door Page", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Maze Cave - Maze Room Holy Cross", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Old House - Holy Cross Chest", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Patrol Cave - Holy Cross Chest", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Ruined Passage - Holy Cross Chest", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Hourglass Cave - Holy Cross Chest", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Secret Gathering Place - Holy Cross Chest", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Secret Gathering Place - 10 Fairy Reward", player), + lambda state: state.has(fairies, player, 10)) + set_rule(multiworld.get_location("Secret Gathering Place - 20 Fairy Reward", player), + lambda state: state.has(fairies, player, 20)) + set_rule(multiworld.get_location("Coins in the Well - 3 Coins", player), lambda state: state.has(coins, player, 3)) + set_rule(multiworld.get_location("Coins in the Well - 6 Coins", player), lambda state: state.has(coins, player, 6)) + set_rule(multiworld.get_location("Coins in the Well - 10 Coins", player), + lambda state: state.has(coins, player, 10)) + set_rule(multiworld.get_location("Coins in the Well - 15 Coins", player), + lambda state: state.has(coins, player, 15)) + + # East Forest + set_rule(multiworld.get_location("East Forest - Lower Grapple Chest", player), + lambda state: state.has(grapple, player)) + set_rule(multiworld.get_location("East Forest - Lower Dash Chest", player), + lambda state: state.has_all({grapple, laurels}, player)) + set_rule(multiworld.get_location("East Forest - Ice Rod Grapple Chest", player), lambda state: ( + state.has_all({grapple, ice_dagger, fire_wand}, player) and + has_ability(state, player, ice_rod, options, ability_unlocks))) + + # West Garden + set_rule(multiworld.get_location("West Garden - [North] Across From Page Pickup", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("West Garden - [West] In Flooded Walkway", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("West Garden - [West Lowlands] Tree Holy Cross Chest", player), + lambda state: state.has(laurels, player) and has_ability(state, player, holy_cross, options, + ability_unlocks)) + set_rule(multiworld.get_location("West Garden - [East Lowlands] Page Behind Ice Dagger House", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("West Garden - [Central Lowlands] Below Left Walkway", player), + lambda state: state.has(laurels, player)) + + # Ruined Atoll + set_rule(multiworld.get_location("Ruined Atoll - [West] Near Kevin Block", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Ruined Atoll - [East] Locked Room Lower Chest", player), + lambda state: state.has_any({laurels, key}, player)) + set_rule(multiworld.get_location("Ruined Atoll - [East] Locked Room Upper Chest", player), + lambda state: state.has_any({laurels, key}, player)) + + # Frog's Domain + set_rule(multiworld.get_location("Frog's Domain - Side Room Grapple Secret", player), + lambda state: state.has_any({grapple, laurels}, player)) + set_rule(multiworld.get_location("Frog's Domain - Grapple Above Hot Tub", player), + lambda state: state.has_any({grapple, laurels}, player)) + set_rule(multiworld.get_location("Frog's Domain - Escape Chest", player), + lambda state: state.has_any({grapple, laurels}, player)) + + # Eastern Vault Fortress + set_rule(multiworld.get_location("Fortress Arena - Hexagon Red", player), + lambda state: state.has(vault_key, player)) + + # Beneath the Vault + set_rule(multiworld.get_location("Beneath the Fortress - Bridge", player), + lambda state: state.has_group("melee weapons", player, 1) or state.has_any({laurels, fire_wand}, player)) + set_rule(multiworld.get_location("Beneath the Fortress - Obscured Behind Waterfall", player), + lambda state: has_lantern(state, player, options)) + + # Quarry + set_rule(multiworld.get_location("Quarry - [Central] Above Ladder Dash Chest", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Quarry - [West] Upper Area Bombable Wall", player), + lambda state: has_mask(state, player, options)) + + # Ziggurat + set_rule(multiworld.get_location("Rooted Ziggurat Upper - Near Bridge Switch", player), + lambda state: has_sword(state, player) or state.has(fire_wand, player)) + set_rule(multiworld.get_location("Rooted Ziggurat Lower - After Guarded Fuse", player), + lambda state: has_sword(state, player) and has_ability(state, player, prayer, options, ability_unlocks)) + + # Bosses + set_rule(multiworld.get_location("Fortress Arena - Siege Engine/Vault Key Pickup", player), + lambda state: has_sword(state, player)) + set_rule(multiworld.get_location("Librarian - Hexagon Green", player), + lambda state: has_sword(state, player)) + set_rule(multiworld.get_location("Rooted Ziggurat Lower - Hexagon Blue", player), + lambda state: has_sword(state, player)) + + # Swamp + set_rule(multiworld.get_location("Cathedral Gauntlet - Gauntlet Reward", player), + lambda state: state.has(fire_wand, player) and has_sword(state, player)) + set_rule(multiworld.get_location("Swamp - [Entrance] Above Entryway", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Swamp - [South Graveyard] Upper Walkway Dash Chest", player), + lambda state: state.has(laurels, player)) + # these two swamp checks really want you to kill the big skeleton first + set_rule(multiworld.get_location("Swamp - [South Graveyard] 4 Orange Skulls", player), + lambda state: has_sword(state, player)) + set_rule(multiworld.get_location("Swamp - [South Graveyard] Guarded By Tentacles", player), + lambda state: has_sword(state, player)) + + # Hero's Grave and Far Shore + set_rule(multiworld.get_location("Hero's Grave - Tooth Relic", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Hero's Grave - Mushroom Relic", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Hero's Grave - Ash Relic", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Hero's Grave - Flowers Relic", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Hero's Grave - Effigy Relic", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Hero's Grave - Feathers Relic", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Far Shore - Secret Chest", player), + lambda state: state.has(laurels, player)) + + # Events + set_rule(multiworld.get_location("Eastern Bell", player), + lambda state: (has_stick(state, player) or state.has(fire_wand, player))) + set_rule(multiworld.get_location("Western Bell", player), + lambda state: (has_stick(state, player) or state.has(fire_wand, player))) + set_rule(multiworld.get_location("Furnace Fuse", player), + lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + set_rule(multiworld.get_location("South and West Fortress Exterior Fuses", player), + lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + set_rule(multiworld.get_location("Upper and Central Fortress Exterior Fuses", player), + lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + set_rule(multiworld.get_location("Beneath the Vault Fuse", player), + lambda state: state.has("Activate South and West Fortress Exterior Fuses", player)) + set_rule(multiworld.get_location("Eastern Vault West Fuses", player), + lambda state: state.has("Activate Beneath the Vault Fuse", player)) + set_rule(multiworld.get_location("Eastern Vault East Fuse", player), + lambda state: state.has_all({"Activate Upper and Central Fortress Exterior Fuses", + "Activate South and West Fortress Exterior Fuses"}, player)) + set_rule(multiworld.get_location("Quarry Connector Fuse", player), + lambda state: has_ability(state, player, prayer, options, ability_unlocks) and state.has(grapple, player)) + set_rule(multiworld.get_location("Quarry Fuse", player), + lambda state: state.has("Activate Quarry Connector Fuse", player)) + set_rule(multiworld.get_location("Ziggurat Fuse", player), + lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + set_rule(multiworld.get_location("West Garden Fuse", player), + lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + set_rule(multiworld.get_location("Library Fuse", player), + lambda state: has_ability(state, player, prayer, options, ability_unlocks)) diff --git a/worlds/tunic/er_scripts.py b/worlds/tunic/er_scripts.py new file mode 100644 index 000000000000..84b97e13daad --- /dev/null +++ b/worlds/tunic/er_scripts.py @@ -0,0 +1,453 @@ +from typing import Dict, List, Set, Tuple, TYPE_CHECKING +from BaseClasses import Region, ItemClassification, Item, Location +from .locations import location_table +from .er_data import Portal, tunic_er_regions, portal_mapping, hallway_helper, hallway_helper_nmg, \ + dependent_regions, dependent_regions_nmg, dependent_regions_ur +from .er_rules import set_er_region_rules + +if TYPE_CHECKING: + from . import TunicWorld + + +class TunicERItem(Item): + game: str = "Tunic" + + +class TunicERLocation(Location): + game: str = "Tunic" + + +def create_er_regions(world: "TunicWorld") -> Tuple[Dict[Portal, Portal], Dict[int, str]]: + regions: Dict[str, Region] = {} + portal_pairs: Dict[Portal, Portal] = pair_portals(world) + logic_rules = world.options.logic_rules + + # check if a portal leads to a hallway. if it does, update the hint text accordingly + def hint_helper(portal: Portal, hint_string: str = "") -> str: + # start by setting it as the name of the portal, for the case we're not using the hallway helper + if hint_string == "": + hint_string = portal.name + + if logic_rules: + hallways = hallway_helper_nmg + else: + hallways = hallway_helper + + if portal.scene_destination() in hallways: + # if we have a hallway, we want the region rather than the portal name + if hint_string == portal.name: + hint_string = portal.region + # library exterior is two regions, we just want to fix up the name + if hint_string in {"Library Exterior Tree", "Library Exterior Ladder"}: + hint_string = "Library Exterior" + + # search through the list for the other end of the hallway + for portala, portalb in portal_pairs.items(): + if portala.scene_destination() == hallways[portal.scene_destination()]: + # if we find that we have a chain of hallways, do recursion + if portalb.scene_destination() in hallways: + hint_region = portalb.region + if hint_region in {"Library Exterior Tree", "Library Exterior Ladder"}: + hint_region = "Library Exterior" + hint_string = hint_region + " then " + hint_string + hint_string = hint_helper(portalb, hint_string) + else: + # if we didn't find a chain, get the portal name for the end of the chain + hint_string = portalb.name + " then " + hint_string + return hint_string + # and then the same thing for the other portal, since we have to check each separately + if portalb.scene_destination() == hallways[portal.scene_destination()]: + if portala.scene_destination() in hallways: + hint_region = portala.region + if hint_region in {"Library Exterior Tree", "Library Exterior Ladder"}: + hint_region = "Library Exterior" + hint_string = hint_region + " then " + hint_string + hint_string = hint_helper(portala, hint_string) + else: + hint_string = portala.name + " then " + hint_string + return hint_string + return hint_string + + # create our regions, give them hint text if they're in a spot where it makes sense to + for region_name, region_data in tunic_er_regions.items(): + hint_text = "error" + if region_data.hint == 1: + for portal1, portal2 in portal_pairs.items(): + if portal1.region == region_name: + hint_text = hint_helper(portal2) + break + if portal2.region == region_name: + hint_text = hint_helper(portal1) + break + regions[region_name] = Region(region_name, world.player, world.multiworld, hint_text) + elif region_data.hint == 2: + for portal1, portal2 in portal_pairs.items(): + if portal1.scene() == tunic_er_regions[region_name].game_scene: + hint_text = hint_helper(portal2) + break + if portal2.scene() == tunic_er_regions[region_name].game_scene: + hint_text = hint_helper(portal1) + break + regions[region_name] = Region(region_name, world.player, world.multiworld, hint_text) + elif region_data.hint == 3: + # only the west garden portal item for now + if region_name == "West Garden Portal Item": + if world.options.logic_rules: + for portal1, portal2 in portal_pairs.items(): + if portal1.scene() == "Archipelagos Redux": + hint_text = hint_helper(portal2) + break + if portal2.scene() == "Archipelagos Redux": + hint_text = hint_helper(portal1) + break + regions[region_name] = Region(region_name, world.player, world.multiworld, hint_text) + else: + for portal1, portal2 in portal_pairs.items(): + if portal1.region == "West Garden Portal": + hint_text = hint_helper(portal2) + break + if portal2.region == "West Garden Portal": + hint_text = hint_helper(portal1) + break + regions[region_name] = Region(region_name, world.player, world.multiworld, hint_text) + else: + regions[region_name] = Region(region_name, world.player, world.multiworld) + + set_er_region_rules(world, world.ability_unlocks, regions, portal_pairs) + + er_hint_data: Dict[int, str] = {} + for location_name, location_id in world.location_name_to_id.items(): + region = regions[location_table[location_name].er_region] + location = TunicERLocation(world.player, location_name, location_id, region) + region.locations.append(location) + if region.name == region.hint_text: + continue + er_hint_data[location.address] = region.hint_text + + create_randomized_entrances(portal_pairs, regions) + + for region in regions.values(): + world.multiworld.regions.append(region) + + place_event_items(world, regions) + + victory_region = regions["Spirit Arena Victory"] + victory_location = TunicERLocation(world.player, "The Heir", None, victory_region) + victory_location.place_locked_item(TunicERItem("Victory", ItemClassification.progression, None, world.player)) + world.multiworld.completion_condition[world.player] = lambda state: state.has("Victory", world.player) + victory_region.locations.append(victory_location) + + portals_and_hints = (portal_pairs, er_hint_data) + + return portals_and_hints + + +tunic_events: Dict[str, str] = { + "Eastern Bell": "Forest Belltower Upper", + "Western Bell": "Overworld Belltower", + "Furnace Fuse": "Furnace Fuse", + "South and West Fortress Exterior Fuses": "Fortress Exterior from Overworld", + "Upper and Central Fortress Exterior Fuses": "Fortress Courtyard Upper", + "Beneath the Vault Fuse": "Beneath the Vault Back", + "Eastern Vault West Fuses": "Eastern Vault Fortress", + "Eastern Vault East Fuse": "Eastern Vault Fortress", + "Quarry Connector Fuse": "Quarry Connector", + "Quarry Fuse": "Quarry", + "Ziggurat Fuse": "Rooted Ziggurat Lower Back", + "West Garden Fuse": "West Garden", + "Library Fuse": "Library Lab", +} + + +def place_event_items(world: "TunicWorld", regions: Dict[str, Region]) -> None: + for event_name, region_name in tunic_events.items(): + region = regions[region_name] + location = TunicERLocation(world.player, event_name, None, region) + if event_name.endswith("Bell"): + location.place_locked_item( + TunicERItem("Ring " + event_name, ItemClassification.progression, None, world.player)) + else: + location.place_locked_item( + TunicERItem("Activate " + event_name, ItemClassification.progression, None, world.player)) + region.locations.append(location) + + +# pairing off portals, starting with dead ends +def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]: + # separate the portals into dead ends and non-dead ends + portal_pairs: Dict[Portal, Portal] = {} + dead_ends: List[Portal] = [] + two_plus: List[Portal] = [] + fixed_shop = False + logic_rules = world.options.logic_rules.value + + # create separate lists for dead ends and non-dead ends + if logic_rules: + for portal in portal_mapping: + if tunic_er_regions[portal.region].dead_end == 1: + dead_ends.append(portal) + else: + two_plus.append(portal) + else: + for portal in portal_mapping: + if tunic_er_regions[portal.region].dead_end: + dead_ends.append(portal) + else: + two_plus.append(portal) + + connected_regions: Set[str] = set() + # make better start region stuff when/if implementing random start + start_region = "Overworld" + connected_regions.update(add_dependent_regions(start_region, logic_rules)) + + # need to plando fairy cave, or it could end up laurels locked + # fix this later to be random? probably not? + if world.options.laurels_location == "10_fairies": + portal1 = None + portal2 = None + for portal in two_plus: + if portal.scene_destination() == "Overworld Redux, Waterfall_": + portal1 = portal + break + for portal in dead_ends: + if portal.scene_destination() == "Waterfall, Overworld Redux_": + portal2 = portal + break + portal_pairs[portal1] = portal2 + two_plus.remove(portal1) + dead_ends.remove(portal2) + + if world.options.fixed_shop: + fixed_shop = True + portal1 = None + for portal in two_plus: + if portal.scene_destination() == "Overworld Redux, Windmill_": + portal1 = portal + break + portal2 = Portal(name="Shop Portal", region=f"Shop Entrance 2", destination="Previous Region_") + portal_pairs[portal1] = portal2 + two_plus.remove(portal1) + + # we want to start by making sure every region is accessible + non_dead_end_regions = set() + for region_name, region_info in tunic_er_regions.items(): + if not region_info.dead_end: + non_dead_end_regions.add(region_name) + elif region_info.dead_end == 2 and logic_rules: + non_dead_end_regions.add(region_name) + + world.random.shuffle(two_plus) + check_success = 0 + portal1 = None + portal2 = None + while len(connected_regions) < len(non_dead_end_regions): + # find a portal in an inaccessible region + if check_success == 0: + for portal in two_plus: + if portal.region in connected_regions: + # if there's risk of self-locking, start over + if gate_before_switch(portal, two_plus): + world.random.shuffle(two_plus) + break + portal1 = portal + two_plus.remove(portal) + check_success = 1 + break + + # then we find a portal in a connected region + if check_success == 1: + for portal in two_plus: + if portal.region not in connected_regions: + # if there's risk of self-locking, shuffle and try again + if gate_before_switch(portal, two_plus): + world.random.shuffle(two_plus) + break + portal2 = portal + two_plus.remove(portal) + check_success = 2 + break + + # once we have both portals, connect them and add the new region(s) to connected_regions + if check_success == 2: + connected_regions.update(add_dependent_regions(portal2.region, logic_rules)) + portal_pairs[portal1] = portal2 + check_success = 0 + world.random.shuffle(two_plus) + + # add 6 shops, connect them to unique scenes + # this is due to a limitation in Tunic -- you wrong warp if there's multiple shops + shop_scenes: Set[str] = set() + shop_count = 6 + + if fixed_shop: + shop_count = 1 + shop_scenes.add("Overworld Redux") + + for i in range(shop_count): + portal1 = None + for portal in two_plus: + if portal.scene() not in shop_scenes: + shop_scenes.add(portal.scene()) + portal1 = portal + two_plus.remove(portal) + break + if portal1 is None: + raise Exception("Too many shops in the pool, or something else went wrong") + portal2 = Portal(name="Shop Portal", region=f"Shop Entrance {i + 1}", destination="Previous Region_") + portal_pairs[portal1] = portal2 + + # connect dead ends to random non-dead ends + # none of the key events are in dead ends, so we don't need to do gate_before_switch + while len(dead_ends) > 0: + portal1 = two_plus.pop() + portal2 = dead_ends.pop() + portal_pairs[portal1] = portal2 + + # then randomly connect the remaining portals to each other + # every region is accessible, so gate_before_switch is not necessary + while len(two_plus) > 1: + portal1 = two_plus.pop() + portal2 = two_plus.pop() + portal_pairs[portal1] = portal2 + + if len(two_plus) == 1: + raise Exception("two plus had an odd number of portals, investigate this") + + for portal1, portal2 in portal_pairs.items(): + world.multiworld.spoiler.set_entrance(portal1.name, portal2.name, "both", world.player) + + return portal_pairs + + +# loop through our list of paired portals and make two-way connections +def create_randomized_entrances(portal_pairs: Dict[Portal, Portal], regions: Dict[str, Region]) -> None: + for portal1, portal2 in portal_pairs.items(): + region1 = regions[portal1.region] + region2 = regions[portal2.region] + region1.connect(region2, f"{portal1.name} -> {portal2.name}") + # prevent the logic from thinking you can get to any shop-connected region from the shop + if portal2.name != "Shop": + region2.connect(region1, f"{portal2.name} -> {portal1.name}") + + +# loop through the static connections, return regions you can reach from this region +def add_dependent_regions(region_name: str, logic_rules: int) -> Set[str]: + region_set = set() + if not logic_rules: + regions_to_add = dependent_regions + elif logic_rules == 1: + regions_to_add = dependent_regions_nmg + else: + regions_to_add = dependent_regions_ur + for origin_regions, destination_regions in regions_to_add.items(): + if region_name in origin_regions: + # if you matched something in the first set, you get the regions in its paired set + region_set.update(destination_regions) + return region_set + # if you didn't match anything in the first sets, just gives you the region + region_set = {region_name} + return region_set + + +# we're checking if an event-locked portal is being placed before the regions where its key(s) is/are +# doing this ensures the keys will not be locked behind the event-locked portal +def gate_before_switch(check_portal: Portal, two_plus: List[Portal]) -> bool: + # the western belltower cannot be locked since you can access it with laurels + # so we only need to make sure the forest belltower isn't locked + if check_portal.scene_destination() == "Overworld Redux, Temple_main": + i = 0 + for portal in two_plus: + if portal.region == "Forest Belltower Upper": + i += 1 + break + if i == 1: + return True + + # fortress big gold door needs 2 scenes and one of the two upper portals of the courtyard + elif check_portal.scene_destination() == "Fortress Main, Fortress Arena_": + i = j = k = 0 + for portal in two_plus: + if portal.region == "Fortress Courtyard Upper": + i += 1 + if portal.scene() == "Fortress Basement": + j += 1 + if portal.region == "Eastern Vault Fortress": + k += 1 + if i == 2 or j == 2 or k == 5: + return True + + # fortress teleporter needs only the left fuses + elif check_portal.scene_destination() in ["Fortress Arena, Transit_teleporter_spidertank", + "Transit, Fortress Arena_teleporter_spidertank"]: + i = j = k = 0 + for portal in two_plus: + if portal.scene() == "Fortress Courtyard": + i += 1 + if portal.scene() == "Fortress Basement": + j += 1 + if portal.region == "Eastern Vault Fortress": + k += 1 + if i == 8 or j == 2 or k == 5: + return True + + # Cathedral door needs Overworld and the front of Swamp + # Overworld is currently guaranteed, so no need to check it + elif check_portal.scene_destination() == "Swamp Redux 2, Cathedral Redux_main": + i = 0 + for portal in two_plus: + if portal.region == "Swamp": + i += 1 + if i == 4: + return True + + # Zig portal room exit needs Zig 3 to be accessible to hit the fuse + elif check_portal.scene_destination() == "ziggurat2020_FTRoom, ziggurat2020_3_": + i = 0 + for portal in two_plus: + if portal.scene() == "ziggurat2020_3": + i += 1 + if i == 2: + return True + + # Quarry teleporter needs you to hit the Darkwoods fuse + # Since it's physically in Quarry, we don't need to check for it + elif check_portal.scene_destination() in ["Quarry Redux, Transit_teleporter_quarry teleporter", + "Quarry Redux, ziggurat2020_0_"]: + i = 0 + for portal in two_plus: + if portal.scene() == "Darkwoods Tunnel": + i += 1 + if i == 2: + return True + + # Same as above, but Quarry isn't guaranteed here + elif check_portal.scene_destination() == "Transit, Quarry Redux_teleporter_quarry teleporter": + i = j = 0 + for portal in two_plus: + if portal.scene() == "Darkwoods Tunnel": + i += 1 + if portal.scene() == "Quarry Redux": + j += 1 + if i == 2 or j == 7: + return True + + # Need Library fuse to use this teleporter + elif check_portal.scene_destination() == "Transit, Library Lab_teleporter_library teleporter": + i = 0 + for portal in two_plus: + if portal.scene() == "Library Lab": + i += 1 + if i == 3: + return True + + # Need West Garden fuse to use this teleporter + elif check_portal.scene_destination() == "Transit, Archipelagos Redux_teleporter_archipelagos_teleporter": + i = 0 + for portal in two_plus: + if portal.scene() == "Archipelagos Redux": + i += 1 + if i == 6: + return True + + # false means you're good to place the portal + return False diff --git a/worlds/tunic/items.py b/worlds/tunic/items.py new file mode 100644 index 000000000000..16608620c6e3 --- /dev/null +++ b/worlds/tunic/items.py @@ -0,0 +1,214 @@ +from itertools import groupby +from typing import Dict, List, Set, NamedTuple +from BaseClasses import ItemClassification + + +class TunicItemData(NamedTuple): + classification: ItemClassification + quantity_in_item_pool: int + item_id_offset: int + item_group: str = "" + + +item_base_id = 509342400 + +item_table: Dict[str, TunicItemData] = { + "Firecracker x2": TunicItemData(ItemClassification.filler, 3, 0, "bombs"), + "Firecracker x3": TunicItemData(ItemClassification.filler, 3, 1, "bombs"), + "Firecracker x4": TunicItemData(ItemClassification.filler, 3, 2, "bombs"), + "Firecracker x5": TunicItemData(ItemClassification.filler, 1, 3, "bombs"), + "Firecracker x6": TunicItemData(ItemClassification.filler, 2, 4, "bombs"), + "Fire Bomb x2": TunicItemData(ItemClassification.filler, 2, 5, "bombs"), + "Fire Bomb x3": TunicItemData(ItemClassification.filler, 1, 6, "bombs"), + "Ice Bomb x2": TunicItemData(ItemClassification.filler, 2, 7, "bombs"), + "Ice Bomb x3": TunicItemData(ItemClassification.filler, 2, 8, "bombs"), + "Ice Bomb x5": TunicItemData(ItemClassification.filler, 1, 9, "bombs"), + "Lure": TunicItemData(ItemClassification.filler, 4, 10, "consumables"), + "Lure x2": TunicItemData(ItemClassification.filler, 1, 11, "consumables"), + "Pepper x2": TunicItemData(ItemClassification.filler, 4, 12, "consumables"), + "Ivy x3": TunicItemData(ItemClassification.filler, 2, 13, "consumables"), + "Effigy": TunicItemData(ItemClassification.useful, 12, 14, "money"), + "HP Berry": TunicItemData(ItemClassification.filler, 2, 15, "consumables"), + "HP Berry x2": TunicItemData(ItemClassification.filler, 4, 16, "consumables"), + "HP Berry x3": TunicItemData(ItemClassification.filler, 2, 17, "consumables"), + "MP Berry": TunicItemData(ItemClassification.filler, 4, 18, "consumables"), + "MP Berry x2": TunicItemData(ItemClassification.filler, 2, 19, "consumables"), + "MP Berry x3": TunicItemData(ItemClassification.filler, 7, 20, "consumables"), + "Fairy": TunicItemData(ItemClassification.progression, 20, 21), + "Stick": TunicItemData(ItemClassification.progression, 1, 22, "weapons"), + "Sword": TunicItemData(ItemClassification.progression, 3, 23, "weapons"), + "Sword Upgrade": TunicItemData(ItemClassification.progression, 4, 24, "weapons"), + "Magic Wand": TunicItemData(ItemClassification.progression, 1, 25, "weapons"), + "Magic Dagger": TunicItemData(ItemClassification.progression, 1, 26), + "Magic Orb": TunicItemData(ItemClassification.progression, 1, 27), + "Hero's Laurels": TunicItemData(ItemClassification.progression, 1, 28), + "Lantern": TunicItemData(ItemClassification.progression, 1, 29), + "Gun": TunicItemData(ItemClassification.useful, 1, 30, "weapons"), + "Shield": TunicItemData(ItemClassification.useful, 1, 31), + "Dath Stone": TunicItemData(ItemClassification.useful, 1, 32), + "Hourglass": TunicItemData(ItemClassification.useful, 1, 33), + "Old House Key": TunicItemData(ItemClassification.progression, 1, 34, "keys"), + "Key": TunicItemData(ItemClassification.progression, 2, 35, "keys"), + "Fortress Vault Key": TunicItemData(ItemClassification.progression, 1, 36, "keys"), + "Flask Shard": TunicItemData(ItemClassification.useful, 12, 37, "potions"), + "Potion Flask": TunicItemData(ItemClassification.useful, 5, 38, "potions"), + "Golden Coin": TunicItemData(ItemClassification.progression, 17, 39), + "Card Slot": TunicItemData(ItemClassification.useful, 4, 40), + "Red Questagon": TunicItemData(ItemClassification.progression_skip_balancing, 1, 41, "hexagons"), + "Green Questagon": TunicItemData(ItemClassification.progression_skip_balancing, 1, 42, "hexagons"), + "Blue Questagon": TunicItemData(ItemClassification.progression_skip_balancing, 1, 43, "hexagons"), + "Gold Questagon": TunicItemData(ItemClassification.progression_skip_balancing, 0, 44, "hexagons"), + "ATT Offering": TunicItemData(ItemClassification.useful, 4, 45, "offerings"), + "DEF Offering": TunicItemData(ItemClassification.useful, 4, 46, "offerings"), + "Potion Offering": TunicItemData(ItemClassification.useful, 3, 47, "offerings"), + "HP Offering": TunicItemData(ItemClassification.useful, 6, 48, "offerings"), + "MP Offering": TunicItemData(ItemClassification.useful, 3, 49, "offerings"), + "SP Offering": TunicItemData(ItemClassification.useful, 2, 50, "offerings"), + "Hero Relic - ATT": TunicItemData(ItemClassification.useful, 1, 51, "hero relics"), + "Hero Relic - DEF": TunicItemData(ItemClassification.useful, 1, 52, "hero relics"), + "Hero Relic - HP": TunicItemData(ItemClassification.useful, 1, 53, "hero relics"), + "Hero Relic - MP": TunicItemData(ItemClassification.useful, 1, 54, "hero relics"), + "Hero Relic - POTION": TunicItemData(ItemClassification.useful, 1, 55, "hero relics"), + "Hero Relic - SP": TunicItemData(ItemClassification.useful, 1, 56, "hero relics"), + "Orange Peril Ring": TunicItemData(ItemClassification.useful, 1, 57, "cards"), + "Tincture": TunicItemData(ItemClassification.useful, 1, 58, "cards"), + "Scavenger Mask": TunicItemData(ItemClassification.progression, 1, 59, "cards"), + "Cyan Peril Ring": TunicItemData(ItemClassification.useful, 1, 60, "cards"), + "Bracer": TunicItemData(ItemClassification.useful, 1, 61, "cards"), + "Dagger Strap": TunicItemData(ItemClassification.useful, 1, 62, "cards"), + "Inverted Ash": TunicItemData(ItemClassification.useful, 1, 63, "cards"), + "Lucky Cup": TunicItemData(ItemClassification.useful, 1, 64, "cards"), + "Magic Echo": TunicItemData(ItemClassification.useful, 1, 65, "cards"), + "Anklet": TunicItemData(ItemClassification.useful, 1, 66, "cards"), + "Muffling Bell": TunicItemData(ItemClassification.useful, 1, 67, "cards"), + "Glass Cannon": TunicItemData(ItemClassification.useful, 1, 68, "cards"), + "Perfume": TunicItemData(ItemClassification.useful, 1, 69, "cards"), + "Louder Echo": TunicItemData(ItemClassification.useful, 1, 70, "cards"), + "Aura's Gem": TunicItemData(ItemClassification.useful, 1, 71, "cards"), + "Bone Card": TunicItemData(ItemClassification.useful, 1, 72, "cards"), + "Mr Mayor": TunicItemData(ItemClassification.useful, 1, 73, "golden treasures"), + "Secret Legend": TunicItemData(ItemClassification.useful, 1, 74, "golden treasures"), + "Sacred Geometry": TunicItemData(ItemClassification.useful, 1, 75, "golden treasures"), + "Vintage": TunicItemData(ItemClassification.useful, 1, 76, "golden treasures"), + "Just Some Pals": TunicItemData(ItemClassification.useful, 1, 77, "golden treasures"), + "Regal Weasel": TunicItemData(ItemClassification.useful, 1, 78, "golden treasures"), + "Spring Falls": TunicItemData(ItemClassification.useful, 1, 79, "golden treasures"), + "Power Up": TunicItemData(ItemClassification.useful, 1, 80, "golden treasures"), + "Back To Work": TunicItemData(ItemClassification.useful, 1, 81, "golden treasures"), + "Phonomath": TunicItemData(ItemClassification.useful, 1, 82, "golden treasures"), + "Dusty": TunicItemData(ItemClassification.useful, 1, 83, "golden treasures"), + "Forever Friend": TunicItemData(ItemClassification.useful, 1, 84, "golden treasures"), + "Fool Trap": TunicItemData(ItemClassification.trap, 0, 85, "fool"), + "Money x1": TunicItemData(ItemClassification.filler, 3, 86, "money"), + "Money x10": TunicItemData(ItemClassification.filler, 1, 87, "money"), + "Money x15": TunicItemData(ItemClassification.filler, 10, 88, "money"), + "Money x16": TunicItemData(ItemClassification.filler, 1, 89, "money"), + "Money x20": TunicItemData(ItemClassification.filler, 17, 90, "money"), + "Money x25": TunicItemData(ItemClassification.filler, 14, 91, "money"), + "Money x30": TunicItemData(ItemClassification.filler, 4, 92, "money"), + "Money x32": TunicItemData(ItemClassification.filler, 4, 93, "money"), + "Money x40": TunicItemData(ItemClassification.filler, 3, 94, "money"), + "Money x48": TunicItemData(ItemClassification.filler, 1, 95, "money"), + "Money x50": TunicItemData(ItemClassification.filler, 7, 96, "money"), + "Money x64": TunicItemData(ItemClassification.filler, 1, 97, "money"), + "Money x100": TunicItemData(ItemClassification.filler, 5, 98, "money"), + "Money x128": TunicItemData(ItemClassification.useful, 3, 99, "money"), + "Money x200": TunicItemData(ItemClassification.useful, 1, 100, "money"), + "Money x255": TunicItemData(ItemClassification.useful, 1, 101, "money"), + "Pages 0-1": TunicItemData(ItemClassification.useful, 1, 102, "pages"), + "Pages 2-3": TunicItemData(ItemClassification.useful, 1, 103, "pages"), + "Pages 4-5": TunicItemData(ItemClassification.useful, 1, 104, "pages"), + "Pages 6-7": TunicItemData(ItemClassification.useful, 1, 105, "pages"), + "Pages 8-9": TunicItemData(ItemClassification.useful, 1, 106, "pages"), + "Pages 10-11": TunicItemData(ItemClassification.useful, 1, 107, "pages"), + "Pages 12-13": TunicItemData(ItemClassification.useful, 1, 108, "pages"), + "Pages 14-15": TunicItemData(ItemClassification.useful, 1, 109, "pages"), + "Pages 16-17": TunicItemData(ItemClassification.useful, 1, 110, "pages"), + "Pages 18-19": TunicItemData(ItemClassification.useful, 1, 111, "pages"), + "Pages 20-21": TunicItemData(ItemClassification.useful, 1, 112, "pages"), + "Pages 22-23": TunicItemData(ItemClassification.useful, 1, 113, "pages"), + "Pages 24-25 (Prayer)": TunicItemData(ItemClassification.progression, 1, 114, "pages"), + "Pages 26-27": TunicItemData(ItemClassification.useful, 1, 115, "pages"), + "Pages 28-29": TunicItemData(ItemClassification.useful, 1, 116, "pages"), + "Pages 30-31": TunicItemData(ItemClassification.useful, 1, 117, "pages"), + "Pages 32-33": TunicItemData(ItemClassification.useful, 1, 118, "pages"), + "Pages 34-35": TunicItemData(ItemClassification.useful, 1, 119, "pages"), + "Pages 36-37": TunicItemData(ItemClassification.useful, 1, 120, "pages"), + "Pages 38-39": TunicItemData(ItemClassification.useful, 1, 121, "pages"), + "Pages 40-41": TunicItemData(ItemClassification.useful, 1, 122, "pages"), + "Pages 42-43 (Holy Cross)": TunicItemData(ItemClassification.progression, 1, 123, "pages"), + "Pages 44-45": TunicItemData(ItemClassification.useful, 1, 124, "pages"), + "Pages 46-47": TunicItemData(ItemClassification.useful, 1, 125, "pages"), + "Pages 48-49": TunicItemData(ItemClassification.useful, 1, 126, "pages"), + "Pages 50-51": TunicItemData(ItemClassification.useful, 1, 127, "pages"), + "Pages 52-53 (Ice Rod)": TunicItemData(ItemClassification.progression, 1, 128, "pages"), + "Pages 54-55": TunicItemData(ItemClassification.useful, 1, 129, "pages"), +} + +fool_tiers: List[List[str]] = [ + [], + ["Money x1", "Money x10", "Money x15", "Money x16"], + ["Money x1", "Money x10", "Money x15", "Money x16", "Money x20"], + ["Money x1", "Money x10", "Money x15", "Money x16", "Money x20", "Money x25", "Money x30"], +] + +slot_data_item_names = [ + "Stick", + "Sword", + "Sword Upgrade", + "Magic Dagger", + "Magic Wand", + "Magic Orb", + "Hero's Laurels", + "Lantern", + "Gun", + "Scavenger Mask", + "Shield", + "Dath Stone", + "Hourglass", + "Old House Key", + "Fortress Vault Key", + "Hero Relic - ATT", + "Hero Relic - DEF", + "Hero Relic - POTION", + "Hero Relic - HP", + "Hero Relic - SP", + "Hero Relic - MP", + "Pages 24-25 (Prayer)", + "Pages 42-43 (Holy Cross)", + "Pages 52-53 (Ice Rod)", + "Red Questagon", + "Green Questagon", + "Blue Questagon", + "Gold Questagon", +] + +item_name_to_id: Dict[str, int] = {name: item_base_id + data.item_id_offset for name, data in item_table.items()} + +filler_items: List[str] = [name for name, data in item_table.items() if data.classification == ItemClassification.filler] + + +def get_item_group(item_name: str) -> str: + return item_table[item_name].item_group + + +item_name_groups: Dict[str, Set[str]] = { + group: set(item_names) for group, item_names in groupby(sorted(item_table, key=get_item_group), get_item_group) if group != "" +} + +# extra groups for the purpose of aliasing items +extra_groups: Dict[str, Set[str]] = { + "laurels": {"Hero's Laurels"}, + "orb": {"Magic Orb"}, + "dagger": {"Magic Dagger"}, + "magic rod": {"Magic Wand"}, + "holy cross": {"Pages 42-43 (Holy Cross)"}, + "prayer": {"Pages 24-25 (Prayer)"}, + "ice rod": {"Pages 52-53 (Ice Rod)"}, + "melee weapons": {"Stick", "Sword", "Sword Upgrade"}, + "progressive sword": {"Sword Upgrade"}, + "abilities": {"Pages 24-25 (Prayer)", "Pages 42-43 (Holy Cross)", "Pages 52-53 (Ice Rod)"}, + "questagons": {"Red Questagon", "Green Questagon", "Blue Questagon", "Gold Questagon"} +} + +item_name_groups.update(extra_groups) diff --git a/worlds/tunic/locations.py b/worlds/tunic/locations.py new file mode 100644 index 000000000000..1501fb7da24d --- /dev/null +++ b/worlds/tunic/locations.py @@ -0,0 +1,337 @@ +from typing import Dict, NamedTuple, Set +from itertools import groupby + + +class TunicLocationData(NamedTuple): + region: str + er_region: str # entrance rando region + location_group: str = "region" + + +location_base_id = 509342400 + +location_table: Dict[str, TunicLocationData] = { + "Beneath the Well - [Powered Secret Room] Chest": TunicLocationData("Beneath the Well", "Beneath the Well Back"), + "Beneath the Well - [Entryway] Chest": TunicLocationData("Beneath the Well", "Beneath the Well Main"), + "Beneath the Well - [Third Room] Beneath Platform Chest": TunicLocationData("Beneath the Well", "Beneath the Well Main"), + "Beneath the Well - [Third Room] Tentacle Chest": TunicLocationData("Beneath the Well", "Beneath the Well Main"), + "Beneath the Well - [Entryway] Obscured Behind Waterfall": TunicLocationData("Beneath the Well", "Beneath the Well Main"), + "Beneath the Well - [Save Room] Upper Floor Chest 1": TunicLocationData("Beneath the Well", "Beneath the Well Back"), + "Beneath the Well - [Save Room] Upper Floor Chest 2": TunicLocationData("Beneath the Well", "Beneath the Well Back"), + "Beneath the Well - [Second Room] Underwater Chest": TunicLocationData("Beneath the Well", "Beneath the Well Main"), + "Beneath the Well - [Back Corridor] Right Secret": TunicLocationData("Beneath the Well", "Beneath the Well Main"), + "Beneath the Well - [Back Corridor] Left Secret": TunicLocationData("Beneath the Well", "Beneath the Well Main"), + "Beneath the Well - [Second Room] Obscured Behind Waterfall": TunicLocationData("Beneath the Well", "Beneath the Well Main"), + "Beneath the Well - [Side Room] Chest By Pots": TunicLocationData("Beneath the Well", "Beneath the Well Main"), + "Beneath the Well - [Side Room] Chest By Phrends": TunicLocationData("Beneath the Well", "Beneath the Well Back"), + "Beneath the Well - [Second Room] Page": TunicLocationData("Beneath the Well", "Beneath the Well Main"), + "Dark Tomb Checkpoint - [Passage To Dark Tomb] Page Pickup": TunicLocationData("Beneath the Well", "Dark Tomb Checkpoint"), + "Cathedral - [1F] Guarded By Lasers": TunicLocationData("Cathedral", "Cathedral"), + "Cathedral - [1F] Near Spikes": TunicLocationData("Cathedral", "Cathedral"), + "Cathedral - [2F] Bird Room": TunicLocationData("Cathedral", "Cathedral"), + "Cathedral - [2F] Entryway Upper Walkway": TunicLocationData("Cathedral", "Cathedral"), + "Cathedral - [1F] Library": TunicLocationData("Cathedral", "Cathedral"), + "Cathedral - [2F] Library": TunicLocationData("Cathedral", "Cathedral"), + "Cathedral - [2F] Guarded By Lasers": TunicLocationData("Cathedral", "Cathedral"), + "Cathedral - [2F] Bird Room Secret": TunicLocationData("Cathedral", "Cathedral"), + "Cathedral - [1F] Library Secret": TunicLocationData("Cathedral", "Cathedral"), + "Dark Tomb - Spike Maze Near Exit": TunicLocationData("Dark Tomb", "Dark Tomb Main"), + "Dark Tomb - 2nd Laser Room": TunicLocationData("Dark Tomb", "Dark Tomb Main"), + "Dark Tomb - 1st Laser Room": TunicLocationData("Dark Tomb", "Dark Tomb Main"), + "Dark Tomb - Spike Maze Upper Walkway": TunicLocationData("Dark Tomb", "Dark Tomb Main"), + "Dark Tomb - Skulls Chest": TunicLocationData("Dark Tomb", "Dark Tomb Main"), + "Dark Tomb - Spike Maze Near Stairs": TunicLocationData("Dark Tomb", "Dark Tomb Main"), + "Dark Tomb - 1st Laser Room Obscured": TunicLocationData("Dark Tomb", "Dark Tomb Main"), + "Guardhouse 2 - Upper Floor": TunicLocationData("East Forest", "Guard House 2"), + "Guardhouse 2 - Bottom Floor Secret": TunicLocationData("East Forest", "Guard House 2"), + "Guardhouse 1 - Upper Floor Obscured": TunicLocationData("East Forest", "Guard House 1 East"), + "Guardhouse 1 - Upper Floor": TunicLocationData("East Forest", "Guard House 1 East"), + "East Forest - Dancing Fox Spirit Holy Cross": TunicLocationData("East Forest", "East Forest Dance Fox Spot", "holy cross"), + "East Forest - Golden Obelisk Holy Cross": TunicLocationData("East Forest", "East Forest", "holy cross"), + "East Forest - Ice Rod Grapple Chest": TunicLocationData("East Forest", "East Forest"), + "East Forest - Above Save Point": TunicLocationData("East Forest", "East Forest"), + "East Forest - Above Save Point Obscured": TunicLocationData("East Forest", "East Forest"), + "East Forest - From Guardhouse 1 Chest": TunicLocationData("East Forest", "East Forest Dance Fox Spot"), + "East Forest - Near Save Point": TunicLocationData("East Forest", "East Forest"), + "East Forest - Beneath Spider Chest": TunicLocationData("East Forest", "East Forest"), + "East Forest - Near Telescope": TunicLocationData("East Forest", "East Forest"), + "East Forest - Spider Chest": TunicLocationData("East Forest", "East Forest"), + "East Forest - Lower Dash Chest": TunicLocationData("East Forest", "East Forest"), + "East Forest - Lower Grapple Chest": TunicLocationData("East Forest", "East Forest"), + "East Forest - Bombable Wall": TunicLocationData("East Forest", "East Forest"), + "East Forest - Page On Teleporter": TunicLocationData("East Forest", "East Forest"), + "Forest Belltower - Near Save Point": TunicLocationData("East Forest", "Forest Belltower Lower"), + "Forest Belltower - After Guard Captain": TunicLocationData("East Forest", "Forest Belltower Upper"), + "Forest Belltower - Obscured Near Bell Top Floor": TunicLocationData("East Forest", "Forest Belltower Upper"), + "Forest Belltower - Obscured Beneath Bell Bottom Floor": TunicLocationData("East Forest", "Forest Belltower Main"), + "Forest Belltower - Page Pickup": TunicLocationData("East Forest", "Forest Belltower Main"), + "Forest Grave Path - Holy Cross Code by Grave": TunicLocationData("East Forest", "Forest Grave Path by Grave", "holy cross"), + "Forest Grave Path - Above Gate": TunicLocationData("East Forest", "Forest Grave Path Main"), + "Forest Grave Path - Obscured Chest": TunicLocationData("East Forest", "Forest Grave Path Main"), + "Forest Grave Path - Upper Walkway": TunicLocationData("East Forest", "Forest Grave Path Upper"), + "Forest Grave Path - Sword Pickup": TunicLocationData("East Forest", "Forest Grave Path by Grave"), + "Hero's Grave - Tooth Relic": TunicLocationData("East Forest", "Hero Relic - East Forest"), + "Fortress Courtyard - From East Belltower": TunicLocationData("East Forest", "Fortress Exterior from East Forest"), + "Fortress Leaf Piles - Secret Chest": TunicLocationData("Eastern Vault Fortress", "Fortress Leaf Piles"), + "Fortress Arena - Hexagon Red": TunicLocationData("Eastern Vault Fortress", "Fortress Arena"), + "Fortress Arena - Siege Engine/Vault Key Pickup": TunicLocationData("Eastern Vault Fortress", "Fortress Arena"), + "Fortress East Shortcut - Chest Near Slimes": TunicLocationData("Eastern Vault Fortress", "Fortress East Shortcut Lower"), + "Eastern Vault Fortress - [West Wing] Candles Holy Cross": TunicLocationData("Eastern Vault Fortress", "Eastern Vault Fortress", "holy cross"), + "Eastern Vault Fortress - [West Wing] Dark Room Chest 1": TunicLocationData("Eastern Vault Fortress", "Eastern Vault Fortress"), + "Eastern Vault Fortress - [West Wing] Dark Room Chest 2": TunicLocationData("Eastern Vault Fortress", "Eastern Vault Fortress"), + "Eastern Vault Fortress - [East Wing] Bombable Wall": TunicLocationData("Eastern Vault Fortress", "Eastern Vault Fortress"), + "Eastern Vault Fortress - [West Wing] Page Pickup": TunicLocationData("Eastern Vault Fortress", "Eastern Vault Fortress"), + "Fortress Grave Path - Upper Walkway": TunicLocationData("Eastern Vault Fortress", "Fortress Grave Path Upper"), + "Fortress Grave Path - Chest Right of Grave": TunicLocationData("Eastern Vault Fortress", "Fortress Grave Path"), + "Fortress Grave Path - Obscured Chest Left of Grave": TunicLocationData("Eastern Vault Fortress", "Fortress Grave Path"), + "Hero's Grave - Flowers Relic": TunicLocationData("Eastern Vault Fortress", "Hero Relic - Fortress"), + "Beneath the Fortress - Bridge": TunicLocationData("Beneath the Vault", "Beneath the Vault Back"), + "Beneath the Fortress - Cell Chest 1": TunicLocationData("Beneath the Vault", "Beneath the Vault Back"), + "Beneath the Fortress - Obscured Behind Waterfall": TunicLocationData("Beneath the Vault", "Beneath the Vault Front"), + "Beneath the Fortress - Back Room Chest": TunicLocationData("Beneath the Vault", "Beneath the Vault Back"), + "Beneath the Fortress - Cell Chest 2": TunicLocationData("Beneath the Vault", "Beneath the Vault Back"), + "Frog's Domain - Near Vault": TunicLocationData("Frog's Domain", "Frog's Domain"), + "Frog's Domain - Slorm Room": TunicLocationData("Frog's Domain", "Frog's Domain"), + "Frog's Domain - Escape Chest": TunicLocationData("Frog's Domain", "Frog's Domain Back"), + "Frog's Domain - Grapple Above Hot Tub": TunicLocationData("Frog's Domain", "Frog's Domain"), + "Frog's Domain - Above Vault": TunicLocationData("Frog's Domain", "Frog's Domain"), + "Frog's Domain - Main Room Top Floor": TunicLocationData("Frog's Domain", "Frog's Domain"), + "Frog's Domain - Main Room Bottom Floor": TunicLocationData("Frog's Domain", "Frog's Domain"), + "Frog's Domain - Side Room Secret Passage": TunicLocationData("Frog's Domain", "Frog's Domain"), + "Frog's Domain - Side Room Chest": TunicLocationData("Frog's Domain", "Frog's Domain"), + "Frog's Domain - Side Room Grapple Secret": TunicLocationData("Frog's Domain", "Frog's Domain"), + "Frog's Domain - Magic Orb Pickup": TunicLocationData("Frog's Domain", "Frog's Domain"), + "Librarian - Hexagon Green": TunicLocationData("Library", "Library Arena"), + "Library Hall - Holy Cross Chest": TunicLocationData("Library", "Library Hall", "holy cross"), + "Library Lab - Chest By Shrine 2": TunicLocationData("Library", "Library Lab"), + "Library Lab - Chest By Shrine 1": TunicLocationData("Library", "Library Lab"), + "Library Lab - Chest By Shrine 3": TunicLocationData("Library", "Library Lab"), + "Library Lab - Behind Chalkboard by Fuse": TunicLocationData("Library", "Library Lab"), + "Library Lab - Page 3": TunicLocationData("Library", "Library Lab"), + "Library Lab - Page 1": TunicLocationData("Library", "Library Lab"), + "Library Lab - Page 2": TunicLocationData("Library", "Library Lab"), + "Hero's Grave - Mushroom Relic": TunicLocationData("Library", "Hero Relic - Library"), + "Lower Mountain - Page Before Door": TunicLocationData("Overworld", "Lower Mountain"), + "Changing Room - Normal Chest": TunicLocationData("Overworld", "Changing Room"), + "Fortress Courtyard - Chest Near Cave": TunicLocationData("Overworld", "Fortress Exterior near cave"), + "Fortress Courtyard - Near Fuse": TunicLocationData("Overworld", "Fortress Exterior from Overworld"), + "Fortress Courtyard - Below Walkway": TunicLocationData("Overworld", "Fortress Exterior from Overworld"), + "Fortress Courtyard - Page Near Cave": TunicLocationData("Overworld", "Fortress Exterior near cave"), + "West Furnace - Lantern Pickup": TunicLocationData("Overworld", "Furnace Fuse"), + "Maze Cave - Maze Room Chest": TunicLocationData("Overworld", "Maze Cave"), + "Old House - Normal Chest": TunicLocationData("Overworld", "Old House Front"), + "Old House - Shield Pickup": TunicLocationData("Overworld", "Old House Front"), + "Overworld - [West] Obscured Behind Windmill": TunicLocationData("Overworld", "Overworld"), + "Overworld - [South] Beach Chest": TunicLocationData("Overworld", "Overworld"), + "Overworld - [West] Obscured Near Well": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Central] Bombable Wall": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Northwest] Chest Near Turret": TunicLocationData("Overworld", "Overworld"), + "Overworld - [East] Chest Near Pots": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Northwest] Chest Near Golden Obelisk": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Southwest] South Chest Near Guard": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Southwest] West Beach Guarded By Turret": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Southwest] Chest Guarded By Turret": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Northwest] Shadowy Corner Chest": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Southwest] Obscured In Tunnel To Beach": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Southwest] Grapple Chest Over Walkway": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Northwest] Chest Beneath Quarry Gate": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Southeast] Chest Near Swamp": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Southwest] From West Garden": TunicLocationData("Overworld", "Overworld"), + "Overworld - [East] Grapple Chest": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Southwest] West Beach Guarded By Turret 2": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Southwest] Beach Chest Near Flowers": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Southwest] Bombable Wall Near Fountain": TunicLocationData("Overworld", "Overworld"), + "Overworld - [West] Chest After Bell": TunicLocationData("Overworld", "Overworld Belltower"), + "Overworld - [Southwest] Tunnel Guarded By Turret": TunicLocationData("Overworld", "Overworld"), + "Overworld - [East] Between Ladders Near Ruined Passage": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Northeast] Chest Above Patrol Cave": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Southwest] Beach Chest Beneath Guard": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Central] Chest Across From Well": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Northwest] Chest Near Quarry Gate": TunicLocationData("Overworld", "Overworld"), + "Overworld - [East] Chest In Trees": TunicLocationData("Overworld", "Overworld"), + "Overworld - [West] Chest Behind Moss Wall": TunicLocationData("Overworld", "Overworld"), + "Overworld - [South] Beach Page": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Southeast] Page on Pillar by Swamp": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Southwest] Key Pickup": TunicLocationData("Overworld", "Overworld"), + "Overworld - [West] Key Pickup": TunicLocationData("Overworld", "Overworld"), + "Overworld - [East] Page Near Secret Shop": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Southwest] Fountain Page": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Northwest] Page on Pillar by Dark Tomb": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Northwest] Fire Wand Pickup": TunicLocationData("Overworld", "Overworld"), + "Overworld - [West] Page On Teleporter": TunicLocationData("Overworld", "Overworld"), + "Overworld - [Northwest] Page By Well": TunicLocationData("Overworld", "Overworld"), + "Patrol Cave - Normal Chest": TunicLocationData("Overworld", "Patrol Cave"), + "Ruined Shop - Chest 1": TunicLocationData("Overworld", "Ruined Shop"), + "Ruined Shop - Chest 2": TunicLocationData("Overworld", "Ruined Shop"), + "Ruined Shop - Chest 3": TunicLocationData("Overworld", "Ruined Shop"), + "Ruined Passage - Page Pickup": TunicLocationData("Overworld", "Ruined Passage"), + "Shop - Potion 1": TunicLocationData("Overworld", "Shop", "shop"), + "Shop - Potion 2": TunicLocationData("Overworld", "Shop", "shop"), + "Shop - Coin 1": TunicLocationData("Overworld", "Shop", "shop"), + "Shop - Coin 2": TunicLocationData("Overworld", "Shop", "shop"), + "Special Shop - Secret Page Pickup": TunicLocationData("Overworld", "Special Shop"), + "Stick House - Stick Chest": TunicLocationData("Overworld", "Stick House"), + "Sealed Temple - Page Pickup": TunicLocationData("Overworld", "Sealed Temple"), + "Hourglass Cave - Hourglass Chest": TunicLocationData("Overworld", "Hourglass Cave"), + "Far Shore - Secret Chest": TunicLocationData("Overworld", "Far Shore"), + "Far Shore - Page Pickup": TunicLocationData("Overworld", "Far Shore to Spawn"), + "Coins in the Well - 10 Coins": TunicLocationData("Overworld", "Overworld", "well"), + "Coins in the Well - 15 Coins": TunicLocationData("Overworld", "Overworld", "well"), + "Coins in the Well - 3 Coins": TunicLocationData("Overworld", "Overworld", "well"), + "Coins in the Well - 6 Coins": TunicLocationData("Overworld", "Overworld", "well"), + "Secret Gathering Place - 20 Fairy Reward": TunicLocationData("Overworld", "Secret Gathering Place", "fairies"), + "Secret Gathering Place - 10 Fairy Reward": TunicLocationData("Overworld", "Secret Gathering Place", "fairies"), + "Overworld - [West] Moss Wall Holy Cross": TunicLocationData("Overworld Holy Cross", "Overworld Holy Cross", "holy cross"), + "Overworld - [Southwest] Flowers Holy Cross": TunicLocationData("Overworld Holy Cross", "Overworld Holy Cross", "holy cross"), + "Overworld - [Southwest] Fountain Holy Cross": TunicLocationData("Overworld Holy Cross", "Overworld Holy Cross", "holy cross"), + "Overworld - [Northeast] Flowers Holy Cross": TunicLocationData("Overworld Holy Cross", "Overworld Holy Cross", "holy cross"), + "Overworld - [East] Weathervane Holy Cross": TunicLocationData("Overworld Holy Cross", "Overworld Holy Cross", "holy cross"), + "Overworld - [West] Windmill Holy Cross": TunicLocationData("Overworld Holy Cross", "Overworld Holy Cross", "holy cross"), + "Overworld - [Southwest] Haiku Holy Cross": TunicLocationData("Overworld Holy Cross", "Overworld Holy Cross", "holy cross"), + "Overworld - [West] Windchimes Holy Cross": TunicLocationData("Overworld Holy Cross", "Overworld Holy Cross", "holy cross"), + "Overworld - [South] Starting Platform Holy Cross": TunicLocationData("Overworld Holy Cross", "Overworld Holy Cross", "holy cross"), + "Overworld - [Northwest] Golden Obelisk Page": TunicLocationData("Overworld Holy Cross", "Overworld Holy Cross", "holy cross"), + "Old House - Holy Cross Door Page": TunicLocationData("Overworld Holy Cross", "Old House Back", "holy cross"), + "Cube Cave - Holy Cross Chest": TunicLocationData("Overworld Holy Cross", "Cube Cave", "holy cross"), + "Southeast Cross Door - Chest 3": TunicLocationData("Overworld Holy Cross", "Southeast Cross Room", "holy cross"), + "Southeast Cross Door - Chest 2": TunicLocationData("Overworld Holy Cross", "Southeast Cross Room", "holy cross"), + "Southeast Cross Door - Chest 1": TunicLocationData("Overworld Holy Cross", "Southeast Cross Room", "holy cross"), + "Maze Cave - Maze Room Holy Cross": TunicLocationData("Overworld Holy Cross", "Maze Cave", "holy cross"), + "Caustic Light Cave - Holy Cross Chest": TunicLocationData("Overworld Holy Cross", "Caustic Light Cave", "holy cross"), + "Old House - Holy Cross Chest": TunicLocationData("Overworld Holy Cross", "Old House Front", "holy cross"), + "Patrol Cave - Holy Cross Chest": TunicLocationData("Overworld Holy Cross", "Patrol Cave", "holy cross"), + "Ruined Passage - Holy Cross Chest": TunicLocationData("Overworld Holy Cross", "Ruined Passage", "holy cross"), + "Hourglass Cave - Holy Cross Chest": TunicLocationData("Overworld Holy Cross", "Hourglass Cave", "holy cross"), + "Sealed Temple - Holy Cross Chest": TunicLocationData("Overworld Holy Cross", "Sealed Temple", "holy cross"), + "Fountain Cross Door - Page Pickup": TunicLocationData("Overworld Holy Cross", "Fountain Cross Room", "holy cross"), + "Secret Gathering Place - Holy Cross Chest": TunicLocationData("Overworld Holy Cross", "Secret Gathering Place", "holy cross"), + "Top of the Mountain - Page At The Peak": TunicLocationData("Overworld Holy Cross", "Top of the Mountain", "holy cross"), + "Monastery - Monastery Chest": TunicLocationData("Quarry", "Monastery Back"), + "Quarry - [Back Entrance] Bushes Holy Cross": TunicLocationData("Quarry Back", "Quarry Back", "holy cross"), + "Quarry - [Back Entrance] Chest": TunicLocationData("Quarry Back", "Quarry Back"), + "Quarry - [Central] Near Shortcut Ladder": TunicLocationData("Quarry", "Quarry"), + "Quarry - [East] Near Telescope": TunicLocationData("Quarry", "Quarry"), + "Quarry - [East] Upper Floor": TunicLocationData("Quarry", "Quarry"), + "Quarry - [Central] Below Entry Walkway": TunicLocationData("Quarry", "Quarry"), + "Quarry - [East] Obscured Near Winding Staircase": TunicLocationData("Quarry", "Quarry"), + "Quarry - [East] Obscured Beneath Scaffolding": TunicLocationData("Quarry", "Quarry"), + "Quarry - [East] Obscured Near Telescope": TunicLocationData("Quarry", "Quarry"), + "Quarry - [Back Entrance] Obscured Behind Wall": TunicLocationData("Quarry Back", "Quarry Back"), + "Quarry - [Central] Obscured Below Entry Walkway": TunicLocationData("Quarry", "Quarry"), + "Quarry - [Central] Top Floor Overhang": TunicLocationData("Quarry", "Quarry"), + "Quarry - [East] Near Bridge": TunicLocationData("Quarry", "Quarry"), + "Quarry - [Central] Above Ladder": TunicLocationData("Quarry", "Quarry Monastery Entry"), + "Quarry - [Central] Obscured Behind Staircase": TunicLocationData("Quarry", "Quarry"), + "Quarry - [Central] Above Ladder Dash Chest": TunicLocationData("Quarry", "Quarry Monastery Entry"), + "Quarry - [West] Upper Area Bombable Wall": TunicLocationData("Quarry Back", "Quarry Back"), + "Quarry - [East] Bombable Wall": TunicLocationData("Quarry", "Quarry"), + "Hero's Grave - Ash Relic": TunicLocationData("Quarry", "Hero Relic - Quarry"), + "Quarry - [West] Shooting Range Secret Path": TunicLocationData("Lower Quarry", "Lower Quarry"), + "Quarry - [West] Near Shooting Range": TunicLocationData("Lower Quarry", "Lower Quarry"), + "Quarry - [West] Below Shooting Range": TunicLocationData("Lower Quarry", "Lower Quarry"), + "Quarry - [Lowlands] Below Broken Ladder": TunicLocationData("Lower Quarry", "Lower Quarry"), + "Quarry - [West] Upper Area Near Waterfall": TunicLocationData("Lower Quarry", "Lower Quarry"), + "Quarry - [Lowlands] Upper Walkway": TunicLocationData("Lower Quarry", "Lower Quarry"), + "Quarry - [West] Lower Area Below Bridge": TunicLocationData("Lower Quarry", "Lower Quarry"), + "Quarry - [West] Lower Area Isolated Chest": TunicLocationData("Lower Quarry", "Lower Quarry"), + "Quarry - [Lowlands] Near Elevator": TunicLocationData("Lower Quarry", "Lower Quarry"), + "Quarry - [West] Lower Area After Bridge": TunicLocationData("Lower Quarry", "Lower Quarry"), + "Rooted Ziggurat Upper - Near Bridge Switch": TunicLocationData("Rooted Ziggurat", "Rooted Ziggurat Upper Front"), + "Rooted Ziggurat Upper - Beneath Bridge To Administrator": TunicLocationData("Rooted Ziggurat", "Rooted Ziggurat Upper Back"), + "Rooted Ziggurat Tower - Inside Tower": TunicLocationData("Rooted Ziggurat", "Rooted Ziggurat Middle Top"), + "Rooted Ziggurat Lower - Near Corpses": TunicLocationData("Rooted Ziggurat", "Rooted Ziggurat Lower Front"), + "Rooted Ziggurat Lower - Spider Ambush": TunicLocationData("Rooted Ziggurat", "Rooted Ziggurat Lower Front"), + "Rooted Ziggurat Lower - Left Of Checkpoint Before Fuse": TunicLocationData("Rooted Ziggurat", "Rooted Ziggurat Lower Front"), + "Rooted Ziggurat Lower - After Guarded Fuse": TunicLocationData("Rooted Ziggurat", "Rooted Ziggurat Lower Front"), + "Rooted Ziggurat Lower - Guarded By Double Turrets": TunicLocationData("Rooted Ziggurat", "Rooted Ziggurat Lower Front"), + "Rooted Ziggurat Lower - After 2nd Double Turret Chest": TunicLocationData("Rooted Ziggurat", "Rooted Ziggurat Lower Front"), + "Rooted Ziggurat Lower - Guarded By Double Turrets 2": TunicLocationData("Rooted Ziggurat", "Rooted Ziggurat Lower Front"), + "Rooted Ziggurat Lower - Hexagon Blue": TunicLocationData("Rooted Ziggurat", "Rooted Ziggurat Lower Back"), + "Ruined Atoll - [West] Near Kevin Block": TunicLocationData("Ruined Atoll", "Ruined Atoll"), + "Ruined Atoll - [South] Upper Floor On Power Line": TunicLocationData("Ruined Atoll", "Ruined Atoll"), + "Ruined Atoll - [South] Chest Near Big Crabs": TunicLocationData("Ruined Atoll", "Ruined Atoll"), + "Ruined Atoll - [North] Guarded By Bird": TunicLocationData("Ruined Atoll", "Ruined Atoll"), + "Ruined Atoll - [Northeast] Chest Beneath Brick Walkway": TunicLocationData("Ruined Atoll", "Ruined Atoll"), + "Ruined Atoll - [Northwest] Bombable Wall": TunicLocationData("Ruined Atoll", "Ruined Atoll"), + "Ruined Atoll - [North] Obscured Beneath Bridge": TunicLocationData("Ruined Atoll", "Ruined Atoll"), + "Ruined Atoll - [South] Upper Floor On Bricks": TunicLocationData("Ruined Atoll", "Ruined Atoll"), + "Ruined Atoll - [South] Near Birds": TunicLocationData("Ruined Atoll", "Ruined Atoll"), + "Ruined Atoll - [Northwest] Behind Envoy": TunicLocationData("Ruined Atoll", "Ruined Atoll"), + "Ruined Atoll - [Southwest] Obscured Behind Fuse": TunicLocationData("Ruined Atoll", "Ruined Atoll"), + "Ruined Atoll - [East] Locked Room Upper Chest": TunicLocationData("Ruined Atoll", "Ruined Atoll"), + "Ruined Atoll - [North] From Lower Overworld Entrance": TunicLocationData("Ruined Atoll", "Ruined Atoll Lower Entry Area"), + "Ruined Atoll - [East] Locked Room Lower Chest": TunicLocationData("Ruined Atoll", "Ruined Atoll"), + "Ruined Atoll - [Northeast] Chest On Brick Walkway": TunicLocationData("Ruined Atoll", "Ruined Atoll"), + "Ruined Atoll - [Southeast] Chest Near Fuse": TunicLocationData("Ruined Atoll", "Ruined Atoll"), + "Ruined Atoll - [Northeast] Key Pickup": TunicLocationData("Ruined Atoll", "Ruined Atoll"), + "Cathedral Gauntlet - Gauntlet Reward": TunicLocationData("Swamp", "Cathedral Gauntlet"), + "Cathedral - Secret Legend Trophy Chest": TunicLocationData("Swamp", "Cathedral Secret Legend Room"), + "Swamp - [Upper Graveyard] Obscured Behind Hill": TunicLocationData("Swamp", "Swamp"), + "Swamp - [South Graveyard] 4 Orange Skulls": TunicLocationData("Swamp", "Swamp"), + "Swamp - [Central] Near Ramps Up": TunicLocationData("Swamp", "Swamp"), + "Swamp - [Upper Graveyard] Near Shield Fleemers": TunicLocationData("Swamp", "Swamp"), + "Swamp - [South Graveyard] Obscured Behind Ridge": TunicLocationData("Swamp", "Swamp"), + "Swamp - [South Graveyard] Obscured Beneath Telescope": TunicLocationData("Swamp", "Swamp"), + "Swamp - [Entrance] Above Entryway": TunicLocationData("Swamp", "Back of Swamp Laurels Area"), + "Swamp - [Central] South Secret Passage": TunicLocationData("Swamp", "Swamp"), + "Swamp - [South Graveyard] Upper Walkway On Pedestal": TunicLocationData("Swamp", "Swamp"), + "Swamp - [South Graveyard] Guarded By Tentacles": TunicLocationData("Swamp", "Swamp"), + "Swamp - [Upper Graveyard] Near Telescope": TunicLocationData("Swamp", "Swamp"), + "Swamp - [Outside Cathedral] Near Moonlight Bridge Door": TunicLocationData("Swamp", "Swamp"), + "Swamp - [Entrance] Obscured Inside Watchtower": TunicLocationData("Swamp", "Swamp"), + "Swamp - [Entrance] South Near Fence": TunicLocationData("Swamp", "Swamp"), + "Swamp - [South Graveyard] Guarded By Big Skeleton": TunicLocationData("Swamp", "Swamp"), + "Swamp - [South Graveyard] Chest Near Graves": TunicLocationData("Swamp", "Swamp"), + "Swamp - [Entrance] North Small Island": TunicLocationData("Swamp", "Swamp"), + "Swamp - [Outside Cathedral] Obscured Behind Memorial": TunicLocationData("Swamp", "Back of Swamp"), + "Swamp - [Central] Obscured Behind Northern Mountain": TunicLocationData("Swamp", "Swamp"), + "Swamp - [South Graveyard] Upper Walkway Dash Chest": TunicLocationData("Swamp", "Swamp"), + "Swamp - [South Graveyard] Above Big Skeleton": TunicLocationData("Swamp", "Swamp"), + "Swamp - [Central] Beneath Memorial": TunicLocationData("Swamp", "Swamp"), + "Hero's Grave - Feathers Relic": TunicLocationData("Swamp", "Hero Relic - Swamp"), + "West Furnace - Chest": TunicLocationData("West Garden", "Furnace Walking Path"), + "Overworld - [West] Near West Garden Entrance": TunicLocationData("West Garden", "Overworld to West Garden from Furnace"), + "West Garden - [Central Highlands] Holy Cross (Blue Lines)": TunicLocationData("West Garden", "West Garden", "holy cross"), + "West Garden - [West Lowlands] Tree Holy Cross Chest": TunicLocationData("West Garden", "West Garden", "holy cross"), + "West Garden - [Southeast Lowlands] Outside Cave": TunicLocationData("West Garden", "West Garden"), + "West Garden - [Central Lowlands] Chest Beneath Faeries": TunicLocationData("West Garden", "West Garden"), + "West Garden - [North] Behind Holy Cross Door": TunicLocationData("West Garden", "West Garden", "holy cross"), + "West Garden - [Central Highlands] Top of Ladder Before Boss": TunicLocationData("West Garden", "West Garden"), + "West Garden - [Central Lowlands] Passage Beneath Bridge": TunicLocationData("West Garden", "West Garden"), + "West Garden - [North] Across From Page Pickup": TunicLocationData("West Garden", "West Garden"), + "West Garden - [Central Lowlands] Below Left Walkway": TunicLocationData("West Garden", "West Garden"), + "West Garden - [West] In Flooded Walkway": TunicLocationData("West Garden", "West Garden"), + "West Garden - [West] Past Flooded Walkway": TunicLocationData("West Garden", "West Garden"), + "West Garden - [North] Obscured Beneath Hero's Memorial": TunicLocationData("West Garden", "West Garden"), + "West Garden - [Central Lowlands] Chest Near Shortcut Bridge": TunicLocationData("West Garden", "West Garden"), + "West Garden - [West Highlands] Upper Left Walkway": TunicLocationData("West Garden", "West Garden"), + "West Garden - [Central Lowlands] Chest Beneath Save Point": TunicLocationData("West Garden", "West Garden"), + "West Garden - [Central Highlands] Behind Guard Captain": TunicLocationData("West Garden", "West Garden"), + "West Garden - [Central Highlands] After Garden Knight": TunicLocationData("West Garden", "West Garden after Boss"), + "West Garden - [South Highlands] Secret Chest Beneath Fuse": TunicLocationData("West Garden", "West Garden"), + "West Garden - [East Lowlands] Page Behind Ice Dagger House": TunicLocationData("West Garden", "West Garden Portal Item"), + "West Garden - [North] Page Pickup": TunicLocationData("West Garden", "West Garden"), + "West Garden House - [Southeast Lowlands] Ice Dagger Pickup": TunicLocationData("West Garden", "Magic Dagger House"), + "Hero's Grave - Effigy Relic": TunicLocationData("West Garden", "Hero Relic - West Garden"), +} + +hexagon_locations: Dict[str, str] = { + "Red Questagon": "Fortress Arena - Siege Engine/Vault Key Pickup", + "Green Questagon": "Librarian - Hexagon Green", + "Blue Questagon": "Rooted Ziggurat Lower - Hexagon Blue", +} + +location_name_to_id: Dict[str, int] = {name: location_base_id + index for index, name in enumerate(location_table)} + + +def get_loc_group(location_name: str) -> str: + loc_group = location_table[location_name].location_group + if loc_group == "region": + # set loc_group as the region name. Typically, location groups are lowercase + loc_group = location_table[location_name].region.lower() + return loc_group + + +location_name_groups: Dict[str, Set[str]] = { + group: set(item_names) for group, item_names in groupby(sorted(location_table, key=get_loc_group), get_loc_group) +} diff --git a/worlds/tunic/options.py b/worlds/tunic/options.py new file mode 100644 index 000000000000..77fa2cdaf5bc --- /dev/null +++ b/worlds/tunic/options.py @@ -0,0 +1,147 @@ +from dataclasses import dataclass + +from Options import DefaultOnToggle, Toggle, StartInventoryPool, Choice, Range, PerGameCommonOptions + + +class SwordProgression(DefaultOnToggle): + """Adds four sword upgrades to the item pool that will progressively grant stronger melee weapons, including two new + swords with increased range and attack power.""" + internal_name = "sword_progression" + display_name = "Sword Progression" + + +class StartWithSword(Toggle): + """Start with a sword in the player's inventory. Does not count towards Sword Progression.""" + internal_name = "start_with_sword" + display_name = "Start With Sword" + + +class KeysBehindBosses(Toggle): + """Places the three hexagon keys behind their respective boss fight in your world.""" + internal_name = "keys_behind_bosses" + display_name = "Keys Behind Bosses" + + +class AbilityShuffling(Toggle): + """Locks the usage of Prayer, Holy Cross*, and Ice Rod until the relevant pages of the manual have been found. + If playing Hexagon Quest, abilities are instead randomly unlocked after obtaining 25%, 50%, and 75% of the required + Hexagon goal amount. + *Certain Holy Cross usages are still allowed, such as the free bomb codes, the seeking spell, and other + player-facing codes. + """ + internal_name = "ability_shuffling" + display_name = "Ability Shuffling" + + +class LogicRules(Choice): + """Set which logic rules to use for your world. + Restricted: Standard logic, no glitches. + No Major Glitches: Ice grapples through doors, shooting the west bell, and boss quick kills are included in logic. + Unrestricted: Logic in No Major Glitches, as well as ladder storage to get to certain places early. + *Special Shop is not in logic without the Hero's Laurels in Unrestricted due to soft lock potential. + *Using Ladder Storage to get to individual chests is not in logic to avoid tedium. + *Getting knocked out of the air by enemies during Ladder Storage to reach places is not in logic, except for in + Rooted Ziggurat Lower. This is so you're not punished for playing with enemy rando on.""" + internal_name = "logic_rules" + display_name = "Logic Rules" + option_restricted = 0 + option_no_major_glitches = 1 + option_unrestricted = 2 + default = 0 + + +class Lanternless(Toggle): + """Choose whether you require the Lantern for dark areas. + When enabled, the Lantern is marked as Useful instead of Progression.""" + internal_name = "lanternless" + display_name = "Lanternless" + + +class Maskless(Toggle): + """Choose whether you require the Scavenger's Mask for Lower Quarry. + When enabled, the Scavenger's Mask is marked as Useful instead of Progression.""" + internal_name = "maskless" + display_name = "Maskless" + + +class FoolTraps(Choice): + """Replaces low-to-medium value money rewards in the item pool with fool traps, which cause random negative + effects to the player.""" + internal_name = "fool_traps" + display_name = "Fool Traps" + option_off = 0 + option_normal = 1 + option_double = 2 + option_onslaught = 3 + default = 1 + + +class HexagonQuest(Toggle): + """An alternate goal that shuffles Gold "Questagon" items into the item pool and allows the game to be completed + after collecting the required number of them.""" + internal_name = "hexagon_quest" + display_name = "Hexagon Quest" + + +class HexagonGoal(Range): + """How many Gold Questagons are required to complete the game on Hexagon Quest.""" + internal_name = "hexagon_goal" + display_name = "Gold Hexagons Required" + range_start = 15 + range_end = 50 + default = 20 + + +class ExtraHexagonPercentage(Range): + """How many extra Gold Questagons are shuffled into the item pool, taken as a percentage of the goal amount.""" + internal_name = "extra_hexagon_percentage" + display_name = "Percentage of Extra Gold Hexagons" + range_start = 0 + range_end = 100 + default = 50 + + +class EntranceRando(Toggle): + """Randomize the connections between scenes. + A small, very lost fox on a big adventure.""" + internal_name = "entrance_rando" + display_name = "Entrance Rando" + + +class FixedShop(Toggle): + """Forces the Windmill entrance to lead to a shop, and places only one other shop in the pool. + Has no effect if Entrance Rando is not enabled.""" + internal_name = "fixed_shop" + display_name = "ER Fixed Shop" + + +class LaurelsLocation(Choice): + """Force the Hero's Laurels to be placed at a location in your world. + For if you want to avoid or specify early or late Laurels. + If you use the 10 Fairies option in Entrance Rando, Secret Gathering Place will be at its vanilla entrance.""" + internal_name = "laurels_location" + display_name = "Laurels Location" + option_anywhere = 0 + option_6_coins = 1 + option_10_coins = 2 + option_10_fairies = 3 + default = 0 + + +@dataclass +class TunicOptions(PerGameCommonOptions): + sword_progression: SwordProgression + start_with_sword: StartWithSword + keys_behind_bosses: KeysBehindBosses + ability_shuffling: AbilityShuffling + logic_rules: LogicRules + entrance_rando: EntranceRando + fixed_shop: FixedShop + fool_traps: FoolTraps + hexagon_quest: HexagonQuest + hexagon_goal: HexagonGoal + extra_hexagon_percentage: ExtraHexagonPercentage + lanternless: Lanternless + maskless: Maskless + laurels_location: LaurelsLocation + start_inventory_from_pool: StartInventoryPool diff --git a/worlds/tunic/regions.py b/worlds/tunic/regions.py new file mode 100644 index 000000000000..5d5248f210d6 --- /dev/null +++ b/worlds/tunic/regions.py @@ -0,0 +1,25 @@ +from typing import Dict, Set + +tunic_regions: Dict[str, Set[str]] = { + "Menu": {"Overworld"}, + "Overworld": {"Overworld Holy Cross", "East Forest", "Dark Tomb", "Beneath the Well", "West Garden", + "Ruined Atoll", "Eastern Vault Fortress", "Beneath the Vault", "Quarry Back", "Quarry", "Swamp", + "Spirit Arena"}, + "Overworld Holy Cross": set(), + "East Forest": {"Eastern Vault Fortress"}, + "Dark Tomb": {"West Garden"}, + "Beneath the Well": {"Dark Tomb"}, + "West Garden": {"Overworld", "Dark Tomb"}, + "Ruined Atoll": {"Frog's Domain", "Library"}, + "Frog's Domain": set(), + "Library": set(), + "Eastern Vault Fortress": {"Beneath the Vault"}, + "Beneath the Vault": {"Eastern Vault Fortress"}, + "Quarry Back": {"Quarry"}, + "Quarry": {"Lower Quarry", "Rooted Ziggurat"}, + "Lower Quarry": {"Rooted Ziggurat"}, + "Rooted Ziggurat": set(), + "Swamp": {"Cathedral"}, + "Cathedral": set(), + "Spirit Arena": set() +} diff --git a/worlds/tunic/rules.py b/worlds/tunic/rules.py new file mode 100644 index 000000000000..9906936a469f --- /dev/null +++ b/worlds/tunic/rules.py @@ -0,0 +1,345 @@ +from random import Random +from typing import Dict, TYPE_CHECKING + +from worlds.generic.Rules import set_rule, forbid_item +from BaseClasses import CollectionState +from .options import TunicOptions +if TYPE_CHECKING: + from . import TunicWorld + +laurels = "Hero's Laurels" +grapple = "Magic Orb" +ice_dagger = "Magic Dagger" +fire_wand = "Magic Wand" +lantern = "Lantern" +fairies = "Fairy" +coins = "Golden Coin" +prayer = "Pages 24-25 (Prayer)" +holy_cross = "Pages 42-43 (Holy Cross)" +ice_rod = "Pages 52-53 (Ice Rod)" +key = "Key" +house_key = "Old House Key" +vault_key = "Fortress Vault Key" +mask = "Scavenger Mask" +red_hexagon = "Red Questagon" +green_hexagon = "Green Questagon" +blue_hexagon = "Blue Questagon" +gold_hexagon = "Gold Questagon" + + +def randomize_ability_unlocks(random: Random, options: TunicOptions) -> Dict[str, int]: + ability_requirement = [1, 1, 1] + if options.hexagon_quest.value: + hexagon_goal = options.hexagon_goal.value + # Set ability unlocks to 25, 50, and 75% of goal amount + ability_requirement = [hexagon_goal // 4, hexagon_goal // 2, hexagon_goal * 3 // 4] + abilities = [prayer, holy_cross, ice_rod] + random.shuffle(abilities) + return dict(zip(abilities, ability_requirement)) + + +def has_ability(state: CollectionState, player: int, ability: str, options: TunicOptions, + ability_unlocks: Dict[str, int]) -> bool: + if not options.ability_shuffling: + return True + if options.hexagon_quest: + return state.has(gold_hexagon, player, ability_unlocks[ability]) + return state.has(ability, player) + + +# a check to see if you can whack things in melee at all +def has_stick(state: CollectionState, player: int) -> bool: + return state.has("Stick", player) or state.has("Sword Upgrade", player, 1) or state.has("Sword", player) + + +def has_sword(state: CollectionState, player: int) -> bool: + return state.has("Sword", player) or state.has("Sword Upgrade", player, 2) + + +def has_ice_grapple_logic(long_range: bool, state: CollectionState, player: int, options: TunicOptions, + ability_unlocks: Dict[str, int]) -> bool: + if not options.logic_rules: + return False + + if not long_range: + return state.has_all({ice_dagger, grapple}, player) + else: + return state.has_all({ice_dagger, fire_wand, grapple}, player) and \ + has_ability(state, player, ice_rod, options, ability_unlocks) + + +def can_ladder_storage(state: CollectionState, player: int, options: TunicOptions) -> bool: + if options.logic_rules == "unrestricted" and has_stick(state, player): + return True + else: + return False + + +def has_mask(state: CollectionState, player: int, options: TunicOptions) -> bool: + if options.maskless: + return True + else: + return state.has(mask, player) + + +def has_lantern(state: CollectionState, player: int, options: TunicOptions) -> bool: + if options.lanternless: + return True + else: + return state.has(lantern, player) + + +def set_region_rules(world: "TunicWorld", ability_unlocks: Dict[str, int]) -> None: + multiworld = world.multiworld + player = world.player + options = world.options + + multiworld.get_entrance("Overworld -> Overworld Holy Cross", player).access_rule = \ + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks) + multiworld.get_entrance("Overworld -> Beneath the Well", player).access_rule = \ + lambda state: has_stick(state, player) or state.has(fire_wand, player) + multiworld.get_entrance("Overworld -> Dark Tomb", player).access_rule = \ + lambda state: has_lantern(state, player, options) + multiworld.get_entrance("Overworld -> West Garden", player).access_rule = \ + lambda state: state.has(laurels, player) \ + or can_ladder_storage(state, player, options) + multiworld.get_entrance("Beneath the Well -> Dark Tomb", player).access_rule = \ + lambda state: has_lantern(state, player, options) + multiworld.get_entrance("West Garden -> Dark Tomb", player).access_rule = \ + lambda state: has_lantern(state, player, options) + multiworld.get_entrance("Overworld -> Eastern Vault Fortress", player).access_rule = \ + lambda state: state.has(laurels, player) \ + or has_ice_grapple_logic(True, state, player, options, ability_unlocks) \ + or can_ladder_storage(state, player, options) + multiworld.get_entrance("East Forest -> Eastern Vault Fortress", player).access_rule = \ + lambda state: state.has(laurels, player) \ + or has_ice_grapple_logic(True, state, player, options, ability_unlocks) \ + or can_ladder_storage(state, player, options) + # using laurels or ls to get in is covered by the -> Eastern Vault Fortress rules + multiworld.get_entrance("Overworld -> Beneath the Vault", player).access_rule = \ + lambda state: has_lantern(state, player, options) and \ + has_ability(state, player, prayer, options, ability_unlocks) + multiworld.get_entrance("Ruined Atoll -> Library", player).access_rule = \ + lambda state: state.has_any({grapple, laurels}, player) and \ + has_ability(state, player, prayer, options, ability_unlocks) + multiworld.get_entrance("Overworld -> Quarry", player).access_rule = \ + lambda state: (has_sword(state, player) or state.has(fire_wand, player)) \ + and (state.has_any({grapple, laurels}, player) or can_ladder_storage(state, player, options)) + multiworld.get_entrance("Quarry Back -> Quarry", player).access_rule = \ + lambda state: has_sword(state, player) or state.has(fire_wand, player) + multiworld.get_entrance("Quarry -> Lower Quarry", player).access_rule = \ + lambda state: has_mask(state, player, options) + multiworld.get_entrance("Lower Quarry -> Rooted Ziggurat", player).access_rule = \ + lambda state: (state.has(grapple, player) and has_ability(state, player, prayer, options, ability_unlocks)) \ + or has_ice_grapple_logic(False, state, player, options, ability_unlocks) + multiworld.get_entrance("Quarry -> Rooted Ziggurat", player).access_rule = \ + lambda state: has_ice_grapple_logic(False, state, player, options, ability_unlocks) + multiworld.get_entrance("Swamp -> Cathedral", player).access_rule = \ + lambda state: state.has(laurels, player) and has_ability(state, player, prayer, options, ability_unlocks) \ + or has_ice_grapple_logic(False, state, player, options, ability_unlocks) + multiworld.get_entrance("Overworld -> Spirit Arena", player).access_rule = \ + lambda state: (state.has(gold_hexagon, player, options.hexagon_goal.value) if options.hexagon_quest.value + else state.has_all({red_hexagon, green_hexagon, blue_hexagon}, player)) and \ + has_ability(state, player, prayer, options, ability_unlocks) and has_sword(state, player) + + +def set_location_rules(world: "TunicWorld", ability_unlocks: Dict[str, int]) -> None: + multiworld = world.multiworld + player = world.player + options = world.options + + forbid_item(multiworld.get_location("Secret Gathering Place - 20 Fairy Reward", player), fairies, player) + + # Ability Shuffle Exclusive Rules + set_rule(multiworld.get_location("Far Shore - Page Pickup", player), + lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + set_rule(multiworld.get_location("Fortress Courtyard - Chest Near Cave", player), + lambda state: has_ability(state, player, prayer, options, ability_unlocks) or state.has(laurels, player) + or can_ladder_storage(state, player, options) + or (has_ice_grapple_logic(True, state, player, options, ability_unlocks) + and has_lantern(state, player, options))) + set_rule(multiworld.get_location("Fortress Courtyard - Page Near Cave", player), + lambda state: has_ability(state, player, prayer, options, ability_unlocks) or state.has(laurels, player) + or can_ladder_storage(state, player, options) + or (has_ice_grapple_logic(True, state, player, options, ability_unlocks) + and has_lantern(state, player, options))) + set_rule(multiworld.get_location("East Forest - Dancing Fox Spirit Holy Cross", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Forest Grave Path - Holy Cross Code by Grave", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("East Forest - Golden Obelisk Holy Cross", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Beneath the Well - [Powered Secret Room] Chest", player), + lambda state: has_ability(state, player, prayer, options, ability_unlocks)) + set_rule(multiworld.get_location("West Garden - [North] Behind Holy Cross Door", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Library Hall - Holy Cross Chest", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Eastern Vault Fortress - [West Wing] Candles Holy Cross", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("West Garden - [Central Highlands] Holy Cross (Blue Lines)", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Quarry - [Back Entrance] Bushes Holy Cross", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("Cathedral - Secret Legend Trophy Chest", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks)) + + # Overworld + set_rule(multiworld.get_location("Overworld - [Southwest] Fountain Page", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Overworld - [Southwest] Grapple Chest Over Walkway", player), + lambda state: state.has_any({grapple, laurels}, player)) + set_rule(multiworld.get_location("Overworld - [Southwest] West Beach Guarded By Turret 2", player), + lambda state: state.has_any({grapple, laurels}, player)) + set_rule(multiworld.get_location("Far Shore - Secret Chest", player), + lambda state: state.has(laurels, player) and has_ability(state, player, prayer, options, ability_unlocks)) + set_rule(multiworld.get_location("Overworld - [Southeast] Page on Pillar by Swamp", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Old House - Normal Chest", player), + lambda state: state.has(house_key, player) + or has_ice_grapple_logic(False, state, player, options, ability_unlocks) + or (state.has(laurels, player) and options.logic_rules)) + set_rule(multiworld.get_location("Old House - Holy Cross Chest", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks) and + (state.has(house_key, player) + or has_ice_grapple_logic(False, state, player, options, ability_unlocks) + or (state.has(laurels, player) and options.logic_rules))) + set_rule(multiworld.get_location("Old House - Shield Pickup", player), + lambda state: state.has(house_key, player) + or has_ice_grapple_logic(False, state, player, options, ability_unlocks) + or (state.has(laurels, player) and options.logic_rules)) + set_rule(multiworld.get_location("Overworld - [Northwest] Page on Pillar by Dark Tomb", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Overworld - [Southwest] From West Garden", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Overworld - [West] Chest After Bell", player), + lambda state: state.has(laurels, player) + or (has_lantern(state, player, options) and has_sword(state, player))) + set_rule(multiworld.get_location("Overworld - [Northwest] Chest Beneath Quarry Gate", player), + lambda state: state.has_any({grapple, laurels}, player) or options.logic_rules) + set_rule(multiworld.get_location("Overworld - [East] Grapple Chest", player), + lambda state: state.has(grapple, player)) + set_rule(multiworld.get_location("Special Shop - Secret Page Pickup", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Sealed Temple - Holy Cross Chest", player), + lambda state: has_ability(state, player, holy_cross, options, ability_unlocks) and + (state.has(laurels, player) + or (has_lantern(state, player, options) and + (has_sword(state, player) or state.has(fire_wand, player))) + or has_ice_grapple_logic(False, state, player, options, ability_unlocks))) + set_rule(multiworld.get_location("Sealed Temple - Page Pickup", player), + lambda state: state.has(laurels, player) + or (has_lantern(state, player, options) and (has_sword(state, player) or state.has(fire_wand, player))) + or has_ice_grapple_logic(False, state, player, options, ability_unlocks)) + + set_rule(multiworld.get_location("Secret Gathering Place - 10 Fairy Reward", player), + lambda state: state.has(fairies, player, 10)) + set_rule(multiworld.get_location("Secret Gathering Place - 20 Fairy Reward", player), + lambda state: state.has(fairies, player, 20)) + set_rule(multiworld.get_location("Coins in the Well - 3 Coins", player), + lambda state: state.has(coins, player, 3)) + set_rule(multiworld.get_location("Coins in the Well - 6 Coins", player), + lambda state: state.has(coins, player, 6)) + set_rule(multiworld.get_location("Coins in the Well - 10 Coins", player), + lambda state: state.has(coins, player, 10)) + set_rule(multiworld.get_location("Coins in the Well - 15 Coins", player), + lambda state: state.has(coins, player, 15)) + + # East Forest + set_rule(multiworld.get_location("East Forest - Lower Grapple Chest", player), + lambda state: state.has(grapple, player)) + set_rule(multiworld.get_location("East Forest - Lower Dash Chest", player), + lambda state: state.has_all({grapple, laurels}, player)) + set_rule(multiworld.get_location("East Forest - Ice Rod Grapple Chest", player), + lambda state: state.has_all({grapple, ice_dagger, fire_wand}, player) + and has_ability(state, player, ice_rod, options, ability_unlocks)) + + # West Garden + set_rule(multiworld.get_location("West Garden - [North] Across From Page Pickup", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("West Garden - [West] In Flooded Walkway", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("West Garden - [West Lowlands] Tree Holy Cross Chest", player), + lambda state: state.has(laurels, player) + and has_ability(state, player, holy_cross, options, ability_unlocks)) + set_rule(multiworld.get_location("West Garden - [East Lowlands] Page Behind Ice Dagger House", player), + lambda state: (state.has(laurels, player) and has_ability(state, player, prayer, options, ability_unlocks)) + or has_ice_grapple_logic(True, state, player, options, ability_unlocks)) + set_rule(multiworld.get_location("West Garden - [Central Lowlands] Below Left Walkway", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("West Garden - [Central Highlands] After Garden Knight", player), + lambda state: has_sword(state, player) or state.has(laurels, player) + or has_ice_grapple_logic(False, state, player, options, ability_unlocks) + or can_ladder_storage(state, player, options)) + + # Ruined Atoll + set_rule(multiworld.get_location("Ruined Atoll - [West] Near Kevin Block", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Ruined Atoll - [East] Locked Room Lower Chest", player), + lambda state: state.has_any({laurels, key}, player)) + set_rule(multiworld.get_location("Ruined Atoll - [East] Locked Room Upper Chest", player), + lambda state: state.has_any({laurels, key}, player)) + set_rule(multiworld.get_location("Librarian - Hexagon Green", player), + lambda state: has_sword(state, player) or options.logic_rules) + + # Frog's Domain + set_rule(multiworld.get_location("Frog's Domain - Side Room Grapple Secret", player), + lambda state: state.has_any({grapple, laurels}, player)) + set_rule(multiworld.get_location("Frog's Domain - Grapple Above Hot Tub", player), + lambda state: state.has_any({grapple, laurels}, player)) + set_rule(multiworld.get_location("Frog's Domain - Escape Chest", player), + lambda state: state.has_any({grapple, laurels}, player)) + + # Eastern Vault Fortress + set_rule(multiworld.get_location("Fortress Leaf Piles - Secret Chest", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Fortress Arena - Siege Engine/Vault Key Pickup", player), + lambda state: has_sword(state, player) and + (has_ability(state, player, prayer, options, ability_unlocks) + or has_ice_grapple_logic(False, state, player, options, ability_unlocks))) + set_rule(multiworld.get_location("Fortress Arena - Hexagon Red", player), + lambda state: state.has(vault_key, player) and + (has_ability(state, player, prayer, options, ability_unlocks) + or has_ice_grapple_logic(False, state, player, options, ability_unlocks))) + + # Beneath the Vault + set_rule(multiworld.get_location("Beneath the Fortress - Bridge", player), + lambda state: has_stick(state, player) or state.has_any({laurels, fire_wand}, player)) + set_rule(multiworld.get_location("Beneath the Fortress - Obscured Behind Waterfall", player), + lambda state: has_stick(state, player) and has_lantern(state, player, options)) + + # Quarry + set_rule(multiworld.get_location("Quarry - [Central] Above Ladder Dash Chest", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Quarry - [West] Upper Area Bombable Wall", player), + lambda state: has_mask(state, player, options)) + set_rule(multiworld.get_location("Rooted Ziggurat Lower - Hexagon Blue", player), + lambda state: has_sword(state, player)) + + # Swamp + set_rule(multiworld.get_location("Cathedral Gauntlet - Gauntlet Reward", player), + lambda state: state.has(laurels, player) and state.has(fire_wand, player) and has_sword(state, player)) + set_rule(multiworld.get_location("Swamp - [Entrance] Above Entryway", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Swamp - [South Graveyard] Upper Walkway Dash Chest", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Swamp - [Outside Cathedral] Obscured Behind Memorial", player), + lambda state: state.has(laurels, player)) + set_rule(multiworld.get_location("Swamp - [South Graveyard] 4 Orange Skulls", player), + lambda state: has_sword(state, player)) + set_rule(multiworld.get_location("Swamp - [South Graveyard] Guarded By Tentacles", player), + lambda state: has_sword(state, player)) + + # Hero's Grave + set_rule(multiworld.get_location("Hero's Grave - Tooth Relic", player), + lambda state: state.has(laurels, player) and has_ability(state, player, prayer, options, ability_unlocks)) + set_rule(multiworld.get_location("Hero's Grave - Mushroom Relic", player), + lambda state: state.has(laurels, player) and has_ability(state, player, prayer, options, ability_unlocks)) + set_rule(multiworld.get_location("Hero's Grave - Ash Relic", player), + lambda state: state.has(laurels, player) and has_ability(state, player, prayer, options, ability_unlocks)) + set_rule(multiworld.get_location("Hero's Grave - Flowers Relic", player), + lambda state: state.has(laurels, player) and has_ability(state, player, prayer, options, ability_unlocks)) + set_rule(multiworld.get_location("Hero's Grave - Effigy Relic", player), + lambda state: state.has(laurels, player) and has_ability(state, player, prayer, options, ability_unlocks)) + set_rule(multiworld.get_location("Hero's Grave - Feathers Relic", player), + lambda state: state.has(laurels, player) and has_ability(state, player, prayer, options, ability_unlocks)) diff --git a/worlds/tunic/test/__init__.py b/worlds/tunic/test/__init__.py new file mode 100644 index 000000000000..f8ab99d67d24 --- /dev/null +++ b/worlds/tunic/test/__init__.py @@ -0,0 +1,6 @@ +from test.bases import WorldTestBase + + +class TunicTestBase(WorldTestBase): + game = "Tunic" + player: int = 1 \ No newline at end of file diff --git a/worlds/tunic/test/test_access.py b/worlds/tunic/test/test_access.py new file mode 100644 index 000000000000..d74858bd27ef --- /dev/null +++ b/worlds/tunic/test/test_access.py @@ -0,0 +1,70 @@ +from . import TunicTestBase +from .. import options + + +class TestAccess(TunicTestBase): + # test whether you can get into the temple without laurels + def test_temple_access(self): + self.collect_all_but(["Hero's Laurels", "Lantern"]) + self.assertFalse(self.can_reach_location("Sealed Temple - Page Pickup")) + self.collect_by_name(["Lantern"]) + self.assertTrue(self.can_reach_location("Sealed Temple - Page Pickup")) + + # test that the wells function properly. Since fairies is written the same way, that should succeed too + def test_wells(self): + self.collect_all_but(["Golden Coin"]) + self.assertFalse(self.can_reach_location("Coins in the Well - 3 Coins")) + self.collect_by_name(["Golden Coin"]) + self.assertTrue(self.can_reach_location("Coins in the Well - 3 Coins")) + + +class TestStandardShuffle(TunicTestBase): + options = {options.AbilityShuffling.internal_name: options.AbilityShuffling.option_true} + + # test that you need to get holy cross to open the hc door in overworld + def test_hc_door(self): + self.assertFalse(self.can_reach_location("Fountain Cross Door - Page Pickup")) + self.collect_by_name("Pages 42-43 (Holy Cross)") + self.assertTrue(self.can_reach_location("Fountain Cross Door - Page Pickup")) + + +class TestHexQuestShuffle(TunicTestBase): + options = {options.HexagonQuest.internal_name: options.HexagonQuest.option_true, + options.AbilityShuffling.internal_name: options.AbilityShuffling.option_true} + + # test that you need the gold questagons to open the hc door in overworld + def test_hc_door_hex_shuffle(self): + self.assertFalse(self.can_reach_location("Fountain Cross Door - Page Pickup")) + self.collect_by_name("Gold Questagon") + self.assertTrue(self.can_reach_location("Fountain Cross Door - Page Pickup")) + + +class TestHexQuestNoShuffle(TunicTestBase): + options = {options.HexagonQuest.internal_name: options.HexagonQuest.option_true, + options.AbilityShuffling.internal_name: options.AbilityShuffling.option_false} + + # test that you can get the item behind the overworld hc door with nothing and no ability shuffle + def test_hc_door_no_shuffle(self): + self.assertTrue(self.can_reach_location("Fountain Cross Door - Page Pickup")) + + +class TestNormalGoal(TunicTestBase): + options = {options.HexagonQuest.internal_name: options.HexagonQuest.option_false} + + # test that you need the three colored hexes to reach the Heir in standard + def test_normal_goal(self): + location = ["The Heir"] + items = [["Red Questagon", "Blue Questagon", "Green Questagon"]] + self.assertAccessDependency(location, items) + + +class TestER(TunicTestBase): + options = {options.EntranceRando.internal_name: options.EntranceRando.option_true, + options.AbilityShuffling.internal_name: options.AbilityShuffling.option_true, + options.HexagonQuest.internal_name: options.HexagonQuest.option_false} + + def test_overworld_hc_chest(self): + # test to see that static connections are working properly -- this chest requires holy cross and is in Overworld + self.assertFalse(self.can_reach_location("Overworld - [Southwest] Flowers Holy Cross")) + self.collect_by_name(["Pages 42-43 (Holy Cross)"]) + self.assertTrue(self.can_reach_location("Overworld - [Southwest] Flowers Holy Cross")) diff --git a/worlds/undertale/docs/setup_en.md b/worlds/undertale/docs/setup_en.md index f82105c26916..3c20b614d3fa 100644 --- a/worlds/undertale/docs/setup_en.md +++ b/worlds/undertale/docs/setup_en.md @@ -4,7 +4,6 @@ - Undertale from the [Steam page](https://store.steampowered.com/app/391540) - Archipelago from the [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases) - - (select `Undertale Client` during installation.) ### First time setup diff --git a/worlds/v6/Options.py b/worlds/v6/Options.py index 107fbab465e1..1950d1bcbd02 100644 --- a/worlds/v6/Options.py +++ b/worlds/v6/Options.py @@ -1,8 +1,10 @@ import typing -from Options import Option, DeathLink, Range, Toggle +from dataclasses import dataclass +from Options import Option, DeathLink, Range, Toggle, PerGameCommonOptions class DoorCost(Range): """Amount of Trinkets required to enter Areas. Set to 0 to disable artificial locks.""" + display_name = "Door Cost" range_start = 0 range_end = 3 default = 3 @@ -13,6 +15,7 @@ class AreaCostRandomizer(Toggle): class DeathLinkAmnesty(Range): """Amount of Deaths to take before sending a DeathLink signal, for balancing difficulty""" + display_name = "Death Link Amnesty" range_start = 0 range_end = 30 default = 15 @@ -25,11 +28,11 @@ class MusicRandomizer(Toggle): """Randomize Music""" display_name = "Music Randomizer" -v6_options: typing.Dict[str,type(Option)] = { - "MusicRandomizer": MusicRandomizer, - "AreaRandomizer": AreaRandomizer, - "DoorCost": DoorCost, - "AreaCostRandomizer": AreaCostRandomizer, - "death_link": DeathLink, - "DeathLinkAmnesty": DeathLinkAmnesty -} \ No newline at end of file +@dataclass +class V6Options(PerGameCommonOptions): + music_rando: MusicRandomizer + area_rando: AreaRandomizer + door_cost: DoorCost + area_cost: AreaCostRandomizer + death_link: DeathLink + death_link_amnesty: DeathLinkAmnesty diff --git a/worlds/v6/Regions.py b/worlds/v6/Regions.py index 5a8f0315f44a..f6e9ee753890 100644 --- a/worlds/v6/Regions.py +++ b/worlds/v6/Regions.py @@ -31,14 +31,3 @@ def create_regions(world: MultiWorld, player: int): locWrp_names = ["Edge Games"] regWrp.locations += [V6Location(player, loc_name, location_table[loc_name], regWrp) for loc_name in locWrp_names] world.regions.append(regWrp) - - -def connect_regions(world: MultiWorld, player: int, source: str, target: str, rule): - sourceRegion = world.get_region(source, player) - targetRegion = world.get_region(target, player) - - connection = Entrance(player,'', sourceRegion) - connection.access_rule = rule - - sourceRegion.exits.append(connection) - connection.connect(targetRegion) \ No newline at end of file diff --git a/worlds/v6/Rules.py b/worlds/v6/Rules.py index ecb34f2f32ff..bf0d60499eb5 100644 --- a/worlds/v6/Rules.py +++ b/worlds/v6/Rules.py @@ -1,6 +1,6 @@ import typing from ..generic.Rules import add_rule -from .Regions import connect_regions, v6areas +from .Regions import v6areas def _has_trinket_range(state, player, start, end) -> bool: @@ -10,34 +10,36 @@ def _has_trinket_range(state, player, start, end) -> bool: return True -def set_rules(world, player, area_connections: typing.Dict[int, int], area_cost_map: typing.Dict[int, int]): +def set_rules(multiworld, options, player, area_connections: typing.Dict[int, int], area_cost_map: typing.Dict[int, int]): areashuffle = list(range(len(v6areas))) - if world.AreaRandomizer[player].value: - world.random.shuffle(areashuffle) + if options.area_rando: + multiworld.random.shuffle(areashuffle) area_connections.update({(index + 1): (value + 1) for index, value in enumerate(areashuffle)}) area_connections.update({0: 0}) - if world.AreaCostRandomizer[player].value: - world.random.shuffle(areashuffle) + if options.area_cost: + multiworld.random.shuffle(areashuffle) area_cost_map.update({(index + 1): (value + 1) for index, value in enumerate(areashuffle)}) area_cost_map.update({0: 0}) + menu_region = multiworld.get_region("Menu", player) for i in range(1, 5): - connect_regions(world, player, "Menu", v6areas[area_connections[i] - 1], - lambda state, i=i: _has_trinket_range(state, player, - world.DoorCost[player].value * (area_cost_map[i] - 1), - world.DoorCost[player].value * area_cost_map[i])) + target_region = multiworld.get_region(v6areas[area_connections[i] - 1], player) + menu_region.connect(connecting_region=target_region, + rule=lambda state, i=i: _has_trinket_range(state, player, + options.door_cost * (area_cost_map[i] - 1), + options.door_cost * area_cost_map[i])) # Special Rule for V - add_rule(world.get_location("V", player), lambda state: state.can_reach("Laboratory", 'Region', player) and + add_rule(multiworld.get_location("V", player), lambda state: state.can_reach("Laboratory", 'Region', player) and state.can_reach("The Tower", 'Region', player) and state.can_reach("Space Station 2", 'Region', player) and state.can_reach("Warp Zone", 'Region', player)) # Special Rule for NPC Trinket - add_rule(world.get_location("NPC Trinket", player), + add_rule(multiworld.get_location("NPC Trinket", player), lambda state: state.can_reach("Laboratory", 'Region', player) or (state.can_reach("The Tower", 'Region', player) and state.can_reach("Space Station 2", 'Region', player) and state.can_reach("Warp Zone", 'Region', player))) - world.completion_condition[player] = lambda state: state.can_reach("V", 'Location', player) + multiworld.completion_condition[player] = lambda state: state.can_reach("V", 'Location', player) diff --git a/worlds/v6/__init__.py b/worlds/v6/__init__.py index 6ff7fba60c2d..30a76f82cce6 100644 --- a/worlds/v6/__init__.py +++ b/worlds/v6/__init__.py @@ -2,7 +2,7 @@ import os, json from .Items import item_table, V6Item from .Locations import location_table, V6Location -from .Options import v6_options +from .Options import V6Options from .Rules import set_rules from .Regions import create_regions from BaseClasses import Item, ItemClassification, Tutorial @@ -41,7 +41,7 @@ class V6World(World): music_map: typing.Dict[int,int] - option_definitions = v6_options + options_dataclass = V6Options def create_regions(self): create_regions(self.multiworld, self.player) @@ -49,7 +49,7 @@ def create_regions(self): def set_rules(self): self.area_connections = {} self.area_cost_map = {} - set_rules(self.multiworld, self.player, self.area_connections, self.area_cost_map) + set_rules(self.multiworld, self.options, self.player, self.area_connections, self.area_cost_map) def create_item(self, name: str) -> Item: return V6Item(name, ItemClassification.progression, item_table[name], self.player) @@ -61,7 +61,7 @@ def create_items(self): def generate_basic(self): musiclist_o = [1,2,3,4,9,12] musiclist_s = musiclist_o.copy() - if self.multiworld.MusicRandomizer[self.player].value: + if self.options.music_rando: self.multiworld.random.shuffle(musiclist_s) self.music_map = dict(zip(musiclist_o, musiclist_s)) @@ -69,10 +69,10 @@ def fill_slot_data(self): return { "MusicRando": self.music_map, "AreaRando": self.area_connections, - "DoorCost": self.multiworld.DoorCost[self.player].value, + "DoorCost": self.options.door_cost.value, "AreaCostRando": self.area_cost_map, - "DeathLink": self.multiworld.death_link[self.player].value, - "DeathLink_Amnesty": self.multiworld.DeathLinkAmnesty[self.player].value + "DeathLink": self.options.death_link.value, + "DeathLink_Amnesty": self.options.death_link_amnesty.value } def generate_output(self, output_directory: str): diff --git a/worlds/witness/WitnessItems.txt b/worlds/witness/WitnessItems.txt index 750d6bd4ebec..e17464a0923a 100644 --- a/worlds/witness/WitnessItems.txt +++ b/worlds/witness/WitnessItems.txt @@ -16,6 +16,7 @@ Symbols: 72 - Colored Squares 80 - Arrows 200 - Progressive Dots - Dots,Full Dots +210 - Progressive Symmetry - Symmetry,Colored Dots 260 - Progressive Stars - Stars,Stars + Same Colored Symbol Useful: @@ -29,8 +30,9 @@ Filler: #503 - Energy Fill (Max) - 1 Traps: -600 - Slowness - 8 +600 - Slowness - 6 610 - Power Surge - 2 +615 - Bonk - 1 Jokes: 650 - Functioning Brain @@ -41,10 +43,13 @@ Doors: 1102 - Tutorial Outpost Exit (Panel) - 0x04CA4 1105 - Symmetry Island Lower (Panel) - 0x000B0 1107 - Symmetry Island Upper (Panel) - 0x1C349 +1108 - Desert Surface 3 Control (Panel) - 0x09FA0 +1109 - Desert Surface 8 Control (Panel) - 0x09F86 1110 - Desert Light Room Entry (Panel) - 0x0C339 1111 - Desert Flood Controls (Panel) - 0x1C2DF,0x1831E,0x1C260,0x1831C,0x1C2F3,0x1831D,0x1C2B1,0x1831B 1112 - Desert Light Control (Panel) - 0x09FAA 1113 - Desert Flood Room Entry (Panel) - 0x0A249 +1114 - Desert Elevator Room Hexagonal Control (Panel) - 0x0A015 1115 - Quarry Elevator Control (Panel) - 0x17CC4 1117 - Quarry Entry 1 (Panel) - 0x09E57 1118 - Quarry Entry 2 (Panel) - 0x17C09 @@ -69,6 +74,7 @@ Doors: 1167 - Town Maze Rooftop Bridge (Panel) - 0x2896A 1169 - Town Windmill Entry (Panel) - 0x17F5F 1172 - Town Cargo Box Entry (Panel) - 0x0A0C8 +1173 - Town Desert Laser Redirect Control (Panel) - 0x09F98 1182 - Windmill Turn Control (Panel) - 0x17D02 1184 - Theater Entry (Panel) - 0x17F89 1185 - Theater Video Input (Panel) - 0x00815 @@ -231,10 +237,10 @@ Doors: 1984 - Caves Shortcuts - 0x2D859,0x2D73F 1987 - Tunnels Doors - 0x27739,0x27263,0x09E87,0x0348A -2000 - Desert Control Panels - 0x09FAA,0x1C2DF,0x1831E,0x1C260,0x1831C,0x1C2F3,0x1831D,0x1C2B1,0x1831B +2000 - Desert Control Panels - 0x09FAA,0x1C2DF,0x1831E,0x1C260,0x1831C,0x1C2F3,0x1831D,0x1C2B1,0x1831B,0x0A015,0x09FA0,0x09F86 2005 - Quarry Stoneworks Control Panels - 0x03678,0x03676,0x03679,0x03675 2010 - Quarry Boathouse Control Panels - 0x03852,0x03858,0x275FA -2015 - Town Control Panels - 0x2896A,0x334D8 +2015 - Town Control Panels - 0x2896A,0x334D8,0x09F98 2020 - Windmill & Theater Control Panels - 0x17D02,0x00815 2025 - Bunker Control Panels - 0x34BC5,0x34BC6,0x0A079 2030 - Swamp Control Panels - 0x00609,0x18488,0x181F5,0x17E2B,0x17C0A,0x17E07 @@ -242,7 +248,7 @@ Doors: 2100 - Symmetry Island Panels - 0x1C349,0x000B0 2101 - Tutorial Outpost Panels - 0x0A171,0x04CA4 -2105 - Desert Panels - 0x09FAA,0x1C2DF,0x1831E,0x1C260,0x1831C,0x1C2F3,0x1831D,0x1C2B1,0x1831B,0x0C339,0x0A249 +2105 - Desert Panels - 0x09FAA,0x1C2DF,0x1831E,0x1C260,0x1831C,0x1C2F3,0x1831D,0x1C2B1,0x1831B,0x0C339,0x0A249,0x0A015,0x09FA0,0x09F86 2110 - Quarry Outside Panels - 0x17C09,0x09E57,0x17CC4 2115 - Quarry Stoneworks Panels - 0x01E5A,0x01E59,0x03678,0x03676,0x03679,0x03675 2120 - Quarry Boathouse Panels - 0x03852,0x03858,0x275FA @@ -250,6 +256,7 @@ Doors: 2125 - Monastery Panels - 0x09D9B,0x00C92,0x00B10 2130 - Town Church & RGB House Panels - 0x28998,0x28A0D,0x334D8 2135 - Town Maze Panels - 0x2896A,0x28A79 +2137 - Town Dockside House Panels - 0x0A0C8,0x09F98 2140 - Windmill & Theater Panels - 0x17D02,0x00815,0x17F5F,0x17F89,0x0A168,0x33AB2 2145 - Treehouse Panels - 0x0A182,0x0288C,0x02886,0x2700B,0x17CBC,0x037FF 2150 - Bunker Panels - 0x34BC5,0x34BC6,0x0A079,0x0A099,0x17C2E diff --git a/worlds/witness/WitnessLogic.txt b/worlds/witness/WitnessLogic.txt index acfbe8c14eb0..ec0922bec697 100644 --- a/worlds/witness/WitnessLogic.txt +++ b/worlds/witness/WitnessLogic.txt @@ -209,12 +209,12 @@ Door - 0x0C316 (Elevator Room Entry) - 0x18076 159034 - 0x337F8 (Flood Room EP) - 0x1C2DF - True Desert Elevator Room (Desert) - Desert Lowest Level Inbetween Shortcuts - 0x01317: -158111 - 0x17C31 (Final Transparent) - True - True -158113 - 0x012D7 (Final Hexagonal) - 0x17C31 & 0x0A015 - True -158114 - 0x0A015 (Final Hexagonal Control) - 0x17C31 - True -158115 - 0x0A15C (Final Bent 1) - True - True -158116 - 0x09FFF (Final Bent 2) - 0x0A15C - True -158117 - 0x0A15F (Final Bent 3) - 0x09FFF - True +158111 - 0x17C31 (Elevator Room Transparent) - True - True +158113 - 0x012D7 (Elevator Room Hexagonal) - 0x17C31 & 0x0A015 - True +158114 - 0x0A015 (Elevator Room Hexagonal Control) - 0x17C31 - True +158115 - 0x0A15C (Elevator Room Bent 1) - True - True +158116 - 0x09FFF (Elevator Room Bent 2) - 0x0A15C - True +158117 - 0x0A15F (Elevator Room Bent 3) - 0x09FFF - True 159035 - 0x037BB (Elevator EP) - 0x01317 - True Door - 0x01317 (Elevator) - 0x03608 @@ -474,7 +474,7 @@ Town (Town) - Main Island - True - The Ocean - 0x0A054 - Town Maze Rooftop - 0x2 158218 - 0x0A054 (Boat Spawn) - 0x17CA6 | 0x17CDF | 0x09DB8 | 0x17C95 - Boat 158219 - 0x0A0C8 (Cargo Box Entry Panel) - True - Black/White Squares & Shapers Door - 0x0A0C9 (Cargo Box Entry) - 0x0A0C8 -158707 - 0x09F98 (Desert Laser Redirect) - True - True +158707 - 0x09F98 (Desert Laser Redirect Control) - True - True 158220 - 0x18590 (Transparent) - True - Symmetry 158221 - 0x28AE3 (Vines) - 0x18590 - True 158222 - 0x28938 (Apple Tree) - 0x28AE3 - True @@ -895,9 +895,9 @@ Mountainside Vault (Mountainside): Mountaintop (Mountaintop) - Mountain Top Layer - 0x17C34: 158405 - 0x0042D (River Shape) - True - True -158406 - 0x09F7F (Box Short) - 7 Lasers - True +158406 - 0x09F7F (Box Short) - 7 Lasers + Redirect - True 158407 - 0x17C34 (Mountain Entry Panel) - 0x09F7F - Stars & Black/White Squares & Stars + Same Colored Symbol -158800 - 0xFFF00 (Box Long) - 11 Lasers & 0x17C34 - True +158800 - 0xFFF00 (Box Long) - 11 Lasers + Redirect & 0x17C34 - True 159300 - 0x001A3 (River Shape EP) - True - True 159320 - 0x3370E (Arch Black EP) - True - True 159324 - 0x336C8 (Arch White Right EP) - True - True diff --git a/worlds/witness/WitnessLogicExpert.txt b/worlds/witness/WitnessLogicExpert.txt index b1d9b8e30e40..056ae145c47e 100644 --- a/worlds/witness/WitnessLogicExpert.txt +++ b/worlds/witness/WitnessLogicExpert.txt @@ -209,12 +209,12 @@ Door - 0x0C316 (Elevator Room Entry) - 0x18076 159034 - 0x337F8 (Flood Room EP) - 0x1C2DF - True Desert Elevator Room (Desert) - Desert Lowest Level Inbetween Shortcuts - 0x01317: -158111 - 0x17C31 (Final Transparent) - True - True -158113 - 0x012D7 (Final Hexagonal) - 0x17C31 & 0x0A015 - True -158114 - 0x0A015 (Final Hexagonal Control) - 0x17C31 - True -158115 - 0x0A15C (Final Bent 1) - True - True -158116 - 0x09FFF (Final Bent 2) - 0x0A15C - True -158117 - 0x0A15F (Final Bent 3) - 0x09FFF - True +158111 - 0x17C31 (Elevator Room Transparent) - True - True +158113 - 0x012D7 (Elevator Room Hexagonal) - 0x17C31 & 0x0A015 - True +158114 - 0x0A015 (Elevator Room Hexagonal Control) - 0x17C31 - True +158115 - 0x0A15C (Elevator Room Bent 1) - True - True +158116 - 0x09FFF (Elevator Room Bent 2) - 0x0A15C - True +158117 - 0x0A15F (Elevator Room Bent 3) - 0x09FFF - True 159035 - 0x037BB (Elevator EP) - 0x01317 - True Door - 0x01317 (Elevator) - 0x03608 @@ -474,7 +474,7 @@ Town (Town) - Main Island - True - The Ocean - 0x0A054 - Town Maze Rooftop - 0x2 158218 - 0x0A054 (Boat Spawn) - 0x17CA6 | 0x17CDF | 0x09DB8 | 0x17C95 - Boat 158219 - 0x0A0C8 (Cargo Box Entry Panel) - True - Squares & Black/White Squares & Shapers & Triangles Door - 0x0A0C9 (Cargo Box Entry) - 0x0A0C8 -158707 - 0x09F98 (Desert Laser Redirect) - True - True +158707 - 0x09F98 (Desert Laser Redirect Control) - True - True 158220 - 0x18590 (Transparent) - True - Symmetry 158221 - 0x28AE3 (Vines) - 0x18590 - True 158222 - 0x28938 (Apple Tree) - 0x28AE3 - True @@ -895,9 +895,9 @@ Mountainside Vault (Mountainside): Mountaintop (Mountaintop) - Mountain Top Layer - 0x17C34: 158405 - 0x0042D (River Shape) - True - True -158406 - 0x09F7F (Box Short) - 7 Lasers - True +158406 - 0x09F7F (Box Short) - 7 Lasers + Redirect - True 158407 - 0x17C34 (Mountain Entry Panel) - 0x09F7F - Stars & Black/White Squares & Stars + Same Colored Symbol & Triangles -158800 - 0xFFF00 (Box Long) - 11 Lasers & 0x17C34 - True +158800 - 0xFFF00 (Box Long) - 11 Lasers + Redirect & 0x17C34 - True 159300 - 0x001A3 (River Shape EP) - True - True 159320 - 0x3370E (Arch Black EP) - True - True 159324 - 0x336C8 (Arch White Right EP) - True - True diff --git a/worlds/witness/WitnessLogicVanilla.txt b/worlds/witness/WitnessLogicVanilla.txt index 779ead6bde4b..71af12f76dbb 100644 --- a/worlds/witness/WitnessLogicVanilla.txt +++ b/worlds/witness/WitnessLogicVanilla.txt @@ -209,12 +209,12 @@ Door - 0x0C316 (Elevator Room Entry) - 0x18076 159034 - 0x337F8 (Flood Room EP) - 0x1C2DF - True Desert Elevator Room (Desert) - Desert Lowest Level Inbetween Shortcuts - 0x01317: -158111 - 0x17C31 (Final Transparent) - True - True -158113 - 0x012D7 (Final Hexagonal) - 0x17C31 & 0x0A015 - True -158114 - 0x0A015 (Final Hexagonal Control) - 0x17C31 - True -158115 - 0x0A15C (Final Bent 1) - True - True -158116 - 0x09FFF (Final Bent 2) - 0x0A15C - True -158117 - 0x0A15F (Final Bent 3) - 0x09FFF - True +158111 - 0x17C31 (Elevator Room Transparent) - True - True +158113 - 0x012D7 (Elevator Room Hexagonal) - 0x17C31 & 0x0A015 - True +158114 - 0x0A015 (Elevator Room Hexagonal Control) - 0x17C31 - True +158115 - 0x0A15C (Elevator Room Bent 1) - True - True +158116 - 0x09FFF (Elevator Room Bent 2) - 0x0A15C - True +158117 - 0x0A15F (Elevator Room Bent 3) - 0x09FFF - True 159035 - 0x037BB (Elevator EP) - 0x01317 - True Door - 0x01317 (Elevator) - 0x03608 @@ -474,7 +474,7 @@ Town (Town) - Main Island - True - The Ocean - 0x0A054 - Town Maze Rooftop - 0x2 158218 - 0x0A054 (Boat Spawn) - 0x17CA6 | 0x17CDF | 0x09DB8 | 0x17C95 - Boat 158219 - 0x0A0C8 (Cargo Box Entry Panel) - True - Black/White Squares & Shapers Door - 0x0A0C9 (Cargo Box Entry) - 0x0A0C8 -158707 - 0x09F98 (Desert Laser Redirect) - True - True +158707 - 0x09F98 (Desert Laser Redirect Control) - True - True 158220 - 0x18590 (Transparent) - True - Symmetry 158221 - 0x28AE3 (Vines) - 0x18590 - True 158222 - 0x28938 (Apple Tree) - 0x28AE3 - True @@ -895,9 +895,9 @@ Mountainside Vault (Mountainside): Mountaintop (Mountaintop) - Mountain Top Layer - 0x17C34: 158405 - 0x0042D (River Shape) - True - True -158406 - 0x09F7F (Box Short) - 7 Lasers - True +158406 - 0x09F7F (Box Short) - 7 Lasers + Redirect - True 158407 - 0x17C34 (Mountain Entry Panel) - 0x09F7F - Black/White Squares -158800 - 0xFFF00 (Box Long) - 11 Lasers & 0x17C34 - True +158800 - 0xFFF00 (Box Long) - 11 Lasers + Redirect & 0x17C34 - True 159300 - 0x001A3 (River Shape EP) - True - True 159320 - 0x3370E (Arch Black EP) - True - True 159324 - 0x336C8 (Arch White Right EP) - True - True diff --git a/worlds/witness/__init__.py b/worlds/witness/__init__.py index 6360c33aefb9..a645abc08125 100644 --- a/worlds/witness/__init__.py +++ b/worlds/witness/__init__.py @@ -6,6 +6,7 @@ from BaseClasses import Region, Location, MultiWorld, Item, Entrance, Tutorial, CollectionState from Options import PerGameCommonOptions, Toggle +from .presets import witness_option_presets from .hints import get_always_hint_locations, get_always_hint_items, get_priority_hint_locations, \ get_priority_hint_items, make_hints, generate_joke_hints from worlds.AutoWorld import World, WebWorld @@ -15,7 +16,7 @@ from .items import WitnessItem, StaticWitnessItems, WitnessPlayerItems, ItemData from .regions import WitnessRegions from .rules import set_rules -from .Options import TheWitnessOptions +from .options import TheWitnessOptions from .utils import get_audio_logs from logging import warning, error @@ -31,6 +32,8 @@ class WitnessWebWorld(WebWorld): ["NewSoupVi", "Jarno"] )] + options_presets = witness_option_presets + class WitnessWorld(World): """ @@ -40,7 +43,6 @@ class WitnessWorld(World): """ game = "The Witness" topology_present = False - data_version = 14 StaticWitnessLogic() StaticWitnessLocations() @@ -88,10 +90,10 @@ def _get_slot_data(self): } def generate_early(self): - disabled_locations = self.multiworld.exclude_locations[self.player].value + disabled_locations = self.options.exclude_locations.value self.player_logic = WitnessPlayerLogic( - self, disabled_locations, self.multiworld.start_inventory[self.player].value + self, disabled_locations, self.options.start_inventory.value ) self.locat: WitnessPlayerLocations = WitnessPlayerLocations(self, self.player_logic) @@ -102,14 +104,29 @@ def generate_early(self): self.log_ids_to_hints = dict() - if not (self.options.shuffle_symbols or self.options.shuffle_doors or self.options.shuffle_lasers): - if self.multiworld.players == 1: - warning(f"{self.multiworld.get_player_name(self.player)}'s Witness world doesn't have any progression" - f" items. Please turn on Symbol Shuffle, Door Shuffle or Laser Shuffle if that doesn't" - f" seem right.") - else: - raise Exception(f"{self.multiworld.get_player_name(self.player)}'s Witness world doesn't have any" - f" progression items. Please turn on Symbol Shuffle, Door Shuffle or Laser Shuffle.") + interacts_with_multiworld = ( + self.options.shuffle_symbols or + self.options.shuffle_doors or + self.options.shuffle_lasers == "anywhere" + ) + + has_progression = ( + interacts_with_multiworld + or self.options.shuffle_lasers == "local" + or self.options.shuffle_boat + or self.options.early_caves == "add_to_pool" + ) + + if not has_progression and self.multiworld.players == 1: + warning(f"{self.multiworld.get_player_name(self.player)}'s Witness world doesn't have any progression" + f" items. Please turn on Symbol Shuffle, Door Shuffle or Laser Shuffle if that doesn't seem right.") + elif not interacts_with_multiworld and self.multiworld.players > 1: + raise Exception(f"{self.multiworld.get_player_name(self.player)}'s Witness world doesn't have enough" + f" progression items that can be placed in other players' worlds. Please turn on Symbol" + f" Shuffle, Door Shuffle or non-local Laser Shuffle.") + + if self.options.shuffle_lasers == "local": + self.options.local_items.value |= self.item_name_groups["Lasers"] def create_regions(self): self.regio.create_regions(self, self.player_logic) @@ -176,7 +193,8 @@ def create_regions(self): extra_checks = [ ("First Hallway Room", "First Hallway Bend"), ("First Hallway", "First Hallway Straight"), - ("Desert Outside", "Desert Surface 3"), + ("Desert Outside", "Desert Surface 1"), + ("Desert Outside", "Desert Surface 2"), ] for i in range(num_early_locs, needed_size): @@ -253,7 +271,7 @@ def create_items(self): self.own_itempool += new_items self.multiworld.itempool += new_items if self.items.item_data[item_name].local_only: - self.multiworld.local_items[self.player].value.add(item_name) + self.options.local_items.value.add(item_name) def fill_slot_data(self) -> dict: hint_amount = self.options.hint_amount.value diff --git a/worlds/witness/hints.py b/worlds/witness/hints.py index d238aa4adfb6..c00827feee20 100644 --- a/worlds/witness/hints.py +++ b/worlds/witness/hints.py @@ -187,8 +187,8 @@ def get_always_hint_items(world: "WitnessWorld") -> List[str]: return always -def get_always_hint_locations(_: "WitnessWorld") -> List[str]: - return [ +def get_always_hint_locations(world: "WitnessWorld") -> List[str]: + always = [ "Challenge Vault Box", "Mountain Bottom Floor Discard", "Theater Eclipse EP", @@ -196,6 +196,16 @@ def get_always_hint_locations(_: "WitnessWorld") -> List[str]: "Mountainside Cloud Cycle EP", ] + # Add Obelisk Sides that contain EPs that are meant to be hinted, if they are necessary to complete the Obelisk Side + if world.options.EP_difficulty == "eclipse": + always.append("Town Obelisk Side 6") # Eclipse EP + + if world.options.EP_difficulty != "normal": + always.append("Treehouse Obelisk Side 4") # Couch EP + always.append("River Obelisk Side 1") # Cloud Cycle EP. Needs to be changed to "Mountainside Obelisk" soon + + return always + def get_priority_hint_items(world: "WitnessWorld") -> List[str]: priority = { @@ -217,9 +227,8 @@ def get_priority_hint_items(world: "WitnessWorld") -> List[str]: "Eraser", "Black/White Squares", "Colored Squares", - "Colored Dots", "Sound Dots", - "Symmetry" + "Progressive Symmetry" ] priority.update(world.random.sample(symbols, 5)) @@ -249,8 +258,8 @@ def get_priority_hint_items(world: "WitnessWorld") -> List[str]: return sorted(priority) -def get_priority_hint_locations(_: "WitnessWorld") -> List[str]: - return [ +def get_priority_hint_locations(world: "WitnessWorld") -> List[str]: + priority = [ "Swamp Purple Underwater", "Shipwreck Vault Box", "Town RGB Room Left", @@ -265,6 +274,13 @@ def get_priority_hint_locations(_: "WitnessWorld") -> List[str]: "Boat Shipwreck Green EP", "Quarry Stoneworks Control Room Left", ] + + # Add Obelisk Sides that contain EPs that are meant to be hinted, if they are necessary to complete the Obelisk Side + if world.options.EP_difficulty != "normal": + priority.append("Town Obelisk Side 6") # Theater Flowers EP + priority.append("Treehouse Obelisk Side 4") # Shipwreck Green EP + + return priority def make_hint_from_item(world: "WitnessWorld", item_name: str, own_itempool: List[Item]): diff --git a/worlds/witness/locations.py b/worlds/witness/locations.py index d20be2794056..026977701a64 100644 --- a/worlds/witness/locations.py +++ b/worlds/witness/locations.py @@ -55,8 +55,8 @@ class StaticWitnessLocations: "Desert Light Room 3", "Desert Pond Room 5", "Desert Flood Room 6", - "Desert Final Hexagonal", - "Desert Final Bent 3", + "Desert Elevator Room Hexagonal", + "Desert Elevator Room Bent 3", "Desert Laser Panel", "Quarry Entry 1 Panel", diff --git a/worlds/witness/Options.py b/worlds/witness/options.py similarity index 82% rename from worlds/witness/Options.py rename to worlds/witness/options.py index 4c4b4f76267f..ac1f2bc82830 100644 --- a/worlds/witness/Options.py +++ b/worlds/witness/options.py @@ -28,11 +28,14 @@ class ShuffleSymbols(DefaultOnToggle): display_name = "Shuffle Symbols" -class ShuffleLasers(Toggle): +class ShuffleLasers(Choice): """If on, the 11 lasers are turned into items and will activate on their own upon receiving them. Note: There is a visual bug that can occur with the Desert Laser. It does not affect gameplay - The Laser can still be redirected as normal, for both applications of redirection.""" display_name = "Shuffle Lasers" + option_off = 0 + option_local = 1 + option_anywhere = 2 class ShuffleDoors(Choice): @@ -114,9 +117,13 @@ class ShufflePostgame(Toggle): class VictoryCondition(Choice): - """Change the victory condition from the original game's ending (elevator) to beating the Challenge - or solving the mountaintop box, either using the short solution - (7 lasers or whatever you've changed it to) or the long solution (11 lasers or whatever you've changed it to).""" + """Set the victory condition for this world. + Elevator: Start the elevator at the bottom of the mountain (requires Mountain Lasers). + Challenge: Beat the secret Challenge (requires Challenge Lasers). + Mountain Box Short: Input the short solution to the Mountaintop Box (requires Mountain Lasers). + Mountain Box Long: Input the long solution to the Mountaintop Box (requires Challenge Lasers). + It is important to note that while the Mountain Box requires Desert Laser to be redirected in Town for that laser + to count, the laser locks on the Elevator and Challenge Timer panels do not.""" display_name = "Victory Condition" option_elevator = 0 option_challenge = 1 @@ -133,10 +140,13 @@ class PuzzleRandomization(Choice): class MountainLasers(Range): - """Sets the amount of beams required to enter the final area.""" + """Sets the amount of lasers required to enter the Mountain. + If set to a higher amount than 7, the mountaintop box will be slightly rotated to make it possible to solve without + the hatch being opened. + This change will also be applied logically to the long solution ("Challenge Lasers" setting).""" display_name = "Required Lasers for Mountain Entry" range_start = 1 - range_end = 7 + range_end = 11 default = 7 @@ -182,10 +192,19 @@ class HintAmount(Range): class DeathLink(Toggle): """If on: Whenever you fail a puzzle (with some exceptions), everyone who is also on Death Link dies. - The effect of a "death" in The Witness is a Power Surge.""" + The effect of a "death" in The Witness is a Bonk Trap.""" display_name = "Death Link" +class DeathLinkAmnesty(Range): + """Number of panel fails to allow before sending a death through Death Link. + 0 means every panel fail will send a death, 1 means every other panel fail will send a death, etc.""" + display_name = "Death Link Amnesty" + range_start = 0 + range_end = 5 + default = 1 + + @dataclass class TheWitnessOptions(PerGameCommonOptions): puzzle_randomization: PuzzleRandomization @@ -209,3 +228,4 @@ class TheWitnessOptions(PerGameCommonOptions): puzzle_skip_amount: PuzzleSkipAmount hint_amount: HintAmount death_link: DeathLink + death_link_amnesty: DeathLinkAmnesty diff --git a/worlds/witness/player_logic.py b/worlds/witness/player_logic.py index e1ef1ae4319e..5d538e62b748 100644 --- a/worlds/witness/player_logic.py +++ b/worlds/witness/player_logic.py @@ -103,7 +103,8 @@ def reduce_req_within_region(self, panel_hex: str) -> FrozenSet[FrozenSet[str]]: if option_entity in self.EVENT_NAMES_BY_HEX: new_items = frozenset({frozenset([option_entity])}) - elif option_entity in {"7 Lasers", "11 Lasers", "PP2 Weirdness", "Theater to Tunnels"}: + elif option_entity in {"7 Lasers", "11 Lasers", "7 Lasers + Redirect", "11 Lasers + Redirect", + "PP2 Weirdness", "Theater to Tunnels"}: new_items = frozenset({frozenset([option_entity])}) else: new_items = self.reduce_req_within_region(option_entity) @@ -322,7 +323,10 @@ def make_options_adjustments(self, world: "WitnessWorld"): elif victory == 3: self.VICTORY_LOCATION = "0xFFF00" - if chal_lasers <= 7: + # Long box can usually only be solved by opening Mountain Entry. However, if it requires 7 lasers or less + # (challenge_lasers <= 7), you can now solve it without opening Mountain Entry first. + # Furthermore, if the user sets mountain_lasers > 7, the box is rotated to not require Mountain Entry either. + if chal_lasers <= 7 or mnt_lasers > 7: adjustment_linesets_in_order.append([ "Requirement Changes:", "0xFFF00 - 11 Lasers - True", diff --git a/worlds/witness/presets.py b/worlds/witness/presets.py new file mode 100644 index 000000000000..1fee1a7968b2 --- /dev/null +++ b/worlds/witness/presets.py @@ -0,0 +1,101 @@ +from typing import Any, Dict + +from .options import * + +witness_option_presets: Dict[str, Dict[str, Any]] = { + # Great for short syncs & scratching that "speedrun with light routing elements" itch. + "Short & Dense": { + "progression_balancing": 30, + + "puzzle_randomization": PuzzleRandomization.option_sigma_normal, + + "shuffle_symbols": False, + "shuffle_doors": ShuffleDoors.option_panels, + "door_groupings": DoorGroupings.option_off, + "shuffle_boat": True, + "shuffle_lasers": ShuffleLasers.option_local, + + "disable_non_randomized_puzzles": True, + "shuffle_discarded_panels": False, + "shuffle_vault_boxes": False, + "shuffle_EPs": ShuffleEnvironmentalPuzzles.option_off, + "EP_difficulty": EnvironmentalPuzzlesDifficulty.option_normal, + "shuffle_postgame": False, + + "victory_condition": VictoryCondition.option_mountain_box_short, + "mountain_lasers": 7, + "challenge_lasers": 11, + + "early_caves": EarlyCaves.option_off, + "elevators_come_to_you": False, + + "trap_percentage": TrapPercentage.default, + "puzzle_skip_amount": PuzzleSkipAmount.default, + "hint_amount": HintAmount.default, + "death_link": DeathLink.default, + }, + + # For relative beginners who want to move to the next step. + "Advanced, But Chill": { + "progression_balancing": 30, + + "puzzle_randomization": PuzzleRandomization.option_sigma_normal, + + "shuffle_symbols": True, + "shuffle_doors": ShuffleDoors.option_doors, + "door_groupings": DoorGroupings.option_regional, + "shuffle_boat": True, + "shuffle_lasers": ShuffleLasers.option_off, + + "disable_non_randomized_puzzles": False, + "shuffle_discarded_panels": True, + "shuffle_vault_boxes": True, + "shuffle_EPs": ShuffleEnvironmentalPuzzles.option_obelisk_sides, + "EP_difficulty": EnvironmentalPuzzlesDifficulty.option_normal, + "shuffle_postgame": False, + + "victory_condition": VictoryCondition.option_mountain_box_long, + "mountain_lasers": 6, + "challenge_lasers": 9, + + "early_caves": EarlyCaves.option_off, + "elevators_come_to_you": False, + + "trap_percentage": TrapPercentage.default, + "puzzle_skip_amount": 15, + "hint_amount": HintAmount.default, + "death_link": DeathLink.default, + }, + + # Allsanity but without the BS (no expert, no tedious EPs). + "Nice Allsanity": { + "progression_balancing": 50, + + "puzzle_randomization": PuzzleRandomization.option_sigma_normal, + + "shuffle_symbols": True, + "shuffle_doors": ShuffleDoors.option_mixed, + "door_groupings": DoorGroupings.option_off, + "shuffle_boat": True, + "shuffle_lasers": ShuffleLasers.option_anywhere, + + "disable_non_randomized_puzzles": False, + "shuffle_discarded_panels": True, + "shuffle_vault_boxes": True, + "shuffle_EPs": ShuffleEnvironmentalPuzzles.option_individual, + "EP_difficulty": EnvironmentalPuzzlesDifficulty.option_normal, + "shuffle_postgame": False, + + "victory_condition": VictoryCondition.option_challenge, + "mountain_lasers": 6, + "challenge_lasers": 9, + + "early_caves": EarlyCaves.option_off, + "elevators_come_to_you": True, + + "trap_percentage": TrapPercentage.default, + "puzzle_skip_amount": 15, + "hint_amount": HintAmount.default, + "death_link": DeathLink.default, + }, +} diff --git a/worlds/witness/rules.py b/worlds/witness/rules.py index 75c662ac0f26..5eded11ad412 100644 --- a/worlds/witness/rules.py +++ b/worlds/witness/rules.py @@ -29,8 +29,9 @@ ] -def _has_laser(laser_hex: str, world: "WitnessWorld", player: int) -> Callable[[CollectionState], bool]: - if laser_hex == "0x012FB": +def _has_laser(laser_hex: str, world: "WitnessWorld", player: int, + redirect_required: bool) -> Callable[[CollectionState], bool]: + if laser_hex == "0x012FB" and redirect_required: return lambda state: ( _can_solve_panel(laser_hex, world, world.player, world.player_logic, world.locat)(state) and state.has("Desert Laser Redirection", player) @@ -39,11 +40,11 @@ def _has_laser(laser_hex: str, world: "WitnessWorld", player: int) -> Callable[[ return _can_solve_panel(laser_hex, world, world.player, world.player_logic, world.locat) -def _has_lasers(amount: int, world: "WitnessWorld") -> Callable[[CollectionState], bool]: +def _has_lasers(amount: int, world: "WitnessWorld", redirect_required: bool) -> Callable[[CollectionState], bool]: laser_lambdas = [] for laser_hex in laser_hexes: - has_laser_lambda = _has_laser(laser_hex, world, world.player) + has_laser_lambda = _has_laser(laser_hex, world, world.player, redirect_required) laser_lambdas.append(has_laser_lambda) @@ -155,10 +156,16 @@ def _has_item(item: str, world: "WitnessWorld", player: int, return lambda state: state.can_reach(item, "Region", player) if item == "7 Lasers": laser_req = world.options.mountain_lasers.value - return _has_lasers(laser_req, world) + return _has_lasers(laser_req, world, False) + if item == "7 Lasers + Redirect": + laser_req = world.options.mountain_lasers.value + return _has_lasers(laser_req, world, True) if item == "11 Lasers": laser_req = world.options.challenge_lasers.value - return _has_lasers(laser_req, world) + return _has_lasers(laser_req, world, False) + if item == "11 Lasers + Redirect": + laser_req = world.options.challenge_lasers.value + return _has_lasers(laser_req, world, True) elif item == "PP2 Weirdness": return lambda state: _can_do_expert_pp2(state, world) elif item == "Theater to Tunnels": diff --git a/worlds/witness/settings/Door_Shuffle/Complex_Additional_Panels.txt b/worlds/witness/settings/Door_Shuffle/Complex_Additional_Panels.txt index 79bda7ea2281..b84370908524 100644 --- a/worlds/witness/settings/Door_Shuffle/Complex_Additional_Panels.txt +++ b/worlds/witness/settings/Door_Shuffle/Complex_Additional_Panels.txt @@ -1,4 +1,7 @@ Items: +Desert Surface 3 Control (Panel) +Desert Surface 8 Control (Panel) +Desert Elevator Room Hexagonal Control (Panel) Desert Flood Controls (Panel) Desert Light Control (Panel) Quarry Elevator Control (Panel) @@ -10,6 +13,7 @@ Quarry Boathouse Hook Control (Panel) Monastery Shutters Control (Panel) Town Maze Rooftop Bridge (Panel) Town RGB Control (Panel) +Town Desert Laser Redirect Control (Panel) Windmill Turn Control (Panel) Theater Video Input (Panel) Bunker Drop-Down Door Controls (Panel) diff --git a/worlds/witness/settings/Door_Shuffle/Simple_Panels.txt b/worlds/witness/settings/Door_Shuffle/Simple_Panels.txt index 79da154491b7..42258bca1a47 100644 --- a/worlds/witness/settings/Door_Shuffle/Simple_Panels.txt +++ b/worlds/witness/settings/Door_Shuffle/Simple_Panels.txt @@ -10,7 +10,7 @@ Monastery Panels Town Church & RGB House Panels Town Maze Panels Windmill & Theater Panels -Town Cargo Box Entry (Panel) +Town Dockside House Panels Treehouse Panels Bunker Panels Swamp Panels diff --git a/worlds/witness/settings/Symbol_Shuffle.txt b/worlds/witness/settings/Symbol_Shuffle.txt index 3d0342f5e2a9..253fe98bad42 100644 --- a/worlds/witness/settings/Symbol_Shuffle.txt +++ b/worlds/witness/settings/Symbol_Shuffle.txt @@ -1,9 +1,8 @@ Items: Arrows Progressive Dots -Colored Dots Sound Dots -Symmetry +Progressive Symmetry Triangles Eraser Shapers diff --git a/worlds/witness/static_logic.py b/worlds/witness/static_logic.py index 29c171d45c33..0e8d649af6ff 100644 --- a/worlds/witness/static_logic.py +++ b/worlds/witness/static_logic.py @@ -109,7 +109,6 @@ def read_logic_file(self, lines): "Laser", "Laser Hedges", "Laser Pressure Plates", - "Desert Laser Redirect" } is_vault_or_video = "Vault" in entity_name or "Video" in entity_name diff --git a/worlds/zillion/__init__.py b/worlds/zillion/__init__.py index 3f441d12ab34..d30bef144464 100644 --- a/worlds/zillion/__init__.py +++ b/worlds/zillion/__init__.py @@ -4,7 +4,7 @@ import settings import threading import typing -from typing import Any, Dict, List, Literal, Set, Tuple, Optional, cast +from typing import Any, Dict, List, Set, Tuple, Optional, cast import os import logging @@ -12,7 +12,7 @@ MultiWorld, Item, CollectionState, Entrance, Tutorial from .logic import cs_to_zz_locs from .region import ZillionLocation, ZillionRegion -from .options import ZillionOptions, ZillionStartChar, validate +from .options import ZillionOptions, validate from .id_maps import item_name_to_id as _item_name_to_id, \ loc_name_to_id as _loc_name_to_id, make_id_to_others, \ zz_reg_name_to_reg_name, base_id @@ -225,7 +225,7 @@ def access_rule_wrapped(zz_loc_local: ZzLocation, loc.access_rule = access_rule if not (limited_skill >= zz_loc.req): loc.progress_type = LocationProgressType.EXCLUDED - self.multiworld.exclude_locations[p].value.add(loc.name) + self.options.exclude_locations.value.add(loc.name) here.locations.append(loc) self.my_locations.append(loc) @@ -288,15 +288,15 @@ def stage_generate_basic(multiworld: MultiWorld, *args: Any) -> None: if group["game"] == "Zillion": assert "item_pool" in group item_pool = group["item_pool"] - to_stay: Literal['Apple', 'Champ', 'JJ'] = "JJ" + to_stay: Chars = "JJ" if "JJ" in item_pool: assert "players" in group group_players = group["players"] - start_chars = cast(Dict[int, ZillionStartChar], getattr(multiworld, "start_char")) - players_start_chars = [ - (player, start_chars[player].current_option_name) - for player in group_players - ] + players_start_chars: List[Tuple[int, Chars]] = [] + for player in group_players: + z_world = multiworld.worlds[player] + assert isinstance(z_world, ZillionWorld) + players_start_chars.append((player, z_world.options.start_char.get_char())) start_char_counts = Counter(sc for _, sc in players_start_chars) # majority rules if start_char_counts["Apple"] > start_char_counts["Champ"]: @@ -304,7 +304,7 @@ def stage_generate_basic(multiworld: MultiWorld, *args: Any) -> None: elif start_char_counts["Champ"] > start_char_counts["Apple"]: to_stay = "Champ" else: # equal - choices: Tuple[Literal['Apple', 'Champ', 'JJ'], ...] = ("Apple", "Champ") + choices: Tuple[Chars, ...] = ("Apple", "Champ") to_stay = multiworld.random.choice(choices) for p, sc in players_start_chars: diff --git a/worlds/zillion/client.py b/worlds/zillion/client.py index ac73f6db50c8..b10507aaf885 100644 --- a/worlds/zillion/client.py +++ b/worlds/zillion/client.py @@ -16,7 +16,7 @@ from zilliandomizer.options import Chars from zilliandomizer.patch import RescueInfo -from .id_maps import make_id_to_others +from .id_maps import loc_name_to_id, make_id_to_others from .config import base_id, zillion_map @@ -323,6 +323,7 @@ def process_from_game_queue(self) -> None: elif isinstance(event_from_game, events.WinEventFromGame): if not self.finished_game: async_start(self.send_msgs([ + {"cmd": 'LocationChecks', "locations": [loc_name_to_id["J-6 bottom far left"]]}, {"cmd": "StatusUpdate", "status": ClientStatus.CLIENT_GOAL} ])) self.finished_game = True diff --git a/worlds/zillion/docs/setup_en.md b/worlds/zillion/docs/setup_en.md index 22dee5ee55e6..79f7912dd4fd 100644 --- a/worlds/zillion/docs/setup_en.md +++ b/worlds/zillion/docs/setup_en.md @@ -2,7 +2,7 @@ ## Required Software -- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). Make sure to check the box for `Zillion Client - Zillion Patch Setup` +- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). - RetroArch 1.10.3 or newer from: [RetroArch Website](https://retroarch.com?page=platforms). @@ -30,9 +30,10 @@ Put your Zillion ROM file in the Archipelago directory in your home directory. ### Windows Setup -1. During the installation of Archipelago, install the Zillion Client. If you did not do this, - or you are on an older version, you may run the installer again to install the Zillion Client. -2. During setup, you will be asked to locate your base ROM file. This is the Zillion ROM file mentioned above in Required Software. +1. Download and install [Archipelago](). **The installer + file is located in the assets section at the bottom of the version information.** +2. The first time you do local generation or patch your game, you will be asked to locate your base ROM file. + This is the Zillion ROM file mentioned above in Required Software. This only needs to be done once. --- # Play diff --git a/worlds/zillion/logic.py b/worlds/zillion/logic.py index 305546c78b62..dcbc6131f1a9 100644 --- a/worlds/zillion/logic.py +++ b/worlds/zillion/logic.py @@ -1,9 +1,11 @@ -from typing import Dict, FrozenSet, Tuple, cast, List, Counter as _Counter +from typing import Dict, FrozenSet, Tuple, List, Counter as _Counter + from BaseClasses import CollectionState + +from zilliandomizer.logic_components.items import Item, items from zilliandomizer.logic_components.locations import Location from zilliandomizer.randomizer import Randomizer -from zilliandomizer.logic_components.items import Item, items -from .region import ZillionLocation + from .item import ZillionItem from .id_maps import item_name_to_id @@ -18,11 +20,12 @@ def set_randomizer_locs(cs: CollectionState, p: int, zz_r: Randomizer) -> int: returns a hash of the player and of the set locations with their items """ + from . import ZillionWorld z_world = cs.multiworld.worlds[p] - my_locations = cast(List[ZillionLocation], getattr(z_world, "my_locations")) + assert isinstance(z_world, ZillionWorld) _hash = p - for z_loc in my_locations: + for z_loc in z_world.my_locations: zz_name = z_loc.zz_loc.name zz_item = z_loc.item.zz_item \ if isinstance(z_loc.item, ZillionItem) and z_loc.item.player == p \ diff --git a/worlds/zillion/options.py b/worlds/zillion/options.py index cb861e962128..97f8b817f77c 100644 --- a/worlds/zillion/options.py +++ b/worlds/zillion/options.py @@ -1,13 +1,14 @@ from collections import Counter from dataclasses import dataclass -from typing import Dict, Tuple +from typing import ClassVar, Dict, Tuple from typing_extensions import TypeGuard # remove when Python >= 3.10 from Options import DefaultOnToggle, NamedRange, PerGameCommonOptions, Range, Toggle, Choice -from zilliandomizer.options import \ - Options as ZzOptions, char_to_gun, char_to_jump, ID, \ - VBLR as ZzVBLR, chars, Chars, ItemCounts as ZzItemCounts +from zilliandomizer.options import ( + Options as ZzOptions, char_to_gun, char_to_jump, ID, + VBLR as ZzVBLR, Chars, ItemCounts as ZzItemCounts +) from zilliandomizer.options.parsing import validate as zz_validate @@ -107,6 +108,15 @@ class ZillionStartChar(Choice): display_name = "start character" default = "random" + _name_capitalization: ClassVar[Dict[int, Chars]] = { + option_jj: "JJ", + option_apple: "Apple", + option_champ: "Champ", + } + + def get_char(self) -> Chars: + return ZillionStartChar._name_capitalization[self.value] + class ZillionIDCardCount(Range): """ @@ -348,16 +358,6 @@ def validate(options: ZillionOptions) -> "Tuple[ZzOptions, Counter[str]]": # that should be all of the level requirements met - name_capitalization: Dict[str, Chars] = { - "jj": "JJ", - "apple": "Apple", - "champ": "Champ", - } - - start_char = options.start_char - start_char_name = name_capitalization[start_char.current_key] - assert start_char_name in chars - starting_cards = options.starting_cards room_gen = options.room_gen @@ -371,7 +371,7 @@ def validate(options: ZillionOptions) -> "Tuple[ZzOptions, Counter[str]]": max_level.value, False, # tutorial skill, - start_char_name, + options.start_char.get_char(), floppy_req.value, options.continues.value, bool(options.randomize_alarms.value), diff --git a/worlds_disabled/README.md b/worlds_disabled/README.md index b891bc71d4ba..a7bffe222b14 100644 --- a/worlds_disabled/README.md +++ b/worlds_disabled/README.md @@ -3,3 +3,11 @@ This folder is for already merged worlds that are unmaintained and currently broken. If you are interested in fixing and stepping up as maintainer for any of these worlds, please review the [world maintainer](/docs/world%20maintainer.md) documentation. + +## Information for Disabled Worlds + +For each disabled world, a README file can be found detailing when the world was disabled and the reasons that it +was disabled. In order to be considered for reactivation, these concerns should be handled at a bare minimum. However, +each world may have additional issues that also need to be handled, such as deprecated API calls or missing components. + + diff --git a/worlds_disabled/oribf/README.md b/worlds_disabled/oribf/README.md new file mode 100644 index 000000000000..0c78c23bea0d --- /dev/null +++ b/worlds_disabled/oribf/README.md @@ -0,0 +1,7 @@ +### Ori and the Blind Forest + +This world was disabled for the following reasons: + +* Missing client +* Unmaintained +* Outdated, fails tests as of Jun 29, 2023