Update BaseClasses.py

https://discord.com/channels/731205301247803413/1214608557077700720/1283880700126302228

:)

BaseClasses.py

@@ -335,6 +335,13 @@ class MultiWorld():
             for item_name, item_count in next(iter(common_item_count.values())).items():
                 for _ in range(item_count):
                     new_item = group["world"].create_item(item_name)
+
+                    # Make sure this item is picked up even if it is not progression
+                    # (Monkeypatching a property is kind of hard, this is one of the only ways)
+                    class AdvancementTrue(new_item.__class__):
+                        advancement = True
+                    new_item.__class__ = AdvancementTrue
+
                     # mangle together all original classification bits
                     new_item.classification |= classifications[item_name]
                     new_itempool.append(new_item)
@@ -1207,7 +1214,7 @@ class ItemClassification(IntFlag):
     filler = 0b0000  # aka trash, as in filler items like ammo, currency etc,
     progression = 0b0001  # Item that is logically relevant
     useful = 0b0010  # Item that is generally quite useful, but not required for anything logical
-    trap = 0b0100  # detrimental or entirely useless (nothing) item
+    trap = 0b0100  # detrimental item
     skip_balancing = 0b1000  # should technically never occur on its own
     # Item that is logically relevant, but progression balancing should not touch.
     # Typically currency or other counted items.

CommonClient.py

@@ -662,17 +662,19 @@ class CommonContext:
         logger.exception(msg, exc_info=exc_info, extra={'compact_gui': True})
         self._messagebox_connection_loss = self.gui_error(msg, exc_info[1])
 
-    def run_gui(self):
-        """Import kivy UI system and start running it as self.ui_task."""
+    def make_gui(self) -> typing.Type["kvui.GameManager"]:
+        """To return the Kivy App class needed for run_gui so it can be overridden before being built"""
         from kvui import GameManager
 
         class TextManager(GameManager):
-            logging_pairs = [
-                ("Client", "Archipelago")
-            ]
             base_title = "Archipelago Text Client"
 
-        self.ui = TextManager(self)
+        return TextManager
+
+    def run_gui(self):
+        """Import kivy UI system from make_gui() and start running it as self.ui_task."""
+        ui_class = self.make_gui()
+        self.ui = ui_class(self)
         self.ui_task = asyncio.create_task(self.ui.async_run(), name="UI")
 
     def run_cli(self):
@@ -994,7 +996,7 @@ def get_base_parser(description: typing.Optional[str] = None):
     return parser
 
 
-def run_as_textclient():
+def run_as_textclient(*args):
     class TextContext(CommonContext):
         # Text Mode to use !hint and such with games that have no text entry
         tags = CommonContext.tags | {"TextOnly"}
@@ -1033,15 +1035,18 @@ def run_as_textclient():
     parser = get_base_parser(description="Gameless Archipelago Client, for text interfacing.")
     parser.add_argument('--name', default=None, help="Slot Name to connect as.")
     parser.add_argument("url", nargs="?", help="Archipelago connection url")
-    args = parser.parse_args()
+    args = parser.parse_args(args)
 
     if args.url:
         url = urllib.parse.urlparse(args.url)
-        args.connect = url.netloc
-        if url.username:
-            args.name = urllib.parse.unquote(url.username)
-        if url.password:
-            args.password = urllib.parse.unquote(url.password)
+        if url.scheme == "archipelago":
+            args.connect = url.netloc
+            if url.username:
+                args.name = urllib.parse.unquote(url.username)
+            if url.password:
+                args.password = urllib.parse.unquote(url.password)
+        else:
+            parser.error(f"bad url, found {args.url}, expected url in form of archipelago://archipelago.gg:38281")
 
     colorama.init()
 
@@ -1051,4 +1056,4 @@ def run_as_textclient():
 
 if __name__ == '__main__':
     logging.getLogger().setLevel(logging.INFO)  # force log-level to work around log level resetting to WARNING
-    run_as_textclient()
+    run_as_textclient(*sys.argv[1:])  # default value for parse_args

Generate.py

@@ -155,6 +155,7 @@ def main(args=None) -> Tuple[argparse.Namespace, int]:
     erargs.outputpath = args.outputpath
     erargs.skip_prog_balancing = args.skip_prog_balancing
     erargs.skip_output = args.skip_output
+    erargs.name = {}
 
     settings_cache: Dict[str, Tuple[argparse.Namespace, ...]] = \
         {fname: (tuple(roll_settings(yaml, args.plando) for yaml in yamls) if args.sameoptions else None)
@@ -202,7 +203,7 @@ def main(args=None) -> Tuple[argparse.Namespace, int]:
 
                     if path == args.weights_file_path:  # if name came from the weights file, just use base player name
                         erargs.name[player] = f"Player{player}"
-                    elif not erargs.name[player]:  # if name was not specified, generate it from filename
+                    elif player not in erargs.name:  # if name was not specified, generate it from filename
                         erargs.name[player] = os.path.splitext(os.path.split(path)[-1])[0]
                     erargs.name[player] = handle_name(erargs.name[player], player, name_counter)
 

Launcher.py

@@ -16,10 +16,11 @@ import multiprocessing
 import shlex
 import subprocess
 import sys
+import urllib.parse
 import webbrowser
 from os.path import isfile
 from shutil import which
-from typing import Callable, Sequence, Union, Optional
+from typing import Callable, Optional, Sequence, Tuple, Union
 
 import Utils
 import settings
@@ -107,7 +108,81 @@ components.extend([
 ])
 
 
-def identify(path: Union[None, str]):
+def handle_uri(path: str, launch_args: Tuple[str, ...]) -> None:
+    url = urllib.parse.urlparse(path)
+    queries = urllib.parse.parse_qs(url.query)
+    launch_args = (path, *launch_args)
+    client_component = None
+    text_client_component = None
+    if "game" in queries:
+        game = queries["game"][0]
+    else:  # TODO around 0.6.0 - this is for pre this change webhost uri's
+        game = "Archipelago"
+    for component in components:
+        if component.supports_uri and component.game_name == game:
+            client_component = component
+        elif component.display_name == "Text Client":
+            text_client_component = component
+
+    from kvui import App, Button, BoxLayout, Label, Clock, Window
+
+    class Popup(App):
+        timer_label: Label
+        remaining_time: Optional[int]
+
+        def __init__(self):
+            self.title = "Connect to Multiworld"
+            self.icon = r"data/icon.png"
+            super().__init__()
+
+        def build(self):
+            layout = BoxLayout(orientation="vertical")
+
+            if client_component is None:
+                self.remaining_time = 7
+                label_text = (f"A game client able to parse URIs was not detected for {game}.\n"
+                              f"Launching Text Client in 7 seconds...")
+                self.timer_label = Label(text=label_text)
+                layout.add_widget(self.timer_label)
+                Clock.schedule_interval(self.update_label, 1)
+            else:
+                layout.add_widget(Label(text="Select client to open and connect with."))
+                button_row = BoxLayout(orientation="horizontal", size_hint=(1, 0.4))
+
+                text_client_button = Button(
+                    text=text_client_component.display_name,
+                    on_release=lambda *args: run_component(text_client_component, *launch_args)
+                )
+                button_row.add_widget(text_client_button)
+
+                game_client_button = Button(
+                    text=client_component.display_name,
+                    on_release=lambda *args: run_component(client_component, *launch_args)
+                )
+                button_row.add_widget(game_client_button)
+
+                layout.add_widget(button_row)
+
+            return layout
+
+        def update_label(self, dt):
+            if self.remaining_time > 1:
+                # countdown the timer and string replace the number
+                self.remaining_time -= 1
+                self.timer_label.text = self.timer_label.text.replace(
+                    str(self.remaining_time + 1), str(self.remaining_time)
+                )
+            else:
+                # our timer is finished so launch text client and close down
+                run_component(text_client_component, *launch_args)
+                Clock.unschedule(self.update_label)
+                App.get_running_app().stop()
+                Window.close()
+
+    Popup().run()
+
+
+def identify(path: Union[None, str]) -> Tuple[Union[None, str], Union[None, Component]]:
     if path is None:
         return None, None
     for component in components:
@@ -299,20 +374,24 @@ def main(args: Optional[Union[argparse.Namespace, dict]] = None):
     elif not args:
         args = {}
 
-    if args.get("Patch|Game|Component", None) is not None:
-        file, component = identify(args["Patch|Game|Component"])
+    path = args.get("Patch|Game|Component|url", None)
+    if path is not None:
+        if path.startswith("archipelago://"):
+            handle_uri(path, args.get("args", ()))
+            return
+        file, component = identify(path)
         if file:
             args['file'] = file
         if component:
             args['component'] = component
         if not component:
-            logging.warning(f"Could not identify Component responsible for {args['Patch|Game|Component']}")
+            logging.warning(f"Could not identify Component responsible for {path}")
 
     if args["update_settings"]:
         update_settings()
-    if 'file' in args:
+    if "file" in args:
         run_component(args["component"], args["file"], *args["args"])
-    elif 'component' in args:
+    elif "component" in args:
         run_component(args["component"], *args["args"])
     elif not args["update_settings"]:
         run_gui()
@@ -322,12 +401,16 @@ if __name__ == '__main__':
     init_logging('Launcher')
     Utils.freeze_support()
     multiprocessing.set_start_method("spawn")  # if launched process uses kivy, fork won't work
-    parser = argparse.ArgumentParser(description='Archipelago Launcher')
+    parser = argparse.ArgumentParser(
+        description='Archipelago Launcher',
+        usage="[-h] [--update_settings] [Patch|Game|Component] [-- component args here]"
+    )
     run_group = parser.add_argument_group("Run")
     run_group.add_argument("--update_settings", action="store_true",
                            help="Update host.yaml and exit.")
-    run_group.add_argument("Patch|Game|Component", type=str, nargs="?",
-                           help="Pass either a patch file, a generated game or the name of a component to run.")
+    run_group.add_argument("Patch|Game|Component|url", type=str, nargs="?",
+                           help="Pass either a patch file, a generated game, the component name to run, or a url to "
+                                "connect with.")
     run_group.add_argument("args", nargs="*",
                            help="Arguments to pass to component.")
     main(parser.parse_args())

Options.py

@@ -973,7 +973,19 @@ class PlandoTexts(Option[typing.List[PlandoText]], VerifyKeys):
                     if random.random() < float(text.get("percentage", 100)/100):
                         at = text.get("at", None)
                         if at is not None:
+                            if isinstance(at, dict):
+                                if at:
+                                    at = random.choices(list(at.keys()),
+                                                        weights=list(at.values()), k=1)[0]
+                                else:
+                                    raise OptionError("\"at\" must be a valid string or weighted list of strings!")
                             given_text = text.get("text", [])
+                            if isinstance(given_text, dict):
+                                if not given_text:
+                                    given_text = []
+                                else:
+                                    given_text = random.choices(list(given_text.keys()),
+                                                                weights=list(given_text.values()), k=1)
                             if isinstance(given_text, str):
                                 given_text = [given_text]
                             texts.append(PlandoText(
@@ -981,6 +993,8 @@ class PlandoTexts(Option[typing.List[PlandoText]], VerifyKeys):
                                 given_text,
                                 text.get("percentage", 100)
                             ))
+                        else:
+                            raise OptionError("\"at\" must be a valid string or weighted list of strings!")
                 elif isinstance(text, PlandoText):
                     if random.random() < float(text.percentage/100):
                         texts.append(text)

WebHostLib/templates/macros.html

@@ -22,7 +22,7 @@
             {% for patch in room.seed.slots|list|sort(attribute="player_id") %}
                 <tr>
                     <td>{{ patch.player_id }}</td>
-                    <td data-tooltip="Connect via TextClient"><a href="archipelago://{{ patch.player_name | e}}:None@{{ config['HOST_ADDRESS'] }}:{{ room.last_port }}">{{ patch.player_name }}</a></td>
+                    <td data-tooltip="Connect via Game Client"><a href="archipelago://{{ patch.player_name | e}}:None@{{ config['HOST_ADDRESS'] }}:{{ room.last_port }}?game={{ patch.game }}&room={{ room.id | suuid }}">{{ patch.player_name }}</a></td>
                     <td>{{ patch.game }}</td>
                     <td>
                         {% if patch.data %}

docs/CODEOWNERS

@@ -46,7 +46,7 @@
 /worlds/clique/ @ThePhar
 
 # Dark Souls III
-/worlds/dark_souls_3/ @Marechal-L
+/worlds/dark_souls_3/ @Marechal-L @nex3
 
 # Donkey Kong Country 3
 /worlds/dkc3/ @PoryGone

inno_setup.iss

@@ -228,8 +228,8 @@ Root: HKCR; Subkey: "{#MyAppName}worlddata\shell\open\command"; ValueData: """{a
 
 Root: HKCR; Subkey: "archipelago"; ValueType: "string"; ValueData: "Archipegalo Protocol"; Flags: uninsdeletekey;
 Root: HKCR; Subkey: "archipelago"; ValueType: "string"; ValueName: "URL Protocol"; ValueData: "";
-Root: HKCR; Subkey: "archipelago\DefaultIcon"; ValueType: "string"; ValueData: "{app}\ArchipelagoTextClient.exe,0";
-Root: HKCR; Subkey: "archipelago\shell\open\command"; ValueType: "string"; ValueData: """{app}\ArchipelagoTextClient.exe"" ""%1""";
+Root: HKCR; Subkey: "archipelago\DefaultIcon"; ValueType: "string"; ValueData: "{app}\ArchipelagoLauncher.exe,0";
+Root: HKCR; Subkey: "archipelago\shell\open\command"; ValueType: "string"; ValueData: """{app}\ArchipelagoLauncher.exe"" ""%1""";
 
 [Code]
 // See: https://stackoverflow.com/a/51614652/2287576

worlds/LauncherComponents.py

@@ -26,10 +26,13 @@ class Component:
     cli: bool
     func: Optional[Callable]
     file_identifier: Optional[Callable[[str], bool]]
+    game_name: Optional[str]
+    supports_uri: Optional[bool]
 
     def __init__(self, display_name: str, script_name: Optional[str] = None, frozen_name: Optional[str] = None,
                  cli: bool = False, icon: str = 'icon', component_type: Optional[Type] = None,
-                 func: Optional[Callable] = None, file_identifier: Optional[Callable[[str], bool]] = None):
+                 func: Optional[Callable] = None, file_identifier: Optional[Callable[[str], bool]] = None,
+                 game_name: Optional[str] = None, supports_uri: Optional[bool] = False):
         self.display_name = display_name
         self.script_name = script_name
         self.frozen_name = frozen_name or f'Archipelago{script_name}' if script_name else None
@@ -45,6 +48,8 @@ class Component:
             Type.ADJUSTER if "Adjuster" in display_name else Type.MISC)
         self.func = func
         self.file_identifier = file_identifier
+        self.game_name = game_name
+        self.supports_uri = supports_uri
 
     def handles_file(self, path: str):
         return self.file_identifier(path) if self.file_identifier else False
@@ -56,10 +61,10 @@ class Component:
 processes = weakref.WeakSet()
 
 
-def launch_subprocess(func: Callable, name: str = None):
+def launch_subprocess(func: Callable, name: str = None, args: Tuple[str, ...] = ()) -> None:
     global processes
     import multiprocessing
-    process = multiprocessing.Process(target=func, name=name)
+    process = multiprocessing.Process(target=func, name=name, args=args)
     process.start()
     processes.add(process)
 
@@ -78,9 +83,9 @@ class SuffixIdentifier:
         return False
 
 
-def launch_textclient():
+def launch_textclient(*args):
     import CommonClient
-    launch_subprocess(CommonClient.run_as_textclient, name="TextClient")
+    launch_subprocess(CommonClient.run_as_textclient, name="TextClient", args=args)
 
 
 def _install_apworld(apworld_src: str = "") -> Optional[Tuple[pathlib.Path, pathlib.Path]]:

worlds/_bizhawk/context.py

@@ -59,14 +59,10 @@ class BizHawkClientContext(CommonContext):
         self.bizhawk_ctx = BizHawkContext()
         self.watcher_timeout = 0.5
 
-    def run_gui(self):
-        from kvui import GameManager
-
-        class BizHawkManager(GameManager):
-            base_title = "Archipelago BizHawk Client"
-
-        self.ui = BizHawkManager(self)
-        self.ui_task = asyncio.create_task(self.ui.async_run(), name="UI")
+    def make_gui(self):
+        ui = super().make_gui()
+        ui.base_title = "Archipelago BizHawk Client"
+        return ui
 
     def on_package(self, cmd, args):
         if cmd == "Connected":

worlds/alttp/Options.py

@@ -728,7 +728,7 @@ class ALttPPlandoConnections(PlandoConnections):
     entrances = set([connection[0] for connection in (
         *default_connections, *default_dungeon_connections, *inverted_default_connections,
         *inverted_default_dungeon_connections)])
-    exits = set([connection[1] for connection in (
+    exits = set([connection[0] for connection in (
         *default_connections, *default_dungeon_connections, *inverted_default_connections,
         *inverted_default_dungeon_connections)])
 

worlds/messenger/__init__.py

@@ -19,7 +19,7 @@ from .shop import FIGURINES, PROG_SHOP_ITEMS, SHOP_ITEMS, USEFUL_SHOP_ITEMS, shu
 from .subclasses import MessengerEntrance, MessengerItem, MessengerRegion, MessengerShopLocation
 
 components.append(
-    Component("The Messenger", component_type=Type.CLIENT, func=launch_game)#, game_name="The Messenger", supports_uri=True)
+    Component("The Messenger", component_type=Type.CLIENT, func=launch_game, game_name="The Messenger", supports_uri=True)
 )
 
 
@@ -27,6 +27,7 @@ class MessengerSettings(Group):
     class GamePath(FilePath):
         description = "The Messenger game executable"
         is_exe = True
+        md5s = ["1b53534569060bc06179356cd968ed1d"]
 
     game_path: GamePath = GamePath("TheMessenger.exe")
 

worlds/messenger/client_setup.py

@@ -1,10 +1,10 @@
+import argparse
 import io
 import logging
 import os.path
 import subprocess
 import urllib.request
 from shutil import which
-from tkinter.messagebox import askyesnocancel
 from typing import Any, Optional
 from zipfile import ZipFile
 from Utils import open_file
@@ -17,11 +17,33 @@ from Utils import is_windows, messagebox, tuplize_version
 MOD_URL = "https://api.github.com/repos/alwaysintreble/TheMessengerRandomizerModAP/releases/latest"
 
 
-def launch_game(url: Optional[str] = None) -> None:
+def ask_yes_no_cancel(title: str, text: str) -> Optional[bool]:
+    """
+    Wrapper for tkinter.messagebox.askyesnocancel, that creates a popup dialog box with yes, no, and cancel buttons.
+
+    :param title: Title to be displayed at the top of the message box.
+    :param text: Text to be displayed inside the message box.
+    :return: Returns True if yes, False if no, None if cancel.
+    """
+    from tkinter import Tk, messagebox
+    root = Tk()
+    root.withdraw()
+    ret = messagebox.askyesnocancel(title, text)
+    root.update()
+    return ret
+
+
+
+def launch_game(*args) -> None:
     """Check the game installation, then launch it"""
     def courier_installed() -> bool:
         """Check if Courier is installed"""
-        return os.path.exists(os.path.join(game_folder, "TheMessenger_Data", "Managed", "Assembly-CSharp.Courier.mm.dll"))
+        assembly_path = os.path.join(game_folder, "TheMessenger_Data", "Managed", "Assembly-CSharp.dll")
+        with open(assembly_path, "rb") as assembly:
+            for line in assembly:
+                if b"Courier" in line:
+                    return True
+        return False
 
     def mod_installed() -> bool:
         """Check if the mod is installed"""
@@ -56,27 +78,34 @@ def launch_game(url: Optional[str] = None) -> None:
         if not is_windows:
             mono_exe = which("mono")
             if not mono_exe:
-                # steam deck support but doesn't currently work
-                messagebox("Failure", "Failed to install Courier", True)
-                raise RuntimeError("Failed to install Courier")
-                # # download and use mono kickstart
-                # # this allows steam deck support
-                # mono_kick_url = "https://github.com/flibitijibibo/MonoKickstart/archive/refs/heads/master.zip"
-                # target = os.path.join(folder, "monoKickstart")
-                # os.makedirs(target, exist_ok=True)
-                # with urllib.request.urlopen(mono_kick_url) as download:
-                #     with ZipFile(io.BytesIO(download.read()), "r") as zf:
-                #         for member in zf.infolist():
-                #             zf.extract(member, path=target)
-                # installer = subprocess.Popen([os.path.join(target, "precompiled"),
-                #                               os.path.join(folder, "MiniInstaller.exe")], shell=False)
-                # os.remove(target)
+                # download and use mono kickstart
+                # this allows steam deck support
+                mono_kick_url = "https://github.com/flibitijibibo/MonoKickstart/archive/716f0a2bd5d75138969090494a76328f39a6dd78.zip"
+                files = []
+                with urllib.request.urlopen(mono_kick_url) as download:
+                    with ZipFile(io.BytesIO(download.read()), "r") as zf:
+                        for member in zf.infolist():
+                            if "precompiled/" not in member.filename or member.filename.endswith("/"):
+                                continue
+                            member.filename = member.filename.split("/")[-1]
+                            if member.filename.endswith("bin.x86_64"):
+                                member.filename = "MiniInstaller.bin.x86_64"
+                            zf.extract(member, path=game_folder)
+                            files.append(member.filename)
+                mono_installer = os.path.join(game_folder, "MiniInstaller.bin.x86_64")
+                os.chmod(mono_installer, 0o755)
+                installer = subprocess.Popen(mono_installer, shell=False)
+                failure = installer.wait()
+                for file in files:
+                    os.remove(file)
             else:
-                installer = subprocess.Popen([mono_exe, os.path.join(game_folder, "MiniInstaller.exe")], shell=False)
+                installer = subprocess.Popen([mono_exe, os.path.join(game_folder, "MiniInstaller.exe")], shell=True)
+                failure = installer.wait()
         else:
-            installer = subprocess.Popen(os.path.join(game_folder, "MiniInstaller.exe"), shell=False)
+            installer = subprocess.Popen(os.path.join(game_folder, "MiniInstaller.exe"), shell=True)
+            failure = installer.wait()
 
-        failure = installer.wait()
+        print(failure)
         if failure:
             messagebox("Failure", "Failed to install Courier", True)
             os.chdir(working_directory)
@@ -124,18 +153,35 @@ def launch_game(url: Optional[str] = None) -> None:
         return "alpha" in latest_version or tuplize_version(latest_version) > tuplize_version(installed_version)
 
     from . import MessengerWorld
-    game_folder = os.path.dirname(MessengerWorld.settings.game_path)
+    try:
+        game_folder = os.path.dirname(MessengerWorld.settings.game_path)
+    except ValueError as e:
+        logging.error(e)
+        messagebox("Invalid File", "Selected file did not match expected hash. "
+                   "Please try again and ensure you select The Messenger.exe.")
+        return
     working_directory = os.getcwd()
+    # setup ssl context
+    try:
+        import certifi
+        import ssl
+        context = ssl.create_default_context(ssl.Purpose.SERVER_AUTH, cafile=certifi.where())
+        context.set_alpn_protocols(["http/1.1"])
+        https_handler = urllib.request.HTTPSHandler(context=context)
+        opener = urllib.request.build_opener(https_handler)
+        urllib.request.install_opener(opener)
+    except ImportError:
+        pass
     if not courier_installed():
-        should_install = askyesnocancel("Install Courier",
-                                        "No Courier installation detected. Would you like to install now?")
+        should_install = ask_yes_no_cancel("Install Courier",
+                                           "No Courier installation detected. Would you like to install now?")
         if not should_install:
             return
         logging.info("Installing Courier")
         install_courier()
     if not mod_installed():
-        should_install = askyesnocancel("Install Mod",
-                                        "No randomizer mod detected. Would you like to install now?")
+        should_install = ask_yes_no_cancel("Install Mod",
+                                           "No randomizer mod detected. Would you like to install now?")
         if not should_install:
             return
         logging.info("Installing Mod")
@@ -143,22 +189,33 @@ def launch_game(url: Optional[str] = None) -> None:
     else:
         latest = request_data(MOD_URL)["tag_name"]
         if available_mod_update(latest):
-            should_update = askyesnocancel("Update Mod",
-                                           f"New mod version detected. Would you like to update to {latest} now?")
+            should_update = ask_yes_no_cancel("Update Mod",
+                                              f"New mod version detected. Would you like to update to {latest} now?")
             if should_update:
                 logging.info("Updating mod")
                 install_mod()
             elif should_update is None:
                 return
+
+    if not args:
+        should_launch = ask_yes_no_cancel("Launch Game",
+                                          "Mod installed and up to date. Would you like to launch the game now?")
+        if not should_launch:
+            return
+
+    parser = argparse.ArgumentParser(description="Messenger Client Launcher")
+    parser.add_argument("url", type=str, nargs="?", help="Archipelago Webhost uri to auto connect to.")
+    args = parser.parse_args(args)
+
     if not is_windows:
-        if url:
-            open_file(f"steam://rungameid/764790//{url}/")
+        if args.url:
+            open_file(f"steam://rungameid/764790//{args.url}/")
         else:
             open_file("steam://rungameid/764790")
     else:
         os.chdir(game_folder)
-        if url:
-            subprocess.Popen([MessengerWorld.settings.game_path, str(url)])
+        if args.url:
+            subprocess.Popen([MessengerWorld.settings.game_path, str(args.url)])
         else:
             subprocess.Popen(MessengerWorld.settings.game_path)
         os.chdir(working_directory)

worlds/pokemon_emerald/__init__.py

@@ -711,6 +711,7 @@ class PokemonEmeraldWorld(World):
             "trainersanity",
             "modify_118",
             "death_link",
+            "normalize_encounter_rates",
         )
         slot_data["free_fly_location_id"] = self.free_fly_location_id
         slot_data["hm_requirements"] = self.hm_requirements

worlds/pokemon_emerald/data.py

@@ -276,15 +276,13 @@ def _str_to_pokemon_data_type(string: str) -> TrainerPokemonDataTypeEnum:
         return TrainerPokemonDataTypeEnum.ITEM_CUSTOM_MOVES
 
 
-@dataclass
-class TrainerPokemonData:
+class TrainerPokemonData(NamedTuple):
     species_id: int
     level: int
     moves: Optional[Tuple[int, int, int, int]]
 
 
-@dataclass
-class TrainerPartyData:
+class TrainerPartyData(NamedTuple):
     pokemon: List[TrainerPokemonData]
     pokemon_data_type: TrainerPokemonDataTypeEnum
     address: int

worlds/pokemon_emerald/opponents.py

@@ -1,6 +1,6 @@
 from typing import TYPE_CHECKING, Dict, List, Set
 
-from .data import NUM_REAL_SPECIES, UNEVOLVED_POKEMON, TrainerPokemonData, data
+from .data import NUM_REAL_SPECIES, UNEVOLVED_POKEMON, data
 from .options import RandomizeTrainerParties
 from .pokemon import filter_species_by_nearby_bst
 from .util import int_to_bool_array
@@ -111,6 +111,6 @@ def randomize_opponent_parties(world: "PokemonEmeraldWorld") -> None:
                 hm_moves[3] if world.random.random() < 0.25 else level_up_moves[3]
             )
 
-            new_party.append(TrainerPokemonData(new_species.species_id, pokemon.level, new_moves))
+            new_party.append(pokemon._replace(species_id=new_species.species_id, moves=new_moves))
 
-        trainer.party.pokemon = new_party
+        trainer.party = trainer.party._replace(pokemon=new_party)

worlds/pokemon_emerald/pokemon.py

@@ -4,8 +4,7 @@ Functions related to pokemon species and moves
 import functools
 from typing import TYPE_CHECKING, Dict, List, Set, Optional, Tuple
 
-from .data import (NUM_REAL_SPECIES, OUT_OF_LOGIC_MAPS, EncounterTableData, LearnsetMove, MiscPokemonData,
-                   SpeciesData, data)
+from .data import (NUM_REAL_SPECIES, OUT_OF_LOGIC_MAPS, EncounterTableData, LearnsetMove, SpeciesData, data)
 from .options import (Goal, HmCompatibility, LevelUpMoves, RandomizeAbilities, RandomizeLegendaryEncounters,
                       RandomizeMiscPokemon, RandomizeStarters, RandomizeTypes, RandomizeWildPokemon,
                       TmTutorCompatibility)
@@ -461,7 +460,7 @@ def randomize_learnsets(world: "PokemonEmeraldWorld") -> None:
                                            type_bias, normal_bias, species.types)
             else:
                 new_move = 0
-            new_learnset.append(LearnsetMove(old_learnset[cursor].level, new_move))
+            new_learnset.append(old_learnset[cursor]._replace(move_id=new_move))
             cursor += 1
 
         # All moves from here onward are actual moves.
@@ -473,7 +472,7 @@ def randomize_learnsets(world: "PokemonEmeraldWorld") -> None:
                 new_move = get_random_move(world.random,
                                            {move.move_id for move in new_learnset} | world.blacklisted_moves,
                                            type_bias, normal_bias, species.types)
-            new_learnset.append(LearnsetMove(old_learnset[cursor].level, new_move))
+            new_learnset.append(old_learnset[cursor]._replace(move_id=new_move))
             cursor += 1
 
         species.learnset = new_learnset
@@ -581,8 +580,10 @@ def randomize_starters(world: "PokemonEmeraldWorld") -> None:
             picked_evolution = world.random.choice(potential_evolutions)
 
         for trainer_name, starter_position, is_evolved in rival_teams[i]:
+            new_species_id = picked_evolution if is_evolved else starter.species_id
             trainer_data = world.modified_trainers[data.constants[trainer_name]]
-            trainer_data.party.pokemon[starter_position].species_id = picked_evolution if is_evolved else starter.species_id
+            trainer_data.party.pokemon[starter_position] = \
+                trainer_data.party.pokemon[starter_position]._replace(species_id=new_species_id)
 
 
 def randomize_legendary_encounters(world: "PokemonEmeraldWorld") -> None:
@@ -594,10 +595,7 @@ def randomize_legendary_encounters(world: "PokemonEmeraldWorld") -> None:
         world.random.shuffle(shuffled_species)
 
         for i, encounter in enumerate(data.legendary_encounters):
-            world.modified_legendary_encounters.append(MiscPokemonData(
-                shuffled_species[i],
-                encounter.address
-            ))
+            world.modified_legendary_encounters.append(encounter._replace(species_id=shuffled_species[i]))
     else:
         should_match_bst = world.options.legendary_encounters in {
             RandomizeLegendaryEncounters.option_match_base_stats,
@@ -621,9 +619,8 @@ def randomize_legendary_encounters(world: "PokemonEmeraldWorld") -> None:
             if should_match_bst:
                 candidates = filter_species_by_nearby_bst(candidates, sum(original_species.base_stats))
 
-            world.modified_legendary_encounters.append(MiscPokemonData(
-                world.random.choice(candidates).species_id,
-                encounter.address
+            world.modified_legendary_encounters.append(encounter._replace(
+                species_id=world.random.choice(candidates).species_id
             ))
 
 
@@ -637,10 +634,7 @@ def randomize_misc_pokemon(world: "PokemonEmeraldWorld") -> None:
 
         world.modified_misc_pokemon = []
         for i, encounter in enumerate(data.misc_pokemon):
-            world.modified_misc_pokemon.append(MiscPokemonData(
-                shuffled_species[i],
-                encounter.address
-            ))
+            world.modified_misc_pokemon.append(encounter._replace(species_id=shuffled_species[i]))
     else:
         should_match_bst = world.options.misc_pokemon in {
             RandomizeMiscPokemon.option_match_base_stats,
@@ -672,9 +666,8 @@ def randomize_misc_pokemon(world: "PokemonEmeraldWorld") -> None:
             if len(player_filtered_candidates) > 0:
                 candidates = player_filtered_candidates
 
-            world.modified_misc_pokemon.append(MiscPokemonData(
-                world.random.choice(candidates).species_id,
-                encounter.address
+            world.modified_misc_pokemon.append(encounter._replace(
+                species_id=world.random.choice(candidates).species_id
             ))
 
 

worlds/pokemon_emerald/rules.py

@@ -19,20 +19,20 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     hm_rules: Dict[str, Callable[[CollectionState], bool]] = {}
     for hm, badges in world.hm_requirements.items():
         if isinstance(badges, list):
-            hm_rules[hm] = lambda state, hm=hm, badges=badges: state.has(hm, world.player) \
-                                                               and state.has_all(badges, world.player)
+            hm_rules[hm] = lambda state, hm=hm, badges=badges: \
+                state.has(hm, world.player) and state.has_all(badges, world.player)
         else:
-            hm_rules[hm] = lambda state, hm=hm, badges=badges: state.has(hm, world.player) \
-                                                               and state.has_group("Badges", world.player, badges)
+            hm_rules[hm] = lambda state, hm=hm, badges=badges: \
+                state.has(hm, world.player) and state.has_group_unique("Badges", world.player, badges)
 
     def has_acro_bike(state: CollectionState):
         return state.has("Acro Bike", world.player)
 
     def has_mach_bike(state: CollectionState):
         return state.has("Mach Bike", world.player)
-    
+
     def defeated_n_gym_leaders(state: CollectionState, n: int) -> bool:
-        return sum([state.has(event, world.player) for event in [
+        return state.has_from_list_unique([
             "EVENT_DEFEAT_ROXANNE",
             "EVENT_DEFEAT_BRAWLY",
             "EVENT_DEFEAT_WATTSON",
@@ -41,7 +41,7 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
             "EVENT_DEFEAT_WINONA",
             "EVENT_DEFEAT_TATE_AND_LIZA",
             "EVENT_DEFEAT_JUAN",
-        ]]) >= n
+        ], world.player, n)
 
     huntable_legendary_events = [
         f"EVENT_ENCOUNTER_{key}"
@@ -61,8 +61,9 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
         }.items()
         if name in world.options.allowed_legendary_hunt_encounters.value
     ]
+
     def encountered_n_legendaries(state: CollectionState, n: int) -> bool:
-        return sum(int(state.has(event, world.player)) for event in huntable_legendary_events) >= n
+        return state.has_from_list_unique(huntable_legendary_events, world.player, n)
 
     def get_entrance(entrance: str):
         return world.multiworld.get_entrance(entrance, world.player)
@@ -235,11 +236,11 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     if world.options.norman_requirement == NormanRequirement.option_badges:
         set_rule(
             get_entrance("MAP_PETALBURG_CITY_GYM:2/MAP_PETALBURG_CITY_GYM:3"),
-            lambda state: state.has_group("Badges", world.player, world.options.norman_count.value)
+            lambda state: state.has_group_unique("Badges", world.player, world.options.norman_count.value)
         )
         set_rule(
             get_entrance("MAP_PETALBURG_CITY_GYM:5/MAP_PETALBURG_CITY_GYM:6"),
-            lambda state: state.has_group("Badges", world.player, world.options.norman_count.value)
+            lambda state: state.has_group_unique("Badges", world.player, world.options.norman_count.value)
         )
     else:
         set_rule(
@@ -299,15 +300,15 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     )
     set_rule(
         get_entrance("REGION_ROUTE116/EAST -> REGION_TERRA_CAVE_ENTRANCE/MAIN"),
-        lambda state: state.has("EVENT_DEFEAT_CHAMPION", world.player) and \
-            state.has("TERRA_CAVE_ROUTE_116_1", world.player) and \
-            state.has("EVENT_DEFEAT_SHELLY", world.player)
+        lambda state: state.has("EVENT_DEFEAT_CHAMPION", world.player)
+            and state.has("TERRA_CAVE_ROUTE_116_1", world.player)
+            and state.has("EVENT_DEFEAT_SHELLY", world.player)
     )
     set_rule(
         get_entrance("REGION_ROUTE116/WEST -> REGION_TERRA_CAVE_ENTRANCE/MAIN"),
-        lambda state: state.has("EVENT_DEFEAT_CHAMPION", world.player) and \
-            state.has("TERRA_CAVE_ROUTE_116_2", world.player) and \
-            state.has("EVENT_DEFEAT_SHELLY", world.player)
+        lambda state: state.has("EVENT_DEFEAT_CHAMPION", world.player)
+            and state.has("TERRA_CAVE_ROUTE_116_2", world.player)
+            and state.has("EVENT_DEFEAT_SHELLY", world.player)
     )
 
     # Rusturf Tunnel
@@ -347,19 +348,19 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     )
     set_rule(
         get_entrance("REGION_ROUTE115/NORTH_BELOW_SLOPE -> REGION_ROUTE115/NORTH_ABOVE_SLOPE"),
-        lambda state: has_mach_bike(state)
+        has_mach_bike
     )
     set_rule(
         get_entrance("REGION_ROUTE115/NORTH_BELOW_SLOPE -> REGION_TERRA_CAVE_ENTRANCE/MAIN"),
-        lambda state: state.has("EVENT_DEFEAT_CHAMPION", world.player) and \
-            state.has("TERRA_CAVE_ROUTE_115_1", world.player) and \
-            state.has("EVENT_DEFEAT_SHELLY",  world.player)
+        lambda state: state.has("EVENT_DEFEAT_CHAMPION", world.player)
+            and state.has("TERRA_CAVE_ROUTE_115_1", world.player)
+            and state.has("EVENT_DEFEAT_SHELLY",  world.player)
     )
     set_rule(
         get_entrance("REGION_ROUTE115/NORTH_ABOVE_SLOPE -> REGION_TERRA_CAVE_ENTRANCE/MAIN"),
-        lambda state: state.has("EVENT_DEFEAT_CHAMPION", world.player) and \
-            state.has("TERRA_CAVE_ROUTE_115_2", world.player) and \
-            state.has("EVENT_DEFEAT_SHELLY",  world.player)
+        lambda state: state.has("EVENT_DEFEAT_CHAMPION", world.player)
+            and state.has("TERRA_CAVE_ROUTE_115_2", world.player)
+            and state.has("EVENT_DEFEAT_SHELLY",  world.player)
     )
 
     if world.options.extra_boulders:
@@ -375,7 +376,7 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     if world.options.extra_bumpy_slope:
         set_rule(
             get_entrance("REGION_ROUTE115/SOUTH_BELOW_LEDGE -> REGION_ROUTE115/SOUTH_ABOVE_LEDGE"),
-            lambda state: has_acro_bike(state)
+            has_acro_bike
         )
     else:
         set_rule(
@@ -386,17 +387,17 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     # Route 105
     set_rule(
         get_entrance("REGION_UNDERWATER_ROUTE105/MARINE_CAVE_ENTRANCE_1 -> REGION_UNDERWATER_MARINE_CAVE/MAIN"),
-        lambda state: hm_rules["HM08 Dive"](state) and \
-            state.has("EVENT_DEFEAT_CHAMPION", world.player) and \
-            state.has("MARINE_CAVE_ROUTE_105_1", world.player) and \
-            state.has("EVENT_DEFEAT_SHELLY", world.player)
+        lambda state: hm_rules["HM08 Dive"](state)
+            and state.has("EVENT_DEFEAT_CHAMPION", world.player)
+            and state.has("MARINE_CAVE_ROUTE_105_1", world.player)
+            and state.has("EVENT_DEFEAT_SHELLY", world.player)
     )
     set_rule(
         get_entrance("REGION_UNDERWATER_ROUTE105/MARINE_CAVE_ENTRANCE_2 -> REGION_UNDERWATER_MARINE_CAVE/MAIN"),
-        lambda state: hm_rules["HM08 Dive"](state) and \
-            state.has("EVENT_DEFEAT_CHAMPION", world.player) and \
-            state.has("MARINE_CAVE_ROUTE_105_2", world.player) and \
-            state.has("EVENT_DEFEAT_SHELLY", world.player)
+        lambda state: hm_rules["HM08 Dive"](state)
+            and state.has("EVENT_DEFEAT_CHAMPION", world.player)
+            and state.has("MARINE_CAVE_ROUTE_105_2", world.player)
+            and state.has("EVENT_DEFEAT_SHELLY", world.player)
     )
     set_rule(
         get_entrance("MAP_ROUTE105:0/MAP_ISLAND_CAVE:0"),
@@ -439,7 +440,7 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     )
     set_rule(
         get_entrance("REGION_GRANITE_CAVE_B1F/LOWER -> REGION_GRANITE_CAVE_B1F/UPPER"),
-        lambda state: has_mach_bike(state)
+        has_mach_bike
     )
 
     # Route 107
@@ -643,15 +644,15 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     )
     set_rule(
         get_entrance("REGION_ROUTE114/ABOVE_WATERFALL -> REGION_TERRA_CAVE_ENTRANCE/MAIN"),
-        lambda state: state.has("EVENT_DEFEAT_CHAMPION", world.player) and \
-            state.has("TERRA_CAVE_ROUTE_114_1", world.player) and \
-            state.has("EVENT_DEFEAT_SHELLY", world.player)
+        lambda state: state.has("EVENT_DEFEAT_CHAMPION", world.player)
+            and state.has("TERRA_CAVE_ROUTE_114_1", world.player)
+            and state.has("EVENT_DEFEAT_SHELLY", world.player)
     )
     set_rule(
         get_entrance("REGION_ROUTE114/MAIN -> REGION_TERRA_CAVE_ENTRANCE/MAIN"),
-        lambda state: state.has("EVENT_DEFEAT_CHAMPION", world.player) and \
-            state.has("TERRA_CAVE_ROUTE_114_2", world.player) and \
-            state.has("EVENT_DEFEAT_SHELLY", world.player)
+        lambda state: state.has("EVENT_DEFEAT_CHAMPION", world.player)
+            and state.has("TERRA_CAVE_ROUTE_114_2", world.player)
+            and state.has("EVENT_DEFEAT_SHELLY", world.player)
     )
 
     # Meteor Falls
@@ -699,11 +700,11 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     # Jagged Pass
     set_rule(
         get_entrance("REGION_JAGGED_PASS/BOTTOM -> REGION_JAGGED_PASS/MIDDLE"),
-        lambda state: has_acro_bike(state)
+        has_acro_bike
     )
     set_rule(
         get_entrance("REGION_JAGGED_PASS/MIDDLE -> REGION_JAGGED_PASS/TOP"),
-        lambda state: has_acro_bike(state)
+        has_acro_bike
     )
     set_rule(
         get_entrance("MAP_JAGGED_PASS:4/MAP_MAGMA_HIDEOUT_1F:0"),
@@ -719,11 +720,11 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     # Mirage Tower
     set_rule(
         get_entrance("REGION_MIRAGE_TOWER_2F/TOP -> REGION_MIRAGE_TOWER_2F/BOTTOM"),
-        lambda state: has_mach_bike(state)
+        has_mach_bike
     )
     set_rule(
         get_entrance("REGION_MIRAGE_TOWER_2F/BOTTOM -> REGION_MIRAGE_TOWER_2F/TOP"),
-        lambda state: has_mach_bike(state)
+        has_mach_bike
     )
     set_rule(
         get_entrance("REGION_MIRAGE_TOWER_3F/TOP -> REGION_MIRAGE_TOWER_3F/BOTTOM"),
@@ -812,15 +813,15 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     )
     set_rule(
         get_entrance("REGION_ROUTE118/EAST -> REGION_TERRA_CAVE_ENTRANCE/MAIN"),
-        lambda state: state.has("EVENT_DEFEAT_CHAMPION", world.player) and \
-            state.has("TERRA_CAVE_ROUTE_118_1", world.player) and \
-            state.has("EVENT_DEFEAT_SHELLY", world.player)
+        lambda state: state.has("EVENT_DEFEAT_CHAMPION", world.player)
+            and state.has("TERRA_CAVE_ROUTE_118_1", world.player)
+            and state.has("EVENT_DEFEAT_SHELLY", world.player)
     )
     set_rule(
         get_entrance("REGION_ROUTE118/WEST -> REGION_TERRA_CAVE_ENTRANCE/MAIN"),
-        lambda state: state.has("EVENT_DEFEAT_CHAMPION", world.player) and \
-            state.has("TERRA_CAVE_ROUTE_118_2", world.player) and \
-            state.has("EVENT_DEFEAT_SHELLY", world.player)
+        lambda state: state.has("EVENT_DEFEAT_CHAMPION", world.player)
+            and state.has("TERRA_CAVE_ROUTE_118_2", world.player)
+            and state.has("EVENT_DEFEAT_SHELLY", world.player)
     )
 
     # Route 119
@@ -830,11 +831,11 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     )
     set_rule(
         get_entrance("REGION_ROUTE119/LOWER -> REGION_ROUTE119/LOWER_ACROSS_RAILS"),
-        lambda state: has_acro_bike(state)
+        has_acro_bike
     )
     set_rule(
         get_entrance("REGION_ROUTE119/LOWER_ACROSS_RAILS -> REGION_ROUTE119/LOWER"),
-        lambda state: has_acro_bike(state)
+        has_acro_bike
     )
     set_rule(
         get_entrance("REGION_ROUTE119/UPPER -> REGION_ROUTE119/MIDDLE_RIVER"),
@@ -850,7 +851,7 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     )
     set_rule(
         get_entrance("REGION_ROUTE119/ABOVE_WATERFALL -> REGION_ROUTE119/ABOVE_WATERFALL_ACROSS_RAILS"),
-        lambda state: has_acro_bike(state)
+        has_acro_bike
     )
     if "Route 119 Aqua Grunts" not in world.options.remove_roadblocks.value:
         set_rule(
@@ -927,11 +928,11 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     )
     set_rule(
         get_entrance("REGION_SAFARI_ZONE_SOUTH/MAIN -> REGION_SAFARI_ZONE_NORTH/MAIN"),
-        lambda state: has_acro_bike(state)
+        has_acro_bike
     )
     set_rule(
         get_entrance("REGION_SAFARI_ZONE_SOUTHWEST/MAIN -> REGION_SAFARI_ZONE_NORTHWEST/MAIN"),
-        lambda state: has_mach_bike(state)
+        has_mach_bike
     )
     set_rule(
         get_entrance("REGION_SAFARI_ZONE_SOUTHWEST/MAIN -> REGION_SAFARI_ZONE_SOUTHWEST/POND"),
@@ -1115,17 +1116,17 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     # Route 125
     set_rule(
         get_entrance("REGION_UNDERWATER_ROUTE125/MARINE_CAVE_ENTRANCE_1 -> REGION_UNDERWATER_MARINE_CAVE/MAIN"),
-        lambda state: hm_rules["HM08 Dive"](state) and \
-            state.has("EVENT_DEFEAT_CHAMPION", world.player) and \
-            state.has("MARINE_CAVE_ROUTE_125_1", world.player) and \
-            state.has("EVENT_DEFEAT_SHELLY", world.player)
+        lambda state: hm_rules["HM08 Dive"](state)
+            and state.has("EVENT_DEFEAT_CHAMPION", world.player)
+            and state.has("MARINE_CAVE_ROUTE_125_1", world.player)
+            and state.has("EVENT_DEFEAT_SHELLY", world.player)
     )
     set_rule(
         get_entrance("REGION_UNDERWATER_ROUTE125/MARINE_CAVE_ENTRANCE_2 -> REGION_UNDERWATER_MARINE_CAVE/MAIN"),
-        lambda state: hm_rules["HM08 Dive"](state) and \
-            state.has("EVENT_DEFEAT_CHAMPION", world.player) and \
-            state.has("MARINE_CAVE_ROUTE_125_2", world.player) and \
-            state.has("EVENT_DEFEAT_SHELLY", world.player)
+        lambda state: hm_rules["HM08 Dive"](state)
+            and state.has("EVENT_DEFEAT_CHAMPION", world.player)
+            and state.has("MARINE_CAVE_ROUTE_125_2", world.player)
+            and state.has("EVENT_DEFEAT_SHELLY", world.player)
     )
 
     # Shoal Cave
@@ -1257,17 +1258,17 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     )
     set_rule(
         get_entrance("REGION_UNDERWATER_ROUTE127/MARINE_CAVE_ENTRANCE_1 -> REGION_UNDERWATER_MARINE_CAVE/MAIN"),
-        lambda state: hm_rules["HM08 Dive"](state) and \
-            state.has("EVENT_DEFEAT_CHAMPION", world.player) and \
-            state.has("MARINE_CAVE_ROUTE_127_1", world.player) and \
-            state.has("EVENT_DEFEAT_SHELLY", world.player)
+        lambda state: hm_rules["HM08 Dive"](state)
+            and state.has("EVENT_DEFEAT_CHAMPION", world.player)
+            and state.has("MARINE_CAVE_ROUTE_127_1", world.player)
+            and state.has("EVENT_DEFEAT_SHELLY", world.player)
     )
     set_rule(
         get_entrance("REGION_UNDERWATER_ROUTE127/MARINE_CAVE_ENTRANCE_2 -> REGION_UNDERWATER_MARINE_CAVE/MAIN"),
-        lambda state: hm_rules["HM08 Dive"](state) and \
-            state.has("EVENT_DEFEAT_CHAMPION", world.player) and \
-            state.has("MARINE_CAVE_ROUTE_127_2", world.player) and \
-            state.has("EVENT_DEFEAT_SHELLY", world.player)
+        lambda state: hm_rules["HM08 Dive"](state)
+            and state.has("EVENT_DEFEAT_CHAMPION", world.player)
+            and state.has("MARINE_CAVE_ROUTE_127_2", world.player)
+            and state.has("EVENT_DEFEAT_SHELLY", world.player)
     )
 
     # Route 128
@@ -1374,17 +1375,17 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     # Route 129
     set_rule(
         get_entrance("REGION_UNDERWATER_ROUTE129/MARINE_CAVE_ENTRANCE_1 -> REGION_UNDERWATER_MARINE_CAVE/MAIN"),
-        lambda state: hm_rules["HM08 Dive"](state) and \
-            state.has("EVENT_DEFEAT_CHAMPION", world.player) and \
-            state.has("MARINE_CAVE_ROUTE_129_1", world.player) and \
-            state.has("EVENT_DEFEAT_SHELLY", world.player)
+        lambda state: hm_rules["HM08 Dive"](state)
+            and state.has("EVENT_DEFEAT_CHAMPION", world.player)
+            and state.has("MARINE_CAVE_ROUTE_129_1", world.player)
+            and state.has("EVENT_DEFEAT_SHELLY", world.player)
     )
     set_rule(
         get_entrance("REGION_UNDERWATER_ROUTE129/MARINE_CAVE_ENTRANCE_2 -> REGION_UNDERWATER_MARINE_CAVE/MAIN"),
-        lambda state: hm_rules["HM08 Dive"](state) and \
-            state.has("EVENT_DEFEAT_CHAMPION", world.player) and \
-            state.has("MARINE_CAVE_ROUTE_129_2", world.player) and \
-            state.has("EVENT_DEFEAT_SHELLY", world.player)
+        lambda state: hm_rules["HM08 Dive"](state)
+            and state.has("EVENT_DEFEAT_CHAMPION", world.player)
+            and state.has("MARINE_CAVE_ROUTE_129_2", world.player)
+            and state.has("EVENT_DEFEAT_SHELLY", world.player)
     )
 
     # Pacifidlog Town
@@ -1505,7 +1506,7 @@ def set_rules(world: "PokemonEmeraldWorld") -> None:
     if world.options.elite_four_requirement == EliteFourRequirement.option_badges:
         set_rule(
             get_entrance("REGION_EVER_GRANDE_CITY_POKEMON_LEAGUE_1F/MAIN -> REGION_EVER_GRANDE_CITY_POKEMON_LEAGUE_1F/BEHIND_BADGE_CHECKERS"),
-            lambda state: state.has_group("Badges", world.player, world.options.elite_four_count.value)
+            lambda state: state.has_group_unique("Badges", world.player, world.options.elite_four_count.value)
         )
     else:
         set_rule(

worlds/rogue_legacy/Options.py

@@ -1,6 +1,6 @@
-from typing import Dict
+from Options import Choice, Range, Toggle, DeathLink, DefaultOnToggle, OptionSet, PerGameCommonOptions
 
-from Options import Choice, Range, Option, Toggle, DeathLink, DefaultOnToggle, OptionSet
+from dataclasses import dataclass
 
 
 class StartingGender(Choice):
@@ -175,13 +175,21 @@ class NumberOfChildren(Range):
     default = 3
 
 
-class AdditionalNames(OptionSet):
+class AdditionalLadyNames(OptionSet):
     """
     Set of additional names your potential offspring can have. If Allow Default Names is disabled, this is the only list
     of names your children can have. The first value will also be your initial character's name depending on Starting
     Gender.
     """
-    display_name = "Additional Names"
+    display_name = "Additional Lady Names"
+
+class AdditionalSirNames(OptionSet):
+    """
+    Set of additional names your potential offspring can have. If Allow Default Names is disabled, this is the only list
+    of names your children can have. The first value will also be your initial character's name depending on Starting
+    Gender.
+    """
+    display_name = "Additional Sir Names"
 
 
 class AllowDefaultNames(DefaultOnToggle):
@@ -336,42 +344,44 @@ class AvailableClasses(OptionSet):
     The upgraded form of your starting class will be available regardless.
     """
     display_name = "Available Classes"
-    default = {"Knight", "Mage", "Barbarian", "Knave", "Shinobi", "Miner", "Spellthief", "Lich", "Dragon", "Traitor"}
+    default = frozenset(
+        {"Knight", "Mage", "Barbarian", "Knave", "Shinobi", "Miner", "Spellthief", "Lich", "Dragon", "Traitor"}
+    )
     valid_keys = {"Knight", "Mage", "Barbarian", "Knave", "Shinobi", "Miner", "Spellthief", "Lich", "Dragon", "Traitor"}
 
 
-rl_options: Dict[str, type(Option)] = {
-    "starting_gender": StartingGender,
-    "starting_class": StartingClass,
-    "available_classes": AvailableClasses,
-    "new_game_plus": NewGamePlus,
-    "fairy_chests_per_zone": FairyChestsPerZone,
-    "chests_per_zone": ChestsPerZone,
-    "universal_fairy_chests": UniversalFairyChests,
-    "universal_chests": UniversalChests,
-    "vendors": Vendors,
-    "architect": Architect,
-    "architect_fee": ArchitectFee,
-    "disable_charon": DisableCharon,
-    "require_purchasing": RequirePurchasing,
-    "progressive_blueprints": ProgressiveBlueprints,
-    "gold_gain_multiplier": GoldGainMultiplier,
-    "number_of_children": NumberOfChildren,
-    "free_diary_on_generation": FreeDiaryOnGeneration,
-    "khidr": ChallengeBossKhidr,
-    "alexander": ChallengeBossAlexander,
-    "leon": ChallengeBossLeon,
-    "herodotus": ChallengeBossHerodotus,
-    "health_pool": HealthUpPool,
-    "mana_pool": ManaUpPool,
-    "attack_pool": AttackUpPool,
-    "magic_damage_pool": MagicDamageUpPool,
-    "armor_pool": ArmorUpPool,
-    "equip_pool": EquipUpPool,
-    "crit_chance_pool": CritChanceUpPool,
-    "crit_damage_pool": CritDamageUpPool,
-    "allow_default_names": AllowDefaultNames,
-    "additional_lady_names": AdditionalNames,
-    "additional_sir_names": AdditionalNames,
-    "death_link": DeathLink,
-}
+@dataclass
+class RLOptions(PerGameCommonOptions):
+    starting_gender: StartingGender
+    starting_class: StartingClass
+    available_classes: AvailableClasses
+    new_game_plus: NewGamePlus
+    fairy_chests_per_zone: FairyChestsPerZone
+    chests_per_zone: ChestsPerZone
+    universal_fairy_chests: UniversalFairyChests
+    universal_chests: UniversalChests
+    vendors: Vendors
+    architect: Architect
+    architect_fee: ArchitectFee
+    disable_charon: DisableCharon
+    require_purchasing: RequirePurchasing
+    progressive_blueprints: ProgressiveBlueprints
+    gold_gain_multiplier: GoldGainMultiplier
+    number_of_children: NumberOfChildren
+    free_diary_on_generation: FreeDiaryOnGeneration
+    khidr: ChallengeBossKhidr
+    alexander: ChallengeBossAlexander
+    leon: ChallengeBossLeon
+    herodotus: ChallengeBossHerodotus
+    health_pool: HealthUpPool
+    mana_pool: ManaUpPool
+    attack_pool: AttackUpPool
+    magic_damage_pool: MagicDamageUpPool
+    armor_pool: ArmorUpPool
+    equip_pool: EquipUpPool
+    crit_chance_pool: CritChanceUpPool
+    crit_damage_pool: CritDamageUpPool
+    allow_default_names: AllowDefaultNames
+    additional_lady_names: AdditionalLadyNames
+    additional_sir_names: AdditionalSirNames
+    death_link: DeathLink

worlds/rogue_legacy/Regions.py

@@ -1,15 +1,18 @@
-from typing import Dict, List, NamedTuple, Optional
+from typing import Dict, List, NamedTuple, Optional, TYPE_CHECKING
 
 from BaseClasses import MultiWorld, Region, Entrance
 from .Locations import RLLocation, location_table, get_locations_by_category
 
+if TYPE_CHECKING:
+    from . import RLWorld
+
 
 class RLRegionData(NamedTuple):
     locations: Optional[List[str]]
     region_exits: Optional[List[str]]
 
 
-def create_regions(multiworld: MultiWorld, player: int):
+def create_regions(world: "RLWorld"):
     regions: Dict[str, RLRegionData] = {
         "Menu":              RLRegionData(None, ["Castle Hamson"]),
         "The Manor":         RLRegionData([],   []),
@@ -56,9 +59,9 @@ def create_regions(multiworld: MultiWorld, player: int):
     regions["The Fountain Room"].locations.append("Fountain Room")
 
     # Chests
-    chests = int(multiworld.chests_per_zone[player])
+    chests = int(world.options.chests_per_zone)
     for i in range(0, chests):
-        if multiworld.universal_chests[player]:
+        if world.options.universal_chests:
             regions["Castle Hamson"].locations.append(f"Chest {i + 1}")
             regions["Forest Abkhazia"].locations.append(f"Chest {i + 1 + chests}")
             regions["The Maya"].locations.append(f"Chest {i + 1 + (chests * 2)}")
@@ -70,9 +73,9 @@ def create_regions(multiworld: MultiWorld, player: int):
             regions["Land of Darkness"].locations.append(f"Land of Darkness - Chest {i + 1}")
 
     # Fairy Chests
-    chests = int(multiworld.fairy_chests_per_zone[player])
+    chests = int(world.options.fairy_chests_per_zone)
     for i in range(0, chests):
-        if multiworld.universal_fairy_chests[player]:
+        if world.options.universal_fairy_chests:
             regions["Castle Hamson"].locations.append(f"Fairy Chest {i + 1}")
             regions["Forest Abkhazia"].locations.append(f"Fairy Chest {i + 1 + chests}")
             regions["The Maya"].locations.append(f"Fairy Chest {i + 1 + (chests * 2)}")
@@ -85,14 +88,14 @@ def create_regions(multiworld: MultiWorld, player: int):
 
     # Set up the regions correctly.
     for name, data in regions.items():
-        multiworld.regions.append(create_region(multiworld, player, name, data))
+        world.multiworld.regions.append(create_region(world.multiworld, world.player, name, data))
 
-    multiworld.get_entrance("Castle Hamson", player).connect(multiworld.get_region("Castle Hamson", player))
-    multiworld.get_entrance("The Manor", player).connect(multiworld.get_region("The Manor", player))
-    multiworld.get_entrance("Forest Abkhazia", player).connect(multiworld.get_region("Forest Abkhazia", player))
-    multiworld.get_entrance("The Maya", player).connect(multiworld.get_region("The Maya", player))
-    multiworld.get_entrance("Land of Darkness", player).connect(multiworld.get_region("Land of Darkness", player))
-    multiworld.get_entrance("The Fountain Room", player).connect(multiworld.get_region("The Fountain Room", player))
+    world.get_entrance("Castle Hamson").connect(world.get_region("Castle Hamson"))
+    world.get_entrance("The Manor").connect(world.get_region("The Manor"))
+    world.get_entrance("Forest Abkhazia").connect(world.get_region("Forest Abkhazia"))
+    world.get_entrance("The Maya").connect(world.get_region("The Maya"))
+    world.get_entrance("Land of Darkness").connect(world.get_region("Land of Darkness"))
+    world.get_entrance("The Fountain Room").connect(world.get_region("The Fountain Room"))
 
 
 def create_region(multiworld: MultiWorld, player: int, name: str, data: RLRegionData):

worlds/rogue_legacy/Rules.py

@@ -1,9 +1,13 @@
-from BaseClasses import CollectionState, MultiWorld
+from BaseClasses import CollectionState
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from . import RLWorld
 
 
-def get_upgrade_total(multiworld: MultiWorld, player: int) -> int:
-    return int(multiworld.health_pool[player]) + int(multiworld.mana_pool[player]) + \
-           int(multiworld.attack_pool[player]) + int(multiworld.magic_damage_pool[player])
+def get_upgrade_total(world: "RLWorld") -> int:
+    return int(world.options.health_pool) + int(world.options.mana_pool) + \
+           int(world.options.attack_pool) + int(world.options.magic_damage_pool)
 
 
 def get_upgrade_count(state: CollectionState, player: int) -> int:
@@ -19,8 +23,8 @@ def has_upgrade_amount(state: CollectionState, player: int, amount: int) -> bool
     return get_upgrade_count(state, player) >= amount
 
 
-def has_upgrades_percentage(state: CollectionState, player: int, percentage: float) -> bool:
-    return has_upgrade_amount(state, player, round(get_upgrade_total(state.multiworld, player) * (percentage / 100)))
+def has_upgrades_percentage(state: CollectionState, world: "RLWorld", percentage: float) -> bool:
+    return has_upgrade_amount(state, world.player, round(get_upgrade_total(world) * (percentage / 100)))
 
 
 def has_movement_rune(state: CollectionState, player: int) -> bool:
@@ -47,15 +51,15 @@ def has_defeated_dungeon(state: CollectionState, player: int) -> bool:
     return state.has("Defeat Herodotus", player) or state.has("Defeat Astrodotus", player)
 
 
-def set_rules(multiworld: MultiWorld, player: int):
+def set_rules(world: "RLWorld", player: int):
     # If 'vendors' are 'normal', then expect it to show up in the first half(ish) of the spheres.
-    if multiworld.vendors[player] == "normal":
-        multiworld.get_location("Forest Abkhazia Boss Reward", player).access_rule = \
+    if world.options.vendors == "normal":
+        world.get_location("Forest Abkhazia Boss Reward").access_rule = \
             lambda state: has_vendors(state, player)
 
     # Gate each manor location so everything isn't dumped into sphere 1.
     manor_rules = {
-        "Defeat Khidr" if multiworld.khidr[player] == "vanilla" else "Defeat Neo Khidr": [
+        "Defeat Khidr" if world.options.khidr == "vanilla" else "Defeat Neo Khidr": [
             "Manor - Left Wing Window",
             "Manor - Left Wing Rooftop",
             "Manor - Right Wing Window",
@@ -66,7 +70,7 @@ def set_rules(multiworld: MultiWorld, player: int):
             "Manor - Left Tree 2",
             "Manor - Right Tree",
         ],
-        "Defeat Alexander" if multiworld.alexander[player] == "vanilla" else "Defeat Alexander IV": [
+        "Defeat Alexander" if world.options.alexander == "vanilla" else "Defeat Alexander IV": [
             "Manor - Left Big Upper 1",
             "Manor - Left Big Upper 2",
             "Manor - Left Big Windows",
@@ -78,7 +82,7 @@ def set_rules(multiworld: MultiWorld, player: int):
             "Manor - Right Big Rooftop",
             "Manor - Right Extension",
         ],
-        "Defeat Ponce de Leon" if multiworld.leon[player] == "vanilla" else "Defeat Ponce de Freon": [
+        "Defeat Ponce de Leon" if world.options.leon == "vanilla" else "Defeat Ponce de Freon": [
             "Manor - Right High Base",
             "Manor - Right High Upper",
             "Manor - Right High Tower",
@@ -90,24 +94,24 @@ def set_rules(multiworld: MultiWorld, player: int):
     # Set rules for manor locations.
     for event, locations in manor_rules.items():
         for location in locations:
-            multiworld.get_location(location, player).access_rule = lambda state: state.has(event, player)
+            world.get_location(location).access_rule = lambda state: state.has(event, player)
 
     # Set rules for fairy chests to decrease headache of expectation to find non-movement fairy chests.
-    for fairy_location in [location for location in multiworld.get_locations(player) if "Fairy" in location.name]:
+    for fairy_location in [location for location in world.multiworld.get_locations(player) if "Fairy" in location.name]:
         fairy_location.access_rule = lambda state: has_fairy_progression(state, player)
 
     # Region rules.
-    multiworld.get_entrance("Forest Abkhazia", player).access_rule = \
-        lambda state: has_upgrades_percentage(state, player, 12.5) and has_defeated_castle(state, player)
+    world.get_entrance("Forest Abkhazia").access_rule = \
+        lambda state: has_upgrades_percentage(state, world, 12.5) and has_defeated_castle(state, player)
 
-    multiworld.get_entrance("The Maya", player).access_rule = \
-        lambda state: has_upgrades_percentage(state, player, 25) and has_defeated_forest(state, player)
+    world.get_entrance("The Maya").access_rule = \
+        lambda state: has_upgrades_percentage(state, world, 25) and has_defeated_forest(state, player)
 
-    multiworld.get_entrance("Land of Darkness", player).access_rule = \
-        lambda state: has_upgrades_percentage(state, player, 37.5) and has_defeated_tower(state, player)
+    world.get_entrance("Land of Darkness").access_rule = \
+        lambda state: has_upgrades_percentage(state, world, 37.5) and has_defeated_tower(state, player)
 
-    multiworld.get_entrance("The Fountain Room", player).access_rule = \
-        lambda state: has_upgrades_percentage(state, player, 50) and has_defeated_dungeon(state, player)
+    world.get_entrance("The Fountain Room").access_rule = \
+        lambda state: has_upgrades_percentage(state, world, 50) and has_defeated_dungeon(state, player)
 
     # Win condition.
-    multiworld.completion_condition[player] = lambda state: state.has("Defeat The Fountain", player)
+    world.multiworld.completion_condition[player] = lambda state: state.has("Defeat The Fountain", player)

worlds/rogue_legacy/__init__.py

@@ -4,7 +4,7 @@ from BaseClasses import Tutorial
 from worlds.AutoWorld import WebWorld, World
 from .Items import RLItem, RLItemData, event_item_table, get_items_by_category, item_table
 from .Locations import RLLocation, location_table
-from .Options import rl_options
+from .Options import RLOptions
 from .Presets import rl_options_presets
 from .Regions import create_regions
 from .Rules import set_rules
@@ -33,20 +33,17 @@ class RLWorld(World):
     But that's OK, because no one is perfect, and you don't have to be to succeed.
     """
     game = "Rogue Legacy"
-    option_definitions = rl_options
+    options_dataclass = RLOptions
+    options: RLOptions
     topology_present = True
     required_client_version = (0, 3, 5)
     web = RLWeb()
 
-    item_name_to_id = {name: data.code for name, data in item_table.items()}
-    location_name_to_id = {name: data.code for name, data in location_table.items()}
-
-    # TODO: Replace calls to this function with "options-dict", once that PR is completed and merged.
-    def get_setting(self, name: str):
-        return getattr(self.multiworld, name)[self.player]
+    item_name_to_id = {name: data.code for name, data in item_table.items() if data.code is not None}
+    location_name_to_id = {name: data.code for name, data in location_table.items() if data.code is not None}
 
     def fill_slot_data(self) -> dict:
-        return {option_name: self.get_setting(option_name).value for option_name in rl_options}
+        return self.options.as_dict(*[name for name in self.options_dataclass.type_hints.keys()])
 
     def generate_early(self):
         location_ids_used_per_game = {
@@ -74,18 +71,18 @@ class RLWorld(World):
             )
         
         # Check validation of names.
-        additional_lady_names = len(self.get_setting("additional_lady_names").value)
-        additional_sir_names = len(self.get_setting("additional_sir_names").value)
-        if not self.get_setting("allow_default_names"):
-            if additional_lady_names < int(self.get_setting("number_of_children")):
+        additional_lady_names = len(self.options.additional_lady_names.value)
+        additional_sir_names = len(self.options.additional_sir_names.value)
+        if not self.options.allow_default_names:
+            if additional_lady_names < int(self.options.number_of_children):
                 raise Exception(
                     f"allow_default_names is off, but not enough names are defined in additional_lady_names. "
-                    f"Expected {int(self.get_setting('number_of_children'))}, Got {additional_lady_names}")
+                    f"Expected {int(self.options.number_of_children)}, Got {additional_lady_names}")
 
-            if additional_sir_names < int(self.get_setting("number_of_children")):
+            if additional_sir_names < int(self.options.number_of_children):
                 raise Exception(
                     f"allow_default_names is off, but not enough names are defined in additional_sir_names. "
-                    f"Expected {int(self.get_setting('number_of_children'))}, Got {additional_sir_names}")
+                    f"Expected {int(self.options.number_of_children)}, Got {additional_sir_names}")
 
     def create_items(self):
         item_pool: List[RLItem] = []
@@ -95,110 +92,110 @@ class RLWorld(World):
 
             # Architect
             if name == "Architect":
-                if self.get_setting("architect") == "disabled":
+                if self.options.architect == "disabled":
                     continue
-                if self.get_setting("architect") == "start_unlocked":
+                if self.options.architect == "start_unlocked":
                     self.multiworld.push_precollected(self.create_item(name))
                     continue
-                if self.get_setting("architect") == "early":
+                if self.options.architect == "early":
                     self.multiworld.local_early_items[self.player]["Architect"] = 1
 
             # Blacksmith and Enchantress
             if name == "Blacksmith" or name == "Enchantress":
-                if self.get_setting("vendors") == "start_unlocked":
+                if self.options.vendors == "start_unlocked":
                     self.multiworld.push_precollected(self.create_item(name))
                     continue
-                if self.get_setting("vendors") == "early":
+                if self.options.vendors == "early":
                     self.multiworld.local_early_items[self.player]["Blacksmith"] = 1
                     self.multiworld.local_early_items[self.player]["Enchantress"] = 1
 
             # Haggling
-            if name == "Haggling" and self.get_setting("disable_charon"):
+            if name == "Haggling" and self.options.disable_charon:
                 continue
 
             # Blueprints
             if data.category == "Blueprints":
                 # No progressive blueprints if progressive_blueprints are disabled.
-                if name == "Progressive Blueprints" and not self.get_setting("progressive_blueprints"):
+                if name == "Progressive Blueprints" and not self.options.progressive_blueprints:
                     continue
                 # No distinct blueprints if progressive_blueprints are enabled.
-                elif name != "Progressive Blueprints" and self.get_setting("progressive_blueprints"):
+                elif name != "Progressive Blueprints" and self.options.progressive_blueprints:
                     continue
 
             # Classes
             if data.category == "Classes":
                 if name == "Progressive Knights":
-                    if "Knight" not in self.get_setting("available_classes"):
+                    if "Knight" not in self.options.available_classes:
                         continue
 
-                    if self.get_setting("starting_class") == "knight":
+                    if self.options.starting_class == "knight":
                         quantity = 1
                 if name == "Progressive Mages":
-                    if "Mage" not in self.get_setting("available_classes"):
+                    if "Mage" not in self.options.available_classes:
                         continue
 
-                    if self.get_setting("starting_class") == "mage":
+                    if self.options.starting_class == "mage":
                         quantity = 1
                 if name == "Progressive Barbarians":
-                    if "Barbarian" not in self.get_setting("available_classes"):
+                    if "Barbarian" not in self.options.available_classes:
                         continue
 
-                    if self.get_setting("starting_class") == "barbarian":
+                    if self.options.starting_class == "barbarian":
                         quantity = 1
                 if name == "Progressive Knaves":
-                    if "Knave" not in self.get_setting("available_classes"):
+                    if "Knave" not in self.options.available_classes:
                         continue
 
-                    if self.get_setting("starting_class") == "knave":
+                    if self.options.starting_class == "knave":
                         quantity = 1
                 if name == "Progressive Miners":
-                    if "Miner" not in self.get_setting("available_classes"):
+                    if "Miner" not in self.options.available_classes:
                         continue
 
-                    if self.get_setting("starting_class") == "miner":
+                    if self.options.starting_class == "miner":
                         quantity = 1
                 if name == "Progressive Shinobis":
-                    if "Shinobi" not in self.get_setting("available_classes"):
+                    if "Shinobi" not in self.options.available_classes:
                         continue
 
-                    if self.get_setting("starting_class") == "shinobi":
+                    if self.options.starting_class == "shinobi":
                         quantity = 1
                 if name == "Progressive Liches":
-                    if "Lich" not in self.get_setting("available_classes"):
+                    if "Lich" not in self.options.available_classes:
                         continue
 
-                    if self.get_setting("starting_class") == "lich":
+                    if self.options.starting_class == "lich":
                         quantity = 1
                 if name == "Progressive Spellthieves":
-                    if "Spellthief" not in self.get_setting("available_classes"):
+                    if "Spellthief" not in self.options.available_classes:
                         continue
 
-                    if self.get_setting("starting_class") == "spellthief":
+                    if self.options.starting_class == "spellthief":
                         quantity = 1
                 if name == "Dragons":
-                    if "Dragon" not in self.get_setting("available_classes"):
+                    if "Dragon" not in self.options.available_classes:
                         continue
                 if name == "Traitors":
-                    if "Traitor" not in self.get_setting("available_classes"):
+                    if "Traitor" not in self.options.available_classes:
                         continue
 
             # Skills
             if name == "Health Up":
-                quantity = self.get_setting("health_pool")
+                quantity = self.options.health_pool.value
             elif name == "Mana Up":
-                quantity = self.get_setting("mana_pool")
+                quantity = self.options.mana_pool.value
             elif name == "Attack Up":
-                quantity = self.get_setting("attack_pool")
+                quantity = self.options.attack_pool.value
             elif name == "Magic Damage Up":
-                quantity = self.get_setting("magic_damage_pool")
+                quantity = self.options.magic_damage_pool.value
             elif name == "Armor Up":
-                quantity = self.get_setting("armor_pool")
+                quantity = self.options.armor_pool.value
             elif name == "Equip Up":
-                quantity = self.get_setting("equip_pool")
+                quantity = self.options.equip_pool.value
             elif name == "Crit Chance Up":
-                quantity = self.get_setting("crit_chance_pool")
+                quantity = self.options.crit_chance_pool.value
             elif name == "Crit Damage Up":
-                quantity = self.get_setting("crit_damage_pool")
+                quantity = self.options.crit_damage_pool.value
 
             # Ignore filler, it will be added in a later stage.
             if data.category == "Filler":
@@ -215,7 +212,7 @@ class RLWorld(World):
     def get_filler_item_name(self) -> str:
         fillers = get_items_by_category("Filler")
         weights = [data.weight for data in fillers.values()]
-        return self.multiworld.random.choices([filler for filler in fillers.keys()], weights, k=1)[0]
+        return self.random.choices([filler for filler in fillers.keys()], weights, k=1)[0]
 
     def create_item(self, name: str) -> RLItem:
         data = item_table[name]
@@ -226,10 +223,10 @@ class RLWorld(World):
         return RLItem(name, data.classification, data.code, self.player)
 
     def set_rules(self):
-        set_rules(self.multiworld, self.player)
+        set_rules(self, self.player)
 
     def create_regions(self):
-        create_regions(self.multiworld, self.player)
+        create_regions(self)
         self._place_events()
 
     def _place_events(self):
@@ -238,7 +235,7 @@ class RLWorld(World):
             self.create_event("Defeat The Fountain"))
 
         # Khidr / Neo Khidr
-        if self.get_setting("khidr") == "vanilla":
+        if self.options.khidr == "vanilla":
             self.multiworld.get_location("Castle Hamson Boss Room", self.player).place_locked_item(
                 self.create_event("Defeat Khidr"))
         else:
@@ -246,7 +243,7 @@ class RLWorld(World):
                 self.create_event("Defeat Neo Khidr"))
 
         # Alexander / Alexander IV
-        if self.get_setting("alexander") == "vanilla":
+        if self.options.alexander == "vanilla":
             self.multiworld.get_location("Forest Abkhazia Boss Room", self.player).place_locked_item(
                 self.create_event("Defeat Alexander"))
         else:
@@ -254,7 +251,7 @@ class RLWorld(World):
                 self.create_event("Defeat Alexander IV"))
 
         # Ponce de Leon / Ponce de Freon
-        if self.get_setting("leon") == "vanilla":
+        if self.options.leon == "vanilla":
             self.multiworld.get_location("The Maya Boss Room", self.player).place_locked_item(
                 self.create_event("Defeat Ponce de Leon"))
         else:
@@ -262,7 +259,7 @@ class RLWorld(World):
                 self.create_event("Defeat Ponce de Freon"))
 
         # Herodotus / Astrodotus
-        if self.get_setting("herodotus") == "vanilla":
+        if self.options.herodotus == "vanilla":
             self.multiworld.get_location("Land of Darkness Boss Room", self.player).place_locked_item(
                 self.create_event("Defeat Herodotus"))
         else:

worlds/rogue_legacy/test/__init__.py

@@ -1,4 +1,4 @@
-from test.TestBase import WorldTestBase
+from test.bases import WorldTestBase
 
 
 class RLTestBase(WorldTestBase):

worlds/sc2/docs/en_Starcraft 2.md

@@ -1,4 +1,4 @@
-# Starcraft 2
+# StarCraft 2
 
 ## Game page in other languages:
 * [Français](/games/Starcraft%202/info/fr)
@@ -7,9 +7,11 @@
 
 The following unlocks are randomized as items:
 1. Your ability to build any non-worker unit.
-2. Unit specific upgrades including some combinations not available in the vanilla campaigns, such as both strain choices simultaneously for Zerg and every Spear of Adun upgrade simultaneously for Protoss!
+2. Unit specific upgrades including some combinations not available in the vanilla campaigns, such as both strain 
+choices simultaneously for Zerg and every Spear of Adun upgrade simultaneously for Protoss!
 3. Your ability to get the generic unit upgrades, such as attack and armour upgrades.
-4. Other miscellaneous upgrades such as laboratory upgrades and mercenaries for Terran, Kerrigan levels and upgrades for Zerg, and Spear of Adun upgrades for Protoss.
+4. Other miscellaneous upgrades such as laboratory upgrades and mercenaries for Terran, Kerrigan levels and upgrades 
+for Zerg, and Spear of Adun upgrades for Protoss.
 5. Small boosts to your starting mineral, vespene gas, and supply totals on each mission.
 
 You find items by making progress in these categories:
@@ -18,50 +20,91 @@ You find items by making progress in these categories:
 * Reaching milestones in the mission, such as completing part of a main objective
 * Completing challenges based on achievements in the base game, such as clearing all Zerg on Devil's Playground
 
-Except for mission completion, these categories can be disabled in the game's settings. For instance, you can disable getting items for reaching required milestones.
+In Archipelago's nomenclature, these are the locations where items can be found.
+Each location, including mission completion, has a set of rules that specify the items required to access it.
+These rules were designed assuming that StarCraft 2 is played on the Brutal difficulty.
+Since each location has its own rule, it's possible that an item required for progression is in a mission where you 
+can't reach all of its locations or complete it. 
+However, mission completion is always required to gain access to new missions.
+
+Aside from mission completion, the other location categories can be disabled in the player options.
+For instance, you can disable getting items for reaching required milestones.
 
 When you receive items, they will immediately become available, even during a mission, and you will be
-notified via a text box in the top-right corner of the game screen. Item unlocks are also logged in the Archipelago client.
+notified via a text box in the top-right corner of the game screen. 
+Item unlocks are also logged in the Archipelago client.
 
-Missions are launched through the Starcraft 2 Archipelago client, through the Starcraft 2 Launcher tab. The between mission segments on the Hyperion, the Leviathan, and the Spear of Adun are not included. Additionally, metaprogression currencies such as credits and Solarite are not used.
+Missions are launched through the StarCraft 2 Archipelago client, through the StarCraft 2 Launcher tab. 
+The between mission segments on the Hyperion, the Leviathan, and the Spear of Adun are not included. 
+Additionally, metaprogression currencies such as credits and Solarite are not used.
 
 ## What is the goal of this game when randomized?
 
-The goal is to beat the final mission in the mission order. The yaml configuration file controls the mission order and how missions are shuffled.
+The goal is to beat the final mission in the mission order. 
+The yaml configuration file controls the mission order (e.g. blitz, grid, etc.), which combination of the four 
+StarCraft 2 campaigns can be used to populate the mission order and how missions are shuffled. 
+Since the first two options determine the number of missions in a StarCraft 2 world, they can be used to customize the 
+expected time to complete the world. 
+Note that the evolution missions from Heart of the Swarm are not included in the randomizer.
 
-## What non-randomized changes are there from vanilla Starcraft 2?
+## What non-randomized changes are there from vanilla StarCraft 2?
 
 1. Some missions have more vespene geysers available to allow a wider variety of units.
-2. Many new units and upgrades have been added as items, coming from co-op, melee, later campaigns, later expansions, brood war, and original ideas.
-3. Higher-tech production structures, including Factories, Starports, Robotics Facilities, and Stargates, no longer have tech requirements.
+2. Many new units and upgrades have been added as items, coming from co-op, melee, later campaigns, later expansions, 
+brood war, and original ideas.
+3. Higher-tech production structures, including Factories, Starports, Robotics Facilities, and Stargates, no longer 
+have tech requirements.
 4. Zerg missions have been adjusted to give the player a starting Lair where they would only have Hatcheries.
-5. Upgrades with a downside have had the downside removed, such as automated refineries costing more or tech reactors taking longer to build.
-6. Unit collision within the vents in Enemy Within has been adjusted to allow larger units to travel through them without getting stuck in odd places.
+5. Upgrades with a downside have had the downside removed, such as automated refineries costing more or tech reactors 
+taking longer to build.
+6. Unit collision within the vents in Enemy Within has been adjusted to allow larger units to travel through them 
+without getting stuck in odd places.
 7. Several vanilla bugs have been fixed.
 
 ## Which of my items can be in another player's world?
 
-By default, any of StarCraft 2's items (specified above) can be in another player's world. See the
-[Advanced YAML Guide](/tutorial/Archipelago/advanced_settings/en)
-for more information on how to change this.
+By default, any of StarCraft 2's items (specified above) can be in another player's world. 
+See the [Advanced YAML Guide](/tutorial/Archipelago/advanced_settings/en) for more information on how to change this.
 
 ## Unique Local Commands
 
-The following commands are only available when using the Starcraft 2 Client to play with Archipelago. You can list them any time in the client with `/help`.
+The following commands are only available when using the StarCraft 2 Client to play with Archipelago. 
+You can list them any time in the client with `/help`.
 
-* `/download_data` Download the most recent release of the necessary files for playing SC2 with Archipelago. Will overwrite existing files
+* `/download_data` Download the most recent release of the necessary files for playing SC2 with Archipelago. 
+Will overwrite existing files
 * `/difficulty [difficulty]` Overrides the difficulty set for the world.
     * Options: casual, normal, hard, brutal
 * `/game_speed [game_speed]` Overrides the game speed for the world
     * Options: default, slower, slow, normal, fast, faster
 * `/color [faction] [color]` Changes your color for one of your playable factions.
     * Faction options: raynor, kerrigan, primal, protoss, nova
-    * Color options: white, red, blue, teal, purple, yellow, orange, green, lightpink, violet, lightgrey, darkgreen, brown, lightgreen, darkgrey, pink, rainbow, random, default
+    * Color options: white, red, blue, teal, purple, yellow, orange, green, lightpink, violet, lightgrey, darkgreen, 
+    brown, lightgreen, darkgrey, pink, rainbow, random, default
 * `/option [option_name] [option_value]` Sets an option normally controlled by your yaml after generation.
     * Run without arguments to list all options.
-    * Options pertain to automatic cutscene skipping, Kerrigan presence, Spear of Adun presence, starting resource amounts, controlling AI allies, etc.
-* `/disable_mission_check` Disables the check to see if a mission is available to play. Meant for co-op runs where one player can play the next mission in a chain the other player is doing.
-* `/play [mission_id]` Starts a Starcraft 2 mission based off of the mission_id provided
+    * Options pertain to automatic cutscene skipping, Kerrigan presence, Spear of Adun presence, starting resource 
+    amounts, controlling AI allies, etc.
+* `/disable_mission_check` Disables the check to see if a mission is available to play. 
+Meant for co-op runs where one player can play the next mission in a chain the other player is doing.
+* `/play [mission_id]` Starts a StarCraft 2 mission based off of the mission_id provided
 * `/available` Get what missions are currently available to play
 * `/unfinished` Get what missions are currently available to play and have not had all locations checked
 * `/set_path [path]` Manually set the SC2 install directory (if the automatic detection fails)
+
+Note that the behavior of the command `/received` was modified in the StarCraft 2 client.
+In the Common client of Archipelago, the command returns the list of items received in the reverse order they were 
+received.
+In the StarCraft 2 client, the returned list will be divided by races (i.e., Any, Protoss, Terran, and Zerg).
+Additionally, upgrades are grouped beneath their corresponding units or buildings.
+A filter parameter can be provided, e.g., `/received Thor`, to limit the number of items shown.
+Every item whose name, race, or group name contains the provided parameter will be shown.
+
+## Known issues
+
+- StarCraft 2 Archipelago does not support loading a saved game. 
+For this reason, it is recommended to play on a difficulty level lower than what you are normally comfortable with.
+- StarCraft 2 Archipelago does not support the restart of a mission from the StarCraft 2 menu. 
+To restart a mission, use the StarCraft 2 Client.
+- A crash report is often generated when a mission is closed. 
+This does not affect the game and can be ignored.

worlds/sc2/docs/fr_Starcraft 2.md

@@ -21,6 +21,14 @@ Les *items* sont trouvés en accomplissant du progrès dans les catégories suiv
 * Réussir des défis basés sur les succès du jeu de base, e.g. éliminer tous les *Zerg* dans la mission 
 *Devil's Playground*
 
+Dans la nomenclature d'Archipelago, il s'agit des *locations* où l'on peut trouver des *items*.
+Pour chaque *location*, incluant le fait de terminer une mission, il y a des règles qui définissent les *items* 
+nécessaires pour y accéder.
+Ces règles ont été conçues en assumant que *StarCraft 2* est joué à la difficulté *Brutal*.
+Étant donné que chaque *location* a ses propres règles, il est possible qu'un *item* nécessaire à la progression se 
+trouve dans une mission dont vous ne pouvez pas atteindre toutes les *locations* ou que vous ne pouvez pas terminer. 
+Cependant, il est toujours nécessaire de terminer une mission pour pouvoir accéder à de nouvelles missions.
+
 Ces catégories, outre la première, peuvent être désactivées dans les options du jeu. 
 Par exemple, vous pouvez désactiver le fait d'obtenir des *items*  lorsque des étapes importantes d'une mission sont 
 accomplies.
@@ -37,8 +45,13 @@ Archipelago*.
 
 ## Quel est le but de ce jeu quand il est *randomized*?
 
-Le but est de réussir la mission finale dans la disposition des missions (e.g. *blitz*, *grid*, etc.).
-Les choix faits dans le fichier *yaml* définissent la disposition des missions et comment elles sont mélangées.
+Le but est de réussir la mission finale du *mission order* (e.g. *blitz*, *grid*, etc.).
+Le fichier de configuration yaml permet de spécifier le *mission order*, lesquelles des quatre campagnes de 
+*StarCraft 2* peuvent être utilisées pour remplir le *mission order* et comment les missions sont distribuées dans le 
+*mission order*. 
+Étant donné que les deux premières options déterminent le nombre de missions dans un monde de *StarCraft 2*, elles 
+peuvent être utilisées pour moduler le temps nécessaire pour terminer le monde. 
+Notez que les missions d'évolution de Heart of the Swarm ne sont pas incluses dans le *randomizer*.
 
 ## Quelles sont les modifications non aléatoires comparativement à la version de base de *StarCraft 2*
 
@@ -93,3 +106,20 @@ mission de la chaîne qu'un autre joueur est en train d'entamer.
 l'accès à un *item* n'ont pas été accomplis.
 * `/set_path [path]` Permet de définir manuellement où *StarCraft 2* est installé ce qui est pertinent seulement si la 
 détection automatique de cette dernière échoue.
+
+Notez que le comportement de la commande `/received` a été modifié dans le client *StarCraft 2*.
+Dans le client *Common* d'Archipelago, elle renvoie la liste des *items* reçus dans l'ordre inverse de leur réception.
+Dans le client de *StarCraft 2*, la liste est divisée par races (i.e., *Any*, *Protoss*, *Terran*, et *Zerg*).
+De plus, les améliorations sont regroupées sous leurs unités/bâtiments correspondants.
+Un paramètre de filtrage peut aussi être fourni, e.g., `/received Thor`, pour limiter le nombre d'*items* affichés.
+Tous les *items* dont le nom, la race ou le nom de groupe contient le paramètre fourni seront affichés.
+
+## Problèmes connus
+
+- *StarCraft 2 Archipelago* ne supporte pas le chargement d'une sauvegarde. 
+Pour cette raison, il est recommandé de jouer à un niveau de difficulté inférieur à celui avec lequel vous êtes 
+normalement à l'aise.
+- *StarCraft 2 Archipelago* ne supporte pas le redémarrage d'une mission depuis le menu de *StarCraft 2*.
+Pour redémarrer une mission, utilisez le client de *StarCraft 2 Archipelago*.
+- Un rapport d'erreur est souvent généré lorsqu'une mission est fermée. 
+Cela n'affecte pas le jeu et peut être ignoré.

worlds/sc2/docs/setup_en.md

@@ -1,30 +1,39 @@
 # StarCraft 2 Randomizer Setup Guide
 
-This guide contains instructions on how to install and troubleshoot the StarCraft 2 Archipelago client, as well as where
-to obtain a config file for StarCraft 2.
+This guide contains instructions on how to install and troubleshoot the StarCraft 2 Archipelago client, as well as 
+where to obtain a config file for StarCraft 2.
 
 ## Required Software
 
 - [StarCraft 2](https://starcraft2.com/en-us/)
+   - While StarCraft 2 Archipelago supports all four campaigns, they are not mandatory to play the randomizer. 
+   If you do not own certain campaigns, you only need to exclude them in the configuration file of your world.
 - [The most recent Archipelago release](https://github.com/ArchipelagoMW/Archipelago/releases)
 
 ## How do I install this randomizer?
 
-1. Install StarCraft 2 and Archipelago using the links above. The StarCraft 2 Archipelago client is downloaded by the Archipelago installer.
+1. Install StarCraft 2 and Archipelago using the links above. The StarCraft 2 Archipelago client is downloaded by the 
+Archipelago installer.
    - Linux users should also follow the instructions found at the bottom of this page 
      (["Running in Linux"](#running-in-linux)).
 2. Run ArchipelagoStarcraft2Client.exe.
-   - macOS users should instead follow the instructions found at ["Running in macOS"](#running-in-macos) for this step only.
-3. Type the command `/download_data`. This will automatically install the Maps and Data files from the third link above.
+   - macOS users should instead follow the instructions found at ["Running in macOS"](#running-in-macos) for this step 
+   only.
+3. Type the command `/download_data`. 
+This will automatically install the Maps and Data files needed to play StarCraft 2 Archipelago.
 
 ## Where do I get a config file (aka "YAML") for this game?
 
-Yaml files are configuration files that tell Archipelago how you'd like your game to be randomized, even if you're only using default options.
+Yaml files are configuration files that tell Archipelago how you'd like your game to be randomized, even if you're only 
+using default options.
 When you're setting up a multiworld, every world needs its own yaml file.
 
 There are three basic ways to get a yaml:
-* You can go to the [Player Options](/games/Starcraft%202/player-options) page, set your options in the GUI, and export the yaml.
-* You can generate a template, either by downloading it from the [Player Options](/games/Starcraft%202/player-options) page or by generating it from the Launcher (ArchipelagoLauncher.exe). The template includes descriptions of each option, you just have to edit it in your text editor of choice.
+* You can go to the [Player Options](/games/Starcraft%202/player-options) page, set your options in the GUI, and export 
+the yaml.
+* You can generate a template, either by downloading it from the [Player Options](/games/Starcraft%202/player-options) 
+page or by generating it from the Launcher (`ArchipelagoLauncher.exe`). 
+The template includes descriptions of each option, you just have to edit it in your text editor of choice.
 * You can ask someone else to share their yaml to use it for yourself or adjust it as you wish.
 
 Remember the name you enter in the options page or in the yaml file, you'll need it to connect later!
@@ -36,15 +45,31 @@ Check out [Creating a YAML](/tutorial/Archipelago/setup/en#creating-a-yaml) for
 
 The simplest way to check is to use the website [validator](/check). 
 
-You can also test it by attempting to generate a multiworld with your yaml. Save your yaml to the Players/ folder within your Archipelago installation and run ArchipelagoGenerate.exe. You should see a new .zip file within the output/ folder of your Archipelago installation if things worked correctly. It's advisable to run ArchipelagoGenerate through a terminal so that you can see the printout, which will include any errors and the precise output file name if it's successful. If you don't like terminals, you can also check the log file in the logs/ folder.
+You can also test it by attempting to generate a multiworld with your yaml. Save your yaml to the `Players/` folder 
+within your Archipelago installation and run `ArchipelagoGenerate.exe`. 
+You should see a new `.zip` file within the `output/` folder of your Archipelago installation if things worked 
+correctly. 
+It's advisable to run `ArchipelagoGenerate.exe` through a terminal so that you can see the printout, which will include 
+any errors and the precise output file name if it's successful. 
+If you don't like terminals, you can also check the log file in the `logs/` folder.
 
 #### What does Progression Balancing do?
 
-For Starcraft 2, not much. It's an Archipelago-wide option meant to shift required items earlier in the playthrough, but Starcraft 2 tends to be much more open in what items you can use. As such, this adjustment isn't very noticeable. It can also increase generation times, so we generally recommend turning it off.
+For StarCraft 2, this option doesn't have much impact. 
+It is an Archipelago option designed to balance world progression by swapping items in spheres. 
+If the Progression Balancing of one world is greater than that of others, items in that world are more likely to be 
+obtained early, and vice versa if its value is smaller. 
+However, StarCraft 2 is more permissive regarding the items that can be used to progress, so this option has little 
+influence on progression in a StarCraft 2 world. 
+StarCraft 2. 
+Since this option increases the time required to generate a MultiWorld, we recommend deactivating it (i.e., setting it 
+to zero) for a StarCraft 2 world.
 
 #### How do I specify items in a list, like in excluded items?
 
-You can look up the syntax for yaml collections in the [YAML specification](https://yaml.org/spec/1.2.2/#21-collections). For lists, every item goes on its own line, started with a hyphen:
+You can look up the syntax for yaml collections in the 
+[YAML specification](https://yaml.org/spec/1.2.2/#21-collections). 
+For lists, every item goes on its own line, started with a hyphen:
 
 ```yaml
 excluded_items:
@@ -52,11 +77,13 @@ excluded_items:
   - Drop-Pods (Kerrigan Tier 7)
 ```
 
-An empty list is just a matching pair of square brackets: `[]`. That's the default value in the template, which should let you know to use this syntax.
+An empty list is just a matching pair of square brackets: `[]`. 
+That's the default value in the template, which should let you know to use this syntax.
 
 #### How do I specify items for the starting inventory?
 
-The starting inventory is a YAML mapping rather than a list, which associates an item with the amount you start with. The syntax looks like the item name, followed by a colon, then a whitespace character, and then the value:
+The starting inventory is a YAML mapping rather than a list, which associates an item with the amount you start with. 
+The syntax looks like the item name, followed by a colon, then a whitespace character, and then the value:
 
 ```yaml
 start_inventory:
@@ -64,37 +91,61 @@ start_inventory:
   Additional Starting Vespene: 5
 ```
 
-An empty mapping is just a matching pair of curly braces: `{}`. That's the default value in the template, which should let you know to use this syntax.
+An empty mapping is just a matching pair of curly braces: `{}`. 
+That's the default value in the template, which should let you know to use this syntax.
 
 #### How do I know the exact names of items and locations?
 
-The [*datapackage*](/datapackage) page of the Archipelago website provides a complete list of the items and locations for each game that it currently supports, including StarCraft 2.
+The [*datapackage*](/datapackage) page of the Archipelago website provides a complete list of the items and locations 
+for each game that it currently supports, including StarCraft 2.
 
-You can also look up a complete list of the item names in the [Icon Repository](https://matthewmarinets.github.io/ap_sc2_icons/) page.
+You can also look up a complete list of the item names in the 
+[Icon Repository](https://matthewmarinets.github.io/ap_sc2_icons/) page.
 This page also contains supplementary information of each item.
-However, the items shown in that page might differ from those shown in the datapackage page of Archipelago since the former is generated, most of the time, from beta versions of StarCraft 2 Archipelago undergoing development.
+However, the items shown in that page might differ from those shown in the datapackage page of Archipelago since the 
+former is generated, most of the time, from beta versions of StarCraft 2 Archipelago undergoing development.
 
-As for the locations, you can see all the locations associated to a mission in your world by placing your cursor over the mission in the 'StarCraft 2 Launcher' tab in the client.
+As for the locations, you can see all the locations associated to a mission in your world by placing your cursor over 
+the mission in the 'StarCraft 2 Launcher' tab in the client.
 
 ## How do I join a MultiWorld game?
 
 1. Run ArchipelagoStarcraft2Client.exe.
-   - macOS users should instead follow the instructions found at ["Running in macOS"](#running-in-macos) for this step only.
+   - macOS users should instead follow the instructions found at ["Running in macOS"](#running-in-macos) for this step 
+   only.
 2. Type `/connect [server ip]`.
    - If you're running through the website, the server IP should be displayed near the top of the room page.
 3. Type your slot name from your YAML when prompted.
 4. If the server has a password, enter that when prompted.
-5. Once connected, switch to the 'StarCraft 2 Launcher' tab in the client. There, you can see all the missions in your world. Unreachable missions will have greyed-out text. Just click on an available mission to start it!
+5. Once connected, switch to the 'StarCraft 2 Launcher' tab in the client. There, you can see all the missions in your 
+world. 
+Unreachable missions will have greyed-out text. Just click on an available mission to start it!
 
 ## The game isn't launching when I try to start a mission.
 
-First, check the log file for issues (stored at `[Archipelago Directory]/logs/SC2Client.txt`). If you can't figure out
-the log file, visit our [Discord's](https://discord.com/invite/8Z65BR2) tech-support channel for help. Please include a
-specific description of what's going wrong and attach your log file to your message.
+First, check the log file for issues (stored at `[Archipelago Directory]/logs/SC2Client.txt`). 
+If you can't figure out the log file, visit our [Discord's](https://discord.com/invite/8Z65BR2) tech-support channel 
+for help. 
+Please include a specific description of what's going wrong and attach your log file to your message.
+
+## My keyboard shortcuts profile is not available when I play *StarCraft 2 Archipelago*.
+
+For your keyboard shortcuts profile to work in Archipelago, you need to copy your shortcuts file from 
+`Documents/StarCraft II/Accounts/######/Hotkeys` to `Documents/StarCraft II/Hotkeys`. 
+If the folder doesn't exist, create it.
+
+To enable StarCraft 2 Archipelago to use your profile, follow these steps:
+1. Launch StarCraft 2 via the Battle.net application.
+2. Change your hotkey profile to the standard mode and accept.
+3. Select your custom profile and accept.
+
+You will only need to do this once.
 
 ## Running in macOS
 
-To run StarCraft 2 through Archipelago in macOS, you will need to run the client via source as seen here: [macOS Guide](/tutorial/Archipelago/mac/en). Note: to launch the client, you will need to run the command `python3 Starcraft2Client.py`.
+To run StarCraft 2 through Archipelago in macOS, you will need to run the client via source as seen here: 
+[macOS Guide](/tutorial/Archipelago/mac/en). 
+Note: to launch the client, you will need to run the command `python3 Starcraft2Client.py`.
 
 ## Running in Linux
 
@@ -102,9 +153,9 @@ To run StarCraft 2 through Archipelago in Linux, you will need to install the ga
 of the Archipelago client.
 
 Make sure you have StarCraft 2 installed using Wine, and that you have followed the
-[installation procedures](#how-do-i-install-this-randomizer?) to add the Archipelago maps to the correct location. You will not
-need to copy the .dll files. If you're having trouble installing or running StarCraft 2 on Linux, I recommend using the
-Lutris installer.
+[installation procedures](#how-do-i-install-this-randomizer?) to add the Archipelago maps to the correct location. 
+You will not need to copy the `.dll` files. 
+If you're having trouble installing or running StarCraft 2 on Linux, it is recommend to use the Lutris installer.
 
 Copy the following into a .sh file, replacing the values of **WINE** and **SC2PATH** variables with the relevant
 locations, as well as setting **PATH_TO_ARCHIPELAGO** to the directory containing the AppImage if it is not in the same
@@ -139,5 +190,5 @@ below, replacing **${ID}** with the numerical ID.
     lutris lutris:rungameid/${ID} --output-script sc2.sh
 
 This will get all of the relevant environment variables Lutris sets to run StarCraft 2 in a script, including the path
-to the Wine binary that Lutris uses. You can then remove the line that runs the Battle.Net launcher and copy the code
-above into the existing script.
+to the Wine binary that Lutris uses. 
+You can then remove the line that runs the Battle.Net launcher and copy the code above into the existing script.

worlds/sc2/docs/setup_fr.md

@@ -6,6 +6,10 @@ indications pour obtenir un fichier de configuration de *StarCraft 2 Archipelago
 ## Logiciels requis
 
 - [*StarCraft 2*](https://starcraft2.com/en-us/)
+   - Bien que *StarCraft 2 Archipelago* supporte les quatre campagnes, elles ne sont pas obligatoires pour jouer au 
+   *randomizer*. 
+   Si vous ne possédez pas certaines campagnes, il vous suffit de les exclure dans le fichier de configuration de 
+   votre monde.
 - [La version la plus récente d'Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases)
 
 ## Comment est-ce que j'installe ce *randomizer*?
@@ -41,10 +45,6 @@ préférences.
 Prenez soin de vous rappeler du nom de joueur que vous avez inscrit dans la page à options ou dans le fichier *yaml* 
 puisque vous en aurez besoin pour vous connecter à votre monde!
 
-Notez que la page *Player options* ne permet pas de définir certaines des options avancées, e.g., l'exclusion de 
-certaines unités ou de leurs améliorations. 
-Utilisez la page [*Weighted Options*](/weighted-options) pour avoir accès à ces dernières.
-
 Si vous désirez des informations et/ou instructions générales sur l'utilisation d'un fichier *yaml* pour Archipelago, 
 veuillez consulter [*Creating a YAML*](/tutorial/Archipelago/setup/en#creating-a-yaml).
 
@@ -66,15 +66,15 @@ dans le dossier `logs/`.
 
 #### À quoi sert l'option *Progression Balancing*?
 
-Pour *Starcraft 2*, cette option ne fait pas grand-chose.
+Pour *StarCraft 2*, cette option ne fait pas grand-chose.
 Il s'agit d'une option d'Archipelago permettant d'équilibrer la progression des mondes en interchangeant les *items* 
 dans les *spheres*. 
 Si le *Progression Balancing* d'un monde est plus grand que ceux des autres, les *items* de progression de ce monde ont 
 plus de chance d'être obtenus tôt et vice-versa si sa valeur est plus petite que celle des autres mondes. 
-Cependant, *Starcraft 2* est beaucoup plus permissif en termes d'*items* qui permettent de progresser, ce réglage à 
+Cependant, *StarCraft 2* est beaucoup plus permissif en termes d'*items* qui permettent de progresser, ce réglage à 
 donc peu d'influence sur la progression dans *StarCraft 2*. 
 Vu qu'il augmente le temps de génération d'un *MultiWorld*, nous recommandons de le désactiver, c-à-d le définir à 
-zéro, pour *Starcraft 2*. 
+zéro, pour *StarCraft 2*. 
 
 
 #### Comment est-ce que je définis une liste d'*items*, e.g. pour l'option *excluded items*?
@@ -122,6 +122,10 @@ Cependant, l'information présente dans cette dernière peut différer de celle
 puisqu'elle est générée, habituellement, à partir de la version en développement de *StarCraft 2 Archipelago* qui 
 n'ont peut-être pas encore été inclus dans le site web d'Archipelago.
 
+Pour ce qui concerne les *locations*, vous pouvez consulter tous les *locations* associés à une mission dans votre 
+monde en plaçant votre curseur sur la case correspondante dans l'onglet *StarCraft 2 Launcher* du client.
+
+
 ## Comment est-ce que je peux joindre un *MultiWorld*?
 
 1. Exécuter `ArchipelagoStarcraft2Client.exe`.
@@ -152,7 +156,7 @@ qui se trouve dans `Documents/StarCraft II/Accounts/######/Hotkeys` vers `Docume
 Si le dossier n'existe pas, créez-le.
 
 Pour que *StarCraft 2 Archipelago* utilise votre profil, suivez les étapes suivantes.
-Lancez *Starcraft 2* via l'application *Battle.net*. 
+Lancez *StarCraft 2* via l'application *Battle.net*. 
 Changez votre profil de raccourcis clavier pour le mode standard et acceptez, puis sélectionnez votre profil 
 personnalisé et acceptez. 
 Vous n'aurez besoin de faire ça qu'une seule fois.

worlds/stardew_valley/logic/skill_logic.py

@@ -15,13 +15,13 @@ from .. import options
 from ..data.harvest import HarvestCropSource
 from ..mods.logic.magic_logic import MagicLogicMixin
 from ..mods.logic.mod_skills_levels import get_mod_skill_levels
-from ..stardew_rule import StardewRule, True_, False_, true_, And
+from ..stardew_rule import StardewRule, true_, True_, False_
 from ..strings.craftable_names import Fishing
 from ..strings.machine_names import Machine
 from ..strings.performance_names import Performance
 from ..strings.quality_names import ForageQuality
 from ..strings.region_names import Region
-from ..strings.skill_names import Skill, all_mod_skills
+from ..strings.skill_names import Skill, all_mod_skills, all_vanilla_skills
 from ..strings.tool_names import ToolMaterial, Tool
 from ..strings.wallet_item_names import Wallet
 
@@ -43,22 +43,17 @@ CombatLogicMixin, MagicLogicMixin, HarvestingLogicMixin]]):
         if level <= 0:
             return True_()
 
-        tool_level = (level - 1) // 2
+        tool_level = min(4, (level - 1) // 2)
         tool_material = ToolMaterial.tiers[tool_level]
-        months = max(1, level - 1)
-        months_rule = self.logic.time.has_lived_months(months)
 
-        if self.options.skill_progression != options.SkillProgression.option_vanilla:
-            previous_level_rule = self.logic.skill.has_level(skill, level - 1)
-        else:
-            previous_level_rule = true_
+        previous_level_rule = self.logic.skill.has_previous_level(skill, level)
 
         if skill == Skill.fishing:
             xp_rule = self.logic.tool.has_fishing_rod(max(tool_level, 3))
         elif skill == Skill.farming:
             xp_rule = self.can_get_farming_xp & self.logic.tool.has_tool(Tool.hoe, tool_material) & self.logic.tool.can_water(tool_level)
         elif skill == Skill.foraging:
-            xp_rule = (self.can_get_foraging_xp & self.logic.tool.has_tool(Tool.axe, tool_material)) |\
+            xp_rule = (self.can_get_foraging_xp & self.logic.tool.has_tool(Tool.axe, tool_material)) | \
                       self.logic.magic.can_use_clear_debris_instead_of_tool_level(tool_level)
         elif skill == Skill.mining:
             xp_rule = self.logic.tool.has_tool(Tool.pickaxe, tool_material) | \
@@ -70,22 +65,34 @@ CombatLogicMixin, MagicLogicMixin, HarvestingLogicMixin]]):
             xp_rule = xp_rule & self.logic.region.can_reach(Region.mines_floor_5)
         elif skill in all_mod_skills:
             # Ideal solution would be to add a logic registry, but I'm too lazy.
-            return previous_level_rule & months_rule & self.logic.mod.skill.can_earn_mod_skill_level(skill, level)
+            return previous_level_rule & self.logic.mod.skill.can_earn_mod_skill_level(skill, level)
         else:
             raise Exception(f"Unknown skill: {skill}")
 
-        return previous_level_rule & months_rule & xp_rule
+        return previous_level_rule & xp_rule
 
     # Should be cached
     def has_level(self, skill: str, level: int) -> StardewRule:
-        if level <= 0:
-            return True_()
+        assert level >= 0, f"There is no level before level 0."
+        if level == 0:
+            return true_
 
         if self.options.skill_progression == options.SkillProgression.option_vanilla:
             return self.logic.skill.can_earn_level(skill, level)
 
         return self.logic.received(f"{skill} Level", level)
 
+    def has_previous_level(self, skill: str, level: int) -> StardewRule:
+        assert level > 0, f"There is no level before level 0."
+        if level == 1:
+            return true_
+
+        if self.options.skill_progression == options.SkillProgression.option_vanilla:
+            months = max(1, level - 1)
+            return self.logic.time.has_lived_months(months)
+
+        return self.logic.received(f"{skill} Level", level - 1)
+
     @cache_self1
     def has_farming_level(self, level: int) -> StardewRule:
         return self.logic.skill.has_level(Skill.farming, level)
@@ -108,18 +115,9 @@ CombatLogicMixin, MagicLogicMixin, HarvestingLogicMixin]]):
             return rule_with_fishing
         return self.logic.time.has_lived_months(months_with_4_skills) | rule_with_fishing
 
-    def has_all_skills_maxed(self, included_modded_skills: bool = True) -> StardewRule:
-        if self.options.skill_progression == options.SkillProgression.option_vanilla:
-            return self.has_total_level(50)
-        skills_items = vanilla_skill_items
-        if included_modded_skills:
-            skills_items += get_mod_skill_levels(self.options.mods)
-        return And(*[self.logic.received(skill, 10) for skill in skills_items])
-
-    def can_enter_mastery_cave(self) -> StardewRule:
-        if self.options.skill_progression == options.SkillProgression.option_progressive_with_masteries:
-            return self.logic.received(Wallet.mastery_of_the_five_ways)
-        return self.has_all_skills_maxed()
+    def has_any_skills_maxed(self, included_modded_skills: bool = True) -> StardewRule:
+        skills = self.content.skills.keys() if included_modded_skills else sorted(all_vanilla_skills)
+        return self.logic.or_(*(self.logic.skill.has_level(skill, 10) for skill in skills))
 
     @cached_property
     def can_get_farming_xp(self) -> StardewRule:
@@ -197,13 +195,19 @@ CombatLogicMixin, MagicLogicMixin, HarvestingLogicMixin]]):
             return self.has_level(Skill.foraging, 9)
         return False_()
 
-    @cached_property
-    def can_earn_mastery_experience(self) -> StardewRule:
-        if self.options.skill_progression != options.SkillProgression.option_progressive_with_masteries:
-            return self.has_all_skills_maxed() & self.logic.time.has_lived_max_months
-        return self.logic.time.has_lived_max_months
+    def can_earn_mastery(self, skill: str) -> StardewRule:
+        # Checking for level 11, so it includes having level 10 and being able to earn xp.
+        return self.logic.skill.can_earn_level(skill, 11) & self.logic.region.can_reach(Region.mastery_cave)
 
     def has_mastery(self, skill: str) -> StardewRule:
-        if self.options.skill_progression != options.SkillProgression.option_progressive_with_masteries:
-            return self.can_earn_mastery_experience and self.logic.region.can_reach(Region.mastery_cave)
-        return self.logic.received(f"{skill} Mastery")
+        if self.options.skill_progression == options.SkillProgression.option_progressive_with_masteries:
+            return self.logic.received(f"{skill} Mastery")
+
+        return self.logic.skill.can_earn_mastery(skill)
+
+    @cached_property
+    def can_enter_mastery_cave(self) -> StardewRule:
+        if self.options.skill_progression == options.SkillProgression.option_progressive_with_masteries:
+            return self.logic.received(Wallet.mastery_of_the_five_ways)
+
+        return self.has_any_skills_maxed(included_modded_skills=False)

worlds/stardew_valley/rules.py

@@ -154,7 +154,7 @@ def set_bundle_rules(bundle_rooms: List[BundleRoom], logic: StardewLogic, multiw
                 extra_raccoons = extra_raccoons + num
                 bundle_rules = logic.received(CommunityUpgrade.raccoon, extra_raccoons) & bundle_rules
                 if num > 1:
-                    previous_bundle_name = f"Raccoon Request {num-1}"
+                    previous_bundle_name = f"Raccoon Request {num - 1}"
                     bundle_rules = bundle_rules & logic.region.can_reach_location(previous_bundle_name)
             room_rules.append(bundle_rules)
             MultiWorldRules.set_rule(location, bundle_rules)
@@ -168,13 +168,16 @@ def set_skills_rules(logic: StardewLogic, multiworld, player, world_options: Sta
     mods = world_options.mods
     if world_options.skill_progression == SkillProgression.option_vanilla:
         return
+
     for i in range(1, 11):
         set_vanilla_skill_rule_for_level(logic, multiworld, player, i)
         set_modded_skill_rule_for_level(logic, multiworld, player, mods, i)
-    if world_options.skill_progression != SkillProgression.option_progressive_with_masteries:
+
+    if world_options.skill_progression == SkillProgression.option_progressive:
         return
+
     for skill in [Skill.farming, Skill.fishing, Skill.foraging, Skill.mining, Skill.combat]:
-        MultiWorldRules.set_rule(multiworld.get_location(f"{skill} Mastery", player), logic.skill.can_earn_mastery_experience)
+        MultiWorldRules.set_rule(multiworld.get_location(f"{skill} Mastery", player), logic.skill.can_earn_mastery(skill))
 
 
 def set_vanilla_skill_rule_for_level(logic: StardewLogic, multiworld, player, level: int):
@@ -256,8 +259,7 @@ def set_entrance_rules(logic: StardewLogic, multiworld, player, world_options: S
     set_entrance_rule(multiworld, player, LogicEntrance.farmhouse_cooking, logic.cooking.can_cook_in_kitchen)
     set_entrance_rule(multiworld, player, LogicEntrance.shipping, logic.shipping.can_use_shipping_bin)
     set_entrance_rule(multiworld, player, LogicEntrance.watch_queen_of_sauce, logic.action.can_watch(Channel.queen_of_sauce))
-    set_entrance_rule(multiworld, player, Entrance.forest_to_mastery_cave, logic.skill.can_enter_mastery_cave())
-    set_entrance_rule(multiworld, player, Entrance.forest_to_mastery_cave, logic.skill.can_enter_mastery_cave())
+    set_entrance_rule(multiworld, player, Entrance.forest_to_mastery_cave, logic.skill.can_enter_mastery_cave)
     set_entrance_rule(multiworld, player, LogicEntrance.buy_experience_books, logic.time.has_lived_months(2))
     set_entrance_rule(multiworld, player, LogicEntrance.buy_year1_books, logic.time.has_year_two)
     set_entrance_rule(multiworld, player, LogicEntrance.buy_year3_books, logic.time.has_year_three)

worlds/stardew_valley/test/__init__.py

@@ -85,7 +85,7 @@ def allsanity_no_mods_6_x_x():
         options.QuestLocations.internal_name: 56,
         options.SeasonRandomization.internal_name: options.SeasonRandomization.option_randomized,
         options.Shipsanity.internal_name: options.Shipsanity.option_everything,
-        options.SkillProgression.internal_name: options.SkillProgression.option_progressive,
+        options.SkillProgression.internal_name: options.SkillProgression.option_progressive_with_masteries,
         options.SpecialOrderLocations.internal_name: options.SpecialOrderLocations.option_board_qi,
         options.ToolProgression.internal_name: options.ToolProgression.option_progressive,
         options.TrapItems.internal_name: options.TrapItems.option_nightmare,
@@ -310,6 +310,12 @@ class SVTestBase(RuleAssertMixin, WorldTestBase, SVTestCase):
             self.multiworld.worlds[self.player].total_progression_items -= 1
         return created_item
 
+    def remove_one_by_name(self, item: str) -> None:
+        self.remove(self.create_item(item))
+
+    def reset_collection_state(self):
+        self.multiworld.state = self.original_state.copy()
+
 
 pre_generated_worlds = {}
 

worlds/stardew_valley/test/rules/TestSkills.py

@@ -1,23 +1,30 @@
-from ... import HasProgressionPercent
+from ... import HasProgressionPercent, StardewLogic
 from ...options import ToolProgression, SkillProgression, Mods
-from ...strings.skill_names import all_skills
+from ...strings.skill_names import all_skills, all_vanilla_skills, Skill
 from ...test import SVTestBase
 
 
-class TestVanillaSkillLogicSimplification(SVTestBase):
+class TestSkillProgressionVanilla(SVTestBase):
     options = {
         SkillProgression.internal_name: SkillProgression.option_vanilla,
         ToolProgression.internal_name: ToolProgression.option_progressive,
     }
 
     def test_skill_logic_has_level_only_uses_one_has_progression_percent(self):
-        rule = self.multiworld.worlds[1].logic.skill.has_level("Farming", 8)
-        self.assertEqual(1, sum(1 for i in rule.current_rules if type(i) == HasProgressionPercent))
+        rule = self.multiworld.worlds[1].logic.skill.has_level(Skill.farming, 8)
+        self.assertEqual(1, sum(1 for i in rule.current_rules if type(i) is HasProgressionPercent))
+
+    def test_has_mastery_requires_month_equivalent_to_10_levels(self):
+        logic: StardewLogic = self.multiworld.worlds[1].logic
+        rule = logic.skill.has_mastery(Skill.farming)
+        time_rule = logic.time.has_lived_months(10)
+
+        self.assertIn(time_rule, rule.current_rules)
 
 
-class TestAllSkillsRequirePrevious(SVTestBase):
+class TestSkillProgressionProgressive(SVTestBase):
     options = {
-        SkillProgression.internal_name: SkillProgression.option_progressive_with_masteries,
+        SkillProgression.internal_name: SkillProgression.option_progressive,
         Mods.internal_name: frozenset(Mods.valid_keys),
     }
 
@@ -25,16 +32,82 @@ class TestAllSkillsRequirePrevious(SVTestBase):
         for skill in all_skills:
             self.collect_everything()
             self.remove_by_name(f"{skill} Level")
+
             for level in range(1, 11):
                 location_name = f"Level {level} {skill}"
+                location = self.multiworld.get_location(location_name, self.player)
+
                 with self.subTest(location_name):
-                    can_reach = self.can_reach_location(location_name)
                     if level > 1:
-                        self.assertFalse(can_reach)
+                        self.assert_reach_location_false(location, self.multiworld.state)
                         self.collect(f"{skill} Level")
-                        can_reach = self.can_reach_location(location_name)
-                    self.assertTrue(can_reach)
-            self.multiworld.state = self.original_state.copy()
+
+                    self.assert_reach_location_true(location, self.multiworld.state)
+
+            self.reset_collection_state()
+
+    def test_has_level_requires_exact_amount_of_levels(self):
+        logic: StardewLogic = self.multiworld.worlds[1].logic
+        rule = logic.skill.has_level(Skill.farming, 8)
+        level_rule = logic.received("Farming Level", 8)
+
+        self.assertEqual(level_rule, rule)
+
+    def test_has_previous_level_requires_one_less_level_than_requested(self):
+        logic: StardewLogic = self.multiworld.worlds[1].logic
+        rule = logic.skill.has_previous_level(Skill.farming, 8)
+        level_rule = logic.received("Farming Level", 7)
+
+        self.assertEqual(level_rule, rule)
+
+    def test_has_mastery_requires_10_levels(self):
+        logic: StardewLogic = self.multiworld.worlds[1].logic
+        rule = logic.skill.has_mastery(Skill.farming)
+        level_rule = logic.received("Farming Level", 10)
+
+        self.assertIn(level_rule, rule.current_rules)
 
 
+class TestSkillProgressionProgressiveWithMasteryWithoutMods(SVTestBase):
+    options = {
+        SkillProgression.internal_name: SkillProgression.option_progressive_with_masteries,
+        ToolProgression.internal_name: ToolProgression.option_progressive,
+        Mods.internal_name: frozenset(),
+    }
 
+    def test_has_mastery_requires_the_item(self):
+        logic: StardewLogic = self.multiworld.worlds[1].logic
+        rule = logic.skill.has_mastery(Skill.farming)
+        received_mastery = logic.received("Farming Mastery")
+
+        self.assertEqual(received_mastery, rule)
+
+    def test_given_all_levels_when_can_earn_mastery_then_can_earn_mastery(self):
+        self.collect_everything()
+
+        for skill in all_vanilla_skills:
+            with self.subTest(skill):
+                location = self.multiworld.get_location(f"{skill} Mastery", self.player)
+                self.assert_reach_location_true(location, self.multiworld.state)
+
+        self.reset_collection_state()
+
+    def test_given_one_level_missing_when_can_earn_mastery_then_cannot_earn_mastery(self):
+        for skill in all_vanilla_skills:
+            with self.subTest(skill):
+                self.collect_everything()
+                self.remove_one_by_name(f"{skill} Level")
+
+                location = self.multiworld.get_location(f"{skill} Mastery", self.player)
+                self.assert_reach_location_false(location, self.multiworld.state)
+
+                self.reset_collection_state()
+
+    def test_given_one_tool_missing_when_can_earn_mastery_then_cannot_earn_mastery(self):
+        self.collect_everything()
+
+        self.remove_one_by_name(f"Progressive Pickaxe")
+        location = self.multiworld.get_location("Mining Mastery", self.player)
+        self.assert_reach_location_false(location, self.multiworld.state)
+
+        self.reset_collection_state()

worlds/tunic/__init__.py

@@ -7,8 +7,9 @@ from .rules import set_location_rules, set_region_rules, randomize_ability_unloc
 from .er_rules import set_er_location_rules
 from .regions import tunic_regions
 from .er_scripts import create_er_regions
-from .er_data import portal_mapping
-from .options import TunicOptions, EntranceRando, tunic_option_groups, tunic_option_presets, TunicPlandoConnections
+from .er_data import portal_mapping, RegionInfo, tunic_er_regions
+from .options import (TunicOptions, EntranceRando, tunic_option_groups, tunic_option_presets, TunicPlandoConnections,
+                      LaurelsLocation, LogicRules, LaurelsZips, IceGrappling, LadderStorage)
 from worlds.AutoWorld import WebWorld, World
 from Options import PlandoConnection
 from decimal import Decimal, ROUND_HALF_UP
@@ -48,10 +49,12 @@ class TunicLocation(Location):
 
 
 class SeedGroup(TypedDict):
-    logic_rules: int  # logic rules value
+    laurels_zips: bool  # laurels_zips value
+    ice_grappling: int  # ice_grappling value
+    ladder_storage: int  # ls value
     laurels_at_10_fairies: bool  # laurels location value
     fixed_shop: bool  # fixed shop value
-    plando: TunicPlandoConnections  # consolidated of plando connections for the seed group
+    plando: TunicPlandoConnections  # consolidated plando connections for the seed group
 
 
 class TunicWorld(World):
@@ -77,8 +80,17 @@ class TunicWorld(World):
     tunic_portal_pairs: Dict[str, str]
     er_portal_hints: Dict[int, str]
     seed_groups: Dict[str, SeedGroup] = {}
+    shop_num: int = 1  # need to make it so that you can walk out of shops, but also that they aren't all connected
+    er_regions: Dict[str, RegionInfo]  # absolutely needed so outlet regions work
 
     def generate_early(self) -> None:
+        if self.options.logic_rules >= LogicRules.option_no_major_glitches:
+            self.options.laurels_zips.value = LaurelsZips.option_true
+            self.options.ice_grappling.value = IceGrappling.option_medium
+            if self.options.logic_rules.value == LogicRules.option_unrestricted:
+                self.options.ladder_storage.value = LadderStorage.option_medium
+
+        self.er_regions = tunic_er_regions.copy()
         if self.options.plando_connections:
             for index, cxn in enumerate(self.options.plando_connections):
                 # making shops second to simplify other things later
@@ -99,7 +111,10 @@ class TunicWorld(World):
                 self.options.keys_behind_bosses.value = passthrough["keys_behind_bosses"]
                 self.options.sword_progression.value = passthrough["sword_progression"]
                 self.options.ability_shuffling.value = passthrough["ability_shuffling"]
-                self.options.logic_rules.value = passthrough["logic_rules"]
+                self.options.laurels_zips.value = passthrough["laurels_zips"]
+                self.options.ice_grappling.value = passthrough["ice_grappling"]
+                self.options.ladder_storage.value = passthrough["ladder_storage"]
+                self.options.ladder_storage_without_items = passthrough["ladder_storage_without_items"]
                 self.options.lanternless.value = passthrough["lanternless"]
                 self.options.maskless.value = passthrough["maskless"]
                 self.options.hexagon_quest.value = passthrough["hexagon_quest"]
@@ -118,19 +133,28 @@ class TunicWorld(World):
             group = tunic.options.entrance_rando.value
             # if this is the first world in the group, set the rules equal to its rules
             if group not in cls.seed_groups:
-                cls.seed_groups[group] = SeedGroup(logic_rules=tunic.options.logic_rules.value,
-                                                   laurels_at_10_fairies=tunic.options.laurels_location == 3,
-                                                   fixed_shop=bool(tunic.options.fixed_shop),
-                                                   plando=tunic.options.plando_connections)
+                cls.seed_groups[group] = \
+                    SeedGroup(laurels_zips=bool(tunic.options.laurels_zips),
+                              ice_grappling=tunic.options.ice_grappling.value,
+                              ladder_storage=tunic.options.ladder_storage.value,
+                              laurels_at_10_fairies=tunic.options.laurels_location == LaurelsLocation.option_10_fairies,
+                              fixed_shop=bool(tunic.options.fixed_shop),
+                              plando=tunic.options.plando_connections)
                 continue
-                
+
+            # off is more restrictive
+            if not tunic.options.laurels_zips:
+                cls.seed_groups[group]["laurels_zips"] = False
             # lower value is more restrictive
-            if tunic.options.logic_rules.value < cls.seed_groups[group]["logic_rules"]:
-                cls.seed_groups[group]["logic_rules"] = tunic.options.logic_rules.value
+            if tunic.options.ice_grappling < cls.seed_groups[group]["ice_grappling"]:
+                cls.seed_groups[group]["ice_grappling"] = tunic.options.ice_grappling.value
+            # lower value is more restrictive
+            if tunic.options.ladder_storage.value < cls.seed_groups[group]["ladder_storage"]:
+                cls.seed_groups[group]["ladder_storage"] = tunic.options.ladder_storage.value
             # laurels at 10 fairies changes logic for secret gathering place placement
             if tunic.options.laurels_location == 3:
                 cls.seed_groups[group]["laurels_at_10_fairies"] = True
-            # fewer shops, one at windmill
+            # more restrictive, overrides the option for others in the same group, which is better than failing imo
             if tunic.options.fixed_shop:
                 cls.seed_groups[group]["fixed_shop"] = True
 
@@ -366,7 +390,10 @@ class TunicWorld(World):
             "ability_shuffling": self.options.ability_shuffling.value,
             "hexagon_quest": self.options.hexagon_quest.value,
             "fool_traps": self.options.fool_traps.value,
-            "logic_rules": self.options.logic_rules.value,
+            "laurels_zips": self.options.laurels_zips.value,
+            "ice_grappling": self.options.ice_grappling.value,
+            "ladder_storage": self.options.ladder_storage.value,
+            "ladder_storage_without_items": self.options.ladder_storage_without_items.value,
             "lanternless": self.options.lanternless.value,
             "maskless": self.options.maskless.value,
             "entrance_rando": int(bool(self.options.entrance_rando.value)),

worlds/tunic/docs/en_TUNIC.md

@@ -83,8 +83,6 @@ Notes:
 - 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 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.
 

worlds/tunic/er_data.py

@@ -1,6 +1,9 @@
-from typing import Dict, NamedTuple, List
+from typing import Dict, NamedTuple, List, TYPE_CHECKING, Optional
 from enum import IntEnum
 
+if TYPE_CHECKING:
+    from . import TunicWorld
+
 
 class Portal(NamedTuple):
     name: str  # human-readable name
@@ -9,6 +12,8 @@ class Portal(NamedTuple):
     tag: str  # vanilla tag
 
     def scene(self) -> str:  # the actual scene name in Tunic
+        if self.region.startswith("Shop"):
+            return tunic_er_regions["Shop"].game_scene
         return tunic_er_regions[self.region].game_scene
 
     def scene_destination(self) -> str:  # full, nonchanging name to interpret by the mod
@@ -458,7 +463,7 @@ portal_mapping: List[Portal] = [
     
     Portal(name="Cathedral Main Exit", region="Cathedral",
            destination="Swamp Redux 2", tag="_main"),
-    Portal(name="Cathedral Elevator", region="Cathedral",
+    Portal(name="Cathedral Elevator", region="Cathedral to Gauntlet",
            destination="Cathedral Arena", tag="_"),
     Portal(name="Cathedral Secret Legend Room Exit", region="Cathedral Secret Legend Room",
            destination="Swamp Redux 2", tag="_secret"),
@@ -517,6 +522,13 @@ portal_mapping: List[Portal] = [
 class RegionInfo(NamedTuple):
     game_scene: str  # the name of the scene in the actual game
     dead_end: int = 0  # if a region has only one exit
+    outlet_region: Optional[str] = None
+    is_fake_region: bool = False
+
+
+# gets the outlet region name if it exists, the region if it doesn't
+def get_portal_outlet_region(portal: Portal, world: "TunicWorld") -> str:
+    return world.er_regions[portal.region].outlet_region or portal.region
 
 
 class DeadEnd(IntEnum):
@@ -558,11 +570,11 @@ tunic_er_regions: Dict[str, RegionInfo] = {
     "Overworld Ruined Passage Door": RegionInfo("Overworld Redux"),  # the small space betweeen the door and the portal
     "Overworld Old House Door": RegionInfo("Overworld Redux"),  # the too-small space between the door and the portal
     "Overworld Southeast Cross Door": RegionInfo("Overworld Redux"),  # the small space betweeen the door and the portal
-    "Overworld Fountain Cross Door": RegionInfo("Overworld Redux"),  # the small space between the door and the portal
+    "Overworld Fountain Cross Door": RegionInfo("Overworld Redux", outlet_region="Overworld"),
     "Overworld Temple Door": RegionInfo("Overworld Redux"),  # the small space betweeen the door and the portal
-    "Overworld Town Portal": RegionInfo("Overworld Redux"),  # being able to go to or come from the portal
-    "Overworld Spawn Portal": RegionInfo("Overworld Redux"),  # being able to go to or come from the portal
-    "Cube Cave Entrance Region": RegionInfo("Overworld Redux"),  # other side of the bomb wall
+    "Overworld Town Portal": RegionInfo("Overworld Redux", outlet_region="Overworld"),
+    "Overworld Spawn Portal": RegionInfo("Overworld Redux", outlet_region="Overworld"),
+    "Cube Cave Entrance Region": RegionInfo("Overworld Redux", outlet_region="Overworld"),  # other side of the bomb wall
     "Stick House": RegionInfo("Sword Cave", dead_end=DeadEnd.all_cats),
     "Windmill": RegionInfo("Windmill"),
     "Old House Back": RegionInfo("Overworld Interiors"),  # part with the hc door
@@ -591,7 +603,7 @@ tunic_er_regions: Dict[str, RegionInfo] = {
     "Forest Belltower Lower": RegionInfo("Forest Belltower"),
     "East Forest": RegionInfo("East Forest Redux"),
     "East Forest Dance Fox Spot": RegionInfo("East Forest Redux"),
-    "East Forest Portal": RegionInfo("East Forest Redux"),
+    "East Forest Portal": RegionInfo("East Forest Redux", outlet_region="East Forest"),
     "Lower Forest": RegionInfo("East Forest Redux"),  # bottom of the forest
     "Guard House 1 East": RegionInfo("East Forest Redux Laddercave"),
     "Guard House 1 West": RegionInfo("East Forest Redux Laddercave"),
@@ -601,7 +613,7 @@ tunic_er_regions: Dict[str, RegionInfo] = {
     "Forest Grave Path Main": RegionInfo("Sword Access"),
     "Forest Grave Path Upper": RegionInfo("Sword Access"),
     "Forest Grave Path by Grave": RegionInfo("Sword Access"),
-    "Forest Hero's Grave": RegionInfo("Sword Access"),
+    "Forest Hero's Grave": RegionInfo("Sword Access", outlet_region="Forest Grave Path by Grave"),
     "Dark Tomb Entry Point": RegionInfo("Crypt Redux"),  # both upper exits
     "Dark Tomb Upper": RegionInfo("Crypt Redux"),  # the part with the casket and the top of the ladder
     "Dark Tomb Main": RegionInfo("Crypt Redux"),
@@ -614,18 +626,19 @@ tunic_er_regions: Dict[str, RegionInfo] = {
     "Beneath the Well Back": RegionInfo("Sewer"),  # the back two portals, and all 4 upper chests
     "West Garden": RegionInfo("Archipelagos Redux"),
     "Magic Dagger House": RegionInfo("archipelagos_house", dead_end=DeadEnd.all_cats),
-    "West Garden Portal": RegionInfo("Archipelagos Redux", dead_end=DeadEnd.restricted),
+    "West Garden Portal": RegionInfo("Archipelagos Redux", dead_end=DeadEnd.restricted, outlet_region="West Garden by Portal"),
+    "West Garden by Portal": RegionInfo("Archipelagos Redux", dead_end=DeadEnd.restricted),
     "West Garden Portal Item": RegionInfo("Archipelagos Redux", dead_end=DeadEnd.restricted),
     "West Garden Laurels Exit Region": RegionInfo("Archipelagos Redux"),
     "West Garden after Boss": RegionInfo("Archipelagos Redux"),
-    "West Garden Hero's Grave Region": RegionInfo("Archipelagos Redux"),
+    "West Garden Hero's Grave Region": RegionInfo("Archipelagos Redux", outlet_region="West Garden"),
     "Ruined Atoll": RegionInfo("Atoll Redux"),
     "Ruined Atoll Lower Entry Area": RegionInfo("Atoll Redux"),
     "Ruined Atoll Ladder Tops": RegionInfo("Atoll Redux"),  # at the top of the 5 ladders in south Atoll
     "Ruined Atoll Frog Mouth": RegionInfo("Atoll Redux"),
     "Ruined Atoll Frog Eye": RegionInfo("Atoll Redux"),
-    "Ruined Atoll Portal": RegionInfo("Atoll Redux"),
-    "Ruined Atoll Statue": RegionInfo("Atoll Redux"),
+    "Ruined Atoll Portal": RegionInfo("Atoll Redux", outlet_region="Ruined Atoll"),
+    "Ruined Atoll Statue": RegionInfo("Atoll Redux", outlet_region="Ruined Atoll"),
     "Frog Stairs Eye Exit": RegionInfo("Frog Stairs"),
     "Frog Stairs Upper": RegionInfo("Frog Stairs"),
     "Frog Stairs Lower": RegionInfo("Frog Stairs"),
@@ -633,18 +646,20 @@ tunic_er_regions: Dict[str, RegionInfo] = {
     "Frog's Domain Entry": RegionInfo("frog cave main"),
     "Frog's Domain": RegionInfo("frog cave main"),
     "Frog's Domain Back": RegionInfo("frog cave main"),
-    "Library Exterior Tree Region": RegionInfo("Library Exterior"),
+    "Library Exterior Tree Region": RegionInfo("Library Exterior", outlet_region="Library Exterior by Tree"),
+    "Library Exterior by Tree": RegionInfo("Library Exterior"),
     "Library Exterior Ladder Region": RegionInfo("Library Exterior"),
     "Library Hall Bookshelf": RegionInfo("Library Hall"),
     "Library Hall": RegionInfo("Library Hall"),
-    "Library Hero's Grave Region": RegionInfo("Library Hall"),
+    "Library Hero's Grave Region": RegionInfo("Library Hall", outlet_region="Library Hall"),
     "Library Hall to Rotunda": RegionInfo("Library Hall"),
     "Library Rotunda to Hall": RegionInfo("Library Rotunda"),
     "Library Rotunda": RegionInfo("Library Rotunda"),
     "Library Rotunda to Lab": RegionInfo("Library Rotunda"),
     "Library Lab": RegionInfo("Library Lab"),
     "Library Lab Lower": RegionInfo("Library Lab"),
-    "Library Portal": RegionInfo("Library Lab"),
+    "Library Portal": RegionInfo("Library Lab", outlet_region="Library Lab on Portal Pad"),
+    "Library Lab on Portal Pad": RegionInfo("Library Lab"),
     "Library Lab to Librarian": RegionInfo("Library Lab"),
     "Library Arena": RegionInfo("Library Arena", dead_end=DeadEnd.all_cats),
     "Fortress Exterior from East Forest": RegionInfo("Fortress Courtyard"),
@@ -663,22 +678,22 @@ tunic_er_regions: Dict[str, RegionInfo] = {
     "Fortress Grave Path": RegionInfo("Fortress Reliquary"),
     "Fortress Grave Path Upper": RegionInfo("Fortress Reliquary", dead_end=DeadEnd.restricted),
     "Fortress Grave Path Dusty Entrance Region": RegionInfo("Fortress Reliquary"),
-    "Fortress Hero's Grave Region": RegionInfo("Fortress Reliquary"),
+    "Fortress Hero's Grave Region": RegionInfo("Fortress Reliquary", outlet_region="Fortress Grave Path"),
     "Fortress Leaf Piles": RegionInfo("Dusty", dead_end=DeadEnd.all_cats),
     "Fortress Arena": RegionInfo("Fortress Arena"),
-    "Fortress Arena Portal": RegionInfo("Fortress Arena"),
+    "Fortress Arena Portal": RegionInfo("Fortress Arena", outlet_region="Fortress Arena"),
     "Lower Mountain": RegionInfo("Mountain"),
     "Lower Mountain Stairs": RegionInfo("Mountain"),
     "Top of the Mountain": RegionInfo("Mountaintop", dead_end=DeadEnd.all_cats),
     "Quarry Connector": RegionInfo("Darkwoods Tunnel"),
     "Quarry Entry": RegionInfo("Quarry Redux"),
     "Quarry": RegionInfo("Quarry Redux"),
-    "Quarry Portal": RegionInfo("Quarry Redux"),
+    "Quarry Portal": RegionInfo("Quarry Redux", outlet_region="Quarry Entry"),
     "Quarry Back": RegionInfo("Quarry Redux"),
     "Quarry Monastery Entry": RegionInfo("Quarry Redux"),
     "Monastery Front": RegionInfo("Monastery"),
     "Monastery Back": RegionInfo("Monastery"),
-    "Monastery Hero's Grave Region": RegionInfo("Monastery"),
+    "Monastery Hero's Grave Region": RegionInfo("Monastery", outlet_region="Monastery Back"),
     "Monastery Rope": RegionInfo("Quarry Redux"),
     "Lower Quarry": RegionInfo("Quarry Redux"),
     "Even Lower Quarry": RegionInfo("Quarry Redux"),
@@ -691,19 +706,21 @@ tunic_er_regions: Dict[str, RegionInfo] = {
     "Rooted Ziggurat Middle Bottom": RegionInfo("ziggurat2020_2"),
     "Rooted Ziggurat Lower Front": RegionInfo("ziggurat2020_3"),  # the vanilla entry point side
     "Rooted Ziggurat Lower Back": RegionInfo("ziggurat2020_3"),  # the boss side
-    "Zig Skip Exit": RegionInfo("ziggurat2020_3", dead_end=DeadEnd.special),  # the exit from zig skip, for use with fixed shop on
-    "Rooted Ziggurat Portal Room Entrance": RegionInfo("ziggurat2020_3"),  # the door itself on the zig 3 side
-    "Rooted Ziggurat Portal": RegionInfo("ziggurat2020_FTRoom"),
+    "Zig Skip Exit": RegionInfo("ziggurat2020_3", dead_end=DeadEnd.special, outlet_region="Rooted Ziggurat Lower Front"),  # the exit from zig skip, for use with fixed shop on
+    "Rooted Ziggurat Portal Room Entrance": RegionInfo("ziggurat2020_3", outlet_region="Rooted Ziggurat Lower Back"),  # the door itself on the zig 3 side
+    "Rooted Ziggurat Portal": RegionInfo("ziggurat2020_FTRoom", outlet_region="Rooted Ziggurat Portal Room"),
+    "Rooted Ziggurat Portal Room": RegionInfo("ziggurat2020_FTRoom"),
     "Rooted Ziggurat Portal Room Exit": RegionInfo("ziggurat2020_FTRoom"),
     "Swamp Front": RegionInfo("Swamp Redux 2"),  # from the main entry to the top of the ladder after south
     "Swamp Mid": RegionInfo("Swamp Redux 2"),  # from the bottom of the ladder to the cathedral door
     "Swamp Ledge under Cathedral Door": RegionInfo("Swamp Redux 2"),  # the ledge with the chest and secret door
-    "Swamp to Cathedral Treasure Room": RegionInfo("Swamp Redux 2"),  # just the door
+    "Swamp to Cathedral Treasure Room": RegionInfo("Swamp Redux 2", outlet_region="Swamp Ledge under Cathedral Door"),  # just the door
     "Swamp to Cathedral Main Entrance Region": RegionInfo("Swamp Redux 2"),  # just the door
     "Back of Swamp": RegionInfo("Swamp Redux 2"),  # the area with hero grave and gauntlet entrance
-    "Swamp Hero's Grave Region": RegionInfo("Swamp Redux 2"),
+    "Swamp Hero's Grave Region": RegionInfo("Swamp Redux 2", outlet_region="Back of Swamp"),
     "Back of Swamp Laurels Area": RegionInfo("Swamp Redux 2"),  # the spots you need laurels to traverse
     "Cathedral": RegionInfo("Cathedral Redux"),
+    "Cathedral to Gauntlet": RegionInfo("Cathedral Redux"),  # the elevator
     "Cathedral Secret Legend Room": RegionInfo("Cathedral Redux", dead_end=DeadEnd.all_cats),
     "Cathedral Gauntlet Checkpoint": RegionInfo("Cathedral Arena"),
     "Cathedral Gauntlet": RegionInfo("Cathedral Arena"),
@@ -711,10 +728,10 @@ tunic_er_regions: Dict[str, RegionInfo] = {
     "Far Shore": RegionInfo("Transit"),
     "Far Shore to Spawn Region": RegionInfo("Transit"),
     "Far Shore to East Forest Region": RegionInfo("Transit"),
-    "Far Shore to Quarry Region": RegionInfo("Transit"),
-    "Far Shore to Fortress Region": RegionInfo("Transit"),
-    "Far Shore to Library Region": RegionInfo("Transit"),
-    "Far Shore to West Garden Region": RegionInfo("Transit"),
+    "Far Shore to Quarry Region": RegionInfo("Transit", outlet_region="Far Shore"),
+    "Far Shore to Fortress Region": RegionInfo("Transit", outlet_region="Far Shore"),
+    "Far Shore to Library Region": RegionInfo("Transit", outlet_region="Far Shore"),
+    "Far Shore to West Garden Region": RegionInfo("Transit", outlet_region="Far Shore"),
     "Hero Relic - Fortress": RegionInfo("RelicVoid", dead_end=DeadEnd.all_cats),
     "Hero Relic - Quarry": RegionInfo("RelicVoid", dead_end=DeadEnd.all_cats),
     "Hero Relic - West Garden": RegionInfo("RelicVoid", dead_end=DeadEnd.all_cats),
@@ -728,6 +745,16 @@ tunic_er_regions: Dict[str, RegionInfo] = {
 }
 
 
+# this is essentially a pared down version of the region connections in rules.py, with some minor differences
+# the main purpose of this is to make it so that you can access every region
+# most items are excluded from the rules here, since we can assume Archipelago will properly place them
+# laurels (hyperdash) can be locked at 10 fairies, requiring access to secret gathering place
+# so until secret gathering place has been paired, you do not have hyperdash, so you cannot use hyperdash entrances
+# Zip means you need the laurels zips option enabled
+# IG# refers to ice grappling difficulties
+# LS# refers to ladder storage difficulties
+# LS rules are used for region connections here regardless of whether you have being knocked out of the air in logic
+# this is because it just means you can reach the entrances in that region via ladder storage
 traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     "Overworld": {
         "Overworld Beach":
@@ -735,13 +762,13 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
         "Overworld to Atoll Upper":
             [["Hyperdash"]],
         "Overworld Belltower":
-            [["Hyperdash"], ["UR"]],
+            [["Hyperdash"], ["LS1"]],
         "Overworld Swamp Upper Entry":
-            [["Hyperdash"], ["UR"]],
+            [["Hyperdash"], ["LS1"]],
         "Overworld Swamp Lower Entry":
             [],
         "Overworld Special Shop Entry":
-            [["Hyperdash"], ["UR"]],
+            [["Hyperdash"], ["LS1"]],
         "Overworld Well Ladder":
             [],
         "Overworld Ruined Passage Door":
@@ -759,11 +786,11 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
         "Overworld after Envoy":
             [],
         "Overworld Quarry Entry":
-            [["NMG"]],
+            [["IG2"], ["LS1"]],
         "Overworld Tunnel Turret":
-            [["NMG"], ["Hyperdash"]],
+            [["IG1"], ["LS1"], ["Hyperdash"]],
         "Overworld Temple Door":
-            [["NMG"], ["Forest Belltower Upper", "Overworld Belltower"]],
+            [["IG2"], ["LS3"], ["Forest Belltower Upper", "Overworld Belltower"]],
         "Overworld Southeast Cross Door":
             [],
         "Overworld Fountain Cross Door":
@@ -773,25 +800,28 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
         "Overworld Spawn Portal":
             [],
         "Overworld Well to Furnace Rail":
-            [["UR"]], 
+            [["LS2"]],
         "Overworld Old House Door":
             [],
         "Cube Cave Entrance Region":
             [],
+        # drop a rudeling, icebolt or ice bomb
+        "Overworld to West Garden from Furnace":
+            [["IG3"]],
     },
     "East Overworld": {
         "Above Ruined Passage":
             [],
         "After Ruined Passage":
-            [["NMG"]],
-        "Overworld":
-            [],
+            [["IG1"], ["LS1"]],
+        # "Overworld":
+        #     [],
         "Overworld at Patrol Cave":
             [],
         "Overworld above Patrol Cave":
             [],
         "Overworld Special Shop Entry":
-            [["Hyperdash"], ["UR"]]
+            [["Hyperdash"], ["LS1"]]
     },
     "Overworld Special Shop Entry": {
         "East Overworld":
@@ -800,8 +830,8 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     "Overworld Belltower": {
         "Overworld Belltower at Bell":
             [],
-        "Overworld":
-            [],
+        # "Overworld":
+        #     [],
         "Overworld to West Garden Upper":
             [],
     },
@@ -809,19 +839,19 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
         "Overworld Belltower":
             [],
     },
-    "Overworld Swamp Upper Entry": {
-        "Overworld":
-            [],
-    },
-    "Overworld Swamp Lower Entry": {
-        "Overworld":
-            [],
-    },
+    # "Overworld Swamp Upper Entry": {
+    #     "Overworld":
+    #         [],
+    # },
+    # "Overworld Swamp Lower Entry": {
+    #     "Overworld":
+    #         [],
+    # },
     "Overworld Beach": {
-        "Overworld":
-            [],
+        # "Overworld":
+        #     [],
         "Overworld West Garden Laurels Entry":
-            [["Hyperdash"]],
+            [["Hyperdash"], ["LS1"]],
         "Overworld to Atoll Upper":
             [],
         "Overworld Tunnel Turret":
@@ -832,38 +862,37 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
             [["Hyperdash"]],
     },
     "Overworld to Atoll Upper": {
-        "Overworld":
-            [],
+        # "Overworld":
+        #     [],
         "Overworld Beach":
             [],
     },
     "Overworld Tunnel Turret": {
-        "Overworld":
-            [],
+        # "Overworld":
+        #     [],
         "Overworld Beach":
             [],
     },
     "Overworld Well Ladder": {
-        "Overworld":
-            [],
+        # "Overworld":
+        #     [],
     },
     "Overworld at Patrol Cave": {
         "East Overworld":
-            [["Hyperdash"]],
+            [["Hyperdash"], ["LS1"], ["IG1"]],
         "Overworld above Patrol Cave":
             [],
     },
     "Overworld above Patrol Cave": {
-        "Overworld":
-            [],
+        # "Overworld":
+        #     [],
         "East Overworld":
             [],
         "Upper Overworld":
             [],
         "Overworld at Patrol Cave":
             [],
-        "Overworld Belltower at Bell":
-            [["NMG"]],
+        # readd long dong if we ever do a misc tricks option
     },
     "Upper Overworld": {
         "Overworld above Patrol Cave":
@@ -878,51 +907,49 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
             [],
     },
     "Overworld above Quarry Entrance": {
-        "Overworld":
-            [],
+        # "Overworld":
+        #     [],
         "Upper Overworld":
             [],
     },
     "Overworld Quarry Entry": {
         "Overworld after Envoy":
             [],
-        "Overworld":
-            [["NMG"]],
+        # "Overworld":
+        #     [["IG1"]],
     },
     "Overworld after Envoy": {
-        "Overworld":
-            [],
+        # "Overworld":
+        #     [],
         "Overworld Quarry Entry":
             [],
     },
     "After Ruined Passage": {
-        "Overworld":
-            [],
+        # "Overworld":
+        #     [],
         "Above Ruined Passage":
             [],
-        "East Overworld":
-            [["NMG"]],
     },
     "Above Ruined Passage": {
-        "Overworld":
-            [],
+        # "Overworld":
+        #     [],
         "After Ruined Passage":
             [],
         "East Overworld":
             [],
     },
-    "Overworld Ruined Passage Door": {
-        "Overworld":
-            [["Hyperdash", "NMG"]],
-    },
-    "Overworld Town Portal": {
-        "Overworld":
-            [],
-    },
-    "Overworld Spawn Portal": {
-        "Overworld":
-            [],
-    },
+    # "Overworld Ruined Passage Door": {
+    #     "Overworld":
+    #         [["Hyperdash", "Zip"]],
+    # },
+    # "Overworld Town Portal": {
+    #     "Overworld":
+    #         [],
+    # },
+    # "Overworld Spawn Portal": {
+    #     "Overworld":
+    #         [],
+    # },
     "Cube Cave Entrance Region": {
         "Overworld":
             [],
@@ -933,7 +960,7 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "Old House Back": {
         "Old House Front":
-            [["Hyperdash", "NMG"]],
+            [["Hyperdash", "Zip"]],
     },
     "Furnace Fuse": {
         "Furnace Ladder Area":
@@ -941,9 +968,9 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "Furnace Ladder Area": {
         "Furnace Fuse":
-            [["Hyperdash"], ["UR"]],
+            [["Hyperdash"], ["LS1"]],
         "Furnace Walking Path":
-            [["Hyperdash"], ["UR"]],
+            [["Hyperdash"], ["LS1"]],
     },
     "Furnace Walking Path": {
         "Furnace Ladder Area":
@@ -971,7 +998,7 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "East Forest": {
         "East Forest Dance Fox Spot":
-            [["Hyperdash"], ["NMG"]],
+            [["Hyperdash"], ["IG1"], ["LS1"]],
         "East Forest Portal":
             [],
         "Lower Forest":
@@ -979,7 +1006,7 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "East Forest Dance Fox Spot": {
         "East Forest":
-            [["Hyperdash"], ["NMG"]],
+            [["Hyperdash"], ["IG1"]],
     },
     "East Forest Portal": {
         "East Forest":
@@ -995,7 +1022,7 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "Guard House 1 West": {
         "Guard House 1 East":
-            [["Hyperdash"], ["UR"]],
+            [["Hyperdash"], ["LS1"]],
     },
     "Guard House 2 Upper": {
         "Guard House 2 Lower":
@@ -1007,19 +1034,19 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "Forest Grave Path Main": {
         "Forest Grave Path Upper":
-            [["Hyperdash"], ["UR"]],
+            [["Hyperdash"], ["LS2"], ["IG3"]],
         "Forest Grave Path by Grave":
             [],
     },
     "Forest Grave Path Upper": {
         "Forest Grave Path Main":
-            [["Hyperdash"], ["NMG"]],
+            [["Hyperdash"], ["IG1"]],
     },
     "Forest Grave Path by Grave": {
         "Forest Hero's Grave":
             [], 
         "Forest Grave Path Main":
-            [["NMG"]],
+            [["IG1"]],
     },
     "Forest Hero's Grave": {
         "Forest Grave Path by Grave":
@@ -1051,7 +1078,7 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "Dark Tomb Checkpoint": {
         "Well Boss":
-            [["Hyperdash", "NMG"]],
+            [["Hyperdash", "Zip"]],
     },
     "Dark Tomb Entry Point": {
         "Dark Tomb Upper":
@@ -1075,13 +1102,13 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "West Garden": {
         "West Garden Laurels Exit Region":
-            [["Hyperdash"], ["UR"]],
+            [["Hyperdash"], ["LS1"]],
         "West Garden after Boss":
             [], 
         "West Garden Hero's Grave Region":
             [],
         "West Garden Portal Item":
-            [["NMG"]],
+            [["IG2"]],
     },
     "West Garden Laurels Exit Region": {
         "West Garden":
@@ -1093,13 +1120,19 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "West Garden Portal Item": {
         "West Garden":
-            [["NMG"]], 
-        "West Garden Portal":
-            [["Hyperdash", "West Garden"]],
+            [["IG1"]],
+        "West Garden by Portal":
+            [["Hyperdash"]],
     },
-    "West Garden Portal": {
+    "West Garden by Portal": {
         "West Garden Portal Item":
             [["Hyperdash"]],
+        "West Garden Portal":
+            [["West Garden"]],
+    },
+    "West Garden Portal": {
+        "West Garden by Portal":
+            [],
     },
     "West Garden Hero's Grave Region": {
         "West Garden":
@@ -1107,7 +1140,7 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "Ruined Atoll": {
         "Ruined Atoll Lower Entry Area":
-            [["Hyperdash"], ["UR"]],
+            [["Hyperdash"], ["LS1"]],
         "Ruined Atoll Ladder Tops":
             [],
         "Ruined Atoll Frog Mouth":
@@ -1174,11 +1207,17 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
             [],
     },
     "Library Exterior Ladder Region": {
+        "Library Exterior by Tree":
+            [],
+    },
+    "Library Exterior by Tree": {
         "Library Exterior Tree Region":
             [],
+        "Library Exterior Ladder Region":
+            [],
     },
     "Library Exterior Tree Region": {
-        "Library Exterior Ladder Region":
+        "Library Exterior by Tree":
             [],
     },
     "Library Hall Bookshelf": {
@@ -1223,15 +1262,21 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     "Library Lab": {
         "Library Lab Lower":
             [["Hyperdash"]],
-        "Library Portal":
+        "Library Lab on Portal Pad":
             [],
         "Library Lab to Librarian":
             [],
     },
-    "Library Portal": {
+    "Library Lab on Portal Pad": {
+        "Library Portal":
+            [],
         "Library Lab":
             [],
     },
+    "Library Portal": {
+        "Library Lab on Portal Pad":
+            [],
+    },
     "Library Lab to Librarian": {
         "Library Lab":
             [],
@@ -1240,11 +1285,9 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
         "Fortress Exterior from Overworld":
             [], 
         "Fortress Courtyard Upper":
-            [["UR"]], 
-        "Fortress Exterior near cave":
-            [["UR"]],
+            [["LS2"]],
         "Fortress Courtyard":
-            [["UR"]],
+            [["LS1"]],
     },
     "Fortress Exterior from Overworld": {
         "Fortress Exterior from East Forest":
@@ -1252,15 +1295,15 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
         "Fortress Exterior near cave":
             [], 
         "Fortress Courtyard":
-            [["Hyperdash"], ["NMG"]],
+            [["Hyperdash"], ["IG1"], ["LS1"]],
     },
     "Fortress Exterior near cave": {
         "Fortress Exterior from Overworld":
-            [["Hyperdash"], ["UR"]], 
-        "Fortress Courtyard":
-            [["UR"]], 
+            [["Hyperdash"], ["LS1"]],
+        "Fortress Courtyard":  # ice grapple hard: shoot far fire pot, it aggros one of the enemies over to you
+            [["IG3"], ["LS1"]],
         "Fortress Courtyard Upper":
-            [["UR"]],
+            [["LS2"]],
         "Beneath the Vault Entry":
             [],
     },
@@ -1270,7 +1313,7 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "Fortress Courtyard": {
         "Fortress Courtyard Upper":
-            [["NMG"]],
+            [["IG1"]],
         "Fortress Exterior from Overworld":
             [["Hyperdash"]],
     },
@@ -1296,7 +1339,7 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "Fortress East Shortcut Lower": {
         "Fortress East Shortcut Upper":
-            [["NMG"]],
+            [["IG1"]],
     },
     "Fortress East Shortcut Upper": {
         "Fortress East Shortcut Lower":
@@ -1304,11 +1347,11 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "Eastern Vault Fortress": {
         "Eastern Vault Fortress Gold Door":
-            [["NMG"], ["Fortress Exterior from Overworld", "Beneath the Vault Back", "Fortress Courtyard Upper"]],
+            [["IG2"], ["Fortress Exterior from Overworld", "Beneath the Vault Back", "Fortress Courtyard Upper"]],
     },
     "Eastern Vault Fortress Gold Door": {
         "Eastern Vault Fortress":
-            [["NMG"]],
+            [["IG1"]],
     },
     "Fortress Grave Path": {
         "Fortress Hero's Grave Region":
@@ -1318,7 +1361,7 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "Fortress Grave Path Upper": {
         "Fortress Grave Path":
-            [["NMG"]],
+            [["IG1"]],
     },
     "Fortress Grave Path Dusty Entrance Region": {
         "Fortress Grave Path":
@@ -1346,7 +1389,7 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "Monastery Back": {
         "Monastery Front":
-            [["Hyperdash", "NMG"]], 
+            [["Hyperdash", "Zip"]],
         "Monastery Hero's Grave Region":
             [],
     },
@@ -1363,6 +1406,8 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
             [["Quarry Connector"]],
         "Quarry":
             [],
+        "Monastery Rope":
+            [["LS2"]],
     },
     "Quarry Portal": {
         "Quarry Entry":
@@ -1374,7 +1419,7 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
         "Quarry Back":
             [["Hyperdash"]],
         "Monastery Rope":
-            [["UR"]],
+            [["LS2"]],
     },
     "Quarry Back": {
         "Quarry":
@@ -1392,7 +1437,7 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
         "Quarry Monastery Entry":
             [],
         "Lower Quarry Zig Door":
-            [["NMG"]],
+            [["IG3"]],
     },
     "Lower Quarry": {
         "Even Lower Quarry":
@@ -1402,7 +1447,7 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
         "Lower Quarry":
             [],
         "Lower Quarry Zig Door":
-            [["Quarry", "Quarry Connector"], ["NMG"]],
+            [["Quarry", "Quarry Connector"], ["IG3"]],
     },
     "Monastery Rope": {
         "Quarry Back":
@@ -1430,7 +1475,7 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "Rooted Ziggurat Lower Back": {
         "Rooted Ziggurat Lower Front":
-            [["Hyperdash"], ["UR"]],
+            [["Hyperdash"], ["LS2"], ["IG1"]],
         "Rooted Ziggurat Portal Room Entrance":
             [],
     },
@@ -1443,26 +1488,35 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
             [],
     },
     "Rooted Ziggurat Portal Room Exit": {
-        "Rooted Ziggurat Portal":
+        "Rooted Ziggurat Portal Room":
             [],
     },
-    "Rooted Ziggurat Portal": {
+    "Rooted Ziggurat Portal Room": {
+        "Rooted Ziggurat Portal":
+            [],
         "Rooted Ziggurat Portal Room Exit":
             [["Rooted Ziggurat Lower Back"]],
     },
+    "Rooted Ziggurat Portal": {
+        "Rooted Ziggurat Portal Room":
+            [],
+    },
     "Swamp Front": {
         "Swamp Mid":
             [],
+        # get one pillar from the gate, then dash onto the gate, very tricky
+        "Back of Swamp Laurels Area":
+            [["Hyperdash", "Zip"]],
     },
     "Swamp Mid": {
         "Swamp Front":
             [],
         "Swamp to Cathedral Main Entrance Region":
-            [["Hyperdash"], ["NMG"]],
+            [["Hyperdash"], ["IG2"], ["LS3"]],
         "Swamp Ledge under Cathedral Door":
             [],
         "Back of Swamp":
-            [["UR"]],
+            [["LS1"]],  # ig3 later?
     },
     "Swamp Ledge under Cathedral Door": {
         "Swamp Mid":
@@ -1476,24 +1530,41 @@ traversal_requirements: Dict[str, Dict[str, List[List[str]]]] = {
     },
     "Swamp to Cathedral Main Entrance Region": {
         "Swamp Mid":
-            [["NMG"]],
+            [["IG1"]],
     },
     "Back of Swamp": {
         "Back of Swamp Laurels Area":
-            [["Hyperdash"], ["UR"]],
+            [["Hyperdash"], ["LS2"]],
         "Swamp Hero's Grave Region":
             [],
+        "Swamp Mid":
+            [["LS2"]],
+        "Swamp Front":
+            [["LS1"]],
+        "Swamp to Cathedral Main Entrance Region":
+            [["LS3"]],
+        "Swamp to Cathedral Treasure Room":
+            [["LS3"]]
     },
     "Back of Swamp Laurels Area": {
         "Back of Swamp":
             [["Hyperdash"]],
+        # get one pillar from the gate, then dash onto the gate, very tricky
         "Swamp Mid":
-            [["NMG", "Hyperdash"]],
+            [["IG1", "Hyperdash"], ["Hyperdash", "Zip"]],
     },
     "Swamp Hero's Grave Region": {
         "Back of Swamp":
             [],
     },
+    "Cathedral": {
+        "Cathedral to Gauntlet":
+            [],
+    },
+    "Cathedral to Gauntlet": {
+        "Cathedral":
+            [],
+    },
     "Cathedral Gauntlet Checkpoint": {
         "Cathedral Gauntlet":
             [],

worlds/tunic/er_scripts.py

@@ -1,7 +1,7 @@
-from typing import Dict, List, Set, TYPE_CHECKING
+from typing import Dict, List, Set, Tuple, TYPE_CHECKING
 from BaseClasses import Region, ItemClassification, Item, Location
 from .locations import location_table
-from .er_data import Portal, tunic_er_regions, portal_mapping, traversal_requirements, DeadEnd
+from .er_data import Portal, portal_mapping, traversal_requirements, DeadEnd, RegionInfo
 from .er_rules import set_er_region_rules
 from Options import PlandoConnection
 from .options import EntranceRando
@@ -22,17 +22,18 @@ class TunicERLocation(Location):
 
 def create_er_regions(world: "TunicWorld") -> Dict[Portal, Portal]:
     regions: Dict[str, Region] = {}
+    for region_name, region_data in world.er_regions.items():
+        regions[region_name] = Region(region_name, world.player, world.multiworld)
+
     if world.options.entrance_rando:
-        portal_pairs = pair_portals(world)
+        portal_pairs = pair_portals(world, regions)
+
         # output the entrances to the spoiler log here for convenience
         sorted_portal_pairs = sort_portals(portal_pairs)
         for portal1, portal2 in sorted_portal_pairs.items():
             world.multiworld.spoiler.set_entrance(portal1, portal2, "both", world.player)
     else:
-        portal_pairs = vanilla_portals()
-
-    for region_name, region_data in tunic_er_regions.items():
-        regions[region_name] = Region(region_name, world.player, world.multiworld)
+        portal_pairs = vanilla_portals(world, regions)
 
     set_er_region_rules(world, regions, portal_pairs)
 
@@ -93,7 +94,18 @@ def place_event_items(world: "TunicWorld", regions: Dict[str, Region]) -> None:
         region.locations.append(location)
 
 
-def vanilla_portals() -> Dict[Portal, Portal]:
+# all shops are the same shop. however, you cannot get to all shops from the same shop entrance.
+# so, we need a bunch of shop regions that connect to the actual shop, but the actual shop cannot connect back
+def create_shop_region(world: "TunicWorld", regions: Dict[str, Region]) -> None:
+    new_shop_name = f"Shop {world.shop_num}"
+    world.er_regions[new_shop_name] = RegionInfo("Shop", dead_end=DeadEnd.all_cats)
+    new_shop_region = Region(new_shop_name, world.player, world.multiworld)
+    new_shop_region.connect(regions["Shop"])
+    regions[new_shop_name] = new_shop_region
+    world.shop_num += 1
+
+
+def vanilla_portals(world: "TunicWorld", regions: Dict[str, Region]) -> Dict[Portal, Portal]:
     portal_pairs: Dict[Portal, Portal] = {}
     # we don't want the zig skip exit for vanilla portals, since it shouldn't be considered for logic here
     portal_map = [portal for portal in portal_mapping if portal.name != "Ziggurat Lower Falling Entrance"]
@@ -105,8 +117,9 @@ def vanilla_portals() -> Dict[Portal, Portal]:
         portal2_sdt = portal1.destination_scene()
 
         if portal2_sdt.startswith("Shop,"):
-            portal2 = Portal(name="Shop", region="Shop",
+            portal2 = Portal(name=f"Shop Portal {world.shop_num}", region=f"Shop {world.shop_num}",
                              destination="Previous Region", tag="_")
+            create_shop_region(world, regions)
 
         elif portal2_sdt == "Purgatory, Purgatory_bottom":
             portal2_sdt = "Purgatory, Purgatory_top"
@@ -125,14 +138,15 @@ def vanilla_portals() -> Dict[Portal, Portal]:
 
 
 # pairing off portals, starting with dead ends
-def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
-    # separate the portals into dead ends and non-dead ends
+def pair_portals(world: "TunicWorld", regions: Dict[str, Region]) -> Dict[Portal, Portal]:
     portal_pairs: Dict[Portal, Portal] = {}
     dead_ends: List[Portal] = []
     two_plus: List[Portal] = []
     player_name = world.player_name
     portal_map = portal_mapping.copy()
-    logic_rules = world.options.logic_rules.value
+    laurels_zips = world.options.laurels_zips.value
+    ice_grappling = world.options.ice_grappling.value
+    ladder_storage = world.options.ladder_storage.value
     fixed_shop = world.options.fixed_shop
     laurels_location = world.options.laurels_location
     traversal_reqs = deepcopy(traversal_requirements)
@@ -142,19 +156,21 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
     # if it's not one of the EntranceRando options, it's a custom seed
     if world.options.entrance_rando.value not in EntranceRando.options.values():
         seed_group = world.seed_groups[world.options.entrance_rando.value]
-        logic_rules = seed_group["logic_rules"]
+        laurels_zips = seed_group["laurels_zips"]
+        ice_grappling = seed_group["ice_grappling"]
+        ladder_storage = seed_group["ladder_storage"]
         fixed_shop = seed_group["fixed_shop"]
         laurels_location = "10_fairies" if seed_group["laurels_at_10_fairies"] is True else False
 
+    logic_tricks: Tuple[bool, int, int] = (laurels_zips, ice_grappling, ladder_storage)
+
     # marking that you don't immediately have laurels
     if laurels_location == "10_fairies" and not hasattr(world.multiworld, "re_gen_passthrough"):
         has_laurels = False
 
-    shop_scenes: Set[str] = set()
     shop_count = 6
     if fixed_shop:
         shop_count = 0
-        shop_scenes.add("Overworld Redux")
     else:
         # if fixed shop is off, remove this portal
         for portal in portal_map:
@@ -169,13 +185,13 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
 
     # create separate lists for dead ends and non-dead ends
     for portal in portal_map:
-        dead_end_status = tunic_er_regions[portal.region].dead_end
+        dead_end_status = world.er_regions[portal.region].dead_end
         if dead_end_status == DeadEnd.free:
             two_plus.append(portal)
         elif dead_end_status == DeadEnd.all_cats:
             dead_ends.append(portal)
         elif dead_end_status == DeadEnd.restricted:
-            if logic_rules:
+            if ice_grappling:
                 two_plus.append(portal)
             else:
                 dead_ends.append(portal)
@@ -196,7 +212,7 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
     # make better start region stuff when/if implementing random start
     start_region = "Overworld"
     connected_regions.add(start_region)
-    connected_regions = update_reachable_regions(connected_regions, traversal_reqs, has_laurels, logic_rules)
+    connected_regions = update_reachable_regions(connected_regions, traversal_reqs, has_laurels, logic_tricks)
 
     if world.options.entrance_rando.value in EntranceRando.options.values():
         plando_connections = world.options.plando_connections.value
@@ -225,12 +241,14 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
                 plando_connections.append(PlandoConnection(portal_name1, portal_name2, "both"))
 
     non_dead_end_regions = set()
-    for region_name, region_info in tunic_er_regions.items():
+    for region_name, region_info in world.er_regions.items():
         if not region_info.dead_end:
             non_dead_end_regions.add(region_name)
-        elif region_info.dead_end == 2 and logic_rules:
+        # if ice grappling to places is in logic, both places stop being dead ends
+        elif region_info.dead_end == DeadEnd.restricted and ice_grappling:
             non_dead_end_regions.add(region_name)
-        elif region_info.dead_end == 3:
+        # secret gathering place and zig skip get weird, special handling
+        elif region_info.dead_end == DeadEnd.special:
             if (region_name == "Secret Gathering Place" and laurels_location == "10_fairies") \
                     or (region_name == "Zig Skip Exit" and fixed_shop):
                 non_dead_end_regions.add(region_name)
@@ -239,6 +257,9 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
         for connection in plando_connections:
             p_entrance = connection.entrance
             p_exit = connection.exit
+            # if you plando secret gathering place, need to know that during portal pairing
+            if "Secret Gathering Place Exit" in [p_entrance, p_exit]:
+                waterfall_plando = True
             portal1_dead_end = True
             portal2_dead_end = True
 
@@ -285,16 +306,13 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
                         break
                 # if it's not a dead end, it might be a shop
                 if p_exit == "Shop Portal":
-                    portal2 = Portal(name="Shop Portal", region="Shop",
+                    portal2 = Portal(name=f"Shop Portal {world.shop_num}", region=f"Shop {world.shop_num}",
                                      destination="Previous Region", tag="_")
+                    create_shop_region(world, regions)
                     shop_count -= 1
                     # need to maintain an even number of portals total
                     if shop_count < 0:
                         shop_count += 2
-                    for p in portal_mapping:
-                        if p.name == p_entrance:
-                            shop_scenes.add(p.scene())
-                            break
                 # and if it's neither shop nor dead end, it just isn't correct
                 else:
                     if not portal2:
@@ -327,11 +345,10 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
                     else:
                         raise Exception(f"{player_name} paired a dead end to a dead end in their "
                                         "plando connections.")
-                waterfall_plando = True
             portal_pairs[portal1] = portal2
 
         # if we have plando connections, our connected regions may change somewhat
-        connected_regions = update_reachable_regions(connected_regions, traversal_reqs, has_laurels, logic_rules)
+        connected_regions = update_reachable_regions(connected_regions, traversal_reqs, has_laurels, logic_tricks)
 
     if fixed_shop and not hasattr(world.multiworld, "re_gen_passthrough"):
         portal1 = None
@@ -343,7 +360,9 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
             raise Exception(f"Failed to do Fixed Shop option. "
                             f"Did {player_name} plando connection the Windmill Shop entrance?")
 
-        portal2 = Portal(name="Shop Portal", region="Shop", destination="Previous Region", tag="_")
+        portal2 = Portal(name=f"Shop Portal {world.shop_num}", region=f"Shop {world.shop_num}",
+                         destination="Previous Region", tag="_")
+        create_shop_region(world, regions)
 
         portal_pairs[portal1] = portal2
         two_plus.remove(portal1)
@@ -393,7 +412,7 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
                         if waterfall_plando:
                             cr = connected_regions.copy()
                             cr.add(portal.region)
-                            if "Secret Gathering Place" not in update_reachable_regions(cr, traversal_reqs, has_laurels, logic_rules):
+                            if "Secret Gathering Place" not in update_reachable_regions(cr, traversal_reqs, has_laurels, logic_tricks):
                                 continue
                         elif portal.region != "Secret Gathering Place":
                             continue
@@ -405,9 +424,9 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
 
         # once we have both portals, connect them and add the new region(s) to connected_regions
         if check_success == 2:
-            connected_regions = update_reachable_regions(connected_regions, traversal_reqs, has_laurels, logic_rules)
             if "Secret Gathering Place" in connected_regions:
                 has_laurels = True
+            connected_regions = update_reachable_regions(connected_regions, traversal_reqs, has_laurels, logic_tricks)
             portal_pairs[portal1] = portal2
             check_success = 0
             random_object.shuffle(two_plus)
@@ -418,16 +437,12 @@ def pair_portals(world: "TunicWorld") -> Dict[Portal, Portal]:
             shop_count = 0
     
     for i in range(shop_count):
-        portal1 = None
-        for portal in two_plus:
-            if portal.scene() not in shop_scenes:
-                shop_scenes.add(portal.scene())
-                portal1 = portal
-                two_plus.remove(portal)
-                break
+        portal1 = two_plus.pop()
         if portal1 is None:
-            raise Exception("Too many shops in the pool, or something else went wrong.")
-        portal2 = Portal(name="Shop Portal", region="Shop", destination="Previous Region", tag="_")
+            raise Exception("TUNIC: Too many shops in the pool, or something else went wrong.")
+        portal2 = Portal(name=f"Shop Portal {world.shop_num}", region=f"Shop {world.shop_num}",
+                         destination="Previous Region", tag="_")
+        create_shop_region(world, regions)
         
         portal_pairs[portal1] = portal2
 
@@ -460,13 +475,12 @@ def create_randomized_entrances(portal_pairs: Dict[Portal, Portal], regions: Dic
         region1 = regions[portal1.region]
         region2 = regions[portal2.region]
         region1.connect(connecting_region=region2, name=portal1.name)
-        # prevent the logic from thinking you can get to any shop-connected region from the shop
-        if portal2.name not in {"Shop", "Shop Portal"}:
-            region2.connect(connecting_region=region1, name=portal2.name)
+        region2.connect(connecting_region=region1, name=portal2.name)
 
 
 def update_reachable_regions(connected_regions: Set[str], traversal_reqs: Dict[str, Dict[str, List[List[str]]]],
-                             has_laurels: bool, logic: int) -> Set[str]:
+                             has_laurels: bool, logic: Tuple[bool, int, int]) -> Set[str]:
+    zips, ice_grapples, ls = logic
     # starting count, so we can run it again if this changes
     region_count = len(connected_regions)
     for origin, destinations in traversal_reqs.items():
@@ -485,11 +499,15 @@ def update_reachable_regions(connected_regions: Set[str], traversal_reqs: Dict[s
                     if req == "Hyperdash":
                         if not has_laurels:
                             break
-                    elif req == "NMG":
-                        if not logic:
+                    elif req == "Zip":
+                        if not zips:
                             break
-                    elif req == "UR":
-                        if logic < 2:
+                    # if req is higher than logic option, then it breaks since it's not a valid connection
+                    elif req.startswith("IG"):
+                        if int(req[-1]) > ice_grapples:
+                            break
+                    elif req.startswith("LS"):
+                        if int(req[-1]) > ls:
                             break
                     elif req not in connected_regions:
                         break

worlds/tunic/items.py

@@ -166,6 +166,7 @@ item_table: Dict[str, TunicItemData] = {
     "Ladders in Swamp": TunicItemData(ItemClassification.progression, 0, 150, "Ladders"),
 }
 
+# items to be replaced by fool traps
 fool_tiers: List[List[str]] = [
     [],
     ["Money x1", "Money x10", "Money x15", "Money x16"],
@@ -173,6 +174,7 @@ fool_tiers: List[List[str]] = [
     ["Money x1", "Money x10", "Money x15", "Money x16", "Money x20", "Money x25", "Money x30"],
 ]
 
+# items we'll want the location of in slot data, for generating in-game hints
 slot_data_item_names = [
     "Stick",
     "Sword",

worlds/tunic/ladder_storage_data.py

@@ -0,0 +1,186 @@
+from typing import Dict, List, Set, NamedTuple, Optional
+
+
+# ladders in overworld, since it is the most complex area for ladder storage
+class OWLadderInfo(NamedTuple):
+    ladders: Set[str]  # ladders where the top or bottom is at the same elevation
+    portals: List[str]  # portals at the same elevation, only those without doors
+    regions: List[str]  # regions where a melee enemy can hit you out of ladder storage
+
+
+# groups for ladders at the same elevation, for use in determing whether you can ls to entrances in diff rulesets
+ow_ladder_groups: Dict[str, OWLadderInfo] = {
+    # lowest elevation
+    "LS Elev 0": OWLadderInfo({"Ladders in Overworld Town", "Ladder to Ruined Atoll", "Ladder to Swamp"},
+                              ["Swamp Redux 2_conduit", "Overworld Cave_", "Atoll Redux_lower", "Maze Room_",
+                              "Town Basement_beach", "Archipelagos Redux_lower", "Archipelagos Redux_lowest"],
+                              ["Overworld Beach"]),
+    # also the east filigree room
+    "LS Elev 1": OWLadderInfo({"Ladders near Weathervane", "Ladders in Overworld Town", "Ladder to Swamp"},
+                              ["Furnace_gyro_lower", "Swamp Redux 2_wall"],
+                              ["Overworld Tunnel Turret"]),
+    # also the fountain filigree room and ruined passage door
+    "LS Elev 2": OWLadderInfo({"Ladders near Weathervane", "Ladders to West Bell"},
+                              ["Archipelagos Redux_upper", "Ruins Passage_east"],
+                              ["After Ruined Passage"]),
+    # also old house door
+    "LS Elev 3": OWLadderInfo({"Ladders near Weathervane", "Ladder to Quarry", "Ladders to West Bell",
+                               "Ladders in Overworld Town"},
+                              [],
+                              ["Overworld after Envoy", "East Overworld"]),
+    # skip top of top ladder next to weathervane level, does not provide logical access to anything
+    "LS Elev 4": OWLadderInfo({"Ladders near Dark Tomb", "Ladder to Quarry", "Ladders to West Bell", "Ladders in Well",
+                               "Ladders in Overworld Town"},
+                              ["Darkwoods Tunnel_"],
+                              []),
+    "LS Elev 5": OWLadderInfo({"Ladders near Overworld Checkpoint", "Ladders near Patrol Cave"},
+                              ["PatrolCave_", "Forest Belltower_", "Fortress Courtyard_", "ShopSpecial_"],
+                              ["East Overworld"]),
+    # skip top of belltower, middle of dark tomb ladders, and top of checkpoint, does not grant access to anything
+    "LS Elev 6": OWLadderInfo({"Ladders near Patrol Cave", "Ladder near Temple Rafters"},
+                              ["Temple_rafters"],
+                              ["Overworld above Patrol Cave"]),
+    # in-line with the chest above dark tomb, gets you up the mountain stairs
+    "LS Elev 7": OWLadderInfo({"Ladders near Patrol Cave", "Ladder near Temple Rafters", "Ladders near Dark Tomb"},
+                              ["Mountain_"],
+                              ["Upper Overworld"]),
+}
+
+
+# ladders accessible within different regions of overworld, only those that are relevant
+# other scenes will just have them hardcoded since this type of structure is not necessary there
+region_ladders: Dict[str, Set[str]] = {
+    "Overworld": {"Ladders near Weathervane", "Ladders near Overworld Checkpoint", "Ladders near Dark Tomb",
+                  "Ladders in Overworld Town", "Ladder to Swamp", "Ladders in Well"},
+    "Overworld Beach": {"Ladder to Ruined Atoll"},
+    "Overworld at Patrol Cave": {"Ladders near Patrol Cave"},
+    "Overworld Quarry Entry": {"Ladder to Quarry"},
+    "Overworld Belltower": {"Ladders to West Bell"},
+    "Overworld after Temple Rafters": {"Ladders near Temple Rafters"},
+}
+
+
+class LadderInfo(NamedTuple):
+    origin: str  # origin region
+    destination: str  # destination portal
+    ladders_req: Optional[str] = None  # ladders required to do this
+    dest_is_region: bool = False  # whether it is a region that you are going to
+
+
+easy_ls: List[LadderInfo] = [
+    # In the furnace
+    # Furnace ladder to the fuse entrance
+    LadderInfo("Furnace Ladder Area", "Furnace, Overworld Redux_gyro_upper_north"),
+    # Furnace ladder to Dark Tomb
+    LadderInfo("Furnace Ladder Area", "Furnace, Crypt Redux_"),
+    # Furnace ladder to the West Garden connector
+    LadderInfo("Furnace Ladder Area", "Furnace, Overworld Redux_gyro_west"),
+
+    # West Garden
+    # exit after Garden Knight
+    LadderInfo("West Garden", "Archipelagos Redux, Overworld Redux_upper"),
+    # West Garden laurels exit
+    LadderInfo("West Garden", "Archipelagos Redux, Overworld Redux_lowest"),
+
+    # Atoll, use the little ladder you fix at the beginning
+    LadderInfo("Ruined Atoll", "Atoll Redux, Overworld Redux_lower"),
+    LadderInfo("Ruined Atoll", "Atoll Redux, Frog Stairs_mouth"),  # special case
+
+    # East Forest
+    # Entrance by the dancing fox holy cross spot
+    LadderInfo("East Forest", "East Forest Redux, East Forest Redux Laddercave_upper"),
+
+    # From the west side of Guard House 1 to the east side
+    LadderInfo("Guard House 1 West", "East Forest Redux Laddercave, East Forest Redux_gate"),
+    LadderInfo("Guard House 1 West", "East Forest Redux Laddercave, Forest Boss Room_"),
+
+    # Fortress Exterior
+    # shop, ls at the ladder by the telescope
+    LadderInfo("Fortress Exterior from Overworld", "Fortress Courtyard, Shop_"),
+    # Fortress main entry and grave path lower entry, ls at the ladder by the telescope
+    LadderInfo("Fortress Exterior from Overworld", "Fortress Courtyard, Fortress Main_Big Door"),
+    LadderInfo("Fortress Exterior from Overworld", "Fortress Courtyard, Fortress Reliquary_Lower"),
+    # Use the top of the ladder by the telescope
+    LadderInfo("Fortress Exterior from Overworld", "Fortress Courtyard, Fortress Reliquary_Upper"),
+    LadderInfo("Fortress Exterior from Overworld", "Fortress Courtyard, Fortress East_"),
+
+    # same as above, except from the east side of the area
+    LadderInfo("Fortress Exterior from East Forest", "Fortress Courtyard, Overworld Redux_"),
+    LadderInfo("Fortress Exterior from East Forest", "Fortress Courtyard, Shop_"),
+    LadderInfo("Fortress Exterior from East Forest", "Fortress Courtyard, Fortress Main_Big Door"),
+    LadderInfo("Fortress Exterior from East Forest", "Fortress Courtyard, Fortress Reliquary_Lower"),
+
+    # same as above, except from the Beneath the Vault entrance ladder
+    LadderInfo("Fortress Exterior near cave", "Fortress Courtyard, Overworld Redux_", "Ladder to Beneath the Vault"),
+    LadderInfo("Fortress Exterior near cave", "Fortress Courtyard, Fortress Main_Big Door",
+               "Ladder to Beneath the Vault"),
+    LadderInfo("Fortress Exterior near cave", "Fortress Courtyard, Fortress Reliquary_Lower",
+               "Ladder to Beneath the Vault"),
+
+    # Swamp to Gauntlet
+    LadderInfo("Swamp Mid", "Swamp Redux 2, Cathedral Arena_", "Ladders in Swamp"),
+
+    # Ladder by the hero grave
+    LadderInfo("Back of Swamp", "Swamp Redux 2, Overworld Redux_conduit"),
+    LadderInfo("Back of Swamp", "Swamp Redux 2, Shop_"),
+]
+
+# if we can gain elevation or get knocked down, add the harder ones
+medium_ls: List[LadderInfo] = [
+    # region-destination versions of easy ls spots
+    LadderInfo("East Forest", "East Forest Dance Fox Spot", dest_is_region=True),
+    # fortress courtyard knockdowns are never logically relevant, the fuse requires upper
+    LadderInfo("Back of Swamp", "Swamp Mid", dest_is_region=True),
+    LadderInfo("Back of Swamp", "Swamp Front", dest_is_region=True),
+
+    # gain height off the northeast fuse ramp
+    LadderInfo("Ruined Atoll", "Atoll Redux, Frog Stairs_eye"),
+
+    # Upper exit from the Forest Grave Path, use LS at the ladder by the gate switch
+    LadderInfo("Forest Grave Path Main", "Sword Access, East Forest Redux_upper"),
+
+    # Upper exits from the courtyard. Use the ramp in the courtyard, then the blocks north of the first fuse
+    LadderInfo("Fortress Exterior from Overworld", "Fortress Courtyard Upper", dest_is_region=True),
+    LadderInfo("Fortress Exterior from East Forest", "Fortress Courtyard, Fortress Reliquary_Upper"),
+    LadderInfo("Fortress Exterior from East Forest", "Fortress Courtyard, Fortress East_"),
+    LadderInfo("Fortress Exterior from East Forest", "Fortress Courtyard Upper", dest_is_region=True),
+    LadderInfo("Fortress Exterior near cave", "Fortress Courtyard, Fortress Reliquary_Upper",
+               "Ladder to Beneath the Vault"),
+    LadderInfo("Fortress Exterior near cave", "Fortress Courtyard, Fortress East_", "Ladder to Beneath the Vault"),
+    LadderInfo("Fortress Exterior near cave", "Fortress Courtyard Upper", "Ladder to Beneath the Vault",
+               dest_is_region=True),
+
+    # need to gain height to get up the stairs
+    LadderInfo("Lower Mountain", "Mountain, Mountaintop_"),
+
+    # Where the rope is behind Monastery
+    LadderInfo("Quarry Entry", "Quarry Redux, Monastery_back"),
+    LadderInfo("Quarry Monastery Entry", "Quarry Redux, Monastery_back"),
+    LadderInfo("Quarry Back", "Quarry Redux, Monastery_back"),
+
+    LadderInfo("Rooted Ziggurat Lower Back", "ziggurat2020_3, ziggurat2020_2_"),
+    LadderInfo("Rooted Ziggurat Lower Back", "Rooted Ziggurat Lower Front", dest_is_region=True),
+
+    # Swamp to Overworld upper
+    LadderInfo("Swamp Mid", "Swamp Redux 2, Overworld Redux_wall", "Ladders in Swamp"),
+    LadderInfo("Back of Swamp", "Swamp Redux 2, Overworld Redux_wall"),
+]
+
+hard_ls: List[LadderInfo] = [
+    # lower ladder, go into the waterfall then above the bonfire, up a ramp, then through the right wall
+    LadderInfo("Beneath the Well Front", "Sewer, Sewer_Boss_", "Ladders in Well"),
+    LadderInfo("Beneath the Well Front", "Sewer, Overworld Redux_west_aqueduct", "Ladders in Well"),
+    LadderInfo("Beneath the Well Front", "Beneath the Well Back", "Ladders in Well", dest_is_region=True),
+    # go through the hexagon engraving above the vault door
+    LadderInfo("Frog's Domain", "frog cave main, Frog Stairs_Exit", "Ladders to Frog's Domain"),
+    # the turret at the end here is not affected by enemy rando
+    LadderInfo("Frog's Domain", "Frog's Domain Back", "Ladders to Frog's Domain", dest_is_region=True),
+    # todo: see if we can use that new laurels strat here
+    # LadderInfo("Rooted Ziggurat Lower Back", "ziggurat2020_3, ziggurat2020_FTRoom_"),
+    # go behind the cathedral to reach the door, pretty easily doable
+    LadderInfo("Swamp Mid", "Swamp Redux 2, Cathedral Redux_main", "Ladders in Swamp"),
+    LadderInfo("Back of Swamp", "Swamp Redux 2, Cathedral Redux_main"),
+    # need to do hc midair, probably cannot get into this without hc
+    LadderInfo("Swamp Mid", "Swamp Redux 2, Cathedral Redux_secret", "Ladders in Swamp"),
+    LadderInfo("Back of Swamp", "Swamp Redux 2, Cathedral Redux_secret"),
+]

worlds/tunic/locations.py

@@ -47,7 +47,7 @@ location_table: Dict[str, TunicLocationData] = {
     "Guardhouse 1 - Upper Floor": TunicLocationData("East Forest", "Guard House 1 East"),
     "East Forest - Dancing Fox Spirit Holy Cross": TunicLocationData("East Forest", "East Forest Dance Fox Spot", location_group="Holy Cross"),
     "East Forest - Golden Obelisk Holy Cross": TunicLocationData("East Forest", "Lower Forest", location_group="Holy Cross"),
-    "East Forest - Ice Rod Grapple Chest": TunicLocationData("East Forest", "East Forest"),
+    "East Forest - Ice Rod Grapple Chest": TunicLocationData("East Forest", "Lower Forest"),
     "East Forest - Above Save Point": TunicLocationData("East Forest", "East Forest"),
     "East Forest - Above Save Point Obscured": TunicLocationData("East Forest", "East Forest"),
     "East Forest - From Guardhouse 1 Chest": TunicLocationData("East Forest", "East Forest Dance Fox Spot"),
@@ -205,7 +205,7 @@ location_table: Dict[str, TunicLocationData] = {
     "Fountain Cross Door - Page Pickup": TunicLocationData("Overworld Holy Cross", "Fountain Cross Room", location_group="Holy Cross"),
     "Secret Gathering Place - Holy Cross Chest": TunicLocationData("Overworld Holy Cross", "Secret Gathering Place", location_group="Holy Cross"),
     "Top of the Mountain - Page At The Peak": TunicLocationData("Overworld Holy Cross", "Top of the Mountain", location_group="Holy Cross"),
-    "Monastery - Monastery Chest": TunicLocationData("Quarry", "Monastery Back"),
+    "Monastery - Monastery Chest": TunicLocationData("Monastery", "Monastery Back"),
     "Quarry - [Back Entrance] Bushes Holy Cross": TunicLocationData("Quarry Back", "Quarry Back", location_group="Holy Cross"),
     "Quarry - [Back Entrance] Chest": TunicLocationData("Quarry Back", "Quarry Back"),
     "Quarry - [Central] Near Shortcut Ladder": TunicLocationData("Quarry Back", "Quarry Back"),
@@ -224,7 +224,7 @@ location_table: Dict[str, TunicLocationData] = {
     "Quarry - [Central] Above Ladder Dash Chest": TunicLocationData("Quarry", "Quarry Monastery Entry"),
     "Quarry - [West] Upper Area Bombable Wall": TunicLocationData("Quarry Back", "Quarry Back"),
     "Quarry - [East] Bombable Wall": TunicLocationData("Quarry", "Quarry"),
-    "Hero's Grave - Ash Relic": TunicLocationData("Quarry", "Hero Relic - Quarry"),
+    "Hero's Grave - Ash Relic": TunicLocationData("Monastery", "Hero Relic - Quarry"),
     "Quarry - [West] Shooting Range Secret Path": TunicLocationData("Lower Quarry", "Lower Quarry"),
     "Quarry - [West] Near Shooting Range": TunicLocationData("Lower Quarry", "Lower Quarry"),
     "Quarry - [West] Below Shooting Range": TunicLocationData("Lower Quarry", "Lower Quarry"),

worlds/tunic/options.py

@@ -1,7 +1,7 @@
 from dataclasses import dataclass
 from typing import Dict, Any
 from Options import (DefaultOnToggle, Toggle, StartInventoryPool, Choice, Range, TextChoice, PlandoConnections,
-                     PerGameCommonOptions, OptionGroup)
+                     PerGameCommonOptions, OptionGroup, Visibility)
 from .er_data import portal_mapping
 
 
@@ -39,27 +39,6 @@ class AbilityShuffling(Toggle):
     display_name = "Shuffle Abilities"
 
 
-class LogicRules(Choice):
-    """
-    Set which logic rules to use for your world.
-    Restricted: Standard logic, no glitches.
-    No Major Glitches: Sneaky Laurels zips, ice grapples through doors, shooting the west bell, and boss quick kills are included in logic.
-    * Ice grappling through the Ziggurat door is not in logic since you will get stuck in there without Prayer.
-    Unrestricted: Logic in No Major Glitches, as well as ladder storage to get to certain places early.
-    * Torch is given to the player at the start of the game due to the high softlock potential with various tricks. Using the torch is not required in logic.
-    * Using Ladder Storage to get to individual chests is not in logic to avoid tedium.
-    * Getting knocked out of the air by enemies during Ladder Storage to reach places is not in logic, except for in Rooted Ziggurat Lower. This is so you're not punished for playing with enemy rando on.
-    """
-    internal_name = "logic_rules"
-    display_name = "Logic Rules"
-    option_restricted = 0
-    option_no_major_glitches = 1
-    alias_nmg = 1
-    option_unrestricted = 2
-    alias_ur = 2
-    default = 0
-
-
 class Lanternless(Toggle):
     """
     Choose whether you require the Lantern for dark areas.
@@ -173,8 +152,8 @@ class ShuffleLadders(Toggle):
     """
     internal_name = "shuffle_ladders"
     display_name = "Shuffle Ladders"
-    
-    
+
+
 class TunicPlandoConnections(PlandoConnections):
     """
     Generic connection plando. Format is:
@@ -189,6 +168,82 @@ class TunicPlandoConnections(PlandoConnections):
     duplicate_exits = True
 
 
+class LaurelsZips(Toggle):
+    """
+    Choose whether to include using the Hero's Laurels to zip through gates, doors, and tricky spots.
+    Notable inclusions are the Monastery gate, Ruined Passage door, Old House gate, Forest Grave Path gate, and getting from the Back of Swamp to the Middle of Swamp.
+    """
+    internal_name = "laurels_zips"
+    display_name = "Laurels Zips Logic"
+
+
+class IceGrappling(Choice):
+    """
+    Choose whether grappling frozen enemies is in logic.
+    Easy includes ice grappling enemies that are in range without luring them. May include clips through terrain.
+    Medium includes using ice grapples to push enemies through doors or off ledges without luring them. Also includes bringing an enemy over to the Temple Door to grapple through it.
+    Hard includes luring or grappling enemies to get to where you want to go.
+    The Medium and Hard options will give the player the Torch to return to the Overworld checkpoint to avoid softlocks. Using the Torch is considered in logic.
+    Note: You will still be expected to ice grapple to the slime in East Forest from below with this option off.
+    """
+    internal_name = "ice_grappling"
+    display_name = "Ice Grapple Logic"
+    option_off = 0
+    option_easy = 1
+    option_medium = 2
+    option_hard = 3
+    default = 0
+
+
+class LadderStorage(Choice):
+    """
+    Choose whether Ladder Storage is in logic.
+    Easy includes uses of Ladder Storage to get to open doors over a long distance without too much difficulty. May include convenient elevation changes (going up Mountain stairs, stairs in front of Special Shop, etc.).
+    Medium includes the above as well as changing your elevation using the environment and getting knocked down by melee enemies mid-LS.
+    Hard includes the above as well as going behind the map to enter closed doors from behind, shooting a fuse with the magic wand to knock yourself down at close range, and getting into the Cathedral Secret Legend room mid-LS.
+    Enabling any of these difficulty options will give the player the Torch item to return to the Overworld checkpoint to avoid softlocks. Using the Torch is considered in logic.
+    Opening individual chests while doing ladder storage is excluded due to tedium.
+    Knocking yourself out of LS with a bomb is excluded due to the problematic nature of consumables in logic.
+    """
+    internal_name = "ladder_storage"
+    display_name = "Ladder Storage Logic"
+    option_off = 0
+    option_easy = 1
+    option_medium = 2
+    option_hard = 3
+    default = 0
+
+
+class LadderStorageWithoutItems(Toggle):
+    """
+    If disabled, you logically require Stick, Sword, or Magic Orb to perform Ladder Storage.
+    If enabled, you will be expected to perform Ladder Storage without progression items.
+    This can be done with the plushie code, a Golden Coin, Prayer, and many other options.
+
+    This option has no effect if you do not have Ladder Storage Logic enabled.
+    """
+    internal_name = "ladder_storage_without_items"
+    display_name = "Ladder Storage without Items"
+
+
+class LogicRules(Choice):
+    """
+    This option has been superseded by the individual trick options.
+    If set to nmg, it will set Ice Grappling to medium and Laurels Zips on.
+    If set to ur, it will do nmg as well as set Ladder Storage to medium.
+    It is here to avoid breaking old yamls, and will be removed at a later date.
+    """
+    visibility = Visibility.none
+    internal_name = "logic_rules"
+    display_name = "Logic Rules"
+    option_restricted = 0
+    option_no_major_glitches = 1
+    alias_nmg = 1
+    option_unrestricted = 2
+    alias_ur = 2
+    default = 0
+
+
 @dataclass
 class TunicOptions(PerGameCommonOptions):
     start_inventory_from_pool: StartInventoryPool
@@ -199,22 +254,30 @@ class TunicOptions(PerGameCommonOptions):
     shuffle_ladders: ShuffleLadders
     entrance_rando: EntranceRando
     fixed_shop: FixedShop
-    logic_rules: LogicRules
     fool_traps: FoolTraps
     hexagon_quest: HexagonQuest
     hexagon_goal: HexagonGoal
     extra_hexagon_percentage: ExtraHexagonPercentage
+    laurels_location: LaurelsLocation
     lanternless: Lanternless
     maskless: Maskless
-    laurels_location: LaurelsLocation
+    laurels_zips: LaurelsZips
+    ice_grappling: IceGrappling
+    ladder_storage: LadderStorage
+    ladder_storage_without_items: LadderStorageWithoutItems
     plando_connections: TunicPlandoConnections
+
+    logic_rules: LogicRules
       
 
 tunic_option_groups = [
     OptionGroup("Logic Options", [
-        LogicRules,
         Lanternless,
         Maskless,
+        LaurelsZips,
+        IceGrappling,
+        LadderStorage,
+        LadderStorageWithoutItems
     ])
 ]
 
@@ -231,9 +294,12 @@ tunic_option_presets: Dict[str, Dict[str, Any]] = {
     "Glace Mode": {
         "accessibility": "minimal",
         "ability_shuffling": True,
-        "entrance_rando": "yes",
+        "entrance_rando": True,
         "fool_traps": "onslaught",
-        "logic_rules": "unrestricted",
+        "laurels_zips": True,
+        "ice_grappling": "hard",
+        "ladder_storage": "hard",
+        "ladder_storage_without_items": True,
         "maskless": True,
         "lanternless": True,
     },

worlds/tunic/regions.py

@@ -16,7 +16,8 @@ tunic_regions: Dict[str, Set[str]] = {
     "Eastern Vault Fortress": {"Beneath the Vault"},
     "Beneath the Vault": {"Eastern Vault Fortress"},
     "Quarry Back": {"Quarry"},
-    "Quarry": {"Lower Quarry"},
+    "Quarry": {"Monastery", "Lower Quarry"},
+    "Monastery": set(),
     "Lower Quarry": {"Rooted Ziggurat"},
     "Rooted Ziggurat": set(),
     "Swamp": {"Cathedral"},

worlds/tunic/rules.py

@@ -3,7 +3,7 @@ from typing import Dict, TYPE_CHECKING
 
 from worlds.generic.Rules import set_rule, forbid_item, add_rule
 from BaseClasses import CollectionState
-from .options import TunicOptions
+from .options import TunicOptions, LadderStorage, IceGrappling
 if TYPE_CHECKING:
     from . import TunicWorld
 
@@ -27,10 +27,10 @@ green_hexagon = "Green Questagon"
 blue_hexagon = "Blue Questagon"
 gold_hexagon = "Gold Questagon"
 
+# "Quarry - [East] Bombable Wall" is excluded from this list since it has slightly different rules
 bomb_walls = ["East Forest - Bombable Wall", "Eastern Vault Fortress - [East Wing] Bombable Wall",
               "Overworld - [Central] Bombable Wall", "Overworld - [Southwest] Bombable Wall Near Fountain",
-              "Quarry - [West] Upper Area Bombable Wall", "Quarry - [East] Bombable Wall",
-              "Ruined Atoll - [Northwest] Bombable Wall"]
+              "Quarry - [West] Upper Area Bombable Wall", "Ruined Atoll - [Northwest] Bombable Wall"]
 
 
 def randomize_ability_unlocks(random: Random, options: TunicOptions) -> Dict[str, int]:
@@ -64,32 +64,33 @@ def has_sword(state: CollectionState, player: int) -> bool:
     return state.has("Sword", player) or state.has("Sword Upgrade", player, 2)
 
 
-def has_ice_grapple_logic(long_range: bool, state: CollectionState, world: "TunicWorld") -> bool:
-    player = world.player
-    if not world.options.logic_rules:
+def laurels_zip(state: CollectionState, world: "TunicWorld") -> bool:
+    return world.options.laurels_zips and state.has(laurels, world.player)
+
+
+def has_ice_grapple_logic(long_range: bool, difficulty: IceGrappling, state: CollectionState, world: "TunicWorld") -> bool:
+    if world.options.ice_grappling < difficulty:
         return False
     if not long_range:
-        return state.has_all({ice_dagger, grapple}, player)
+        return state.has_all({ice_dagger, grapple}, world.player)
     else:
-        return state.has_all({ice_dagger, fire_wand, grapple}, player) and has_ability(icebolt, state, world)
+        return state.has_all({ice_dagger, fire_wand, grapple}, world.player) and has_ability(icebolt, state, world)
 
 
 def can_ladder_storage(state: CollectionState, world: "TunicWorld") -> bool:
-    return world.options.logic_rules == "unrestricted" and has_stick(state, world.player)
+    if not world.options.ladder_storage:
+        return False
+    if world.options.ladder_storage_without_items:
+        return True
+    return has_stick(state, world.player) or state.has(grapple, world.player)
 
 
 def has_mask(state: CollectionState, world: "TunicWorld") -> bool:
-    if world.options.maskless:
-        return True
-    else:
-        return state.has(mask, world.player)
+    return world.options.maskless or state.has(mask, world.player)
 
 
 def has_lantern(state: CollectionState, world: "TunicWorld") -> bool:
-    if world.options.lanternless:
-        return True
-    else:
-        return state.has(lantern, world.player)
+    return world.options.lanternless or state.has(lantern, world.player)
 
 
 def set_region_rules(world: "TunicWorld") -> None:
@@ -102,12 +103,14 @@ def set_region_rules(world: "TunicWorld") -> None:
         lambda state: has_stick(state, player) or state.has(fire_wand, player)
     world.get_entrance("Overworld -> Dark Tomb").access_rule = \
         lambda state: has_lantern(state, world)
+    # laurels in, ladder storage in through the furnace, or ice grapple down the belltower
     world.get_entrance("Overworld -> West Garden").access_rule = \
-        lambda state: state.has(laurels, player) \
-        or can_ladder_storage(state, world)
+        lambda state: (state.has(laurels, player)
+                       or can_ladder_storage(state, world)
+                       or has_ice_grapple_logic(False, IceGrappling.option_hard, state, world))
     world.get_entrance("Overworld -> Eastern Vault Fortress").access_rule = \
         lambda state: state.has(laurels, player) \
-        or has_ice_grapple_logic(True, state, world) \
+        or has_ice_grapple_logic(True, IceGrappling.option_easy, state, world) \
         or can_ladder_storage(state, world)
     # using laurels or ls to get in is covered by the -> Eastern Vault Fortress rules
     world.get_entrance("Overworld -> Beneath the Vault").access_rule = \
@@ -124,8 +127,8 @@ def set_region_rules(world: "TunicWorld") -> None:
     world.get_entrance("Lower Quarry -> Rooted Ziggurat").access_rule = \
         lambda state: state.has(grapple, player) and has_ability(prayer, state, world)
     world.get_entrance("Swamp -> Cathedral").access_rule = \
-        lambda state: state.has(laurels, player) and has_ability(prayer, state, world) \
-        or has_ice_grapple_logic(False, state, world)
+        lambda state: (state.has(laurels, player) and has_ability(prayer, state, world)) \
+        or has_ice_grapple_logic(False, IceGrappling.option_medium, state, world)
     world.get_entrance("Overworld -> Spirit Arena").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)
@@ -133,10 +136,18 @@ def set_region_rules(world: "TunicWorld") -> None:
                        and has_ability(prayer, state, world) and has_sword(state, player)
                        and state.has_any({lantern, laurels}, player))
 
+    world.get_region("Quarry").connect(world.get_region("Rooted Ziggurat"),
+                                       rule=lambda state: has_ice_grapple_logic(True, IceGrappling.option_hard, state, world)
+                                       and has_ability(prayer, state, world))
+
+    if options.ladder_storage >= LadderStorage.option_medium:
+        # ls at any ladder in a safe spot in quarry to get to the monastery rope entrance
+        world.get_region("Quarry Back").connect(world.get_region("Monastery"),
+                                                rule=lambda state: can_ladder_storage(state, world))
+
 
 def set_location_rules(world: "TunicWorld") -> None:
     player = world.player
-    options = world.options
 
     forbid_item(world.get_location("Secret Gathering Place - 20 Fairy Reward"), fairies, player)
 
@@ -147,11 +158,13 @@ def set_location_rules(world: "TunicWorld") -> None:
              lambda state: has_ability(prayer, state, world)
              or state.has(laurels, player)
              or can_ladder_storage(state, world)
-             or (has_ice_grapple_logic(True, state, world) and has_lantern(state, world)))
+             or (has_ice_grapple_logic(True, IceGrappling.option_easy, state, world)
+                 and has_lantern(state, world)))
     set_rule(world.get_location("Fortress Courtyard - Page Near Cave"),
              lambda state: has_ability(prayer, state, world) or state.has(laurels, player)
              or can_ladder_storage(state, world)
-             or (has_ice_grapple_logic(True, state, world) and has_lantern(state, world)))
+             or (has_ice_grapple_logic(True, IceGrappling.option_easy, state, world)
+                 and has_lantern(state, world)))
     set_rule(world.get_location("East Forest - Dancing Fox Spirit Holy Cross"),
              lambda state: has_ability(holy_cross, state, world))
     set_rule(world.get_location("Forest Grave Path - Holy Cross Code by Grave"),
@@ -186,17 +199,17 @@ def set_location_rules(world: "TunicWorld") -> None:
              lambda state: state.has(laurels, player))
     set_rule(world.get_location("Old House - Normal Chest"),
              lambda state: state.has(house_key, player)
-             or has_ice_grapple_logic(False, state, world)
-             or (state.has(laurels, player) and options.logic_rules))
+             or has_ice_grapple_logic(False, IceGrappling.option_medium, state, world)
+             or laurels_zip(state, world))
     set_rule(world.get_location("Old House - Holy Cross Chest"),
              lambda state: has_ability(holy_cross, state, world) and (
                      state.has(house_key, player)
-                     or has_ice_grapple_logic(False, state, world)
-                     or (state.has(laurels, player) and options.logic_rules)))
+                     or has_ice_grapple_logic(False, IceGrappling.option_medium, state, world)
+                     or laurels_zip(state, world)))
     set_rule(world.get_location("Old House - Shield Pickup"),
              lambda state: state.has(house_key, player)
-             or has_ice_grapple_logic(False, state, world)
-             or (state.has(laurels, player) and options.logic_rules))
+             or has_ice_grapple_logic(False, IceGrappling.option_medium, state, world)
+             or laurels_zip(state, world))
     set_rule(world.get_location("Overworld - [Northwest] Page on Pillar by Dark Tomb"),
              lambda state: state.has(laurels, player))
     set_rule(world.get_location("Overworld - [Southwest] From West Garden"),
@@ -206,7 +219,7 @@ def set_location_rules(world: "TunicWorld") -> None:
              or (has_lantern(state, world) and has_sword(state, player))
              or can_ladder_storage(state, world))
     set_rule(world.get_location("Overworld - [Northwest] Chest Beneath Quarry Gate"),
-             lambda state: state.has_any({grapple, laurels}, player) or options.logic_rules)
+             lambda state: state.has_any({grapple, laurels}, player))
     set_rule(world.get_location("Overworld - [East] Grapple Chest"),
              lambda state: state.has(grapple, player))
     set_rule(world.get_location("Special Shop - Secret Page Pickup"),
@@ -215,11 +228,11 @@ def set_location_rules(world: "TunicWorld") -> None:
              lambda state: has_ability(holy_cross, state, world)
              and (state.has(laurels, player) or (has_lantern(state, world) and (has_sword(state, player)
                                                                                 or state.has(fire_wand, player)))
-                  or has_ice_grapple_logic(False, state, world)))
+                  or has_ice_grapple_logic(False, IceGrappling.option_medium, state, world)))
     set_rule(world.get_location("Sealed Temple - Page Pickup"),
              lambda state: state.has(laurels, player)
              or (has_lantern(state, world) and (has_sword(state, player) or state.has(fire_wand, player)))
-             or has_ice_grapple_logic(False, state, world))
+             or has_ice_grapple_logic(False, IceGrappling.option_medium, state, world))
     set_rule(world.get_location("West Furnace - Lantern Pickup"),
              lambda state: has_stick(state, player) or state.has_any({fire_wand, laurels}, player))
 
@@ -254,7 +267,7 @@ def set_location_rules(world: "TunicWorld") -> None:
              lambda state: state.has(laurels, player) and has_ability(holy_cross, state, world))
     set_rule(world.get_location("West Garden - [East Lowlands] Page Behind Ice Dagger House"),
              lambda state: (state.has(laurels, player) and has_ability(prayer, state, world))
-             or has_ice_grapple_logic(True, state, world))
+             or has_ice_grapple_logic(True, IceGrappling.option_easy, state, world))
     set_rule(world.get_location("West Garden - [Central Lowlands] Below Left Walkway"),
              lambda state: state.has(laurels, player))
     set_rule(world.get_location("West Garden - [Central Highlands] After Garden Knight"),
@@ -265,12 +278,15 @@ def set_location_rules(world: "TunicWorld") -> None:
     # Ruined Atoll
     set_rule(world.get_location("Ruined Atoll - [West] Near Kevin Block"),
              lambda state: state.has(laurels, player))
+    # ice grapple push a crab through the door
     set_rule(world.get_location("Ruined Atoll - [East] Locked Room Lower Chest"),
-             lambda state: state.has(laurels, player) or state.has(key, player, 2))
+             lambda state: state.has(laurels, player) or state.has(key, player, 2)
+             or has_ice_grapple_logic(False, IceGrappling.option_medium, state, world))
     set_rule(world.get_location("Ruined Atoll - [East] Locked Room Upper Chest"),
-             lambda state: state.has(laurels, player) or state.has(key, player, 2))
+             lambda state: state.has(laurels, player) or state.has(key, player, 2)
+             or has_ice_grapple_logic(False, IceGrappling.option_medium, state, world))
     set_rule(world.get_location("Librarian - Hexagon Green"),
-             lambda state: has_sword(state, player) or options.logic_rules)
+             lambda state: has_sword(state, player))
 
     # Frog's Domain
     set_rule(world.get_location("Frog's Domain - Side Room Grapple Secret"),
@@ -285,10 +301,12 @@ def set_location_rules(world: "TunicWorld") -> None:
              lambda state: state.has(laurels, player))
     set_rule(world.get_location("Fortress Arena - Siege Engine/Vault Key Pickup"),
              lambda state: has_sword(state, player)
-             and (has_ability(prayer, state, world) or has_ice_grapple_logic(False, state, world)))
+             and (has_ability(prayer, state, world)
+                  or has_ice_grapple_logic(False, IceGrappling.option_medium, state, world)))
     set_rule(world.get_location("Fortress Arena - Hexagon Red"),
              lambda state: state.has(vault_key, player)
-             and (has_ability(prayer, state, world) or has_ice_grapple_logic(False, state, world)))
+             and (has_ability(prayer, state, world)
+                  or has_ice_grapple_logic(False, IceGrappling.option_medium, state, world)))
 
     # Beneath the Vault
     set_rule(world.get_location("Beneath the Fortress - Bridge"),
@@ -301,14 +319,14 @@ def set_location_rules(world: "TunicWorld") -> None:
              lambda state: state.has(laurels, player))
     set_rule(world.get_location("Rooted Ziggurat Upper - Near Bridge Switch"),
              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(world.get_location("Rooted Ziggurat Lower - Hexagon Blue"),
-             lambda state: has_sword(state, player) or (state.has(grapple, player) and options.logic_rules))
+             lambda state: has_sword(state, player))
 
     # Swamp
     set_rule(world.get_location("Cathedral Gauntlet - Gauntlet Reward"),
              lambda state: (state.has(fire_wand, player) and has_sword(state, player))
-             and (state.has(laurels, player) or has_ice_grapple_logic(False, state, world)))
+             and (state.has(laurels, player) 
+                  or has_ice_grapple_logic(False, IceGrappling.option_medium, state, world)))
     set_rule(world.get_location("Swamp - [Entrance] Above Entryway"),
              lambda state: state.has(laurels, player))
     set_rule(world.get_location("Swamp - [South Graveyard] Upper Walkway Dash Chest"),
@@ -335,8 +353,16 @@ def set_location_rules(world: "TunicWorld") -> None:
     # Bombable Walls
     for location_name in bomb_walls:
         # has_sword is there because you can buy bombs in the shop
-        set_rule(world.get_location(location_name), lambda state: state.has(gun, player) or has_sword(state, player))
+        set_rule(world.get_location(location_name),
+                 lambda state: state.has(gun, player)
+                 or has_sword(state, player)
+                 or has_ice_grapple_logic(False, IceGrappling.option_hard, state, world))
     add_rule(world.get_location("Cube Cave - Holy Cross Chest"),
+             lambda state: state.has(gun, player)
+             or has_sword(state, player)
+             or has_ice_grapple_logic(False, IceGrappling.option_hard, state, world))
+    # can't ice grapple to this one, not enough space
+    set_rule(world.get_location("Quarry - [East] Bombable Wall"),
              lambda state: state.has(gun, player) or has_sword(state, player))
 
     # Shop

worlds/tunic/test/test_access.py

@@ -68,3 +68,57 @@ class TestER(TunicTestBase):
         self.assertFalse(self.can_reach_location("Overworld - [Southwest] Flowers Holy Cross"))
         self.collect_by_name(["Pages 42-43 (Holy Cross)"])
         self.assertTrue(self.can_reach_location("Overworld - [Southwest] Flowers Holy Cross"))
+
+
+class TestERSpecial(TunicTestBase):
+    options = {options.EntranceRando.internal_name: options.EntranceRando.option_yes,
+               options.AbilityShuffling.internal_name: options.AbilityShuffling.option_true,
+               options.HexagonQuest.internal_name: options.HexagonQuest.option_false,
+               options.FixedShop.internal_name: options.FixedShop.option_false,
+               options.IceGrappling.internal_name: options.IceGrappling.option_easy,
+               "plando_connections": [
+                   {
+                       "entrance": "Stick House Entrance",
+                       "exit": "Ziggurat Portal Room Entrance"
+                   },
+                   {
+                       "entrance": "Ziggurat Lower to Ziggurat Tower",
+                       "exit": "Secret Gathering Place Exit"
+                   }
+               ]}
+    # with these plando connections, you need to ice grapple from the back of lower zig to the front to get laurels
+
+
+# ensure that ladder storage connections connect to the outlet region, not the portal's region
+class TestLadderStorage(TunicTestBase):
+    options = {options.EntranceRando.internal_name: options.EntranceRando.option_yes,
+               options.AbilityShuffling.internal_name: options.AbilityShuffling.option_true,
+               options.HexagonQuest.internal_name: options.HexagonQuest.option_false,
+               options.FixedShop.internal_name: options.FixedShop.option_false,
+               options.LadderStorage.internal_name: options.LadderStorage.option_hard,
+               options.LadderStorageWithoutItems.internal_name: options.LadderStorageWithoutItems.option_false,
+               "plando_connections": [
+                   {
+                       "entrance": "Fortress Courtyard Shop",
+                       # "exit": "Ziggurat Portal Room Exit"
+                       "exit": "Spawn to Far Shore"
+                   },
+                   {
+                       "entrance": "Fortress Courtyard to Beneath the Vault",
+                       "exit": "Stick House Exit"
+                   },
+                   {
+                       "entrance": "Stick House Entrance",
+                       "exit": "Fortress Courtyard to Overworld"
+                   },
+                   {
+                       "entrance": "Old House Waterfall Entrance",
+                       "exit": "Ziggurat Portal Room Entrance"
+                   },
+               ]}
+
+    def test_ls_to_shop_entrance(self) -> None:
+        self.collect_by_name(["Magic Orb"])
+        self.assertFalse(self.can_reach_location("Fortress Courtyard - Page Near Cave"))
+        self.collect_by_name(["Pages 24-25 (Prayer)"])
+        self.assertTrue(self.can_reach_location("Fortress Courtyard - Page Near Cave"))

worlds/witness/__init__.py

@@ -61,7 +61,7 @@ class WitnessWorld(World):
     item_name_groups = static_witness_items.ITEM_GROUPS
     location_name_groups = static_witness_locations.AREA_LOCATION_GROUPS
 
-    required_client_version = (0, 4, 5)
+    required_client_version = (0, 5, 1)
 
     player_logic: WitnessPlayerLogic
     player_locations: WitnessPlayerLocations

worlds/witness/hints.py

@@ -220,7 +220,7 @@ def try_getting_location_group_for_location(world: "WitnessWorld", hint_loc: Loc
 def word_direct_hint(world: "WitnessWorld", hint: WitnessLocationHint) -> WitnessWordedHint:
     location_name = hint.location.name
     if hint.location.player != world.player:
-        location_name += " (" + world.player_name + ")"
+        location_name += " (" + world.multiworld.get_player_name(hint.location.player) + ")"
 
     item = hint.location.item
 
@@ -229,7 +229,7 @@ def word_direct_hint(world: "WitnessWorld", hint: WitnessLocationHint) -> Witnes
         item_name = item.name
 
         if item.player != world.player:
-            item_name += " (" + world.player_name + ")"
+            item_name += " (" + world.multiworld.get_player_name(item.player) + ")"
 
     hint_text = ""
     area: Optional[str] = None

worlds/yachtdice/__init__.py

@@ -466,6 +466,9 @@ class YachtDiceWorld(World):
         menu.exits.append(connection)
         connection.connect(board)
         self.multiworld.regions += [menu, board]
+        
+    def get_filler_item_name(self) -> str:
+        return "Good RNG"
 
     def set_rules(self):
         """