WebHost: Better host room (#3496)

* add Range= to log, making responses a lot smaller for massive rooms
* switch xhr to fetch
* post the form using fetch if possible
  * also refresh log faster while waiting for command echo / response
  * do not follow redirect, saving a request
  * do not post empty body
* smooth-scroll the log view
* paste the log into the div when loading the HTML (up to 1MB, rest will be `fetch`ed)
* fix duplicate charset in display_log response

CommonClient.py

@@ -23,7 +23,7 @@ if __name__ == "__main__":
 
 from MultiServer import CommandProcessor
 from NetUtils import (Endpoint, decode, NetworkItem, encode, JSONtoTextParser, ClientStatus, Permission, NetworkSlot,
-                      RawJSONtoTextParser, add_json_text, add_json_location, add_json_item, JSONTypes)
+                      RawJSONtoTextParser, add_json_text, add_json_location, add_json_item, JSONTypes, SlotType)
 from Utils import Version, stream_input, async_start
 from worlds import network_data_package, AutoWorldRegister
 import os
@@ -862,7 +862,8 @@ async def process_server_cmd(ctx: CommonContext, args: dict):
         ctx.team = args["team"]
         ctx.slot = args["slot"]
         # int keys get lost in JSON transfer
-        ctx.slot_info = {int(pid): data for pid, data in args["slot_info"].items()}
+        ctx.slot_info = {0: NetworkSlot("Archipelago", "Archipelago", SlotType.player)}
+        ctx.slot_info.update({int(pid): data for pid, data in args["slot_info"].items()})
         ctx.hint_points = args.get("hint_points", 0)
         ctx.consume_players_package(args["players"])
         ctx.stored_data_notification_keys.add(f"_read_hints_{ctx.team}_{ctx.slot}")

WebHostLib/misc.py

@@ -1,6 +1,6 @@
 import datetime
 import os
-from typing import List, Dict, Union
+from typing import Dict, Iterator, List, Tuple, Union
 
 import jinja2.exceptions
 from flask import request, redirect, url_for, render_template, Response, session, abort, send_from_directory
@@ -97,25 +97,36 @@ def new_room(seed: UUID):
     return redirect(url_for("host_room", room=room.id))
 
 
-def _read_log(path: str):
+def _read_log(path: str, offset: int = 0) -> Iterator[bytes]:
-    if os.path.exists(path):
+    with open(path, "rb") as log:
-        with open(path, encoding="utf-8-sig") as log:
+        marker = log.read(3)  # skip optional BOM
-            yield from log
+        if marker != b'\xEF\xBB\xBF':
-    else:
+            log.seek(0, os.SEEK_SET)
-        yield f"Logfile {path} does not exist. " \
+        log.seek(offset, os.SEEK_CUR)
-              f"Likely a crash during spinup of multiworld instance or it is still spinning up."
+        yield from log
 
 
 @app.route('/log/<suuid:room>')
-def display_log(room: UUID):
+def display_log(room: UUID) -> Union[str, Response, Tuple[str, int]]:
     room = Room.get(id=room)
     if room is None:
         return abort(404)
     if room.owner == session["_id"]:
         file_path = os.path.join("logs", str(room.id) + ".txt")
-        if os.path.exists(file_path):
+        try:
-            return Response(_read_log(file_path), mimetype="text/plain;charset=UTF-8")
+            range_header = request.headers.get("Range")
-        return "Log File does not exist."
+            if range_header:
+                range_type, range_values = range_header.split('=')
+                start, end = map(str.strip, range_values.split('-', 1))
+                if range_type != "bytes" or end != "":
+                    return "Unsupported range", 500
+                # NOTE: we skip Content-Range in the response here, which isn't great but works for our JS
+                return Response(_read_log(file_path, int(start)), mimetype="text/plain", status=206)
+            return Response(_read_log(file_path), mimetype="text/plain")
+        except FileNotFoundError:
+            return Response(f"Logfile {file_path} does not exist. "
+                            f"Likely a crash during spinup of multiworld instance or it is still spinning up.",
+                            mimetype="text/plain")
 
     return "Access Denied", 403
 
@@ -139,7 +150,21 @@ def host_room(room: UUID):
     with db_session:
         room.last_activity = now  # will trigger a spinup, if it's not already running
 
-    return render_template("hostRoom.html", room=room, should_refresh=should_refresh)
+    def get_log(max_size: int = 1024000) -> str:
+        try:
+            raw_size = 0
+            fragments: List[str] = []
+            for block in _read_log(os.path.join("logs", str(room.id) + ".txt")):
+                if raw_size + len(block) > max_size:
+                    fragments.append("…")
+                    break
+                raw_size += len(block)
+                fragments.append(block.decode("utf-8"))
+            return "".join(fragments)
+        except FileNotFoundError:
+            return ""
+
+    return render_template("hostRoom.html", room=room, should_refresh=should_refresh, get_log=get_log)
 
 
 @app.route('/favicon.ico')

WebHostLib/options.py

@@ -234,7 +234,7 @@ def generate_yaml(game: str):
         # Detect random-* keys and set their options accordingly
         for key, val in options.copy().items():
             if key.startswith("random-"):
-                options[key[len("random-"):]] = "random"
+                options[key.removeprefix("random-")] = "random"
                 del options[key]
 
         # Error checking

WebHostLib/robots.py

@@ -8,7 +8,8 @@ from . import cache
 def robots():
     # If this host is not official, do not allow search engine crawling
     if not app.config["ASSET_RIGHTS"]:
-        return app.send_static_file('robots.txt')
+        # filename changed in case the path is intercepted and served by an outside service
+        return app.send_static_file('robots_file.txt')
 
     # Send 404 if the host has affirmed this to be the official WebHost
     abort(404)

WebHostLib/templates/hostRoom.html

@@ -44,7 +44,7 @@
         {{ macros.list_patches_room(room) }}
         {% if room.owner == session["_id"] %}
             <div style="display: flex; align-items: center;">
-                <form method=post style="flex-grow: 1; margin-right: 1em;">
+                <form method="post" id="command-form" style="flex-grow: 1; margin-right: 1em;">
                     <div class="form-group">
                         <label for="cmd"></label>
                         <input class="form-control" type="text" id="cmd" name="cmd"
@@ -55,24 +55,89 @@
                     Open Log File...
                 </a>
             </div>
-        <div id="logger"></div>
+        {%  set log = get_log() -%}
-        <script type="application/ecmascript">
+        {%- set log_len = log | length - 1 if log.endswith("…") else log | length -%}
-            let xmlhttp = new XMLHttpRequest();
+        <div id="logger" style="white-space: pre">{{ log }}</div>
-            let url = '{{ url_for('display_log', room = room.id) }}';
+        <script>
+          let url = '{{ url_for('display_log', room = room.id) }}';
+          let bytesReceived = {{ log_len }};
+          let updateLogTimeout;
+          let awaitingCommandResponse = false;
+          let logger = document.getElementById("logger");
 
-            xmlhttp.onreadystatechange = function () {
+          function scrollToBottom(el) {
-                if (this.readyState === 4 && this.status === 200) {
+            let bot = el.scrollHeight - el.clientHeight;
-                    document.getElementById("logger").innerText = this.responseText;
+            el.scrollTop += Math.ceil((bot - el.scrollTop)/10);
-                }
+            if (bot - el.scrollTop >= 1) {
-            };
+              window.clearTimeout(el.scrollTimer);
-
+              el.scrollTimer = window.setTimeout(() => {
-            function request_new() {
+                scrollToBottom(el)
-                xmlhttp.open("GET", url, true);
+              }, 16);
-                xmlhttp.send();
             }
+          }
 
-            window.setTimeout(request_new, 1000);
+          async function updateLog() {
-            window.setInterval(request_new, 10000);
+            try {
+              let res = await fetch(url, {
+                headers: {
+                  'Range': `bytes=${bytesReceived}-`,
+                }
+              });
+              if (res.ok) {
+                let text = await res.text();
+                if (text.length > 0) {
+                  awaitingCommandResponse = false;
+                  if (bytesReceived === 0 || res.status !== 206) {
+                    logger.innerHTML = '';
+                  }
+                  if (res.status !== 206) {
+                    bytesReceived = 0;
+                  } else {
+                    bytesReceived += new Blob([text]).size;
+                  }
+                  if (logger.innerHTML.endsWith('…')) {
+                    logger.innerHTML = logger.innerHTML.substring(0, logger.innerHTML.length - 1);
+                  }
+                  logger.appendChild(document.createTextNode(text));
+                  scrollToBottom(logger);
+                }
+              }
+            }
+            finally {
+              window.clearTimeout(updateLogTimeout);
+              updateLogTimeout = window.setTimeout(updateLog, awaitingCommandResponse ? 500 : 10000);
+            }
+          }
+
+          async function postForm(ev) {
+            /** @type {HTMLInputElement} */
+            let cmd = document.getElementById("cmd");
+            if (cmd.value === "") {
+              ev.preventDefault();
+              return;
+            }
+            /** @type {HTMLFormElement} */
+            let form = document.getElementById("command-form");
+            let req = fetch(form.action || window.location.href, {
+              method: form.method,
+              body: new FormData(form),
+              redirect: "manual",
+            });
+            ev.preventDefault(); // has to happen before first await
+            form.reset();
+            let res = await req;
+            if (res.ok || res.type === 'opaqueredirect') {
+              awaitingCommandResponse = true;
+              window.clearTimeout(updateLogTimeout);
+              updateLogTimeout = window.setTimeout(updateLog, 100);
+            } else {
+              window.alert(res.statusText);
+            }
+          }
+
+          document.getElementById("command-form").addEventListener("submit", postForm);
+          updateLogTimeout = window.setTimeout(updateLog, 1000);
+          logger.scrollTop = logger.scrollHeight;
         </script>
         {% endif %}
     </div>

WebHostLib/tracker.py

@@ -1366,28 +1366,28 @@ if "Starcraft 2" in network_data_package["games"]:
         organics_icon_base_url = "https://0rganics.org/archipelago/sc2wol/"
 
         icons = {
-            "Starting Minerals":                           "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/icons/icon-mineral-protoss.png",
+            "Starting Minerals":                           github_icon_base_url + "blizzard/icon-mineral-nobg.png",
-            "Starting Vespene":                            "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/icons/icon-gas-terran.png",
+            "Starting Vespene":                            github_icon_base_url + "blizzard/icon-gas-terran-nobg.png",
             "Starting Supply":                             github_icon_base_url + "blizzard/icon-supply-terran_nobg.png",
 
-            "Terran Infantry Weapons Level 1":             "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-infantryweaponslevel1.png",
+            "Terran Infantry Weapons Level 1":             github_icon_base_url + "blizzard/btn-upgrade-terran-infantryweaponslevel1.png",
-            "Terran Infantry Weapons Level 2":             "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-infantryweaponslevel2.png",
+            "Terran Infantry Weapons Level 2":             github_icon_base_url + "blizzard/btn-upgrade-terran-infantryweaponslevel2.png",
-            "Terran Infantry Weapons Level 3":             "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-infantryweaponslevel3.png",
+            "Terran Infantry Weapons Level 3":             github_icon_base_url + "blizzard/btn-upgrade-terran-infantryweaponslevel3.png",
-            "Terran Infantry Armor Level 1":               "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-infantryarmorlevel1.png",
+            "Terran Infantry Armor Level 1":               github_icon_base_url + "blizzard/btn-upgrade-terran-infantryarmorlevel1.png",
-            "Terran Infantry Armor Level 2":               "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-infantryarmorlevel2.png",
+            "Terran Infantry Armor Level 2":               github_icon_base_url + "blizzard/btn-upgrade-terran-infantryarmorlevel2.png",
-            "Terran Infantry Armor Level 3":               "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-infantryarmorlevel3.png",
+            "Terran Infantry Armor Level 3":               github_icon_base_url + "blizzard/btn-upgrade-terran-infantryarmorlevel3.png",
-            "Terran Vehicle Weapons Level 1":              "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-vehicleweaponslevel1.png",
+            "Terran Vehicle Weapons Level 1":              github_icon_base_url + "blizzard/btn-upgrade-terran-vehicleweaponslevel1.png",
-            "Terran Vehicle Weapons Level 2":              "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-vehicleweaponslevel2.png",
+            "Terran Vehicle Weapons Level 2":              github_icon_base_url + "blizzard/btn-upgrade-terran-vehicleweaponslevel2.png",
-            "Terran Vehicle Weapons Level 3":              "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-vehicleweaponslevel3.png",
+            "Terran Vehicle Weapons Level 3":              github_icon_base_url + "blizzard/btn-upgrade-terran-vehicleweaponslevel3.png",
-            "Terran Vehicle Armor Level 1":                "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-vehicleplatinglevel1.png",
+            "Terran Vehicle Armor Level 1":                github_icon_base_url + "blizzard/btn-upgrade-terran-vehicleplatinglevel1.png",
-            "Terran Vehicle Armor Level 2":                "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-vehicleplatinglevel2.png",
+            "Terran Vehicle Armor Level 2":                github_icon_base_url + "blizzard/btn-upgrade-terran-vehicleplatinglevel2.png",
-            "Terran Vehicle Armor Level 3":                "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-vehicleplatinglevel3.png",
+            "Terran Vehicle Armor Level 3":                github_icon_base_url + "blizzard/btn-upgrade-terran-vehicleplatinglevel3.png",
-            "Terran Ship Weapons Level 1":                 "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-shipweaponslevel1.png",
+            "Terran Ship Weapons Level 1":                 github_icon_base_url + "blizzard/btn-upgrade-terran-shipweaponslevel1.png",
-            "Terran Ship Weapons Level 2":                 "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-shipweaponslevel2.png",
+            "Terran Ship Weapons Level 2":                 github_icon_base_url + "blizzard/btn-upgrade-terran-shipweaponslevel2.png",
-            "Terran Ship Weapons Level 3":                 "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-shipweaponslevel3.png",
+            "Terran Ship Weapons Level 3":                 github_icon_base_url + "blizzard/btn-upgrade-terran-shipweaponslevel3.png",
-            "Terran Ship Armor Level 1":                   "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-shipplatinglevel1.png",
+            "Terran Ship Armor Level 1":                   github_icon_base_url + "blizzard/btn-upgrade-terran-shipplatinglevel1.png",
-            "Terran Ship Armor Level 2":                   "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-shipplatinglevel2.png",
+            "Terran Ship Armor Level 2":                   github_icon_base_url + "blizzard/btn-upgrade-terran-shipplatinglevel2.png",
-            "Terran Ship Armor Level 3":                   "https://sclegacy.com/images/uploaded/starcraftii_beta/gamefiles/upgrades/btn-upgrade-terran-shipplatinglevel3.png",
+            "Terran Ship Armor Level 3":                   github_icon_base_url + "blizzard/btn-upgrade-terran-shipplatinglevel3.png",
 
             "Bunker":                                      "https://static.wikia.nocookie.net/starcraft/images/c/c5/Bunker_SC2_Icon1.jpg",
             "Missile Turret":                              "https://static.wikia.nocookie.net/starcraft/images/5/5f/MissileTurret_SC2_Icon1.jpg",

inno_setup.iss

@@ -219,7 +219,7 @@ Root: HKCR; Subkey: "{#MyAppName}multidata\shell\open\command";  ValueData: """{
 Root: HKCR; Subkey: ".apworld";                                 ValueData: "{#MyAppName}worlddata";  Flags: uninsdeletevalue; ValueType: string;  ValueName: "";
 Root: HKCR; Subkey: "{#MyAppName}worlddata";                    ValueData: "Archipelago World Data"; Flags: uninsdeletekey;   ValueType: string;  ValueName: "";
 Root: HKCR; Subkey: "{#MyAppName}worlddata\DefaultIcon";        ValueData: "{app}\ArchipelagoLauncher.exe,0";                 ValueType: string;  ValueName: "";
-Root: HKCR; Subkey: "{#MyAppName}worlddata\shell\open\command"; ValueData: """{app}\ArchipelagoLauncher.exe"" ""%1""";
+Root: HKCR; Subkey: "{#MyAppName}worlddata\shell\open\command"; ValueData: """{app}\ArchipelagoLauncher.exe"" ""%1""";        ValueType: string;  ValueName: "";
 
 Root: HKCR; Subkey: "archipelago"; ValueType: "string"; ValueData: "Archipegalo Protocol"; Flags: uninsdeletekey;
 Root: HKCR; Subkey: "archipelago"; ValueType: "string"; ValueName: "URL Protocol"; ValueData: "";

test/bases.py

@@ -292,12 +292,12 @@ class WorldTestBase(unittest.TestCase):
         """Ensure all state can reach everything and complete the game with the defined options"""
         if not (self.run_default_tests and self.constructed):
             return
-        with self.subTest("Game", game=self.game):
+        with self.subTest("Game", game=self.game, seed=self.multiworld.seed):
             excluded = self.multiworld.worlds[self.player].options.exclude_locations.value
             state = self.multiworld.get_all_state(False)
             for location in self.multiworld.get_locations():
                 if location.name not in excluded:
-                    with self.subTest("Location should be reached", location=location):
+                    with self.subTest("Location should be reached", location=location.name):
                         reachable = location.can_reach(state)
                         self.assertTrue(reachable, f"{location.name} unreachable")
             with self.subTest("Beatable"):
@@ -308,7 +308,7 @@ class WorldTestBase(unittest.TestCase):
         """Ensure empty state can reach at least one location with the defined options"""
         if not (self.run_default_tests and self.constructed):
             return
-        with self.subTest("Game", game=self.game):
+        with self.subTest("Game", game=self.game, seed=self.multiworld.seed):
             state = CollectionState(self.multiworld)
             locations = self.multiworld.get_reachable_locations(state, self.player)
             self.assertGreater(len(locations), 0,

test/general/test_reachability.py

@@ -41,15 +41,15 @@ class TestBase(unittest.TestCase):
                 state = multiworld.get_all_state(False)
                 for location in multiworld.get_locations():
                     if location.name not in excluded:
-                        with self.subTest("Location should be reached", location=location):
+                        with self.subTest("Location should be reached", location=location.name):
                             self.assertTrue(location.can_reach(state), f"{location.name} unreachable")
 
                 for region in multiworld.get_regions():
                     if region.name in unreachable_regions:
-                        with self.subTest("Region should be unreachable", region=region):
+                        with self.subTest("Region should be unreachable", region=region.name):
                             self.assertFalse(region.can_reach(state))
                     else:
-                        with self.subTest("Region should be reached", region=region):
+                        with self.subTest("Region should be reached", region=region.name):
                             self.assertTrue(region.can_reach(state))
 
                 with self.subTest("Completion Condition"):

worlds/AutoWorld.py

@@ -280,7 +280,7 @@ class World(metaclass=AutoWorldRegister):
     future. Protocol level compatibility check moved to MultiServer.min_client_version.
     """
 
-    required_server_version: Tuple[int, int, int] = (0, 2, 4)
+    required_server_version: Tuple[int, int, int] = (0, 5, 0)
     """update this if the resulting multidata breaks forward-compatibility of the server"""
 
     hint_blacklist: ClassVar[FrozenSet[str]] = frozenset()

worlds/adventure/Rules.py

@@ -1,7 +1,5 @@
-from worlds.adventure import location_table
+from .Options import BatLogic, DifficultySwitchB
-from worlds.adventure.Options import BatLogic, DifficultySwitchB, DifficultySwitchA
 from worlds.generic.Rules import add_rule, set_rule, forbid_item
-from BaseClasses import LocationProgressType
 
 
 def set_rules(self) -> None:

worlds/alttp/Client.py

@@ -682,7 +682,7 @@ def get_alttp_settings(romfile: str):
 
         if 'yes' in choice:
             import LttPAdjuster
-            from worlds.alttp.Rom import get_base_rom_path
+            from .Rom import get_base_rom_path
             last_settings.rom = romfile
             last_settings.baserom = get_base_rom_path()
             last_settings.world = None

worlds/alttp/EntranceShuffle.py

@@ -1437,7 +1437,7 @@ def connect_mandatory_exits(world, entrances, caves, must_be_exits, player):
     invalid_cave_connections = defaultdict(set)
 
     if world.glitches_required[player] in ['overworld_glitches', 'hybrid_major_glitches', 'no_logic']:
-        from worlds.alttp import OverworldGlitchRules
+        from . import OverworldGlitchRules
         for entrance in OverworldGlitchRules.get_non_mandatory_exits(world.mode[player] == 'inverted'):
             invalid_connections[entrance] = set()
             if entrance in must_be_exits:

worlds/alttp/Options.py

@@ -486,7 +486,7 @@ class LTTPBosses(PlandoBosses):
 
     @classmethod
     def can_place_boss(cls, boss: str, location: str) -> bool:
-        from worlds.alttp.Bosses import can_place_boss
+        from .Bosses import can_place_boss
         level = ''
         words = location.split(" ")
         if words[-1] in ("top", "middle", "bottom"):

worlds/alttp/Regions.py

@@ -406,7 +406,7 @@ def create_dungeon_region(world: MultiWorld, player: int, name: str, hint: str,
 
 def _create_region(world: MultiWorld, player: int, name: str, type: LTTPRegionType, hint: str, locations=None,
                    exits=None):
-    from worlds.alttp.SubClasses import ALttPLocation
+    from .SubClasses import ALttPLocation
     ret = LTTPRegion(name, type, hint, player, world)
     if exits:
         for exit in exits:
@@ -760,7 +760,7 @@ location_table: typing.Dict[str,
      'Turtle Rock - Prize': (
          [0x120A7, 0x53F24, 0x53F25, 0x18005C, 0x180079, 0xC708], None, True, 'Turtle Rock')}
 
-from worlds.alttp.Shops import shop_table_by_location_id, shop_table_by_location
+from .Shops import shop_table_by_location_id, shop_table_by_location
 lookup_id_to_name = {data[0]: name for name, data in location_table.items() if type(data[0]) == int}
 lookup_id_to_name = {**lookup_id_to_name, **{data[1]: name for name, data in key_drop_data.items()}}
 lookup_id_to_name.update(shop_table_by_location_id)

worlds/alttp/Rules.py

@@ -405,16 +405,14 @@ def global_rules(multiworld: MultiWorld, player: int):
         set_rule(multiworld.get_location('Swamp Palace - Waterway Pot Key', player), lambda state: can_use_bombs(state, player))
 
     set_rule(multiworld.get_entrance('Thieves Town Big Key Door', player), lambda state: state.has('Big Key (Thieves Town)', player))
-
     if multiworld.worlds[player].dungeons["Thieves Town"].boss.enemizer_name == "Blind":
         set_rule(multiworld.get_entrance('Blind Fight', player), lambda state: state._lttp_has_key('Small Key (Thieves Town)', player, 3) and can_use_bombs(state, player))
-
     set_rule(multiworld.get_location('Thieves\' Town - Big Chest', player),
              lambda state: ((state._lttp_has_key('Small Key (Thieves Town)', player, 3)) or (location_item_name(state, 'Thieves\' Town - Big Chest', player) == ("Small Key (Thieves Town)", player)) and state._lttp_has_key('Small Key (Thieves Town)', player, 2)) and state.has('Hammer', player))
-
+    set_rule(multiworld.get_location('Thieves\' Town - Blind\'s Cell', player),
+             lambda state: state._lttp_has_key('Small Key (Thieves Town)', player))
     if multiworld.accessibility[player] != 'locations' and not multiworld.key_drop_shuffle[player]:
         set_always_allow(multiworld.get_location('Thieves\' Town - Big Chest', player), lambda state, item: item.name == 'Small Key (Thieves Town)' and item.player == player)
-
     set_rule(multiworld.get_location('Thieves\' Town - Attic', player), lambda state: state._lttp_has_key('Small Key (Thieves Town)', player, 3))
     set_rule(multiworld.get_location('Thieves\' Town - Spike Switch Pot Key', player),
              lambda state: state._lttp_has_key('Small Key (Thieves Town)', player))

worlds/alttp/test/dungeons/TestThievesTown.py

@@ -37,7 +37,8 @@ class TestThievesTown(TestDungeon):
 
             ["Thieves' Town - Blind's Cell", False, []],
             ["Thieves' Town - Blind's Cell", False, [], ['Big Key (Thieves Town)']],
-            ["Thieves' Town - Blind's Cell", True, ['Big Key (Thieves Town)']],
+            ["Thieves' Town - Blind's Cell", False, [], ['Small Key (Thieves Town)']],
+            ["Thieves' Town - Blind's Cell", True, ['Big Key (Thieves Town)', 'Small Key (Thieves Town)']],
 
             ["Thieves' Town - Boss", False, []],
             ["Thieves' Town - Boss", False, [], ['Big Key (Thieves Town)']],

worlds/aquaria/test/test_beast_form_access.py

@@ -4,7 +4,7 @@ Date: Thu, 18 Apr 2024 18:45:56 +0000
 Description: Unit test used to test accessibility of locations with and without the beast form
 """
 
-from worlds.aquaria.test import AquariaTestBase
+from . import AquariaTestBase
 
 
 class BeastFormAccessTest(AquariaTestBase):

worlds/aquaria/test/test_bind_song_access.py

@@ -5,7 +5,7 @@ Description: Unit test used to test accessibility of locations with and without
              under rock needing bind song option)
 """
 
-from worlds.aquaria.test import AquariaTestBase, after_home_water_locations
+from . import AquariaTestBase, after_home_water_locations
 
 
 class BindSongAccessTest(AquariaTestBase):

worlds/aquaria/test/test_bind_song_option_access.py

@@ -5,8 +5,8 @@ Description: Unit test used to test accessibility of locations with and without
              under rock needing bind song option)
 """
 
-from worlds.aquaria.test import AquariaTestBase
+from . import AquariaTestBase
-from worlds.aquaria.test.test_bind_song_access import after_home_water_locations
+from .test_bind_song_access import after_home_water_locations
 
 
 class BindSongOptionAccessTest(AquariaTestBase):

worlds/aquaria/test/test_confined_home_water.py

@@ -4,7 +4,7 @@ Date: Fri, 03 May 2024 14:07:35 +0000
 Description: Unit test used to test accessibility of region with the home water confine via option
 """
 
-from worlds.aquaria.test import AquariaTestBase
+from . import AquariaTestBase
 
 
 class ConfinedHomeWaterAccessTest(AquariaTestBase):

worlds/aquaria/test/test_dual_song_access.py

@@ -4,7 +4,7 @@ Date: Thu, 18 Apr 2024 18:45:56 +0000
 Description: Unit test used to test accessibility of locations with and without the dual song
 """
 
-from worlds.aquaria.test import AquariaTestBase
+from . import AquariaTestBase
 
 
 class LiAccessTest(AquariaTestBase):

worlds/aquaria/test/test_energy_form_access.py

@@ -5,7 +5,7 @@ Description: Unit test used to test accessibility of locations with and without
              energy form option)
 """
 
-from worlds.aquaria.test import AquariaTestBase
+from . import AquariaTestBase
 
 
 class EnergyFormAccessTest(AquariaTestBase):

worlds/aquaria/test/test_fish_form_access.py

@@ -4,7 +4,7 @@ Date: Thu, 18 Apr 2024 18:45:56 +0000
 Description: Unit test used to test accessibility of locations with and without the fish form
 """
 
-from worlds.aquaria.test import AquariaTestBase
+from . import AquariaTestBase
 
 
 class FishFormAccessTest(AquariaTestBase):

worlds/aquaria/test/test_li_song_access.py

@@ -4,7 +4,7 @@ Date: Thu, 18 Apr 2024 18:45:56 +0000
 Description: Unit test used to test accessibility of locations with and without Li
 """
 
-from worlds.aquaria.test import AquariaTestBase
+from . import AquariaTestBase
 
 
 class LiAccessTest(AquariaTestBase):

worlds/aquaria/test/test_light_access.py

@@ -4,7 +4,7 @@ Date: Thu, 18 Apr 2024 18:45:56 +0000
 Description: Unit test used to test accessibility of locations with and without a light (Dumbo pet or sun form)
 """
 
-from worlds.aquaria.test import AquariaTestBase
+from . import AquariaTestBase
 
 
 class LightAccessTest(AquariaTestBase):

worlds/aquaria/test/test_nature_form_access.py

@@ -4,7 +4,7 @@ Date: Thu, 18 Apr 2024 18:45:56 +0000
 Description: Unit test used to test accessibility of locations with and without the nature form
 """
 
-from worlds.aquaria.test import AquariaTestBase
+from . import AquariaTestBase
 
 
 class NatureFormAccessTest(AquariaTestBase):

worlds/aquaria/test/test_no_progression_hard_hidden_locations.py

@@ -4,7 +4,7 @@ Date: Fri, 03 May 2024 14:07:35 +0000
 Description: Unit test used to test that no progression items can be put in hard or hidden locations when option enabled
 """
 
-from worlds.aquaria.test import AquariaTestBase
+from . import AquariaTestBase
 from BaseClasses import ItemClassification
 
 

worlds/aquaria/test/test_progression_hard_hidden_locations.py

@@ -4,8 +4,7 @@ Date: Fri, 03 May 2024 14:07:35 +0000
 Description: Unit test used to test that progression items can be put in hard or hidden locations when option disabled
 """
 
-from worlds.aquaria.test import AquariaTestBase
+from . import AquariaTestBase
-from BaseClasses import ItemClassification
 
 
 class UNoProgressionHardHiddenTest(AquariaTestBase):

worlds/aquaria/test/test_spirit_form_access.py

@@ -4,7 +4,7 @@ Date: Thu, 18 Apr 2024 18:45:56 +0000
 Description: Unit test used to test accessibility of locations with and without the spirit form
 """
 
-from worlds.aquaria.test import AquariaTestBase
+from . import AquariaTestBase
 
 
 class SpiritFormAccessTest(AquariaTestBase):

worlds/aquaria/test/test_sun_form_access.py

@@ -4,7 +4,7 @@ Date: Thu, 18 Apr 2024 18:45:56 +0000
 Description: Unit test used to test accessibility of locations with and without the sun form
 """
 
-from worlds.aquaria.test import AquariaTestBase
+from . import AquariaTestBase
 
 
 class SunFormAccessTest(AquariaTestBase):

worlds/aquaria/test/test_unconfine_home_water_via_both.py

@@ -5,7 +5,7 @@ Description: Unit test used to test accessibility of region with the unconfined
              turtle and energy door
 """
 
-from worlds.aquaria.test import AquariaTestBase
+from . import AquariaTestBase
 
 
 class UnconfineHomeWaterBothAccessTest(AquariaTestBase):

worlds/aquaria/test/test_unconfine_home_water_via_energy_door.py

@@ -4,7 +4,7 @@ Date: Fri, 03 May 2024 14:07:35 +0000
 Description: Unit test used to test accessibility of region with the unconfined home water option via the energy door
 """
 
-from worlds.aquaria.test import AquariaTestBase
+from . import AquariaTestBase
 
 
 class UnconfineHomeWaterEnergyDoorAccessTest(AquariaTestBase):

worlds/aquaria/test/test_unconfine_home_water_via_transturtle.py

@@ -4,7 +4,7 @@ Date: Fri, 03 May 2024 14:07:35 +0000
 Description: Unit test used to test accessibility of region with the unconfined home water option via transturtle
 """
 
-from worlds.aquaria.test import AquariaTestBase
+from . import AquariaTestBase
 
 
 class UnconfineHomeWaterTransturtleAccessTest(AquariaTestBase):

worlds/dkc3/Client.py

@@ -60,7 +60,7 @@ class DKC3SNIClient(SNIClient):
             return
 
         new_checks = []
-        from worlds.dkc3.Rom import location_rom_data, item_rom_data, boss_location_ids, level_unlock_map
+        from .Rom import location_rom_data, item_rom_data, boss_location_ids, level_unlock_map
         location_ram_data = await snes_read(ctx, WRAM_START + 0x5FE, 0x81)
         for loc_id, loc_data in location_rom_data.items():
             if loc_id not in ctx.locations_checked:

worlds/ladx/LADXR/locations/droppedKey.py

@@ -19,7 +19,7 @@ class DroppedKey(ItemInfo):
             extra = 0x01F8
         super().__init__(room, extra)
     def patch(self, rom, option, *, multiworld=None):
-        if (option.startswith(MAP) and option != MAP) or (option.startswith(COMPASS) and option != COMPASS) or option.startswith(STONE_BEAK) or (option.startswith(NIGHTMARE_KEY) and option != NIGHTMARE_KEY )or (option.startswith(KEY) and option != KEY):
+        if (option.startswith(MAP) and option != MAP) or (option.startswith(COMPASS) and option != COMPASS) or (option.startswith(STONE_BEAK) and option != STONE_BEAK) or (option.startswith(NIGHTMARE_KEY) and option != NIGHTMARE_KEY) or (option.startswith(KEY) and option != KEY):
             if option[-1] == 'P':
                 print(option)
             if self._location.dungeon == int(option[-1]) and multiworld is None and self.room not in {0x166, 0x223}:

worlds/ladx/Options.py

@@ -52,6 +52,7 @@ class TextShuffle(DefaultOffToggle):
     [On] Shuffles all the text in the game
     [Off] (default) doesn't shuffle them.
     """
+    display_name = "Text Shuffle"
 
 
 class Rooster(DefaultOnToggle, LADXROption):
@@ -68,7 +69,8 @@ class Boomerang(Choice):
     [Normal] requires Magnifying Lens to get the boomerang.
     [Gift] The boomerang salesman will give you a random item, and the boomerang is shuffled.
     """
-
+    display_name = "Boomerang"
+    
     normal = 0
     gift = 1
     default = gift
@@ -113,6 +115,7 @@ class APTitleScreen(DefaultOnToggle):
 
 
 class BossShuffle(Choice):
+    display_name = "Boss Shuffle"
     none = 0
     shuffle = 1
     random = 2
@@ -120,6 +123,7 @@ class BossShuffle(Choice):
 
 
 class DungeonItemShuffle(Choice):
+    display_name = "Dungeon Item Shuffle"
     option_original_dungeon = 0
     option_own_dungeons = 1
     option_own_world = 2
@@ -291,6 +295,7 @@ class Bowwow(Choice):
     [Normal] BowWow is in the item pool, but can be logically expected as a damage source.
     [Swordless] The progressive swords are removed from the item pool.
     """
+    display_name = "BowWow"
     normal = 0
     swordless = 1
     default = normal
@@ -466,6 +471,7 @@ class Music(Choice, LADXROption):
     [Shuffled] Shuffled Music
     [Off] No music
     """
+    display_name = "Music"
     ladxr_name = "music"
     option_vanilla = 0
     option_shuffled = 1
@@ -485,6 +491,7 @@ class WarpImprovements(DefaultOffToggle):
     [On] Adds remake style warp screen to the game. Choose your warp destination on the map after jumping in a portal and press B to select.
     [Off] No change
     """
+    display_name = "Warp Improvements"
 
 
 class AdditionalWarpPoints(DefaultOffToggle):
@@ -492,6 +499,7 @@ class AdditionalWarpPoints(DefaultOffToggle):
     [On] (requires warp improvements) Adds a warp point at Crazy Tracy's house (the Mambo teleport spot) and Eagle's Tower
     [Off] No change
     """
+    display_name = "Additional Warp Points"
 
 ladx_option_groups = [
     OptionGroup("Goal Options", [

worlds/ladx/Tracker.py

@@ -1,4 +1,4 @@
-from worlds.ladx.LADXR.checkMetadata import checkMetadataTable
+from .LADXR.checkMetadata import checkMetadataTable
 import json
 import logging
 import websockets

worlds/musedash/MuseDashData.txt

@@ -557,3 +557,13 @@ Tsukuyomi Ni Naru|74-2|CHUNITHM COURSE MUSE|False|5|7|9|
 The wheel to the right|74-3|CHUNITHM COURSE MUSE|True|5|7|9|11
 Climax|74-4|CHUNITHM COURSE MUSE|True|4|8|11|11
 Spider's Thread|74-5|CHUNITHM COURSE MUSE|True|5|8|10|12
+HIT ME UP|43-54|MD Plus Project|True|4|6|8|
+Test Me feat. Uyeon|43-55|MD Plus Project|True|3|5|9|
+Assault TAXI|43-56|MD Plus Project|True|4|7|10|
+No|43-57|MD Plus Project|False|4|6|9|
+Pop it|43-58|MD Plus Project|True|1|3|6|
+HEARTBEAT! KyunKyun!|43-59|MD Plus Project|True|4|6|9|
+SUPERHERO|75-0|Novice Rider Pack|False|2|4|7|
+Highway_Summer|75-1|Novice Rider Pack|True|2|4|6|
+Mx. Black Box|75-2|Novice Rider Pack|True|5|7|9|
+Sweet Encounter|75-3|Novice Rider Pack|True|2|4|7|

worlds/musedash/docs/setup_en.md

@@ -17,11 +17,12 @@
 ## Installing the Archipelago mod to Muse Dash
 
 1. Download [MelonLoader.Installer.exe](https://github.com/LavaGang/MelonLoader/releases/latest) and run it.
-2. Choose the automated tab, click the select button and browse to `MuseDash.exe`. Then click install.
+2. Choose the automated tab, click the select button and browse to `MuseDash.exe`.
   - You can find the folder in steam by finding the game in your library, right clicking it and choosing *Manage→Browse Local Files*.
   - If you click the bar at the top telling you your current folder, this will give you a path you can copy. If you paste that into the window popped up by **MelonLoader**, it will automatically go to the same folder.
-3. Run the game once, and wait until you get to the Muse Dash start screen before exiting.
+3. Uncheck "Latest" and select v0.6.1. Then click install.
-4. Download the latest [Muse Dash Archipelago Mod](https://github.com/DeamonHunter/ArchipelagoMuseDash/releases/latest) and then extract that into the newly created `/Mods/` folder in MuseDash's install location.
+4. Run the game once, and wait until you get to the Muse Dash start screen before exiting.
+5. Download the latest [Muse Dash Archipelago Mod](https://github.com/DeamonHunter/ArchipelagoMuseDash/releases/latest) and then extract that into the newly created `/Mods/` folder in MuseDash's install location.
   - All files must be under the `/Mods/` folder and not within a sub folder inside of `/Mods/`
 
 If you've successfully installed everything, a button will appear in the bottom right which will allow you to log into an Archipelago server.

worlds/musedash/docs/setup_es.md

@@ -17,11 +17,12 @@
 ## Instalar el mod de Archipelago en Muse Dash
 
 1. Descarga [MelonLoader.Installer.exe](https://github.com/LavaGang/MelonLoader/releases/latest) y ejecutalo.
-2. Elije la pestaña "automated", haz clic en el botón "select" y busca tu `MuseDash.exe`. Luego haz clic en "install".
+2. Elije la pestaña "automated", haz clic en el botón "select" y busca tu `MuseDash.exe`.
   - Puedes encontrar la carpeta en Steam buscando el juego en tu biblioteca, haciendo clic derecho sobre el y elegir *Administrar→Ver archivos locales*.
   - Si haces clic en la barra superior que te indica la carpeta en la que estas, te dará la dirección de ésta para que puedas copiarla. Al pegar esa dirección en la ventana que **MelonLoader** abre, irá automaticamente a esa carpeta.
-3. Ejecuta el juego una vez, y espera hasta que aparezca la pantalla de inicio de Muse Dash antes de cerrarlo.
+3. Desmarca "Latest" y selecciona v0.6.1. Luego haz clic en "install".
-4. Descarga la última version de [Muse Dash Archipelago Mod](https://github.com/DeamonHunter/ArchipelagoMuseDash/releases/latest) y extraelo en la nueva carpeta creada llamada `/Mods/`, localizada en la carpeta de instalación de Muse Dash.
+4. Ejecuta el juego una vez, y espera hasta que aparezca la pantalla de inicio de Muse Dash antes de cerrarlo.
+5. Descarga la última version de [Muse Dash Archipelago Mod](https://github.com/DeamonHunter/ArchipelagoMuseDash/releases/latest) y extraelo en la nueva carpeta creada llamada `/Mods/`, localizada en la carpeta de instalación de Muse Dash.
   - Todos los archivos deben ir directamente en la carpeta `/Mods/`, y NO en una subcarpeta dentro de la carpeta `/Mods/`
 
 Si todo fue instalado correctamente, un botón aparecerá en la parte inferior derecha del juego una vez abierto, que te permitirá conectarte al servidor de Archipelago.

worlds/oot/__init__.py

@@ -173,6 +173,15 @@ class OOTWorld(World):
         "Adult Trade Item": {"Pocket Egg", "Pocket Cucco", "Cojiro", "Odd Mushroom",
             "Odd Potion", "Poachers Saw", "Broken Sword", "Prescription",
             "Eyeball Frog", "Eyedrops", "Claim Check"},
+        "Keys": {"Small Key (Bottom of the Well)", "Small Key (Fire Temple)", "Small Key (Forest Temple)",
+                 "Small Key (Ganons Castle)", "Small Key (Gerudo Training Ground)", "Small Key (Shadow Temple)",
+                 "Small Key (Spirit Temple)", "Small Key (Thieves Hideout)", "Small Key (Water Temple)",
+                 "Small Key Ring (Bottom of the Well)", "Small Key Ring (Fire Temple)",
+                 "Small Key Ring (Forest Temple)", "Small Key Ring (Ganons Castle)",
+                 "Small Key Ring (Gerudo Training Ground)", "Small Key Ring (Shadow Temple)",
+                 "Small Key Ring (Spirit Temple)", "Small Key Ring (Thieves Hideout)", "Small Key Ring (Water Temple)",
+                 "Boss Key (Fire Temple)", "Boss Key (Forest Temple)", "Boss Key (Ganons Castle)",
+                 "Boss Key (Shadow Temple)", "Boss Key (Spirit Temple)", "Boss Key (Water Temple)"},
     }
 
     location_name_groups = build_location_name_groups()
@@ -1173,10 +1182,35 @@ class OOTWorld(World):
 
     def fill_slot_data(self):
         self.collectible_flags_available.wait()
-        return {
+
+        slot_data = {
             'collectible_override_flags': self.collectible_override_flags,
             'collectible_flag_offsets': self.collectible_flag_offsets
         }
+        slot_data.update(self.options.as_dict(
+            "open_forest", "open_kakariko", "open_door_of_time", "zora_fountain", "gerudo_fortress",
+            "bridge", "bridge_stones", "bridge_medallions", "bridge_rewards", "bridge_tokens", "bridge_hearts",
+            "shuffle_ganon_bosskey", "ganon_bosskey_medallions", "ganon_bosskey_stones", "ganon_bosskey_rewards",
+            "ganon_bosskey_tokens", "ganon_bosskey_hearts", "trials",
+            "triforce_hunt", "triforce_goal", "extra_triforce_percentage",
+            "shopsanity", "shop_slots", "shopsanity_prices", "tokensanity",
+            "dungeon_shortcuts", "dungeon_shortcuts_list",
+            "mq_dungeons_mode", "mq_dungeons_list", "mq_dungeons_count",
+            "shuffle_interior_entrances", "shuffle_grotto_entrances", "shuffle_dungeon_entrances",
+            "shuffle_overworld_entrances", "shuffle_bosses", "key_rings", "key_rings_list", "enhance_map_compass",
+            "shuffle_mapcompass", "shuffle_smallkeys", "shuffle_hideoutkeys", "shuffle_bosskeys",
+            "logic_rules", "logic_no_night_tokens_without_suns_song", "logic_tricks",
+            "warp_songs", "shuffle_song_items","shuffle_medigoron_carpet_salesman", "shuffle_frog_song_rupees",
+            "shuffle_scrubs", "shuffle_child_trade", "shuffle_freestanding_items", "shuffle_pots", "shuffle_crates",
+            "shuffle_cows", "shuffle_beehives", "shuffle_kokiri_sword", "shuffle_ocarinas", "shuffle_gerudo_card",
+            "shuffle_beans", "starting_age", "bombchus_in_logic", "spawn_positions", "owl_drops",
+            "no_epona_race", "skip_some_minigame_phases", "complete_mask_quest", "free_scarecrow", "plant_beans",
+            "chicken_count", "big_poe_count", "fae_torch_count", "blue_fire_arrows",
+            "damage_multiplier", "deadly_bonks", "starting_tod", "junk_ice_traps",
+            "start_with_consumables", "adult_trade_start", "plando_connections"
+            )
+        )
+        return slot_data
 
 
     def modify_multidata(self, multidata: dict):

worlds/overcooked2/test/TestOvercooked2.py

@@ -4,10 +4,11 @@ from random import Random
 from worlds.AutoWorld import AutoWorldRegister
 from test.general import setup_solo_multiworld
 
-from worlds.overcooked2.Items import *
+from ..Items import *
-from worlds.overcooked2.Overcooked2Levels import Overcooked2Dlc, Overcooked2Level, OverworldRegion, overworld_region_by_level, level_id_to_shortname
+from ..Overcooked2Levels import (Overcooked2Dlc, Overcooked2Level, OverworldRegion, overworld_region_by_level,
-from worlds.overcooked2.Logic import level_logic, overworld_region_logic, level_shuffle_factory
+                                 level_id_to_shortname)
-from worlds.overcooked2.Locations import oc2_location_name_to_id
+from ..Logic import level_logic, overworld_region_logic, level_shuffle_factory
+from ..Locations import oc2_location_name_to_id
 
 
 class Overcooked2Test(unittest.TestCase):

worlds/raft/Options.py

@@ -32,7 +32,13 @@ class FillerItemTypes(Choice):
     option_both = 2
 
 class IslandFrequencyLocations(Choice):
-    """Sets where frequencies for story islands are located."""
+    """Sets where frequencies for story islands are located.
+    Vanilla will keep frequencies in their vanilla, non-randomized locations.
+    Random On Island will randomize each frequency within its vanilla island, but will preserve island order.
+    Random Island Order will change the order you visit islands, but will preserve the vanilla location of each frequency unlock.
+    Random On Island Random Order will randomize the location containing the frequency on each island and randomize the order.
+    Progressive will randomize the frequencies to anywhere, but will always unlock the frequencies in vanilla order as the frequency items are received.
+    Anywhere will randomize the frequencies to anywhere, and frequencies will be received in any order."""
     display_name = "Frequency locations"
     option_vanilla = 0
     option_random_on_island = 1
@@ -53,7 +59,8 @@ class IslandGenerationDistance(Choice):
     default = 8
 
 class ExpensiveResearch(Toggle):
-    """Makes unlocking items in the Crafting Table consume the researched items."""
+    """If No is selected, researching items and unlocking items in the Crafting Table works the same as vanilla Raft.
+    If Yes is selected, each unlock in the Crafting Table will require its own set of researched items in order to unlock it."""
     display_name = "Expensive research"
 
 class ProgressiveItems(DefaultOnToggle):
@@ -66,8 +73,7 @@ class BigIslandEarlyCrafting(Toggle):
     display_name = "Early recipes behind big islands"
 
 class PaddleboardMode(Toggle):
-    """Sets later story islands to in logic without an Engine or Steering Wheel. May require lots of paddling. Not
+    """Sets later story islands to be in logic without an Engine or Steering Wheel. May require lots of paddling."""
-    recommended."""
     display_name = "Paddleboard Mode"
 
 raft_options = {

worlds/raft/docs/setup_en.md

@@ -17,7 +17,7 @@
 
 4. Open RML and click Play. If you've already installed it, the executable that was used to install RML ("RMLLauncher.exe" unless renamed) should be used to run RML. Raft should start after clicking Play.
 
-5. Open the RML menu. This should open automatically when Raft first loads. If it does not, and you see RML information in the top center of the Raft main menu, press F9 to open it.
+5. Open the RML menu. This should open automatically when Raft first loads. If it does not, and you see RML information in the top center of the Raft main menu, press F9 to open it. If you do not see RML information at the top, close Raft+RML, go back to Step 4 and run RML as administrator.
 
 6. Navigate to the "Mod manager" tab in the left-hand menu.
 

worlds/rogue_legacy/test/TestUnique.py

@@ -1,8 +1,8 @@
 from typing import Dict
 
 from . import RLTestBase
-from worlds.rogue_legacy.Items import RLItemData, item_table
+from ..Items import item_table
-from worlds.rogue_legacy.Locations import RLLocationData, location_table
+from ..Locations import location_table
 
 
 class UniqueTest(RLTestBase):

worlds/sc2/Client.py

@@ -22,10 +22,9 @@ from pathlib import Path
 # CommonClient import first to trigger ModuleUpdater
 from CommonClient import CommonContext, server_loop, ClientCommandProcessor, gui_enabled, get_base_parser
 from Utils import init_logging, is_windows, async_start
-from worlds.sc2 import ItemNames
+from . import ItemNames, Options
-from worlds.sc2.ItemGroups import item_name_groups, unlisted_item_name_groups
+from .ItemGroups import item_name_groups
-from worlds.sc2 import Options
+from .Options import (
-from worlds.sc2.Options import (
     MissionOrder, KerriganPrimalStatus, kerrigan_unit_available, KerriganPresence,
     GameSpeed, GenericUpgradeItems, GenericUpgradeResearch, ColorChoice, GenericUpgradeMissions,
     LocationInclusion, ExtraLocations, MasteryLocations, ChallengeLocations, VanillaLocations,
@@ -46,11 +45,12 @@ from worlds._sc2common import bot
 from worlds._sc2common.bot.data import Race
 from worlds._sc2common.bot.main import run_game
 from worlds._sc2common.bot.player import Bot
-from worlds.sc2.Items import lookup_id_to_name, get_full_item_list, ItemData, type_flaggroups, upgrade_numbers, upgrade_numbers_all
+from .Items import (lookup_id_to_name, get_full_item_list, ItemData, type_flaggroups, upgrade_numbers,
-from worlds.sc2.Locations import SC2WOL_LOC_ID_OFFSET, LocationType, SC2HOTS_LOC_ID_OFFSET
+                    upgrade_numbers_all)
-from worlds.sc2.MissionTables import lookup_id_to_mission, SC2Campaign, lookup_name_to_mission, \
+from .Locations import SC2WOL_LOC_ID_OFFSET, LocationType, SC2HOTS_LOC_ID_OFFSET
-    lookup_id_to_campaign, MissionConnection, SC2Mission, campaign_mission_table, SC2Race, get_no_build_missions
+from .MissionTables import (lookup_id_to_mission, SC2Campaign, lookup_name_to_mission,
-from worlds.sc2.Regions import MissionInfo
+                            lookup_id_to_campaign, MissionConnection, SC2Mission, campaign_mission_table, SC2Race)
+from .Regions import MissionInfo
 
 import colorama
 from Options import Option

worlds/sc2/ClientGui.py

@@ -13,12 +13,12 @@ from kivy.uix.floatlayout import FloatLayout
 from kivy.uix.scrollview import ScrollView
 from kivy.properties import StringProperty
 
-from worlds.sc2.Client import SC2Context, calc_unfinished_missions, parse_unlock
+from .Client import SC2Context, calc_unfinished_missions, parse_unlock
-from worlds.sc2.MissionTables import lookup_id_to_mission, lookup_name_to_mission, campaign_race_exceptions, \
+from .MissionTables import (lookup_id_to_mission, lookup_name_to_mission, campaign_race_exceptions, SC2Mission, SC2Race,
-    SC2Mission, SC2Race, SC2Campaign
+                            SC2Campaign)
-from worlds.sc2.Locations import LocationType, lookup_location_id_to_type
+from .Locations import LocationType, lookup_location_id_to_type
-from worlds.sc2.Options import LocationInclusion
+from .Options import LocationInclusion
-from worlds.sc2 import SC2World, get_first_mission
+from . import SC2World, get_first_mission
 
 
 class HoverableButton(HoverBehavior, Button):

worlds/smw/Client.py

@@ -223,7 +223,7 @@ class SMWSNIClient(SNIClient):
 
         next_trap, message = self.trap_queue.pop(0)
 
-        from worlds.smw.Rom import trap_rom_data
+        from .Rom import trap_rom_data
         if next_trap.item in trap_rom_data:
             trap_active = await snes_read(ctx, WRAM_START + trap_rom_data[next_trap.item][0], 0x3)
 
@@ -349,8 +349,8 @@ class SMWSNIClient(SNIClient):
         blocksanity_flags = bytearray(await snes_read(ctx, SMW_BLOCKSANITY_FLAGS, 0xC))
         blocksanity_active = await snes_read(ctx, SMW_BLOCKSANITY_ACTIVE_ADDR, 0x1)
         level_clear_flags = bytearray(await snes_read(ctx, SMW_LEVEL_CLEAR_FLAGS, 0x60))
-        from worlds.smw.Rom import item_rom_data, ability_rom_data, trap_rom_data, icon_rom_data
+        from .Rom import item_rom_data, ability_rom_data, trap_rom_data, icon_rom_data
-        from worlds.smw.Levels import location_id_to_level_id, level_info_dict, level_blocks_data
+        from .Levels import location_id_to_level_id, level_info_dict, level_blocks_data
         from worlds import AutoWorldRegister
         for loc_name, level_data in location_id_to_level_id.items():
             loc_id = AutoWorldRegister.world_types[ctx.game].location_name_to_id[loc_name]

worlds/subnautica/test/__init__.py

@@ -15,7 +15,7 @@ class SubnauticaTest(unittest.TestCase):
                     self.assertGreater(self.scancutoff, id)
 
     def testGroupAssociation(self):
-        from worlds.subnautica import items
+        from .. import items
         for item_id, item_data in items.item_table.items():
             if item_data.type == items.ItemType.group:
                 with self.subTest(item=item_data.name):

worlds/tunic/__init__.py

@@ -156,9 +156,6 @@ class TunicWorld(World):
         return TunicItem(name, item_data.classification, self.item_name_to_id[name], self.player)
 
     def create_items(self) -> None:
-        keys_behind_bosses = self.options.keys_behind_bosses
-        hexagon_quest = self.options.hexagon_quest
-        sword_progression = self.options.sword_progression
 
         tunic_items: List[TunicItem] = []
         self.slot_data_items = []
@@ -172,7 +169,7 @@ class TunicWorld(World):
         if self.options.start_with_sword:
             self.multiworld.push_precollected(self.create_item("Sword"))
 
-        if sword_progression:
+        if self.options.sword_progression:
             items_to_create["Stick"] = 0
             items_to_create["Sword"] = 0
         else:
@@ -189,9 +186,9 @@ class TunicWorld(World):
             self.slot_data_items.append(laurels)
             items_to_create["Hero's Laurels"] = 0
 
-        if keys_behind_bosses:
+        if self.options.keys_behind_bosses:
             for rgb_hexagon, location in hexagon_locations.items():
-                hex_item = self.create_item(gold_hexagon if hexagon_quest else rgb_hexagon)
+                hex_item = self.create_item(gold_hexagon if self.options.hexagon_quest else rgb_hexagon)
                 self.multiworld.get_location(location, self.player).place_locked_item(hex_item)
                 self.slot_data_items.append(hex_item)
                 items_to_create[rgb_hexagon] = 0
@@ -222,7 +219,7 @@ class TunicWorld(World):
                     ladder_count += 1
             remove_filler(ladder_count)
 
-        if hexagon_quest:
+        if self.options.hexagon_quest:
             # Calculate number of hexagons in item pool
             hexagon_goal = self.options.hexagon_goal
             extra_hexagons = self.options.extra_hexagon_percentage
@@ -238,6 +235,18 @@ class TunicWorld(World):
 
             remove_filler(items_to_create[gold_hexagon])
 
+            for hero_relic in item_name_groups["Hero Relics"]:
+                relic_item = TunicItem(hero_relic, ItemClassification.useful, self.item_name_to_id[hero_relic], self.player)
+                tunic_items.append(relic_item)
+                items_to_create[hero_relic] = 0
+
+        if not self.options.ability_shuffling:
+            for page in item_name_groups["Abilities"]:
+                if items_to_create[page] > 0:
+                    page_item = TunicItem(page, ItemClassification.useful, self.item_name_to_id[page], self.player)
+                    tunic_items.append(page_item)
+                    items_to_create[page] = 0
+
         if self.options.maskless:
             mask_item = TunicItem("Scavenger Mask", ItemClassification.useful, self.item_name_to_id["Scavenger Mask"], self.player)
             tunic_items.append(mask_item)

worlds/tunic/docs/en_TUNIC.md

@@ -82,8 +82,13 @@ Notes:
 - The Entrance Randomizer option must be enabled for it to work.
 - The `direction` field is not supported. Connections are always coupled.
 - For a list of entrance names, check `er_data.py` in the TUNIC world folder or generate a game with the Entrance Randomizer option enabled and check the spoiler log.
-- There is no limit to the number of Shops hard-coded into place.
+- There is no limit to the number of Shops you can plando.
 - If you have more than one shop in a scene, you may be wrong warped when exiting a shop.
 - If you have a shop in every scene, and you have an odd number of shops, it will error out.
 
 See the [Archipelago Plando Guide](../../../tutorial/Archipelago/plando/en) for more information on Plando and Connection Plando.
+
+## Is there anything else I should know?
+You can go to [The TUNIC Randomizer Website](https://rando.tunic.run/) for a list of randomizer features as well as some helpful tips.
+You can use the Fairy Seeking Spell (ULU RDR) to locate the nearest unchecked location.
+You can use the Entrance Seeking Spell (RDR ULU) to locate the nearest unused entrance.

worlds/tunic/er_rules.py

@@ -991,7 +991,8 @@ def set_er_region_rules(world: "TunicWorld", ability_unlocks: Dict[str, int], re
         connecting_region=regions["Spirit Arena Victory"],
         rule=lambda state: (state.has(gold_hexagon, player, world.options.hexagon_goal.value) if
                             world.options.hexagon_quest else
-                            state.has_all({red_hexagon, green_hexagon, blue_hexagon, "Unseal the Heir"}, player)))
+                            (state.has_all({red_hexagon, green_hexagon, blue_hexagon, "Unseal the Heir"}, player)
+                            and state.has_group_unique("Hero Relics", player, 6))))
 
     # connecting the regions portals are in to other portals you can access via ladder storage
     # using has_stick instead of can_ladder_storage since it's already checking the logic rules
@@ -1464,8 +1465,10 @@ def set_er_location_rules(world: "TunicWorld", ability_unlocks: Dict[str, int])
              lambda state: state.has(laurels, player))
 
     # Ziggurat
+    # if ER is off, you still need to get past the Admin or you'll get stuck in lower zig
     set_rule(multiworld.get_location("Rooted Ziggurat Upper - Near Bridge Switch", player),
-             lambda state: has_sword(state, player) or state.has(fire_wand, player))
+             lambda state: has_sword(state, player) or (state.has(fire_wand, player) and (state.has(laurels, player)
+                                                                                          or options.entrance_rando)))
     set_rule(multiworld.get_location("Rooted Ziggurat Lower - After Guarded Fuse", player),
              lambda state: has_sword(state, player) and has_ability(state, player, prayer, options, ability_unlocks))
 

worlds/tunic/items.py

@@ -64,12 +64,12 @@ item_table: Dict[str, TunicItemData] = {
     "HP Offering": TunicItemData(ItemClassification.useful, 6, 48, "Offerings"),
     "MP Offering": TunicItemData(ItemClassification.useful, 3, 49, "Offerings"),
     "SP Offering": TunicItemData(ItemClassification.useful, 2, 50, "Offerings"),
-    "Hero Relic - ATT": TunicItemData(ItemClassification.useful, 1, 51, "Hero Relics"),
+    "Hero Relic - ATT": TunicItemData(ItemClassification.progression_skip_balancing, 1, 51, "Hero Relics"),
-    "Hero Relic - DEF": TunicItemData(ItemClassification.useful, 1, 52, "Hero Relics"),
+    "Hero Relic - DEF": TunicItemData(ItemClassification.progression_skip_balancing, 1, 52, "Hero Relics"),
-    "Hero Relic - HP": TunicItemData(ItemClassification.useful, 1, 53, "Hero Relics"),
+    "Hero Relic - HP": TunicItemData(ItemClassification.progression_skip_balancing, 1, 53, "Hero Relics"),
-    "Hero Relic - MP": TunicItemData(ItemClassification.useful, 1, 54, "Hero Relics"),
+    "Hero Relic - MP": TunicItemData(ItemClassification.progression_skip_balancing, 1, 54, "Hero Relics"),
-    "Hero Relic - POTION": TunicItemData(ItemClassification.useful, 1, 55, "Hero Relics"),
+    "Hero Relic - POTION": TunicItemData(ItemClassification.progression_skip_balancing, 1, 55, "Hero Relics"),
-    "Hero Relic - SP": TunicItemData(ItemClassification.useful, 1, 56, "Hero Relics"),
+    "Hero Relic - SP": TunicItemData(ItemClassification.progression_skip_balancing, 1, 56, "Hero Relics"),
     "Orange Peril Ring": TunicItemData(ItemClassification.useful, 1, 57, "Cards"),
     "Tincture": TunicItemData(ItemClassification.useful, 1, 58, "Cards"),
     "Scavenger Mask": TunicItemData(ItemClassification.progression, 1, 59, "Cards"),
@@ -143,7 +143,6 @@ item_table: Dict[str, TunicItemData] = {
     "Pages 50-51": TunicItemData(ItemClassification.useful, 1, 127, "Pages"),
     "Pages 52-53 (Icebolt)": TunicItemData(ItemClassification.progression, 1, 128, "Pages"),
     "Pages 54-55": TunicItemData(ItemClassification.useful, 1, 129, "Pages"),
-    
     "Ladders near Weathervane": TunicItemData(ItemClassification.progression, 0, 130, "Ladders"),
     "Ladders near Overworld Checkpoint": TunicItemData(ItemClassification.progression, 0, 131, "Ladders"),
     "Ladders near Patrol Cave": TunicItemData(ItemClassification.progression, 0, 132, "Ladders"),

worlds/tunic/rules.py

@@ -128,7 +128,7 @@ def set_region_rules(world: "TunicWorld", ability_unlocks: Dict[str, int]) -> No
         or has_ice_grapple_logic(False, state, player, options, ability_unlocks)
     multiworld.get_entrance("Overworld -> Spirit Arena", player).access_rule = \
         lambda state: (state.has(gold_hexagon, player, options.hexagon_goal.value) if options.hexagon_quest.value
-                       else state.has_all({red_hexagon, green_hexagon, blue_hexagon}, player)) and \
+                       else state.has_all({red_hexagon, green_hexagon, blue_hexagon}, player) and state.has_group_unique("Hero Relics", player, 6)) and \
         has_ability(state, player, prayer, options, ability_unlocks) and has_sword(state, player) and \
         state.has_any({lantern, laurels}, player)
 
@@ -304,6 +304,8 @@ def set_location_rules(world: "TunicWorld", ability_unlocks: Dict[str, int]) ->
     # Quarry
     set_rule(multiworld.get_location("Quarry - [Central] Above Ladder Dash Chest", player),
              lambda state: state.has(laurels, player))
+    set_rule(multiworld.get_location("Rooted Ziggurat Upper - Near Bridge Switch", player),
+             lambda state: has_sword(state, player) or state.has_all({fire_wand, laurels}, player))
     # nmg - kill boss scav with orb + firecracker, or similar
     set_rule(multiworld.get_location("Rooted Ziggurat Lower - Hexagon Blue", player),
              lambda state: has_sword(state, player) or (state.has(grapple, player) and options.logic_rules))

worlds/undertale/Items.py

@@ -105,7 +105,6 @@ item_table = {
 non_key_items = {
     "Butterscotch Pie": 1,
     "500G": 2,
-    "1000G": 2,
     "Face Steak": 1,
     "Snowman Piece": 1,
     "Instant Noodles": 1,
@@ -147,6 +146,7 @@ plot_items = {
 key_items = {
     "Complete Skeleton": 1,
     "Fish": 1,
+    "1000G": 2,
     "DT Extractor": 1,
     "Mettaton Plush": 1,
     "Punch Card": 3,

worlds/undertale/Options.py

@@ -1,5 +1,5 @@
-import typing
+from Options import Choice, Toggle, Range, PerGameCommonOptions
-from Options import Choice, Option, Toggle, Range
+from dataclasses import dataclass
 
 
 class RouteRequired(Choice):
@@ -86,17 +86,17 @@ class RandoBattleOptions(Toggle):
     default = 0
 
 
-undertale_options: typing.Dict[str, type(Option)] = {
+@dataclass
-    "route_required":                           RouteRequired,
+class UndertaleOptions(PerGameCommonOptions):
-    "starting_area":                            StartingArea,
+    route_required:                           RouteRequired
-    "key_hunt":                                 KeyHunt,
+    starting_area:                            StartingArea
-    "key_pieces":                               KeyPieces,
+    key_hunt:                                 KeyHunt
-    "rando_love":                               RandomizeLove,
+    key_pieces:                               KeyPieces
-    "rando_stats":                              RandomizeStats,
+    rando_love:                               RandomizeLove
-    "temy_include":                             IncludeTemy,
+    rando_stats:                              RandomizeStats
-    "no_equips":                                NoEquips,
+    temy_include:                             IncludeTemy
-    "only_flakes":                              OnlyFlakes,
+    no_equips:                                NoEquips
-    "prog_armor":                               ProgressiveArmor,
+    only_flakes:                              OnlyFlakes
-    "prog_weapons":                             ProgressiveWeapons,
+    prog_armor:                               ProgressiveArmor
-    "rando_item_button":                     RandoBattleOptions,
+    prog_weapons:                             ProgressiveWeapons
-}
+    rando_item_button:                        RandoBattleOptions

worlds/undertale/Rules.py

@@ -1,18 +1,22 @@
-from worlds.generic.Rules import set_rule, add_rule, add_item_rule
+from worlds.generic.Rules import set_rule, add_rule
-from BaseClasses import MultiWorld, CollectionState
+from BaseClasses import CollectionState
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from . import UndertaleWorld
 
 
-def _undertale_is_route(state: CollectionState, player: int, route: int):
+def _undertale_is_route(world: "UndertaleWorld", route: int):
     if route == 3:
-        return state.multiworld.route_required[player].current_key == "all_routes"
+        return world.options.route_required.current_key == "all_routes"
-    if state.multiworld.route_required[player].current_key == "all_routes":
+    if world.options.route_required.current_key == "all_routes":
         return True
     if route == 0:
-        return state.multiworld.route_required[player].current_key == "neutral"
+        return world.options.route_required.current_key == "neutral"
     if route == 1:
-        return state.multiworld.route_required[player].current_key == "pacifist"
+        return world.options.route_required.current_key == "pacifist"
     if route == 2:
-        return state.multiworld.route_required[player].current_key == "genocide"
+        return world.options.route_required.current_key == "genocide"
     return False
 
 
@@ -27,7 +31,7 @@ def _undertale_has_plot(state: CollectionState, player: int, item: str):
         return state.has("DT Extractor", player)
 
 
-def _undertale_can_level(state: CollectionState, exp: int, lvl: int):
+def _undertale_can_level(exp: int, lvl: int):
     if exp >= 10 and lvl == 1:
         return True
     elif exp >= 30 and lvl == 2:
@@ -70,7 +74,9 @@ def _undertale_can_level(state: CollectionState, exp: int, lvl: int):
 
 
 # Sets rules on entrances and advancements that are always applied
-def set_rules(multiworld: MultiWorld, player: int):
+def set_rules(world: "UndertaleWorld"):
+    player = world.player
+    multiworld = world.multiworld
     set_rule(multiworld.get_entrance("Ruins Hub", player), lambda state: state.has("Ruins Key", player))
     set_rule(multiworld.get_entrance("Snowdin Hub", player), lambda state: state.has("Snowdin Key", player))
     set_rule(multiworld.get_entrance("Waterfall Hub", player), lambda state: state.has("Waterfall Key", player))
@@ -81,16 +87,16 @@ def set_rules(multiworld: MultiWorld, player: int):
     set_rule(multiworld.get_entrance("New Home Exit", player),
              lambda state: (state.has("Left Home Key", player) and
                             state.has("Right Home Key", player)) or
-                           state.has("Key Piece", player, state.multiworld.key_pieces[player].value))
+                           state.has("Key Piece", player, world.options.key_pieces.value))
-    if _undertale_is_route(multiworld.state, player, 1):
+    if _undertale_is_route(world, 1):
         set_rule(multiworld.get_entrance("Papyrus\" Home Entrance", player),
                  lambda state: _undertale_has_plot(state, player, "Complete Skeleton"))
         set_rule(multiworld.get_entrance("Undyne\"s Home Entrance", player),
                  lambda state: _undertale_has_plot(state, player, "Fish") and state.has("Papyrus Date", player))
         set_rule(multiworld.get_entrance("Lab Elevator", player),
                  lambda state: state.has("Alphys Date", player) and state.has("DT Extractor", player) and
-                                ((state.has("Left Home Key", player) and state.has("Right Home Key", player)) or
+                               ((state.has("Left Home Key", player) and state.has("Right Home Key", player)) or
-                                state.has("Key Piece", player, state.multiworld.key_pieces[player].value)))
+                                 state.has("Key Piece", player, world.options.key_pieces.value)))
         set_rule(multiworld.get_location("Alphys Date", player),
                  lambda state: state.can_reach("New Home", "Region", player) and state.has("Undyne Letter EX", player)
                                and state.has("Undyne Date", player))
@@ -101,7 +107,10 @@ def set_rules(multiworld: MultiWorld, player: int):
         set_rule(multiworld.get_location("True Lab Plot", player),
                  lambda state: state.can_reach("New Home", "Region", player)
                                and state.can_reach("Letter Quest", "Location", player)
-                               and state.can_reach("Alphys Date", "Location", player))
+                               and state.can_reach("Alphys Date", "Location", player)
+                               and ((state.has("Left Home Key", player) and
+                                    state.has("Right Home Key", player)) or
+                                    state.has("Key Piece", player, world.options.key_pieces.value)))
         set_rule(multiworld.get_location("Chisps Machine", player),
                  lambda state: state.can_reach("True Lab", "Region", player))
         set_rule(multiworld.get_location("Dog Sale 1", player),
@@ -118,7 +127,7 @@ def set_rules(multiworld: MultiWorld, player: int):
                  lambda state: state.can_reach("News Show", "Region", player) and state.has("Hot Dog...?", player, 1))
         set_rule(multiworld.get_location("Letter Quest", player),
                  lambda state: state.can_reach("Last Corridor", "Region", player) and state.has("Undyne Date", player))
-    if (not _undertale_is_route(multiworld.state, player, 2)) or _undertale_is_route(multiworld.state, player, 3):
+    if (not _undertale_is_route(world, 2)) or _undertale_is_route(world, 3):
         set_rule(multiworld.get_location("Nicecream Punch Card", player),
                  lambda state: state.has("Punch Card", player, 3) and state.can_reach("Waterfall", "Region", player))
         set_rule(multiworld.get_location("Nicecream Snowdin", player),
@@ -129,26 +138,26 @@ def set_rules(multiworld: MultiWorld, player: int):
                  lambda state: state.can_reach("Waterfall", "Region", player))
         set_rule(multiworld.get_location("Apron Hidden", player),
                  lambda state: state.can_reach("Cooking Show", "Region", player))
-    if _undertale_is_route(multiworld.state, player, 2) and \
+    if _undertale_is_route(world, 2) and \
-            (bool(multiworld.rando_love[player].value) or bool(multiworld.rando_stats[player].value)):
+            (bool(world.options.rando_love.value) or bool(world.options.rando_stats.value)):
         maxlv = 1
         exp = 190
         curarea = "Old Home"
 
         while maxlv < 20:
             maxlv += 1
-            if multiworld.rando_love[player]:
+            if world.options.rando_love:
                 set_rule(multiworld.get_location(("LOVE " + str(maxlv)), player), lambda state: False)
-            if multiworld.rando_stats[player]:
+            if world.options.rando_stats:
                 set_rule(multiworld.get_location(("ATK "+str(maxlv)), player), lambda state: False)
                 set_rule(multiworld.get_location(("HP "+str(maxlv)), player), lambda state: False)
                 if maxlv in {5, 9, 13, 17}:
                     set_rule(multiworld.get_location(("DEF "+str(maxlv)), player), lambda state: False)
         maxlv = 1
         while maxlv < 20:
-            while _undertale_can_level(multiworld.state, exp, maxlv):
+            while _undertale_can_level(exp, maxlv):
                 maxlv += 1
-                if multiworld.rando_stats[player]:
+                if world.options.rando_stats:
                     if curarea == "Old Home":
                         add_rule(multiworld.get_location(("ATK "+str(maxlv)), player),
                                  lambda state: (state.can_reach("Old Home", "Region", player)), combine="or")
@@ -197,7 +206,7 @@ def set_rules(multiworld: MultiWorld, player: int):
                         if maxlv == 5 or maxlv == 9 or maxlv == 13 or maxlv == 17:
                             add_rule(multiworld.get_location(("DEF "+str(maxlv)), player),
                                      lambda state: (state.can_reach("New Home Exit", "Entrance", player)), combine="or")
-                if multiworld.rando_love[player]:
+                if world.options.rando_love:
                     if curarea == "Old Home":
                         add_rule(multiworld.get_location(("LOVE "+str(maxlv)), player),
                                  lambda state: (state.can_reach("Old Home", "Region", player)), combine="or")
@@ -307,9 +316,9 @@ def set_rules(multiworld: MultiWorld, player: int):
 
 
 # Sets rules on completion condition
-def set_completion_rules(multiworld: MultiWorld, player: int):
+def set_completion_rules(world: "UndertaleWorld"):
-    completion_requirements = lambda state: state.can_reach("Barrier", "Region", player)
+    player = world.player
-    if _undertale_is_route(multiworld.state, player, 1):
+    multiworld = world.multiworld
-        completion_requirements = lambda state: state.can_reach("True Lab", "Region", player)
+    multiworld.completion_condition[player] = lambda state: state.can_reach("Barrier", "Region", player)
-
+    if _undertale_is_route(world, 1):
-    multiworld.completion_condition[player] = lambda state: completion_requirements(state)
+        multiworld.completion_condition[player] = lambda state: state.can_reach("True Lab", "Region", player)

worlds/undertale/__init__.py

@@ -5,9 +5,9 @@ from .Regions import undertale_regions, link_undertale_areas
 from .Rules import set_rules, set_completion_rules
 from worlds.generic.Rules import exclusion_rules
 from BaseClasses import Region, Entrance, Tutorial, Item
-from .Options import undertale_options
+from .Options import UndertaleOptions
 from worlds.AutoWorld import World, WebWorld
-from worlds.LauncherComponents import Component, components, Type
+from worlds.LauncherComponents import Component, components
 from multiprocessing import Process
 
 
@@ -46,7 +46,8 @@ class UndertaleWorld(World):
     from their underground prison.
     """
     game = "Undertale"
-    option_definitions = undertale_options
+    options_dataclass = UndertaleOptions
+    options: UndertaleOptions
     web = UndertaleWeb()
 
     item_name_to_id = {name: data.code for name, data in item_table.items()}
@@ -54,39 +55,55 @@ class UndertaleWorld(World):
 
     def _get_undertale_data(self):
         return {
-            "world_seed": self.multiworld.per_slot_randoms[self.player].getrandbits(32),
+            "world_seed": self.random.getrandbits(32),
             "seed_name": self.multiworld.seed_name,
             "player_name": self.multiworld.get_player_name(self.player),
             "player_id": self.player,
             "client_version": self.required_client_version,
             "race": self.multiworld.is_race,
-            "route": self.multiworld.route_required[self.player].current_key,
+            "route": self.options.route_required.current_key,
-            "starting_area": self.multiworld.starting_area[self.player].current_key,
+            "starting_area": self.options.starting_area.current_key,
-            "temy_armor_include": bool(self.multiworld.temy_include[self.player].value),
+            "temy_armor_include": bool(self.options.temy_include.value),
-            "only_flakes": bool(self.multiworld.only_flakes[self.player].value),
+            "only_flakes": bool(self.options.only_flakes.value),
-            "no_equips": bool(self.multiworld.no_equips[self.player].value),
+            "no_equips": bool(self.options.no_equips.value),
-            "key_hunt": bool(self.multiworld.key_hunt[self.player].value),
+            "key_hunt": bool(self.options.key_hunt.value),
-            "key_pieces": self.multiworld.key_pieces[self.player].value,
+            "key_pieces": self.options.key_pieces.value,
-            "rando_love": bool(self.multiworld.rando_love[self.player].value),
+            "rando_love": bool(self.options.rando_love.value),
-            "rando_stats": bool(self.multiworld.rando_stats[self.player].value),
+            "rando_stats": bool(self.options.rando_stats.value),
-            "prog_armor": bool(self.multiworld.prog_armor[self.player].value),
+            "prog_armor": bool(self.options.prog_armor.value),
-            "prog_weapons": bool(self.multiworld.prog_weapons[self.player].value),
+            "prog_weapons": bool(self.options.prog_weapons.value),
-            "rando_item_button": bool(self.multiworld.rando_item_button[self.player].value)
+            "rando_item_button": bool(self.options.rando_item_button.value)
         }
 
+    def get_filler_item_name(self):
+        if self.options.route_required == "all_routes":
+            junk_pool = junk_weights_all
+        elif self.options.route_required == "genocide":
+            junk_pool = junk_weights_genocide
+        elif self.options.route_required == "neutral":
+            junk_pool = junk_weights_neutral
+        elif self.options.route_required == "pacifist":
+            junk_pool = junk_weights_pacifist
+        else:
+            junk_pool = junk_weights_all
+        if not self.options.only_flakes:
+            return self.random.choices(list(junk_pool.keys()), weights=list(junk_pool.values()))[0]
+        else:
+            return "Temmie Flakes"
+
     def create_items(self):
         self.multiworld.get_location("Undyne Date", self.player).place_locked_item(self.create_item("Undyne Date"))
         self.multiworld.get_location("Alphys Date", self.player).place_locked_item(self.create_item("Alphys Date"))
         self.multiworld.get_location("Papyrus Date", self.player).place_locked_item(self.create_item("Papyrus Date"))
         # Generate item pool
         itempool = []
-        if self.multiworld.route_required[self.player] == "all_routes":
+        if self.options.route_required == "all_routes":
             junk_pool = junk_weights_all.copy()
-        elif self.multiworld.route_required[self.player] == "genocide":
+        elif self.options.route_required == "genocide":
             junk_pool = junk_weights_genocide.copy()
-        elif self.multiworld.route_required[self.player] == "neutral":
+        elif self.options.route_required == "neutral":
             junk_pool = junk_weights_neutral.copy()
-        elif self.multiworld.route_required[self.player] == "pacifist":
+        elif self.options.route_required == "pacifist":
             junk_pool = junk_weights_pacifist.copy()
         else:
             junk_pool = junk_weights_all.copy()
@@ -99,73 +116,68 @@ class UndertaleWorld(World):
             itempool += [name] * num
         for name, num in non_key_items.items():
             itempool += [name] * num
-        if self.multiworld.rando_item_button[self.player]:
+        if self.options.rando_item_button:
             itempool += ["ITEM"]
         else:
             self.multiworld.push_precollected(self.create_item("ITEM"))
         self.multiworld.push_precollected(self.create_item("FIGHT"))
         self.multiworld.push_precollected(self.create_item("ACT"))
         self.multiworld.push_precollected(self.create_item("MERCY"))
-        if self.multiworld.route_required[self.player] == "genocide":
+        if self.options.route_required == "genocide":
             itempool = [item for item in itempool if item != "Popato Chisps" and item != "Stained Apron" and
                         item != "Nice Cream" and item != "Hot Cat" and item != "Hot Dog...?" and item != "Punch Card"]
-        elif self.multiworld.route_required[self.player] == "neutral":
+        elif self.options.route_required == "neutral":
             itempool = [item for item in itempool if item != "Popato Chisps" and item != "Hot Cat" and
                         item != "Hot Dog...?"]
-        if self.multiworld.route_required[self.player] == "pacifist" or \
+        if self.options.route_required == "pacifist" or self.options.route_required == "all_routes":
-                self.multiworld.route_required[self.player] == "all_routes":
             itempool += ["Undyne Letter EX"]
         else:
             itempool.remove("Complete Skeleton")
             itempool.remove("Fish")
             itempool.remove("DT Extractor")
             itempool.remove("Hush Puppy")
-        if self.multiworld.key_hunt[self.player]:
+        if self.options.key_hunt:
-            itempool += ["Key Piece"] * self.multiworld.key_pieces[self.player].value
+            itempool += ["Key Piece"] * self.options.key_pieces.value
         else:
             itempool += ["Left Home Key"]
             itempool += ["Right Home Key"]
-        if not self.multiworld.rando_love[self.player] or \
+        if not self.options.rando_love or \
-                (self.multiworld.route_required[self.player] != "genocide" and
+                (self.options.route_required != "genocide" and self.options.route_required != "all_routes"):
-                 self.multiworld.route_required[self.player] != "all_routes"):
             itempool = [item for item in itempool if not item == "LOVE"]
-        if not self.multiworld.rando_stats[self.player] or \
+        if not self.options.rando_stats or \
-                (self.multiworld.route_required[self.player] != "genocide" and
+                (self.options.route_required != "genocide" and self.options.route_required != "all_routes"):
-                 self.multiworld.route_required[self.player] != "all_routes"):
             itempool = [item for item in itempool if not (item == "ATK Up" or item == "DEF Up" or item == "HP Up")]
-        if self.multiworld.temy_include[self.player]:
+        if self.options.temy_include:
             itempool += ["temy armor"]
-        if self.multiworld.no_equips[self.player]:
+        if self.options.no_equips:
             itempool = [item for item in itempool if item not in required_armor and item not in required_weapons]
         else:
-            if self.multiworld.prog_armor[self.player]:
+            if self.options.prog_armor:
                 itempool = [item if (item not in required_armor and not item == "temy armor") else
                             "Progressive Armor" for item in itempool]
-            if self.multiworld.prog_weapons[self.player]:
+            if self.options.prog_weapons:
                 itempool = [item if item not in required_weapons else "Progressive Weapons" for item in itempool]
-        if self.multiworld.route_required[self.player] == "genocide" or \
+        if self.options.route_required == "genocide" or \
-                self.multiworld.route_required[self.player] == "all_routes":
+                self.options.route_required == "all_routes":
-            if not self.multiworld.only_flakes[self.player]:
+            if not self.options.only_flakes:
                 itempool += ["Snowman Piece"] * 2
-            if not self.multiworld.no_equips[self.player]:
+            if not self.options.no_equips:
                 itempool = ["Real Knife" if item == "Worn Dagger" else "The Locket"
                             if item == "Heart Locket" else item for item in itempool]
-        if self.multiworld.only_flakes[self.player]:
+        if self.options.only_flakes:
             itempool = [item for item in itempool if item not in non_key_items]
 
-        starting_key = self.multiworld.starting_area[self.player].current_key.title() + " Key"
+        starting_key = self.options.starting_area.current_key.title() + " Key"
         itempool.remove(starting_key)
         self.multiworld.push_precollected(self.create_item(starting_key))
         # Choose locations to automatically exclude based on settings
         exclusion_pool = set()
-        exclusion_pool.update(exclusion_table[self.multiworld.route_required[self.player].current_key])
+        exclusion_pool.update(exclusion_table[self.options.route_required.current_key])
-        if not self.multiworld.rando_love[self.player] or \
+        if not self.options.rando_love or \
-                (self.multiworld.route_required[self.player] != "genocide" and
+                (self.options.route_required != "genocide" and self.options.route_required != "all_routes"):
-                 self.multiworld.route_required[self.player] != "all_routes"):
             exclusion_pool.update(exclusion_table["NoLove"])
-        if not self.multiworld.rando_stats[self.player] or \
+        if not self.options.rando_stats or \
-                (self.multiworld.route_required[self.player] != "genocide" and
+                (self.options.route_required != "genocide" and self.options.route_required != "all_routes"):
-                 self.multiworld.route_required[self.player] != "all_routes"):
             exclusion_pool.update(exclusion_table["NoStats"])
 
         # Choose locations to automatically exclude based on settings
@@ -173,36 +185,33 @@ class UndertaleWorld(World):
         exclusion_checks.update(["Nicecream Punch Card", "Hush Trade"])
         exclusion_rules(self.multiworld, self.player, exclusion_checks)
 
-        # Fill remaining items with randomly generated junk or Temmie Flakes
-        if not self.multiworld.only_flakes[self.player]:
-            itempool += self.multiworld.random.choices(list(junk_pool.keys()), weights=list(junk_pool.values()),
-                                                       k=len(self.location_names)-len(itempool)-len(exclusion_pool))
-        else:
-            itempool += ["Temmie Flakes"] * (len(self.location_names) - len(itempool) - len(exclusion_pool))
         # Convert itempool into real items
         itempool = [item for item in map(lambda name: self.create_item(name), itempool)]
+        # Fill remaining items with randomly generated junk or Temmie Flakes
+        while len(itempool) < len(self.multiworld.get_unfilled_locations(self.player)):
+            itempool.append(self.create_filler())
 
         self.multiworld.itempool += itempool
 
     def set_rules(self):
-        set_rules(self.multiworld, self.player)
+        set_rules(self)
-        set_completion_rules(self.multiworld, self.player)
+        set_completion_rules(self)
 
     def create_regions(self):
         def UndertaleRegion(region_name: str, exits=[]):
             ret = Region(region_name, self.player, self.multiworld)
             ret.locations += [UndertaleAdvancement(self.player, loc_name, loc_data.id, ret)
-                             for loc_name, loc_data in advancement_table.items()
+                              for loc_name, loc_data in advancement_table.items()
-                             if loc_data.region == region_name and
+                              if loc_data.region == region_name and
-                             (loc_name not in exclusion_table["NoStats"] or
+                              (loc_name not in exclusion_table["NoStats"] or
-                              (self.multiworld.rando_stats[self.player] and
+                              (self.options.rando_stats and
-                               (self.multiworld.route_required[self.player] == "genocide" or
+                               (self.options.route_required == "genocide" or
-                                self.multiworld.route_required[self.player] == "all_routes"))) and
+                                self.options.route_required == "all_routes"))) and
-                             (loc_name not in exclusion_table["NoLove"] or
+                              (loc_name not in exclusion_table["NoLove"] or
-                              (self.multiworld.rando_love[self.player] and
+                              (self.options.rando_love and
-                               (self.multiworld.route_required[self.player] == "genocide" or
+                               (self.options.route_required == "genocide" or
-                                self.multiworld.route_required[self.player] == "all_routes"))) and
+                                self.options.route_required == "all_routes"))) and
-                             loc_name not in exclusion_table[self.multiworld.route_required[self.player].current_key]]
+                              loc_name not in exclusion_table[self.options.route_required.current_key]]
             for exit in exits:
                 ret.exits.append(Entrance(self.player, exit, ret))
             return ret
@@ -212,11 +221,11 @@ class UndertaleWorld(World):
 
     def fill_slot_data(self):
         slot_data = self._get_undertale_data()
-        for option_name in undertale_options:
+        for option_name in self.options.as_dict():
             option = getattr(self.multiworld, option_name)[self.player]
             if (option_name == "rando_love" or option_name == "rando_stats") and \
-                    self.multiworld.route_required[self.player] != "genocide" and \
+                    self.options.route_required != "genocide" and \
-                    self.multiworld.route_required[self.player] != "all_routes":
+                    self.options.route_required != "all_routes":
                 option.value = False
             if slot_data.get(option_name, None) is None and type(option.value) in {str, int}:
                 slot_data[option_name] = int(option.value)

worlds/yoshisisland/Client.py

@@ -87,9 +87,7 @@ class YoshisIslandSNIClient(SNIClient):
 
         if game_mode is None:
             return
-        elif goal_flag[0] != 0x00:
+
-            await ctx.send_msgs([{"cmd": "StatusUpdate", "status": ClientStatus.CLIENT_GOAL}])
-            ctx.finished_game = True
         elif game_mode[0] not in VALID_GAME_STATES:
             return
         elif item_received[0] > 0x00:
@@ -101,6 +99,10 @@ class YoshisIslandSNIClient(SNIClient):
             ctx.rom = None
             return
 
+        if goal_flag[0] != 0x00:
+            await ctx.send_msgs([{"cmd": "StatusUpdate", "status": ClientStatus.CLIENT_GOAL}])
+            ctx.finished_game = True
+
         new_checks = []
         from .Rom import location_table
 

worlds/zillion/test/TestOptions.py

@@ -1,6 +1,6 @@
 from . import ZillionTestBase
 
-from worlds.zillion.options import ZillionJumpLevels, ZillionGunLevels, ZillionOptions, validate
+from ..options import ZillionJumpLevels, ZillionGunLevels, ZillionOptions, validate
 from zilliandomizer.options import VBLR_CHOICES
 
 

worlds/zillion/test/TestReproducibleRandom.py

@@ -1,7 +1,7 @@
 from typing import cast
 from . import ZillionTestBase
 
-from worlds.zillion import ZillionWorld
+from .. import ZillionWorld
 
 
 class SeedTest(ZillionTestBase):

worlds/zillion/test/__init__.py

@@ -1,6 +1,6 @@
 from typing import cast
 from test.bases import WorldTestBase
-from worlds.zillion import ZillionWorld
+from .. import ZillionWorld
 
 
 class ZillionTestBase(WorldTestBase):