Merge branch 'main' into instruction_patch_kdl3

AHITClient.py

@@ -0,0 +1,8 @@
+from worlds.ahit.Client import launch
+import Utils
+import ModuleUpdate
+ModuleUpdate.update()
+
+if __name__ == "__main__":
+    Utils.init_logging("AHITClient", exception_logger="Client")
+    launch()

MultiServer.py

@@ -508,7 +508,7 @@ class Context:
                 self.logger.exception(e)
             self._start_async_saving()
 
-    def _start_async_saving(self):
+    def _start_async_saving(self, atexit_save: bool = True):
         if not self.auto_saver_thread:
             def save_regularly():
                 # time.time() is platform dependent, so using the expensive datetime method instead
@@ -532,8 +532,9 @@ class Context:
             self.auto_saver_thread = threading.Thread(target=save_regularly, daemon=True)
             self.auto_saver_thread.start()
 
-            import atexit
-            atexit.register(self._save, True)  # make sure we save on exit too
+            if atexit_save:
+                import atexit
+                atexit.register(self._save, True)  # make sure we save on exit too
 
     def get_save(self) -> dict:
         self.recheck_hints()

Options.py

@@ -746,6 +746,7 @@ class NamedRange(Range):
 
 class FreezeValidKeys(AssembleOptions):
     def __new__(mcs, name, bases, attrs):
+        assert not "_valid_keys" in attrs, "'_valid_keys' gets set by FreezeValidKeys, define 'valid_keys' instead."
         if "valid_keys" in attrs:
             attrs["_valid_keys"] = frozenset(attrs["valid_keys"])
         return super(FreezeValidKeys, mcs).__new__(mcs, name, bases, attrs)

README.md

@@ -67,7 +67,9 @@ Currently, the following games are supported:
 * Yoshi's Island
 * Mario & Luigi: Superstar Saga
 * Bomb Rush Cyberfunk
+* Aquaria
 * Yu-Gi-Oh! Ultimate Masters: World Championship Tournament 2006
+* A Hat in Time
 
 For setup and instructions check out our [tutorials page](https://archipelago.gg/tutorial/).
 Downloads can be found at [Releases](https://github.com/ArchipelagoMW/Archipelago/releases), including compiled

WebHost.py

@@ -117,7 +117,7 @@ if __name__ == "__main__":
     logging.basicConfig(format='[%(asctime)s] %(message)s', level=logging.INFO)
 
     from WebHostLib.lttpsprites import update_sprites_lttp
-    from WebHostLib.autolauncher import autohost, autogen
+    from WebHostLib.autolauncher import autohost, autogen, stop
     from WebHostLib.options import create as create_options_files
 
     try:
@@ -138,3 +138,11 @@ if __name__ == "__main__":
         else:
             from waitress import serve
             serve(app, port=app.config["PORT"], threads=app.config["WAITRESS_THREADS"])
+    else:
+        from time import sleep
+        try:
+            while True:
+                sleep(1)  # wait for process to be killed
+        except (SystemExit, KeyboardInterrupt):
+            pass
+    stop()  # stop worker threads

WebHostLib/autolauncher.py

@@ -3,16 +3,26 @@ from __future__ import annotations
 import json
 import logging
 import multiprocessing
-import time
 import typing
-from uuid import UUID
 from datetime import timedelta, datetime
+from threading import Event, Thread
+from uuid import UUID
 
 from pony.orm import db_session, select, commit
 
 from Utils import restricted_loads
 from .locker import Locker, AlreadyRunningException
 
+_stop_event = Event()
+
+
+def stop():
+    """Stops previously launched threads"""
+    global _stop_event
+    stop_event = _stop_event
+    _stop_event = Event()  # new event for new threads
+    stop_event.set()
+
 
 def handle_generation_success(seed_id):
     logging.info(f"Generation finished for seed {seed_id}")
@@ -63,6 +73,7 @@ def cleanup():
 
 def autohost(config: dict):
     def keep_running():
+        stop_event = _stop_event
         try:
             with Locker("autohost"):
                 cleanup()
@@ -72,26 +83,25 @@ def autohost(config: dict):
                     hosters.append(hoster)
                     hoster.start()
 
-                while 1:
-                    time.sleep(0.1)
+                while not stop_event.wait(0.1):
                     with db_session:
                         rooms = select(
                             room for room in Room if
                             room.last_activity >= datetime.utcnow() - timedelta(days=3))
                         for room in rooms:
                             # we have to filter twice, as the per-room timeout can't currently be PonyORM transpiled.
-                            if room.last_activity >= datetime.utcnow() - timedelta(seconds=room.timeout):
+                            if room.last_activity >= datetime.utcnow() - timedelta(seconds=room.timeout + 5):
                                 hosters[room.id.int % len(hosters)].start_room(room.id)
 
         except AlreadyRunningException:
             logging.info("Autohost reports as already running, not starting another.")
 
-    import threading
-    threading.Thread(target=keep_running, name="AP_Autohost").start()
+    Thread(target=keep_running, name="AP_Autohost").start()
 
 
 def autogen(config: dict):
     def keep_running():
+        stop_event = _stop_event
         try:
             with Locker("autogen"):
 
@@ -112,8 +122,7 @@ def autogen(config: dict):
                             commit()
                         select(generation for generation in Generation if generation.state == STATE_ERROR).delete()
 
-                    while 1:
-                        time.sleep(0.1)
+                    while not stop_event.wait(0.1):
                         with db_session:
                             # for update locks the database row(s) during transaction, preventing writes from elsewhere
                             to_start = select(
@@ -124,8 +133,7 @@ def autogen(config: dict):
         except AlreadyRunningException:
             logging.info("Autogen reports as already running, not starting another.")
 
-    import threading
-    threading.Thread(target=keep_running, name="AP_Autogen").start()
+    Thread(target=keep_running, name="AP_Autogen").start()
 
 
 multiworlds: typing.Dict[type(Room.id), MultiworldInstance] = {}

WebHostLib/customserver.py

@@ -74,6 +74,7 @@ class WebHostContext(Context):
 
     def _load_game_data(self):
         for key, value in self.static_server_data.items():
+            # NOTE: attributes are mutable and shared, so they will have to be copied before being modified
             setattr(self, key, value)
         self.non_hintable_names = collections.defaultdict(frozenset, self.non_hintable_names)
 
@@ -101,18 +102,37 @@ class WebHostContext(Context):
 
         multidata = self.decompress(room.seed.multidata)
         game_data_packages = {}
+
+        static_gamespackage = self.gamespackage  # this is shared across all rooms
+        static_item_name_groups = self.item_name_groups
+        static_location_name_groups = self.location_name_groups
+        self.gamespackage = {"Archipelago": static_gamespackage["Archipelago"]}  # this may be modified by _load
+        self.item_name_groups = {}
+        self.location_name_groups = {}
+
         for game in list(multidata.get("datapackage", {})):
             game_data = multidata["datapackage"][game]
             if "checksum" in game_data:
-                if self.gamespackage.get(game, {}).get("checksum") == game_data["checksum"]:
-                    # non-custom. remove from multidata
+                if static_gamespackage.get(game, {}).get("checksum") == game_data["checksum"]:
+                    # non-custom. remove from multidata and use static data
                     # games package could be dropped from static data once all rooms embed data package
                     del multidata["datapackage"][game]
                 else:
                     row = GameDataPackage.get(checksum=game_data["checksum"])
                     if row:  # None if rolled on >= 0.3.9 but uploaded to <= 0.3.8. multidata should be complete
                         game_data_packages[game] = Utils.restricted_loads(row.data)
+                        continue
+                    else:
+                        self.logger.warning(f"Did not find game_data_package for {game}: {game_data['checksum']}")
+            self.gamespackage[game] = static_gamespackage.get(game, {})
+            self.item_name_groups[game] = static_item_name_groups.get(game, {})
+            self.location_name_groups[game] = static_location_name_groups.get(game, {})
 
+        if not game_data_packages:
+            # all static -> use the static dicts directly
+            self.gamespackage = static_gamespackage
+            self.item_name_groups = static_item_name_groups
+            self.location_name_groups = static_location_name_groups
         return self._load(multidata, game_data_packages, True)
 
     @db_session
@@ -122,7 +142,7 @@ class WebHostContext(Context):
             savegame_data = Room.get(id=self.room_id).multisave
             if savegame_data:
                 self.set_save(restricted_loads(Room.get(id=self.room_id).multisave))
-            self._start_async_saving()
+            self._start_async_saving(atexit_save=False)
         threading.Thread(target=self.listen_to_db_commands, daemon=True).start()
 
     @db_session
@@ -212,59 +232,62 @@ def run_server_process(name: str, ponyconfig: dict, static_server_data: dict,
     loop = asyncio.get_event_loop()
 
     async def start_room(room_id):
-        try:
-            logger = set_up_logging(room_id)
-            ctx = WebHostContext(static_server_data, logger)
-            ctx.load(room_id)
-            ctx.init_save()
+        with Locker(f"RoomLocker {room_id}"):
             try:
-                ctx.server = websockets.serve(functools.partial(server, ctx=ctx), ctx.host, ctx.port, ssl=ssl_context)
+                logger = set_up_logging(room_id)
+                ctx = WebHostContext(static_server_data, logger)
+                ctx.load(room_id)
+                ctx.init_save()
+                try:
+                    ctx.server = websockets.serve(
+                        functools.partial(server, ctx=ctx), ctx.host, ctx.port, ssl=ssl_context)
 
-                await ctx.server
-            except OSError:  # likely port in use
-                ctx.server = websockets.serve(functools.partial(server, ctx=ctx), ctx.host, 0, ssl=ssl_context)
+                    await ctx.server
+                except OSError:  # likely port in use
+                    ctx.server = websockets.serve(
+                        functools.partial(server, ctx=ctx), ctx.host, 0, ssl=ssl_context)
 
-                await ctx.server
-            port = 0
-            for wssocket in ctx.server.ws_server.sockets:
-                socketname = wssocket.getsockname()
-                if wssocket.family == socket.AF_INET6:
-                    # Prefer IPv4, as most users seem to not have working ipv6 support
-                    if not port:
+                    await ctx.server
+                port = 0
+                for wssocket in ctx.server.ws_server.sockets:
+                    socketname = wssocket.getsockname()
+                    if wssocket.family == socket.AF_INET6:
+                        # Prefer IPv4, as most users seem to not have working ipv6 support
+                        if not port:
+                            port = socketname[1]
+                    elif wssocket.family == socket.AF_INET:
                         port = socketname[1]
-                elif wssocket.family == socket.AF_INET:
-                    port = socketname[1]
-            if port:
-                ctx.logger.info(f'Hosting game at {host}:{port}')
+                if port:
+                    ctx.logger.info(f'Hosting game at {host}:{port}')
+                    with db_session:
+                        room = Room.get(id=ctx.room_id)
+                        room.last_port = port
+                else:
+                    ctx.logger.exception("Could not determine port. Likely hosting failure.")
                 with db_session:
-                    room = Room.get(id=ctx.room_id)
-                    room.last_port = port
-            else:
-                ctx.logger.exception("Could not determine port. Likely hosting failure.")
-            with db_session:
-                ctx.auto_shutdown = Room.get(id=room_id).timeout
-            ctx.shutdown_task = asyncio.create_task(auto_shutdown(ctx, []))
-            await ctx.shutdown_task
+                    ctx.auto_shutdown = Room.get(id=room_id).timeout
+                ctx.shutdown_task = asyncio.create_task(auto_shutdown(ctx, []))
+                await ctx.shutdown_task
 
-            # ensure auto launch is on the same page in regard to room activity.
-            with db_session:
-                room: Room = Room.get(id=ctx.room_id)
-                room.last_activity = datetime.datetime.utcnow() - datetime.timedelta(seconds=room.timeout + 60)
-
-        except (KeyboardInterrupt, SystemExit):
-            with db_session:
-                room = Room.get(id=room_id)
-                # ensure the Room does not spin up again on its own, minute of safety buffer
-                room.last_activity = datetime.datetime.utcnow() - datetime.timedelta(minutes=1, seconds=room.timeout)
-        except Exception:
-            with db_session:
-                room = Room.get(id=room_id)
-                room.last_port = -1
-                # ensure the Room does not spin up again on its own, minute of safety buffer
-                room.last_activity = datetime.datetime.utcnow() - datetime.timedelta(minutes=1, seconds=room.timeout)
-            raise
-        finally:
-            rooms_shutting_down.put(room_id)
+            except (KeyboardInterrupt, SystemExit):
+                pass
+            except Exception:
+                with db_session:
+                    room = Room.get(id=room_id)
+                    room.last_port = -1
+                raise
+            finally:
+                try:
+                    ctx._save()
+                    with (db_session):
+                        # ensure the Room does not spin up again on its own, minute of safety buffer
+                        room = Room.get(id=room_id)
+                        room.last_activity = datetime.datetime.utcnow() - \
+                                             datetime.timedelta(minutes=1, seconds=room.timeout)
+                    logging.info(f"Shutting down room {room_id} on {name}.")
+                finally:
+                    await asyncio.sleep(5)
+                    rooms_shutting_down.put(room_id)
 
     class Starter(threading.Thread):
         def run(self):

WebHostLib/generate.py

@@ -70,37 +70,41 @@ def generate(race=False):
                 flash(options)
             else:
                 meta = get_meta(request.form, race)
-                results, gen_options = roll_options(options, set(meta["plando_options"]))
-
-                if any(type(result) == str for result in results.values()):
-                    return render_template("checkResult.html", results=results)
-                elif len(gen_options) > app.config["MAX_ROLL"]:
-                    flash(f"Sorry, generating of multiworlds is limited to {app.config['MAX_ROLL']} players. "
-                          f"If you have a larger group, please generate it yourself and upload it.")
-                elif len(gen_options) >= app.config["JOB_THRESHOLD"]:
-                    gen = Generation(
-                        options=pickle.dumps({name: vars(options) for name, options in gen_options.items()}),
-                        # convert to json compatible
-                        meta=json.dumps(meta),
-                        state=STATE_QUEUED,
-                        owner=session["_id"])
-                    commit()
-
-                    return redirect(url_for("wait_seed", seed=gen.id))
-                else:
-                    try:
-                        seed_id = gen_game({name: vars(options) for name, options in gen_options.items()},
-                                           meta=meta, owner=session["_id"].int)
-                    except BaseException as e:
-                        from .autolauncher import handle_generation_failure
-                        handle_generation_failure(e)
-                        return render_template("seedError.html", seed_error=(e.__class__.__name__ + ": " + str(e)))
-
-                    return redirect(url_for("view_seed", seed=seed_id))
+                return start_generation(options, meta)
 
     return render_template("generate.html", race=race, version=__version__)
 
 
+def start_generation(options: Dict[str, Union[dict, str]], meta: Dict[str, Any]):
+    results, gen_options = roll_options(options, set(meta["plando_options"]))
+
+    if any(type(result) == str for result in results.values()):
+        return render_template("checkResult.html", results=results)
+    elif len(gen_options) > app.config["MAX_ROLL"]:
+        flash(f"Sorry, generating of multiworlds is limited to {app.config['MAX_ROLL']} players. "
+              f"If you have a larger group, please generate it yourself and upload it.")
+    elif len(gen_options) >= app.config["JOB_THRESHOLD"]:
+        gen = Generation(
+            options=pickle.dumps({name: vars(options) for name, options in gen_options.items()}),
+            # convert to json compatible
+            meta=json.dumps(meta),
+            state=STATE_QUEUED,
+            owner=session["_id"])
+        commit()
+
+        return redirect(url_for("wait_seed", seed=gen.id))
+    else:
+        try:
+            seed_id = gen_game({name: vars(options) for name, options in gen_options.items()},
+                               meta=meta, owner=session["_id"].int)
+        except BaseException as e:
+            from .autolauncher import handle_generation_failure
+            handle_generation_failure(e)
+            return render_template("seedError.html", seed_error=(e.__class__.__name__ + ": " + str(e)))
+
+        return redirect(url_for("view_seed", seed=seed_id))
+
+
 def gen_game(gen_options: dict, meta: Optional[Dict[str, Any]] = None, owner=None, sid=None):
     if not meta:
         meta: Dict[str, Any] = {}

WebHostLib/options.py

@@ -1,33 +1,33 @@
 import collections.abc
-import os
-import yaml
-import requests
 import json
-import flask
+import os
+from textwrap import dedent
+from typing import Dict, Union
+
+import yaml
+from flask import redirect, render_template, request, Response
 
 import Options
-from Options import Visibility
-from flask import redirect, render_template, request, Response
-from worlds.AutoWorld import AutoWorldRegister
 from Utils import local_path
-from textwrap import dedent
+from worlds.AutoWorld import AutoWorldRegister
 from . import app, cache
 
 
-def create():
+def create() -> None:
     target_folder = local_path("WebHostLib", "static", "generated")
     yaml_folder = os.path.join(target_folder, "configs")
 
     Options.generate_yaml_templates(yaml_folder)
 
 
-def get_world_theme(game_name: str):
+def get_world_theme(game_name: str) -> str:
     if game_name in AutoWorldRegister.world_types:
         return AutoWorldRegister.world_types[game_name].web.theme
     return 'grass'
 
 
-def render_options_page(template: str, world_name: str, is_complex: bool = False):
+def render_options_page(template: str, world_name: str, is_complex: bool = False) -> Union[Response, str]:
+    visibility_flag = Options.Visibility.complex_ui if is_complex else Options.Visibility.simple_ui
     world = AutoWorldRegister.world_types[world_name]
     if world.hidden or world.web.options_page is False:
         return redirect("games")
@@ -39,13 +39,8 @@ def render_options_page(template: str, world_name: str, is_complex: bool = False
     grouped_options = {group: {} for group in ordered_groups}
     for option_name, option in world.options_dataclass.type_hints.items():
         # Exclude settings from options pages if their visibility is disabled
-        if not is_complex and option.visibility < Visibility.simple_ui:
-            continue
-
-        if is_complex and option.visibility < Visibility.complex_ui:
-            continue
-
-        grouped_options[option_groups.get(option, "Game Options")][option_name] = option
+        if visibility_flag in option.visibility:
+            grouped_options[option_groups.get(option, "Game Options")][option_name] = option
 
     return render_template(
         template,
@@ -58,26 +53,12 @@ def render_options_page(template: str, world_name: str, is_complex: bool = False
     )
 
 
-def generate_game(player_name: str, formatted_options: dict):
-    payload = {
-        "race": 0,
-        "hint_cost": 10,
-        "forfeit_mode": "auto",
-        "remaining_mode": "disabled",
-        "collect_mode": "goal",
-        "weights": {
-            player_name: formatted_options,
-        },
-    }
-    r = requests.post("https://archipelago.gg/api/generate", json=payload)
-    if 200 <= r.status_code <= 299:
-        response_data = r.json()
-        return redirect(response_data["url"])
-    else:
-        return r.text
+def generate_game(options: Dict[str, Union[dict, str]]) -> Union[Response, str]:
+    from .generate import start_generation
+    return start_generation(options, {"plando_options": ["items", "connections", "texts", "bosses"]})
 
 
-def send_yaml(player_name: str, formatted_options: dict):
+def send_yaml(player_name: str, formatted_options: dict) -> Response:
     response = Response(yaml.dump(formatted_options, sort_keys=False))
     response.headers["Content-Type"] = "text/yaml"
     response.headers["Content-Disposition"] = f"attachment; filename={player_name}.yaml"
@@ -85,7 +66,7 @@ def send_yaml(player_name: str, formatted_options: dict):
 
 
 @app.template_filter("dedent")
-def filter_dedent(text: str):
+def filter_dedent(text: str) -> str:
     return dedent(text).strip("\n ")
 
 
@@ -98,10 +79,6 @@ def test_ordered(obj):
 @cache.cached()
 def option_presets(game: str) -> Response:
     world = AutoWorldRegister.world_types[game]
-    presets = {}
-
-    if world.web.options_presets:
-        presets = presets | world.web.options_presets
 
     class SetEncoder(json.JSONEncoder):
         def default(self, obj):
@@ -110,8 +87,8 @@ def option_presets(game: str) -> Response:
                 return list(obj)
             return json.JSONEncoder.default(self, obj)
 
-    json_data = json.dumps(presets, cls=SetEncoder)
-    response = flask.Response(json_data)
+    json_data = json.dumps(world.web.options_presets, cls=SetEncoder)
+    response = Response(json_data)
     response.headers["Content-Type"] = "application/json"
     return response
 
@@ -169,7 +146,7 @@ def generate_weighted_yaml(game: str):
         }
 
         if intent_generate:
-            return generate_game(player_name, formatted_options)
+            return generate_game({player_name: formatted_options})
 
         else:
             return send_yaml(player_name, formatted_options)
@@ -243,7 +220,7 @@ def generate_yaml(game: str):
         }
 
         if intent_generate:
-            return generate_game(player_name, formatted_options)
+            return generate_game({player_name: formatted_options})
 
         else:
             return send_yaml(player_name, formatted_options)

WebHostLib/templates/playerOptions/macros.html

@@ -114,7 +114,7 @@
 {% macro ItemDict(option_name, option, world) %}
     {{ OptionTitle(option_name, option) }}
     <div class="option-container">
-        {% for item_name in world.item_names|sort %}
+        {% for item_name in (option.valid_keys|sort if (option.valid_keys|length > 0) else world.item_names|sort) %}
             <div class="option-entry">
                 <label for="{{ option_name }}-{{ item_name }}-qty">{{ item_name }}</label>
                 <input type="number" id="{{ option_name }}-{{ item_name }}-qty" name="{{ option_name }}||{{ item_name }}||qty" value="{{ option.default[item_name]|default("0") }}" data-option-name="{{ option_name }}" data-item-name="{{ item_name }}" />
@@ -149,7 +149,7 @@
         {% if world.location_name_groups.keys()|length > 1 %}
             <div class="option-divider">&nbsp;</div>
         {% endif %}
-        {% for location_name in world.location_names|sort %}
+        {% for location_name in (option.valid_keys|sort if (option.valid_keys|length > 0) else world.location_names|sort) %}
             <div class="option-entry">
                 <input type="checkbox" id="{{ option_name }}-{{ location_name }}" name="{{ option_name }}" value="{{ location_name }}" {{ "checked" if location_name in option.default }} />
                 <label for="{{ option_name }}-{{ location_name }}">{{ location_name }}</label>
@@ -172,7 +172,7 @@
         {% if world.item_name_groups.keys()|length > 1 %}
             <div class="option-divider">&nbsp;</div>
         {% endif %}
-        {% for item_name in world.item_names|sort %}
+        {% for item_name in (option.valid_keys|sort if (option.valid_keys|length > 0) else world.item_names|sort) %}
             <div class="option-entry">
                 <input type="checkbox" id="{{ option_name }}-{{ item_name }}" name="{{ option_name }}" value="{{ item_name }}" {{ "checked" if item_name in option.default }} />
                 <label for="{{ option_name }}-{{ item_name }}">{{ item_name }}</label>

WebHostLib/templates/weightedOptions/macros.html

@@ -105,7 +105,7 @@
 
 {% macro ItemDict(option_name, option, world) %}
     <div class="dict-container">
-        {% for item_name in world.item_names|sort %}
+        {% for item_name in (option.valid_keys|sort if (option.valid_keys|length > 0) else world.item_names|sort) %}
             <div class="dict-entry">
                 <label for="{{ option_name }}-{{ item_name }}-qty">{{ item_name }}</label>
                 <input
@@ -150,7 +150,7 @@
         {% if world.location_name_groups.keys()|length > 1 %}
             <div class="divider">&nbsp;</div>
         {% endif %}
-        {% for location_name in world.location_names|sort %}
+        {% for location_name in (option.valid_keys|sort if (option.valid_keys|length > 0) else world.location_names|sort) %}
             <div class="set-entry">
                 <input type="checkbox" id="{{ option_name }}-{{ location_name }}" name="{{ option_name }}||{{ location_name }}" value="1" {{ "checked" if location_name in option.default }} />
                 <label for="{{ option_name }}-{{ location_name }}">{{ location_name }}</label>
@@ -172,7 +172,7 @@
         {% if world.item_name_groups.keys()|length > 1 %}
             <div class="set-divider">&nbsp;</div>
         {% endif %}
-        {% for item_name in world.item_names|sort %}
+        {% for item_name in (option.valid_keys|sort if (option.valid_keys|length > 0) else world.item_names|sort) %}
             <div class="set-entry">
                 <input type="checkbox" id="{{ option_name }}-{{ item_name }}" name="{{ option_name }}||{{ item_name }}" value="1" {{ "checked" if item_name in option.default }} />
                 <label for="{{ option_name }}-{{ item_name }}">{{ item_name }}</label>

docs/CODEOWNERS

@@ -13,6 +13,9 @@
 # Adventure
 /worlds/adventure/ @JusticePS
 
+# A Hat in Time
+/worlds/ahit/ @CookieCat45
+
 # A Link to the Past
 /worlds/alttp/ @Berserker66
 

worlds/ahit/Client.py

@@ -0,0 +1,232 @@
+import asyncio
+import Utils
+import websockets
+import functools
+from copy import deepcopy
+from typing import List, Any, Iterable
+from NetUtils import decode, encode, JSONtoTextParser, JSONMessagePart, NetworkItem
+from MultiServer import Endpoint
+from CommonClient import CommonContext, gui_enabled, ClientCommandProcessor, logger, get_base_parser
+
+DEBUG = False
+
+
+class AHITJSONToTextParser(JSONtoTextParser):
+    def _handle_color(self, node: JSONMessagePart):
+        return self._handle_text(node)  # No colors for the in-game text
+
+
+class AHITCommandProcessor(ClientCommandProcessor):
+    def _cmd_ahit(self):
+        """Check AHIT Connection State"""
+        if isinstance(self.ctx, AHITContext):
+            logger.info(f"AHIT Status: {self.ctx.get_ahit_status()}")
+
+
+class AHITContext(CommonContext):
+    command_processor = AHITCommandProcessor
+    game = "A Hat in Time"
+
+    def __init__(self, server_address, password):
+        super().__init__(server_address, password)
+        self.proxy = None
+        self.proxy_task = None
+        self.gamejsontotext = AHITJSONToTextParser(self)
+        self.autoreconnect_task = None
+        self.endpoint = None
+        self.items_handling = 0b111
+        self.room_info = None
+        self.connected_msg = None
+        self.game_connected = False
+        self.awaiting_info = False
+        self.full_inventory: List[Any] = []
+        self.server_msgs: List[Any] = []
+
+    async def server_auth(self, password_requested: bool = False):
+        if password_requested and not self.password:
+            await super(AHITContext, self).server_auth(password_requested)
+
+        await self.get_username()
+        await self.send_connect()
+
+    def get_ahit_status(self) -> str:
+        if not self.is_proxy_connected():
+            return "Not connected to A Hat in Time"
+
+        return "Connected to A Hat in Time"
+
+    async def send_msgs_proxy(self, msgs: Iterable[dict]) -> bool:
+        """ `msgs` JSON serializable """
+        if not self.endpoint or not self.endpoint.socket.open or self.endpoint.socket.closed:
+            return False
+
+        if DEBUG:
+            logger.info(f"Outgoing message: {msgs}")
+
+        await self.endpoint.socket.send(msgs)
+        return True
+
+    async def disconnect(self, allow_autoreconnect: bool = False):
+        await super().disconnect(allow_autoreconnect)
+
+    async def disconnect_proxy(self):
+        if self.endpoint and not self.endpoint.socket.closed:
+            await self.endpoint.socket.close()
+        if self.proxy_task is not None:
+            await self.proxy_task
+
+    def is_connected(self) -> bool:
+        return self.server and self.server.socket.open
+
+    def is_proxy_connected(self) -> bool:
+        return self.endpoint and self.endpoint.socket.open
+
+    def on_print_json(self, args: dict):
+        text = self.gamejsontotext(deepcopy(args["data"]))
+        msg = {"cmd": "PrintJSON", "data": [{"text": text}], "type": "Chat"}
+        self.server_msgs.append(encode([msg]))
+
+        if self.ui:
+            self.ui.print_json(args["data"])
+        else:
+            text = self.jsontotextparser(args["data"])
+            logger.info(text)
+
+    def update_items(self):
+        # just to be safe - we might still have an inventory from a different room
+        if not self.is_connected():
+            return
+
+        self.server_msgs.append(encode([{"cmd": "ReceivedItems", "index": 0, "items": self.full_inventory}]))
+
+    def on_package(self, cmd: str, args: dict):
+        if cmd == "Connected":
+            self.connected_msg = encode([args])
+            if self.awaiting_info:
+                self.server_msgs.append(self.room_info)
+                self.update_items()
+                self.awaiting_info = False
+
+        elif cmd == "ReceivedItems":
+            if args["index"] == 0:
+                self.full_inventory.clear()
+
+            for item in args["items"]:
+                self.full_inventory.append(NetworkItem(*item))
+
+            self.server_msgs.append(encode([args]))
+
+        elif cmd == "RoomInfo":
+            self.seed_name = args["seed_name"]
+            self.room_info = encode([args])
+
+        else:
+            if cmd != "PrintJSON":
+                self.server_msgs.append(encode([args]))
+
+    def run_gui(self):
+        from kvui import GameManager
+
+        class AHITManager(GameManager):
+            logging_pairs = [
+                ("Client", "Archipelago")
+            ]
+            base_title = "Archipelago A Hat in Time Client"
+
+        self.ui = AHITManager(self)
+        self.ui_task = asyncio.create_task(self.ui.async_run(), name="UI")
+
+
+async def proxy(websocket, path: str = "/", ctx: AHITContext = None):
+    ctx.endpoint = Endpoint(websocket)
+    try:
+        await on_client_connected(ctx)
+
+        if ctx.is_proxy_connected():
+            async for data in websocket:
+                if DEBUG:
+                    logger.info(f"Incoming message: {data}")
+
+                for msg in decode(data):
+                    if msg["cmd"] == "Connect":
+                        # Proxy is connecting, make sure it is valid
+                        if msg["game"] != "A Hat in Time":
+                            logger.info("Aborting proxy connection: game is not A Hat in Time")
+                            await ctx.disconnect_proxy()
+                            break
+
+                        if ctx.seed_name:
+                            seed_name = msg.get("seed_name", "")
+                            if seed_name != "" and seed_name != ctx.seed_name:
+                                logger.info("Aborting proxy connection: seed mismatch from save file")
+                                logger.info(f"Expected: {ctx.seed_name}, got: {seed_name}")
+                                text = encode([{"cmd": "PrintJSON",
+                                                "data": [{"text": "Connection aborted - save file to seed mismatch"}]}])
+                                await ctx.send_msgs_proxy(text)
+                                await ctx.disconnect_proxy()
+                                break
+
+                        if ctx.connected_msg and ctx.is_connected():
+                            await ctx.send_msgs_proxy(ctx.connected_msg)
+                            ctx.update_items()
+                        continue
+
+                    if not ctx.is_proxy_connected():
+                        break
+
+                    await ctx.send_msgs([msg])
+
+    except Exception as e:
+        if not isinstance(e, websockets.WebSocketException):
+            logger.exception(e)
+    finally:
+        await ctx.disconnect_proxy()
+
+
+async def on_client_connected(ctx: AHITContext):
+    if ctx.room_info and ctx.is_connected():
+        await ctx.send_msgs_proxy(ctx.room_info)
+    else:
+        ctx.awaiting_info = True
+
+
+async def proxy_loop(ctx: AHITContext):
+    try:
+        while not ctx.exit_event.is_set():
+            if len(ctx.server_msgs) > 0:
+                for msg in ctx.server_msgs:
+                    await ctx.send_msgs_proxy(msg)
+
+                ctx.server_msgs.clear()
+            await asyncio.sleep(0.1)
+    except Exception as e:
+        logger.exception(e)
+        logger.info("Aborting AHIT Proxy Client due to errors")
+
+
+def launch():
+    async def main():
+        parser = get_base_parser()
+        args = parser.parse_args()
+
+        ctx = AHITContext(args.connect, args.password)
+        logger.info("Starting A Hat in Time proxy server")
+        ctx.proxy = websockets.serve(functools.partial(proxy, ctx=ctx),
+                                     host="localhost", port=11311, ping_timeout=999999, ping_interval=999999)
+        ctx.proxy_task = asyncio.create_task(proxy_loop(ctx), name="ProxyLoop")
+
+        if gui_enabled:
+            ctx.run_gui()
+        ctx.run_cli()
+
+        await ctx.proxy
+        await ctx.proxy_task
+        await ctx.exit_event.wait()
+
+    Utils.init_logging("AHITClient")
+    # options = Utils.get_options()
+
+    import colorama
+    colorama.init()
+    asyncio.run(main())
+    colorama.deinit()

worlds/ahit/DeathWishLocations.py

@@ -0,0 +1,243 @@
+from .Types import HatInTimeLocation, HatInTimeItem
+from .Regions import create_region
+from BaseClasses import Region, LocationProgressType, ItemClassification
+from worlds.generic.Rules import add_rule
+from typing import List, TYPE_CHECKING
+from .Locations import death_wishes
+from .Options import EndGoal
+
+if TYPE_CHECKING:
+    from . import HatInTimeWorld
+
+
+dw_prereqs = {
+    "So You're Back From Outer Space":  ["Beat the Heat"],
+    "Snatcher's Hit List":              ["Beat the Heat"],
+    "Snatcher Coins in Mafia Town":     ["So You're Back From Outer Space"],
+    "Rift Collapse: Mafia of Cooks":    ["So You're Back From Outer Space"],
+    "Collect-a-thon":                   ["So You're Back From Outer Space"],
+    "She Speedran from Outer Space":    ["Rift Collapse: Mafia of Cooks"],
+    "Mafia's Jumps":                    ["She Speedran from Outer Space"],
+    "Vault Codes in the Wind":          ["Collect-a-thon", "She Speedran from Outer Space"],
+    "Encore! Encore!":                  ["Collect-a-thon"],
+
+    "Security Breach":                          ["Beat the Heat"],
+    "Rift Collapse: Dead Bird Studio":          ["Security Breach"],
+    "The Great Big Hootenanny":                 ["Security Breach"],
+    "10 Seconds until Self-Destruct":           ["The Great Big Hootenanny"],
+    "Killing Two Birds":                        ["Rift Collapse: Dead Bird Studio", "10 Seconds until Self-Destruct"],
+    "Community Rift: Rhythm Jump Studio":       ["10 Seconds until Self-Destruct"],
+    "Snatcher Coins in Battle of the Birds":    ["The Great Big Hootenanny"],
+    "Zero Jumps":                               ["Rift Collapse: Dead Bird Studio"],
+    "Snatcher Coins in Nyakuza Metro":          ["Killing Two Birds"],
+
+    "Speedrun Well":                    ["Beat the Heat"],
+    "Rift Collapse: Sleepy Subcon":     ["Speedrun Well"],
+    "Boss Rush":                        ["Speedrun Well"],
+    "Quality Time with Snatcher":       ["Rift Collapse: Sleepy Subcon"],
+    "Breaching the Contract":           ["Boss Rush", "Quality Time with Snatcher"],
+    "Community Rift: Twilight Travels": ["Quality Time with Snatcher"],
+    "Snatcher Coins in Subcon Forest":  ["Rift Collapse: Sleepy Subcon"],
+
+    "Bird Sanctuary":                       ["Beat the Heat"],
+    "Snatcher Coins in Alpine Skyline":     ["Bird Sanctuary"],
+    "Wound-Up Windmill":                    ["Bird Sanctuary"],
+    "Rift Collapse: Alpine Skyline":        ["Bird Sanctuary"],
+    "Camera Tourist":                       ["Rift Collapse: Alpine Skyline"],
+    "Community Rift: The Mountain Rift":    ["Rift Collapse: Alpine Skyline"],
+    "The Illness has Speedrun":             ["Rift Collapse: Alpine Skyline", "Wound-Up Windmill"],
+
+    "The Mustache Gauntlet":            ["Wound-Up Windmill"],
+    "No More Bad Guys":                 ["The Mustache Gauntlet"],
+    "Seal the Deal":                    ["Encore! Encore!", "Killing Two Birds",
+                                         "Breaching the Contract", "No More Bad Guys"],
+
+    "Rift Collapse: Deep Sea":          ["Rift Collapse: Mafia of Cooks", "Rift Collapse: Dead Bird Studio",
+                                         "Rift Collapse: Sleepy Subcon", "Rift Collapse: Alpine Skyline"],
+
+    "Cruisin' for a Bruisin'":          ["Rift Collapse: Deep Sea"],
+}
+
+dw_candles = [
+    "Snatcher's Hit List",
+    "Zero Jumps",
+    "Camera Tourist",
+    "Snatcher Coins in Mafia Town",
+    "Snatcher Coins in Battle of the Birds",
+    "Snatcher Coins in Subcon Forest",
+    "Snatcher Coins in Alpine Skyline",
+    "Snatcher Coins in Nyakuza Metro",
+]
+
+annoying_dws = [
+    "Vault Codes in the Wind",
+    "Boss Rush",
+    "Camera Tourist",
+    "The Mustache Gauntlet",
+    "Rift Collapse: Deep Sea",
+    "Cruisin' for a Bruisin'",
+    "Seal the Deal",  # Non-excluded if goal
+]
+
+# includes the above as well
+annoying_bonuses = [
+    "So You're Back From Outer Space",
+    "Encore! Encore!",
+    "Snatcher's Hit List",
+    "Vault Codes in the Wind",
+    "10 Seconds until Self-Destruct",
+    "Killing Two Birds",
+    "Zero Jumps",
+    "Boss Rush",
+    "Bird Sanctuary",
+    "The Mustache Gauntlet",
+    "Wound-Up Windmill",
+    "Camera Tourist",
+    "Rift Collapse: Deep Sea",
+    "Cruisin' for a Bruisin'",
+    "Seal the Deal",
+]
+
+dw_classes = {
+    "Beat the Heat":                    "Hat_SnatcherContract_DeathWish_HeatingUpHarder",
+    "So You're Back From Outer Space":  "Hat_SnatcherContract_DeathWish_BackFromSpace",
+    "Snatcher's Hit List":              "Hat_SnatcherContract_DeathWish_KillEverybody",
+    "Collect-a-thon":                   "Hat_SnatcherContract_DeathWish_PonFrenzy",
+    "Rift Collapse: Mafia of Cooks":    "Hat_SnatcherContract_DeathWish_RiftCollapse_MafiaTown",
+    "Encore! Encore!":                  "Hat_SnatcherContract_DeathWish_MafiaBossEX",
+    "She Speedran from Outer Space":    "Hat_SnatcherContract_DeathWish_Speedrun_MafiaAlien",
+    "Mafia's Jumps":                    "Hat_SnatcherContract_DeathWish_NoAPresses_MafiaAlien",
+    "Vault Codes in the Wind":          "Hat_SnatcherContract_DeathWish_MovingVault",
+    "Snatcher Coins in Mafia Town":     "Hat_SnatcherContract_DeathWish_Tokens_MafiaTown",
+
+    "Security Breach":                          "Hat_SnatcherContract_DeathWish_DeadBirdStudioMoreGuards",
+    "The Great Big Hootenanny":                 "Hat_SnatcherContract_DeathWish_DifficultParade",
+    "Rift Collapse: Dead Bird Studio":          "Hat_SnatcherContract_DeathWish_RiftCollapse_Birds",
+    "10 Seconds until Self-Destruct":           "Hat_SnatcherContract_DeathWish_TrainRushShortTime",
+    "Killing Two Birds":                        "Hat_SnatcherContract_DeathWish_BirdBossEX",
+    "Snatcher Coins in Battle of the Birds":    "Hat_SnatcherContract_DeathWish_Tokens_Birds",
+    "Zero Jumps":                               "Hat_SnatcherContract_DeathWish_NoAPresses",
+
+    "Speedrun Well":                    "Hat_SnatcherContract_DeathWish_Speedrun_SubWell",
+    "Rift Collapse: Sleepy Subcon":     "Hat_SnatcherContract_DeathWish_RiftCollapse_Subcon",
+    "Boss Rush":                        "Hat_SnatcherContract_DeathWish_BossRush",
+    "Quality Time with Snatcher":       "Hat_SnatcherContract_DeathWish_SurvivalOfTheFittest",
+    "Breaching the Contract":           "Hat_SnatcherContract_DeathWish_SnatcherEX",
+    "Snatcher Coins in Subcon Forest":  "Hat_SnatcherContract_DeathWish_Tokens_Subcon",
+
+    "Bird Sanctuary":                   "Hat_SnatcherContract_DeathWish_NiceBirdhouse",
+    "Rift Collapse: Alpine Skyline":    "Hat_SnatcherContract_DeathWish_RiftCollapse_Alps",
+    "Wound-Up Windmill":                "Hat_SnatcherContract_DeathWish_FastWindmill",
+    "The Illness has Speedrun":         "Hat_SnatcherContract_DeathWish_Speedrun_Illness",
+    "Snatcher Coins in Alpine Skyline": "Hat_SnatcherContract_DeathWish_Tokens_Alps",
+    "Camera Tourist":                   "Hat_SnatcherContract_DeathWish_CameraTourist_1",
+
+    "The Mustache Gauntlet":            "Hat_SnatcherContract_DeathWish_HardCastle",
+    "No More Bad Guys":                 "Hat_SnatcherContract_DeathWish_MuGirlEX",
+
+    "Seal the Deal":                    "Hat_SnatcherContract_DeathWish_BossRushEX",
+    "Rift Collapse: Deep Sea":          "Hat_SnatcherContract_DeathWish_RiftCollapse_Cruise",
+    "Cruisin' for a Bruisin'":          "Hat_SnatcherContract_DeathWish_EndlessTasks",
+
+    "Community Rift: Rhythm Jump Studio":   "Hat_SnatcherContract_DeathWish_CommunityRift_RhythmJump",
+    "Community Rift: Twilight Travels":     "Hat_SnatcherContract_DeathWish_CommunityRift_TwilightTravels",
+    "Community Rift: The Mountain Rift":    "Hat_SnatcherContract_DeathWish_CommunityRift_MountainRift",
+
+    "Snatcher Coins in Nyakuza Metro":      "Hat_SnatcherContract_DeathWish_Tokens_Metro",
+}
+
+
+def create_dw_regions(world: "HatInTimeWorld"):
+    if world.options.DWExcludeAnnoyingContracts:
+        for name in annoying_dws:
+            world.excluded_dws.append(name)
+
+    if not world.options.DWEnableBonus or world.options.DWAutoCompleteBonuses:
+        for name in death_wishes:
+            world.excluded_bonuses.append(name)
+    elif world.options.DWExcludeAnnoyingBonuses:
+        for name in annoying_bonuses:
+            world.excluded_bonuses.append(name)
+
+    if world.options.DWExcludeCandles:
+        for name in dw_candles:
+            if name not in world.excluded_dws:
+                world.excluded_dws.append(name)
+
+    spaceship = world.multiworld.get_region("Spaceship", world.player)
+    dw_map: Region = create_region(world, "Death Wish Map")
+    entrance = spaceship.connect(dw_map, "-> Death Wish Map")
+    add_rule(entrance, lambda state: state.has("Time Piece", world.player, world.options.DWTimePieceRequirement))
+
+    if world.options.DWShuffle:
+        # Connect Death Wishes randomly to one another in a linear sequence
+        dw_list: List[str] = []
+        for name in death_wishes.keys():
+            # Don't shuffle excluded or invalid Death Wishes
+            if not world.is_dlc2() and name == "Snatcher Coins in Nyakuza Metro" or world.is_dw_excluded(name):
+                continue
+
+            dw_list.append(name)
+
+        world.random.shuffle(dw_list)
+        count = world.random.randint(world.options.DWShuffleCountMin.value, world.options.DWShuffleCountMax.value)
+        dw_shuffle: List[str] = []
+        total = min(len(dw_list), count)
+        for i in range(total):
+            dw_shuffle.append(dw_list[i])
+
+        # Seal the Deal is always last if it's the goal
+        if world.options.EndGoal == EndGoal.option_seal_the_deal:
+            if "Seal the Deal" in dw_shuffle:
+                dw_shuffle.remove("Seal the Deal")
+
+            dw_shuffle.append("Seal the Deal")
+
+        world.dw_shuffle = dw_shuffle
+        prev_dw = dw_map
+        for death_wish_name in dw_shuffle:
+            dw = create_region(world, death_wish_name)
+            prev_dw.connect(dw)
+            create_dw_locations(world, dw)
+            prev_dw = dw
+    else:
+        # DWShuffle is disabled, use vanilla connections
+        for key in death_wishes.keys():
+            if key == "Snatcher Coins in Nyakuza Metro" and not world.is_dlc2():
+                world.excluded_dws.append(key)
+                continue
+
+            dw = create_region(world, key)
+            if key == "Beat the Heat":
+                dw_map.connect(dw, f"{dw_map.name} -> Beat the Heat")
+            elif key in dw_prereqs.keys():
+                for name in dw_prereqs[key]:
+                    parent = world.multiworld.get_region(name, world.player)
+                    parent.connect(dw, f"{parent.name} -> {key}")
+
+            create_dw_locations(world, dw)
+
+
+def create_dw_locations(world: "HatInTimeWorld", dw: Region):
+    loc_id = death_wishes[dw.name]
+    main_objective = HatInTimeLocation(world.player, f"{dw.name} - Main Objective", loc_id, dw)
+    full_clear = HatInTimeLocation(world.player, f"{dw.name} - All Clear", loc_id + 1, dw)
+    main_stamp = HatInTimeLocation(world.player, f"Main Stamp - {dw.name}", None, dw)
+    bonus_stamps = HatInTimeLocation(world.player, f"Bonus Stamps - {dw.name}", None, dw)
+    main_stamp.show_in_spoiler = False
+    bonus_stamps.show_in_spoiler = False
+    dw.locations.append(main_stamp)
+    dw.locations.append(bonus_stamps)
+    main_stamp.place_locked_item(HatInTimeItem(f"1 Stamp - {dw.name}",
+                                               ItemClassification.progression, None, world.player))
+    bonus_stamps.place_locked_item(HatInTimeItem(f"2 Stamp - {dw.name}",
+                                                 ItemClassification.progression, None, world.player))
+
+    if dw.name in world.excluded_dws:
+        main_objective.progress_type = LocationProgressType.EXCLUDED
+        full_clear.progress_type = LocationProgressType.EXCLUDED
+    elif world.is_bonus_excluded(dw.name):
+        full_clear.progress_type = LocationProgressType.EXCLUDED
+
+    dw.locations.append(main_objective)
+    dw.locations.append(full_clear)

worlds/ahit/DeathWishRules.py

@@ -0,0 +1,462 @@
+from worlds.AutoWorld import CollectionState
+from .Rules import can_use_hat, can_use_hookshot, can_hit, zipline_logic, get_difficulty, has_paintings
+from .Types import HatType, Difficulty, HatInTimeLocation, HatInTimeItem, LocData, HitType
+from .DeathWishLocations import dw_prereqs, dw_candles
+from BaseClasses import Entrance, Location, ItemClassification
+from worlds.generic.Rules import add_rule, set_rule
+from typing import List, Callable, TYPE_CHECKING
+from .Locations import death_wishes
+from .Options import EndGoal
+
+if TYPE_CHECKING:
+    from . import HatInTimeWorld
+
+
+# Any speedruns expect the player to have Sprint Hat
+dw_requirements = {
+    "Beat the Heat": LocData(hit_type=HitType.umbrella),
+    "So You're Back From Outer Space": LocData(hookshot=True),
+    "Mafia's Jumps": LocData(required_hats=[HatType.ICE]),
+    "Vault Codes in the Wind": LocData(required_hats=[HatType.SPRINT]),
+
+    "Security Breach": LocData(hit_type=HitType.umbrella_or_brewing),
+    "10 Seconds until Self-Destruct": LocData(hookshot=True),
+    "Community Rift: Rhythm Jump Studio": LocData(required_hats=[HatType.ICE]),
+
+    "Speedrun Well": LocData(hookshot=True, hit_type=HitType.umbrella_or_brewing),
+    "Boss Rush": LocData(hit_type=HitType.umbrella, hookshot=True),
+    "Community Rift: Twilight Travels": LocData(hookshot=True, required_hats=[HatType.DWELLER]),
+
+    "Bird Sanctuary": LocData(hookshot=True),
+    "Wound-Up Windmill": LocData(hookshot=True),
+    "The Illness has Speedrun": LocData(hookshot=True),
+    "Community Rift: The Mountain Rift": LocData(hookshot=True, required_hats=[HatType.DWELLER]),
+    "Camera Tourist": LocData(misc_required=["Camera Badge"]),
+
+    "The Mustache Gauntlet": LocData(hookshot=True, required_hats=[HatType.DWELLER]),
+
+    "Rift Collapse - Deep Sea": LocData(hookshot=True),
+}
+
+# Includes main objective requirements
+dw_bonus_requirements = {
+    # Some One-Hit Hero requirements need badge pins as well because of Hookshot
+    "So You're Back From Outer Space": LocData(required_hats=[HatType.SPRINT]),
+    "Encore! Encore!": LocData(misc_required=["One-Hit Hero Badge"]),
+
+    "10 Seconds until Self-Destruct": LocData(misc_required=["One-Hit Hero Badge", "Badge Pin"]),
+
+    "Boss Rush": LocData(misc_required=["One-Hit Hero Badge", "Badge Pin"]),
+    "Community Rift: Twilight Travels": LocData(required_hats=[HatType.BREWING]),
+
+    "Bird Sanctuary": LocData(misc_required=["One-Hit Hero Badge", "Badge Pin"], required_hats=[HatType.DWELLER]),
+    "Wound-Up Windmill": LocData(misc_required=["One-Hit Hero Badge", "Badge Pin"]),
+    "The Illness has Speedrun": LocData(required_hats=[HatType.SPRINT]),
+
+    "The Mustache Gauntlet": LocData(required_hats=[HatType.ICE]),
+
+    "Rift Collapse - Deep Sea": LocData(required_hats=[HatType.DWELLER]),
+}
+
+dw_stamp_costs = {
+    "So You're Back From Outer Space":  2,
+    "Collect-a-thon":                   5,
+    "She Speedran from Outer Space":    8,
+    "Encore! Encore!":                  10,
+
+    "Security Breach":                  4,
+    "The Great Big Hootenanny":         7,
+    "10 Seconds until Self-Destruct":   15,
+    "Killing Two Birds":                25,
+    "Snatcher Coins in Nyakuza Metro":  30,
+
+    "Speedrun Well":                10,
+    "Boss Rush":                    15,
+    "Quality Time with Snatcher":   20,
+    "Breaching the Contract":       40,
+
+    "Bird Sanctuary":           15,
+    "Wound-Up Windmill":        30,
+    "The Illness has Speedrun": 35,
+
+    "The Mustache Gauntlet":    35,
+    "No More Bad Guys":         50,
+    "Seal the Deal":            70,
+}
+
+required_snatcher_coins = {
+    "Snatcher Coins in Mafia Town": ["Snatcher Coin - Top of HQ", "Snatcher Coin - Top of Tower",
+                                     "Snatcher Coin - Under Ruined Tower"],
+
+    "Snatcher Coins in Battle of the Birds": ["Snatcher Coin - Top of Red House", "Snatcher Coin - Train Rush",
+                                              "Snatcher Coin - Picture Perfect"],
+
+    "Snatcher Coins in Subcon Forest": ["Snatcher Coin - Swamp Tree", "Snatcher Coin - Manor Roof",
+                                        "Snatcher Coin - Giant Time Piece"],
+
+    "Snatcher Coins in Alpine Skyline": ["Snatcher Coin - Goat Village Top", "Snatcher Coin - Lava Cake",
+                                         "Snatcher Coin - Windmill"],
+
+    "Snatcher Coins in Nyakuza Metro": ["Snatcher Coin - Green Clean Tower", "Snatcher Coin - Bluefin Cat Train",
+                                        "Snatcher Coin - Pink Paw Fence"],
+}
+
+
+def set_dw_rules(world: "HatInTimeWorld"):
+    if "Snatcher's Hit List" not in world.excluded_dws or "Camera Tourist" not in world.excluded_dws:
+        set_enemy_rules(world)
+
+    dw_list: List[str] = []
+    if world.options.DWShuffle:
+        dw_list = world.dw_shuffle
+    else:
+        for name in death_wishes.keys():
+            dw_list.append(name)
+
+    for name in dw_list:
+        if name == "Snatcher Coins in Nyakuza Metro" and not world.is_dlc2():
+            continue
+
+        dw = world.multiworld.get_region(name, world.player)
+        if not world.options.DWShuffle and name in dw_stamp_costs.keys():
+            for entrance in dw.entrances:
+                add_rule(entrance, lambda state, n=name: state.has("Stamps", world.player, dw_stamp_costs[n]))
+
+        main_objective = world.multiworld.get_location(f"{name} - Main Objective", world.player)
+        all_clear = world.multiworld.get_location(f"{name} - All Clear", world.player)
+        main_stamp = world.multiworld.get_location(f"Main Stamp - {name}", world.player)
+        bonus_stamps = world.multiworld.get_location(f"Bonus Stamps - {name}", world.player)
+        if not world.options.DWEnableBonus:
+            # place nothing, but let the locations exist still, so we can use them for bonus stamp rules
+            all_clear.address = None
+            all_clear.place_locked_item(HatInTimeItem("Nothing", ItemClassification.filler, None, world.player))
+            all_clear.show_in_spoiler = False
+
+        # No need for rules if excluded - stamps will be auto-granted
+        if world.is_dw_excluded(name):
+            continue
+
+        modify_dw_rules(world, name)
+        add_dw_rules(world, main_objective)
+        add_dw_rules(world, all_clear)
+        add_rule(main_stamp, main_objective.access_rule)
+        add_rule(all_clear, main_objective.access_rule)
+        # Only set bonus stamp rules if we don't auto complete bonuses
+        if not world.options.DWAutoCompleteBonuses and not world.is_bonus_excluded(all_clear.name):
+            add_rule(bonus_stamps, all_clear.access_rule)
+
+    if world.options.DWShuffle:
+        for i in range(len(world.dw_shuffle)-1):
+            name = world.dw_shuffle[i+1]
+            prev_dw = world.multiworld.get_region(world.dw_shuffle[i], world.player)
+            entrance = world.multiworld.get_entrance(f"{prev_dw.name} -> {name}", world.player)
+            add_rule(entrance, lambda state, n=prev_dw.name: state.has(f"1 Stamp - {n}", world.player))
+    else:
+        for key, reqs in dw_prereqs.items():
+            if key == "Snatcher Coins in Nyakuza Metro" and not world.is_dlc2():
+                continue
+
+            access_rules: List[Callable[[CollectionState], bool]] = []
+            entrances: List[Entrance] = []
+
+            for parent in reqs:
+                entrance = world.multiworld.get_entrance(f"{parent} -> {key}", world.player)
+                entrances.append(entrance)
+
+                if not world.is_dw_excluded(parent):
+                    access_rules.append(lambda state, n=parent: state.has(f"1 Stamp - {n}", world.player))
+
+            for entrance in entrances:
+                for rule in access_rules:
+                    add_rule(entrance, rule)
+
+    if world.options.EndGoal == EndGoal.option_seal_the_deal:
+        world.multiworld.completion_condition[world.player] = lambda state: \
+            state.has("1 Stamp - Seal the Deal", world.player)
+
+
+def add_dw_rules(world: "HatInTimeWorld", loc: Location):
+    bonus: bool = "All Clear" in loc.name
+    if not bonus:
+        data = dw_requirements.get(loc.name)
+    else:
+        data = dw_bonus_requirements.get(loc.name)
+
+    if data is None:
+        return
+
+    if data.hookshot:
+        add_rule(loc, lambda state: can_use_hookshot(state, world))
+
+    for hat in data.required_hats:
+        add_rule(loc, lambda state, h=hat: can_use_hat(state, world, h))
+
+    for misc in data.misc_required:
+        add_rule(loc, lambda state, item=misc: state.has(item, world.player))
+
+    if data.paintings > 0 and world.options.ShuffleSubconPaintings:
+        add_rule(loc, lambda state, paintings=data.paintings: has_paintings(state, world, paintings))
+
+    if data.hit_type is not HitType.none and world.options.UmbrellaLogic:
+        if data.hit_type == HitType.umbrella:
+            add_rule(loc, lambda state: state.has("Umbrella", world.player))
+
+        elif data.hit_type == HitType.umbrella_or_brewing:
+            add_rule(loc, lambda state: state.has("Umbrella", world.player)
+                     or can_use_hat(state, world, HatType.BREWING))
+
+        elif data.hit_type == HitType.dweller_bell:
+            add_rule(loc, lambda state: state.has("Umbrella", world.player)
+                     or can_use_hat(state, world, HatType.BREWING)
+                     or can_use_hat(state, world, HatType.DWELLER))
+
+
+def modify_dw_rules(world: "HatInTimeWorld", name: str):
+    difficulty: Difficulty = get_difficulty(world)
+    main_objective = world.multiworld.get_location(f"{name} - Main Objective", world.player)
+    full_clear = world.multiworld.get_location(f"{name} - All Clear", world.player)
+
+    if name == "The Illness has Speedrun":
+        # All stamps with hookshot only in Expert
+        if difficulty >= Difficulty.EXPERT:
+            set_rule(full_clear, lambda state: True)
+        else:
+            add_rule(main_objective, lambda state: state.has("Umbrella", world.player))
+
+    elif name == "The Mustache Gauntlet":
+        add_rule(main_objective, lambda state: state.has("Umbrella", world.player)
+                 or can_use_hat(state, world, HatType.ICE) or can_use_hat(state, world, HatType.BREWING))
+
+    elif name == "Vault Codes in the Wind":
+        # Sprint is normally expected here
+        if difficulty >= Difficulty.HARD:
+            set_rule(main_objective, lambda state: True)
+
+    elif name == "Speedrun Well":
+        # All stamps with nothing :)
+        if difficulty >= Difficulty.EXPERT:
+            set_rule(main_objective, lambda state: True)
+
+    elif name == "Mafia's Jumps":
+        if difficulty >= Difficulty.HARD:
+            set_rule(main_objective, lambda state: True)
+            set_rule(full_clear, lambda state: True)
+
+    elif name == "So You're Back from Outer Space":
+        # Without Hookshot
+        if difficulty >= Difficulty.HARD:
+            set_rule(main_objective, lambda state: True)
+
+    elif name == "Wound-Up Windmill":
+        # No badge pin required. Player can switch to One Hit Hero after the checkpoint and do level without it.
+        if difficulty >= Difficulty.MODERATE:
+            set_rule(full_clear, lambda state: can_use_hookshot(state, world)
+                     and state.has("One-Hit Hero Badge", world.player))
+
+    if name in dw_candles:
+        set_candle_dw_rules(name, world)
+
+
+def set_candle_dw_rules(name: str, world: "HatInTimeWorld"):
+    main_objective = world.multiworld.get_location(f"{name} - Main Objective", world.player)
+    full_clear = world.multiworld.get_location(f"{name} - All Clear", world.player)
+
+    if name == "Zero Jumps":
+        add_rule(main_objective, lambda state: state.has("Zero Jumps", world.player))
+        add_rule(full_clear, lambda state: state.has("Zero Jumps", world.player, 4)
+                 and state.has("Train Rush (Zero Jumps)", world.player) and can_use_hat(state, world, HatType.ICE))
+
+        # No Ice Hat/painting required in Expert for Toilet Zero Jumps
+        # This painting wall can only be skipped via cherry hover.
+        if get_difficulty(world) < Difficulty.EXPERT or world.options.NoPaintingSkips:
+            set_rule(world.multiworld.get_location("Toilet of Doom (Zero Jumps)", world.player),
+                     lambda state: can_use_hookshot(state, world) and can_hit(state, world)
+                     and has_paintings(state, world, 1, False))
+        else:
+            set_rule(world.multiworld.get_location("Toilet of Doom (Zero Jumps)", world.player),
+                     lambda state: can_use_hookshot(state, world) and can_hit(state, world))
+
+        set_rule(world.multiworld.get_location("Contractual Obligations (Zero Jumps)", world.player),
+                 lambda state: has_paintings(state, world, 1, False))
+
+    elif name == "Snatcher's Hit List":
+        add_rule(main_objective, lambda state: state.has("Mafia Goon", world.player))
+        add_rule(full_clear, lambda state: state.has("Enemy", world.player, 12))
+
+    elif name == "Camera Tourist":
+        add_rule(main_objective, lambda state: state.has("Enemy", world.player, 8))
+        add_rule(full_clear, lambda state: state.has("Boss", world.player, 6)
+                 and state.has("Triple Enemy Photo", world.player))
+
+    elif "Snatcher Coins" in name:
+        coins: List[str] = []
+        for coin in required_snatcher_coins[name]:
+            coins.append(coin)
+            add_rule(full_clear, lambda state, c=coin: state.has(c, world.player))
+
+        # any coin works for the main objective
+        add_rule(main_objective, lambda state: state.has(coins[0], world.player)
+                 or state.has(coins[1], world.player)
+                 or state.has(coins[2], world.player))
+
+
+def create_enemy_events(world: "HatInTimeWorld"):
+    no_tourist = "Camera Tourist" in world.excluded_dws
+    for enemy, regions in hit_list.items():
+        if no_tourist and enemy in bosses:
+            continue
+
+        for area in regions:
+            if (area == "Bon Voyage!" or area == "Time Rift - Deep Sea") and not world.is_dlc1():
+                continue
+
+            if area == "Time Rift - Tour" and (not world.is_dlc1() or world.options.ExcludeTour):
+                continue
+
+            if area == "Bluefin Tunnel" and not world.is_dlc2():
+                continue
+
+            if world.options.DWShuffle and area in death_wishes.keys() and area not in world.dw_shuffle:
+                continue
+
+            region = world.multiworld.get_region(area, world.player)
+            event = HatInTimeLocation(world.player, f"{enemy} - {area}", None, region)
+            event.place_locked_item(HatInTimeItem(enemy, ItemClassification.progression, None, world.player))
+            region.locations.append(event)
+            event.show_in_spoiler = False
+
+    for name in triple_enemy_locations:
+        if name == "Time Rift - Tour" and (not world.is_dlc1() or world.options.ExcludeTour):
+            continue
+
+        if world.options.DWShuffle and name in death_wishes.keys() and name not in world.dw_shuffle:
+            continue
+
+        region = world.multiworld.get_region(name, world.player)
+        event = HatInTimeLocation(world.player, f"Triple Enemy Photo - {name}", None, region)
+        event.place_locked_item(HatInTimeItem("Triple Enemy Photo", ItemClassification.progression, None, world.player))
+        region.locations.append(event)
+        event.show_in_spoiler = False
+        if name == "The Mustache Gauntlet":
+            add_rule(event, lambda state: can_use_hookshot(state, world) and can_use_hat(state, world, HatType.DWELLER))
+
+
+def set_enemy_rules(world: "HatInTimeWorld"):
+    no_tourist = "Camera Tourist" in world.excluded_dws or "Camera Tourist" in world.excluded_bonuses
+
+    for enemy, regions in hit_list.items():
+        if no_tourist and enemy in bosses:
+            continue
+
+        for area in regions:
+            if (area == "Bon Voyage!" or area == "Time Rift - Deep Sea") and not world.is_dlc1():
+                continue
+
+            if area == "Time Rift - Tour" and (not world.is_dlc1() or world.options.ExcludeTour):
+                continue
+
+            if area == "Bluefin Tunnel" and not world.is_dlc2():
+                continue
+
+            if world.options.DWShuffle and area in death_wishes and area not in world.dw_shuffle:
+                continue
+
+            event = world.multiworld.get_location(f"{enemy} - {area}", world.player)
+
+            if enemy == "Toxic Flower":
+                add_rule(event, lambda state: can_use_hookshot(state, world))
+
+                if area == "The Illness has Spread":
+                    add_rule(event, lambda state: not zipline_logic(world) or
+                             state.has("Zipline Unlock - The Birdhouse Path", world.player)
+                             or state.has("Zipline Unlock - The Lava Cake Path", world.player)
+                             or state.has("Zipline Unlock - The Windmill Path", world.player))
+
+            elif enemy == "Director":
+                if area == "Dead Bird Studio Basement":
+                    add_rule(event, lambda state: can_use_hookshot(state, world))
+
+            elif enemy == "Snatcher" or enemy == "Mustache Girl":
+                if area == "Boss Rush":
+                    # need to be able to kill toilet and snatcher
+                    add_rule(event, lambda state: can_hit(state, world) and can_use_hookshot(state, world))
+                    if enemy == "Mustache Girl":
+                        add_rule(event, lambda state: can_hit(state, world, True) and can_use_hookshot(state, world))
+
+                elif area == "The Finale" and enemy == "Mustache Girl":
+                    add_rule(event, lambda state: can_use_hookshot(state, world)
+                             and can_use_hat(state, world, HatType.DWELLER))
+
+            elif enemy == "Shock Squid" or enemy == "Ninja Cat":
+                if area == "Time Rift - Deep Sea":
+                    add_rule(event, lambda state: can_use_hookshot(state, world))
+
+
+# Enemies for Snatcher's Hit List/Camera Tourist, and where to find them
+hit_list = {
+    "Mafia Goon":       ["Mafia Town Area", "Time Rift - Mafia of Cooks", "Time Rift - Tour",
+                         "Bon Voyage!", "The Mustache Gauntlet", "Rift Collapse: Mafia of Cooks",
+                         "So You're Back From Outer Space"],
+
+    "Sleepy Raccoon":   ["She Came from Outer Space", "Down with the Mafia!", "The Twilight Bell",
+                         "She Speedran from Outer Space", "Mafia's Jumps", "The Mustache Gauntlet",
+                         "Time Rift - Sleepy Subcon", "Rift Collapse: Sleepy Subcon"],
+
+    "UFO":              ["Picture Perfect", "So You're Back From Outer Space", "Community Rift: Rhythm Jump Studio"],
+
+    "Rat":              ["Down with the Mafia!", "Bluefin Tunnel"],
+
+    "Shock Squid":      ["Bon Voyage!", "Time Rift - Sleepy Subcon", "Time Rift - Deep Sea",
+                         "Rift Collapse: Sleepy Subcon"],
+
+    "Shromb Egg":       ["The Birdhouse", "Bird Sanctuary"],
+
+    "Spider":           ["Subcon Forest Area", "The Mustache Gauntlet", "Speedrun Well",
+                         "The Lava Cake", "The Windmill"],
+
+    "Crow":             ["Mafia Town Area", "The Birdhouse", "Time Rift - Tour", "Bird Sanctuary",
+                         "Time Rift - Alpine Skyline", "Rift Collapse: Alpine Skyline"],
+
+    "Pompous Crow":     ["The Birdhouse", "Time Rift - The Lab", "Bird Sanctuary", "The Mustache Gauntlet"],
+
+    "Fiery Crow":       ["The Finale", "The Lava Cake", "The Mustache Gauntlet"],
+
+    "Express Owl":      ["The Finale", "Time Rift - The Owl Express", "Time Rift - Deep Sea"],
+
+    "Ninja Cat":        ["The Birdhouse", "The Windmill", "Bluefin Tunnel", "The Mustache Gauntlet",
+                         "Time Rift - Curly Tail Trail", "Time Rift - Alpine Skyline", "Time Rift - Deep Sea",
+                         "Rift Collapse: Alpine Skyline"],
+
+    # Bosses
+    "Mafia Boss":       ["Down with the Mafia!", "Encore! Encore!", "Boss Rush"],
+
+    "Conductor":        ["Dead Bird Studio Basement", "Killing Two Birds", "Boss Rush"],
+    "Toilet":           ["Toilet of Doom", "Boss Rush"],
+
+    "Snatcher":         ["Your Contract has Expired", "Breaching the Contract", "Boss Rush",
+                         "Quality Time with Snatcher"],
+
+    "Toxic Flower":     ["The Illness has Spread", "The Illness has Speedrun"],
+
+    "Mustache Girl":    ["The Finale", "Boss Rush", "No More Bad Guys"],
+}
+
+# Camera Tourist has a bonus that requires getting three different types of enemies in one photo.
+triple_enemy_locations = [
+    "She Came from Outer Space",
+    "She Speedran from Outer Space",
+    "Mafia's Jumps",
+    "The Mustache Gauntlet",
+    "The Birdhouse",
+    "Bird Sanctuary",
+    "Time Rift - Tour",
+]
+
+bosses = [
+    "Mafia Boss",
+    "Conductor",
+    "Toilet",
+    "Snatcher",
+    "Toxic Flower",
+    "Mustache Girl",
+]

worlds/ahit/Items.py

@@ -0,0 +1,302 @@
+from BaseClasses import Item, ItemClassification
+from .Types import HatDLC, HatType, hat_type_to_item, Difficulty, ItemData, HatInTimeItem
+from .Locations import get_total_locations
+from .Rules import get_difficulty
+from .Options import get_total_time_pieces, CTRLogic
+from typing import List, Dict, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from . import HatInTimeWorld
+
+
+def create_itempool(world: "HatInTimeWorld") -> List[Item]:
+    itempool: List[Item] = []
+    if world.has_yarn():
+        yarn_pool: List[Item] = create_multiple_items(world, "Yarn",
+                                                      world.options.YarnAvailable.value,
+                                                      ItemClassification.progression_skip_balancing)
+
+        for i in range(int(len(yarn_pool) * (0.01 * world.options.YarnBalancePercent))):
+            yarn_pool[i].classification = ItemClassification.progression
+
+        itempool += yarn_pool
+
+    for name in item_table.keys():
+        if name == "Yarn":
+            continue
+
+        if not item_dlc_enabled(world, name):
+            continue
+
+        if not world.options.HatItems and name in hat_type_to_item.values():
+            continue
+
+        item_type: ItemClassification = item_table.get(name).classification
+
+        if world.is_dw_only():
+            if item_type is ItemClassification.progression \
+               or item_type is ItemClassification.progression_skip_balancing:
+                continue
+        else:
+            if name == "Scooter Badge":
+                if world.options.CTRLogic is CTRLogic.option_scooter or get_difficulty(world) >= Difficulty.MODERATE:
+                    item_type = ItemClassification.progression
+            elif name == "No Bonk Badge" and world.is_dw():
+                item_type = ItemClassification.progression
+
+        # some death wish bonuses require one hit hero + hookshot
+        if world.is_dw() and name == "Badge Pin" and not world.is_dw_only():
+            item_type = ItemClassification.progression
+
+        if item_type is ItemClassification.filler or item_type is ItemClassification.trap:
+            continue
+
+        if name in act_contracts.keys() and not world.options.ShuffleActContracts:
+            continue
+
+        if name in alps_hooks.keys() and not world.options.ShuffleAlpineZiplines:
+            continue
+
+        if name == "Progressive Painting Unlock" and not world.options.ShuffleSubconPaintings:
+            continue
+
+        if world.options.StartWithCompassBadge and name == "Compass Badge":
+            continue
+
+        if name == "Time Piece":
+            tp_list: List[Item] = create_multiple_items(world, name, get_total_time_pieces(world), item_type)
+            for i in range(int(len(tp_list) * (0.01 * world.options.TimePieceBalancePercent))):
+                tp_list[i].classification = ItemClassification.progression
+
+            itempool += tp_list
+            continue
+
+        itempool += create_multiple_items(world, name, item_frequencies.get(name, 1), item_type)
+
+    itempool += create_junk_items(world, get_total_locations(world) - len(itempool))
+    return itempool
+
+
+def calculate_yarn_costs(world: "HatInTimeWorld"):
+    min_yarn_cost = int(min(world.options.YarnCostMin.value, world.options.YarnCostMax.value))
+    max_yarn_cost = int(max(world.options.YarnCostMin.value, world.options.YarnCostMax.value))
+
+    max_cost = 0
+    for i in range(5):
+        hat: HatType = HatType(i)
+        if not world.is_hat_precollected(hat):
+            cost: int = world.random.randint(min_yarn_cost, max_yarn_cost)
+            world.hat_yarn_costs[hat] = cost
+            max_cost += cost
+        else:
+            world.hat_yarn_costs[hat] = 0
+
+    available_yarn: int = world.options.YarnAvailable.value
+    if max_cost > available_yarn:
+        world.options.YarnAvailable.value = max_cost
+        available_yarn = max_cost
+
+    extra_yarn = max_cost + world.options.MinExtraYarn - available_yarn
+    if extra_yarn > 0:
+        world.options.YarnAvailable.value += extra_yarn
+
+
+def item_dlc_enabled(world: "HatInTimeWorld", name: str) -> bool:
+    data = item_table[name]
+
+    if data.dlc_flags == HatDLC.none:
+        return True
+    elif data.dlc_flags == HatDLC.dlc1 and world.is_dlc1():
+        return True
+    elif data.dlc_flags == HatDLC.dlc2 and world.is_dlc2():
+        return True
+    elif data.dlc_flags == HatDLC.death_wish and world.is_dw():
+        return True
+
+    return False
+
+
+def create_item(world: "HatInTimeWorld", name: str) -> Item:
+    data = item_table[name]
+    return HatInTimeItem(name, data.classification, data.code, world.player)
+
+
+def create_multiple_items(world: "HatInTimeWorld", name: str, count: int = 1,
+                          item_type: ItemClassification = ItemClassification.progression) -> List[Item]:
+
+    data = item_table[name]
+    itemlist: List[Item] = []
+
+    for i in range(count):
+        itemlist += [HatInTimeItem(name, item_type, data.code, world.player)]
+
+    return itemlist
+
+
+def create_junk_items(world: "HatInTimeWorld", count: int) -> List[Item]:
+    trap_chance = world.options.TrapChance.value
+    junk_pool: List[Item] = []
+    junk_list: Dict[str, int] = {}
+    trap_list: Dict[str, int] = {}
+    ic: ItemClassification
+
+    for name in item_table.keys():
+        ic = item_table[name].classification
+        if ic == ItemClassification.filler:
+            if world.is_dw_only() and "Pons" in name:
+                continue
+
+            junk_list[name] = junk_weights.get(name)
+
+        elif trap_chance > 0 and ic == ItemClassification.trap:
+            if name == "Baby Trap":
+                trap_list[name] = world.options.BabyTrapWeight.value
+            elif name == "Laser Trap":
+                trap_list[name] = world.options.LaserTrapWeight.value
+            elif name == "Parade Trap":
+                trap_list[name] = world.options.ParadeTrapWeight.value
+
+    for i in range(count):
+        if trap_chance > 0 and world.random.randint(1, 100) <= trap_chance:
+            junk_pool.append(world.create_item(
+                world.random.choices(list(trap_list.keys()), weights=list(trap_list.values()), k=1)[0]))
+        else:
+            junk_pool.append(world.create_item(
+                world.random.choices(list(junk_list.keys()), weights=list(junk_list.values()), k=1)[0]))
+
+    return junk_pool
+
+
+def get_shop_trap_name(world: "HatInTimeWorld") -> str:
+    rand = world.random.randint(1, 9)
+    name = ""
+    if rand == 1:
+        name = "Time Plece"
+    elif rand == 2:
+        name = "Time Piece (Trust me bro)"
+    elif rand == 3:
+        name = "TimePiece"
+    elif rand == 4:
+        name = "Time Piece?"
+    elif rand == 5:
+        name = "Time Pizza"
+    elif rand == 6:
+        name = "Time piece"
+    elif rand == 7:
+        name = "TIme Piece"
+    elif rand == 8:
+        name = "Time Piece (maybe)"
+    elif rand == 9:
+        name = "Time Piece ;)"
+
+    return name
+
+
+ahit_items = {
+    "Yarn": ItemData(2000300001, ItemClassification.progression_skip_balancing),
+    "Time Piece": ItemData(2000300002, ItemClassification.progression_skip_balancing),
+
+    # for HatItems option
+    "Sprint Hat": ItemData(2000300049, ItemClassification.progression),
+    "Brewing Hat": ItemData(2000300050, ItemClassification.progression),
+    "Ice Hat": ItemData(2000300051, ItemClassification.progression),
+    "Dweller Mask": ItemData(2000300052, ItemClassification.progression),
+    "Time Stop Hat": ItemData(2000300053, ItemClassification.progression),
+
+    # Badges
+    "Projectile Badge": ItemData(2000300024, ItemClassification.useful),
+    "Fast Hatter Badge": ItemData(2000300025, ItemClassification.useful),
+    "Hover Badge": ItemData(2000300026, ItemClassification.useful),
+    "Hookshot Badge": ItemData(2000300027, ItemClassification.progression),
+    "Item Magnet Badge": ItemData(2000300028, ItemClassification.useful),
+    "No Bonk Badge": ItemData(2000300029, ItemClassification.useful),
+    "Compass Badge": ItemData(2000300030, ItemClassification.useful),
+    "Scooter Badge": ItemData(2000300031, ItemClassification.useful),
+    "One-Hit Hero Badge": ItemData(2000300038, ItemClassification.progression, HatDLC.death_wish),
+    "Camera Badge": ItemData(2000300042, ItemClassification.progression, HatDLC.death_wish),
+
+    # Relics
+    "Relic (Burger Patty)": ItemData(2000300006, ItemClassification.progression),
+    "Relic (Burger Cushion)": ItemData(2000300007, ItemClassification.progression),
+    "Relic (Mountain Set)": ItemData(2000300008, ItemClassification.progression),
+    "Relic (Train)": ItemData(2000300009, ItemClassification.progression),
+    "Relic (UFO)": ItemData(2000300010, ItemClassification.progression),
+    "Relic (Cow)": ItemData(2000300011, ItemClassification.progression),
+    "Relic (Cool Cow)": ItemData(2000300012, ItemClassification.progression),
+    "Relic (Tin-foil Hat Cow)": ItemData(2000300013, ItemClassification.progression),
+    "Relic (Crayon Box)": ItemData(2000300014, ItemClassification.progression),
+    "Relic (Red Crayon)": ItemData(2000300015, ItemClassification.progression),
+    "Relic (Blue Crayon)": ItemData(2000300016, ItemClassification.progression),
+    "Relic (Green Crayon)": ItemData(2000300017, ItemClassification.progression),
+    # DLC
+    "Relic (Cake Stand)": ItemData(2000300018, ItemClassification.progression, HatDLC.dlc1),
+    "Relic (Shortcake)": ItemData(2000300019, ItemClassification.progression, HatDLC.dlc1),
+    "Relic (Chocolate Cake Slice)": ItemData(2000300020, ItemClassification.progression, HatDLC.dlc1),
+    "Relic (Chocolate Cake)": ItemData(2000300021, ItemClassification.progression, HatDLC.dlc1),
+    "Relic (Necklace Bust)": ItemData(2000300022, ItemClassification.progression, HatDLC.dlc2),
+    "Relic (Necklace)": ItemData(2000300023, ItemClassification.progression, HatDLC.dlc2),
+
+    # Garbage items
+    "25 Pons": ItemData(2000300034, ItemClassification.filler),
+    "50 Pons": ItemData(2000300035, ItemClassification.filler),
+    "100 Pons": ItemData(2000300036, ItemClassification.filler),
+    "Health Pon": ItemData(2000300037, ItemClassification.filler),
+    "Random Cosmetic": ItemData(2000300044, ItemClassification.filler),
+
+    # Traps
+    "Baby Trap": ItemData(2000300039, ItemClassification.trap),
+    "Laser Trap": ItemData(2000300040, ItemClassification.trap),
+    "Parade Trap": ItemData(2000300041, ItemClassification.trap),
+
+    # Other
+    "Badge Pin": ItemData(2000300043, ItemClassification.useful),
+    "Umbrella": ItemData(2000300033, ItemClassification.progression),
+    "Progressive Painting Unlock": ItemData(2000300003, ItemClassification.progression),
+    # DLC
+    "Metro Ticket - Yellow": ItemData(2000300045, ItemClassification.progression, HatDLC.dlc2),
+    "Metro Ticket - Green": ItemData(2000300046, ItemClassification.progression, HatDLC.dlc2),
+    "Metro Ticket - Blue": ItemData(2000300047, ItemClassification.progression, HatDLC.dlc2),
+    "Metro Ticket - Pink": ItemData(2000300048, ItemClassification.progression, HatDLC.dlc2),
+}
+
+act_contracts = {
+    "Snatcher's Contract - The Subcon Well": ItemData(2000300200, ItemClassification.progression),
+    "Snatcher's Contract - Toilet of Doom": ItemData(2000300201, ItemClassification.progression),
+    "Snatcher's Contract - Queen Vanessa's Manor": ItemData(2000300202, ItemClassification.progression),
+    "Snatcher's Contract - Mail Delivery Service": ItemData(2000300203, ItemClassification.progression),
+}
+
+alps_hooks = {
+    "Zipline Unlock - The Birdhouse Path": ItemData(2000300204, ItemClassification.progression),
+    "Zipline Unlock - The Lava Cake Path": ItemData(2000300205, ItemClassification.progression),
+    "Zipline Unlock - The Windmill Path": ItemData(2000300206, ItemClassification.progression),
+    "Zipline Unlock - The Twilight Bell Path": ItemData(2000300207, ItemClassification.progression),
+}
+
+relic_groups = {
+    "Burger": {"Relic (Burger Patty)", "Relic (Burger Cushion)"},
+    "Train": {"Relic (Mountain Set)", "Relic (Train)"},
+    "UFO": {"Relic (UFO)", "Relic (Cow)", "Relic (Cool Cow)", "Relic (Tin-foil Hat Cow)"},
+    "Crayon": {"Relic (Crayon Box)", "Relic (Red Crayon)", "Relic (Blue Crayon)", "Relic (Green Crayon)"},
+    "Cake": {"Relic (Cake Stand)", "Relic (Chocolate Cake)", "Relic (Chocolate Cake Slice)", "Relic (Shortcake)"},
+    "Necklace": {"Relic (Necklace Bust)", "Relic (Necklace)"},
+}
+
+item_frequencies = {
+    "Badge Pin": 2,
+    "Progressive Painting Unlock": 3,
+}
+
+junk_weights = {
+    "25 Pons": 50,
+    "50 Pons": 25,
+    "100 Pons": 10,
+    "Health Pon": 35,
+    "Random Cosmetic": 35,
+}
+
+item_table = {
+    **ahit_items,
+    **act_contracts,
+    **alps_hooks,
+}

worlds/ahit/Options.py

@@ -0,0 +1,770 @@
+from typing import List, TYPE_CHECKING, Dict, Any
+from schema import Schema, Optional
+from dataclasses import dataclass
+from worlds.AutoWorld import PerGameCommonOptions
+from Options import Range, Toggle, DeathLink, Choice, OptionDict, DefaultOnToggle, OptionGroup
+
+if TYPE_CHECKING:
+    from . import HatInTimeWorld
+
+
+def create_option_groups() -> List[OptionGroup]:
+    option_group_list: List[OptionGroup] = []
+    for name, options in ahit_option_groups.items():
+        option_group_list.append(OptionGroup(name=name, options=options))
+
+    return option_group_list
+
+
+def adjust_options(world: "HatInTimeWorld"):
+    if world.options.HighestChapterCost < world.options.LowestChapterCost:
+        world.options.HighestChapterCost.value, world.options.LowestChapterCost.value = \
+         world.options.LowestChapterCost.value, world.options.HighestChapterCost.value
+
+    if world.options.FinalChapterMaxCost < world.options.FinalChapterMinCost:
+        world.options.FinalChapterMaxCost.value, world.options.FinalChapterMinCost.value = \
+         world.options.FinalChapterMinCost.value, world.options.FinalChapterMaxCost.value
+
+    if world.options.BadgeSellerMaxItems < world.options.BadgeSellerMinItems:
+        world.options.BadgeSellerMaxItems.value, world.options.BadgeSellerMinItems.value = \
+         world.options.BadgeSellerMinItems.value, world.options.BadgeSellerMaxItems.value
+
+    if world.options.NyakuzaThugMaxShopItems < world.options.NyakuzaThugMinShopItems:
+        world.options.NyakuzaThugMaxShopItems.value, world.options.NyakuzaThugMinShopItems.value = \
+         world.options.NyakuzaThugMinShopItems.value, world.options.NyakuzaThugMaxShopItems.value
+
+    if world.options.DWShuffleCountMax < world.options.DWShuffleCountMin:
+        world.options.DWShuffleCountMax.value, world.options.DWShuffleCountMin.value = \
+         world.options.DWShuffleCountMin.value, world.options.DWShuffleCountMax.value
+
+    total_tps: int = get_total_time_pieces(world)
+    if world.options.HighestChapterCost > total_tps-5:
+        world.options.HighestChapterCost.value = min(45, total_tps-5)
+
+    if world.options.LowestChapterCost > total_tps-5:
+        world.options.LowestChapterCost.value = min(45, total_tps-5)
+
+    if world.options.FinalChapterMaxCost > total_tps:
+        world.options.FinalChapterMaxCost.value = min(50, total_tps)
+
+    if world.options.FinalChapterMinCost > total_tps:
+        world.options.FinalChapterMinCost.value = min(50, total_tps)
+
+    if world.is_dlc1() and world.options.ShipShapeCustomTaskGoal <= 0:
+        # automatically determine task count based on Tasksanity settings
+        if world.options.Tasksanity:
+            world.options.ShipShapeCustomTaskGoal.value = world.options.TasksanityCheckCount * world.options.TasksanityTaskStep
+        else:
+            world.options.ShipShapeCustomTaskGoal.value = 18
+
+    # Don't allow Rush Hour goal if DLC2 content is disabled
+    if world.options.EndGoal == EndGoal.option_rush_hour and not world.options.EnableDLC2:
+        world.options.EndGoal.value = EndGoal.option_finale
+
+    # Don't allow Seal the Deal goal if Death Wish content is disabled
+    if world.options.EndGoal == EndGoal.option_seal_the_deal and not world.is_dw():
+        world.options.EndGoal.value = EndGoal.option_finale
+
+    if world.options.DWEnableBonus:
+        world.options.DWAutoCompleteBonuses.value = 0
+
+    if world.is_dw_only():
+        world.options.EndGoal.value = EndGoal.option_seal_the_deal
+        world.options.ActRandomizer.value = 0
+        world.options.ShuffleAlpineZiplines.value = 0
+        world.options.ShuffleSubconPaintings.value = 0
+        world.options.ShuffleStorybookPages.value = 0
+        world.options.ShuffleActContracts.value = 0
+        world.options.EnableDLC1.value = 0
+        world.options.LogicDifficulty.value = LogicDifficulty.option_normal
+        world.options.DWTimePieceRequirement.value = 0
+
+
+def get_total_time_pieces(world: "HatInTimeWorld") -> int:
+    count: int = 40
+    if world.is_dlc1():
+        count += 6
+
+    if world.is_dlc2():
+        count += 10
+
+    return min(40+world.options.MaxExtraTimePieces, count)
+
+
+class EndGoal(Choice):
+    """The end goal required to beat the game.
+    Finale: Reach Time's End and beat Mustache Girl. The Finale will be in its vanilla location.
+
+    Rush Hour: Reach and complete Rush Hour. The level will be in its vanilla location and Chapter 7
+    will be the final chapter. You also must find Nyakuza Metro itself and complete all of its levels.
+    Requires DLC2 content to be enabled.
+
+    Seal the Deal: Reach and complete the Seal the Deal death wish main objective.
+    Requires Death Wish content to be enabled."""
+    display_name = "End Goal"
+    option_finale = 1
+    option_rush_hour = 2
+    option_seal_the_deal = 3
+    default = 1
+
+
+class ActRandomizer(Choice):
+    """If enabled, shuffle the game's Acts between each other.
+    Light will cause Time Rifts to only be shuffled amongst each other,
+    and Blue Time Rifts and Purple Time Rifts to be shuffled separately."""
+    display_name = "Shuffle Acts"
+    option_false = 0
+    option_light = 1
+    option_insanity = 2
+    default = 1
+
+
+class ActPlando(OptionDict):
+    """Plando acts onto other acts. For example, \"Train Rush\": \"Alpine Free Roam\" will place Alpine Free Roam
+    at Train Rush."""
+    display_name = "Act Plando"
+    schema = Schema({
+        Optional(str): str
+    })
+
+
+class ActBlacklist(OptionDict):
+    """Blacklist acts from being shuffled onto other acts. Multiple can be listed per act.
+    For example, \"Barrel Battle\": [\"The Big Parade\", \"Dead Bird Studio\"]
+    will prevent The Big Parade and Dead Bird Studio from being shuffled onto Barrel Battle."""
+    display_name = "Act Blacklist"
+    schema = Schema({
+        Optional(str): list
+    })
+
+
+class FinaleShuffle(Toggle):
+    """If enabled, chapter finales will only be shuffled amongst each other in act shuffle."""
+    display_name = "Finale Shuffle"
+
+
+class LogicDifficulty(Choice):
+    """Choose the difficulty setting for logic.
+    For an exhaustive list of all logic tricks for each difficulty, see this Google Doc:
+    https://docs.google.com/document/d/1x9VLSQ5davfx1KGamR9T0mD5h69_lDXJ6H7Gq7knJRI/edit?usp=sharing"""
+    display_name = "Logic Difficulty"
+    option_normal = -1
+    option_moderate = 0
+    option_hard = 1
+    option_expert = 2
+    default = -1
+
+
+class CTRLogic(Choice):
+    """Choose how you want to logically clear Cheating the Race."""
+    display_name = "Cheating the Race Logic"
+    option_time_stop_only = 0
+    option_scooter = 1
+    option_sprint = 2
+    option_nothing = 3
+    default = 0
+
+
+class RandomizeHatOrder(Choice):
+    """Randomize the order that hats are stitched in.
+    Time Stop Last will force Time Stop to be the last hat in the sequence."""
+    display_name = "Randomize Hat Order"
+    option_false = 0
+    option_true = 1
+    option_time_stop_last = 2
+    default = 1
+
+
+class YarnBalancePercent(Range):
+    """How much (in percentage) of the yarn in the pool that will be progression balanced."""
+    display_name = "Yarn Balance Percentage"
+    default = 20
+    range_start = 0
+    range_end = 100
+
+
+class TimePieceBalancePercent(Range):
+    """How much (in percentage) of time pieces in the pool that will be progression balanced."""
+    display_name = "Time Piece Balance Percentage"
+    default = 35
+    range_start = 0
+    range_end = 100
+
+
+class StartWithCompassBadge(DefaultOnToggle):
+    """If enabled, start with the Compass Badge. In Archipelago, the Compass Badge will track all items in the world
+    (instead of just Relics). Recommended if you're not familiar with where item locations are."""
+    display_name = "Start with Compass Badge"
+
+
+class CompassBadgeMode(Choice):
+    """closest - Compass Badge points to the closest item regardless of classification
+    important_only - Compass Badge points to progression/useful items only
+    important_first - Compass Badge points to progression/useful items first, then it will point to junk items"""
+    display_name = "Compass Badge Mode"
+    option_closest = 1
+    option_important_only = 2
+    option_important_first = 3
+    default = 1
+
+
+class UmbrellaLogic(Toggle):
+    """Makes Hat Kid's default punch attack do absolutely nothing, making the Umbrella much more relevant and useful"""
+    display_name = "Umbrella Logic"
+
+
+class ShuffleStorybookPages(DefaultOnToggle):
+    """If enabled, each storybook page in the purple Time Rifts is an item check.
+    The Compass Badge can track these down for you."""
+    display_name = "Shuffle Storybook Pages"
+
+
+class ShuffleActContracts(DefaultOnToggle):
+    """If enabled, shuffle Snatcher's act contracts into the pool as items"""
+    display_name = "Shuffle Contracts"
+
+
+class ShuffleAlpineZiplines(Toggle):
+    """If enabled, Alpine's zipline paths leading to the peaks will be locked behind items."""
+    display_name = "Shuffle Alpine Ziplines"
+
+
+class ShuffleSubconPaintings(Toggle):
+    """If enabled, shuffle items into the pool that unlock Subcon Forest fire spirit paintings.
+    These items are progressive, with the order of Village-Swamp-Courtyard."""
+    display_name = "Shuffle Subcon Paintings"
+
+
+class NoPaintingSkips(Toggle):
+    """If enabled, prevent Subcon fire wall skips from being in logic on higher difficulty settings."""
+    display_name = "No Subcon Fire Wall Skips"
+
+
+class StartingChapter(Choice):
+    """Determines which chapter you will be guaranteed to be able to enter at the beginning of the game."""
+    display_name = "Starting Chapter"
+    option_1 = 1
+    option_2 = 2
+    option_3 = 3
+    option_4 = 4
+    default = 1
+
+
+class ChapterCostIncrement(Range):
+    """Lower values mean chapter costs increase slower. Higher values make the cost differences more steep."""
+    display_name = "Chapter Cost Increment"
+    range_start = 1
+    range_end = 8
+    default = 4
+
+
+class ChapterCostMinDifference(Range):
+    """The minimum difference between chapter costs."""
+    display_name = "Minimum Chapter Cost Difference"
+    range_start = 1
+    range_end = 8
+    default = 4
+
+
+class LowestChapterCost(Range):
+    """Value determining the lowest possible cost for a chapter.
+    Chapter costs will, progressively, be calculated based on this value (except for the final chapter)."""
+    display_name = "Lowest Possible Chapter Cost"
+    range_start = 0
+    range_end = 10
+    default = 5
+
+
+class HighestChapterCost(Range):
+    """Value determining the highest possible cost for a chapter.
+    Chapter costs will, progressively, be calculated based on this value (except for the final chapter)."""
+    display_name = "Highest Possible Chapter Cost"
+    range_start = 15
+    range_end = 45
+    default = 25
+
+
+class FinalChapterMinCost(Range):
+    """Minimum Time Pieces required to enter the final chapter. This is part of your goal."""
+    display_name = "Final Chapter Minimum Time Piece Cost"
+    range_start = 0
+    range_end = 50
+    default = 30
+
+
+class FinalChapterMaxCost(Range):
+    """Maximum Time Pieces required to enter the final chapter. This is part of your goal."""
+    display_name = "Final Chapter Maximum Time Piece Cost"
+    range_start = 0
+    range_end = 50
+    default = 35
+
+
+class MaxExtraTimePieces(Range):
+    """Maximum number of extra Time Pieces from the DLCs.
+    Arctic Cruise will add up to 6. Nyakuza Metro will add up to 10. The absolute maximum is 56."""
+    display_name = "Max Extra Time Pieces"
+    range_start = 0
+    range_end = 16
+    default = 16
+
+
+class YarnCostMin(Range):
+    """The minimum possible yarn needed to stitch a hat."""
+    display_name = "Minimum Yarn Cost"
+    range_start = 1
+    range_end = 12
+    default = 4
+
+
+class YarnCostMax(Range):
+    """The maximum possible yarn needed to stitch a hat."""
+    display_name = "Maximum Yarn Cost"
+    range_start = 1
+    range_end = 12
+    default = 8
+
+
+class YarnAvailable(Range):
+    """How much yarn is available to collect in the item pool."""
+    display_name = "Yarn Available"
+    range_start = 30
+    range_end = 80
+    default = 50
+
+
+class MinExtraYarn(Range):
+    """The minimum number of extra yarn in the item pool.
+    There must be at least this much more yarn over the total number of yarn needed to craft all hats.
+    For example, if this option's value is 10, and the total yarn needed to craft all hats is 40,
+    there must be at least 50 yarn in the pool."""
+    display_name = "Max Extra Yarn"
+    range_start = 5
+    range_end = 15
+    default = 10
+
+
+class HatItems(Toggle):
+    """Removes all yarn from the pool and turns the hats into individual items instead."""
+    display_name = "Hat Items"
+
+
+class MinPonCost(Range):
+    """The minimum number of Pons that any item in the Badge Seller's shop can cost."""
+    display_name = "Minimum Shop Pon Cost"
+    range_start = 10
+    range_end = 800
+    default = 75
+
+
+class MaxPonCost(Range):
+    """The maximum number of Pons that any item in the Badge Seller's shop can cost."""
+    display_name = "Maximum Shop Pon Cost"
+    range_start = 10
+    range_end = 800
+    default = 300
+
+
+class BadgeSellerMinItems(Range):
+    """The smallest number of items that the Badge Seller can have for sale."""
+    display_name = "Badge Seller Minimum Items"
+    range_start = 0
+    range_end = 10
+    default = 4
+
+
+class BadgeSellerMaxItems(Range):
+    """The largest number of items that the Badge Seller can have for sale."""
+    display_name = "Badge Seller Maximum Items"
+    range_start = 0
+    range_end = 10
+    default = 8
+
+
+class EnableDLC1(Toggle):
+    """Shuffle content from The Arctic Cruise (Chapter 6) into the game. This also includes the Tour time rift.
+    DO NOT ENABLE THIS OPTION IF YOU DO NOT HAVE SEAL THE DEAL DLC INSTALLED!!!"""
+    display_name = "Shuffle Chapter 6"
+
+
+class Tasksanity(Toggle):
+    """If enabled, Ship Shape tasks will become checks. Requires DLC1 content to be enabled."""
+    display_name = "Tasksanity"
+
+
+class TasksanityTaskStep(Range):
+    """How many tasks the player must complete in Tasksanity to send a check."""
+    display_name = "Tasksanity Task Step"
+    range_start = 1
+    range_end = 3
+    default = 1
+
+
+class TasksanityCheckCount(Range):
+    """How many Tasksanity checks there will be in total."""
+    display_name = "Tasksanity Check Count"
+    range_start = 1
+    range_end = 30
+    default = 18
+
+
+class ExcludeTour(Toggle):
+    """Removes the Tour time rift from the game. This option is recommended if you don't want to deal with
+    important levels being shuffled onto the Tour time rift, or important items being shuffled onto Tour pages
+    when your goal is Time's End."""
+    display_name = "Exclude Tour Time Rift"
+
+
+class ShipShapeCustomTaskGoal(Range):
+    """Change the number of tasks required to complete Ship Shape. If this option's value is 0, the number of tasks
+    required will be TasksanityTaskStep x TasksanityCheckCount, if Tasksanity is enabled. If Tasksanity is disabled,
+    it will use the game's default of 18.
+    This option will not affect Cruisin' for a Bruisin'."""
+    display_name = "Ship Shape Custom Task Goal"
+    range_start = 0
+    range_end = 90
+    default = 0
+
+
+class EnableDLC2(Toggle):
+    """Shuffle content from Nyakuza Metro (Chapter 7) into the game.
+    DO NOT ENABLE THIS OPTION IF YOU DO NOT HAVE NYAKUZA METRO DLC INSTALLED!!!"""
+    display_name = "Shuffle Chapter 7"
+
+
+class MetroMinPonCost(Range):
+    """The cheapest an item can be in any Nyakuza Metro shop. Includes ticket booths."""
+    display_name = "Metro Shops Minimum Pon Cost"
+    range_start = 10
+    range_end = 800
+    default = 50
+
+
+class MetroMaxPonCost(Range):
+    """The most expensive an item can be in any Nyakuza Metro shop. Includes ticket booths."""
+    display_name = "Metro Shops Maximum Pon Cost"
+    range_start = 10
+    range_end = 800
+    default = 200
+
+
+class NyakuzaThugMinShopItems(Range):
+    """The smallest number of items that the thugs in Nyakuza Metro can have for sale."""
+    display_name = "Nyakuza Thug Minimum Shop Items"
+    range_start = 0
+    range_end = 5
+    default = 2
+
+
+class NyakuzaThugMaxShopItems(Range):
+    """The largest number of items that the thugs in Nyakuza Metro can have for sale."""
+    display_name = "Nyakuza Thug Maximum Shop Items"
+    range_start = 0
+    range_end = 5
+    default = 4
+
+
+class NoTicketSkips(Choice):
+    """Prevent metro gate skips from being in logic on higher difficulties.
+    Rush Hour option will only consider the ticket skips for Rush Hour in logic."""
+    display_name = "No Ticket Skips"
+    option_false = 0
+    option_true = 1
+    option_rush_hour = 2
+
+
+class BaseballBat(Toggle):
+    """Replace the Umbrella with the baseball bat from Nyakuza Metro.
+    DLC2 content does not have to be shuffled for this option but Nyakuza Metro still needs to be installed."""
+    display_name = "Baseball Bat"
+
+
+class EnableDeathWish(Toggle):
+    """Shuffle Death Wish contracts into the game. Each contract by default will have 1 check granted upon completion.
+    DO NOT ENABLE THIS OPTION IF YOU DO NOT HAVE SEAL THE DEAL DLC INSTALLED!!!"""
+    display_name = "Enable Death Wish"
+
+
+class DeathWishOnly(Toggle):
+    """An alternative gameplay mode that allows you to exclusively play Death Wish in a seed.
+    This has the following effects:
+    - Death Wish is instantly unlocked from the start
+    - All hats and other progression items are instantly given to you
+    - Useful items such as Fast Hatter Badge will still be in the item pool instead of in your inventory at the start
+    - All chapters and their levels are unlocked, act shuffle is forced off
+    - Any checks other than Death Wish contracts are completely removed
+    - All Pons in the item pool are replaced with Health Pons or random cosmetics
+    - The EndGoal option is forced to complete Seal the Deal"""
+    display_name = "Death Wish Only"
+
+
+class DWShuffle(Toggle):
+    """An alternative mode for Death Wish where each contract is unlocked one by one, in a random order.
+    Stamp requirements to unlock contracts is removed. Any excluded contracts will not be shuffled into the sequence.
+    If Seal the Deal is the end goal, it will always be the last Death Wish in the sequence.
+    Disabling candles is highly recommended."""
+    display_name = "Death Wish Shuffle"
+
+
+class DWShuffleCountMin(Range):
+    """The minimum number of Death Wishes that can be in the Death Wish shuffle sequence.
+    The final result is clamped at the number of non-excluded Death Wishes."""
+    display_name = "Death Wish Shuffle Minimum Count"
+    range_start = 5
+    range_end = 38
+    default = 18
+
+
+class DWShuffleCountMax(Range):
+    """The maximum number of Death Wishes that can be in the Death Wish shuffle sequence.
+    The final result is clamped at the number of non-excluded Death Wishes."""
+    display_name = "Death Wish Shuffle Maximum Count"
+    range_start = 5
+    range_end = 38
+    default = 25
+
+
+class DWEnableBonus(Toggle):
+    """In Death Wish, add a location for completing all of a DW contract's bonuses,
+    in addition to the location for completing the DW contract normally.
+    WARNING!! Only for the brave! This option can create VERY DIFFICULT SEEDS!
+    ONLY turn this on if you know what you are doing to yourself and everyone else in the multiworld!
+    Using Peace and Tranquility to auto-complete the bonuses will NOT count!"""
+    display_name = "Shuffle Death Wish Full Completions"
+
+
+class DWAutoCompleteBonuses(DefaultOnToggle):
+    """If enabled, auto complete all bonus stamps after completing the main objective in a Death Wish.
+    This option will have no effect if bonus checks (DWEnableBonus) are turned on."""
+    display_name = "Auto Complete Bonus Stamps"
+
+
+class DWExcludeAnnoyingContracts(DefaultOnToggle):
+    """Exclude Death Wish contracts from the pool that are particularly tedious or take a long time to reach/clear.
+    Excluded Death Wishes are automatically completed as soon as they are unlocked.
+    This option currently excludes the following contracts:
+    - Vault Codes in the Wind
+    - Boss Rush
+    - Camera Tourist
+    - The Mustache Gauntlet
+    - Rift Collapse: Deep Sea
+    - Cruisin' for a Bruisin'
+    - Seal the Deal (non-excluded if goal, but the checks are still excluded)"""
+    display_name = "Exclude Annoying Death Wish Contracts"
+
+
+class DWExcludeAnnoyingBonuses(DefaultOnToggle):
+    """If Death Wish full completions are shuffled in, exclude tedious Death Wish full completions from the pool.
+    Excluded bonus Death Wishes automatically reward their bonus stamps upon completion of the main objective.
+    This option currently excludes the following bonuses:
+    - So You're Back From Outer Space
+    - Encore! Encore!
+    - Snatcher's Hit List
+    - 10 Seconds until Self-Destruct
+    - Killing Two Birds
+    - Zero Jumps
+    - Bird Sanctuary
+    - Wound-Up Windmill
+    - Vault Codes in the Wind
+    - Boss Rush
+    - Camera Tourist
+    - The Mustache Gauntlet
+    - Rift Collapse: Deep Sea
+    - Cruisin' for a Bruisin'
+    - Seal the Deal"""
+    display_name = "Exclude Annoying Death Wish Full Completions"
+
+
+class DWExcludeCandles(DefaultOnToggle):
+    """If enabled, exclude all candle Death Wishes."""
+    display_name = "Exclude Candle Death Wishes"
+
+
+class DWTimePieceRequirement(Range):
+    """How many Time Pieces that will be required to unlock Death Wish."""
+    display_name = "Death Wish Time Piece Requirement"
+    range_start = 0
+    range_end = 35
+    default = 15
+
+
+class TrapChance(Range):
+    """The chance for any junk item in the pool to be replaced by a trap."""
+    display_name = "Trap Chance"
+    range_start = 0
+    range_end = 100
+    default = 0
+
+
+class BabyTrapWeight(Range):
+    """The weight of Baby Traps in the trap pool.
+    Baby Traps place a multitude of the Conductor's grandkids into Hat Kid's hands, causing her to lose her balance."""
+    display_name = "Baby Trap Weight"
+    range_start = 0
+    range_end = 100
+    default = 40
+
+
+class LaserTrapWeight(Range):
+    """The weight of Laser Traps in the trap pool.
+    Laser Traps will spawn multiple giant lasers (from Snatcher's boss fight) at Hat Kid's location."""
+    display_name = "Laser Trap Weight"
+    range_start = 0
+    range_end = 100
+    default = 40
+
+
+class ParadeTrapWeight(Range):
+    """The weight of Parade Traps in the trap pool.
+    Parade Traps will summon multiple Express Band owls with knives that chase Hat Kid by mimicking her movement."""
+    display_name = "Parade Trap Weight"
+    range_start = 0
+    range_end = 100
+    default = 20
+
+
+@dataclass
+class AHITOptions(PerGameCommonOptions):
+    EndGoal:                  EndGoal
+    ActRandomizer:            ActRandomizer
+    ActPlando:                ActPlando
+    ActBlacklist:             ActBlacklist
+    ShuffleAlpineZiplines:    ShuffleAlpineZiplines
+    FinaleShuffle:            FinaleShuffle
+    LogicDifficulty:          LogicDifficulty
+    YarnBalancePercent:       YarnBalancePercent
+    TimePieceBalancePercent:  TimePieceBalancePercent
+    RandomizeHatOrder:        RandomizeHatOrder
+    UmbrellaLogic:            UmbrellaLogic
+    StartWithCompassBadge:    StartWithCompassBadge
+    CompassBadgeMode:         CompassBadgeMode
+    ShuffleStorybookPages:    ShuffleStorybookPages
+    ShuffleActContracts:      ShuffleActContracts
+    ShuffleSubconPaintings:   ShuffleSubconPaintings
+    NoPaintingSkips:          NoPaintingSkips
+    StartingChapter:          StartingChapter
+    CTRLogic:                 CTRLogic
+
+    EnableDLC1:               EnableDLC1
+    Tasksanity:               Tasksanity
+    TasksanityTaskStep:       TasksanityTaskStep
+    TasksanityCheckCount:     TasksanityCheckCount
+    ExcludeTour:              ExcludeTour
+    ShipShapeCustomTaskGoal:  ShipShapeCustomTaskGoal
+
+    EnableDeathWish:              EnableDeathWish
+    DWShuffle:                    DWShuffle
+    DWShuffleCountMin:            DWShuffleCountMin
+    DWShuffleCountMax:            DWShuffleCountMax
+    DeathWishOnly:                DeathWishOnly
+    DWEnableBonus:                DWEnableBonus
+    DWAutoCompleteBonuses:        DWAutoCompleteBonuses
+    DWExcludeAnnoyingContracts:   DWExcludeAnnoyingContracts
+    DWExcludeAnnoyingBonuses:     DWExcludeAnnoyingBonuses
+    DWExcludeCandles:             DWExcludeCandles
+    DWTimePieceRequirement:       DWTimePieceRequirement
+
+    EnableDLC2:               EnableDLC2
+    BaseballBat:              BaseballBat
+    MetroMinPonCost:          MetroMinPonCost
+    MetroMaxPonCost:          MetroMaxPonCost
+    NyakuzaThugMinShopItems:  NyakuzaThugMinShopItems
+    NyakuzaThugMaxShopItems:  NyakuzaThugMaxShopItems
+    NoTicketSkips:            NoTicketSkips
+
+    LowestChapterCost:        LowestChapterCost
+    HighestChapterCost:       HighestChapterCost
+    ChapterCostIncrement:     ChapterCostIncrement
+    ChapterCostMinDifference: ChapterCostMinDifference
+    MaxExtraTimePieces:       MaxExtraTimePieces
+
+    FinalChapterMinCost:          FinalChapterMinCost
+    FinalChapterMaxCost:          FinalChapterMaxCost
+
+    YarnCostMin:              YarnCostMin
+    YarnCostMax:              YarnCostMax
+    YarnAvailable:            YarnAvailable
+    MinExtraYarn:             MinExtraYarn
+    HatItems:                 HatItems
+
+    MinPonCost:               MinPonCost
+    MaxPonCost:               MaxPonCost
+    BadgeSellerMinItems:      BadgeSellerMinItems
+    BadgeSellerMaxItems:      BadgeSellerMaxItems
+
+    TrapChance:               TrapChance
+    BabyTrapWeight:           BabyTrapWeight
+    LaserTrapWeight:          LaserTrapWeight
+    ParadeTrapWeight:         ParadeTrapWeight
+
+    death_link:               DeathLink
+
+
+ahit_option_groups: Dict[str, List[Any]] = {
+    "General Options": [EndGoal, ShuffleStorybookPages, ShuffleAlpineZiplines, ShuffleSubconPaintings,
+                        ShuffleActContracts, MinPonCost, MaxPonCost, BadgeSellerMinItems, BadgeSellerMaxItems,
+                        LogicDifficulty, NoPaintingSkips, CTRLogic],
+
+    "Act Options": [ActRandomizer, StartingChapter, LowestChapterCost, HighestChapterCost,
+                    ChapterCostIncrement, ChapterCostMinDifference, FinalChapterMinCost, FinalChapterMaxCost,
+                    FinaleShuffle, ActPlando, ActBlacklist],
+
+    "Item Options": [StartWithCompassBadge, CompassBadgeMode, RandomizeHatOrder, YarnAvailable, YarnCostMin,
+                     YarnCostMax, MinExtraYarn, HatItems, UmbrellaLogic, MaxExtraTimePieces, YarnBalancePercent,
+                     TimePieceBalancePercent],
+
+    "Arctic Cruise Options": [EnableDLC1, Tasksanity, TasksanityTaskStep, TasksanityCheckCount,
+                              ShipShapeCustomTaskGoal, ExcludeTour],
+
+    "Nyakuza Metro Options": [EnableDLC2, MetroMinPonCost, MetroMaxPonCost, NyakuzaThugMinShopItems,
+                              NyakuzaThugMaxShopItems, BaseballBat, NoTicketSkips],
+
+    "Death Wish Options": [EnableDeathWish, DWTimePieceRequirement, DWShuffle, DWShuffleCountMin, DWShuffleCountMax,
+                           DWEnableBonus, DWAutoCompleteBonuses, DWExcludeAnnoyingContracts, DWExcludeAnnoyingBonuses,
+                           DWExcludeCandles, DeathWishOnly],
+
+    "Trap Options": [TrapChance, BabyTrapWeight, LaserTrapWeight, ParadeTrapWeight]
+}
+
+
+slot_data_options: List[str] = [
+    "EndGoal",
+    "ActRandomizer",
+    "ShuffleAlpineZiplines",
+    "LogicDifficulty",
+    "CTRLogic",
+    "RandomizeHatOrder",
+    "UmbrellaLogic",
+    "StartWithCompassBadge",
+    "CompassBadgeMode",
+    "ShuffleStorybookPages",
+    "ShuffleActContracts",
+    "ShuffleSubconPaintings",
+    "NoPaintingSkips",
+    "HatItems",
+
+    "EnableDLC1",
+    "Tasksanity",
+    "TasksanityTaskStep",
+    "TasksanityCheckCount",
+    "ShipShapeCustomTaskGoal",
+    "ExcludeTour",
+
+    "EnableDeathWish",
+    "DWShuffle",
+    "DeathWishOnly",
+    "DWEnableBonus",
+    "DWAutoCompleteBonuses",
+    "DWTimePieceRequirement",
+
+    "EnableDLC2",
+    "MetroMinPonCost",
+    "MetroMaxPonCost",
+    "BaseballBat",
+    "NoTicketSkips",
+
+    "MinPonCost",
+    "MaxPonCost",
+
+    "death_link",
+]

worlds/ahit/Rules.py

@@ -0,0 +1,959 @@
+from worlds.AutoWorld import CollectionState
+from worlds.generic.Rules import add_rule, set_rule
+from .Locations import location_table, zipline_unlocks, is_location_valid, contract_locations, \
+    shop_locations, event_locs
+from .Types import HatType, ChapterIndex, hat_type_to_item, Difficulty, HitType
+from BaseClasses import Location, Entrance, Region
+from typing import TYPE_CHECKING, List, Callable, Union, Dict
+from .Options import EndGoal, CTRLogic, NoTicketSkips
+
+if TYPE_CHECKING:
+    from . import HatInTimeWorld
+    
+
+act_connections = {
+    "Mafia Town - Act 2": ["Mafia Town - Act 1"],
+    "Mafia Town - Act 3": ["Mafia Town - Act 1"],
+    "Mafia Town - Act 4": ["Mafia Town - Act 2", "Mafia Town - Act 3"],
+    "Mafia Town - Act 6": ["Mafia Town - Act 4"],
+    "Mafia Town - Act 7": ["Mafia Town - Act 4"],
+    "Mafia Town - Act 5": ["Mafia Town - Act 6", "Mafia Town - Act 7"],
+
+    "Battle of the Birds - Act 2": ["Battle of the Birds - Act 1"],
+    "Battle of the Birds - Act 3": ["Battle of the Birds - Act 1"],
+    "Battle of the Birds - Act 4": ["Battle of the Birds - Act 2", "Battle of the Birds - Act 3"],
+    "Battle of the Birds - Act 5": ["Battle of the Birds - Act 2", "Battle of the Birds - Act 3"],
+    "Battle of the Birds - Finale A": ["Battle of the Birds - Act 4", "Battle of the Birds - Act 5"],
+    "Battle of the Birds - Finale B": ["Battle of the Birds - Finale A"],
+
+    "Subcon Forest - Finale": ["Subcon Forest - Act 1", "Subcon Forest - Act 2",
+                               "Subcon Forest - Act 3", "Subcon Forest - Act 4",
+                               "Subcon Forest - Act 5"],
+
+    "The Arctic Cruise - Act 2":  ["The Arctic Cruise - Act 1"],
+    "The Arctic Cruise - Finale": ["The Arctic Cruise - Act 2"],
+}
+
+
+def can_use_hat(state: CollectionState, world: "HatInTimeWorld", hat: HatType) -> bool:
+    if world.options.HatItems:
+        return state.has(hat_type_to_item[hat], world.player)
+
+    if world.hat_yarn_costs[hat] <= 0:  # this means the hat was put into starting inventory
+        return True
+
+    return state.has("Yarn", world.player, get_hat_cost(world, hat))
+
+
+def get_hat_cost(world: "HatInTimeWorld", hat: HatType) -> int:
+    cost = 0
+    for h in world.hat_craft_order:
+        cost += world.hat_yarn_costs[h]
+        if h == hat:
+            break
+
+    return cost
+
+
+def painting_logic(world: "HatInTimeWorld") -> bool:
+    return bool(world.options.ShuffleSubconPaintings)
+
+
+# -1 = Normal, 0 = Moderate, 1 = Hard, 2 = Expert
+def get_difficulty(world: "HatInTimeWorld") -> Difficulty:
+    return Difficulty(world.options.LogicDifficulty)
+
+
+def has_paintings(state: CollectionState, world: "HatInTimeWorld", count: int, allow_skip: bool = True) -> bool:
+    if not painting_logic(world):
+        return True
+
+    if not world.options.NoPaintingSkips and allow_skip:
+        # In Moderate there is a very easy trick to skip all the walls, except for the one guarding the boss arena
+        if get_difficulty(world) >= Difficulty.MODERATE:
+            return True
+
+    return state.has("Progressive Painting Unlock", world.player, count)
+
+
+def zipline_logic(world: "HatInTimeWorld") -> bool:
+    return bool(world.options.ShuffleAlpineZiplines)
+
+
+def can_use_hookshot(state: CollectionState, world: "HatInTimeWorld"):
+    return state.has("Hookshot Badge", world.player)
+
+
+def can_hit(state: CollectionState, world: "HatInTimeWorld", umbrella_only: bool = False):
+    if not world.options.UmbrellaLogic:
+        return True
+
+    return state.has("Umbrella", world.player) or not umbrella_only and can_use_hat(state, world, HatType.BREWING)
+
+
+def has_relic_combo(state: CollectionState, world: "HatInTimeWorld", relic: str) -> bool:
+    return state.has_group(relic, world.player, len(world.item_name_groups[relic]))
+
+
+def get_relic_count(state: CollectionState, world: "HatInTimeWorld", relic: str) -> int:
+    return state.count_group(relic, world.player)
+
+
+# This is used to determine if the player can clear an act that's required to unlock a Time Rift
+def can_clear_required_act(state: CollectionState, world: "HatInTimeWorld", act_entrance: str) -> bool:
+    entrance: Entrance = world.multiworld.get_entrance(act_entrance, world.player)
+    if not state.can_reach(entrance.connected_region, "Region", world.player):
+        return False
+
+    if "Free Roam" in entrance.connected_region.name:
+        return True
+
+    name: str = f"Act Completion ({entrance.connected_region.name})"
+    return world.multiworld.get_location(name, world.player).access_rule(state)
+
+
+def can_clear_alpine(state: CollectionState, world: "HatInTimeWorld") -> bool:
+    return state.has("Birdhouse Cleared", world.player) and state.has("Lava Cake Cleared", world.player) \
+            and state.has("Windmill Cleared", world.player) and state.has("Twilight Bell Cleared", world.player)
+
+
+def can_clear_metro(state: CollectionState, world: "HatInTimeWorld") -> bool:
+    return state.has("Nyakuza Intro Cleared", world.player) \
+           and state.has("Yellow Overpass Station Cleared", world.player) \
+           and state.has("Yellow Overpass Manhole Cleared", world.player) \
+           and state.has("Green Clean Station Cleared", world.player) \
+           and state.has("Green Clean Manhole Cleared", world.player) \
+           and state.has("Bluefin Tunnel Cleared", world.player) \
+           and state.has("Pink Paw Station Cleared", world.player) \
+           and state.has("Pink Paw Manhole Cleared", world.player)
+
+
+def set_rules(world: "HatInTimeWorld"):
+    # First, chapter access
+    starting_chapter = ChapterIndex(world.options.StartingChapter)
+    world.chapter_timepiece_costs[starting_chapter] = 0
+
+    # Chapter costs increase progressively. Randomly decide the chapter order, except for Finale
+    chapter_list: List[ChapterIndex] = [ChapterIndex.MAFIA, ChapterIndex.BIRDS,
+                                        ChapterIndex.SUBCON, ChapterIndex.ALPINE]
+
+    final_chapter = ChapterIndex.FINALE
+    if world.options.EndGoal == EndGoal.option_rush_hour:
+        final_chapter = ChapterIndex.METRO
+        chapter_list.append(ChapterIndex.FINALE)
+    elif world.options.EndGoal == EndGoal.option_seal_the_deal:
+        final_chapter = None
+        chapter_list.append(ChapterIndex.FINALE)
+
+    if world.is_dlc1():
+        chapter_list.append(ChapterIndex.CRUISE)
+
+    if world.is_dlc2() and final_chapter is not ChapterIndex.METRO:
+        chapter_list.append(ChapterIndex.METRO)
+
+    chapter_list.remove(starting_chapter)
+    world.random.shuffle(chapter_list)
+
+    # Make sure Alpine is unlocked before any DLC chapters are, as the Alpine door needs to be open to access them
+    if starting_chapter is not ChapterIndex.ALPINE and (world.is_dlc1() or world.is_dlc2()):
+        index1 = 69
+        index2 = 69
+        pos: int
+        lowest_index: int
+        chapter_list.remove(ChapterIndex.ALPINE)
+
+        if world.is_dlc1():
+            index1 = chapter_list.index(ChapterIndex.CRUISE)
+
+        if world.is_dlc2() and final_chapter is not ChapterIndex.METRO:
+            index2 = chapter_list.index(ChapterIndex.METRO)
+
+        lowest_index = min(index1, index2)
+        if lowest_index == 0:
+            pos = 0
+        else:
+            pos = world.random.randint(0, lowest_index)
+
+        chapter_list.insert(pos, ChapterIndex.ALPINE)
+
+    lowest_cost: int = world.options.LowestChapterCost.value
+    highest_cost: int = world.options.HighestChapterCost.value
+    cost_increment: int = world.options.ChapterCostIncrement.value
+    min_difference: int = world.options.ChapterCostMinDifference.value
+    last_cost = 0
+
+    for i, chapter in enumerate(chapter_list):
+        min_range: int = lowest_cost + (cost_increment * i)
+        if min_range >= highest_cost:
+            min_range = highest_cost-1
+
+        value: int = world.random.randint(min_range, min(highest_cost, max(lowest_cost, last_cost + cost_increment)))
+        cost = world.random.randint(value, min(value + cost_increment, highest_cost))
+        if i >= 1:
+            if last_cost + min_difference > cost:
+                cost = last_cost + min_difference
+
+        cost = min(cost, highest_cost)
+        world.chapter_timepiece_costs[chapter] = cost
+        last_cost = cost
+
+    if final_chapter is not None:
+        final_chapter_cost: int
+        if world.options.FinalChapterMinCost == world.options.FinalChapterMaxCost:
+            final_chapter_cost = world.options.FinalChapterMaxCost.value
+        else:
+            final_chapter_cost = world.random.randint(world.options.FinalChapterMinCost.value,
+                                                      world.options.FinalChapterMaxCost.value)
+
+        world.chapter_timepiece_costs[final_chapter] = final_chapter_cost
+
+    add_rule(world.multiworld.get_entrance("Telescope -> Mafia Town", world.player),
+             lambda state: state.has("Time Piece", world.player, world.chapter_timepiece_costs[ChapterIndex.MAFIA]))
+
+    add_rule(world.multiworld.get_entrance("Telescope -> Battle of the Birds", world.player),
+             lambda state: state.has("Time Piece", world.player, world.chapter_timepiece_costs[ChapterIndex.BIRDS]))
+
+    add_rule(world.multiworld.get_entrance("Telescope -> Subcon Forest", world.player),
+             lambda state: state.has("Time Piece", world.player, world.chapter_timepiece_costs[ChapterIndex.SUBCON]))
+
+    add_rule(world.multiworld.get_entrance("Telescope -> Alpine Skyline", world.player),
+             lambda state: state.has("Time Piece", world.player, world.chapter_timepiece_costs[ChapterIndex.ALPINE]))
+
+    add_rule(world.multiworld.get_entrance("Telescope -> Time's End", world.player),
+             lambda state: state.has("Time Piece", world.player, world.chapter_timepiece_costs[ChapterIndex.FINALE])
+             and can_use_hat(state, world, HatType.BREWING) and can_use_hat(state, world, HatType.DWELLER))
+
+    if world.is_dlc1():
+        add_rule(world.multiworld.get_entrance("Telescope -> Arctic Cruise", world.player),
+                 lambda state: state.has("Time Piece", world.player, world.chapter_timepiece_costs[ChapterIndex.ALPINE])
+                 and state.has("Time Piece", world.player, world.chapter_timepiece_costs[ChapterIndex.CRUISE]))
+
+    if world.is_dlc2():
+        add_rule(world.multiworld.get_entrance("Telescope -> Nyakuza Metro", world.player),
+                 lambda state: state.has("Time Piece", world.player, world.chapter_timepiece_costs[ChapterIndex.ALPINE])
+                 and state.has("Time Piece", world.player, world.chapter_timepiece_costs[ChapterIndex.METRO])
+                 and can_use_hat(state, world, HatType.DWELLER) and can_use_hat(state, world, HatType.ICE))
+
+    if not world.options.ActRandomizer:
+        set_default_rift_rules(world)
+
+    table = {**location_table, **event_locs}
+    for (key, data) in table.items():
+        if not is_location_valid(world, key):
+            continue
+
+        if key in contract_locations.keys():
+            continue
+
+        loc = world.multiworld.get_location(key, world.player)
+
+        for hat in data.required_hats:
+            add_rule(loc, lambda state, h=hat: can_use_hat(state, world, h))
+
+        if data.hookshot:
+            add_rule(loc, lambda state: can_use_hookshot(state, world))
+
+        if data.paintings > 0 and world.options.ShuffleSubconPaintings:
+            add_rule(loc, lambda state, paintings=data.paintings: has_paintings(state, world, paintings))
+
+        if data.hit_type is not HitType.none and world.options.UmbrellaLogic:
+            if data.hit_type == HitType.umbrella:
+                add_rule(loc, lambda state: state.has("Umbrella", world.player))
+
+            elif data.hit_type == HitType.umbrella_or_brewing:
+                add_rule(loc, lambda state: state.has("Umbrella", world.player)
+                         or can_use_hat(state, world, HatType.BREWING))
+
+            elif data.hit_type == HitType.dweller_bell:
+                add_rule(loc, lambda state: state.has("Umbrella", world.player)
+                         or can_use_hat(state, world, HatType.BREWING)
+                         or can_use_hat(state, world, HatType.DWELLER))
+
+        for misc in data.misc_required:
+            add_rule(loc, lambda state, item=misc: state.has(item, world.player))
+
+    set_specific_rules(world)
+
+    # Putting all of this here, so it doesn't get overridden by anything
+    # Illness starts the player past the intro
+    alpine_entrance = world.multiworld.get_entrance("AFR -> Alpine Skyline Area", world.player)
+    add_rule(alpine_entrance, lambda state: can_use_hookshot(state, world))
+    if world.options.UmbrellaLogic:
+        add_rule(alpine_entrance, lambda state: state.has("Umbrella", world.player))
+
+    if zipline_logic(world):
+        add_rule(world.multiworld.get_entrance("-> The Birdhouse", world.player),
+                 lambda state: state.has("Zipline Unlock - The Birdhouse Path", world.player))
+
+        add_rule(world.multiworld.get_entrance("-> The Lava Cake", world.player),
+                 lambda state: state.has("Zipline Unlock - The Lava Cake Path", world.player))
+
+        add_rule(world.multiworld.get_entrance("-> The Windmill", world.player),
+                 lambda state: state.has("Zipline Unlock - The Windmill Path", world.player))
+
+        add_rule(world.multiworld.get_entrance("-> The Twilight Bell", world.player),
+                 lambda state: state.has("Zipline Unlock - The Twilight Bell Path", world.player))
+
+        add_rule(world.multiworld.get_location("Act Completion (The Illness has Spread)", world.player),
+                 lambda state: state.has("Zipline Unlock - The Birdhouse Path", world.player)
+                 and state.has("Zipline Unlock - The Lava Cake Path", world.player)
+                 and state.has("Zipline Unlock - The Windmill Path", world.player))
+
+    if zipline_logic(world):
+        for (loc, zipline) in zipline_unlocks.items():
+            add_rule(world.multiworld.get_location(loc, world.player),
+                     lambda state, z=zipline: state.has(z, world.player))
+
+    dummy_entrances: List[Entrance] = []
+      
+    for (key, acts) in act_connections.items():
+        if "Arctic Cruise" in key and not world.is_dlc1():
+            continue
+
+        entrance: Entrance = world.multiworld.get_entrance(key, world.player)
+        region: Region = entrance.connected_region
+        access_rules: List[Callable[[CollectionState], bool]] = []
+        dummy_entrances.append(entrance)
+
+        # Entrances to this act that we have to set access_rules on
+        entrances: List[Entrance] = []
+
+        for i, act in enumerate(acts, start=1):
+            act_entrance: Entrance = world.multiworld.get_entrance(act, world.player)
+            access_rules.append(act_entrance.access_rule)
+            required_region = act_entrance.connected_region
+            name: str = f"{key}: Connection {i}"
+            new_entrance: Entrance = required_region.connect(region, name)
+            entrances.append(new_entrance)
+
+            # Copy access rules from act completions
+            if "Free Roam" not in required_region.name:
+                rule: Callable[[CollectionState], bool]
+                name = f"Act Completion ({required_region.name})"
+                rule = world.multiworld.get_location(name, world.player).access_rule
+                access_rules.append(rule)
+
+        for e in entrances:
+            for rules in access_rules:
+                add_rule(e, rules)
+
+    for e in dummy_entrances:
+        set_rule(e, lambda state: False)
+
+    set_event_rules(world)
+
+    if world.options.EndGoal == EndGoal.option_finale:
+        world.multiworld.completion_condition[world.player] = lambda state: state.has("Time Piece Cluster", world.player)
+    elif world.options.EndGoal == EndGoal.option_rush_hour:
+        world.multiworld.completion_condition[world.player] = lambda state: state.has("Rush Hour Cleared", world.player)
+
+
+def set_specific_rules(world: "HatInTimeWorld"):
+    add_rule(world.multiworld.get_location("Mafia Boss Shop Item", world.player),
+             lambda state: state.has("Time Piece", world.player, 12)
+             and state.has("Time Piece", world.player, world.chapter_timepiece_costs[ChapterIndex.BIRDS]))
+
+    set_mafia_town_rules(world)
+    set_botb_rules(world)
+    set_subcon_rules(world)
+    set_alps_rules(world)
+
+    if world.is_dlc1():
+        set_dlc1_rules(world)
+
+    if world.is_dlc2():
+        set_dlc2_rules(world)
+
+    difficulty: Difficulty = get_difficulty(world)
+
+    if difficulty >= Difficulty.MODERATE:
+        set_moderate_rules(world)
+
+    if difficulty >= Difficulty.HARD:
+        set_hard_rules(world)
+
+    if difficulty >= Difficulty.EXPERT:
+        set_expert_rules(world)
+
+
+def set_moderate_rules(world: "HatInTimeWorld"):
+    # Moderate: Gallery without Brewing Hat
+    set_rule(world.multiworld.get_location("Act Completion (Time Rift - Gallery)", world.player), lambda state: True)
+
+    # Moderate: Above Boats via Ice Hat Sliding
+    add_rule(world.multiworld.get_location("Mafia Town - Above Boats", world.player),
+             lambda state: can_use_hat(state, world, HatType.ICE), "or")
+
+    # Moderate: Clock Tower Chest + Ruined Tower with nothing
+    add_rule(world.multiworld.get_location("Mafia Town - Clock Tower Chest", world.player), lambda state: True)
+    add_rule(world.multiworld.get_location("Mafia Town - Top of Ruined Tower", world.player), lambda state: True)
+
+    # Moderate: enter and clear The Subcon Well without Hookshot and without hitting the bell
+    for loc in world.multiworld.get_region("The Subcon Well", world.player).locations:
+        set_rule(loc, lambda state: has_paintings(state, world, 1))
+
+    # Moderate: Vanessa Manor with nothing
+    for loc in world.multiworld.get_region("Queen Vanessa's Manor", world.player).locations:
+        set_rule(loc, lambda state: has_paintings(state, world, 1))
+
+    set_rule(world.multiworld.get_location("Subcon Forest - Manor Rooftop", world.player),
+             lambda state: has_paintings(state, world, 1))
+
+    # Moderate: Village Time Rift with nothing IF umbrella logic is off
+    if not world.options.UmbrellaLogic:
+        set_rule(world.multiworld.get_location("Act Completion (Time Rift - Village)", world.player), lambda state: True)
+
+    # Moderate: get to Birdhouse/Yellow Band Hills without Brewing Hat
+    set_rule(world.multiworld.get_entrance("-> The Birdhouse", world.player),
+             lambda state: can_use_hookshot(state, world))
+    set_rule(world.multiworld.get_location("Alpine Skyline - Yellow Band Hills", world.player),
+             lambda state: can_use_hookshot(state, world))
+
+    # Moderate: The Birdhouse - Dweller Platforms Relic with only Birdhouse access
+    set_rule(world.multiworld.get_location("Alpine Skyline - The Birdhouse: Dweller Platforms Relic", world.player),
+             lambda state: True)
+
+    # Moderate: Twilight Path without Dweller Mask
+    set_rule(world.multiworld.get_location("Alpine Skyline - The Twilight Path", world.player), lambda state: True)
+
+    # Moderate: Mystifying Time Mesa time trial without hats
+    set_rule(world.multiworld.get_location("Alpine Skyline - Mystifying Time Mesa: Zipline", world.player),
+             lambda state: can_use_hookshot(state, world))
+
+    # Moderate: Goat Refinery from TIHS with Sprint only
+    add_rule(world.multiworld.get_location("Alpine Skyline - Goat Refinery", world.player),
+             lambda state: state.has("TIHS Access", world.player)
+             and can_use_hat(state, world, HatType.SPRINT), "or")
+
+    # Moderate: Finale Telescope with only Ice Hat
+    add_rule(world.multiworld.get_entrance("Telescope -> Time's End", world.player),
+             lambda state: state.has("Time Piece", world.player, world.chapter_timepiece_costs[ChapterIndex.FINALE])
+             and can_use_hat(state, world, HatType.ICE), "or")
+
+    # Moderate: Finale without Hookshot
+    set_rule(world.multiworld.get_location("Act Completion (The Finale)", world.player),
+             lambda state: can_use_hat(state, world, HatType.DWELLER))
+
+    if world.is_dlc1():
+        # Moderate: clear Rock the Boat without Ice Hat
+        add_rule(world.multiworld.get_location("Rock the Boat - Post Captain Rescue", world.player), lambda state: True)
+        add_rule(world.multiworld.get_location("Act Completion (Rock the Boat)", world.player), lambda state: True)
+
+        # Moderate: clear Deep Sea without Ice Hat
+        set_rule(world.multiworld.get_location("Act Completion (Time Rift - Deep Sea)", world.player),
+                 lambda state: can_use_hookshot(state, world) and can_use_hat(state, world, HatType.DWELLER))
+
+    # There is a glitched fall damage volume near the Yellow Overpass time piece that warps the player to Pink Paw.
+    # Yellow Overpass time piece can also be reached without Hookshot quite easily.
+    if world.is_dlc2():
+        # No Hookshot
+        set_rule(world.multiworld.get_location("Act Completion (Yellow Overpass Station)", world.player),
+                 lambda state: True)
+
+        # No Dweller, Hookshot, or Time Stop for these
+        set_rule(world.multiworld.get_location("Pink Paw Station - Cat Vacuum", world.player), lambda state: True)
+        set_rule(world.multiworld.get_location("Pink Paw Station - Behind Fan", world.player), lambda state: True)
+        set_rule(world.multiworld.get_location("Pink Paw Station - Pink Ticket Booth", world.player), lambda state: True)
+        set_rule(world.multiworld.get_location("Act Completion (Pink Paw Station)", world.player), lambda state: True)
+        for key in shop_locations.keys():
+            if "Pink Paw Station Thug" in key and is_location_valid(world, key):
+                set_rule(world.multiworld.get_location(key, world.player), lambda state: True)
+
+        # Moderate: clear Rush Hour without Hookshot
+        set_rule(world.multiworld.get_location("Act Completion (Rush Hour)", world.player),
+                 lambda state: state.has("Metro Ticket - Pink", world.player)
+                 and state.has("Metro Ticket - Yellow", world.player)
+                 and state.has("Metro Ticket - Blue", world.player)
+                 and can_use_hat(state, world, HatType.ICE)
+                 and can_use_hat(state, world, HatType.BREWING))
+
+        # Moderate: Bluefin Tunnel + Pink Paw Station without tickets
+        if not world.options.NoTicketSkips:
+            set_rule(world.multiworld.get_entrance("-> Pink Paw Station", world.player), lambda state: True)
+            set_rule(world.multiworld.get_entrance("-> Bluefin Tunnel", world.player), lambda state: True)
+
+
+def set_hard_rules(world: "HatInTimeWorld"):
+    # Hard: clear Time Rift - The Twilight Bell with Sprint+Scooter only
+    add_rule(world.multiworld.get_location("Act Completion (Time Rift - The Twilight Bell)", world.player),
+             lambda state: can_use_hat(state, world, HatType.SPRINT)
+             and state.has("Scooter Badge", world.player), "or")
+
+    # No Dweller Mask required
+    set_rule(world.multiworld.get_location("Subcon Forest - Dweller Floating Rocks", world.player),
+             lambda state: has_paintings(state, world, 3))
+    set_rule(world.multiworld.get_location("Subcon Forest - Dweller Platforming Tree B", world.player),
+             lambda state: has_paintings(state, world, 3))
+
+    # Cherry bridge over boss arena gap (painting still expected)
+    set_rule(world.multiworld.get_location("Subcon Forest - Boss Arena Chest", world.player),
+             lambda state: has_paintings(state, world, 1, False) or state.has("YCHE Access", world.player))
+
+    set_rule(world.multiworld.get_location("Subcon Forest - Noose Treehouse", world.player),
+             lambda state: has_paintings(state, world, 2, True))
+    set_rule(world.multiworld.get_location("Subcon Forest - Long Tree Climb Chest", world.player),
+             lambda state: has_paintings(state, world, 2, True))
+    set_rule(world.multiworld.get_location("Subcon Forest - Tall Tree Hookshot Swing", world.player),
+             lambda state: has_paintings(state, world, 3, True))
+
+    # SDJ
+    add_rule(world.multiworld.get_location("Subcon Forest - Long Tree Climb Chest", world.player),
+             lambda state: can_use_hat(state, world, HatType.SPRINT) and has_paintings(state, world, 2), "or")
+
+    add_rule(world.multiworld.get_location("Act Completion (Time Rift - Curly Tail Trail)", world.player),
+             lambda state: can_use_hat(state, world, HatType.SPRINT), "or")
+
+    # Hard: Goat Refinery from TIHS with nothing
+    add_rule(world.multiworld.get_location("Alpine Skyline - Goat Refinery", world.player),
+             lambda state: state.has("TIHS Access", world.player), "or")
+
+    if world.is_dlc1():
+        # Hard: clear Deep Sea without Dweller Mask
+        set_rule(world.multiworld.get_location("Act Completion (Time Rift - Deep Sea)", world.player),
+                 lambda state: can_use_hookshot(state, world))
+
+    if world.is_dlc2():
+        # Hard: clear Green Clean Manhole without Dweller Mask
+        set_rule(world.multiworld.get_location("Act Completion (Green Clean Manhole)", world.player),
+                 lambda state: can_use_hat(state, world, HatType.ICE))
+
+        # Hard: clear Rush Hour with Brewing Hat only
+        if world.options.NoTicketSkips is not NoTicketSkips.option_true:
+            set_rule(world.multiworld.get_location("Act Completion (Rush Hour)", world.player),
+                     lambda state: can_use_hat(state, world, HatType.BREWING))
+        else:
+            set_rule(world.multiworld.get_location("Act Completion (Rush Hour)", world.player),
+                     lambda state: can_use_hat(state, world, HatType.BREWING)
+                     and state.has("Metro Ticket - Yellow", world.player)
+                     and state.has("Metro Ticket - Blue", world.player)
+                     and state.has("Metro Ticket - Pink", world.player))
+
+
+def set_expert_rules(world: "HatInTimeWorld"):
+    # Finale Telescope with no hats
+    set_rule(world.multiworld.get_entrance("Telescope -> Time's End", world.player),
+             lambda state: state.has("Time Piece", world.player, world.chapter_timepiece_costs[ChapterIndex.FINALE]))
+
+    # Expert: Mafia Town - Above Boats, Top of Lighthouse, and Hot Air Balloon with nothing
+    set_rule(world.multiworld.get_location("Mafia Town - Above Boats", world.player), lambda state: True)
+    set_rule(world.multiworld.get_location("Mafia Town - Top of Lighthouse", world.player), lambda state: True)
+    set_rule(world.multiworld.get_location("Mafia Town - Hot Air Balloon", world.player), lambda state: True)
+
+    # Expert: Clear Dead Bird Studio with nothing
+    for loc in world.multiworld.get_region("Dead Bird Studio - Post Elevator Area", world.player).locations:
+        set_rule(loc, lambda state: True)
+
+    set_rule(world.multiworld.get_location("Act Completion (Dead Bird Studio)", world.player), lambda state: True)
+
+    # Expert: Clear Dead Bird Studio Basement without Hookshot
+    for loc in world.multiworld.get_region("Dead Bird Studio Basement", world.player).locations:
+        set_rule(loc, lambda state: True)
+
+    # Expert: get to and clear Twilight Bell without Dweller Mask.
+    # Dweller Mask OR Sprint Hat OR Brewing Hat OR Time Stop + Umbrella required to complete act.
+    add_rule(world.multiworld.get_entrance("-> The Twilight Bell", world.player),
+             lambda state: can_use_hookshot(state, world), "or")
+
+    add_rule(world.multiworld.get_location("Act Completion (The Twilight Bell)", world.player),
+             lambda state: can_use_hat(state, world, HatType.BREWING)
+             or can_use_hat(state, world, HatType.DWELLER)
+             or can_use_hat(state, world, HatType.SPRINT)
+             or (can_use_hat(state, world, HatType.TIME_STOP) and state.has("Umbrella", world.player)))
+
+    # Expert: Time Rift - Curly Tail Trail with nothing
+    # Time Rift - Twilight Bell and Time Rift - Village with nothing
+    set_rule(world.multiworld.get_location("Act Completion (Time Rift - Curly Tail Trail)", world.player),
+             lambda state: True)
+
+    set_rule(world.multiworld.get_location("Act Completion (Time Rift - Village)", world.player), lambda state: True)
+    set_rule(world.multiworld.get_location("Act Completion (Time Rift - The Twilight Bell)", world.player),
+             lambda state: True)
+
+    # Expert: Cherry Hovering
+    subcon_area = world.multiworld.get_region("Subcon Forest Area", world.player)
+    yche = world.multiworld.get_region("Your Contract has Expired", world.player)
+    entrance = yche.connect(subcon_area, "Subcon Forest Entrance YCHE")
+
+    if world.options.NoPaintingSkips:
+        add_rule(entrance, lambda state: has_paintings(state, world, 1))
+
+    set_rule(world.multiworld.get_location("Act Completion (Toilet of Doom)", world.player),
+             lambda state: can_use_hookshot(state, world) and can_hit(state, world)
+             and has_paintings(state, world, 1, True))
+
+    # Set painting rules only. Skipping paintings is determined in has_paintings
+    set_rule(world.multiworld.get_location("Subcon Forest - Boss Arena Chest", world.player),
+             lambda state: has_paintings(state, world, 1, True))
+    set_rule(world.multiworld.get_location("Subcon Forest - Magnet Badge Bush", world.player),
+             lambda state: has_paintings(state, world, 3, True))
+
+    # You can cherry hover to Snatcher's post-fight cutscene, which completes the level without having to fight him
+    subcon_area.connect(yche, "Snatcher Hover")
+    set_rule(world.multiworld.get_location("Act Completion (Your Contract has Expired)", world.player),
+             lambda state: True)
+
+    if world.is_dlc2():
+        # Expert: clear Rush Hour with nothing
+        if not world.options.NoTicketSkips:
+            set_rule(world.multiworld.get_location("Act Completion (Rush Hour)", world.player), lambda state: True)
+        else:
+            set_rule(world.multiworld.get_location("Act Completion (Rush Hour)", world.player),
+                     lambda state: state.has("Metro Ticket - Yellow", world.player)
+                     and state.has("Metro Ticket - Blue", world.player)
+                     and state.has("Metro Ticket - Pink", world.player))
+
+        # Expert: Yellow/Green Manhole with nothing using a Boop Clip
+        set_rule(world.multiworld.get_location("Act Completion (Yellow Overpass Manhole)", world.player),
+                 lambda state: True)
+        set_rule(world.multiworld.get_location("Act Completion (Green Clean Manhole)", world.player),
+                 lambda state: True)
+
+
+def set_mafia_town_rules(world: "HatInTimeWorld"):
+    add_rule(world.multiworld.get_location("Mafia Town - Behind HQ Chest", world.player),
+             lambda state: state.can_reach("Act Completion (Heating Up Mafia Town)", "Location", world.player)
+             or state.can_reach("Down with the Mafia!", "Region", world.player)
+             or state.can_reach("Cheating the Race", "Region", world.player)
+             or state.can_reach("The Golden Vault", "Region", world.player))
+
+    # Old guys don't appear in SCFOS
+    add_rule(world.multiworld.get_location("Mafia Town - Old Man (Steel Beams)", world.player),
+             lambda state: state.can_reach("Welcome to Mafia Town", "Region", world.player)
+             or state.can_reach("Barrel Battle", "Region", world.player)
+             or state.can_reach("Cheating the Race", "Region", world.player)
+             or state.can_reach("The Golden Vault", "Region", world.player)
+             or state.can_reach("Down with the Mafia!", "Region", world.player))
+
+    add_rule(world.multiworld.get_location("Mafia Town - Old Man (Seaside Spaghetti)", world.player),
+             lambda state: state.can_reach("Welcome to Mafia Town", "Region", world.player)
+             or state.can_reach("Barrel Battle", "Region", world.player)
+             or state.can_reach("Cheating the Race", "Region", world.player)
+             or state.can_reach("The Golden Vault", "Region", world.player)
+             or state.can_reach("Down with the Mafia!", "Region", world.player))
+
+    # Only available outside She Came from Outer Space
+    add_rule(world.multiworld.get_location("Mafia Town - Mafia Geek Platform", world.player),
+             lambda state: state.can_reach("Welcome to Mafia Town", "Region", world.player)
+             or state.can_reach("Barrel Battle", "Region", world.player)
+             or state.can_reach("Down with the Mafia!", "Region", world.player)
+             or state.can_reach("Cheating the Race", "Region", world.player)
+             or state.can_reach("Heating Up Mafia Town", "Region", world.player)
+             or state.can_reach("The Golden Vault", "Region", world.player))
+
+    # Only available outside Down with the Mafia! (for some reason)
+    add_rule(world.multiworld.get_location("Mafia Town - On Scaffolding", world.player),
+             lambda state: state.can_reach("Welcome to Mafia Town", "Region", world.player)
+             or state.can_reach("Barrel Battle", "Region", world.player)
+             or state.can_reach("She Came from Outer Space", "Region", world.player)
+             or state.can_reach("Cheating the Race", "Region", world.player)
+             or state.can_reach("Heating Up Mafia Town", "Region", world.player)
+             or state.can_reach("The Golden Vault", "Region", world.player))
+
+    # For some reason, the brewing crate is removed in HUMT
+    add_rule(world.multiworld.get_location("Mafia Town - Secret Cave", world.player),
+             lambda state: state.has("HUMT Access", world.player), "or")
+
+    # Can bounce across the lava to get this without Hookshot (need to die though)
+    add_rule(world.multiworld.get_location("Mafia Town - Above Boats", world.player),
+             lambda state: state.has("HUMT Access", world.player), "or")
+
+    if world.options.CTRLogic == CTRLogic.option_nothing:
+        set_rule(world.multiworld.get_location("Act Completion (Cheating the Race)", world.player), lambda state: True)
+    elif world.options.CTRLogic == CTRLogic.option_sprint:
+        add_rule(world.multiworld.get_location("Act Completion (Cheating the Race)", world.player),
+                 lambda state: can_use_hat(state, world, HatType.SPRINT), "or")
+    elif world.options.CTRLogic == CTRLogic.option_scooter:
+        add_rule(world.multiworld.get_location("Act Completion (Cheating the Race)", world.player),
+                 lambda state: can_use_hat(state, world, HatType.SPRINT)
+                 and state.has("Scooter Badge", world.player), "or")
+
+
+def set_botb_rules(world: "HatInTimeWorld"):
+    if not world.options.UmbrellaLogic and get_difficulty(world) < Difficulty.MODERATE:
+        set_rule(world.multiworld.get_location("Dead Bird Studio - DJ Grooves Sign Chest", world.player),
+                 lambda state: state.has("Umbrella", world.player) or can_use_hat(state, world, HatType.BREWING))
+        set_rule(world.multiworld.get_location("Dead Bird Studio - Tepee Chest", world.player),
+                 lambda state: state.has("Umbrella", world.player) or can_use_hat(state, world, HatType.BREWING))
+        set_rule(world.multiworld.get_location("Dead Bird Studio - Conductor Chest", world.player),
+                 lambda state: state.has("Umbrella", world.player) or can_use_hat(state, world, HatType.BREWING))
+        set_rule(world.multiworld.get_location("Act Completion (Dead Bird Studio)", world.player),
+                 lambda state: state.has("Umbrella", world.player) or can_use_hat(state, world, HatType.BREWING))
+
+
+def set_subcon_rules(world: "HatInTimeWorld"):
+    set_rule(world.multiworld.get_location("Act Completion (Time Rift - Village)", world.player),
+             lambda state: can_use_hat(state, world, HatType.BREWING) or state.has("Umbrella", world.player)
+             or can_use_hat(state, world, HatType.DWELLER))
+
+    # You can't skip over the boss arena wall without cherry hover, so these two need to be set this way
+    set_rule(world.multiworld.get_location("Subcon Forest - Boss Arena Chest", world.player),
+             lambda state: state.has("TOD Access", world.player) and can_use_hookshot(state, world)
+             and has_paintings(state, world, 1, False) or state.has("YCHE Access", world.player))
+
+    # The painting wall can't be skipped without cherry hover, which is Expert
+    set_rule(world.multiworld.get_location("Act Completion (Toilet of Doom)", world.player),
+             lambda state: can_use_hookshot(state, world) and can_hit(state, world)
+             and has_paintings(state, world, 1, False))
+
+    add_rule(world.multiworld.get_entrance("Subcon Forest - Act 2", world.player),
+             lambda state: state.has("Snatcher's Contract - The Subcon Well", world.player))
+
+    add_rule(world.multiworld.get_entrance("Subcon Forest - Act 3", world.player),
+             lambda state: state.has("Snatcher's Contract - Toilet of Doom", world.player))
+
+    add_rule(world.multiworld.get_entrance("Subcon Forest - Act 4", world.player),
+             lambda state: state.has("Snatcher's Contract - Queen Vanessa's Manor", world.player))
+
+    add_rule(world.multiworld.get_entrance("Subcon Forest - Act 5", world.player),
+             lambda state: state.has("Snatcher's Contract - Mail Delivery Service", world.player))
+
+    if painting_logic(world):
+        add_rule(world.multiworld.get_location("Act Completion (Contractual Obligations)", world.player),
+                 lambda state: has_paintings(state, world, 1, False))
+
+
+def set_alps_rules(world: "HatInTimeWorld"):
+    add_rule(world.multiworld.get_entrance("-> The Birdhouse", world.player),
+             lambda state: can_use_hookshot(state, world) and can_use_hat(state, world, HatType.BREWING))
+
+    add_rule(world.multiworld.get_entrance("-> The Lava Cake", world.player),
+             lambda state: can_use_hookshot(state, world))
+
+    add_rule(world.multiworld.get_entrance("-> The Windmill", world.player),
+             lambda state: can_use_hookshot(state, world))
+
+    add_rule(world.multiworld.get_entrance("-> The Twilight Bell", world.player),
+             lambda state: can_use_hookshot(state, world) and can_use_hat(state, world, HatType.DWELLER))
+
+    add_rule(world.multiworld.get_location("Alpine Skyline - Mystifying Time Mesa: Zipline", world.player),
+             lambda state: can_use_hat(state, world, HatType.SPRINT) or can_use_hat(state, world, HatType.TIME_STOP))
+
+    add_rule(world.multiworld.get_entrance("Alpine Skyline - Finale", world.player),
+             lambda state: can_clear_alpine(state, world))
+
+    add_rule(world.multiworld.get_location("Alpine Skyline - Goat Refinery", world.player),
+             lambda state: state.has("AFR Access", world.player)
+             and can_use_hookshot(state, world)
+             and can_hit(state, world, True))
+
+
+def set_dlc1_rules(world: "HatInTimeWorld"):
+    add_rule(world.multiworld.get_entrance("Cruise Ship Entrance BV", world.player),
+             lambda state: can_use_hookshot(state, world))
+
+    # This particular item isn't present in Act 3 for some reason, yes in vanilla too
+    add_rule(world.multiworld.get_location("The Arctic Cruise - Toilet", world.player),
+             lambda state: state.can_reach("Bon Voyage!", "Region", world.player)
+             or state.can_reach("Ship Shape", "Region", world.player))
+
+
+def set_dlc2_rules(world: "HatInTimeWorld"):
+    add_rule(world.multiworld.get_entrance("-> Bluefin Tunnel", world.player),
+             lambda state: state.has("Metro Ticket - Green", world.player)
+             or state.has("Metro Ticket - Blue", world.player))
+
+    add_rule(world.multiworld.get_entrance("-> Pink Paw Station", world.player),
+             lambda state: state.has("Metro Ticket - Pink", world.player)
+             or state.has("Metro Ticket - Yellow", world.player) and state.has("Metro Ticket - Blue", world.player))
+
+    add_rule(world.multiworld.get_entrance("Nyakuza Metro - Finale", world.player),
+             lambda state: can_clear_metro(state, world))
+
+    add_rule(world.multiworld.get_location("Act Completion (Rush Hour)", world.player),
+             lambda state: state.has("Metro Ticket - Yellow", world.player)
+             and state.has("Metro Ticket - Blue", world.player)
+             and state.has("Metro Ticket - Pink", world.player))
+
+    for key in shop_locations.keys():
+        if "Green Clean Station Thug B" in key and is_location_valid(world, key):
+            add_rule(world.multiworld.get_location(key, world.player),
+                     lambda state: state.has("Metro Ticket - Yellow", world.player), "or")
+
+
+def reg_act_connection(world: "HatInTimeWorld", region: Union[str, Region], unlocked_entrance: Union[str, Entrance]):
+    reg: Region
+    entrance: Entrance
+    if isinstance(region, str):
+        reg = world.multiworld.get_region(region, world.player)
+    else:
+        reg = region
+
+    if isinstance(unlocked_entrance, str):
+        entrance = world.multiworld.get_entrance(unlocked_entrance, world.player)
+    else:
+        entrance = unlocked_entrance
+
+    world.multiworld.register_indirect_condition(reg, entrance)
+
+
+# See randomize_act_entrances in Regions.py
+# Called before set_rules
+def set_rift_rules(world: "HatInTimeWorld", regions: Dict[str, Region]):
+
+    # This is accessing the regions in place of these time rifts, so we can set the rules on all the entrances.
+    for entrance in regions["Time Rift - Gallery"].entrances:
+        add_rule(entrance, lambda state: can_use_hat(state, world, HatType.BREWING)
+                 and state.has("Time Piece", world.player, world.chapter_timepiece_costs[ChapterIndex.BIRDS]))
+
+    for entrance in regions["Time Rift - The Lab"].entrances:
+        add_rule(entrance, lambda state: can_use_hat(state, world, HatType.DWELLER)
+                 and state.has("Time Piece", world.player, world.chapter_timepiece_costs[ChapterIndex.ALPINE]))
+
+    for entrance in regions["Time Rift - Sewers"].entrances:
+        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Mafia Town - Act 4"))
+        reg_act_connection(world, world.multiworld.get_entrance("Mafia Town - Act 4",
+                                                                world.player).connected_region, entrance)
+
+    for entrance in regions["Time Rift - Bazaar"].entrances:
+        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Mafia Town - Act 6"))
+        reg_act_connection(world, world.multiworld.get_entrance("Mafia Town - Act 6",
+                                                                world.player).connected_region, entrance)
+
+    for entrance in regions["Time Rift - Mafia of Cooks"].entrances:
+        add_rule(entrance, lambda state: has_relic_combo(state, world, "Burger"))
+
+    for entrance in regions["Time Rift - The Owl Express"].entrances:
+        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Battle of the Birds - Act 2"))
+        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Battle of the Birds - Act 3"))
+        reg_act_connection(world, world.multiworld.get_entrance("Battle of the Birds - Act 2",
+                                                                world.player).connected_region, entrance)
+        reg_act_connection(world, world.multiworld.get_entrance("Battle of the Birds - Act 3",
+                                                                world.player).connected_region, entrance)
+
+    for entrance in regions["Time Rift - The Moon"].entrances:
+        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Battle of the Birds - Act 4"))
+        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Battle of the Birds - Act 5"))
+        reg_act_connection(world, world.multiworld.get_entrance("Battle of the Birds - Act 4",
+                                                                world.player).connected_region, entrance)
+        reg_act_connection(world, world.multiworld.get_entrance("Battle of the Birds - Act 5",
+                                                                world.player).connected_region, entrance)
+
+    for entrance in regions["Time Rift - Dead Bird Studio"].entrances:
+        add_rule(entrance, lambda state: has_relic_combo(state, world, "Train"))
+
+    for entrance in regions["Time Rift - Pipe"].entrances:
+        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Subcon Forest - Act 2"))
+        reg_act_connection(world, world.multiworld.get_entrance("Subcon Forest - Act 2",
+                                                                world.player).connected_region, entrance)
+        if painting_logic(world):
+            add_rule(entrance, lambda state: has_paintings(state, world, 2))
+
+    for entrance in regions["Time Rift - Village"].entrances:
+        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Subcon Forest - Act 4"))
+        reg_act_connection(world, world.multiworld.get_entrance("Subcon Forest - Act 4",
+                                                                world.player).connected_region, entrance)
+
+        if painting_logic(world):
+            add_rule(entrance, lambda state: has_paintings(state, world, 2))
+
+    for entrance in regions["Time Rift - Sleepy Subcon"].entrances:
+        add_rule(entrance, lambda state: has_relic_combo(state, world, "UFO"))
+        if painting_logic(world):
+            add_rule(entrance, lambda state: has_paintings(state, world, 3))
+
+    for entrance in regions["Time Rift - Curly Tail Trail"].entrances:
+        add_rule(entrance, lambda state: state.has("Windmill Cleared", world.player))
+
+    for entrance in regions["Time Rift - The Twilight Bell"].entrances:
+        add_rule(entrance, lambda state: state.has("Twilight Bell Cleared", world.player))
+
+    for entrance in regions["Time Rift - Alpine Skyline"].entrances:
+        add_rule(entrance, lambda state: has_relic_combo(state, world, "Crayon"))
+
+    if world.is_dlc1():
+        for entrance in regions["Time Rift - Balcony"].entrances:
+            add_rule(entrance, lambda state: can_clear_required_act(state, world, "The Arctic Cruise - Finale"))
+
+        for entrance in regions["Time Rift - Deep Sea"].entrances:
+            add_rule(entrance, lambda state: has_relic_combo(state, world, "Cake"))
+
+    if world.is_dlc2():
+        for entrance in regions["Time Rift - Rumbi Factory"].entrances:
+            add_rule(entrance, lambda state: has_relic_combo(state, world, "Necklace"))
+
+
+# Basically the same as above, but without the need of the dict since we are just setting defaults
+# Called if Act Rando is disabled
+def set_default_rift_rules(world: "HatInTimeWorld"):
+
+    for entrance in world.multiworld.get_region("Time Rift - Gallery", world.player).entrances:
+        add_rule(entrance, lambda state: can_use_hat(state, world, HatType.BREWING)
+                 and state.has("Time Piece", world.player, world.chapter_timepiece_costs[ChapterIndex.BIRDS]))
+
+    for entrance in world.multiworld.get_region("Time Rift - The Lab", world.player).entrances:
+        add_rule(entrance, lambda state: can_use_hat(state, world, HatType.DWELLER)
+                 and state.has("Time Piece", world.player, world.chapter_timepiece_costs[ChapterIndex.ALPINE]))
+
+    for entrance in world.multiworld.get_region("Time Rift - Sewers", world.player).entrances:
+        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Mafia Town - Act 4"))
+        reg_act_connection(world, "Down with the Mafia!", entrance.name)
+
+    for entrance in world.multiworld.get_region("Time Rift - Bazaar", world.player).entrances:
+        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Mafia Town - Act 6"))
+        reg_act_connection(world, "Heating Up Mafia Town", entrance.name)
+
+    for entrance in world.multiworld.get_region("Time Rift - Mafia of Cooks", world.player).entrances:
+        add_rule(entrance, lambda state: has_relic_combo(state, world, "Burger"))
+
+    for entrance in world.multiworld.get_region("Time Rift - The Owl Express", world.player).entrances:
+        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Battle of the Birds - Act 2"))
+        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Battle of the Birds - Act 3"))
+        reg_act_connection(world, "Murder on the Owl Express", entrance.name)
+        reg_act_connection(world, "Picture Perfect", entrance.name)
+
+    for entrance in world.multiworld.get_region("Time Rift - The Moon", world.player).entrances:
+        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Battle of the Birds - Act 4"))
+        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Battle of the Birds - Act 5"))
+        reg_act_connection(world, "Train Rush", entrance.name)
+        reg_act_connection(world, "The Big Parade", entrance.name)
+
+    for entrance in world.multiworld.get_region("Time Rift - Dead Bird Studio", world.player).entrances:
+        add_rule(entrance, lambda state: has_relic_combo(state, world, "Train"))
+
+    for entrance in world.multiworld.get_region("Time Rift - Pipe", world.player).entrances:
+        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Subcon Forest - Act 2"))
+        reg_act_connection(world, "The Subcon Well", entrance.name)
+        if painting_logic(world):
+            add_rule(entrance, lambda state: has_paintings(state, world, 2))
+
+    for entrance in world.multiworld.get_region("Time Rift - Village", world.player).entrances:
+        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Subcon Forest - Act 4"))
+        reg_act_connection(world, "Queen Vanessa's Manor", entrance.name)
+        if painting_logic(world):
+            add_rule(entrance, lambda state: has_paintings(state, world, 2))
+
+    for entrance in world.multiworld.get_region("Time Rift - Sleepy Subcon", world.player).entrances:
+        add_rule(entrance, lambda state: has_relic_combo(state, world, "UFO"))
+        if painting_logic(world):
+            add_rule(entrance, lambda state: has_paintings(state, world, 3))
+
+    for entrance in world.multiworld.get_region("Time Rift - Curly Tail Trail", world.player).entrances:
+        add_rule(entrance, lambda state: state.has("Windmill Cleared", world.player))
+
+    for entrance in world.multiworld.get_region("Time Rift - The Twilight Bell", world.player).entrances:
+        add_rule(entrance, lambda state: state.has("Twilight Bell Cleared", world.player))
+
+    for entrance in world.multiworld.get_region("Time Rift - Alpine Skyline", world.player).entrances:
+        add_rule(entrance, lambda state: has_relic_combo(state, world, "Crayon"))
+
+    if world.is_dlc1():
+        for entrance in world.multiworld.get_region("Time Rift - Balcony", world.player).entrances:
+            add_rule(entrance, lambda state: can_clear_required_act(state, world, "The Arctic Cruise - Finale"))
+
+        for entrance in world.multiworld.get_region("Time Rift - Deep Sea", world.player).entrances:
+            add_rule(entrance, lambda state: has_relic_combo(state, world, "Cake"))
+
+    if world.is_dlc2():
+        for entrance in world.multiworld.get_region("Time Rift - Rumbi Factory", world.player).entrances:
+            add_rule(entrance, lambda state: has_relic_combo(state, world, "Necklace"))
+
+
+def set_event_rules(world: "HatInTimeWorld"):
+    for (name, data) in event_locs.items():
+        if not is_location_valid(world, name):
+            continue
+
+        event: Location = world.multiworld.get_location(name, world.player)
+
+        if data.act_event:
+            add_rule(event, world.multiworld.get_location(f"Act Completion ({data.region})", world.player).access_rule)

worlds/ahit/Types.py

@@ -0,0 +1,86 @@
+from enum import IntEnum, IntFlag
+from typing import NamedTuple, Optional, List
+from BaseClasses import Location, Item, ItemClassification
+
+
+class HatInTimeLocation(Location):
+    game = "A Hat in Time"
+
+
+class HatInTimeItem(Item):
+    game = "A Hat in Time"
+
+
+class HatType(IntEnum):
+    SPRINT = 0
+    BREWING = 1
+    ICE = 2
+    DWELLER = 3
+    TIME_STOP = 4
+
+
+class HitType(IntEnum):
+    none = 0
+    umbrella = 1
+    umbrella_or_brewing = 2
+    dweller_bell = 3
+
+
+class HatDLC(IntFlag):
+    none = 0b000
+    dlc1 = 0b001
+    dlc2 = 0b010
+    death_wish = 0b100
+    dlc1_dw = 0b101
+    dlc2_dw = 0b110
+
+
+class ChapterIndex(IntEnum):
+    SPACESHIP = 0
+    MAFIA = 1
+    BIRDS = 2
+    SUBCON = 3
+    ALPINE = 4
+    FINALE = 5
+    CRUISE = 6
+    METRO = 7
+
+
+class Difficulty(IntEnum):
+    NORMAL = -1
+    MODERATE = 0
+    HARD = 1
+    EXPERT = 2
+
+
+class LocData(NamedTuple):
+    id: int = 0
+    region: str = ""
+    required_hats: List[HatType] = []
+    hookshot: bool = False
+    dlc_flags: HatDLC = HatDLC.none
+    paintings: int = 0  # Paintings required for Subcon painting shuffle
+    misc_required: List[str] = []
+
+    # For UmbrellaLogic setting only.
+    hit_type: HitType = HitType.none
+
+    # Other
+    act_event: bool = False  # Only used for event locations. Copy access rule from act completion
+    nyakuza_thug: str = ""  # Name of Nyakuza thug NPC (for metro shops)
+    snatcher_coin: str = ""  # Only for Snatcher Coin event locations, name of the Snatcher Coin item
+
+
+class ItemData(NamedTuple):
+    code: Optional[int]
+    classification: ItemClassification
+    dlc_flags: Optional[HatDLC] = HatDLC.none
+
+
+hat_type_to_item = {
+    HatType.SPRINT:     "Sprint Hat",
+    HatType.BREWING:    "Brewing Hat",
+    HatType.ICE:        "Ice Hat",
+    HatType.DWELLER:    "Dweller Mask",
+    HatType.TIME_STOP:  "Time Stop Hat",
+}

worlds/ahit/__init__.py

@@ -0,0 +1,374 @@
+from BaseClasses import Item, ItemClassification, Tutorial, Location, MultiWorld
+from .Items import item_table, create_item, relic_groups, act_contracts, create_itempool, get_shop_trap_name, \
+    calculate_yarn_costs
+from .Regions import create_regions, randomize_act_entrances, chapter_act_info, create_events, get_shuffled_region
+from .Locations import location_table, contract_locations, is_location_valid, get_location_names, TASKSANITY_START_ID, \
+    get_total_locations
+from .Rules import set_rules
+from .Options import AHITOptions, slot_data_options, adjust_options, RandomizeHatOrder, EndGoal, create_option_groups
+from .Types import HatType, ChapterIndex, HatInTimeItem, hat_type_to_item
+from .DeathWishLocations import create_dw_regions, dw_classes, death_wishes
+from .DeathWishRules import set_dw_rules, create_enemy_events, hit_list, bosses
+from worlds.AutoWorld import World, WebWorld, CollectionState
+from typing import List, Dict, TextIO
+from worlds.LauncherComponents import Component, components, icon_paths, launch_subprocess, Type
+from Utils import local_path
+
+
+def launch_client():
+    from .Client import launch
+    launch_subprocess(launch, name="AHITClient")
+
+
+components.append(Component("A Hat in Time Client", "AHITClient", func=launch_client,
+                            component_type=Type.CLIENT, icon='yatta'))
+
+icon_paths['yatta'] = local_path('data', 'yatta.png')
+
+
+class AWebInTime(WebWorld):
+    theme = "partyTime"
+    option_groups = create_option_groups()
+    tutorials = [Tutorial(
+        "Multiworld Setup Guide",
+        "A guide for setting up A Hat in Time to be played in Archipelago.",
+        "English",
+        "ahit_en.md",
+        "setup/en",
+        ["CookieCat"]
+    )]
+
+
+class HatInTimeWorld(World):
+    """
+    A Hat in Time is a cute-as-peck 3D platformer featuring a little girl who stitches hats for wicked powers!
+    Freely explore giant worlds and recover Time Pieces to travel to new heights!
+    """
+
+    game = "A Hat in Time"
+    item_name_to_id = {name: data.code for name, data in item_table.items()}
+    location_name_to_id = get_location_names()
+    options_dataclass = AHITOptions
+    options: AHITOptions
+    item_name_groups = relic_groups
+    web = AWebInTime()
+
+    def __init__(self, multiworld: "MultiWorld", player: int):
+        super().__init__(multiworld, player)
+        self.act_connections: Dict[str, str] = {}
+        self.shop_locs: List[str] = []
+
+        self.hat_craft_order: List[HatType] = [HatType.SPRINT, HatType.BREWING, HatType.ICE,
+                                               HatType.DWELLER, HatType.TIME_STOP]
+
+        self.hat_yarn_costs: Dict[HatType, int] = {HatType.SPRINT: -1, HatType.BREWING: -1, HatType.ICE: -1,
+                                                   HatType.DWELLER: -1, HatType.TIME_STOP: -1}
+
+        self.chapter_timepiece_costs: Dict[ChapterIndex, int] = {ChapterIndex.MAFIA: -1,
+                                                                 ChapterIndex.BIRDS: -1,
+                                                                 ChapterIndex.SUBCON: -1,
+                                                                 ChapterIndex.ALPINE: -1,
+                                                                 ChapterIndex.FINALE: -1,
+                                                                 ChapterIndex.CRUISE: -1,
+                                                                 ChapterIndex.METRO: -1}
+        self.excluded_dws: List[str] = []
+        self.excluded_bonuses: List[str] = []
+        self.dw_shuffle: List[str] = []
+        self.nyakuza_thug_items: Dict[str, int] = {}
+        self.badge_seller_count: int = 0
+
+    def generate_early(self):
+        adjust_options(self)
+
+        if self.options.StartWithCompassBadge:
+            self.multiworld.push_precollected(self.create_item("Compass Badge"))
+
+        if self.is_dw_only():
+            return
+
+        # If our starting chapter is 4 and act rando isn't on, force hookshot into inventory
+        # If starting chapter is 3 and painting shuffle is enabled, and act rando isn't, give one free painting unlock
+        start_chapter: ChapterIndex = ChapterIndex(self.options.StartingChapter)
+
+        if start_chapter == ChapterIndex.ALPINE or start_chapter == ChapterIndex.SUBCON:
+            if not self.options.ActRandomizer:
+                if start_chapter == ChapterIndex.ALPINE:
+                    self.multiworld.push_precollected(self.create_item("Hookshot Badge"))
+                    if self.options.UmbrellaLogic:
+                        self.multiworld.push_precollected(self.create_item("Umbrella"))
+
+                if start_chapter == ChapterIndex.SUBCON and self.options.ShuffleSubconPaintings:
+                    self.multiworld.push_precollected(self.create_item("Progressive Painting Unlock"))
+
+    def create_regions(self):
+        # noinspection PyClassVar
+        self.topology_present = bool(self.options.ActRandomizer)
+
+        create_regions(self)
+        if self.options.EnableDeathWish:
+            create_dw_regions(self)
+
+        if self.is_dw_only():
+            return
+
+        create_events(self)
+        if self.is_dw():
+            if "Snatcher's Hit List" not in self.excluded_dws or "Camera Tourist" not in self.excluded_dws:
+                create_enemy_events(self)
+
+        # place vanilla contract locations if contract shuffle is off
+        if not self.options.ShuffleActContracts:
+            for name in contract_locations.keys():
+                self.multiworld.get_location(name, self.player).place_locked_item(create_item(self, name))
+
+    def create_items(self):
+        if self.has_yarn():
+            calculate_yarn_costs(self)
+
+            if self.options.RandomizeHatOrder:
+                self.random.shuffle(self.hat_craft_order)
+                if self.options.RandomizeHatOrder == RandomizeHatOrder.option_time_stop_last:
+                    self.hat_craft_order.remove(HatType.TIME_STOP)
+                    self.hat_craft_order.append(HatType.TIME_STOP)
+
+            # move precollected hats to the start of the list
+            for i in range(5):
+                hat = HatType(i)
+                if self.is_hat_precollected(hat):
+                    self.hat_craft_order.remove(hat)
+                    self.hat_craft_order.insert(0, hat)
+
+        self.multiworld.itempool += create_itempool(self)
+
+    def set_rules(self):
+        if self.is_dw_only():
+            # we already have all items if this is the case, no need for rules
+            self.multiworld.push_precollected(HatInTimeItem("Death Wish Only Mode", ItemClassification.progression,
+                                              None, self.player))
+
+            self.multiworld.completion_condition[self.player] = lambda state: state.has("Death Wish Only Mode",
+                                                                                        self.player)
+
+            if not self.options.DWEnableBonus:
+                for name in death_wishes:
+                    if name == "Snatcher Coins in Nyakuza Metro" and not self.is_dlc2():
+                        continue
+
+                    if self.options.DWShuffle and name not in self.dw_shuffle:
+                        continue
+
+                    full_clear = self.multiworld.get_location(f"{name} - All Clear", self.player)
+                    full_clear.address = None
+                    full_clear.place_locked_item(HatInTimeItem("Nothing", ItemClassification.filler, None, self.player))
+                    full_clear.show_in_spoiler = False
+
+            return
+
+        if self.options.ActRandomizer:
+            randomize_act_entrances(self)
+
+        set_rules(self)
+
+        if self.is_dw():
+            set_dw_rules(self)
+
+    def create_item(self, name: str) -> Item:
+        return create_item(self, name)
+
+    def fill_slot_data(self) -> dict:
+        slot_data: dict = {"Chapter1Cost": self.chapter_timepiece_costs[ChapterIndex.MAFIA],
+                           "Chapter2Cost": self.chapter_timepiece_costs[ChapterIndex.BIRDS],
+                           "Chapter3Cost": self.chapter_timepiece_costs[ChapterIndex.SUBCON],
+                           "Chapter4Cost": self.chapter_timepiece_costs[ChapterIndex.ALPINE],
+                           "Chapter5Cost": self.chapter_timepiece_costs[ChapterIndex.FINALE],
+                           "Chapter6Cost": self.chapter_timepiece_costs[ChapterIndex.CRUISE],
+                           "Chapter7Cost": self.chapter_timepiece_costs[ChapterIndex.METRO],
+                           "BadgeSellerItemCount": self.badge_seller_count,
+                           "SeedNumber": str(self.multiworld.seed),  # For shop prices
+                           "SeedName": self.multiworld.seed_name,
+                           "TotalLocations": get_total_locations(self)}
+
+        if self.has_yarn():
+            slot_data.setdefault("SprintYarnCost", self.hat_yarn_costs[HatType.SPRINT])
+            slot_data.setdefault("BrewingYarnCost", self.hat_yarn_costs[HatType.BREWING])
+            slot_data.setdefault("IceYarnCost", self.hat_yarn_costs[HatType.ICE])
+            slot_data.setdefault("DwellerYarnCost", self.hat_yarn_costs[HatType.DWELLER])
+            slot_data.setdefault("TimeStopYarnCost", self.hat_yarn_costs[HatType.TIME_STOP])
+            slot_data.setdefault("Hat1", int(self.hat_craft_order[0]))
+            slot_data.setdefault("Hat2", int(self.hat_craft_order[1]))
+            slot_data.setdefault("Hat3", int(self.hat_craft_order[2]))
+            slot_data.setdefault("Hat4", int(self.hat_craft_order[3]))
+            slot_data.setdefault("Hat5", int(self.hat_craft_order[4]))
+
+        if self.options.ActRandomizer:
+            for name in self.act_connections.keys():
+                slot_data[name] = self.act_connections[name]
+
+        if self.is_dlc2() and not self.is_dw_only():
+            for name in self.nyakuza_thug_items.keys():
+                slot_data[name] = self.nyakuza_thug_items[name]
+
+        if self.is_dw():
+            i = 0
+            for name in self.excluded_dws:
+                if self.options.EndGoal.value == EndGoal.option_seal_the_deal and name == "Seal the Deal":
+                    continue
+
+                slot_data[f"excluded_dw{i}"] = dw_classes[name]
+                i += 1
+
+            i = 0
+            if not self.options.DWAutoCompleteBonuses:
+                for name in self.excluded_bonuses:
+                    if name in self.excluded_dws:
+                        continue
+
+                    slot_data[f"excluded_bonus{i}"] = dw_classes[name]
+                    i += 1
+
+            if self.options.DWShuffle:
+                shuffled_dws = self.dw_shuffle
+                for i in range(len(shuffled_dws)):
+                    slot_data[f"dw_{i}"] = dw_classes[shuffled_dws[i]]
+
+        shop_item_names: Dict[str, str] = {}
+        for name in self.shop_locs:
+            loc: Location = self.multiworld.get_location(name, self.player)
+            assert loc.item
+            item_name: str
+            if loc.item.classification is ItemClassification.trap and loc.item.game == "A Hat in Time":
+                item_name = get_shop_trap_name(self)
+            else:
+                item_name = loc.item.name
+
+            shop_item_names.setdefault(str(loc.address), item_name)
+
+        slot_data["ShopItemNames"] = shop_item_names
+
+        for name, value in self.options.as_dict(*self.options_dataclass.type_hints).items():
+            if name in slot_data_options:
+                slot_data[name] = value
+
+        return slot_data
+
+    def extend_hint_information(self, hint_data: Dict[int, Dict[int, str]]):
+        if self.is_dw_only() or not self.options.ActRandomizer:
+            return
+
+        new_hint_data = {}
+        alpine_regions = ["The Birdhouse", "The Lava Cake", "The Windmill",
+                          "The Twilight Bell", "Alpine Skyline Area", "Alpine Skyline Area (TIHS)"]
+
+        metro_regions = ["Yellow Overpass Station", "Green Clean Station", "Bluefin Tunnel", "Pink Paw Station"]
+
+        for key, data in location_table.items():
+            if not is_location_valid(self, key):
+                continue
+
+            location = self.multiworld.get_location(key, self.player)
+            region_name: str
+
+            if data.region in alpine_regions:
+                region_name = "Alpine Free Roam"
+            elif data.region in metro_regions:
+                region_name = "Nyakuza Free Roam"
+            elif "Dead Bird Studio - " in data.region:
+                region_name = "Dead Bird Studio"
+            elif data.region in chapter_act_info.keys():
+                region_name = location.parent_region.name
+            else:
+                continue
+
+            new_hint_data[location.address] = get_shuffled_region(self, region_name)
+
+        if self.is_dlc1() and self.options.Tasksanity:
+            ship_shape_region = get_shuffled_region(self, "Ship Shape")
+            id_start: int = TASKSANITY_START_ID
+            for i in range(self.options.TasksanityCheckCount):
+                new_hint_data[id_start+i] = ship_shape_region
+
+        hint_data[self.player] = new_hint_data
+
+    def write_spoiler_header(self, spoiler_handle: TextIO):
+        for i in self.chapter_timepiece_costs:
+            spoiler_handle.write("Chapter %i Cost: %i\n" % (i, self.chapter_timepiece_costs[ChapterIndex(i)]))
+
+        for hat in self.hat_craft_order:
+            spoiler_handle.write("Hat Cost: %s: %i\n" % (hat, self.hat_yarn_costs[hat]))
+
+    def collect(self, state: "CollectionState", item: "Item") -> bool:
+        old_count: int = state.count(item.name, self.player)
+        change = super().collect(state, item)
+        if change and old_count == 0:
+            if "Stamp" in item.name:
+                if "2 Stamp" in item.name:
+                    state.prog_items[self.player]["Stamps"] += 2
+                else:
+                    state.prog_items[self.player]["Stamps"] += 1
+            elif "(Zero Jumps)" in item.name:
+                state.prog_items[self.player]["Zero Jumps"] += 1
+            elif item.name in hit_list.keys():
+                if item.name not in bosses:
+                    state.prog_items[self.player]["Enemy"] += 1
+                else:
+                    state.prog_items[self.player]["Boss"] += 1
+
+        return change
+
+    def remove(self, state: "CollectionState", item: "Item") -> bool:
+        old_count: int = state.count(item.name, self.player)
+        change = super().collect(state, item)
+        if change and old_count == 1:
+            if "Stamp" in item.name:
+                if "2 Stamp" in item.name:
+                    state.prog_items[self.player]["Stamps"] -= 2
+                else:
+                    state.prog_items[self.player]["Stamps"] -= 1
+            elif "(Zero Jumps)" in item.name:
+                state.prog_items[self.player]["Zero Jumps"] -= 1
+            elif item.name in hit_list.keys():
+                if item.name not in bosses:
+                    state.prog_items[self.player]["Enemy"] -= 1
+                else:
+                    state.prog_items[self.player]["Boss"] -= 1
+
+        return change
+
+    def has_yarn(self) -> bool:
+        return not self.is_dw_only() and not self.options.HatItems
+
+    def is_hat_precollected(self, hat: HatType) -> bool:
+        for item in self.multiworld.precollected_items[self.player]:
+            if item.name == hat_type_to_item[hat]:
+                return True
+
+        return False
+
+    def is_dlc1(self) -> bool:
+        return bool(self.options.EnableDLC1)
+
+    def is_dlc2(self) -> bool:
+        return bool(self.options.EnableDLC2)
+
+    def is_dw(self) -> bool:
+        return bool(self.options.EnableDeathWish)
+
+    def is_dw_only(self) -> bool:
+        return self.is_dw() and bool(self.options.DeathWishOnly)
+
+    def is_dw_excluded(self, name: str) -> bool:
+        # don't exclude Seal the Deal if it's our goal
+        if self.options.EndGoal.value == EndGoal.option_seal_the_deal and name == "Seal the Deal" \
+           and f"{name} - Main Objective" not in self.options.exclude_locations:
+            return False
+
+        if name in self.excluded_dws:
+            return True
+
+        return f"{name} - Main Objective" in self.options.exclude_locations
+
+    def is_bonus_excluded(self, name: str) -> bool:
+        if self.is_dw_excluded(name) or name in self.excluded_bonuses:
+            return True
+
+        return f"{name} - All Clear" in self.options.exclude_locations

worlds/ahit/docs/en_A Hat in Time.md

@@ -0,0 +1,53 @@
+# A Hat in Time
+
+## 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.
+
+## What does randomization do to this game?
+
+Items which the player would normally acquire throughout the game have been moved around. 
+Chapter costs are randomized in a progressive order based on your options, 
+so for example you could go to Subcon Forest -> Battle of the Birds -> Alpine Skyline, etc. in that order. 
+If act shuffle is turned on, the levels and Time Rifts in these chapters will be randomized as well.
+ 
+To unlock and access a chapter's Time Rift in act shuffle, 
+the levels in place of the original acts required to unlock the Time Rift in the vanilla game must be completed, 
+and then you must enter a level that allows you to access that Time Rift. 
+For example, Time Rift: Bazaar requires Heating Up Mafia Town to be completed in the vanilla game. 
+To unlock this Time Rift in act shuffle (and therefore the level it contains) 
+you must complete the level that was shuffled in place of Heating Up Mafia Town 
+and then enter the Time Rift through a Mafia Town level.
+
+## What items and locations get shuffled?
+
+Time Pieces, Relics, Yarn, Badges, and most other items are shuffled. 
+Unlike in the vanilla game, yarn is typeless, and hats will be automatically stitched 
+in a set order once you gather enough yarn for each hat. 
+Hats can also optionally be shuffled as individual items instead. 
+Any items in the world, shops, act completions, 
+and optionally storybook pages or Death Wish contracts are locations.
+
+Any freestanding items that are considered to be progression or useful 
+will have a rainbow streak particle attached to them. 
+Filler items will have a white glow attached to them instead.
+
+## Which items can be in another player's world?
+
+Any of the items which can be shuffled may also be placed into another player's world. It is possible to choose to limit
+certain items to your own world.
+
+## What does another world's item look like in A Hat in Time?
+
+Items belonging to other worlds are represented by a badge with the Archipelago logo on it.
+
+## When the player receives an item, what happens?
+
+When the player receives an item, it will play the item collect effect and information about the item 
+will be printed on the screen and in the in-game developer console.
+
+## Is the DLC required to play A Hat in Time in Archipelago?
+
+No, the DLC expansions are not required to play. Their content can be enabled through certain options 
+that are disabled by default, but please don't turn them on if you don't own the respective DLC.

worlds/ahit/docs/setup_en.md

@@ -0,0 +1,102 @@
+# Setup Guide for A Hat in Time in Archipelago
+
+## Required Software
+- [Steam release of A Hat in Time](https://store.steampowered.com/app/253230/A_Hat_in_Time/)
+
+- [Archipelago Workshop Mod for A Hat in Time](https://steamcommunity.com/sharedfiles/filedetails/?id=3026842601)
+
+
+## Optional Software
+- [A Hat in Time Archipelago Map Tracker](https://github.com/Mysteryem/ahit-poptracker/releases), for use with [PopTracker](https://github.com/black-sliver/PopTracker/releases)
+
+
+## Instructions
+
+1. Have Steam running. Open the Steam console with this link: [steam://open/console](steam://open/console)   
+This may not work for some browsers. If that's the case, and you're on Windows, open the Run dialog using Win+R,
+paste the link into the box, and hit Enter.
+
+
+2. In the Steam console, enter the following command: 
+`download_depot 253230 253232 7770543545116491859`. ***Wait for the console to say the download is finished!***
+This can take a while to finish (30+ minutes) depending on your connection speed, so please be patient. Additionally,
+**try to prevent your connection from being interrupted or slowed while Steam is downloading the depot,**
+or else the download may potentially become corrupted (see first FAQ issue below).
+
+
+3. Once the download finishes, go to `steamapps/content/app_253230` in Steam's program folder.
+
+
+4. There should be a folder named `depot_253232`. Rename it to HatinTime_AP and move it to your `steamapps/common` folder.
+
+
+5. In the HatinTime_AP folder, navigate to `Binaries/Win64` and create a new file: `steam_appid.txt`. 
+In this new text file, input the number **253230** on the first line.
+
+
+6. Create a shortcut of `HatinTimeGame.exe` from that folder and move it to wherever you'd like. 
+You will use this shortcut to open the Archipelago-compatible version of A Hat in Time.
+
+
+7. Start up the game using your new shortcut. To confirm if you are on the correct version, 
+go to Settings -> Game Settings. If you don't see an option labelled ***Live Game Events*** you should be running 
+the correct version of the game. In Game Settings, make sure ***Enable Developer Console*** is checked.
+
+
+## Connecting to the Archipelago server
+
+To connect to the multiworld server, simply run the **ArchipelagoAHITClient** 
+(or run it from the Launcher if you have the apworld installed) and connect it to the Archipelago server. 
+The game will connect to the client automatically when you create a new save file.
+
+
+## Console Commands
+
+Commands will not work on the title screen, you must be in-game to use them. To use console commands, 
+make sure ***Enable Developer Console*** is checked in Game Settings and press the tilde key or TAB while in-game.
+
+`ap_say <message>` - Send a chat message to the server. Supports commands, such as `!hint` or `!release`.
+
+`ap_deathlink` - Toggle Death Link.
+
+
+## FAQ/Common Issues
+### I followed the setup, but I receive an odd error message upon starting the game or creating a save file!
+If you receive an error message such as 
+**"Failed to find default engine .ini to retrieve My Documents subdirectory to use. Force quitting."** or
+**"Failed to load map "hub_spaceship"** after booting up the game or creating a save file respectively, then the depot
+download was likely corrupted. The only way to fix this is to start the entire download all over again.
+Unfortunately, this appears to be an underlying issue with Steam's depot downloader. The only way to really prevent this
+from happening is to ensure that your connection is not interrupted or slowed while downloading.
+
+### The game keeps crashing on startup after the splash screen!
+This issue is unfortunately very hard to fix, and the underlying cause is not known. If it does happen however,
+try the following:
+
+- Close Steam **entirely**.
+- Open the downpatched version of the game (with Steam closed) and allow it to load to the titlescreen.
+- Close the game, and then open Steam again. 
+- After launching the game, the issue should hopefully disappear. If not, repeat the above steps until it does.
+
+### I followed the setup, but "Live Game Events" still shows up in the options menu!
+The most common cause of this is the `steam_appid.txt` file. If you're on Windows 10, file extensions are hidden by 
+default (thanks Microsoft). You likely made the mistake of still naming the file `steam_appid.txt`, which, since file 
+extensions are hidden, would result in the file being named `steam_appid.txt.txt`, which is incorrect. 
+To show file extensions in Windows 10, open any folder, click the View tab at the top, and check
+"File name extensions". Then you can correct the name of the file. If the name of the file is correct, 
+and you're still running into the issue, re-read the setup guide again in case you missed a step. 
+If you still can't get it to work, ask for help in the Discord thread.
+
+### The game is running on the older version, but it's not connecting when starting a new save!
+For unknown reasons, the mod will randomly disable itself in the mod menu. To fix this, go to the Mods menu 
+(rocket icon) in-game, and re-enable the mod.
+
+### Why do relics disappear from the stands in the Spaceship after they're completed?
+This is intentional behaviour. Because of how randomizer logic works, there is no way to predict the order that 
+a player will place their relics. Since there are a limited amount of relic stands in the Spaceship, relics are removed 
+after being completed to allow for the placement of more relics without being potentially locked out. 
+The level that the relic set unlocked will stay unlocked.
+
+### When I start a new save file, the intro cinematic doesn't get skipped, Hat Kid's body is missing and the mod doesn't work!
+There is a bug on older versions of A Hat in Time that causes save file creation to fail to work properly 
+if you have too many save files. Delete them and it should fix the problem.

worlds/ahit/test/__init__.py

@@ -0,0 +1,5 @@
+from test.bases import WorldTestBase
+
+
+class HatInTimeTestBase(WorldTestBase):
+    game = "A Hat in Time"

worlds/ahit/test/test_acts.py

@@ -0,0 +1,31 @@
+from ..Regions import act_chapters
+from ..Rules import act_connections
+from . import HatInTimeTestBase
+
+
+class TestActs(HatInTimeTestBase):
+    run_default_tests = False
+
+    options = {
+        "ActRandomizer": 2,
+        "EnableDLC1": 1,
+        "EnableDLC2": 1,
+        "ShuffleActContracts": 0,
+    }
+
+    def test_act_shuffle(self):
+        for i in range(300):
+            self.world_setup()
+            self.collect_all_but([""])
+
+            for name in act_chapters.keys():
+                region = self.multiworld.get_region(name, 1)
+                for entrance in region.entrances:
+                    if entrance.name in act_connections.keys():
+                        continue
+
+                    self.assertTrue(self.can_reach_entrance(entrance.name),
+                                    f"Can't reach {name} from {entrance}\n"
+                                    f"{entrance.parent_region.entrances[0]} -> {entrance.parent_region} "
+                                    f"-> {entrance} -> {name}"
+                                    f" (expected method of access)")

worlds/alttp/Rules.py

@@ -399,8 +399,8 @@ def global_rules(multiworld: MultiWorld, player: int):
     set_rule(multiworld.get_entrance('Swamp Palace (North)', player), lambda state: state.has('Hookshot', player) and state._lttp_has_key('Small Key (Swamp Palace)', player, 5))
     if not multiworld.small_key_shuffle[player] and multiworld.glitches_required[player] not in ['hybrid_major_glitches', 'no_logic']:
         forbid_item(multiworld.get_location('Swamp Palace - Entrance', player), 'Big Key (Swamp Palace)', player)
-    set_rule(multiworld.get_location('Swamp Palace - Prize', player), lambda state: state._lttp_has_key('Small Key (Swamp Palace)', player, 6))
-    set_rule(multiworld.get_location('Swamp Palace - Boss', player), lambda state: state._lttp_has_key('Small Key (Swamp Palace)', player, 6))
+    add_rule(multiworld.get_location('Swamp Palace - Prize', player), lambda state: state._lttp_has_key('Small Key (Swamp Palace)', player, 6))
+    add_rule(multiworld.get_location('Swamp Palace - Boss', player), lambda state: state._lttp_has_key('Small Key (Swamp Palace)', player, 6))
     if multiworld.pot_shuffle[player]:
         # key can (and probably will) be moved behind bombable wall
         set_rule(multiworld.get_location('Swamp Palace - Waterway Pot Key', player), lambda state: can_use_bombs(state, player))

worlds/aquaria/Items.py

@@ -8,14 +8,16 @@ from typing import Optional
 from enum import Enum
 from BaseClasses import Item, ItemClassification
 
+
 class ItemType(Enum):
     """
-    Used to indicate to the multi-world if an item is usefull or not
+    Used to indicate to the multi-world if an item is useful or not
     """
     NORMAL = 0
     PROGRESSION = 1
     JUNK = 2
 
+
 class ItemGroup(Enum):
     """
     Used to group items
@@ -28,6 +30,7 @@ class ItemGroup(Enum):
     SONG = 5
     TURTLE = 6
 
+
 class AquariaItem(Item):
     """
     A single item in the Aquaria game.
@@ -40,22 +43,23 @@ class AquariaItem(Item):
         """
         Initialisation of the Item
         :param name: The name of the item
-        :param classification: If the item is usefull or not
+        :param classification: If the item is useful or not
         :param code: The ID of the item (if None, it is an event)
         :param player: The ID of the player in the multiworld
         """
         super().__init__(name, classification, code, player)
 
+
 class ItemData:
     """
     Data of an item.
     """
-    id:int
-    count:int
-    type:ItemType
-    group:ItemGroup
+    id: int
+    count: int
+    type: ItemType
+    group: ItemGroup
 
-    def __init__(self, id:int, count:int, type:ItemType, group:ItemGroup):
+    def __init__(self, id: int, count: int, type: ItemType, group: ItemGroup):
         """
         Initialisation of the item data
         @param id: The item ID
@@ -68,6 +72,7 @@ class ItemData:
         self.type = type
         self.group = group
 
+
 """Information data for every (not event) item."""
 item_table = {
     #       name:           ID,    Nb,   Item Type,        Item Group
@@ -207,4 +212,3 @@ item_table = {
     "Transturtle Simon says": ItemData(698132, 1, ItemType.PROGRESSION, ItemGroup.TURTLE),  # transport_forest05
     "Transturtle Arnassi ruins": ItemData(698133, 1, ItemType.PROGRESSION, ItemGroup.TURTLE),  # transport_seahorse
 }
-

worlds/aquaria/Locations.py

@@ -43,7 +43,7 @@ class AquariaLocations:
 
     locations_home_water = {
         "Home water, bulb below the grouper fish": 698058,
-        "Home water, bulb in the path bellow Nautilus Prime": 698059,
+        "Home water, bulb in the path below Nautilus Prime": 698059,
         "Home water, bulb in the little room above the grouper fish": 698060,
         "Home water, bulb in the end of the left path from the verse cave": 698061,
         "Home water, bulb in the top left path": 698062,
@@ -129,7 +129,7 @@ class AquariaLocations:
 
     locations_openwater_bl = {
         "Open water bottom left area, bulb behind the chomper fish": 698011,
-        "Open water bottom left area, bulb inside the downest fish pass": 698010,
+        "Open water bottom left area, bulb inside the lowest fish pass": 698010,
     }
 
     locations_skeleton_path = {
@@ -226,7 +226,7 @@ class AquariaLocations:
         "Mithalas cathedral, third urn in the path behind the flesh vein": 698146,
         "Mithalas cathedral, one of the urns in the top right room": 698147,
         "Mithalas cathedral, Mithalan Dress": 698189,
-        "Mithalas cathedral right area, urn bellow the left entrance": 698198,
+        "Mithalas cathedral right area, urn below the left entrance": 698198,
     }
 
     locations_cathedral_underground = {
@@ -457,7 +457,7 @@ class AquariaLocations:
     locations_body_l = {
         "The body left area, first bulb in the top face room": 698066,
         "The body left area, second bulb in the top face room": 698069,
-        "The body left area, bulb bellow the water stream": 698067,
+        "The body left area, bulb below the water stream": 698067,
         "The body left area, bulb in the top path to the top face room": 698068,
         "The body left area, bulb in the bottom face room": 698070,
     }

worlds/aquaria/Options.py

@@ -10,9 +10,8 @@ from Options import Toggle, Choice, Range, DeathLink, PerGameCommonOptions, Defa
 
 class IngredientRandomizer(Choice):
     """
-    Randomize Ingredients. Select if the simple ingredients (that does not have
-    a recipe) should be randomized. If 'common_ingredients' is selected, the
-    randomization will exclude the "Red Bulb", "Special Bulb" and "Rukh Egg".
+    Select if the simple ingredients (that do not have a recipe) should be randomized.
+    If "Common Ingredients" is selected, the randomization will exclude the "Red Bulb", "Special Bulb" and "Rukh Egg".
     """
     display_name = "Randomize Ingredients"
     option_off = 0
@@ -29,27 +28,25 @@ class DishRandomizer(Toggle):
 class TurtleRandomizer(Choice):
     """Randomize the transportation turtle."""
     display_name = "Turtle Randomizer"
-    option_no_turtle_randomization = 0
-    option_randomize_all_turtle = 1
-    option_randomize_turtle_other_than_the_final_one = 2
+    option_none = 0
+    option_all = 1
+    option_all_except_final = 2
     default = 2
 
 
 class EarlyEnergyForm(DefaultOnToggle):
-    """
-    Force the Energy Form to be in a location before leaving the areas around the Home Water.
-    """
+    """ Force the Energy Form to be in a location early in the game """
     display_name = "Early Energy Form"
 
 
 class AquarianTranslation(Toggle):
-    """Translate to English the Aquarian scripture in the game."""
+    """Translate the Aquarian scripture in the game into English."""
     display_name = "Translate Aquarian"
 
 
 class BigBossesToBeat(Range):
     """
-    A number of big bosses to beat before having access to the creator (the final boss). The big bosses are
+    The number of big bosses to beat before having access to the creator (the final boss). The big bosses are
     "Fallen God", "Mithalan God", "Drunian God", "Sun God" and "The Golem".
     """
     display_name = "Big bosses to beat"
@@ -60,12 +57,12 @@ class BigBossesToBeat(Range):
 
 class MiniBossesToBeat(Range):
     """
-    A number of Minibosses to beat before having access to the creator (the final boss). Mini bosses are
+    The number of minibosses to beat before having access to the creator (the final boss). The minibosses are
     "Nautilus Prime", "Blaster Peg Prime", "Mergog", "Mithalan priests", "Octopus Prime", "Crabbius Maximus",
-    "Mantis Shrimp Prime" and "King Jellyfish God Prime". Note that the Energy statue and Simon says are not
-    mini bosses.
+    "Mantis Shrimp Prime" and "King Jellyfish God Prime".
+    Note that the Energy Statue and Simon Says are not minibosses.
     """
-    display_name = "Mini bosses to beat"
+    display_name = "Minibosses to beat"
     range_start = 0
     range_end = 8
     default = 0
@@ -73,47 +70,50 @@ class MiniBossesToBeat(Range):
 
 class Objective(Choice):
     """
-    The game objective can be only to kill the creator or to kill the creator
-    and having obtained the three every secret memories
+    The game objective can be to kill the creator or to kill the creator after obtaining all three secret memories.
     """
     display_name = "Objective"
     option_kill_the_creator = 0
     option_obtain_secrets_and_kill_the_creator = 1
     default = 0
 
+
 class SkipFirstVision(Toggle):
     """
-    The first vision in the game; where Naija transform to Energy Form and get fload by enemy; is quite cool but
+    The first vision in the game, where Naija transforms into Energy Form and gets flooded by enemies, is quite cool but
     can be quite long when you already know what is going on. This option can be used to skip this vision.
     """
-    display_name = "Skip first Naija's vision"
+    display_name = "Skip Naija's first vision"
+
 
 class NoProgressionHardOrHiddenLocation(Toggle):
     """
-    Make sure that there is no progression items at hard to get or hard to find locations.
-    Those locations that will be very High location (that need beast form, soup and skill to get), every
-    location in the bubble cave, locations that need you to cross a false wall without any indication, Arnassi
-    race, bosses and mini-bosses. Usefull for those that want a casual run.
+    Make sure that there are no progression items at hard-to-reach or hard-to-find locations.
+    Those locations are very High locations (that need beast form, soup and skill to get),
+    every location in the bubble cave, locations where need you to cross a false wall without any indication,
+    the Arnassi race, bosses and minibosses. Useful for those that want a more casual run.
     """
     display_name = "No progression in hard or hidden locations"
 
+
 class LightNeededToGetToDarkPlaces(DefaultOnToggle):
     """
-    Make sure that the sun form or the dumbo pet can be aquired before getting to dark places. Be aware that navigating
-    in dark place without light is extremely difficult.
+    Make sure that the sun form or the dumbo pet can be acquired before getting to dark places.
+    Be aware that navigating in dark places without light is extremely difficult.
     """
     display_name = "Light needed to get to dark places"
 
+
 class BindSongNeededToGetUnderRockBulb(Toggle):
     """
-    Make sure that the bind song can be aquired before having to obtain sing bulb under rocks.
+    Make sure that the bind song can be acquired before having to obtain sing bulbs under rocks.
     """
     display_name = "Bind song needed to get sing bulbs under rocks"
 
 
 class UnconfineHomeWater(Choice):
     """
-    Open the way out of Home water area so that Naija can go to open water and beyond without the bind song.
+    Open the way out of the Home water area so that Naija can go to open water and beyond without the bind song.
     """
     display_name = "Unconfine Home Water Area"
     option_off = 0

worlds/aquaria/Regions.py

@@ -5,7 +5,7 @@ Description: Used to manage Regions in the Aquaria game multiworld randomizer
 """
 
 from typing import Dict, Optional
-from BaseClasses import MultiWorld, Region, Entrance, ItemClassification, LocationProgressType, CollectionState
+from BaseClasses import MultiWorld, Region, Entrance, ItemClassification, CollectionState
 from .Items import AquariaItem
 from .Locations import AquariaLocations, AquariaLocation
 from .Options import AquariaOptions
@@ -223,8 +223,6 @@ class AquariaRegions:
             region.add_locations(locations, AquariaLocation)
         return region
 
-
-
     def __create_home_water_area(self) -> None:
         """
         Create the `verse_cave`, `home_water` and `song_cave*` regions
@@ -941,7 +939,7 @@ class AquariaRegions:
         """
         Add secrets events to the `world`
         """
-        self.__add_event_location(self.first_secret, # Doit ajouter une région pour le "first secret"
+        self.__add_event_location(self.first_secret,  # Doit ajouter une région pour le "first secret"
                                   "First secret",
                                   "First secret obtained")
         self.__add_event_location(self.mithalas_city,
@@ -1095,12 +1093,10 @@ class AquariaRegions:
         add_rule(self.multiworld.get_entrance("Veil left of sun temple to Sun temple left area", self.player),
                  lambda state: _has_light(state, self.player) or _has_sun_crystal(state, self.player))
 
-
-
     def __adjusting_manual_rules(self) -> None:
         add_rule(self.multiworld.get_location("Mithalas cathedral, Mithalan Dress", self.player),
                  lambda state: _has_beast_form(state, self.player))
-        add_rule(self.multiworld.get_location("Open water bottom left area, bulb inside the downest fish pass", self.player),
+        add_rule(self.multiworld.get_location("Open water bottom left area, bulb inside the lowest fish pass", self.player),
                  lambda state: _has_fish_form(state, self.player))
         add_rule(self.multiworld.get_location("Kelp forest bottom left area, Walker baby", self.player),
                  lambda state: _has_spirit_form(state, self.player))
@@ -1122,7 +1118,7 @@ class AquariaRegions:
                                          self.player), lambda state: _has_energy_form(state, self.player))
         add_rule(self.multiworld.get_location("Home water, bulb in the bottom left room", self.player),
                  lambda state: _has_bind_song(state, self.player))
-        add_rule(self.multiworld.get_location("Home water, bulb in the path bellow Nautilus Prime", self.player),
+        add_rule(self.multiworld.get_location("Home water, bulb in the path below Nautilus Prime", self.player),
                  lambda state: _has_bind_song(state, self.player))
         add_rule(self.multiworld.get_location("Naija's home, bulb after the energy door", self.player),
                  lambda state: _has_energy_form(state, self.player))
@@ -1133,9 +1129,6 @@ class AquariaRegions:
                  lambda state: _has_fish_form(state, self.player) and
                                _has_spirit_form(state, self.player))
 
-
-
-
     def __no_progression_hard_or_hidden_location(self) -> None:
         self.multiworld.get_location("Energy temple boss area, Fallen god tooth",
                                      self.player).item_rule =\
@@ -1242,11 +1235,7 @@ class AquariaRegions:
             add_rule(self.multiworld.get_entrance("Home Water to Open water top left area", self.player),
                      lambda state: _has_bind_song(state, self.player) and _has_energy_form(state, self.player))
         if options.early_energy_form:
-            add_rule(self.multiworld.get_entrance("Home Water to Home water transturtle room", self.player),
-                     lambda state: _has_energy_form(state, self.player))
-        if options.early_energy_form:
-            add_rule(self.multiworld.get_entrance("Home Water to Open water top left area", self.player),
-                     lambda state: _has_energy_form(state, self.player))
+            self.multiworld.early_items[self.player]["Energy form"] = 1
 
         if options.no_progression_hard_or_hidden_locations:
             self.__no_progression_hard_or_hidden_location()

worlds/aquaria/__init__.py

@@ -5,7 +5,7 @@ Description: Main module for Aquaria game multiworld randomizer
 """
 
 from typing import List, Dict, ClassVar, Any
-from ..AutoWorld import World, WebWorld
+from worlds.AutoWorld import World, WebWorld
 from BaseClasses import Tutorial, MultiWorld, ItemClassification
 from .Items import item_table, AquariaItem, ItemType, ItemGroup
 from .Locations import location_table
@@ -114,7 +114,7 @@ class AquariaWorld(World):
 
     def create_item(self, name: str) -> AquariaItem:
         """
-        Create an AquariaItem using `name' as item name.
+        Create an AquariaItem using 'name' as item name.
         """
         result: AquariaItem
         try:

worlds/aquaria/docs/en_Aquaria.md

@@ -11,39 +11,39 @@ options page link: [Aquaria Player Options Page](../player-options).
 ## What does randomization do to this game?
 The locations in the randomizer are:
 
-- All sing bulbs;
-- All Mithalas Urns;
-- All Sunken City crates;
-- Collectible treasure locations (including pet eggs and costumes);
-- Beating Simon says;
-- Li cave;
-- Every Transportation Turtle (also called transturtle);
-- Locations where you get songs,
-  * Erulian spirit cristal,
-  * Energy status mini-boss,
-  * Beating Mithalan God boss,
-  * Fish cave puzzle,
-  * Beating Drunian God boss,
-  * Beating Sun God boss,
-  * Breaking Li cage in the body
+- All sing bulbs
+- All Mithalas Urns
+- All Sunken City crates
+- Collectible treasure locations (including pet eggs and costumes)
+- Beating Simon says
+- Li cave
+- Every Transportation Turtle (also called transturtle)
+- Locations where you get songs:
+    * Erulian spirit cristal
+    * Energy status mini-boss
+    * Beating Mithalan God boss
+    * Fish cave puzzle
+    * Beating Drunian God boss
+    * Beating Sun God boss
+    * Breaking Li cage in the body
 
 Note that, unlike the vanilla game, when opening sing bulbs, Mithalas urns and Sunken City crates,
-nothing will come out of them. The moment those bulbs, urns and crates are opened, the location is considered received.
+nothing will come out of them. The moment those bulbs, urns and crates are opened, the location is considered checked.
 
 The items in the randomizer are:
-- Dishes (used to learn recipes*);
-- Some ingredients;
-- The Wok (third plate used to cook 3 ingredients recipes everywhere);
-- All collectible treasure (including pet eggs and costumes);
-- Li and Li song;
-- All songs (other than Li's song since it is learned when Li is obtained);
-- Transportation to transturtles.
+- Dishes (used to learn recipes)<sup>*</sup>
+- Some ingredients
+- The Wok (third plate used to cook 3-ingredient recipes everywhere)
+- All collectible treasure (including pet eggs and costumes)
+- Li and Li's song
+- All songs (other than Li's song since it is learned when Li is obtained)
+- Transportation to transturtles
 
 Also, there is the option to randomize every ingredient drops (from fishes, monsters
 or plants).
 
-*Note that, unlike in the vanilla game, the recipes for dishes (other than the Sea Loaf)
-cannot be cooked (and learn) before being obtained as randomized items. Also, enemies and plants
+<sup>*</sup> Note that, unlike in the vanilla game, the recipes for dishes (other than the Sea Loaf)
+cannot be cooked (or learned) before being obtained as randomized items. Also, enemies and plants
 that drop dishes that have not been learned before will drop ingredients of this dish instead.
 
 ## What is the goal of the game?
@@ -57,8 +57,8 @@ Any items specified above can be in another player's world.
 No visuals are shown when finding locations other than collectible treasure.
 For those treasures, the visual of the treasure is visually unchanged.
 After collecting a location check, a message will be shown to inform the player
-what has been collected, and who will receive it.
+what has been collected and who will receive it.
 
 ## When the player receives an item, what happens?
 When you receive an item, a message will pop up to inform you where you received
-the item from, and which one it is.
+the item from and which one it was.

worlds/aquaria/docs/setup_en.md

@@ -2,9 +2,12 @@
 
 ## Required Software
 
-- The original Aquaria Game (buyable from a lot of online game seller);
+- The original Aquaria Game (purchasable from most online game stores)
 - The [Aquaria randomizer](https://github.com/tioui/Aquaria_Randomizer/releases)
-- Optional, for sending [commands](/tutorial/Archipelago/commands/en) like `!hint`: the TextClient from [the most recent Archipelago release](https://github.com/ArchipelagoMW/Archipelago/releases)
+
+## Optional Software
+ 
+- For sending [commands](/tutorial/Archipelago/commands/en) like `!hint`: the TextClient from [the most recent Archipelago release](https://github.com/ArchipelagoMW/Archipelago/releases)
 
 ## Installation and execution Procedures
 
@@ -13,10 +16,9 @@
 First, you should copy the original Aquaria folder game. The randomizer will possibly modify the game so that
 the original game will stop working. Copying the folder will guarantee that the original game keeps on working.
 Also, in Windows, the save files are stored in the Aquaria folder. So copying the Aquaria folder for every Multiworld
-game you play will make sure that every game has their own save game.
+game you play will make sure that every game has its own save game.
 
-Unzip the Aquaria randomizer release and copy all unzipped files in the Aquaria game folder. The unzipped files
-are those:
+Unzip the Aquaria randomizer release and copy all unzipped files in the Aquaria game folder. The unzipped files are:
 - aquaria_randomizer.exe
 - OpenAL32.dll
 - override (directory)
@@ -25,11 +27,11 @@ are those:
 - wrap_oal.dll
 - cacert.pem
 
-If there is a conflict between file in the original game folder and the unzipped files, you should override
-the original files with the one of the unzipped randomizer.
+If there is a conflict between files in the original game folder and the unzipped files, you should overwrite
+the original files with the ones from the unzipped randomizer.
 
 Finally, to launch the randomizer, you must use the command line interface (you can open the command line interface
-by writing `cmd` in the address bar of the Windows file explorer). Here is the command line to use to start the
+by typing `cmd` in the address bar of the Windows File Explorer). Here is the command line used to start the
 randomizer:
 
 ```bash
@@ -44,8 +46,8 @@ aquaria_randomizer.exe  --name YourName --server theServer:thePort --password th
 
 ### Linux when using the AppImage
 
-If you use the AppImage, just copy it in the Aquaria game folder. You then have to make it executable. You
-can do that from command line by using 
+If you use the AppImage, just copy it into the Aquaria game folder. You then have to make it executable. You
+can do that from command line by using:
 
 ```bash
 chmod +x Aquaria_Randomizer-*.AppImage
@@ -65,7 +67,7 @@ or, if the room has a password:
 ./Aquaria_Randomizer-*.AppImage --name YourName --server theServer:thePort --password thePassword
 ```
 
-Note that you should not have multiple Aquaria_Randomizer AppImage file in the same folder. If this situation occurred,
+Note that you should not have multiple Aquaria_Randomizer AppImage file in the same folder. If this situation occurs,
 the preceding commands will launch the game multiple times.
 
 ### Linux when using the tar file
@@ -73,24 +75,23 @@ the preceding commands will launch the game multiple times.
 First, you should copy the original Aquaria folder game. The randomizer will possibly modify the game so that
 the original game will stop working. Copying the folder will guarantee that the original game keeps on working.
 
-Untar the Aquaria randomizer release and copy all extracted files in the Aquaria game folder. The extracted
-files are those:
+Untar the Aquaria randomizer release and copy all extracted files in the Aquaria game folder. The extracted files are:
 - aquaria_randomizer
 - override (directory)
 - usersettings.xml
 - cacert.pem
 
-If there is a conflict between file in the original game folder and the extracted files, you should override
-the original files with the one of the extracted randomizer files.
+If there is a conflict between files in the original game folder and the extracted files, you should overwrite
+the original files with the ones from the extracted randomizer files.
 
-Then, you should use your system package manager to install liblua5, libogg, libvorbis, libopenal and libsdl2.
+Then, you should use your system package manager to install `liblua5`, `libogg`, `libvorbis`, `libopenal` and `libsdl2`.
 On Debian base system (like Ubuntu), you can use the following command:
 
 ```bash
 sudo apt install liblua5.1-0-dev libogg-dev libvorbis-dev libopenal-dev libsdl2-dev
 ```
 
-Also, if there is some `.so` files in the Aquaria original game folder (`libgcc_s.so.1`, `libopenal.so.1`,
+Also, if there are certain `.so` files in the original Aquaria game folder (`libgcc_s.so.1`, `libopenal.so.1`,
 `libSDL-1.2.so.0` and `libstdc++.so.6`), you should remove them from the Aquaria Randomizer game folder. Those are
 old libraries that will not work on the recent build of the randomizer.
 
@@ -106,7 +107,7 @@ or, if the room has a password:
 ./aquaria_randomizer --name YourName --server theServer:thePort --password thePassword
 ```
 
-Note: If you have a permission denied error when using the command line, you can use this command line to be
+Note: If you get a permission denied error when using the command line, you can use this command to be
 sure that your executable has executable permission:
 
 ```bash

worlds/aquaria/test/__init__.py

@@ -25,7 +25,7 @@ after_home_water_locations = [
     "Open water top right area, bulb in the turtle room",
     "Open water top right area, Transturtle",
     "Open water bottom left area, bulb behind the chomper fish",
-    "Open water bottom left area, bulb inside the downest fish pass",
+    "Open water bottom left area, bulb inside the lowest fish pass",
     "Open water skeleton path, bulb close to the right exit",
     "Open water skeleton path, bulb behind the chomper fish",
     "Open water skeleton path, King skull",
@@ -82,7 +82,7 @@ after_home_water_locations = [
     "Mithalas cathedral, third urn in the path behind the flesh vein",
     "Mithalas cathedral, one of the urns in the top right room",
     "Mithalas cathedral, Mithalan Dress",
-    "Mithalas cathedral right area, urn bellow the left entrance",
+    "Mithalas cathedral right area, urn below the left entrance",
     "Cathedral underground, bulb in the center part",
     "Cathedral underground, first bulb in the top left part",
     "Cathedral underground, second bulb in the top left part",
@@ -178,7 +178,7 @@ after_home_water_locations = [
     "The body main area, bulb on the main path blocking tube",
     "The body left area, first bulb in the top face room",
     "The body left area, second bulb in the top face room",
-    "The body left area, bulb bellow the water stream",
+    "The body left area, bulb below the water stream",
     "The body left area, bulb in the top path to the top face room",
     "The body left area, bulb in the bottom face room",
     "The body right area, bulb in the top face room",

worlds/aquaria/test/test_bind_song_access.py

@@ -18,7 +18,7 @@ class BindSongAccessTest(AquariaTestBase):
         """Test locations that require Bind song"""
         locations = [
             "Verse cave right area, Big Seed",
-            "Home water, bulb in the path bellow Nautilus Prime",
+            "Home water, bulb in the path below Nautilus Prime",
             "Home water, bulb in the bottom left room",
             "Home water, Nautilus Egg",
             "Song cave, Verse egg",

worlds/aquaria/test/test_bind_song_option_access.py

@@ -24,7 +24,7 @@ class BindSongOptionAccessTest(AquariaTestBase):
             "Song cave, bulb under the rock close to the song door",
             "Song cave, bulb under the rock in the path to the singing statues",
             "Naija's home, bulb under the rock at the right of the main path",
-            "Home water, bulb in the path bellow Nautilus Prime",
+            "Home water, bulb in the path below Nautilus Prime",
             "Home water, bulb in the bottom left room",
             "Home water, Nautilus Egg",
             "Song cave, Verse egg",

worlds/aquaria/test/test_energy_form_access.py

@@ -39,7 +39,7 @@ class EnergyFormAccessTest(AquariaTestBase):
             "Mithalas cathedral, third urn in the path behind the flesh vein",
             "Mithalas cathedral, one of the urns in the top right room",
             "Mithalas cathedral, Mithalan Dress",
-            "Mithalas cathedral right area, urn bellow the left entrance",
+            "Mithalas cathedral right area, urn below the left entrance",
             "Cathedral boss area, beating Mithalan God",
             "Kelp Forest top left area, bulb close to the Verse egg",
             "Kelp forest top left area, Verse egg",
@@ -67,7 +67,6 @@ class EnergyFormAccessTest(AquariaTestBase):
             "First secret",
             "Sunken City cleared",
             "Objective complete",
-
         ]
         items = [["Energy form"]]
         self.assertAccessDependency(locations, items)

worlds/aquaria/test/test_energy_form_access_option.py

@@ -1,31 +0,0 @@
-"""
-Author: Louis M
-Date: Thu, 18 Apr 2024 18:45:56 +0000
-Description: Unit test used to test accessibility of locations with and without the bind song (with the early
-             energy form option)
-"""
-
-from worlds.aquaria.test import AquariaTestBase, after_home_water_locations
-
-
-class EnergyFormAccessTest(AquariaTestBase):
-    """Unit test used to test accessibility of locations with and without the energy form"""
-    options = {
-        "early_energy_form": True,
-    }
-
-    def test_energy_form_location(self) -> None:
-        """Test locations that require Energy form with early energy song enable"""
-        locations = [
-            "Home water, Nautilus Egg",
-            "Naija's home, bulb after the energy door",
-            "Energy temple first area, bulb in the bottom room blocked by a rock",
-            "Energy temple second area, bulb under the rock",
-            "Energy temple bottom entrance, Krotite armor",
-            "Energy temple third area, bulb in the bottom path",
-            "Energy temple boss area, Fallen god tooth",
-            "Energy temple blaster room, Blaster egg",
-            *after_home_water_locations
-        ]
-        items = [["Energy form"]]
-        self.assertAccessDependency(locations, items)

worlds/aquaria/test/test_fish_form_access.py

@@ -21,7 +21,7 @@ class FishFormAccessTest(AquariaTestBase):
             "Mithalas city, urn inside a home fish pass",
             "Kelp Forest top right area, bulb in the top fish pass",
             "The veil bottom area, Verse egg",
-            "Open water bottom left area, bulb inside the downest fish pass",
+            "Open water bottom left area, bulb inside the lowest fish pass",
             "Kelp Forest top left area, bulb close to the Verse egg",
             "Kelp forest top left area, Verse egg",
             "Mermog cave, bulb in the left part of the cave",

worlds/aquaria/test/test_li_song_access.py

@@ -27,7 +27,7 @@ class LiAccessTest(AquariaTestBase):
             "The body main area, bulb on the main path blocking tube",
             "The body left area, first bulb in the top face room",
             "The body left area, second bulb in the top face room",
-            "The body left area, bulb bellow the water stream",
+            "The body left area, bulb below the water stream",
             "The body left area, bulb in the top path to the top face room",
             "The body left area, bulb in the bottom face room",
             "The body right area, bulb in the top face room",

worlds/aquaria/test/test_nature_form_access.py

@@ -41,7 +41,7 @@ class NatureFormAccessTest(AquariaTestBase):
             "The body main area, bulb on the main path blocking tube",
             "The body left area, first bulb in the top face room",
             "The body left area, second bulb in the top face room",
-            "The body left area, bulb bellow the water stream",
+            "The body left area, bulb below the water stream",
             "The body left area, bulb in the top path to the top face room",
             "The body left area, bulb in the bottom face room",
             "The body right area, bulb in the top face room",

worlds/factorio/requirements.txt

@@ -1,2 +1 @@
-factorio-rcon-py>=2.1.1; python_version >= '3.9'
-factorio-rcon-py==2.0.1; python_version <= '3.8'
+factorio-rcon-py>=2.1.2

worlds/lingo/player_logic.py

@@ -2,7 +2,7 @@ from enum import Enum
 from typing import Dict, List, NamedTuple, Optional, Set, Tuple, TYPE_CHECKING
 
 from Options import OptionError
-from .datatypes import Door, DoorType, RoomAndDoor, RoomAndPanel
+from .datatypes import Door, DoorType, Painting, RoomAndDoor, RoomAndPanel
 from .items import ALL_ITEM_TABLE, ItemType
 from .locations import ALL_LOCATION_TABLE, LocationClassification
 from .options import LocationChecks, ShuffleDoors, SunwarpAccess, VictoryCondition
@@ -361,13 +361,29 @@ class LingoPlayerLogic:
         if door_shuffle == ShuffleDoors.option_none:
             required_painting_rooms += REQUIRED_PAINTING_WHEN_NO_DOORS_ROOMS
             req_exits = [painting_id for painting_id, painting in PAINTINGS.items() if painting.required_when_no_doors]
-            req_enterable = [painting_id for painting_id, painting in PAINTINGS.items()
-                             if not painting.exit_only and not painting.disable and not painting.req_blocked and
-                             not painting.req_blocked_when_no_doors and painting.room not in required_painting_rooms]
-        else:
-            req_enterable = [painting_id for painting_id, painting in PAINTINGS.items()
-                             if not painting.exit_only and not painting.disable and not painting.req_blocked and
-                             painting.room not in required_painting_rooms]
+
+        def is_req_enterable(painting_id: str, painting: Painting) -> bool:
+            if painting.exit_only or painting.disable or painting.req_blocked\
+                    or painting.room in required_painting_rooms:
+                return False
+
+            if world.options.shuffle_doors == ShuffleDoors.option_none:
+                if painting.req_blocked_when_no_doors:
+                    return False
+
+                # Special case for the paintings in Color Hunt and Champion's Rest. These are req blocked when not on
+                # doors mode, and when sunwarps are disabled or sunwarp shuffle is on and the Color Hunt sunwarp is not
+                # an exit. This is because these two rooms would then be inaccessible without roof access, and we can't
+                # hide the Owl Hallway entrance behind roof access.
+                if painting.room in ["Color Hunt", "Champion's Rest"]:
+                    if world.options.sunwarp_access == SunwarpAccess.option_disabled\
+                            or (world.options.shuffle_sunwarps and "Color Hunt" not in self.sunwarp_exits):
+                        return False
+
+            return True
+
+        req_enterable = [painting_id for painting_id, painting in PAINTINGS.items()
+                         if is_req_enterable(painting_id, painting)]
         req_exits += [painting_id for painting_id, painting in PAINTINGS.items()
                       if painting.exit_only and painting.required]
         req_entrances = world.random.sample(req_enterable, len(req_exits))

worlds/subnautica/options.py

@@ -120,7 +120,7 @@ class FillerItemsDistribution(ItemDict):
     """Random chance weights of various filler resources that can be obtained.
     Available items: """
     __doc__ += ", ".join(f"\"{item_name}\"" for item_name in item_names_by_type[ItemType.resource])
-    _valid_keys = frozenset(item_names_by_type[ItemType.resource])
+    valid_keys = sorted(item_names_by_type[ItemType.resource])
     default = {item_name: 1 for item_name in item_names_by_type[ItemType.resource]}
     display_name = "Filler Items Distribution"
 

worlds/tunic/er_rules.py

@@ -268,7 +268,8 @@ def set_er_region_rules(world: "TunicWorld", ability_unlocks: Dict[str, int], re
         connecting_region=regions["Overworld Well Ladder"],
         rule=lambda state: has_ladder("Ladders in Well", state, player, options))
     regions["Overworld Well Ladder"].connect(
-        connecting_region=regions["Overworld"])
+        connecting_region=regions["Overworld"],
+        rule=lambda state: has_ladder("Ladders in Well", state, player, options))
 
     # nmg: can ice grapple through the door
     regions["Overworld"].connect(
@@ -706,17 +707,18 @@ def set_er_region_rules(world: "TunicWorld", ability_unlocks: Dict[str, int], re
         connecting_region=regions["Fortress Exterior from Overworld"])
 
     regions["Beneath the Vault Ladder Exit"].connect(
-        connecting_region=regions["Beneath the Vault Front"],
-        rule=lambda state: has_ladder("Ladder to Beneath the Vault", state, player, options))
-    regions["Beneath the Vault Front"].connect(
+        connecting_region=regions["Beneath the Vault Main"],
+        rule=lambda state: has_ladder("Ladder to Beneath the Vault", state, player, options)
+        and has_lantern(state, player, options))
+    regions["Beneath the Vault Main"].connect(
         connecting_region=regions["Beneath the Vault Ladder Exit"],
         rule=lambda state: has_ladder("Ladder to Beneath the Vault", state, player, options))
 
-    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 Main"].connect(
+        connecting_region=regions["Beneath the Vault Back"])
     regions["Beneath the Vault Back"].connect(
-        connecting_region=regions["Beneath the Vault Front"])
+        connecting_region=regions["Beneath the Vault Main"],
+        rule=lambda state: has_lantern(state, player, options))
 
     regions["Fortress East Shortcut Upper"].connect(
         connecting_region=regions["Fortress East Shortcut Lower"])
@@ -870,6 +872,9 @@ def set_er_region_rules(world: "TunicWorld", ability_unlocks: Dict[str, int], re
     regions["Rooted Ziggurat Portal Room Entrance"].connect(
         connecting_region=regions["Rooted Ziggurat Lower Back"])
 
+    regions["Zig Skip Exit"].connect(
+        connecting_region=regions["Rooted Ziggurat Lower Front"])
+
     regions["Rooted Ziggurat Portal"].connect(
         connecting_region=regions["Rooted Ziggurat Portal Room Exit"],
         rule=lambda state: state.has("Activate Ziggurat Fuse", player))
@@ -1453,8 +1458,6 @@ def set_er_location_rules(world: "TunicWorld", ability_unlocks: Dict[str, int])
     # 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),

worlds/tunic/er_scripts.py

@@ -1,12 +1,12 @@
 from typing import Dict, List, Set, TYPE_CHECKING
 from BaseClasses import Region, ItemClassification, Item, Location
 from .locations import location_table
-from .er_data import Portal, tunic_er_regions, portal_mapping, \
-    dependent_regions_restricted, dependent_regions_nmg, dependent_regions_ur
+from .er_data import Portal, tunic_er_regions, portal_mapping, traversal_requirements, DeadEnd
 from .er_rules import set_er_region_rules
 from .options import EntranceRando
 from worlds.generic import PlandoConnection
 from random import Random
+from copy import deepcopy
 
 if TYPE_CHECKING:
     from . import TunicWorld
@@ -95,7 +95,8 @@ def place_event_items(world: "TunicWorld", regions: Dict[str, Region]) -> None:
 
 def vanilla_portals() -> Dict[Portal, Portal]:
     portal_pairs: Dict[Portal, Portal] = {}
-    portal_map = portal_mapping.copy()
+    # we don't want the zig skip exit for vanilla portals, since it shouldn't be considered for logic here
+    portal_map = [portal for portal in portal_mapping if portal.name != "Ziggurat Lower Falling Entrance"]
 
     while portal_map:
         portal1 = portal_map[0]
@@ -130,9 +131,13 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
     dead_ends: List[Portal] = []
     two_plus: List[Portal] = []
     player_name = world.multiworld.get_player_name(world.player)
+    portal_map = portal_mapping.copy()
     logic_rules = world.options.logic_rules.value
     fixed_shop = world.options.fixed_shop
     laurels_location = world.options.laurels_location
+    traversal_reqs = deepcopy(traversal_requirements)
+    has_laurels = True
+    waterfall_plando = False
 
     # if it's not one of the EntranceRando options, it's a custom seed
     if world.options.entrance_rando.value not in EntranceRando.options:
@@ -140,38 +145,53 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
         logic_rules = seed_group["logic_rules"]
         fixed_shop = seed_group["fixed_shop"]
         laurels_location = "10_fairies" if seed_group["laurels_at_10_fairies"] is True else False
-    
+
+    # marking that you don't immediately have laurels
+    if laurels_location == "10_fairies" and not hasattr(world.multiworld, "re_gen_passthrough"):
+        has_laurels = False
+
     shop_scenes: Set[str] = set()
     shop_count = 6
     if fixed_shop:
-        shop_count = 1
+        shop_count = 0
         shop_scenes.add("Overworld Redux")
-
-    if not logic_rules:
-        dependent_regions = dependent_regions_restricted
-    elif logic_rules == 1:
-        dependent_regions = dependent_regions_nmg
     else:
-        dependent_regions = dependent_regions_ur
+        # if fixed shop is off, remove this portal
+        for portal in portal_map:
+            if portal.region == "Zig Skip Exit":
+                portal_map.remove(portal)
+                break
 
     # 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:
+    for portal in portal_map:
+        dead_end_status = tunic_er_regions[portal.region].dead_end
+        if dead_end_status == DeadEnd.free:
+            two_plus.append(portal)
+        elif dead_end_status == DeadEnd.all_cats:
+            dead_ends.append(portal)
+        elif dead_end_status == DeadEnd.restricted:
+            if logic_rules:
                 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)
+                dead_ends.append(portal)
+        # these two get special handling
+        elif dead_end_status == DeadEnd.special:
+            if portal.region == "Secret Gathering Place":
+                if laurels_location == "10_fairies":
+                    two_plus.append(portal)
+                else:
+                    dead_ends.append(portal)
+            if portal.region == "Zig Skip Exit":
+                if fixed_shop:
+                    two_plus.append(portal)
+                else:
+                    dead_ends.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))
+    connected_regions.add(start_region)
+    connected_regions = update_reachable_regions(connected_regions, traversal_reqs, has_laurels, logic_rules)
 
     if world.options.entrance_rando.value in EntranceRando.options:
         plando_connections = world.multiworld.plando_connections[world.player]
@@ -205,11 +225,17 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
             non_dead_end_regions.add(region_name)
         elif region_info.dead_end == 2 and logic_rules:
             non_dead_end_regions.add(region_name)
+        elif region_info.dead_end == 3:
+            if (region_name == "Secret Gathering Place" and laurels_location == "10_fairies") \
+                    or (region_name == "Zig Skip Exit" and fixed_shop):
+                non_dead_end_regions.add(region_name)
 
     if plando_connections:
         for connection in plando_connections:
             p_entrance = connection.entrance
             p_exit = connection.exit
+            portal1_dead_end = True
+            portal2_dead_end = True
 
             portal1 = None
             portal2 = None
@@ -218,8 +244,10 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
             for portal in two_plus:
                 if p_entrance == portal.name:
                     portal1 = portal
+                    portal1_dead_end = False
                 if p_exit == portal.name:
                     portal2 = portal
+                    portal2_dead_end = False
 
             # search dead_ends individually since we can't really remove items from two_plus during the loop
             if portal1:
@@ -233,7 +261,7 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
                     else:
                         raise Exception(f"{player_name} paired a dead end to a dead end in their "
                                         "plando connections.")
-                    
+
                 for portal in dead_ends:
                     if p_entrance == portal.name:
                         portal1 = portal
@@ -246,7 +274,6 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
             if portal2:
                 two_plus.remove(portal2)
             else:
-                # check if portal2 is a dead end
                 for portal in dead_ends:
                     if p_exit == portal.name:
                         portal2 = portal
@@ -256,6 +283,7 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
                     portal2 = Portal(name="Shop Portal", region="Shop",
                                      destination="Previous Region", tag="_")
                     shop_count -= 1
+                    # need to maintain an even number of portals total
                     if shop_count < 0:
                         shop_count += 2
                     for p in portal_mapping:
@@ -269,48 +297,36 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
                                         f"plando connections in {player_name}'s YAML.")
                     dead_ends.remove(portal2)
 
+            # update the traversal chart to say you can get from portal1's region to portal2's and vice versa
+            if not portal1_dead_end and not portal2_dead_end:
+                traversal_reqs.setdefault(portal1.region, dict())[portal2.region] = []
+                traversal_reqs.setdefault(portal2.region, dict())[portal1.region] = []
+
+            if portal1.region == "Zig Skip Exit" or portal2.region == "Zig Skip Exit":
+                if portal1_dead_end or portal2_dead_end or \
+                        portal1.region == "Secret Gathering Place" or portal2.region == "Secret Gathering Place":
+                    if world.options.entrance_rando.value not in EntranceRando.options:
+                        raise Exception(f"Tunic ER seed group {world.options.entrance_rando.value} paired a dead "
+                                        "end to a dead end in their plando connections.")
+                    else:
+                        raise Exception(f"{player_name} paired a dead end to a dead end in their "
+                                        "plando connections.")
+
+            if portal1.region == "Secret Gathering Place" or portal2.region == "Secret Gathering Place":
+                # need to make sure you didn't pair this to a dead end or zig skip
+                if portal1_dead_end or portal2_dead_end or \
+                        portal1.region == "Zig Skip Exit" or portal2.region == "Zig Skip Exit":
+                    if world.options.entrance_rando.value not in EntranceRando.options:
+                        raise Exception(f"Tunic ER seed group {world.options.entrance_rando.value} paired a dead "
+                                        "end to a dead end in their plando connections.")
+                    else:
+                        raise Exception(f"{player_name} paired a dead end to a dead end in their "
+                                        "plando connections.")
+                waterfall_plando = True
             portal_pairs[portal1] = portal2
 
-            # update dependent regions based on the plando'd connections, to ensure the portals connect well, logically
-            for origins, destinations in dependent_regions.items():
-                if portal1.region in origins:
-                    if portal2.region in non_dead_end_regions:
-                        destinations.append(portal2.region)
-                if portal2.region in origins:
-                    if portal1.region in non_dead_end_regions:
-                        destinations.append(portal1.region)
-
         # if we have plando connections, our connected regions may change somewhat
-        while True:
-            test1 = len(connected_regions)
-            for region in connected_regions.copy():
-                connected_regions.update(add_dependent_regions(region, logic_rules))
-            test2 = len(connected_regions)
-            if test1 == test2:
-                break
-    
-    # need to plando fairy cave, or it could end up laurels locked
-    # fix this later to be random after adding some item logic to dependent regions
-    if laurels_location == "10_fairies" and not hasattr(world.multiworld, "re_gen_passthrough"):
-        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
-        if not portal1:
-            raise Exception(f"Failed to do Laurels Location at 10 Fairies option. "
-                            f"Did {player_name} plando connection the Secret Gathering Place Entrance?")
-        if not portal2:
-            raise Exception(f"Failed to do Laurels Location at 10 Fairies option. "
-                            f"Did {player_name} plando connection the Secret Gathering Place Exit?")
-        portal_pairs[portal1] = portal2
-        two_plus.remove(portal1)
-        dead_ends.remove(portal2)
+        connected_regions = update_reachable_regions(connected_regions, traversal_reqs, has_laurels, logic_rules)
 
     if fixed_shop and not hasattr(world.multiworld, "re_gen_passthrough"):
         portal1 = None
@@ -339,47 +355,54 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
     previous_conn_num = 0
     fail_count = 0
     while len(connected_regions) < len(non_dead_end_regions):
-        # if the connected regions length stays unchanged for too long, it's stuck in a loop
-        # should, hopefully, only ever occur if someone plandos connections poorly
+        # if this is universal tracker, just break immediately and move on
         if hasattr(world.multiworld, "re_gen_passthrough"):
             break
+        # if the connected regions length stays unchanged for too long, it's stuck in a loop
+        # should, hopefully, only ever occur if someone plandos connections poorly
         if previous_conn_num == len(connected_regions):
             fail_count += 1
             if fail_count >= 500:
-                raise Exception(f"Failed to pair regions. Check plando connections for {player_name} for loops.")
+                raise Exception(f"Failed to pair regions. Check plando connections for {player_name} for errors. "
+                                "Unconnected regions:", non_dead_end_regions - connected_regions)
         else:
             fail_count = 0
         previous_conn_num = len(connected_regions)
 
-        # find a portal in an inaccessible region
+        # find a portal in a connected 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):
-                        random_object.shuffle(two_plus)
-                        break
                     portal1 = portal
                     two_plus.remove(portal)
                     check_success = 1
                     break
 
-        # then we find a portal in a connected region
+        # then we find a portal in an inaccessible 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):
-                        random_object.shuffle(two_plus)
-                        break
+                    # if secret gathering place happens to get paired really late, you can end up running out
+                    if not has_laurels and len(two_plus) < 80:
+                        # if you plando'd secret gathering place with laurels at 10 fairies, you're the reason for this
+                        if waterfall_plando:
+                            cr = connected_regions.copy()
+                            cr.add(portal.region)
+                            if "Secret Gathering Place" not in update_reachable_regions(cr, traversal_reqs, has_laurels, logic_rules):
+                                continue
+                        elif portal.region != "Secret Gathering Place":
+                            continue
                     portal2 = portal
+                    connected_regions.add(portal.region)
                     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))
+            connected_regions = update_reachable_regions(connected_regions, traversal_reqs, has_laurels, logic_rules)
+            if "Secret Gathering Place" in connected_regions:
+                has_laurels = True
             portal_pairs[portal1] = portal2
             check_success = 0
             random_object.shuffle(two_plus)
@@ -411,7 +434,6 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
         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:
@@ -438,126 +460,42 @@ def create_randomized_entrances(portal_pairs: Dict[Portal, Portal], regions: Dic
             region2.connect(connecting_region=region1, name=portal2.name)
 
 
-# loop through the static connections, return regions you can reach from this region
-# todo: refactor to take region_name and dependent_regions
-def add_dependent_regions(region_name: str, logic_rules: int) -> Set[str]:
-    region_set = set()
-    if not logic_rules:
-        regions_to_add = dependent_regions_restricted
-    elif logic_rules == 1:
-        regions_to_add = dependent_regions_nmg
-    else:
-        regions_to_add = dependent_regions_ur
-    for origin_regions, destination_regions in regions_to_add.items():
-        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
+def update_reachable_regions(connected_regions: Set[str], traversal_reqs: Dict[str, Dict[str, List[List[str]]]],
+                             has_laurels: bool, logic: int) -> Set[str]:
+    # starting count, so we can run it again if this changes
+    region_count = len(connected_regions)
+    for origin, destinations in traversal_reqs.items():
+        if origin not in connected_regions:
+            continue
+        # check if we can traverse to any of the destinations
+        for destination, req_lists in destinations.items():
+            if destination in connected_regions:
+                continue
+            met_traversal_reqs = False
+            if len(req_lists) == 0:
+                met_traversal_reqs = True
+            # loop through each set of possible requirements, with a fancy for else loop
+            for reqs in req_lists:
+                for req in reqs:
+                    if req == "Hyperdash":
+                        if not has_laurels:
+                            break
+                    elif req == "NMG":
+                        if not logic:
+                            break
+                    elif req == "UR":
+                        if logic < 2:
+                            break
+                    elif req not in connected_regions:
+                        break
+                else:
+                    met_traversal_reqs = True
+                    break
+            if met_traversal_reqs:
+                connected_regions.add(destination)
 
+    # if the length of connected_regions changed, we got new regions, so we want to check those new origins
+    if region_count != len(connected_regions):
+        connected_regions = update_reachable_regions(connected_regions, traversal_reqs, has_laurels, logic)
 
-# 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 in {"Swamp Front", "Swamp to Cathedral Treasure Room",
-                                 "Swamp to Cathedral Main Entrance Region"}:
-                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
+    return connected_regions

worlds/tunic/items.py

@@ -237,6 +237,8 @@ extra_groups: Dict[str, Set[str]] = {
     "Ladder to Atoll": {"Ladder to Ruined Atoll"},  # fuzzy matching made it hint Ladders in Well, now it won't
     "Ladders to Bell": {"Ladders to West Bell"},
     "Ladders to Well": {"Ladders in Well"},  # fuzzy matching decided ladders in well was ladders to west bell
+    "Ladders in Atoll": {"Ladders in South Atoll"},
+    "Ladders in Ruined Atoll": {"Ladders in South Atoll"},
 }
 
 item_name_groups.update(extra_groups)

worlds/tunic/locations.py

@@ -86,7 +86,7 @@ location_table: Dict[str, TunicLocationData] = {
     "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 - Obscured Behind Waterfall": TunicLocationData("Beneath the Vault", "Beneath the Vault Main"),
     "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"),

worlds/tunic/options.py

@@ -118,7 +118,8 @@ class EntranceRando(TextChoice):
 
 
 class FixedShop(Toggle):
-    """Forces the Windmill entrance to lead to a shop, and places only one other shop in the pool.
+    """Forces the Windmill entrance to lead to a shop, and removes the remaining shops from the pool.
+    Adds another entrance in Rooted Ziggurat Lower to keep an even number of entrances.
     Has no effect if Entrance Rando is not enabled."""
     internal_name = "fixed_shop"
     display_name = "Fewer Shops in Entrance Rando"
@@ -126,8 +127,7 @@ class FixedShop(Toggle):
 
 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."""
+    For if you want to avoid or specify early or late Laurels."""
     internal_name = "laurels_location"
     display_name = "Laurels Location"
     option_anywhere = 0
@@ -147,6 +147,7 @@ class ShuffleLadders(Toggle):
 
 @dataclass
 class TunicOptions(PerGameCommonOptions):
+    start_inventory_from_pool: StartInventoryPool
     sword_progression: SwordProgression
     start_with_sword: StartWithSword
     keys_behind_bosses: KeysBehindBosses
@@ -162,4 +163,3 @@ class TunicOptions(PerGameCommonOptions):
     lanternless: Lanternless
     maskless: Maskless
     laurels_location: LaurelsLocation
-    start_inventory_from_pool: StartInventoryPool

worlds/zillion/__init__.py

@@ -14,7 +14,7 @@ from BaseClasses import ItemClassification, LocationProgressType, \
 from .gen_data import GenData
 from .logic import cs_to_zz_locs
 from .region import ZillionLocation, ZillionRegion
-from .options import ZillionOptions, validate
+from .options import ZillionOptions, validate, z_option_groups
 from .id_maps import ZillionSlotInfo, get_slot_info, 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
@@ -62,6 +62,8 @@ class ZillionWebWorld(WebWorld):
         ["beauxq"]
     )]
 
+    option_groups = z_option_groups
+
 
 class ZillionWorld(World):
     """

worlds/zillion/options.py

@@ -3,7 +3,7 @@ from dataclasses import dataclass
 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 Options import Choice, DefaultOnToggle, NamedRange, OptionGroup, PerGameCommonOptions, Range, Toggle
 
 from zilliandomizer.options import (
     Options as ZzOptions, char_to_gun, char_to_jump, ID,
@@ -279,6 +279,14 @@ class ZillionOptions(PerGameCommonOptions):
     room_gen: ZillionRoomGen
 
 
+z_option_groups = [
+    OptionGroup("item counts", [
+        ZillionIDCardCount, ZillionBreadCount, ZillionOpaOpaCount, ZillionZillionCount,
+        ZillionFloppyDiskCount, ZillionScopeCount, ZillionRedIDCardCount
+    ])
+]
+
+
 def convert_item_counts(ic: "Counter[str]") -> ZzItemCounts:
     tr: ZzItemCounts = {
         ID.card: ic["ID Card"],