Muse Dash: Update song list to Rotaeno Update/7th Anniversary (#5066)

* Revert "Core: Take Counter back out of RestrictedUnpickler #5169"

This reverts commit 95e09c8e2a.

* Update Utils.py

.github/workflows/build.yml

@@ -98,7 +98,7 @@ jobs:
         shell: bash
         run: |
           cd build/exe*
-          cp Players/Templates/Clique.yaml Players/
+          cp Players/Templates/VVVVVV.yaml Players/
           timeout 30 ./ArchipelagoGenerate
       - name: Store 7z
         uses: actions/upload-artifact@v4
@@ -189,7 +189,7 @@ jobs:
         shell: bash
         run: |
           cd build/exe*
-          cp Players/Templates/Clique.yaml Players/
+          cp Players/Templates/VVVVVV.yaml Players/
           timeout 30 ./ArchipelagoGenerate
       - name: Store AppImage
         uses: actions/upload-artifact@v4

.github/workflows/label-pull-requests.yml

@@ -6,6 +6,8 @@ on:
 permissions:
   contents: read
   pull-requests: write
+env:
+  GH_REPO: ${{ github.repository }}
 
 jobs:
   labeler:

.gitignore

@@ -56,7 +56,6 @@ success.txt
 output/
 Output Logs/
 /factorio/
-/Minecraft Forge Server/
 /WebHostLib/static/generated
 /freeze_requirements.txt
 /Archipelago.zip
@@ -184,12 +183,6 @@ _speedups.c
 _speedups.cpp
 _speedups.html
 
-# minecraft server stuff
-jdk*/
-minecraft*/
-minecraft_versions.json
-!worlds/minecraft/
-
 # pyenv
 .python-version
 

AdventureClient.py

@@ -11,6 +11,7 @@ from typing import List
 
 
 import Utils
+from settings import get_settings
 from NetUtils import ClientStatus
 from Utils import async_start
 from CommonClient import CommonContext, server_loop, gui_enabled, ClientCommandProcessor, logger, \
@@ -80,8 +81,8 @@ class AdventureContext(CommonContext):
         self.local_item_locations = {}
         self.dragon_speed_info = {}
 
-        options = Utils.get_settings()
-        self.display_msgs = options["adventure_options"]["display_msgs"]
+        options = get_settings().adventure_options
+        self.display_msgs = options.display_msgs
 
     async def server_auth(self, password_requested: bool = False):
         if password_requested and not self.password:
@@ -102,7 +103,7 @@ class AdventureContext(CommonContext):
     def on_package(self, cmd: str, args: dict):
         if cmd == 'Connected':
             self.locations_array = None
-            if Utils.get_settings()["adventure_options"].get("death_link", False):
+            if get_settings().adventure_options.as_dict().get("death_link", False):
                 self.set_deathlink = True
             async_start(self.get_freeincarnates_used())
         elif cmd == "RoomInfo":
@@ -415,8 +416,9 @@ async def atari_sync_task(ctx: AdventureContext):
 
 
 async def run_game(romfile):
-    auto_start = Utils.get_settings()["adventure_options"].get("rom_start", True)
-    rom_args = Utils.get_settings()["adventure_options"].get("rom_args")
+    options = get_settings().adventure_options
+    auto_start = options.rom_start
+    rom_args = options.rom_args
     if auto_start is True:
         import webbrowser
         webbrowser.open(romfile)

BaseClasses.py

@@ -1337,8 +1337,8 @@ class Region:
         Connects current region to regions in exit dictionary. Passed region names must exist first.
 
         :param exits: exits from the region. format is {"connecting_region": "exit_name"}. if a non dict is provided,
-        created entrances will be named "self.name -> connecting_region"
-        :param rules: rules for the exits from this region. format is {"connecting_region", rule}
+                      created entrances will be named "self.name -> connecting_region"
+        :param rules: rules for the exits from this region. format is {"connecting_region": rule}
         """
         if not isinstance(exits, Dict):
             exits = dict.fromkeys(exits)

Fill.py

@@ -890,7 +890,7 @@ def parse_planned_blocks(multiworld: MultiWorld) -> dict[int, list[PlandoItemBlo
                 worlds = set()
                 for listed_world in target_world:
                     if listed_world not in world_name_lookup:
-                        failed(f"Cannot place item to {target_world}'s world as that world does not exist.",
+                        failed(f"Cannot place item to {listed_world}'s world as that world does not exist.",
                                block.force)
                         continue
                     worlds.add(world_name_lookup[listed_world])
@@ -923,9 +923,9 @@ def parse_planned_blocks(multiworld: MultiWorld) -> dict[int, list[PlandoItemBlo
             if isinstance(locations, str):
                 locations = [locations]
 
-            locations_from_groups: list[str] = []
             resolved_locations: list[Location] = []
             for target_player in worlds:
+                locations_from_groups: list[str] = []
                 world_locations = multiworld.get_unfilled_locations(target_player)
                 for group in multiworld.worlds[target_player].location_name_groups:
                     if group in locations:
@@ -937,13 +937,16 @@ def parse_planned_blocks(multiworld: MultiWorld) -> dict[int, list[PlandoItemBlo
 
             count = block.count
             if not count:
-                count = len(new_block.items)
+                count = (min(len(new_block.items), len(new_block.resolved_locations))
+                         if new_block.resolved_locations else len(new_block.items))
             if isinstance(count, int):
                 count = {"min": count, "max": count}
             if "min" not in count:
                 count["min"] = 0
             if "max" not in count:
-                count["max"] = len(new_block.items)
+                count["max"] = (min(len(new_block.items), len(new_block.resolved_locations))
+                                if new_block.resolved_locations else len(new_block.items))
+
 
             new_block.count = count
             plando_blocks[player].append(new_block)

Launcher.py

@@ -11,6 +11,7 @@ Additional components can be added to worlds.LauncherComponents.components.
 import argparse
 import logging
 import multiprocessing
+import os
 import shlex
 import subprocess
 import sys
@@ -41,13 +42,17 @@ def open_host_yaml():
     if is_linux:
         exe = which('sensible-editor') or which('gedit') or \
               which('xdg-open') or which('gnome-open') or which('kde-open')
-        subprocess.Popen([exe, file])
     elif is_macos:
         exe = which("open")
-        subprocess.Popen([exe, file])
     else:
         webbrowser.open(file)
+        return
 
+    env = os.environ
+    if "LD_LIBRARY_PATH" in env:
+        env = env.copy()
+        del env["LD_LIBRARY_PATH"]  # exe is a system binary, so reset LD_LIBRARY_PATH
+    subprocess.Popen([exe, file], env=env)
 
 def open_patch():
     suffixes = []
@@ -92,7 +97,11 @@ def open_folder(folder_path):
         return
 
     if exe:
-        subprocess.Popen([exe, folder_path])
+        env = os.environ
+        if "LD_LIBRARY_PATH" in env:
+            env = env.copy()
+            del env["LD_LIBRARY_PATH"]  # exe is a system binary, so reset LD_LIBRARY_PATH
+        subprocess.Popen([exe, folder_path], env=env)
     else:
         logging.warning(f"No file browser available to open {folder_path}")
 
@@ -104,14 +113,21 @@ def update_settings():
 
 components.extend([
     # Functions
-    Component("Open host.yaml", func=open_host_yaml),
-    Component("Open Patch", func=open_patch),
-    Component("Generate Template Options", func=generate_yamls),
-    Component("Archipelago Website", func=lambda: webbrowser.open("https://archipelago.gg/")),
-    Component("Discord Server", icon="discord", func=lambda: webbrowser.open("https://discord.gg/8Z65BR2")),
+    Component("Open host.yaml", func=open_host_yaml,
+              description="Open the host.yaml file to change settings for generation, games, and more."),
+    Component("Open Patch", func=open_patch,
+              description="Open a patch file, downloaded from the room page or provided by the host."),
+    Component("Generate Template Options", func=generate_yamls,
+              description="Generate template YAMLs for currently installed games."),
+    Component("Archipelago Website", func=lambda: webbrowser.open("https://archipelago.gg/"),
+              description="Open archipelago.gg in your browser."),
+    Component("Discord Server", icon="discord", func=lambda: webbrowser.open("https://discord.gg/8Z65BR2"),
+              description="Join the Discord server to play public multiworlds, report issues, or just chat!"),
     Component("Unrated/18+ Discord Server", icon="discord",
-              func=lambda: webbrowser.open("https://discord.gg/fqvNCCRsu4")),
-    Component("Browse Files", func=browse_files),
+              func=lambda: webbrowser.open("https://discord.gg/fqvNCCRsu4"),
+              description="Find unrated and 18+ games in the After Dark Discord server."),
+    Component("Browse Files", func=browse_files,
+              description="Open the Archipelago installation folder in your file browser."),
 ])
 
 
@@ -180,7 +196,8 @@ def get_exe(component: str | Component) -> Sequence[str] | None:
 def launch(exe, in_terminal=False):
     if in_terminal:
         if is_windows:
-            subprocess.Popen(['start', *exe], shell=True)
+            # intentionally using a window title with a space so it gets quoted and treated as a title
+            subprocess.Popen(["start", "Running Archipelago", *exe], shell=True)
             return
         elif is_linux:
             terminal = which('x-terminal-emulator') or which('gnome-terminal') or which('xterm')

MMBN3Client.py

@@ -290,12 +290,9 @@ async def gba_sync_task(ctx: MMBN3Context):
 
 
 async def run_game(romfile):
-    options = Utils.get_options().get("mmbn3_options", None)
-    if options is None:
-        auto_start = True
-    else:
-        auto_start = options.get("rom_start", True)
-    if auto_start:
+    from worlds.mmbn3 import MMBN3World
+    auto_start = MMBN3World.settings.rom_start
+    if auto_start is True:
         import webbrowser
         webbrowser.open(romfile)
     elif os.path.isfile(auto_start):

Main.py

@@ -12,6 +12,7 @@ import worlds
 from BaseClasses import CollectionState, Item, Location, LocationProgressType, MultiWorld
 from Fill import FillError, balance_multiworld_progression, distribute_items_restrictive, flood_items, \
     parse_planned_blocks, distribute_planned_blocks, resolve_early_locations_for_planned
+from NetUtils import convert_to_base_types
 from Options import StartInventoryPool
 from Utils import __version__, output_path, version_tuple
 from settings import get_settings
@@ -334,6 +335,9 @@ def main(args, seed=None, baked_server_options: dict[str, object] | None = None)
                 }
                 AutoWorld.call_all(multiworld, "modify_multidata", multidata)
 
+                for key in ("slot_data", "er_hint_data"):
+                    multidata[key] = convert_to_base_types(multidata[key])
+
                 multidata = zlib.compress(pickle.dumps(multidata), 9)
 
                 with open(os.path.join(temp_dir, f'{outfilebase}.archipelago'), 'wb') as f:

MinecraftClient.py

@@ -1,347 +0,0 @@
-import argparse
-import json
-import os
-import sys
-import re
-import atexit
-import shutil
-from subprocess import Popen
-from shutil import copyfile
-from time import strftime
-import logging
-
-import requests
-
-import Utils
-from Utils import is_windows
-from settings import get_settings
-
-atexit.register(input, "Press enter to exit.")
-
-# 1 or more digits followed by m or g, then optional b
-max_heap_re = re.compile(r"^\d+[mMgG][bB]?$")
-
-
-def prompt_yes_no(prompt):
-    yes_inputs = {'yes', 'ye', 'y'}
-    no_inputs = {'no', 'n'}
-    while True:
-        choice = input(prompt + " [y/n] ").lower()
-        if choice in yes_inputs: 
-            return True
-        elif choice in no_inputs: 
-            return False
-        else:
-            print('Please respond with "y" or "n".')
-
-
-def find_ap_randomizer_jar(forge_dir):
-    """Create mods folder if needed; find AP randomizer jar; return None if not found."""
-    mods_dir = os.path.join(forge_dir, 'mods')
-    if os.path.isdir(mods_dir):
-        for entry in os.scandir(mods_dir):
-            if entry.name.startswith("aprandomizer") and entry.name.endswith(".jar"):
-                logging.info(f"Found AP randomizer mod: {entry.name}")
-                return entry.name
-        return None
-    else:
-        os.mkdir(mods_dir)
-        logging.info(f"Created mods folder in {forge_dir}")
-        return None
-
-
-def replace_apmc_files(forge_dir, apmc_file):
-    """Create APData folder if needed; clean .apmc files from APData; copy given .apmc into directory."""
-    if apmc_file is None:
-        return
-    apdata_dir = os.path.join(forge_dir, 'APData')
-    copy_apmc = True
-    if not os.path.isdir(apdata_dir):
-        os.mkdir(apdata_dir)
-        logging.info(f"Created APData folder in {forge_dir}")
-    for entry in os.scandir(apdata_dir):
-        if entry.name.endswith(".apmc") and entry.is_file():
-            if not os.path.samefile(apmc_file, entry.path):
-                os.remove(entry.path)
-                logging.info(f"Removed {entry.name} in {apdata_dir}")
-            else: # apmc already in apdata
-                copy_apmc = False
-    if copy_apmc:
-        copyfile(apmc_file, os.path.join(apdata_dir, os.path.basename(apmc_file)))
-        logging.info(f"Copied {os.path.basename(apmc_file)} to {apdata_dir}")
-
-
-def read_apmc_file(apmc_file):
-    from base64 import b64decode
-
-    with open(apmc_file, 'r') as f:
-        return json.loads(b64decode(f.read()))
-
-
-def update_mod(forge_dir, url: str):
-    """Check mod version, download new mod from GitHub releases page if needed. """
-    ap_randomizer = find_ap_randomizer_jar(forge_dir)
-    os.path.basename(url)
-    if ap_randomizer is not None:
-        logging.info(f"Your current mod is {ap_randomizer}.")
-    else:
-        logging.info(f"You do not have the AP randomizer mod installed.")
-
-    if ap_randomizer != os.path.basename(url):
-        logging.info(f"A new release of the Minecraft AP randomizer mod was found: "
-                     f"{os.path.basename(url)}")
-        if prompt_yes_no("Would you like to update?"):
-            old_ap_mod = os.path.join(forge_dir, 'mods', ap_randomizer) if ap_randomizer is not None else None
-            new_ap_mod = os.path.join(forge_dir, 'mods', os.path.basename(url))
-            logging.info("Downloading AP randomizer mod. This may take a moment...")
-            apmod_resp = requests.get(url)
-            if apmod_resp.status_code == 200:
-                with open(new_ap_mod, 'wb') as f:
-                    f.write(apmod_resp.content)
-                    logging.info(f"Wrote new mod file to {new_ap_mod}")
-                if old_ap_mod is not None:
-                    os.remove(old_ap_mod)
-                    logging.info(f"Removed old mod file from {old_ap_mod}")
-            else:
-                logging.error(f"Error retrieving the randomizer mod (status code {apmod_resp.status_code}).")
-                logging.error(f"Please report this issue on the Archipelago Discord server.")
-                sys.exit(1)
-
-
-def check_eula(forge_dir):
-    """Check if the EULA is agreed to, and prompt the user to read and agree if necessary."""
-    eula_path = os.path.join(forge_dir, "eula.txt")
-    if not os.path.isfile(eula_path):
-        # Create eula.txt
-        with open(eula_path, 'w') as f:
-            f.write("#By changing the setting below to TRUE you are indicating your agreement to our EULA (https://account.mojang.com/documents/minecraft_eula).\n")
-            f.write(f"#{strftime('%a %b %d %X %Z %Y')}\n")
-            f.write("eula=false\n")
-    with open(eula_path, 'r+') as f:
-        text = f.read()
-        if 'false' in text:
-            # Prompt user to agree to the EULA
-            logging.info("You need to agree to the Minecraft EULA in order to run the server.")
-            logging.info("The EULA can be found at https://account.mojang.com/documents/minecraft_eula")
-            if prompt_yes_no("Do you agree to the EULA?"):
-                f.seek(0)
-                f.write(text.replace('false', 'true'))
-                f.truncate()
-                logging.info(f"Set {eula_path} to true")
-            else:
-                sys.exit(0)
-
-
-def find_jdk_dir(version: str) -> str:
-    """get the specified versions jdk directory"""
-    for entry in os.listdir():
-        if os.path.isdir(entry) and entry.startswith(f"jdk{version}"):
-            return os.path.abspath(entry)
-
-
-def find_jdk(version: str) -> str:
-    """get the java exe location"""
-
-    if is_windows:
-        jdk = find_jdk_dir(version)
-        jdk_exe = os.path.join(jdk, "bin", "java.exe")
-        if os.path.isfile(jdk_exe):
-            return jdk_exe
-    else:
-        jdk_exe = shutil.which(options.java)
-        if not jdk_exe:
-            jdk_exe = shutil.which("java") # try to fall back to system java
-            if not jdk_exe:
-                raise Exception("Could not find Java. Is Java installed on the system?")
-        return jdk_exe
-
-
-def download_java(java: str):
-    """Download Corretto (Amazon JDK)"""
-
-    jdk = find_jdk_dir(java)
-    if jdk is not None:
-        print(f"Removing old JDK...")
-        from shutil import rmtree
-        rmtree(jdk)
-
-    print(f"Downloading Java...")
-    jdk_url = f"https://corretto.aws/downloads/latest/amazon-corretto-{java}-x64-windows-jdk.zip"
-    resp = requests.get(jdk_url)
-    if resp.status_code == 200:  # OK
-        print(f"Extracting...")
-        import zipfile
-        from io import BytesIO
-        with zipfile.ZipFile(BytesIO(resp.content)) as zf:
-            zf.extractall()
-    else:
-        print(f"Error downloading Java (status code {resp.status_code}).")
-        print(f"If this was not expected, please report this issue on the Archipelago Discord server.")
-        if not prompt_yes_no("Continue anyways?"):
-            sys.exit(0)
-
-
-def install_forge(directory: str, forge_version: str, java_version: str):
-    """download and install forge"""
-
-    java_exe = find_jdk(java_version)
-    if java_exe is not None:
-        print(f"Downloading Forge {forge_version}...")
-        forge_url = f"https://maven.minecraftforge.net/net/minecraftforge/forge/{forge_version}/forge-{forge_version}-installer.jar"
-        resp = requests.get(forge_url)
-        if resp.status_code == 200:  # OK
-            forge_install_jar = os.path.join(directory, "forge_install.jar")
-            if not os.path.exists(directory):
-                os.mkdir(directory)
-            with open(forge_install_jar, 'wb') as f:
-                f.write(resp.content)
-            print(f"Installing Forge...")
-            install_process = Popen([java_exe, "-jar", forge_install_jar, "--installServer", directory])
-            install_process.wait()
-            os.remove(forge_install_jar)
-
-
-def run_forge_server(forge_dir: str, java_version: str, heap_arg: str) -> Popen:
-    """Run the Forge server."""
-
-    java_exe = find_jdk(java_version)
-    if not os.path.isfile(java_exe):
-        java_exe = "java"  # try to fall back on java in the PATH
-
-    heap_arg = max_heap_re.match(heap_arg).group()
-    if heap_arg[-1] in ['b', 'B']:
-        heap_arg = heap_arg[:-1]
-    heap_arg = "-Xmx" + heap_arg
-
-    os_args = "win_args.txt" if is_windows else "unix_args.txt"
-    args_file = os.path.join(forge_dir, "libraries", "net", "minecraftforge", "forge", forge_version, os_args)
-    forge_args = []
-    with open(args_file) as argfile:
-        for line in argfile:
-            forge_args.extend(line.strip().split(" "))
-
-    args = [java_exe, heap_arg, *forge_args, "-nogui"]
-    logging.info(f"Running Forge server: {args}")
-    os.chdir(forge_dir)
-    return Popen(args)
-
-
-def get_minecraft_versions(version, release_channel="release"):
-    version_file_endpoint = "https://raw.githubusercontent.com/KonoTyran/Minecraft_AP_Randomizer/master/versions/minecraft_versions.json"
-    resp = requests.get(version_file_endpoint)
-    local = False
-    if resp.status_code == 200:  # OK
-        try:
-            data = resp.json()
-        except requests.exceptions.JSONDecodeError:
-            logging.warning(f"Unable to fetch version update file, using local version. (status code {resp.status_code}).")
-            local = True
-    else:
-        logging.warning(f"Unable to fetch version update file, using local version. (status code {resp.status_code}).")
-        local = True
-
-    if local:
-        with open(Utils.user_path("minecraft_versions.json"), 'r') as f:
-            data = json.load(f)
-    else:
-        with open(Utils.user_path("minecraft_versions.json"), 'w') as f:
-            json.dump(data, f)
-
-    try:
-        if version:
-            return next(filter(lambda entry: entry["version"] == version, data[release_channel]))
-        else:
-            return resp.json()[release_channel][0]
-    except (StopIteration, KeyError):
-        logging.error(f"No compatible mod version found for client version {version} on \"{release_channel}\" channel.")
-        if release_channel != "release":
-            logging.error("Consider switching \"release_channel\" to \"release\" in your Host.yaml file")
-        else:
-            logging.error("No suitable mod found on the \"release\" channel. Please Contact us on discord to report this error.")
-        sys.exit(0)
-
-
-def is_correct_forge(forge_dir) -> bool:
-    if os.path.isdir(os.path.join(forge_dir, "libraries", "net", "minecraftforge", "forge", forge_version)):
-        return True
-    return False
-
-
-if __name__ == '__main__':
-    Utils.init_logging("MinecraftClient")
-    parser = argparse.ArgumentParser()
-    parser.add_argument("apmc_file", default=None, nargs='?', help="Path to an Archipelago Minecraft data file (.apmc)")
-    parser.add_argument('--install', '-i', dest='install', default=False, action='store_true',
-                        help="Download and install Java and the Forge server. Does not launch the client afterwards.")
-    parser.add_argument('--release_channel', '-r', dest="channel", type=str, action='store',
-                        help="Specify release channel to use.")
-    parser.add_argument('--java', '-j', metavar='17', dest='java', type=str, default=False, action='store',
-                        help="specify java version.")
-    parser.add_argument('--forge', '-f', metavar='1.18.2-40.1.0', dest='forge', type=str, default=False, action='store',
-                        help="specify forge version. (Minecraft Version-Forge Version)")
-    parser.add_argument('--version', '-v', metavar='9', dest='data_version', type=int, action='store',
-                        help="specify Mod data version to download.")
-
-    args = parser.parse_args()
-    apmc_file = os.path.abspath(args.apmc_file) if args.apmc_file else None
-
-    # Change to executable's working directory
-    os.chdir(os.path.abspath(os.path.dirname(sys.argv[0])))
-
-    options = get_settings().minecraft_options
-    channel = args.channel or options.release_channel
-    apmc_data = None
-    data_version = args.data_version or None
-
-    if apmc_file is None and not args.install:
-        apmc_file = Utils.open_filename('Select APMC file', (('APMC File', ('.apmc',)),))
-
-    if apmc_file is not None and data_version is None:
-        apmc_data = read_apmc_file(apmc_file)
-        data_version = apmc_data.get('client_version', '')
-
-    versions = get_minecraft_versions(data_version, channel)
-
-    forge_dir = options.forge_directory
-    max_heap = options.max_heap_size
-    forge_version = args.forge or versions["forge"]
-    java_version = args.java or versions["java"]
-    mod_url = versions["url"]
-    java_dir = find_jdk_dir(java_version)
-
-    if args.install:
-        if is_windows:
-            print("Installing Java")
-            download_java(java_version)
-        if not is_correct_forge(forge_dir):
-            print("Installing Minecraft Forge")
-            install_forge(forge_dir, forge_version, java_version)
-        else:
-            print("Correct Forge version already found, skipping install.")
-        sys.exit(0)
-
-    if apmc_data is None:
-        raise FileNotFoundError(f"APMC file does not exist or is inaccessible at the given location ({apmc_file})")
-
-    if is_windows:
-        if java_dir is None or not os.path.isdir(java_dir):
-            if prompt_yes_no("Did not find java directory. Download and install java now?"):
-                download_java(java_version)
-                java_dir = find_jdk_dir(java_version)
-            if java_dir is None or not os.path.isdir(java_dir):
-                raise NotADirectoryError(f"Path {java_dir} does not exist or could not be accessed.")
-
-    if not is_correct_forge(forge_dir):
-        if prompt_yes_no(f"Did not find forge version {forge_version} download and install it now?"):
-            install_forge(forge_dir, forge_version, java_version)
-        if not os.path.isdir(forge_dir):
-            raise NotADirectoryError(f"Path {forge_dir} does not exist or could not be accessed.")
-
-    if not max_heap_re.match(max_heap):
-        raise Exception(f"Max heap size {max_heap} in incorrect format. Use a number followed by M or G, e.g. 512M or 2G.")
-
-    update_mod(forge_dir, mod_url)
-    replace_apmc_files(forge_dir, apmc_file)
-    check_eula(forge_dir)
-    server_process = run_forge_server(forge_dir, java_version, max_heap)
-    server_process.wait()

NetUtils.py

@@ -106,6 +106,27 @@ def _scan_for_TypedTuples(obj: typing.Any) -> typing.Any:
     return obj
 
 
+_base_types = str | int | bool | float | None | tuple["_base_types", ...] | dict["_base_types", "base_types"]
+
+
+def convert_to_base_types(obj: typing.Any) -> _base_types:
+    if isinstance(obj, (tuple, list, set, frozenset)):
+        return tuple(convert_to_base_types(o) for o in obj)
+    elif isinstance(obj, dict):
+        return {convert_to_base_types(key): convert_to_base_types(value) for key, value in obj.items()}
+    elif obj is None or type(obj) in (str, int, float, bool):
+        return obj
+    # unwrap simple types to their base, such as StrEnum
+    elif isinstance(obj, str):
+        return str(obj)
+    elif isinstance(obj, int):
+        return int(obj)
+    elif isinstance(obj, float):
+        return float(obj)
+    else:
+        raise Exception(f"Cannot handle {type(obj)}")
+
+
 _encode = JSONEncoder(
     ensure_ascii=False,
     check_circular=False,

Options.py

@@ -1524,9 +1524,11 @@ class PlandoItems(Option[typing.List[PlandoItem]]):
                                           f"dictionary, not {type(items)}")
                     locations = item.get("locations", [])
                     if not locations:
-                        locations = item.get("location", ["Everywhere"])
+                        locations = item.get("location", [])
                         if locations:
                             count = 1
+                        else:
+                            locations = ["Everywhere"]
                         if isinstance(locations, str):
                             locations = [locations]
                         if not isinstance(locations, list):

README.md

@@ -7,7 +7,6 @@ Currently, the following games are supported:
 
 * The Legend of Zelda: A Link to the Past
 * Factorio
-* Minecraft
 * Subnautica
 * Risk of Rain 2
 * The Legend of Zelda: Ocarina of Time
@@ -15,7 +14,6 @@ Currently, the following games are supported:
 * Super Metroid
 * Secret of Evermore
 * Final Fantasy
-* Rogue Legacy
 * VVVVVV
 * Raft
 * Super Mario 64
@@ -42,7 +40,6 @@ Currently, the following games are supported:
 * The Messenger
 * Kingdom Hearts 2
 * The Legend of Zelda: Link's Awakening DX
-* Clique
 * Adventure
 * DLC Quest
 * Noita

Utils.py

@@ -166,6 +166,10 @@ def home_path(*path: str) -> str:
                 os.symlink(home_path.cached_path, legacy_home_path)
             else:
                 os.makedirs(home_path.cached_path, 0o700, exist_ok=True)
+    elif sys.platform == 'darwin':
+        import platformdirs
+        home_path.cached_path = platformdirs.user_data_dir("Archipelago", False)
+        os.makedirs(home_path.cached_path, 0o700, exist_ok=True)
     else:
         # not implemented
         home_path.cached_path = local_path()  # this will generate the same exceptions we got previously
@@ -177,7 +181,7 @@ def user_path(*path: str) -> str:
     """Returns either local_path or home_path based on write permissions."""
     if hasattr(user_path, "cached_path"):
         pass
-    elif os.access(local_path(), os.W_OK):
+    elif os.access(local_path(), os.W_OK) and not (is_macos and is_frozen()):
         user_path.cached_path = local_path()
     else:
         user_path.cached_path = home_path()
@@ -226,7 +230,12 @@ def open_file(filename: typing.Union[str, "pathlib.Path"]) -> None:
         from shutil import which
         open_command = which("open") if is_macos else (which("xdg-open") or which("gnome-open") or which("kde-open"))
         assert open_command, "Didn't find program for open_file! Please report this together with system details."
-        subprocess.call([open_command, filename])
+
+        env = os.environ
+        if "LD_LIBRARY_PATH" in env:
+            env = env.copy()
+            del env["LD_LIBRARY_PATH"]  # exe is a system binary, so reset LD_LIBRARY_PATH
+        subprocess.call([open_command, filename], env=env)
 
 
 # from https://gist.github.com/pypt/94d747fe5180851196eb#gistcomment-4015118 with some changes
@@ -433,6 +442,7 @@ class RestrictedUnpickler(pickle.Unpickler):
         if module == "builtins" and name in safe_builtins:
             return getattr(builtins, name)
         # used by OptionCounter
+        # necessary because the actual Options class instances are pickled when transfered to WebHost generation pool
         if module == "collections" and name == "Counter":
             return collections.Counter
         # used by MultiServer -> savegame/multidata
@@ -708,25 +718,30 @@ def _mp_open_filename(res: "multiprocessing.Queue[typing.Optional[str]]", *args:
     res.put(open_filename(*args))
 
 
+def _run_for_stdout(*args: str):
+    env = os.environ
+    if "LD_LIBRARY_PATH" in env:
+        env = env.copy()
+        del env["LD_LIBRARY_PATH"]  # exe is a system binary, so reset LD_LIBRARY_PATH
+    return subprocess.run(args, capture_output=True, text=True, env=env).stdout.split("\n", 1)[0] or None
+
+
 def open_filename(title: str, filetypes: typing.Iterable[typing.Tuple[str, typing.Iterable[str]]], suggest: str = "") \
         -> typing.Optional[str]:
     logging.info(f"Opening file input dialog for {title}.")
 
-    def run(*args: str):
-        return subprocess.run(args, capture_output=True, text=True).stdout.split("\n", 1)[0] or None
-
     if is_linux:
         # prefer native dialog
         from shutil import which
         kdialog = which("kdialog")
         if kdialog:
             k_filters = '|'.join((f'{text} (*{" *".join(ext)})' for (text, ext) in filetypes))
-            return run(kdialog, f"--title={title}", "--getopenfilename", suggest or ".", k_filters)
+            return _run_for_stdout(kdialog, f"--title={title}", "--getopenfilename", suggest or ".", k_filters)
         zenity = which("zenity")
         if zenity:
             z_filters = (f'--file-filter={text} ({", ".join(ext)}) | *{" *".join(ext)}' for (text, ext) in filetypes)
             selection = (f"--filename={suggest}",) if suggest else ()
-            return run(zenity, f"--title={title}", "--file-selection", *z_filters, *selection)
+            return _run_for_stdout(zenity, f"--title={title}", "--file-selection", *z_filters, *selection)
 
     # fall back to tk
     try:
@@ -760,21 +775,18 @@ def _mp_open_directory(res: "multiprocessing.Queue[typing.Optional[str]]", *args
 
 
 def open_directory(title: str, suggest: str = "") -> typing.Optional[str]:
-    def run(*args: str):
-        return subprocess.run(args, capture_output=True, text=True).stdout.split("\n", 1)[0] or None
-
     if is_linux:
         # prefer native dialog
         from shutil import which
         kdialog = which("kdialog")
         if kdialog:
-            return run(kdialog, f"--title={title}", "--getexistingdirectory",
+            return _run_for_stdout(kdialog, f"--title={title}", "--getexistingdirectory",
                        os.path.abspath(suggest) if suggest else ".")
         zenity = which("zenity")
         if zenity:
             z_filters = ("--directory",)
             selection = (f"--filename={os.path.abspath(suggest)}/",) if suggest else ()
-            return run(zenity, f"--title={title}", "--file-selection", *z_filters, *selection)
+            return _run_for_stdout(zenity, f"--title={title}", "--file-selection", *z_filters, *selection)
 
     # fall back to tk
     try:
@@ -801,9 +813,6 @@ def open_directory(title: str, suggest: str = "") -> typing.Optional[str]:
 
 
 def messagebox(title: str, text: str, error: bool = False) -> None:
-    def run(*args: str):
-        return subprocess.run(args, capture_output=True, text=True).stdout.split("\n", 1)[0] or None
-
     if is_kivy_running():
         from kvui import MessageBox
         MessageBox(title, text, error).open()
@@ -814,10 +823,10 @@ def messagebox(title: str, text: str, error: bool = False) -> None:
         from shutil import which
         kdialog = which("kdialog")
         if kdialog:
-            return run(kdialog, f"--title={title}", "--error" if error else "--msgbox", text)
+            return _run_for_stdout(kdialog, f"--title={title}", "--error" if error else "--msgbox", text)
         zenity = which("zenity")
         if zenity:
-            return run(zenity, f"--title={title}", f"--text={text}", "--error" if error else "--info")
+            return _run_for_stdout(zenity, f"--title={title}", f"--text={text}", "--error" if error else "--info")
 
     elif is_windows:
         import ctypes

WebHostLib/downloads.py

@@ -61,12 +61,7 @@ def download_slot_file(room_id, player_id: int):
     else:
         import io
 
-        if slot_data.game == "Minecraft":
-            from worlds.minecraft import mc_update_output
-            fname = f"AP_{app.jinja_env.filters['suuid'](room_id)}_P{slot_data.player_id}_{slot_data.player_name}.apmc"
-            data = mc_update_output(slot_data.data, server=app.config['HOST_ADDRESS'], port=room.last_port)
-            return send_file(io.BytesIO(data), as_attachment=True, download_name=fname)
-        elif slot_data.game == "Factorio":
+        if slot_data.game == "Factorio":
             with zipfile.ZipFile(io.BytesIO(slot_data.data)) as zf:
                 for name in zf.namelist():
                     if name.endswith("info.json"):

WebHostLib/requirements.txt

@@ -1,4 +1,4 @@
-flask>=3.1.0
+flask>=3.1.1
 werkzeug>=3.1.3
 pony>=0.7.19
 waitress>=3.0.2

WebHostLib/static/assets/minecraftTracker.js

@@ -1,49 +0,0 @@
-window.addEventListener('load', () => {
-  // Reload tracker every 15 seconds
-  const url = window.location;
-  setInterval(() => {
-    const ajax = new XMLHttpRequest();
-    ajax.onreadystatechange = () => {
-      if (ajax.readyState !== 4) { return; }
-
-      // Create a fake DOM using the returned HTML
-      const domParser = new DOMParser();
-      const fakeDOM = domParser.parseFromString(ajax.responseText, 'text/html');
-
-      // Update item tracker
-      document.getElementById('inventory-table').innerHTML = fakeDOM.getElementById('inventory-table').innerHTML;
-      // Update only counters in the location-table
-      let counters = document.getElementsByClassName('counter');
-      const fakeCounters = fakeDOM.getElementsByClassName('counter');
-      for (let i = 0; i < counters.length; i++) {
-        counters[i].innerHTML = fakeCounters[i].innerHTML;
-      }
-    };
-    ajax.open('GET', url);
-    ajax.send();
-  }, 15000)
-
-  // Collapsible advancement sections
-  const categories = document.getElementsByClassName("location-category");
-  for (let i = 0; i < categories.length; i++) {
-    let hide_id = categories[i].id.split('-')[0];
-    if (hide_id == 'Total') {
-      continue;
-    }
-    categories[i].addEventListener('click', function() {
-      // Toggle the advancement list
-      document.getElementById(hide_id).classList.toggle("hide");
-      // Change text of the header
-      const tab_header = document.getElementById(hide_id+'-header').children[0];
-      const orig_text = tab_header.innerHTML;
-      let new_text;
-      if (orig_text.includes("▼")) {
-        new_text = orig_text.replace("▼", "▲");
-      }
-      else {
-        new_text = orig_text.replace("▲", "▼");
-      }
-      tab_header.innerHTML = new_text;
-    });
-  }
-});

WebHostLib/static/styles/minecraftTracker.css

@@ -1,102 +0,0 @@
-#player-tracker-wrapper{
-    margin: 0;
-}
-
-#inventory-table{
-    border-top: 2px solid #000000;
-    border-left: 2px solid #000000;
-    border-right: 2px solid #000000;
-    border-top-left-radius: 4px;
-    border-top-right-radius: 4px;
-    padding: 3px 3px 10px;
-    width: 384px;
-    background-color: #42b149;
-}
-
-#inventory-table td{
-    width: 40px;
-    height: 40px;
-    text-align: center;
-    vertical-align: middle;
-}
-
-#inventory-table img{
-    height: 100%;
-    max-width: 40px;
-    max-height: 40px;
-    filter: grayscale(100%) contrast(75%) brightness(30%);
-}
-
-#inventory-table img.acquired{
-    filter: none;
-}
-
-#inventory-table div.counted-item {
-    position: relative;
-}
-
-#inventory-table div.item-count {
-    position: absolute;
-    color: white;
-    font-family: "Minecraftia", monospace;
-    font-weight: bold;
-    bottom: 0;
-    right: 0;
-}
-
-#location-table{
-    width: 384px;
-    border-left: 2px solid #000000;
-    border-right: 2px solid #000000;
-    border-bottom: 2px solid #000000;
-    border-bottom-left-radius: 4px;
-    border-bottom-right-radius: 4px;
-    background-color: #42b149;
-    padding: 0 3px 3px;
-    font-family: "Minecraftia", monospace;
-    font-size: 14px;
-    cursor: default;
-}
-
-#location-table th{
-    vertical-align: middle;
-    text-align: left;
-    padding-right: 10px;
-}
-
-#location-table td{
-    padding-top: 2px;
-    padding-bottom: 2px;
-    line-height: 20px;
-}
-
-#location-table td.counter {
-    text-align: right;
-    font-size: 14px;
-}
-
-#location-table td.toggle-arrow {
-    text-align: right;
-}
-
-#location-table tr#Total-header {
-    font-weight: bold;
-}
-
-#location-table img{
-    height: 100%;
-    max-width: 30px;
-    max-height: 30px;
-}
-
-#location-table tbody.locations {
-    font-size: 12px;
-}
-
-#location-table td.location-name {
-    padding-left: 16px;
-}
-
-.hide {
-    display: none;
-}

WebHostLib/templates/macros.html

@@ -26,10 +26,7 @@
                     <td>{{ patch.game }}</td>
                     <td>
                         {% if patch.data %}
-                            {% if patch.game == "Minecraft" %}
-                            <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
-                                Download APMC File...</a>
-                            {% elif patch.game == "VVVVVV" and room.seed.slots|length == 1 %}
+                            {% if patch.game == "VVVVVV" and room.seed.slots|length == 1 %}
                             <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
                                 Download APV6 File...</a>
                             {% elif patch.game == "Super Mario 64" and room.seed.slots|length == 1 %}

WebHostLib/templates/tracker__Minecraft.html

@@ -1,84 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <title>{{ player_name }}&apos;s Tracker</title>
-    <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename='styles/minecraftTracker.css') }}"/>
-    <script type="application/ecmascript" src="{{ url_for('static', filename='assets/minecraftTracker.js') }}"></script>
-    <link rel="stylesheet" media="screen" href="https://fontlibrary.org//face/minecraftia" type="text/css"/>
-</head>
-
-<body>
-    {# TODO: Replace this with a proper wrapper for each tracker when developing TrackerAPI. #}
-    <div style="margin-bottom: 0.5rem">
-        <a href="{{ url_for("get_generic_game_tracker", tracker=room.tracker, tracked_team=team, tracked_player=player) }}">Switch To Generic Tracker</a>
-    </div>
-
-    <div id="player-tracker-wrapper" data-tracker="{{ room.tracker|suuid }}">
-        <table id="inventory-table">
-            <tr>
-                <td><img src="{{ tools_url }}" class="{{ 'acquired' }}" title="Progressive Tools" /></td>
-                <td><img src="{{ weapons_url }}" class="{{ 'acquired' }}" title="Progressive Weapons" /></td>
-                <td><img src="{{ armor_url }}" class="{{ 'acquired' }}" title="Progressive Armor" /></td>
-                <td><img src="{{ resource_crafting_url }}" class="{{ 'acquired' if 'Progressive Resource Crafting' in acquired_items }}"
-                    title="Progressive Resource Crafting" /></td>
-                <td><img src="{{ icons['Brewing Stand'] }}" class="{{ 'acquired' if 'Brewing' in acquired_items }}" title="Brewing" /></td>
-                <td>
-                    <div class="counted-item">
-                        <img src="{{ icons['Ender Pearl'] }}" class="{{ 'acquired' if '3 Ender Pearls' in acquired_items }}" title="Ender Pearls" />
-                        <div class="item-count">{{ pearls_count }}</div>
-                    </div>
-                </td>
-            </tr>
-            <tr>
-                <td><img src="{{ icons['Bucket'] }}" class="{{ 'acquired' if 'Bucket' in acquired_items }}" title="Bucket" /></td>
-                <td><img src="{{ icons['Bow'] }}" class="{{ 'acquired' if 'Archery' in acquired_items }}" title="Archery" /></td>
-                <td><img src="{{ icons['Shield'] }}" class="{{ 'acquired' if 'Shield' in acquired_items }}" title="Shield" /></td>
-                <td><img src="{{ icons['Red Bed'] }}" class="{{ 'acquired' if 'Bed' in acquired_items }}" title="Bed" /></td>
-                <td><img src="{{ icons['Water Bottle'] }}" class="{{ 'acquired' if 'Bottles' in acquired_items }}" title="Bottles" /></td>
-                <td>
-                    <div class="counted-item">
-                        <img src="{{ icons['Netherite Scrap'] }}" class="{{ 'acquired' if '8 Netherite Scrap' in acquired_items }}" title="Netherite Scrap" />
-                        <div class="item-count">{{ scrap_count }}</div>
-                    </div>
-                </td>
-            </tr>
-            <tr>
-                <td><img src="{{ icons['Flint and Steel'] }}" class="{{ 'acquired' if 'Flint and Steel' in acquired_items }}" title="Flint and Steel" /></td>
-                <td><img src="{{ icons['Enchanting Table'] }}" class="{{ 'acquired' if 'Enchanting' in acquired_items }}" title="Enchanting" /></td>
-                <td><img src="{{ icons['Fishing Rod'] }}" class="{{ 'acquired' if 'Fishing Rod' in acquired_items }}" title="Fishing Rod" /></td>
-                <td><img src="{{ icons['Campfire'] }}" class="{{ 'acquired' if 'Campfire' in acquired_items }}" title="Campfire" /></td>
-                <td><img src="{{ icons['Spyglass'] }}" class="{{ 'acquired' if 'Spyglass' in acquired_items }}" title="Spyglass" /></td>
-                <td>
-                    <div class="counted-item">
-                        <img src="{{ icons['Dragon Egg Shard'] }}" class="{{ 'acquired' if 'Dragon Egg Shard' in acquired_items }}" title="Dragon Egg Shard" />
-                        <div class="item-count">{{ shard_count }}</div>
-                    </div>
-                </td>
-            </tr>
-             <tr>
-                <td><img src="{{ icons['Lead'] }}" class="{{ 'acquired' if 'Lead' in acquired_items }}" title="Lead" /></td>
-                <td><img src="{{ icons['Saddle'] }}" class="{{ 'acquired' if 'Saddle' in acquired_items }}" title="Saddle" /></td>
-                <td><img src="{{ icons['Channeling Book'] }}" class="{{ 'acquired' if 'Channeling Book' in acquired_items }}" title="Channeling Book" /></td>
-                <td><img src="{{ icons['Silk Touch Book'] }}" class="{{ 'acquired' if 'Silk Touch Book' in acquired_items }}" title="Silk Touch Book" /></td>
-                <td><img src="{{ icons['Piercing IV Book'] }}" class="{{ 'acquired' if 'Piercing IV Book' in acquired_items }}" title="Piercing IV Book" /></td>
-            </tr>
-        </table>
-        <table id="location-table">
-            {% for area in checks_done %}
-            <tr class="location-category" id="{{area}}-header">
-                <td>{{ area }} {{'▼' if area != 'Total'}}</td>
-                <td class="counter">{{ checks_done[area] }} / {{ checks_in_area[area] }}</td>
-            </tr>
-            <tbody class="locations hide" id="{{area}}">
-                {% for location in location_info[area] %}
-                <tr>
-                    <td class="location-name">{{ location }}</td>
-                    <td class="counter">{{ '✔' if location_info[area][location] else '' }}</td>
-                </tr>
-                {% endfor %}
-            </tbody>
-            {% endfor %}
-        </table>
-    </div>
-</body>
-</html>

WebHostLib/tracker.py

@@ -706,127 +706,6 @@ if "A Link to the Past" in network_data_package["games"]:
     _multiworld_trackers["A Link to the Past"] = render_ALinkToThePast_multiworld_tracker
     _player_trackers["A Link to the Past"] = render_ALinkToThePast_tracker
 
-if "Minecraft" in network_data_package["games"]:
-    def render_Minecraft_tracker(tracker_data: TrackerData, team: int, player: int) -> str:
-        icons = {
-            "Wooden Pickaxe":     "https://static.wikia.nocookie.net/minecraft_gamepedia/images/d/d2/Wooden_Pickaxe_JE3_BE3.png",
-            "Stone Pickaxe":      "https://static.wikia.nocookie.net/minecraft_gamepedia/images/c/c4/Stone_Pickaxe_JE2_BE2.png",
-            "Iron Pickaxe":       "https://static.wikia.nocookie.net/minecraft_gamepedia/images/d/d1/Iron_Pickaxe_JE3_BE2.png",
-            "Diamond Pickaxe":    "https://static.wikia.nocookie.net/minecraft_gamepedia/images/e/e7/Diamond_Pickaxe_JE3_BE3.png",
-            "Wooden Sword":       "https://static.wikia.nocookie.net/minecraft_gamepedia/images/d/d5/Wooden_Sword_JE2_BE2.png",
-            "Stone Sword":        "https://static.wikia.nocookie.net/minecraft_gamepedia/images/b/b1/Stone_Sword_JE2_BE2.png",
-            "Iron Sword":         "https://static.wikia.nocookie.net/minecraft_gamepedia/images/8/8e/Iron_Sword_JE2_BE2.png",
-            "Diamond Sword":      "https://static.wikia.nocookie.net/minecraft_gamepedia/images/4/44/Diamond_Sword_JE3_BE3.png",
-            "Leather Tunic":      "https://static.wikia.nocookie.net/minecraft_gamepedia/images/b/b7/Leather_Tunic_JE4_BE2.png",
-            "Iron Chestplate":    "https://static.wikia.nocookie.net/minecraft_gamepedia/images/3/31/Iron_Chestplate_JE2_BE2.png",
-            "Diamond Chestplate": "https://static.wikia.nocookie.net/minecraft_gamepedia/images/e/e0/Diamond_Chestplate_JE3_BE2.png",
-            "Iron Ingot":         "https://static.wikia.nocookie.net/minecraft_gamepedia/images/f/fc/Iron_Ingot_JE3_BE2.png",
-            "Block of Iron":      "https://static.wikia.nocookie.net/minecraft_gamepedia/images/7/7e/Block_of_Iron_JE4_BE3.png",
-            "Brewing Stand":      "https://static.wikia.nocookie.net/minecraft_gamepedia/images/b/b3/Brewing_Stand_%28empty%29_JE10.png",
-            "Ender Pearl":        "https://static.wikia.nocookie.net/minecraft_gamepedia/images/f/f6/Ender_Pearl_JE3_BE2.png",
-            "Bucket":             "https://static.wikia.nocookie.net/minecraft_gamepedia/images/f/fc/Bucket_JE2_BE2.png",
-            "Bow":                "https://static.wikia.nocookie.net/minecraft_gamepedia/images/a/ab/Bow_%28Pull_2%29_JE1_BE1.png",
-            "Shield":             "https://static.wikia.nocookie.net/minecraft_gamepedia/images/c/c6/Shield_JE2_BE1.png",
-            "Red Bed":            "https://static.wikia.nocookie.net/minecraft_gamepedia/images/6/6a/Red_Bed_%28N%29.png",
-            "Netherite Scrap":    "https://static.wikia.nocookie.net/minecraft_gamepedia/images/3/33/Netherite_Scrap_JE2_BE1.png",
-            "Flint and Steel":    "https://static.wikia.nocookie.net/minecraft_gamepedia/images/9/94/Flint_and_Steel_JE4_BE2.png",
-            "Enchanting Table":   "https://static.wikia.nocookie.net/minecraft_gamepedia/images/3/31/Enchanting_Table.gif",
-            "Fishing Rod":        "https://static.wikia.nocookie.net/minecraft_gamepedia/images/7/7f/Fishing_Rod_JE2_BE2.png",
-            "Campfire":           "https://static.wikia.nocookie.net/minecraft_gamepedia/images/9/91/Campfire_JE2_BE2.gif",
-            "Water Bottle":       "https://static.wikia.nocookie.net/minecraft_gamepedia/images/7/75/Water_Bottle_JE2_BE2.png",
-            "Spyglass":           "https://static.wikia.nocookie.net/minecraft_gamepedia/images/c/c1/Spyglass_JE2_BE1.png",
-            "Dragon Egg Shard":   "https://static.wikia.nocookie.net/minecraft_gamepedia/images/3/38/Dragon_Egg_JE4.png",
-            "Lead":               "https://static.wikia.nocookie.net/minecraft_gamepedia/images/1/1f/Lead_JE2_BE2.png",
-            "Saddle":             "https://i.imgur.com/2QtDyR0.png",
-            "Channeling Book":    "https://i.imgur.com/J3WsYZw.png",
-            "Silk Touch Book":    "https://i.imgur.com/iqERxHQ.png",
-            "Piercing IV Book":   "https://i.imgur.com/OzJptGz.png",
-        }
-
-        minecraft_location_ids = {
-            "Story":       [42073, 42023, 42027, 42039, 42002, 42009, 42010, 42070,
-                            42041, 42049, 42004, 42031, 42025, 42029, 42051, 42077],
-            "Nether":      [42017, 42044, 42069, 42058, 42034, 42060, 42066, 42076, 42064, 42071, 42021,
-                            42062, 42008, 42061, 42033, 42011, 42006, 42019, 42000, 42040, 42001, 42015, 42104, 42014],
-            "The End":     [42052, 42005, 42012, 42032, 42030, 42042, 42018, 42038, 42046],
-            "Adventure":   [42047, 42050, 42096, 42097, 42098, 42059, 42055, 42072, 42003, 42109, 42035, 42016, 42020,
-                            42048, 42054, 42068, 42043, 42106, 42074, 42075, 42024, 42026, 42037, 42045, 42056, 42105,
-                            42099, 42103, 42110, 42100],
-            "Husbandry":   [42065, 42067, 42078, 42022, 42113, 42107, 42007, 42079, 42013, 42028, 42036, 42108, 42111,
-                            42112,
-                            42057, 42063, 42053, 42102, 42101, 42092, 42093, 42094, 42095],
-            "Archipelago": [42080, 42081, 42082, 42083, 42084, 42085, 42086, 42087, 42088, 42089, 42090, 42091],
-        }
-
-        display_data = {}
-
-        # Determine display for progressive items
-        progressive_items = {
-            "Progressive Tools":             45013,
-            "Progressive Weapons":           45012,
-            "Progressive Armor":             45014,
-            "Progressive Resource Crafting": 45001
-        }
-        progressive_names = {
-            "Progressive Tools":             ["Wooden Pickaxe", "Stone Pickaxe", "Iron Pickaxe", "Diamond Pickaxe"],
-            "Progressive Weapons":           ["Wooden Sword", "Stone Sword", "Iron Sword", "Diamond Sword"],
-            "Progressive Armor":             ["Leather Tunic", "Iron Chestplate", "Diamond Chestplate"],
-            "Progressive Resource Crafting": ["Iron Ingot", "Iron Ingot", "Block of Iron"]
-        }
-
-        inventory = tracker_data.get_player_inventory_counts(team, player)
-        for item_name, item_id in progressive_items.items():
-            level = min(inventory[item_id], len(progressive_names[item_name]) - 1)
-            display_name = progressive_names[item_name][level]
-            base_name = item_name.split(maxsplit=1)[1].lower().replace(" ", "_")
-            display_data[base_name + "_url"] = icons[display_name]
-
-        # Multi-items
-        multi_items = {
-            "3 Ender Pearls":    45029,
-            "8 Netherite Scrap": 45015,
-            "Dragon Egg Shard":  45043
-        }
-        for item_name, item_id in multi_items.items():
-            base_name = item_name.split()[-1].lower()
-            count = inventory[item_id]
-            if count >= 0:
-                display_data[base_name + "_count"] = count
-
-        # Victory condition
-        game_state = tracker_data.get_player_client_status(team, player)
-        display_data["game_finished"] = game_state == 30
-
-        # Turn location IDs into advancement tab counts
-        checked_locations = tracker_data.get_player_checked_locations(team, player)
-        lookup_name = lambda id: tracker_data.location_id_to_name["Minecraft"][id]
-        location_info = {tab_name: {lookup_name(id): (id in checked_locations) for id in tab_locations}
-                         for tab_name, tab_locations in minecraft_location_ids.items()}
-        checks_done = {tab_name: len([id for id in tab_locations if id in checked_locations])
-                       for tab_name, tab_locations in minecraft_location_ids.items()}
-        checks_done["Total"] = len(checked_locations)
-        checks_in_area = {tab_name: len(tab_locations) for tab_name, tab_locations in minecraft_location_ids.items()}
-        checks_in_area["Total"] = sum(checks_in_area.values())
-
-        lookup_any_item_id_to_name = tracker_data.item_id_to_name["Minecraft"]
-        return render_template(
-            "tracker__Minecraft.html",
-            inventory=inventory,
-            icons=icons,
-            acquired_items={lookup_any_item_id_to_name[id] for id, count in inventory.items() if count > 0},
-            player=player,
-            team=team,
-            room=tracker_data.room,
-            player_name=tracker_data.get_player_name(team, player),
-            saving_second=tracker_data.get_room_saving_second(),
-            checks_done=checks_done,
-            checks_in_area=checks_in_area,
-            location_info=location_info,
-            **display_data,
-        )
-
-    _player_trackers["Minecraft"] = render_Minecraft_tracker
-
 if "Ocarina of Time" in network_data_package["games"]:
     def render_OcarinaOfTime_tracker(tracker_data: TrackerData, team: int, player: int) -> str:
         icons = {

WebHostLib/upload.py

@@ -119,9 +119,9 @@ def upload_zip_to_db(zfile: zipfile.ZipFile, owner=None, meta={"race": False}, s
         # AP Container
         elif handler:
             data = zfile.open(file, "r").read()
-            patch = handler(BytesIO(data))
-            patch.read()
-            files[patch.player] = data
+            with zipfile.ZipFile(BytesIO(data)) as container:
+                player = json.loads(container.open("archipelago.json").read())["player"]
+            files[player] = data
 
         # Spoiler
         elif file.filename.endswith(".txt"):
@@ -135,11 +135,6 @@ def upload_zip_to_db(zfile: zipfile.ZipFile, owner=None, meta={"race": False}, s
                 flash("Could not load multidata. File may be corrupted or incompatible.")
                 multidata = None
 
-        # Minecraft
-        elif file.filename.endswith(".apmc"):
-            data = zfile.open(file, "r").read()
-            metadata = json.loads(base64.b64decode(data).decode("utf-8"))
-            files[metadata["player_id"]] = data
 
         # Factorio
         elif file.filename.endswith(".zip"):

data/client.kv

@@ -24,9 +24,20 @@
 <BaseButton>:
     ripple_color: app.theme_cls.primaryColor
     ripple_duration_in_fast: 0.2
-<MDTabsItemBase>:
-    ripple_color: app.theme_cls.primaryColor
-    ripple_duration_in_fast: 0.2
+<MDNavigationItemBase>:
+    on_release: app.screens.switch_screens(self)
+
+    MDNavigationItemLabel:
+        text: root.text
+        theme_text_color: "Custom"
+        text_color_active: self.theme_cls.primaryColor
+        text_color_normal: 1, 1, 1, 1
+        # indicator is on icon only for some reason
+        canvas.before:
+            Color:
+                rgba: self.theme_cls.secondaryContainerColor if root.active else self.theme_cls.transparentColor
+            Rectangle:
+                size: root.size
 <TooltipLabel>:
     adaptive_height: True
     theme_font_size: "Custom"

data/lua/connector_bizhawk_generic.lua

@@ -365,18 +365,14 @@ request_handlers = {
     ["PREFERRED_CORES"] = function (req)
         local res = {}
         local preferred_cores = client.getconfig().PreferredCores
+        local systems_enumerator = preferred_cores.Keys:GetEnumerator()
 
         res["type"] = "PREFERRED_CORES_RESPONSE"
         res["value"] = {}
-        res["value"]["NES"] = preferred_cores.NES
-        res["value"]["SNES"] = preferred_cores.SNES
-        res["value"]["GB"] = preferred_cores.GB
-        res["value"]["GBC"] = preferred_cores.GBC
-        res["value"]["DGB"] = preferred_cores.DGB
-        res["value"]["SGB"] = preferred_cores.SGB
-        res["value"]["PCE"] = preferred_cores.PCE
-        res["value"]["PCECD"] = preferred_cores.PCECD
-        res["value"]["SGX"] = preferred_cores.SGX
+
+        while systems_enumerator:MoveNext() do
+            res["value"][systems_enumerator.Current] = preferred_cores[systems_enumerator.Current]
+        end
 
         return res
     end,

data/lua/connector_mmbn3.lua

@@ -477,7 +477,7 @@ function main()
         elseif (curstate == STATE_UNINITIALIZED) then
             -- If we're uninitialized, attempt to make the connection.
             if (frame % 120 == 0) then
-                server:settimeout(2)
+                server:settimeout(120)
                 local client, timeout = server:accept()
                 if timeout == nil then
                     print('Initial Connection Made')

docs/CODEOWNERS

@@ -48,9 +48,6 @@
 # Civilization VI
 /worlds/civ6/ @hesto2
 
-# Clique
-/worlds/clique/ @ThePhar
-
 # Dark Souls III
 /worlds/dark_souls_3/ @Marechal-L @nex3
 
@@ -121,9 +118,6 @@
 # The Messenger
 /worlds/messenger/ @alwaysintreble
 
-# Minecraft
-/worlds/minecraft/ @KonoTyran @espeon65536
-
 # Mega Man 2
 /worlds/mm2/ @Silvris
 
@@ -151,9 +145,6 @@
 # Raft
 /worlds/raft/ @SunnyBat
 
-# Rogue Legacy
-/worlds/rogue_legacy/ @ThePhar
-
 # Risk of Rain 2
 /worlds/ror2/ @kindasneaki
 

docs/network diagram/network diagram.md

@@ -117,12 +117,6 @@ flowchart LR
     %% Java Based Games
     subgraph Java
         JM[Mod with Archipelago.MultiClient.Java]
-        subgraph Minecraft
-            MCS[Minecraft Forge Server]
-            JMC[Any Java Minecraft Clients]
-            MCS <-- TCP --> JMC
-        end
-        JM <-- Forge Mod Loader --> MCS
     end
     AS <-- WebSockets --> JM
 
@@ -131,10 +125,8 @@ flowchart LR
         NM[Mod with Archipelago.MultiClient.Net]
         subgraph FNA/XNA
             TS[Timespinner]
-            RL[Rogue Legacy]
         end
         NM <-- TsRandomizer --> TS
-        NM <-- RogueLegacyRandomizer --> RL
         subgraph Unity
             ROR[Risk of Rain 2]
             SN[Subnautica]
@@ -183,4 +175,4 @@ flowchart LR
         FMOD <--> FMAPI
     end
     CC <-- Integrated --> FC
-```
+```

docs/world api.md

@@ -258,31 +258,6 @@ another flag like "progression", it means "an especially useful progression item
 * `progression_skip_balancing`: the combination of `progression` and `skip_balancing`, i.e., a progression item that
   will not be moved around by progression balancing; used, e.g., for currency or tokens, to not flood early spheres
 
-### Events
-
-An Event is a special combination of a Location and an Item, with both having an `id` of `None`. These can be used to
-track certain logic interactions, with the Event Item being required for access in other locations or regions, but not
-being "real". Since the item and location have no ID, they get dropped at the end of generation and so the server is
-never made aware of them and these locations can never be checked, nor can the items be received during play.
-They may also be used for making the spoiler log look nicer, i.e. by having a `"Victory"` Event Item, that
-is required to finish the game. This makes it very clear when the player finishes, rather than only seeing their last
-relevant Item. Events function just like any other Location, and can still have their own access rules, etc.
-By convention, the Event "pair" of Location and Item typically have the same name, though this is not a requirement.
-They must not exist in the `name_to_id` lookups, as they have no ID.
-
-The most common way to create an Event pair is to create and place the Item on the Location as soon as it's created:
-
-```python
-from worlds.AutoWorld import World
-from BaseClasses import ItemClassification
-from .subclasses import MyGameLocation, MyGameItem
-
-
-class MyGameWorld(World):
-    victory_loc = MyGameLocation(self.player, "Victory", None)
-    victory_loc.place_locked_item(MyGameItem("Victory", ItemClassification.progression, None, self.player))
-```
-
 ### Regions
 
 Regions are logical containers that typically hold locations that share some common access rules. If location logic is
@@ -291,7 +266,7 @@ like entrance randomization in logic.
 
 Regions have a list called `exits`, containing `Entrance` objects representing transitions to other regions.
 
-There must be one special region (Called "Menu" by default, but configurable using [origin_region_name](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L298-L299)),
+There must be one special region (Called "Menu" by default, but configurable using [origin_region_name](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L310-L311)),
 from which the logic unfolds. AP assumes that a player will always be able to return to this starting region by resetting the game ("Save and quit").
 
 ### Entrances
@@ -339,6 +314,63 @@ avoiding the need for indirect conditions at the expense of performance.
 An item rule is a function that returns `True` or `False` for a `Location` based on a single item. It can be used to
 reject the placement of an item there.
 
+### Events (or "generation-only items/locations")
+
+An event item or location is one that only exists during multiworld generation; the server is never made aware of them.
+Event locations can never be checked by the player, and event items cannot be received during play.
+
+Events are used to represent in-game actions (that aren't regular Archipelago locations) when either:
+
+* We want to show in the spoiler log when the player is expected to perform the in-game action.
+* It's the cleanest way to represent how that in-game action impacts logic.
+
+Typical examples include completing the goal, defeating a boss, or flipping a switch that affects multiple areas.
+
+To be precise: the term "event" on its own refers to the special combination of an "event item" placed on an "event
+location". Event items and locations are created the same way as normal items and locations, except that they have an
+`id` of `None`, and an event item must be placed on an event location
+(and vice versa). Finally, although events are often described as "fake" items and locations, it's important to
+understand that they are perfectly real during generation.
+
+The most common way to create an event is to create the event item and the event location, then immediately call
+`Location.place_locked_item()`:
+
+```python
+victory_loc = MyGameLocation(self.player, "Defeat the Final Boss", None, final_boss_arena_region)
+victory_loc.place_locked_item(MyGameItem("Victory", ItemClassification.progression, None, self.player))
+self.multiworld.completion_condition[self.player] = lambda state: state.has("Victory", self.player)
+set_rule(victory_loc, lambda state: state.has("Boss Defeating Sword", self.player))
+```
+
+Requiring an event to finish the game will make the spoiler log display an additional
+`Defeat the Final Boss: Victory` line when the player is expected to finish, rather than only showing their last
+relevant item. But events aren't just about the spoiler log; a more substantial example of using events to structure
+your logic might be:
+
+```python
+water_loc = MyGameLocation(self.player, "Water Level Switch", None, pump_station_region)
+water_loc.place_locked_item(MyGameItem("Lowered Water Level", ItemClassification.progression, None, self.player))
+pump_station_region.locations.append(water_loc)
+set_rule(water_loc, lambda state: state.has("Double Jump", self.player))  # the switch is really high up
+...
+basement_loc = MyGameLocation(self.player, "Flooded House - Basement Chest", None, flooded_house_region)
+flooded_house_region.locations += [upstairs_loc, ground_floor_loc, basement_loc]
+...
+set_rule(basement_loc, lambda state: state.has("Lowered Water Level", self.player))
+```
+
+This creates a "Lowered Water Level" event and a regular location whose access rule depends on that
+event being reachable. If you made several more locations the same way, this would ensure all of those locations can
+only become reachable when the event location is reachable (i.e. when the water level can be lowered), without
+copy-pasting the event location's access rule and then repeatedly re-evaluating it. Also, the spoiler log will show
+`Water Level Switch: Lowered Water Level` when the player is expected to do this.
+
+To be clear, this example could also be modeled with a second Region (perhaps "Un-Flooded House"). Or you could modify
+the game so flipping that switch checks a regular AP location in addition to lowering the water level.
+Events are never required, but it may be cleaner to use an event if e.g. flipping that switch affects the logic in
+dozens of half-flooded areas that would all otherwise need additional Regions, and you don't want it to be a regular
+location. It depends on the game.
+
 ## Implementation
 
 ### Your World
@@ -488,8 +520,8 @@ In addition, the following methods can be implemented and are called in this ord
   If it's hard to separate, this can be done during `generate_early` or `create_items` as well.
 * `create_items(self)`
   called to place player's items into the MultiWorld's itempool. By the end of this step all regions, locations and
-  items have to be in the MultiWorld's regions and itempool. You cannot add or remove items, locations, or regions
-  after this step. Locations cannot be moved to different regions after this step.
+  items have to be in the MultiWorld's regions and itempool. You cannot add or remove items, locations, or regions after
+  this step. Locations cannot be moved to different regions after this step. This includes event items and locations.
 * `set_rules(self)`
   called to set access and item rules on locations and entrances.
 * `connect_entrances(self)`
@@ -501,7 +533,7 @@ In addition, the following methods can be implemented and are called in this ord
   called to modify item placement before, during, and after the regular fill process; all finishing before
   `generate_output`. Any items that need to be placed during `pre_fill` should not exist in the itempool, and if there
   are any items that need to be filled this way, but need to be in state while you fill other items, they can be
-  returned from `get_prefill_items`.
+  returned from `get_pre_fill_items`.
 * `generate_output(self, output_directory: str)`
   creates the output files if there is output to be generated. When this is called,
   `self.multiworld.get_locations(self.player)` has all locations for the player, with attribute `item` pointing to the

inno_setup.iss

@@ -138,11 +138,6 @@ Root: HKCR; Subkey: "{#MyAppName}kdl3patch";                     ValueData: "Arc
 Root: HKCR; Subkey: "{#MyAppName}kdl3patch\DefaultIcon";         ValueData: "{app}\ArchipelagoSNIClient.exe,0";                           ValueType: string;  ValueName: "";
 Root: HKCR; Subkey: "{#MyAppName}kdl3patch\shell\open\command";  ValueData: """{app}\ArchipelagoSNIClient.exe"" ""%1""";                  ValueType: string;  ValueName: "";
 
-Root: HKCR; Subkey: ".apmc";                                     ValueData: "{#MyAppName}mcdata";         Flags: uninsdeletevalue; ValueType: string;  ValueName: "";
-Root: HKCR; Subkey: "{#MyAppName}mcdata";                        ValueData: "Archipelago Minecraft Data"; Flags: uninsdeletekey;   ValueType: string;  ValueName: "";
-Root: HKCR; Subkey: "{#MyAppName}mcdata\DefaultIcon";            ValueData: "{app}\ArchipelagoMinecraftClient.exe,0";                           ValueType: string;  ValueName: "";
-Root: HKCR; Subkey: "{#MyAppName}mcdata\shell\open\command";     ValueData: """{app}\ArchipelagoMinecraftClient.exe"" ""%1""";                  ValueType: string;  ValueName: "";
-
 Root: HKCR; Subkey: ".apz5";                                     ValueData: "{#MyAppName}n64zpf";         Flags: uninsdeletevalue; ValueType: string;  ValueName: "";
 Root: HKCR; Subkey: "{#MyAppName}n64zpf";                        ValueData: "Archipelago Ocarina of Time Patch"; Flags: uninsdeletekey;   ValueType: string;  ValueName: "";
 Root: HKCR; Subkey: "{#MyAppName}n64zpf\DefaultIcon";            ValueData: "{app}\ArchipelagoOoTClient.exe,0";                           ValueType: string;  ValueName: "";

kvui.py

@@ -60,7 +60,10 @@ from kivymd.uix.dialog import MDDialog, MDDialogHeadlineText, MDDialogSupporting
 from kivymd.uix.gridlayout import MDGridLayout
 from kivymd.uix.floatlayout import MDFloatLayout
 from kivymd.uix.boxlayout import MDBoxLayout
-from kivymd.uix.tab.tab import MDTabsSecondary, MDTabsItem, MDTabsItemText, MDTabsCarousel
+from kivymd.uix.navigationbar import MDNavigationBar, MDNavigationItem
+from kivymd.uix.screen import MDScreen
+from kivymd.uix.screenmanager import MDScreenManager
+
 from kivymd.uix.menu import MDDropdownMenu
 from kivymd.uix.menu.menu import MDDropdownTextItem
 from kivymd.uix.dropdownitem import MDDropDownItem, MDDropDownItemText
@@ -726,6 +729,10 @@ class MessageBox(Popup):
         self.height += max(0, label.height - 18)
 
 
+class MDNavigationItemBase(MDNavigationItem):
+    text = StringProperty(None)
+
+
 class ButtonsPrompt(MDDialog):
     def __init__(self, title: str, text: str, response: typing.Callable[[str], None],
                  *prompts: str, **kwargs) -> None:
@@ -766,58 +773,34 @@ class ButtonsPrompt(MDDialog):
         )
 
 
-class ClientTabs(MDTabsSecondary):
-    carousel: MDTabsCarousel
-    lock_swiping = True
+class MDScreenManagerBase(MDScreenManager):
+    current_tab: MDNavigationItemBase
+    local_screen_names: list[str]
 
-    def __init__(self, *args, **kwargs):
-        self.carousel = MDTabsCarousel(lock_swiping=True, anim_move_duration=0.2)
-        super().__init__(*args, MDDivider(size_hint_y=None, height=dp(1)), self.carousel, **kwargs)
-        self.size_hint_y = 1
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.local_screen_names = []
 
-    def _check_panel_height(self, *args):
-        self.ids.tab_scroll.height = dp(38)
-
-    def update_indicator(
-        self, x: float = 0.0, w: float = 0.0, instance: MDTabsItem = None
-    ) -> None:
-        def update_indicator(*args):
-            indicator_pos = (0, 0)
-            indicator_size = (0, 0)
-
-            item_text_object = self._get_tab_item_text_icon_object()
-
-            if item_text_object:
-                indicator_pos = (
-                    instance.x + dp(12),
-                    self.indicator.pos[1]
-                    if not self._tabs_carousel
-                    else self._tabs_carousel.height,
-                )
-                indicator_size = (
-                    instance.width - dp(24),
-                    self.indicator_height,
-                )
-
-            Animation(
-                pos=indicator_pos,
-                size=indicator_size,
-                d=0 if not self.indicator_anim else self.indicator_duration,
-                t=self.indicator_transition,
-            ).start(self.indicator)
-
-        if not instance:
-            self.indicator.pos = (x, self.indicator.pos[1])
-            self.indicator.size = (w, self.indicator_height)
+    def add_widget(self, widget: Widget, *args, **kwargs) -> None:
+        super().add_widget(widget, *args, **kwargs)
+        if "index" in kwargs:
+            self.local_screen_names.insert(kwargs["index"], widget.name)
         else:
-            Clock.schedule_once(update_indicator)
+            self.local_screen_names.append(widget.name)
 
-    def remove_tab(self, tab, content=None):
-        if content is None:
-            content = tab.content
-        self.ids.container.remove_widget(tab)
-        self.carousel.remove_widget(content)
-        self.on_size(self, self.size)
+    def switch_screens(self, new_tab: MDNavigationItemBase) -> None:
+        """
+        Called whenever the user clicks a tab to switch to a different screen.
+
+        :param new_tab: The new screen to switch to's tab.
+        """
+        name = new_tab.text
+        if self.local_screen_names.index(name) > self.local_screen_names.index(self.current_screen.name):
+            self.transition.direction = "left"
+        else:
+            self.transition.direction = "right"
+        self.current = name
+        self.current_tab = new_tab
 
 
 class CommandButton(MDButton, MDTooltip):
@@ -845,6 +828,9 @@ class GameManager(ThemedApp):
     main_area_container: MDGridLayout
     """ subclasses can add more columns beside the tabs """
 
+    tabs: MDNavigationBar
+    screens: MDScreenManagerBase
+
     def __init__(self, ctx: context_type):
         self.title = self.base_title
         self.ctx = ctx
@@ -874,7 +860,7 @@ class GameManager(ThemedApp):
     @property
     def tab_count(self):
         if hasattr(self, "tabs"):
-            return max(1, len(self.tabs.tab_list))
+            return max(1, len(self.tabs.children))
         return 1
 
     def on_start(self):
@@ -914,30 +900,32 @@ class GameManager(ThemedApp):
         self.grid.add_widget(self.progressbar)
 
         # middle part
-        self.tabs = ClientTabs(pos_hint={"center_x": 0.5, "center_y": 0.5})
-        self.tabs.add_widget(MDTabsItem(MDTabsItemText(text="All" if len(self.logging_pairs) > 1 else "Archipelago")))
-        self.log_panels["All"] = self.tabs.default_tab_content = UILog(*(logging.getLogger(logger_name)
-                                                                             for logger_name, name in
-                                                                             self.logging_pairs))
-        self.tabs.carousel.add_widget(self.tabs.default_tab_content)
+        self.screens = MDScreenManagerBase(pos_hint={"center_x": 0.5})
+        self.tabs = MDNavigationBar(orientation="horizontal", size_hint_y=None, height=dp(40), set_bars_color=True)
+        # bind the method to the bar for back compatibility
+        self.tabs.remove_tab = self.remove_client_tab
+        self.screens.current_tab = self.add_client_tab(
+            "All" if len(self.logging_pairs) > 1 else "Archipelago",
+            UILog(*(logging.getLogger(logger_name) for logger_name, name in self.logging_pairs)),
+        )
+        self.log_panels["All"] = self.screens.current_tab.content
+        self.screens.current_tab.active = True
 
         for logger_name, display_name in self.logging_pairs:
             bridge_logger = logging.getLogger(logger_name)
             self.log_panels[display_name] = UILog(bridge_logger)
             if len(self.logging_pairs) > 1:
-                panel = MDTabsItem(MDTabsItemText(text=display_name))
-                panel.content = self.log_panels[display_name]
-                # show Archipelago tab if other logging is present
-                self.tabs.carousel.add_widget(panel.content)
-                self.tabs.add_widget(panel)
+                self.add_client_tab(display_name, self.log_panels[display_name])
 
-        hint_panel = self.add_client_tab("Hints", HintLayout())
         self.hint_log = HintLog(self.json_to_kivy_parser)
+        hint_panel = self.add_client_tab("Hints", HintLayout(self.hint_log))
         self.log_panels["Hints"] = hint_panel.content
-        hint_panel.content.add_widget(self.hint_log)
 
         self.main_area_container = MDGridLayout(size_hint_y=1, rows=1)
-        self.main_area_container.add_widget(self.tabs)
+        tab_container = MDGridLayout(size_hint_y=1, cols=1)
+        tab_container.add_widget(self.tabs)
+        tab_container.add_widget(self.screens)
+        self.main_area_container.add_widget(tab_container)
 
         self.grid.add_widget(self.main_area_container)
 
@@ -974,25 +962,61 @@ class GameManager(ThemedApp):
 
         return self.container
 
-    def add_client_tab(self, title: str, content: Widget, index: int = -1) -> Widget:
-        """Adds a new tab to the client window with a given title, and provides a given Widget as its content.
-         Returns the new tab widget, with the provided content being placed on the tab as content."""
-        new_tab = MDTabsItem(MDTabsItemText(text=title))
+    def add_client_tab(self, title: str, content: Widget, index: int = -1) -> MDNavigationItemBase:
+        """
+        Adds a new tab to the client window with a given title, and provides a given Widget as its content.
+        Returns the new tab widget, with the provided content being placed on the tab as content.
+
+        :param title: The title of the tab.
+        :param content: The Widget to be added as content for this tab's new MDScreen. Will also be added to the
+         returned tab as tab.content.
+        :param index: The index to insert the tab at. Defaults to -1, meaning the tab will be appended to the end.
+
+        :return: The new tab.
+        """
+        if self.tabs.children:
+            self.tabs.add_widget(MDDivider(orientation="vertical"))
+        new_tab = MDNavigationItemBase(text=title)
         new_tab.content = content
-        if -1 < index <= len(self.tabs.carousel.slides):
-            new_tab.bind(on_release=self.tabs.set_active_item)
-            new_tab._tabs = self.tabs
-            self.tabs.ids.container.add_widget(new_tab, index=index)
-            self.tabs.carousel.add_widget(new_tab.content, index=len(self.tabs.carousel.slides) - index)
+        new_screen = MDScreen(name=title)
+        new_screen.add_widget(content)
+        if -1 < index <= len(self.tabs.children):
+            remapped_index = len(self.tabs.children) - index
+            self.tabs.add_widget(new_tab, index=remapped_index)
+            self.screens.add_widget(new_screen, index=index)
         else:
             self.tabs.add_widget(new_tab)
-            self.tabs.carousel.add_widget(new_tab.content)
+            self.screens.add_widget(new_screen)
         return new_tab
 
+    def remove_client_tab(self, tab: MDNavigationItemBase) -> None:
+        """
+        Called to remove a tab and its screen.
+
+        :param tab: The tab to remove.
+        """
+        tab_index = self.tabs.children.index(tab)
+        # if the tab is currently active we need to swap before removing it
+        if tab == self.screens.current_tab:
+            if not tab_index:
+                # account for the divider
+                swap_index = tab_index + 2
+            else:
+                swap_index = tab_index - 2
+            self.tabs.children[swap_index].on_release()
+            # self.screens.switch_screens(self.tabs.children[swap_index])
+        # get the divider to the left if we can
+        if not tab_index:
+            divider_index = tab_index + 1
+        else:
+            divider_index = tab_index - 1
+        self.tabs.remove_widget(self.tabs.children[divider_index])
+        self.tabs.remove_widget(tab)
+        self.screens.remove_widget(self.screens.get_screen(tab.text))
+
     def update_texts(self, dt):
-        for slide in self.tabs.carousel.slides:
-            if hasattr(slide, "fix_heights"):
-                slide.fix_heights()  # TODO: remove this when Kivy fixes this upstream
+        if hasattr(self.screens.current_tab.content, "fix_heights"):
+            getattr(self.screens.current_tab.content, "fix_heights")()
         if self.ctx.server:
             self.title = self.base_title + " " + Utils.__version__ + \
                          f" | Connected to: {self.ctx.server_address} " \

setup.py

@@ -63,7 +63,6 @@ non_apworlds: set[str] = {
     "Adventure",
     "ArchipIDLE",
     "Archipelago",
-    "Clique",
     "Lufia II Ancient Cave",
     "Meritous",
     "Ocarina of Time",

test/general/test_implemented.py

@@ -1,7 +1,7 @@
 import unittest
 
 from Fill import distribute_items_restrictive
-from NetUtils import encode
+from NetUtils import convert_to_base_types
 from worlds.AutoWorld import AutoWorldRegister, call_all
 from worlds import failed_world_loads
 from . import setup_solo_multiworld
@@ -47,7 +47,7 @@ class TestImplemented(unittest.TestCase):
                 call_all(multiworld, "post_fill")
                 for key, data in multiworld.worlds[1].fill_slot_data().items():
                     self.assertIsInstance(key, str, "keys in slot data must be a string")
-                    self.assertIsInstance(encode(data), str, f"object {type(data).__name__} not serializable.")
+                    convert_to_base_types(data)  # only put base data types into slot data
 
     def test_no_failed_world_loads(self):
         if failed_world_loads:

test/hosting/__main__.py

@@ -63,12 +63,12 @@ if __name__ == "__main__":
     spacer = '=' * 80
 
     with TemporaryDirectory() as tempdir:
-        multis = [["Clique"], ["Temp World"], ["Clique", "Temp World"]]
+        multis = [["VVVVVV"], ["Temp World"], ["VVVVVV", "Temp World"]]
         p1_games = []
         data_paths = []
         rooms = []
 
-        copy_world("Clique", "Temp World")
+        copy_world("VVVVVV", "Temp World")
         try:
             for n, games in enumerate(multis, 1):
                 print(f"Generating [{n}] {', '.join(games)}")
@@ -101,7 +101,7 @@ if __name__ == "__main__":
                         with Client(host.address, game, "Player1") as client:
                             local_data_packages = client.games_packages
                             local_collected_items = len(client.checked_locations)
-                            if collected_items < 2:  # Clique only has 2 Locations
+                            if collected_items < 2:  # Don't collect anything on the last iteration
                                 client.collect_any()
                             # TODO: Ctrl+C test here as well
 
@@ -125,7 +125,7 @@ if __name__ == "__main__":
                         with Client(host.address, game, "Player1") as client:
                             web_data_packages = client.games_packages
                             web_collected_items = len(client.checked_locations)
-                            if collected_items < 2:  # Clique only has 2 Locations
+                            if collected_items < 2:  # Don't collect anything on the last iteration
                                 client.collect_any()
                             if collected_items == 1:
                                 sleep(1)  # wait for the server to collect the item

test/hosting/generate.py

@@ -34,7 +34,7 @@ def _generate_local_inner(games: Iterable[str],
                         f.write(json.dumps({
                             "name": f"Player{n}",
                             "game": game,
-                            game: {"hard_mode": "true"},
+                            game: {},
                             "description": f"generate_local slot {n} ('Player{n}'): {game}",
                         }))
 

test/hosting/world.py

@@ -30,7 +30,7 @@ def copy(src: str, dst: str) -> None:
     _new_worlds[dst] = str(dst_folder)
     with open(dst_folder / "__init__.py", "r", encoding="utf-8-sig") as f:
         contents = f.read()
-    contents = re.sub(r'game\s*=\s*[\'"]' + re.escape(src) + r'[\'"]', f'game = "{dst}"', contents)
+    contents = re.sub(r'game\s*(:\s*[a-zA-Z\[\]]+)?\s*=\s*[\'"]' + re.escape(src) + r'[\'"]', f'game = "{dst}"', contents)
     with open(dst_folder / "__init__.py", "w", encoding="utf-8") as f:
         f.write(contents)
 

worlds/AutoWorld.py

@@ -382,7 +382,7 @@ class World(metaclass=AutoWorldRegister):
     def create_items(self) -> None:
         """
         Method for creating and submitting items to the itempool. Items and Regions must *not* be created and submitted
-        to the MultiWorld after this step. If items need to be placed during pre_fill use `get_prefill_items`.
+        to the MultiWorld after this step. If items need to be placed during pre_fill use `get_pre_fill_items`.
         """
         pass
 

worlds/Files.py

@@ -158,6 +158,7 @@ class APContainer:
 class APPlayerContainer(APContainer):
     """A zipfile containing at least archipelago.json meant for a player"""
     game: ClassVar[Optional[str]] = None
+    patch_file_ending: str = ""
 
     player: Optional[int]
     player_name: str
@@ -184,6 +185,7 @@ class APPlayerContainer(APContainer):
             "player": self.player,
             "player_name": self.player_name,
             "game": self.game,
+            "patch_file_ending": self.patch_file_ending,
         })
         return manifest
 
@@ -223,7 +225,6 @@ class APProcedurePatch(APAutoPatchInterface):
     """
     hash: Optional[str]  # base checksum of source file
     source_data: bytes
-    patch_file_ending: str = ""
     files: Dict[str, bytes]
 
     @classmethod
@@ -245,7 +246,6 @@ class APProcedurePatch(APAutoPatchInterface):
         manifest = super(APProcedurePatch, self).get_manifest()
         manifest["base_checksum"] = self.hash
         manifest["result_file_ending"] = self.result_file_ending
-        manifest["patch_file_ending"] = self.patch_file_ending
         manifest["procedure"] = self.procedure
         if self.procedure == APDeltaPatch.procedure:
             manifest["compatible_version"] = 5

worlds/LauncherComponents.py

@@ -210,16 +210,17 @@ components: List[Component] = [
     Component('Launcher', 'Launcher', component_type=Type.HIDDEN),
     # Core
     Component('Host', 'MultiServer', 'ArchipelagoServer', cli=True,
-              file_identifier=SuffixIdentifier('.archipelago', '.zip')),
-    Component('Generate', 'Generate', cli=True),
-    Component("Install APWorld", func=install_apworld, file_identifier=SuffixIdentifier(".apworld")),
-    Component('Text Client', 'CommonClient', 'ArchipelagoTextClient', func=launch_textclient),
+              file_identifier=SuffixIdentifier('.archipelago', '.zip'),
+              description="Host a generated multiworld on your computer."),
+    Component('Generate', 'Generate', cli=True,
+              description="Generate a multiworld with the YAMLs in the players folder."),
+    Component("Install APWorld", func=install_apworld, file_identifier=SuffixIdentifier(".apworld"),
+              description="Install an APWorld to play games not included with Archipelago by default."),
+    Component('Text Client', 'CommonClient', 'ArchipelagoTextClient', func=launch_textclient,
+              description="Connect to a multiworld using the text client."),
     Component('Links Awakening DX Client', 'LinksAwakeningClient',
               file_identifier=SuffixIdentifier('.apladx')),
     Component('LttP Adjuster', 'LttPAdjuster'),
-    # Minecraft
-    Component('Minecraft Client', 'MinecraftClient', icon='mcicon', cli=True,
-              file_identifier=SuffixIdentifier('.apmc')),
     # Ocarina of Time
     Component('OoT Client', 'OoTClient',
               file_identifier=SuffixIdentifier('.apz5')),
@@ -242,6 +243,5 @@ components: List[Component] = [
 # if registering an icon from within an apworld, the format "ap:module.name/path/to/file.png" can be used
 icon_paths = {
     'icon': local_path('data', 'icon.png'),
-    'mcicon': local_path('data', 'mcicon.png'),
     'discord': local_path('data', 'discord-mark-blue.png'),
 }

worlds/_bizhawk/client.py

@@ -19,7 +19,8 @@ def launch_client(*args) -> None:
 
 
 component = Component("BizHawk Client", "BizHawkClient", component_type=Type.CLIENT, func=launch_client,
-                      file_identifier=SuffixIdentifier())
+                      file_identifier=SuffixIdentifier(),
+                      description="Open the BizHawk client, to play games using the Bizhawk emulator.")
 components.append(component)
 
 

worlds/alttp/ItemPool.py

@@ -548,10 +548,12 @@ def set_up_take_anys(multiworld, world, player):
     old_man_take_any.shop = TakeAny(old_man_take_any, 0x0112, 0xE2, True, True, total_shop_slots)
     multiworld.shops.append(old_man_take_any.shop)
 
-    swords = [item for item in multiworld.itempool if item.player == player and item.type == 'Sword']
-    if swords:
-        sword = multiworld.random.choice(swords)
-        multiworld.itempool.remove(sword)
+    sword_indices = [
+        index for index, item in enumerate(multiworld.itempool) if item.player == player and item.type == 'Sword'
+    ]
+    if sword_indices:
+        sword_index = multiworld.random.choice(sword_indices)
+        sword = multiworld.itempool.pop(sword_index)
         multiworld.itempool.append(item_factory('Rupees (20)', world))
         old_man_take_any.shop.add_inventory(0, sword.name, 0, 0)
         loc_name = "Old Man Sword Cave"

worlds/alttp/test/options/test_dungeon_fill.py

@@ -38,7 +38,7 @@ class DungeonFillTestBase(TestCase):
     def test_original_dungeons(self):
         self.generate_with_options(DungeonItem.option_original_dungeon)
         for location in self.multiworld.get_filled_locations():
-            with (self.subTest(location=location)):
+            with (self.subTest(location_name=location.name)):
                 if location.parent_region.dungeon is None:
                     self.assertIs(location.item.dungeon, None)
                 else:
@@ -52,7 +52,7 @@ class DungeonFillTestBase(TestCase):
     def test_own_dungeons(self):
         self.generate_with_options(DungeonItem.option_own_dungeons)
         for location in self.multiworld.get_filled_locations():
-            with self.subTest(location=location):
+            with self.subTest(location_name=location.name):
                 if location.parent_region.dungeon is None:
                     self.assertIs(location.item.dungeon, None)
                 else:

worlds/aquaria/Regions.py

@@ -4,7 +4,7 @@ Date: Fri, 15 Mar 2024 18:41:40 +0000
 Description: Used to manage Regions in the Aquaria game multiworld randomizer
 """
 
-from typing import Dict, Optional
+from typing import Dict, Optional, Iterable
 from BaseClasses import MultiWorld, Region, Entrance, Item, ItemClassification, CollectionState
 from .Items import AquariaItem, ItemNames
 from .Locations import AquariaLocations, AquariaLocation, AquariaLocationNames
@@ -34,10 +34,15 @@ def _has_li(state: CollectionState, player: int) -> bool:
     return state.has(ItemNames.LI_AND_LI_SONG, player)
 
 
-def _has_damaging_item(state: CollectionState, player: int) -> bool:
-    """`player` in `state` has the shield song item"""
-    return state.has_any({ItemNames.ENERGY_FORM, ItemNames.NATURE_FORM, ItemNames.BEAST_FORM, ItemNames.LI_AND_LI_SONG,
-                          ItemNames.BABY_NAUTILUS, ItemNames.BABY_PIRANHA, ItemNames.BABY_BLASTER}, player)
+DAMAGING_ITEMS:Iterable[str] = [
+    ItemNames.ENERGY_FORM, ItemNames.NATURE_FORM, ItemNames.BEAST_FORM,
+    ItemNames.LI_AND_LI_SONG, ItemNames.BABY_NAUTILUS, ItemNames.BABY_PIRANHA,
+    ItemNames.BABY_BLASTER
+]
+
+def _has_damaging_item(state: CollectionState, player: int, damaging_items:Iterable[str] = DAMAGING_ITEMS) -> bool:
+    """`player` in `state` has the an item that do damage other than the ones in `to_remove`"""
+    return state.has_any(damaging_items, player)
 
 
 def _has_energy_attack_item(state: CollectionState, player: int) -> bool:
@@ -566,9 +571,11 @@ class AquariaRegions:
         self.__connect_one_way_regions(self.openwater_tr, self.openwater_tr_turtle,
                                        lambda state: _has_beast_form_or_arnassi_armor(state, self.player))
         self.__connect_one_way_regions(self.openwater_tr_turtle, self.openwater_tr)
+        damaging_items_minus_nature_form = [item for item in DAMAGING_ITEMS if item != ItemNames.NATURE_FORM]
         self.__connect_one_way_regions(self.openwater_tr, self.openwater_tr_urns,
                                        lambda state: _has_bind_song(state, self.player) or
-                                                     _has_damaging_item(state, self.player))
+                                                     _has_damaging_item(state, self.player,
+                                                                        damaging_items_minus_nature_form))
         self.__connect_regions(self.openwater_tr, self.openwater_br)
         self.__connect_regions(self.openwater_tr, self.mithalas_city)
         self.__connect_regions(self.openwater_tr, self.veil_b)

worlds/civ_6/Container.py

@@ -1,10 +1,9 @@
 from dataclasses import dataclass
 import os
-import io
 from typing import TYPE_CHECKING, Dict, List, Optional, cast
 import zipfile
 from BaseClasses import Location
-from worlds.Files import APContainer, AutoPatchRegister
+from worlds.Files import APPlayerContainer
 
 from .Enum import CivVICheckType
 from .Locations import CivVILocation, CivVILocationData
@@ -26,22 +25,19 @@ class CivTreeItem:
     ui_tree_row: int
 
 
-class CivVIContainer(APContainer, metaclass=AutoPatchRegister):
+class CivVIContainer(APPlayerContainer):
     """
     Responsible for generating the dynamic mod files for the Civ VI multiworld
     """
     game: Optional[str] = "Civilization VI"
     patch_file_ending = ".apcivvi"
 
-    def __init__(self, patch_data: Dict[str, str] | io.BytesIO, base_path: str = "", output_directory: str = "",
+    def __init__(self, patch_data: Dict[str, str], base_path: str = "", output_directory: str = "",
                  player: Optional[int] = None, player_name: str = "", server: str = ""):
-        if isinstance(patch_data, io.BytesIO):
-            super().__init__(patch_data, player, player_name, server)
-        else:
-            self.patch_data = patch_data
-            self.file_path = base_path
-            container_path = os.path.join(output_directory, base_path + ".apcivvi")
-            super().__init__(container_path, player, player_name, server)
+        self.patch_data = patch_data
+        self.file_path = base_path
+        container_path = os.path.join(output_directory, base_path + ".apcivvi")
+        super().__init__(container_path, player, player_name, server)
 
     def write_contents(self, opened_zipfile: zipfile.ZipFile) -> None:
         for filename, yml in self.patch_data.items():

worlds/civ_6/data/boosts.py

@@ -78,8 +78,8 @@ boosts: List[CivVIBoostData] = [
     CivVIBoostData(
         "BOOST_TECH_IRON_WORKING",
         "ERA_CLASSICAL",
-        ["TECH_MINING"],
-        1,
+        ["TECH_MINING", "TECH_BRONZE_WORKING"],
+        2,
         "DEFAULT",
     ),
     CivVIBoostData(
@@ -165,15 +165,9 @@ boosts: List[CivVIBoostData] = [
         "BOOST_TECH_CASTLES",
         "ERA_MEDIEVAL",
         [
-            "CIVIC_DIVINE_RIGHT",
-            "CIVIC_EXPLORATION",
-            "CIVIC_REFORMED_CHURCH",
             "CIVIC_SUFFRAGE",
             "CIVIC_TOTALITARIANISM",
             "CIVIC_CLASS_STRUGGLE",
-            "CIVIC_DIGITAL_DEMOCRACY",
-            "CIVIC_CORPORATE_LIBERTARIANISM",
-            "CIVIC_SYNTHETIC_TECHNOCRACY",
         ],
         1,
         "DEFAULT",
@@ -393,9 +387,6 @@ boosts: List[CivVIBoostData] = [
             "CIVIC_SUFFRAGE",
             "CIVIC_TOTALITARIANISM",
             "CIVIC_CLASS_STRUGGLE",
-            "CIVIC_DIGITAL_DEMOCRACY",
-            "CIVIC_CORPORATE_LIBERTARIANISM",
-            "CIVIC_SYNTHETIC_TECHNOCRACY",
         ],
         1,
         "DEFAULT",

worlds/civ_6/docs/en_Civilization VI.md

@@ -20,16 +20,17 @@ A short period after receiving an item, you will get a notification indicating y
 
 ## FAQs
 - Do I need the DLC to play this?
-    - Yes, you need both Rise & Fall and Gathering Storm.
+    - You need both expansions, Rise & Fall and Gathering Storm. You do not need the other DLCs but they fully work with this.
 - Does this work with Multiplayer?
     - It does not and, despite my best efforts, probably won't until there's a new way for external programs to be able to interact with the game.
-- Does my mod that reskins Barbarians as various Pro Wrestlers work with this?
-    - Only one way to find out! Any mods that modify techs/civics will most likely cause issues, though.
+- Does this work with other mods?
+    - A lot of mods seem to work without issues combined with this, but you should avoid any mods that change things in the tech or civic tree, as even if they would work it could cause issues with the logic.
 - "Help! I can't see any of the items that have been sent to me!"
     - Both trees by default will show you the researchable Archipelago locations. To view the normal tree, you can click "Toggle Archipelago Tree" in the top-left corner of the tree view.
 - "Oh no! I received the Machinery tech and now instead of getting an Archer next turn, I have to wait an additional 10 turns to get a Crossbowman!"
     - Vanilla prevents you from building units of the same class from an earlier tech level after you have researched a later variant. For example, this could be problematic if someone unlocks Crossbowmen for you right out the gate since you won't be able to make Archers (which have a much lower production cost).
-Solution: You can now go in to the tech tree, click "Toggle Archipelago Tree" to view your unlocked techs, and then can click any tech you have unlocked to toggle whether it is currently active or not.
+    - Solution: You can now go in to the tech tree, click "Toggle Archipelago Tree" to view your unlocked techs, and then can click any tech you have unlocked to toggle whether it is currently active or not.
+	- If you think you should be able to make Field Cannons but seemingly can't try disabling `Telecommunications`
 - "How does DeathLink work? Am I going to have to start a new game every time one of my friends dies?"
     - Heavens no, my fellow Archipelago appreciator. When configuring your Archipelago options for Civilization on the options page, there are several choices available for you to fine tune the way you'd like to be punished for the follies of your friends. These include: Having a random unit destroyed, losing a percentage of gold or faith, or even losing a point on your era score. If you can't make up your mind, you can elect to have any of them be selected every time a death link is sent your way.
     In the event you lose one of your units in combat (this means captured units don't count), then you will send a death link event to the rest of your friends.
@@ -39,7 +40,8 @@ Solution: You can now go in to the tech tree, click "Toggle Archipelago Tree" to
           1. `TECH_WRITING`
           2. `TECH_EDUCATION`
           3. `TECH_CHEMISTRY`
-    - If you want to see the details around each item, you can review [this file](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/civ_6/data/progressive_districts.json).
+	- An important thing to note is that the seaport is part of progressive industrial zones, due to electricity having both an industrial zone building and the seaport.
+    - If you want to see the details around each item, you can review [this file](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/civ_6/data/progressive_districts.py).
 
 ## Boostsanity
 Boostsanity takes all of the Eureka & Inspiration events and makes them location checks. This feature is the one to change up the way Civilization is played in an AP multiworld/randomizer. What normally are mundane tasks that are passively collected now become a novel and interesting bucket list that you need to pay attention to  in order to unlock items for yourself and others!
@@ -56,4 +58,3 @@ Boosts have logic associated with them in order to verify you can always reach t
     - The unpredictable timing of boosts and unlocking them can occasionally lead to scenarios where you'll have to first encounter a locked era defeat and then load a previous save. To help reduce the frequency of this, local `PROGRESSIVE_ERA` items will never be located at a boost check.
 - There's too many boosts, how will I know which one's I should focus on?!
     - In order to give a little more focus to all the boosts rather than just arbitrarily picking them at random, items in both of the vanilla trees will now have an advisor icon on them if its associated boost contains a progression item.
-

worlds/civ_6/docs/setup_en.md

@@ -6,12 +6,14 @@ This guide is meant to help you get up and running with Civilization VI in Archi
 
 The following are required in order to play Civ VI in Archipelago:
 
-- Windows OS (Firaxis does not support the necessary tooling for Mac, or Linux)
+- Windows OS (Firaxis does not support the necessary tooling for Mac, or Linux).
 
-- Installed [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases) v0.4.5 or higher.
+- Installed [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases).
 
 - The latest version of the [Civ VI AP Mod](https://github.com/hesto2/civilization_archipelago_mod/releases/latest).
 
+- A copy of the game `Civilization VI` including the two expansions `Rise & Fall` and `Gathering Storm` (both the Steam and Epic version should work).
+
 ## Enabling the tuner
 
 In the main menu, navigate to the "Game Options" page. On the "Game" menu, make sure that "Tuner (disables achievements)" is enabled.
@@ -20,27 +22,32 @@ In the main menu, navigate to the "Game Options" page. On the "Game" menu, make
 
 1. Download and unzip the latest release of the mod from [GitHub](https://github.com/hesto2/civilization_archipelago_mod/releases/latest).
 
-2. Copy the folder containing the mod files to your Civ VI mods folder. On Windows, this is usually located at `C:\Users\YOUR_USER\Documents\My Games\Sid Meier's Civilization VI\Mods`. If you use OneDrive, check if the folder is instead located in your OneDrive file structure.
+2. Copy the folder containing the mod files to your Civ VI mods folder. On Windows, this is usually located at `C:\Users\YOUR_USER\Documents\My Games\Sid Meier's Civilization VI\Mods`. If you use OneDrive, check if the folder is instead located in your OneDrive file structure, and use that path when relevant in future steps.
 
 3. After the Archipelago host generates a game, you should be given a `.apcivvi` file. Associate the file with the Archipelago Launcher and double click it.
 
-4. Copy the contents of the new folder it generates (it will have the same name as the `.apcivvi` file) into your Civilization VI Archipelago Mod folder. If double clicking the `.apcivvi` file doesn't generate a folder, you can just rename it to a file ending with `.zip` and extract its contents to a new folder. To do this, right click the `.apcivvi` file and click "Rename", make sure it ends in `.zip`, then right click it again and select "Extract All".
+4. Copy the contents of the new folder it generates (it will have the same name as the `.apcivvi` file) into your Civilization VI Archipelago Mod folder. If double clicking the `.apcivvi` file doesn't generate a folder, you can instead open it as a zip file. You can do this by either right clicking it and opening it with a program that handles zip files, or by right clicking and renaming the file extension from `apcivvi` to `zip`.
 
-5. Your finished mod folder should look something like this:
-
-- Civ VI Mods Directory
-  - civilization_archipelago_mod
-    - NewItems.xml
-    - InitOptions.lua
-    - Archipelago.modinfo
-    - All the other mod files, etc.
+5. Place the files generated from the `.apcivvi` in your archipelago mod folder (there should be five files placed there from the apcivvi file, overwrite if asked). Your mod path should look something like `C:\Users\YOUR_USER\Documents\My Games\Sid Meier's Civilization VI\Mods\civilization_archipelago_mod`. 
 
 ## Configuring your game
 
-When configuring your game, make sure to start the game in the Ancient Era and leave all settings related to starting technologies and civics as the defaults. Other than that, configure difficulty, AI, etc. as you normally would.
+Make sure you enable the mod in the main title under Additional Content > Mods. When configuring your game, make sure to start the game in the Ancient Era and leave all settings related to starting technologies and civics as the defaults. Other than that, configure difficulty, AI, etc. as you normally would.
 
 ## Troubleshooting
 
+- If you have troubles with file extension related stuff, make sure Windows shows file extensions as they are turned off by default. If you don't know how to turn them on it is just a quick google search away.
+
 - If you are getting an error: "The remote computer refused the network connection", or something else related to the client (or tuner) not being able to connect, it likely indicates the tuner is not actually enabled. One simple way to verify that it is enabled is, after completing the setup steps, go to Main Menu → Options → Look for an option named "Tuner" and verify it is set to "Enabled"
 
-- If your game gets in a state where someone has sent you items or you have sent locations but these are not correctly sent to the multiworld, you can run `/resync` from the Civ 6 client. This may take up to a minute depending on how many items there are.
+- If your game gets in a state where someone has sent you items or you have sent locations but these are not correctly sent to the multiworld, you can run `/resync` from the Civ 6 client. This may take up to a minute depending on how many items there are. This can resend certain items to you, like one time bonuses.
+
+- If the archipelago mod does not appear in the mod selector in the game, make sure the mod is correctly placed as a folder in the `Sid Meier's Civilization VI\Mods` folder, there should not be any loose files in there only folders. As in the path should look something like `C:\Users\YOUR_USER\Documents\My Games\Sid Meier's Civilization VI\Mods\civilization_archipelago_mod`.
+
+- If it still does not appear make sure you have the right folder, one way to verify you are in the right place is to find the general folder area where your Civ VI save files are located.
+
+- If you get an error when trying to start a game saying `Error - One or more Mods failed to load content`, make sure the files from the `.apcivvi` are placed into the `civilization_archipelago_mod` as loose files and not as a folder.
+
+- If you still have any errors make sure the two expansions Rise & Fall and Gathering Storm are active in the mod selector (all the official DLC works without issues but Rise & Fall and Gathering Storm are required for the mod).
+
+- If boostsanity is enabled and those items are not being sent out but regular techs are, make sure you placed the files from your new room in the mod folder.

worlds/clique/Items.py

@@ -1,38 +0,0 @@
-from typing import Callable, Dict, NamedTuple, Optional, TYPE_CHECKING
-
-from BaseClasses import Item, ItemClassification
-
-if TYPE_CHECKING:
-    from . import CliqueWorld
-
-
-class CliqueItem(Item):
-    game = "Clique"
-
-
-class CliqueItemData(NamedTuple):
-    code: Optional[int] = None
-    type: ItemClassification = ItemClassification.filler
-    can_create: Callable[["CliqueWorld"], bool] = lambda world: True
-
-
-item_data_table: Dict[str, CliqueItemData] = {
-    "Feeling of Satisfaction": CliqueItemData(
-        code=69696969,
-        type=ItemClassification.progression,
-    ),
-    "Button Activation": CliqueItemData(
-        code=69696968,
-        type=ItemClassification.progression,
-        can_create=lambda world: world.options.hard_mode,
-    ),
-    "A Cool Filler Item (No Satisfaction Guaranteed)": CliqueItemData(
-        code=69696967,
-        can_create=lambda world: False  # Only created from `get_filler_item_name`.
-    ),
-    "The Urge to Push": CliqueItemData(
-        type=ItemClassification.progression,
-    ),
-}
-
-item_table = {name: data.code for name, data in item_data_table.items() if data.code is not None}

worlds/clique/Locations.py

@@ -1,37 +0,0 @@
-from typing import Callable, Dict, NamedTuple, Optional, TYPE_CHECKING
-
-from BaseClasses import Location
-
-if TYPE_CHECKING:
-    from . import CliqueWorld
-
-
-class CliqueLocation(Location):
-    game = "Clique"
-
-
-class CliqueLocationData(NamedTuple):
-    region: str
-    address: Optional[int] = None
-    can_create: Callable[["CliqueWorld"], bool] = lambda world: True
-    locked_item: Optional[str] = None
-
-
-location_data_table: Dict[str, CliqueLocationData] = {
-    "The Big Red Button": CliqueLocationData(
-        region="The Button Realm",
-        address=69696969,
-    ),
-    "The Item on the Desk": CliqueLocationData(
-        region="The Button Realm",
-        address=69696968,
-        can_create=lambda world: world.options.hard_mode,
-    ),
-    "In the Player's Mind": CliqueLocationData(
-        region="The Button Realm",
-        locked_item="The Urge to Push",
-    ),
-}
-
-location_table = {name: data.address for name, data in location_data_table.items() if data.address is not None}
-locked_locations = {name: data for name, data in location_data_table.items() if data.locked_item}

worlds/clique/Options.py

@@ -1,34 +0,0 @@
-from dataclasses import dataclass
-from Options import Choice, Toggle, PerGameCommonOptions, StartInventoryPool
-
-
-class HardMode(Toggle):
-    """Only for the most masochistically inclined... Requires button activation!"""
-    display_name = "Hard Mode"
-
-
-class ButtonColor(Choice):
-    """Customize your button! Now available in 12 unique colors."""
-    display_name = "Button Color"
-    option_red = 0
-    option_orange = 1
-    option_yellow = 2
-    option_green = 3
-    option_cyan = 4
-    option_blue = 5
-    option_magenta = 6
-    option_purple = 7
-    option_pink = 8
-    option_brown = 9
-    option_white = 10
-    option_black = 11
-
-
-@dataclass
-class CliqueOptions(PerGameCommonOptions):
-    color: ButtonColor
-    hard_mode: HardMode
-    start_inventory_from_pool: StartInventoryPool
-
-    # DeathLink is always on. Always.
-    # death_link: DeathLink

worlds/clique/Regions.py

@@ -1,11 +0,0 @@
-from typing import Dict, List, NamedTuple
-
-
-class CliqueRegionData(NamedTuple):
-    connecting_regions: List[str] = []
-
-
-region_data_table: Dict[str, CliqueRegionData] = {
-    "Menu": CliqueRegionData(["The Button Realm"]),
-    "The Button Realm": CliqueRegionData(),
-}

worlds/clique/Rules.py

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

worlds/clique/__init__.py

@@ -1,102 +0,0 @@
-from typing import List, Dict, Any
-
-from BaseClasses import Region, Tutorial
-from worlds.AutoWorld import WebWorld, World
-from .Items import CliqueItem, item_data_table, item_table
-from .Locations import CliqueLocation, location_data_table, location_table, locked_locations
-from .Options import CliqueOptions
-from .Regions import region_data_table
-from .Rules import get_button_rule
-
-
-class CliqueWebWorld(WebWorld):
-    theme = "partyTime"
-    
-    setup_en = Tutorial(
-        tutorial_name="Start Guide",
-        description="A guide to playing Clique.",
-        language="English",
-        file_name="guide_en.md",
-        link="guide/en",
-        authors=["Phar"]
-    )
-
-    setup_de = Tutorial(
-        tutorial_name="Anleitung zum Anfangen",
-        description="Eine Anleitung um Clique zu spielen.",
-        language="Deutsch",
-        file_name="guide_de.md",
-        link="guide/de",
-        authors=["Held_der_Zeit"]
-    )
-    
-    tutorials = [setup_en, setup_de]
-    game_info_languages = ["en", "de"]
-
-
-class CliqueWorld(World):
-    """The greatest game of all time."""
-
-    game = "Clique"
-    web = CliqueWebWorld()
-    options: CliqueOptions
-    options_dataclass = CliqueOptions
-    location_name_to_id = location_table
-    item_name_to_id = item_table
-
-    def create_item(self, name: str) -> CliqueItem:
-        return CliqueItem(name, item_data_table[name].type, item_data_table[name].code, self.player)
-
-    def create_items(self) -> None:
-        item_pool: List[CliqueItem] = []
-        for name, item in item_data_table.items():
-            if item.code and item.can_create(self):
-                item_pool.append(self.create_item(name))
-
-        self.multiworld.itempool += item_pool
-
-    def create_regions(self) -> None:
-        # Create regions.
-        for region_name in region_data_table.keys():
-            region = Region(region_name, self.player, self.multiworld)
-            self.multiworld.regions.append(region)
-
-        # Create locations.
-        for region_name, region_data in region_data_table.items():
-            region = self.get_region(region_name)
-            region.add_locations({
-                location_name: location_data.address for location_name, location_data in location_data_table.items()
-                if location_data.region == region_name and location_data.can_create(self)
-            }, CliqueLocation)
-            region.add_exits(region_data_table[region_name].connecting_regions)
-
-        # Place locked locations.
-        for location_name, location_data in locked_locations.items():
-            # Ignore locations we never created.
-            if not location_data.can_create(self):
-                continue
-
-            locked_item = self.create_item(location_data_table[location_name].locked_item)
-            self.get_location(location_name).place_locked_item(locked_item)
-
-        # Set priority location for the Big Red Button!
-        self.options.priority_locations.value.add("The Big Red Button")
-
-    def get_filler_item_name(self) -> str:
-        return "A Cool Filler Item (No Satisfaction Guaranteed)"
-
-    def set_rules(self) -> None:
-        button_rule = get_button_rule(self)
-        self.get_location("The Big Red Button").access_rule = button_rule
-        self.get_location("In the Player's Mind").access_rule = button_rule
-
-        # Do not allow button activations on buttons.
-        self.get_location("The Big Red Button").item_rule = lambda item: item.name != "Button Activation"
-
-        # Completion condition.
-        self.multiworld.completion_condition[self.player] = lambda state: state.has("The Urge to Push", self.player)
-
-    def fill_slot_data(self) -> Dict[str, Any]:
-        return {
-            "color": self.options.color.current_key
-        }

worlds/clique/docs/de_Clique.md

@@ -1,18 +0,0 @@
-# Clique
-
-## Was ist das für ein Spiel?
-
-~~Clique ist ein psychologisches Überlebens-Horror Spiel, in dem der Spieler der Versuchung wiederstehen muss große~~
-~~(rote) Knöpfe zu drücken.~~
-
-Clique ist ein scherzhaftes Spiel, welches für Archipelago im März 2023 entwickelt wurde, um zu zeigen, wie einfach
-es sein kann eine Welt für Archipelago zu entwicklen. Das Ziel des Spiels ist es den großen (standardmäßig) roten
-Knopf zu drücken. Wenn ein Spieler auf dem `hard_mode` (schwieriger Modus) spielt, muss dieser warten bis jemand
-anderes in der Multiworld den Knopf aktiviert, damit er gedrückt werden kann.
-
-Clique kann auf den meisten modernen, HTML5-fähigen Browsern gespielt werden.
-
-## Wo ist die Seite für die Einstellungen?
-
-Die [Seite für die Spielereinstellungen dieses Spiels](../player-options) enthält alle Optionen die man benötigt um
-eine YAML-Datei zu konfigurieren und zu exportieren.

worlds/clique/docs/en_Clique.md

@@ -1,16 +0,0 @@
-# Clique
-
-## What is this game?
-
-~~Clique is a psychological survival horror game where a player must survive the temptation to press red buttons.~~
-
-Clique is a joke game developed for Archipelago in March 2023 to showcase how easy it can be to develop a world for
-Archipelago. The objective of the game is to press the big red button. If a player is playing on `hard_mode`, they must
-wait for someone else in the multiworld to "activate" their button before they can press it.
-
-Clique can be played on most modern HTML5-capable browsers.
-
-## Where is the options page?
-
-The [player options page for this game](../player-options) contains all the options you need to configure
-and export a config file.

worlds/clique/docs/guide_de.md

@@ -1,25 +0,0 @@
-# Clique Anleitung
-
-Nachdem dein Seed generiert wurde, gehe auf die Website von [Clique dem Spiel](http://clique.pharware.com/) und gib
-Server-Daten, deinen Slot-Namen und ein Passwort (falls vorhanden) ein. Klicke dann auf "Connect" (Verbinden).
-
-Wenn du auf "Einfach" spielst, kannst du unbedenklich den Knopf drücken und deine "Befriedigung" erhalten.
-
-Wenn du auf "Schwer" spielst, ist es sehr wahrscheinlich, dass du warten musst bevor du dein Ziel erreichen kannst.
-Glücklicherweise läuft Click auf den meißten großen Browsern, die HTML5 unterstützen. Das heißt du kannst Clique auf
-deinem Handy starten und produktiv sein während du wartest!
-
-Falls du einige Ideen brauchst was du tun kannst, während du wartest bis der Knopf aktiviert wurde, versuche
-(mindestens) eins der Folgenden:
-
-- Dein Zimmer aufräumen.
-- Die Wäsche machen.
-- Etwas Essen von einem X-Belieben Fast Food Restaruant holen.
-- Das tägliche Wordle machen.
-- ~~Deine Seele an **Phar** verkaufen.~~
-- Deine Hausaufgaben erledigen.
-- Deine Post abholen.
-
-
-~~Solltest du auf irgendwelche Probleme in diesem Spiel stoßen, solltest du keinesfalls nicht **thephar** auf~~
-~~Discord kontaktieren. *zwinker* *zwinker*~~

worlds/clique/docs/guide_en.md

@@ -1,22 +0,0 @@
-# Clique Start Guide
-
-After rolling your seed, go to the [Clique Game](http://clique.pharware.com/) site and enter the server details, your 
-slot name, and a room password if one is required. Then click "Connect".
-
-If you're playing on "easy mode", just click the button and receive "Satisfaction".
-
-If you're playing on "hard mode", you may need to wait for activation before you can complete your objective. Luckily, 
-Clique runs in most major browsers that support HTML5, so you can load Clique on your phone and be productive while 
-you wait!
-
-If you need some ideas for what to do while waiting for button activation, give the following a try:
-
-- Clean your room.
-- Wash the dishes.
-- Get some food from a non-descript fast food restaurant.
-- Do the daily Wordle.
-- ~~Sell your soul to Phar.~~
-- Do your school work.
-
-
-~~If you run into any issues with this game, definitely do not contact **thephar** on discord. *wink* *wink*~~

worlds/cv64/data/patches.py

@@ -2893,3 +2893,18 @@ dog_bite_ice_trap_fix = [
     0x25291CB8,  # ADDIU T1, T1, 0x1CB8
     0x01200008   # JR    T1
 ]
+
+shimmy_speed_modifier = [
+    # Increases the player's speed while shimmying as long as they are not holding down Z. If they are holding Z, it
+    # will be the normal speed, allowing it to still be used to set up any tricks that might require the normal speed
+    # (like Left Tower Skip).
+    0x3C088038,  # LUI   T0, 0x8038
+    0x91087D7E,  # LBU   T0, 0x7D7E (T0)
+    0x31090020,  # ANDI  T1, T0, 0x0020
+    0x3C0A800A,  # LUI   T2, 0x800A
+    0x240B005A,  # ADDIU T3, R0, 0x005A
+    0x55200001,  # BNEZL T1,     [forward 0x01]
+    0x240B0032,  # ADDIU T3, R0, 0x0032
+    0xA14B3641,  # SB    T3, 0x3641 (T2)
+    0x0800B7C3   # J     0x8002DF0C
+]

worlds/cv64/options.py

@@ -424,6 +424,7 @@ class PantherDash(Choice):
 class IncreaseShimmySpeed(Toggle):
     """
     Increases the speed at which characters shimmy left and right while hanging on ledges.
+    Hold Z to use the regular speed in case it's needed to do something.
     """
     display_name = "Increase Shimmy Speed"
 

worlds/cv64/rom.py

@@ -607,9 +607,10 @@ class CV64PatchExtensions(APPatchExtension):
         rom_data.write_int32(0xAA530, 0x080FF880)  # J 0x803FE200
         rom_data.write_int32s(0xBFE200, patches.coffin_cutscene_skipper)
 
-        # Increase shimmy speed
+        # Shimmy speed increase hack
         if options["increase_shimmy_speed"]:
-            rom_data.write_byte(0xA4241, 0x5A)
+            rom_data.write_int32(0x97EB4, 0x803FE9F0)
+            rom_data.write_int32s(0xBFE9F0, patches.shimmy_speed_modifier)
 
         # Disable landing fall damage
         if options["fall_guard"]:

worlds/cvcotm/__init__.py

@@ -211,7 +211,8 @@ class CVCotMWorld(World):
                 "ignore_cleansing": self.options.ignore_cleansing.value,
                 "skip_tutorials": self.options.skip_tutorials.value,
                 "required_last_keys": self.required_last_keys,
-                "completion_goal": self.options.completion_goal.value}
+                "completion_goal": self.options.completion_goal.value,
+                "nerf_roc_wing": self.options.nerf_roc_wing.value}
 
     def get_filler_item_name(self) -> str:
         return self.random.choice(FILLER_ITEM_NAMES)

worlds/cvcotm/aesthetics.py

@@ -48,11 +48,17 @@ class OtherGameAppearancesInfo(TypedDict):
 
 
 other_game_item_appearances: Dict[str, Dict[str, OtherGameAppearancesInfo]] = {
-    # NOTE: Symphony of the Night is currently an unsupported world not in main.
+    # NOTE: Symphony of the Night and Harmony of Dissonance are custom worlds that are not core verified.
     "Symphony of the Night": {"Life Vessel": {"type": 0xE4,
                                               "appearance": 0x01},
                               "Heart Vessel": {"type": 0xE4,
                                                "appearance": 0x00}},
+
+    "Castlevania - Harmony of Dissonance": {"Life Max Up": {"type": 0xE4,
+                                                            "appearance": 0x01},
+                                            "Heart Max Up": {"type": 0xE4,
+                                                             "appearance": 0x00}},
+
     "Timespinner": {"Max HP": {"type": 0xE4,
                                "appearance": 0x01},
                     "Max Aura": {"type": 0xE4,
@@ -728,8 +734,8 @@ def get_start_inventory_data(world: "CVCotMWorld") -> Tuple[Dict[int, bytes], bo
                 magic_items_array[array_offset] += 1
 
     # Add the start inventory arrays to the offset data in bytes form.
-    start_inventory_data[0x680080] = bytes(magic_items_array)
-    start_inventory_data[0x6800A0] = bytes(cards_array)
+    start_inventory_data[0x690080] = bytes(magic_items_array)
+    start_inventory_data[0x6900A0] = bytes(cards_array)
 
     # Add the extra max HP/MP/Hearts to all classes' base stats. Doing it this way makes us less likely to hit the max
     # possible Max Ups.

worlds/cvcotm/data/patches.py

@@ -132,40 +132,40 @@ start_inventory_giver = [
 
     # Magic Items
     0x13, 0x48,  # ldr  r0, =0x202572F
-    0x14, 0x49,  # ldr  r1, =0x8680080
+    0x14, 0x49,  # ldr  r1, =0x8690080
     0x00, 0x22,  # mov  r2, #0
     0x8B, 0x5C,  # ldrb r3, [r1, r2]
     0x83, 0x54,  # strb r3, [r0, r2]
     0x01, 0x32,  # adds r2, #1
     0x08, 0x2A,  # cmp  r2, #8
-    0xFA, 0xDB,  # blt  0x8680006
+    0xFA, 0xDB,  # blt  0x8690006
     # Max Ups
     0x11, 0x48,  # ldr  r0, =0x202572C
-    0x12, 0x49,  # ldr  r1, =0x8680090
+    0x12, 0x49,  # ldr  r1, =0x8690090
     0x00, 0x22,  # mov  r2, #0
     0x8B, 0x5C,  # ldrb r3, [r1, r2]
     0x83, 0x54,  # strb r3, [r0, r2]
     0x01, 0x32,  # adds r2, #1
     0x03, 0x2A,  # cmp  r2, #3
-    0xFA, 0xDB,  # blt  0x8680016
+    0xFA, 0xDB,  # blt  0x8690016
     # Cards
     0x0F, 0x48,  # ldr  r0, =0x2025674
-    0x10, 0x49,  # ldr  r1, =0x86800A0
+    0x10, 0x49,  # ldr  r1, =0x86900A0
     0x00, 0x22,  # mov  r2, #0
     0x8B, 0x5C,  # ldrb r3, [r1, r2]
     0x83, 0x54,  # strb r3, [r0, r2]
     0x01, 0x32,  # adds r2, #1
     0x14, 0x2A,  # cmp  r2, #0x14
-    0xFA, 0xDB,  # blt  0x8680026
+    0xFA, 0xDB,  # blt  0x8690026
     # Inventory Items (not currently supported)
     0x0D, 0x48,  # ldr  r0, =0x20256ED
-    0x0E, 0x49,  # ldr  r1, =0x86800C0
+    0x0E, 0x49,  # ldr  r1, =0x86900C0
     0x00, 0x22,  # mov  r2, #0
     0x8B, 0x5C,  # ldrb r3, [r1, r2]
     0x83, 0x54,  # strb r3, [r0, r2]
     0x01, 0x32,  # adds r2, #1
     0x36, 0x2A,  # cmp  r2, #36
-    0xFA, 0xDB,  # blt  0x8680036
+    0xFA, 0xDB,  # blt  0x8690036
     # Return to the function that checks for Magician Mode.
     0xBA, 0x21,  # movs r1, #0xBA
     0x89, 0x00,  # lsls r1, r1, #2
@@ -176,13 +176,13 @@ start_inventory_giver = [
     # LDR number pool
     0x78, 0x7F, 0x00, 0x08,
     0x2F, 0x57, 0x02, 0x02,
-    0x80, 0x00, 0x68, 0x08,
+    0x80, 0x00, 0x69, 0x08,
     0x2C, 0x57, 0x02, 0x02,
-    0x90, 0x00, 0x68, 0x08,
+    0x90, 0x00, 0x69, 0x08,
     0x74, 0x56, 0x02, 0x02,
-    0xA0, 0x00, 0x68, 0x08,
+    0xA0, 0x00, 0x69, 0x08,
     0xED, 0x56, 0x02, 0x02,
-    0xC0, 0x00, 0x68, 0x08,
+    0xC0, 0x00, 0x69, 0x08,
 ]
 
 max_max_up_checker = [

worlds/cvcotm/docs/en_Castlevania - Circle of the Moon.md

@@ -3,7 +3,7 @@
 ## Quick Links
 - [Setup](/tutorial/Castlevania%20-%20Circle%20of%20the%20Moon/setup/en)
 - [Options Page](/games/Castlevania%20-%20Circle%20of%20the%20Moon/player-options)
-- [PopTracker Pack](https://github.com/sassyvania/Circle-of-the-Moon-Rando-AP-Map-Tracker-/releases/latest)
+- [PopTracker Pack](https://github.com/BowserCrusher/Circle-of-the-Moon-AP-Tracker/releases/latest)
 - [Repo for the original, standalone CotMR](https://github.com/calm-palm/cotm-randomizer)
 - [Web version of the above randomizer](https://rando.circleofthemoon.com/)
 - [A more in-depth guide to CotMR's nuances](https://docs.google.com/document/d/1uot4BD9XW7A--A8ecgoY8mLK_vSoQRpY5XCkzgas87c/view?usp=sharing)

worlds/cvcotm/docs/setup_en.md

@@ -22,7 +22,7 @@ clear it.
 
 ## Optional Software
 
-- [Castlevania: Circle of the Moon AP Tracker](https://github.com/sassyvania/Circle-of-the-Moon-Rando-AP-Map-Tracker-/releases/latest), for use with
+- [Castlevania: Circle of the Moon AP Tracker](https://github.com/BowserCrusher/Circle-of-the-Moon-AP-Tracker/releases/latest), for use with
 [PopTracker](https://github.com/black-sliver/PopTracker/releases).
 
 ## Generating and Patching a Game
@@ -64,7 +64,7 @@ perfectly safe to make progress offline; everything will re-sync when you reconn
 
 Castlevania: Circle of the Moon has a fully functional map tracker that supports auto-tracking.
 
-1. Download [Castlevania: Circle of the Moon AP Tracker](https://github.com/sassyvania/Circle-of-the-Moon-Rando-AP-Map-Tracker-/releases/latest) and
+1. Download [Castlevania: Circle of the Moon AP Tracker](https://github.com/BowserCrusher/Circle-of-the-Moon-AP-Tracker/releases/latest) and
 [PopTracker](https://github.com/black-sliver/PopTracker/releases).
 2. Put the tracker pack into `packs/` in your PopTracker install.
 3. Open PopTracker, and load the Castlevania: Circle of the Moon pack.

worlds/cvcotm/rom.py

@@ -335,8 +335,8 @@ class CVCotMPatchExtensions(APPatchExtension):
             rom_data.write_bytes(0x679A60, patches.kickless_roc_height_shortener)
 
         # Give the player their Start Inventory upon entering their name on a new file.
-        rom_data.write_bytes(0x7F70, [0x00, 0x48, 0x87, 0x46, 0x00, 0x00, 0x68, 0x08])
-        rom_data.write_bytes(0x680000, patches.start_inventory_giver)
+        rom_data.write_bytes(0x7F70, [0x00, 0x48, 0x87, 0x46, 0x00, 0x00, 0x69, 0x08])
+        rom_data.write_bytes(0x690000, patches.start_inventory_giver)
 
         # Prevent Max Ups from exceeding 255.
         rom_data.write_bytes(0x5E170, [0x00, 0x4A, 0x97, 0x46, 0x00, 0x00, 0x6A, 0x08])

worlds/dark_souls_3/Locations.py

@@ -884,7 +884,7 @@ location_tables: Dict[str, List[DS3LocationData]] = {
         DS3LocationData("RS: Homeward Bone - balcony by Farron Keep", "Homeward Bone x2"),
         DS3LocationData("RS: Titanite Shard - woods, surrounded by enemies", "Titanite Shard"),
         DS3LocationData("RS: Twin Dragon Greatshield - woods by Crucifixion Woods bonfire",
-                        "Twin Dragon Greatshield"),
+                        "Twin Dragon Greatshield", missable=True), # After Eclipse
         DS3LocationData("RS: Sorcerer Hood - water beneath stronghold", "Sorcerer Hood",
                         hidden=True),  # Hidden fall
         DS3LocationData("RS: Sorcerer Robe - water beneath stronghold", "Sorcerer Robe",
@@ -1887,7 +1887,7 @@ location_tables: Dict[str, List[DS3LocationData]] = {
         DS3LocationData("AL: Twinkling Titanite - lizard after light cathedral #2",
                         "Twinkling Titanite", lizard=True),
         DS3LocationData("AL: Aldrich's Ruby - dark cathedral, miniboss", "Aldrich's Ruby",
-                        miniboss=True),  # Deep Accursed drop
+                        miniboss=True, missable=True),  # Deep Accursed drop, missable after defeating Aldrich
         DS3LocationData("AL: Aldrich Faithful - water reserves, talk to McDonnel", "Aldrich Faithful",
                         hidden=True),  # Behind illusory wall
 

worlds/dark_souls_3/__init__.py

@@ -75,6 +75,13 @@ class DarkSouls3World(World):
     """The pool of all items within this particular world. This is a subset of
     `self.multiworld.itempool`."""
 
+    missable_dupe_prog_locs: Set[str] = {"PC: Storm Ruler - Siegward",
+                                         "US: Pyromancy Flame - Cornyx",
+                                         "US: Tower Key - kill Irina"}
+    """Locations whose vanilla item is a missable duplicate of a non-missable progression item.
+    If vanilla, these locations shouldn't be expected progression, so they aren't created and don't get rules.
+    """
+
     def __init__(self, multiworld: MultiWorld, player: int):
         super().__init__(multiworld, player)
         self.all_excluded_locations = set()
@@ -258,10 +265,7 @@ class DarkSouls3World(World):
                     new_location.progress_type = LocationProgressType.EXCLUDED
             else:
                 # Don't allow missable duplicates of progression items to be expected progression.
-                if location.name in {"PC: Storm Ruler - Siegward",
-                                     "US: Pyromancy Flame - Cornyx",
-                                     "US: Tower Key - kill Irina"}:
-                    continue
+                if location.name in self.missable_dupe_prog_locs: continue
 
                 # Replace non-randomized items with events that give the default item
                 event_item = (
@@ -705,7 +709,7 @@ class DarkSouls3World(World):
         if self._is_location_available("US: Young White Branch - by white tree #2"):
             self._add_item_rule(
                 "US: Young White Branch - by white tree #2",
-                lambda item: item.player == self.player and not item.data.unique
+                lambda item: item.player != self.player or not item.data.unique
             )
         
         # Make sure the Storm Ruler is available BEFORE Yhorm the Giant
@@ -1286,8 +1290,9 @@ class DarkSouls3World(World):
             data = location_dictionary[location]
             if data.dlc and not self.options.enable_dlc: continue
             if data.ngp and not self.options.enable_ngp: continue
+            # Don't add rules to missable duplicates of progression items
+            if location in self.missable_dupe_prog_locs and not self._is_location_available(location): continue
 
-            if not self._is_location_available(location): continue
             if isinstance(rule, str):
                 assert item_dictionary[rule].classification == ItemClassification.progression
                 rule = lambda state, item=rule: state.has(item, self.player)

worlds/dark_souls_3/docs/setup_en.md

@@ -73,7 +73,7 @@ things to keep in mind:
 
 * To run the game itself, just run `launchmod_darksouls3.bat` under Proton.
 
-[.NET Runtime]: https://dotnet.microsoft.com/en-us/download/dotnet/8.0
+[.NET Runtime]: https://dotnet.microsoft.com/en-us/download/dotnet/6.0
 [WINE]: https://www.winehq.org/
 
 ## Troubleshooting

worlds/dkc3/Regions.py

@@ -802,8 +802,10 @@ def connect_regions(world: World, level_list):
     for i in range(0, len(kremwood_forest_levels) - 1):
         connect(world, world.player, names, LocationName.kremwood_forest_region, kremwood_forest_levels[i])
 
-    connect(world, world.player, names, LocationName.kremwood_forest_region, kremwood_forest_levels[-1],
-            lambda state: (state.can_reach(LocationName.riverside_race_flag, "Location", world.player)))
+    connection = connect(world, world.player, names, LocationName.kremwood_forest_region, kremwood_forest_levels[-1],
+                         lambda state: (state.can_reach(LocationName.riverside_race_flag, "Location", world.player)))
+    world.multiworld.register_indirect_condition(world.get_location(LocationName.riverside_race_flag).parent_region,
+                                                 connection)
 
     # Cotton-Top Cove Connections
     cotton_top_cove_levels = [
@@ -837,8 +839,11 @@ def connect_regions(world: World, level_list):
         connect(world, world.player, names, LocationName.mekanos_region, LocationName.sky_high_secret_region,
                 lambda state: (state.has(ItemName.bowling_ball, world.player, 1)))
     else:
-        connect(world, world.player, names, LocationName.mekanos_region, LocationName.sky_high_secret_region,
-                lambda state: (state.can_reach(LocationName.bleaks_house, "Location", world.player)))
+        connection = connect(world, world.player, names, LocationName.mekanos_region,
+                             LocationName.sky_high_secret_region,
+                             lambda state: (state.can_reach(LocationName.bleaks_house, "Location", world.player)))
+        world.multiworld.register_indirect_condition(world.get_location(LocationName.bleaks_house).parent_region,
+                                                     connection)
 
     # K3 Connections
     k3_levels = [
@@ -946,3 +951,4 @@ def connect(world: World, player: int, used_names: typing.Dict[str, int], source
 
     source_region.exits.append(connection)
     connection.connect(target_region)
+    return connection

worlds/dlcquest/Items.py

@@ -30,7 +30,6 @@ class Group(enum.Enum):
     Deprecated = enum.auto()
 
 
-
 @dataclass(frozen=True)
 class ItemData:
     code_without_offset: offset
@@ -98,14 +97,15 @@ def create_trap_items(world, world_options: Options.DLCQuestOptions, trap_needed
     return traps
 
 
-def create_items(world, world_options: Options.DLCQuestOptions, locations_count: int, excluded_items: list[str], random: Random):
+def create_items(world, world_options: Options.DLCQuestOptions, locations_count: int, excluded_items: list[str],
+                 random: Random):
     created_items = []
     if world_options.campaign == Options.Campaign.option_basic or world_options.campaign == Options.Campaign.option_both:
-        create_items_basic(world_options, created_items, world, excluded_items)
+        create_items_campaign(world_options, created_items, world, excluded_items, Group.DLCQuest, 825, 250)
 
     if (world_options.campaign == Options.Campaign.option_live_freemium_or_die or
             world_options.campaign == Options.Campaign.option_both):
-        create_items_lfod(world_options, created_items, world, excluded_items)
+        create_items_campaign(world_options, created_items, world, excluded_items, Group.Freemium, 889, 200)
 
     trap_items = create_trap_items(world, world_options, locations_count - len(created_items), random)
     created_items += trap_items
@@ -113,27 +113,8 @@ def create_items(world, world_options: Options.DLCQuestOptions, locations_count:
     return created_items
 
 
-def create_items_lfod(world_options, created_items, world, excluded_items):
-    for item in items_by_group[Group.Freemium]:
-        if item.name in excluded_items:
-            excluded_items.remove(item)
-            continue
-
-        if item.has_any_group(Group.DLC):
-            created_items.append(world.create_item(item))
-        if item.has_any_group(Group.Item) and world_options.item_shuffle == Options.ItemShuffle.option_shuffled:
-            created_items.append(world.create_item(item))
-            if item.has_any_group(Group.Twice):
-                created_items.append(world.create_item(item))
-    if world_options.coinsanity == Options.CoinSanity.option_coin:
-        if world_options.coinbundlequantity == -1:
-            create_coin_piece(created_items, world, 889, 200, Group.Freemium)
-            return
-        create_coin(world_options, created_items, world, 889, 200, Group.Freemium)
-
-
-def create_items_basic(world_options, created_items, world, excluded_items):
-    for item in items_by_group[Group.DLCQuest]:
+def create_items_campaign(world_options: Options.DLCQuestOptions, created_items: list[DLCQuestItem], world, excluded_items: list[str], group: Group, total_coins: int, required_coins: int):
+    for item in items_by_group[group]:
         if item.name in excluded_items:
             excluded_items.remove(item.name)
             continue
@@ -146,14 +127,15 @@ def create_items_basic(world_options, created_items, world, excluded_items):
                 created_items.append(world.create_item(item))
     if world_options.coinsanity == Options.CoinSanity.option_coin:
         if world_options.coinbundlequantity == -1:
-            create_coin_piece(created_items, world, 825, 250, Group.DLCQuest)
+            create_coin_piece(created_items, world, total_coins, required_coins, group)
             return
-        create_coin(world_options, created_items, world, 825, 250, Group.DLCQuest)
+        create_coin(world_options, created_items, world, total_coins, required_coins, group)
 
 
 def create_coin(world_options, created_items, world, total_coins, required_coins, group):
     coin_bundle_required = math.ceil(required_coins / world_options.coinbundlequantity)
-    coin_bundle_useful = math.ceil((total_coins - coin_bundle_required * world_options.coinbundlequantity) / world_options.coinbundlequantity)
+    coin_bundle_useful = math.ceil(
+        (total_coins - coin_bundle_required * world_options.coinbundlequantity) / world_options.coinbundlequantity)
     for item in items_by_group[group]:
         if item.has_any_group(Group.Coin):
             for i in range(coin_bundle_required):
@@ -165,7 +147,7 @@ def create_coin(world_options, created_items, world, total_coins, required_coins
 def create_coin_piece(created_items, world, total_coins, required_coins, group):
     for item in items_by_group[group]:
         if item.has_any_group(Group.Piece):
-            for i in range(required_coins*10):
+            for i in range(required_coins * 10):
                 created_items.append(world.create_item(item))
             for i in range((total_coins - required_coins) * 10):
                 created_items.append(world.create_item(item, ItemClassification.useful))

worlds/dlcquest/Rules.py

@@ -280,16 +280,19 @@ def set_boss_door_requirements_rules(player, world):
     set_rule(world.get_entrance("Boss Door", player), has_3_swords)
 
 
-def set_lfod_self_obtained_items_rules(world_options, player, world):
+def set_lfod_self_obtained_items_rules(world_options, player, multiworld):
     if world_options.item_shuffle != Options.ItemShuffle.option_disabled:
         return
-    set_rule(world.get_entrance("Vines", player),
+    world = multiworld.worlds[player]
+    set_rule(world.get_entrance("Vines"),
              lambda state: state.has("Incredibly Important Pack", player))
-    set_rule(world.get_entrance("Behind Rocks", player),
+    set_rule(world.get_entrance("Behind Rocks"),
              lambda state: state.can_reach("Cut Content", 'region', player))
-    set_rule(world.get_entrance("Pickaxe Hard Cave", player),
+    multiworld.register_indirect_condition(world.get_region("Cut Content"), world.get_entrance("Behind Rocks"))
+    set_rule(world.get_entrance("Pickaxe Hard Cave"),
              lambda state: state.can_reach("Cut Content", 'region', player) and
                            state.has("Name Change Pack", player))
+    multiworld.register_indirect_condition(world.get_region("Cut Content"), world.get_entrance("Pickaxe Hard Cave"))
 
 
 def set_lfod_shuffled_items_rules(world_options, player, world):

worlds/factorio/Client.py

@@ -69,7 +69,9 @@ class FactorioContext(CommonContext):
     # updated by spinup server
     mod_version: Version = Version(0, 0, 0)
 
-    def __init__(self, server_address, password, filter_item_sends: bool, bridge_chat_out: bool):
+    def __init__(self, server_address, password, filter_item_sends: bool, bridge_chat_out: bool,
+                 rcon_port: int, rcon_password: str, server_settings_path: str | None,
+                 factorio_server_args: tuple[str, ...]):
         super(FactorioContext, self).__init__(server_address, password)
         self.send_index: int = 0
         self.rcon_client = None
@@ -82,6 +84,10 @@ class FactorioContext(CommonContext):
         self.filter_item_sends: bool = filter_item_sends
         self.multiplayer: bool = False  # whether multiple different players have connected
         self.bridge_chat_out: bool = bridge_chat_out
+        self.rcon_port: int = rcon_port
+        self.rcon_password: str = rcon_password
+        self.server_settings_path: str = server_settings_path
+        self.additional_factorio_server_args = factorio_server_args
 
     @property
     def energylink_key(self) -> str:
@@ -126,6 +132,18 @@ class FactorioContext(CommonContext):
         self.rcon_client.send_command(f"/ap-print [font=default-large-bold]Archipelago:[/font] "
                                       f"{text}")
 
+    @property
+    def server_args(self) -> tuple[str, ...]:
+        if self.server_settings_path:
+            return (
+                "--rcon-port", str(self.rcon_port),
+                "--rcon-password", self.rcon_password,
+                "--server-settings", self.server_settings_path,
+                *self.additional_factorio_server_args)
+        else:
+            return ("--rcon-port", str(self.rcon_port), "--rcon-password", self.rcon_password,
+                    *self.additional_factorio_server_args)
+
     @property
     def energy_link_status(self) -> str:
         if not self.energy_link_increment:
@@ -311,7 +329,7 @@ async def factorio_server_watcher(ctx: FactorioContext):
             executable, "--create", savegame_name, "--preset", "archipelago"
         ))
     factorio_process = subprocess.Popen((executable, "--start-server", savegame_name,
-                                         *(str(elem) for elem in server_args)),
+                                         *ctx.server_args),
                                         stderr=subprocess.PIPE,
                                         stdout=subprocess.PIPE,
                                         stdin=subprocess.DEVNULL,
@@ -331,7 +349,7 @@ async def factorio_server_watcher(ctx: FactorioContext):
                 factorio_queue.task_done()
 
                 if not ctx.rcon_client and "Starting RCON interface at IP ADDR:" in msg:
-                    ctx.rcon_client = factorio_rcon.RCONClient("localhost", rcon_port, rcon_password,
+                    ctx.rcon_client = factorio_rcon.RCONClient("localhost", ctx.rcon_port, ctx.rcon_password,
                                                                timeout=5)
                     if not ctx.server:
                         logger.info("Established bridge to Factorio Server. "
@@ -422,7 +440,7 @@ async def factorio_spinup_server(ctx: FactorioContext) -> bool:
             executable, "--create", savegame_name
         ))
     factorio_process = subprocess.Popen(
-        (executable, "--start-server", savegame_name, *(str(elem) for elem in server_args)),
+        (executable, "--start-server", savegame_name, *ctx.server_args),
         stderr=subprocess.PIPE,
         stdout=subprocess.PIPE,
         stdin=subprocess.DEVNULL,
@@ -451,7 +469,7 @@ async def factorio_spinup_server(ctx: FactorioContext) -> bool:
                                     "or a Factorio sharing data directories is already running. "
                                     "Server could not start up.")
                 if not rcon_client and "Starting RCON interface at IP ADDR:" in msg:
-                    rcon_client = factorio_rcon.RCONClient("localhost", rcon_port, rcon_password)
+                    rcon_client = factorio_rcon.RCONClient("localhost", ctx.rcon_port, ctx.rcon_password)
                     if ctx.mod_version == ctx.__class__.mod_version:
                         raise Exception("No Archipelago mod was loaded. Aborting.")
                     await get_info(ctx, rcon_client)
@@ -474,9 +492,8 @@ async def factorio_spinup_server(ctx: FactorioContext) -> bool:
     return False
 
 
-async def main(args, filter_item_sends: bool, filter_bridge_chat_out: bool):
-    ctx = FactorioContext(args.connect, args.password, filter_item_sends, filter_bridge_chat_out)
-
+async def main(make_context):
+    ctx = make_context()
     ctx.server_task = asyncio.create_task(server_loop(ctx), name="ServerLoop")
 
     if gui_enabled:
@@ -509,38 +526,42 @@ class FactorioJSONtoTextParser(JSONtoTextParser):
         return self._handle_text(node)
 
 
-parser = get_base_parser(description="Optional arguments to FactorioClient follow. "
-                                     "Remaining arguments get passed into bound Factorio instance."
-                                     "Refer to Factorio --help for those.")
-parser.add_argument('--rcon-port', default='24242', type=int, help='Port to use to communicate with Factorio')
-parser.add_argument('--rcon-password', help='Password to authenticate with RCON.')
-parser.add_argument('--server-settings', help='Factorio server settings configuration file.')
-
-args, rest = parser.parse_known_args()
-rcon_port = args.rcon_port
-rcon_password = args.rcon_password if args.rcon_password else ''.join(
-    random.choice(string.ascii_letters) for x in range(32))
 factorio_server_logger = logging.getLogger("FactorioServer")
 settings: FactorioSettings = get_settings().factorio_options
 if os.path.samefile(settings.executable, sys.executable):
     selected_executable = settings.executable
     settings.executable = FactorioSettings.executable  # reset to default
-    raise Exception(f"FactorioClient was set to run itself {selected_executable}, aborting process bomb.")
+    raise Exception(f"Factorio Client was set to run itself {selected_executable}, aborting process bomb.")
 
 executable = settings.executable
 
-server_settings = args.server_settings if args.server_settings \
-    else getattr(settings, "server_settings", None)
-server_args = ("--rcon-port", rcon_port, "--rcon-password", rcon_password)
 
-
-def launch():
+def launch(*new_args: str):
     import colorama
-    global executable, server_settings, server_args
+    global executable
     colorama.just_fix_windows_console()
 
+    # args handling
+    parser = get_base_parser(description="Optional arguments to Factorio Client follow. "
+                                         "Remaining arguments get passed into bound Factorio instance."
+                                         "Refer to Factorio --help for those.")
+    parser.add_argument('--rcon-port', default='24242', type=int, help='Port to use to communicate with Factorio')
+    parser.add_argument('--rcon-password', help='Password to authenticate with RCON.')
+    parser.add_argument('--server-settings', help='Factorio server settings configuration file.')
+
+    args, rest = parser.parse_known_args(args=new_args)
+    rcon_port = args.rcon_port
+    rcon_password = args.rcon_password if args.rcon_password else ''.join(
+        random.choice(string.ascii_letters) for _ in range(32))
+
+    server_settings = args.server_settings if args.server_settings \
+        else getattr(settings, "server_settings", None)
+
     if server_settings:
         server_settings = os.path.abspath(server_settings)
+        if not os.path.isfile(server_settings):
+            raise FileNotFoundError(f"Could not find file {server_settings} for server_settings. Aborting.")
+
     initial_filter_item_sends = bool(settings.filter_item_sends)
     initial_bridge_chat_out = bool(settings.bridge_chat_out)
 
@@ -554,14 +575,9 @@ def launch():
         else:
             raise FileNotFoundError(f"Path {executable} is not an executable file.")
 
-    if server_settings and os.path.isfile(server_settings):
-        server_args = (
-            "--rcon-port", rcon_port,
-            "--rcon-password", rcon_password,
-            "--server-settings", server_settings,
-            *rest)
-    else:
-        server_args = ("--rcon-port", rcon_port, "--rcon-password", rcon_password, *rest)
-
-    asyncio.run(main(args, initial_filter_item_sends, initial_bridge_chat_out))
+    asyncio.run(main(lambda: FactorioContext(
+        args.connect, args.password,
+        initial_filter_item_sends, initial_bridge_chat_out,
+        rcon_port, rcon_password, server_settings, rest
+    )))
     colorama.deinit()

worlds/factorio/Mod.py

@@ -67,6 +67,7 @@ class FactorioModFile(worlds.Files.APPlayerContainer):
     game = "Factorio"
     compression_method = zipfile.ZIP_DEFLATED  # Factorio can't load LZMA archives
     writing_tasks: List[Callable[[], Tuple[str, Union[str, bytes]]]]
+    patch_file_ending = ".zip"
 
     def __init__(self, *args: Any, **kwargs: Any):
         super().__init__(*args, **kwargs)

worlds/factorio/Options.py

@@ -321,7 +321,7 @@ class InventorySpillTrapCount(TrapCount):
 
 class FactorioWorldGen(OptionDict):
     """World Generation settings. Overview of options at https://wiki.factorio.com/Map_generator,
-    with in-depth documentation at https://lua-api.factorio.com/latest/Concepts.html#MapGenSettings"""
+    with in-depth documentation at https://lua-api.factorio.com/latest/concepts/MapGenSettings.html"""
     display_name = "World Generation"
     # FIXME: do we want default be a rando-optimized default or in-game DS?
     value: dict[str, dict[str, typing.Any]]

worlds/factorio/__init__.py

@@ -22,9 +22,9 @@ from .Technologies import base_tech_table, recipe_sources, base_technology_table
 from .settings import FactorioSettings
 
 
-def launch_client():
+def launch_client(*args: str):
     from .Client import launch
-    launch_component(launch, name="FactorioClient")
+    launch_component(launch, name="Factorio Client", args=args)
 
 
 components.append(Component("Factorio Client", func=launch_client, component_type=Type.CLIENT))

worlds/generic/docs/advanced_settings_en.md

@@ -288,7 +288,7 @@ world and the beginning of another world. You can also combine multiple files by
 ### Example
 
 ```yaml
-description: Example of generating multiple worlds. World 1 of 3
+description: Example of generating multiple worlds. World 1 of 2
 name: Mario
 game: Super Mario 64
 requires:
@@ -310,31 +310,6 @@ Super Mario 64:
 
 ---
 
-description: Example of generating multiple worlds. World 2 of 3
-name: Minecraft
-game: Minecraft
-Minecraft:
-  progression_balancing: 50
-  accessibility: items
-  advancement_goal: 40
-  combat_difficulty: hard
-  include_hard_advancements: false
-  include_unreasonable_advancements: false
-  include_postgame_advancements: false
-  shuffle_structures: true
-  structure_compasses: true
-  send_defeated_mobs: true
-  bee_traps: 15
-  egg_shards_required: 7
-  egg_shards_available: 10
-  required_bosses:
-    none: 0
-    ender_dragon: 1
-    wither: 0
-    both: 0
-
----
-
 description: Example of generating multiple worlds. World 2 of 2
 name: ExampleFinder
 game: ChecksFinder
@@ -344,6 +319,6 @@ ChecksFinder:
   accessibility: items
 ```
 
-The above example will generate 3 worlds - one Super Mario 64, one Minecraft, and one ChecksFinder.
+The above example will generate 2 worlds - one Super Mario 64 and one ChecksFinder.
  
 

worlds/generic/docs/plando_en.md

@@ -27,73 +27,176 @@ requires:
   plando: bosses, items, texts, connections
 ``` 
 
+For a basic understanding of YAML files, refer to 
+[YAML Formatting](/tutorial/Archipelago/advanced_settings/en#yaml-formatting) 
+in Advanced Settings.
+
 ## Item Plando
-Item plando allows a player to place an item in a specific location or specific locations, or place multiple items into a
-list of specific locations both in their own game or in another player's game.
 
-* The options for item plando are `from_pool`, `world`, `percentage`, `force`, `count`, and either `item` and
-  `location`, or `items` and `locations`.
-    * `from_pool` determines if the item should be taken *from* the item pool or *added* to it. This can be true or
-      false and defaults to true if omitted.
-    * `world` is the target world to place the item in.
-        * It gets ignored if only one world is generated.
-        * Can be a number, name, true, false, null, or a list. False is the default.
-            * If a number is used, it targets that slot or player number in the multiworld.
-            * If a name is used, it will target the world with that player name.
-            * If set to true, it will be any player's world besides your own.
-            * If set to false, it will target your own world.
-            * If set to null, it will target a random world in the multiworld.
-            * If a list of names is used, it will target the games with the player names specified.
-    * `force` determines whether the generator will fail if the item can't be placed in the location. Can be true, false,
-      or silent. Silent is the default.
-        * If set to true, the item must be placed and the generator will throw an error if it is unable to do so.
-        * If set to false, the generator will log a warning if the placement can't be done but will still generate.
-        * If set to silent and the placement fails, it will be ignored entirely.
-    * `percentage` is the percentage chance for the relevant block to trigger. This can be any value from 0 to 100 and
-      if omitted will default to 100.
-    * Single Placement is when you use a plando block to place a single item at a single location.
-        * `item` is the item you would like to place and `location` is the location to place it.
-    * Multi Placement uses a plando block to place multiple items in multiple locations until either list is exhausted.
-        * `items` defines the items to use, each with a number for the amount. Using `true` instead of a number uses however many of that item are in your item pool.
-        * `locations` is a list of possible locations those items can be placed in.
-            * Some special location group names can be specified:
-                * `early_locations` will add all sphere 1 locations (locations logically reachable only with your starting inventory)
-                * `non_early_locations` will add all locations beyond sphere 1 (locations that require finding at least one item before they become logically reachable)
-        * Using the multi placement method, placements are picked randomly.
+Item Plando allows a player to place an item in a specific location or locations, or place multiple items into a list 
+of specific locations in their own game and/or in another player's game.
 
-    * `count` can be used to set the maximum number of items placed from the block. The default is 1 if using `item` and False if using `items`
-        * If a number is used, it will try to place this number of items.
-        * If set to false, it will try to place as many items from the block as it can.
-        * If `min` and `max` are defined, it will try to place a number of items between these two numbers at random.
+To add item plando to your player yaml, you add them under the `plando_items` block. You should start with `item` if you 
+want to do Single Placement, or `items` if you want to do Multi Placement. A list of items can still be defined under 
+`item` but only one of them will be chosen at random to be used.
 
+After you define `item/items`, you would define `location` or `locations`, depending on if you want to fill one 
+location or many. Note that both `location` and `locations` are optional. A list of locations can still be defined under 
+`location` but only one of them will be chosen at random to be used.
+
+You may do any combination of `item/items` and `location/locations` in a plando block, but the block only places items 
+in locations **until the shorter of the two lists is used up.**
+
+Once you are satisfied with your first block, you may continue to define ones under the same `plando_items` parent.
+Each block can have several different options to tailor it the way you like.
+
+* The `items` section defines the items to use. Each item name can be followed by a colon and a value.
+    * A numerical value indicates the amount of that item.
+    * A `true` value uses all copies of that item that are in your item pool.
+
+* The `item` section defines a list of items to use, from which one will be chosen at random. Each item name can be 
+    followed by a colon and a value. The value indicates the weight of that item being chosen.
+
+* The `locations` section defines possible locations those items can be placed in. Two special location groups exist:
+    * `early_locations` will add all sphere 1 locations (locations logically reachable only with your starting 
+      inventory).
+    * `non_early_locations` will add all locations beyond sphere 1 (locations that require finding at least one item 
+      before they become logically reachable).
+
+* `from_pool` determines if the item should be taken *from* the item pool or *created* from scratch.
+    * `false`: Create a new item with the same name (the world will determine its properties e.g. classification).
+    * `true`: Take the existing item, if it exists, from the item pool. If it does not exist, one will be created from 
+      scratch. **(Default)**
+
+* `world` is the target world to place the item in. It gets ignored if only one world is generated.
+    * **A number:** Use this slot or player number in the multiworld.
+    * **A name:** Use the world with that player name.
+    * **A list of names:** Use the worlds with the player names specified.
+    * `true`: Locations will be in any player's world besides your own.
+    * `false`: Locations will be in your own world. **(Default)**
+    * `null`: Locations will be in a random world in the multiworld.
+
+* `force` determines whether the generator will fail if the plando block cannot be fulfilled.
+    * `true`: The generator will throw an error if it is unable to place an item.
+    * `false`: The generator will log a warning if it is unable to place an item, but it will still generate.
+    * `silent`: If the placement fails, it will be ignored entirely. **(Default)**
+
+* `percentage` is the percentage chance for the block to trigger. This can be any integer from 0 to 100. 
+    **(Default: 100)**
+
+* `count` sets the number of items placed from the list.
+    * **Default: 1 if using `item` or `location`, and `false` otherwise.**
+    * **A number:** It will place this number of items.
+    * `false`: It will place as many items from the list as it can.
+    * **If `min` is defined,** it will place at least `min` many items (can be combined with `max`).
+    * **If `max` is defined,** it will place at most `max` many items (can be combined with `min`).
 
 ### Available Items and Locations
 
-A list of all available items and locations can be found in the [website's datapackage](/datapackage). The items and locations will be in the `"item_name_to_id"` and `"location_name_to_id"` sections of the relevant game. You do not need the quotes but the name must be entered in the same as it appears on that page and is case-sensitive.
+A list of all available items and locations can be found in the [website's datapackage](/datapackage). The items and 
+locations will be in the `"item_name_to_id"` and `"location_name_to_id"` sections of the relevant game. Names are 
+case-sensitive. You can also use item groups and location groups that are defined in the datapackage.
 
-### Examples
+## Item Plando Examples
+```yaml
+ plando_items:
+    # Example block - Pokémon Red and Blue
+    - items:
+        Potion: 3
+      locations:
+        - "Route 1 - Free Sample Man" 
+        - "Mt Moon 1F - West Item"
+        - "Mt Moon 1F - South Item"
+```
+This block will lock 3 Potion items on the Route 1 Pokémart employee and 2 Mt Moon items. Note these are all 
+Potions in the vanilla game. The world value has not been specified, so these locations must be in this player's own 
+world by default.
 
 ```yaml
   plando_items:
-    # example block 1 - Timespinner
+  # Example block - A Link to the Past
+    - items:
+        Progressive Sword: 4
+      world:
+        - BobsWitness
+        - BobsRogueLegacy
+      count:
+        min: 1
+        max: 4
+```
+This block will attempt to place a random number, between 1 and 4, of Progressive Swords into any locations within the 
+game slots named "BobsWitness" and "BobsRogueLegacy."
+
+```yaml
+  plando_items:
+  # Example block - Secret of Evermore
+    - items:
+        Levitate: 1
+        Revealer: 1
+        Energize: 1
+      locations:
+        - Master Sword Pedestal
+        - Desert Discard
+      world: true
+      count: 2
+```
+This block will choose 2 from the Levitate, Revealer, and Energize items at random and attempt to put them into the 
+locations named "Master Sword Pedestal" and "Desert Discard". Because the world value is `true`, these locations 
+must be in other players' worlds.
+
+```yaml
+  plando_items:
+    # Example block - Timespinner
     - item:
         Empire Orb: 1
-        Radiant Orb: 1
+        Radiant Orb: 3
       location: Starter Chest 1
-      from_pool: true
+      from_pool: false
       world: true
       percentage: 50
-  
-    # example block 2 - Ocarina of Time
+```
+This block will place a single item, either the Empire Orb or Radiant Orb, on the location "Starter Chest 1". There is
+a 25% chance it is Empire Orb, and 75% chance it is Radiant Orb (1 to 3 odds). The world value is `true`, so this 
+location must be in another player's world. Because the from_pool value is `false`, a copy of these items is added to 
+these locations, while the originals remain in the item pool to be shuffled. Unlike the previous examples, which will 
+always trigger, this block only has a 50% chance to trigger.
+
+```yaml
+  plando_items:
+    # Example block - Factorio
+    - items:
+        progressive-electric-energy-distribution: 2
+        electric-energy-accumulators: 1
+        progressive-turret: 2
+      locations:
+        - AP-1-001
+        - AP-1-002
+        - AP-1-003
+        - AP-1-004
+      percentage: 80
+      force: true
+      from_pool: true
+      world: false
+```
+This block lists 5 items but only 4 locations, so it will place all but 1 of the items randomly among the locations 
+chosen here. This block has an 80% chance of occurring. Because force is `true`, the Generator will fail if it cannot
+place one of the selected items (not including the fifth item). From_pool and World have been set to their default
+values here, but they can be omitted and have the same result: items will be removed from the pool, and the locations
+are in this player's own world.
+
+**NOTE:** Factorio's locations are dynamically generated, so the locations listed above may not exist in your game,
+they are here for demonstration only.
+
+```yaml
+  plando_items:
+    # Example block - Ocarina of Time
     - items:
-        Kokiri Sword: 1
         Biggoron Sword: 1
         Bow: 1
         Magic Meter: 1
         Progressive Strength Upgrade: 3
         Progressive Hookshot: 2
       locations:
-        - Deku Tree Slingshot Chest
         - Dodongos Cavern Bomb Bag Chest
         - Jabu Jabus Belly Boomerang Chest
         - Bottom of the Well Lens of Truth Chest
@@ -102,53 +205,16 @@ A list of all available items and locations can be found in the [website's datap
         - Water Temple Longshot Chest
         - Shadow Temple Hover Boots Chest
         - Spirit Temple Silver Gauntlets Chest
-      world: false
-  
-    # example block 3 - Factorio
-    - items:
-        progressive-electric-energy-distribution: 2
-        electric-energy-accumulators: 1
-        progressive-turret: 2
-      locations:
-        - military
-        - gun-turret
-        - logistic-science-pack
-        - steel-processing
-      percentage: 80
-      force: true
-  
-  # example block 4 - Secret of Evermore
-    - items:
-        Levitate: 1
-        Revealer: 1
-        Energize: 1
-      locations:
-        - Master Sword Pedestal
-        - Boss Relic 1
-      world: true
-      count: 2
-  
-  # example block 5 - A Link to the Past
-    - items:
-        Progressive Sword: 4
-      world:
-        - BobsSlaytheSpire
-        - BobsRogueLegacy
-      count:
-        min: 1
-        max: 4
+      from_pool: false
+      
+    - item: Kokiri Sword
+      location: Deku Tree Slingshot Chest
+      from_pool: false
 ```
-1. This block has a 50% chance to occur, and if it does, it will place either the Empire Orb or Radiant Orb on another
-player's Starter Chest 1 and removes the chosen item from the item pool.
-2. This block will always trigger and will place the player's swords, bow, magic meter, strength upgrades, and hookshots
-in their own dungeon major item chests.
-3. This block has an 80% chance of occurring, and when it does, it will place all but 1 of the items randomly among the
-four locations chosen here.
-4. This block will always trigger and will attempt to place a random 2 of Levitate, Revealer and Energize into
-other players' Master Sword Pedestals or Boss Relic 1 locations.
-5. This block will always trigger and will attempt to place a random number, between 1 and 4, of progressive swords
-into any locations within the game slots named BobsSlaytheSpire and BobsRogueLegacy.
-
+The first block will place the player's Biggoron Sword, Bow, Magic Meter, strength upgrades, and hookshots in the 
+dungeon major item chests. Because the from_pool value is `false`, a copy of these items is added to these locations, 
+while the originals remain in the item pool to be shuffled. The second block will place the Kokiri Sword in the Deku 
+Tree Slingshot Chest, again not from the pool.
 
 ## Boss Plando
 
@@ -194,7 +260,7 @@ relevant guide: [A Link to the Past Plando Guide](/tutorial/A%20Link%20to%20the%
 
 ## Connection Plando
 
-This is currently only supported by a few games, including A Link to the Past, Minecraft, and Ocarina of Time. As the way that these games interact with their
+This is currently only supported by a few games, including A Link to the Past and Ocarina of Time. As the way that these games interact with their
 connections is different, only the basics are explained here. More specific information for connection plando in A Link to the Past can be found in 
 its [plando guide](/tutorial/A%20Link%20to%20the%20Past/plando/en#connections).
 
@@ -207,7 +273,6 @@ its [plando guide](/tutorial/A%20Link%20to%20the%20Past/plando/en#connections).
 
 [A Link to the Past connections](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/EntranceShuffle.py#L3852)
 
-[Minecraft connections](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/data/regions.json#L18****)
 
 ### Examples
 
@@ -223,19 +288,10 @@ its [plando guide](/tutorial/A%20Link%20to%20the%20Past/plando/en#connections).
     - entrance: Agahnims Tower
       exit: Old Man Cave Exit (West)
       direction: exit
-  
-    # example block 2 - Minecraft
-    - entrance: Overworld Structure 1
-      exit: Nether Fortress
-      direction: both
-    - entrance: Overworld Structure 2
-      exit: Village
-      direction: both
+
 ```
 
 1. These connections are decoupled, so going into the Lake Hylia Cave Shop will take you to the inside of Cave 45, and
    when you leave the interior, you will exit to the Cave 45 ledge. Going into the Cave 45 entrance will then take you to
    the Lake Hylia Cave Shop. Walking into the entrance for the Old Man Cave and Agahnim's Tower entrance will both take
    you to their locations as normal, but leaving Old Man Cave will exit at Agahnim's Tower.
-2. This will force a Nether fortress and a village to be the Overworld structures for your game. Note that for the
-   Minecraft connection plando to work structure shuffle must be enabled.

worlds/jakanddaxter/__init__.py

@@ -34,9 +34,9 @@ from .locations import (JakAndDaxterLocation,
                         cache_location_table,
                         orb_location_table)
 from .regions import create_regions
-from .rules import (enforce_multiplayer_limits,
-                    enforce_singleplayer_limits,
-                    verify_orb_trade_amounts,
+from .rules import (enforce_mp_absolute_limits,
+                    enforce_mp_friendly_limits,
+                    enforce_sp_limits,
                     set_orb_trade_rule)
 from .locs import (cell_locations as cells,
                    scout_locations as scouts,
@@ -258,18 +258,31 @@ class JakAndDaxterWorld(World):
             self.options.mountain_pass_cell_count.value = self.power_cell_thresholds[1]
             self.options.lava_tube_cell_count.value = self.power_cell_thresholds[2]
 
-        # Store this for remove function.
-        self.power_cell_thresholds_minus_one = [x - 1 for x in self.power_cell_thresholds]
-
-        # For the fairness of other players in a multiworld game, enforce some friendly limitations on our options,
-        # so we don't cause chaos during seed generation. These friendly limits should **guarantee** a successful gen.
-        # We would have done this earlier, but we needed to sort the power cell thresholds first.
+        # We would have done this earlier, but we needed to sort the power cell thresholds first. Don't worry, we'll
+        # come back to them.
         enforce_friendly_options = self.settings.enforce_friendly_options
-        if enforce_friendly_options:
-            if self.multiworld.players > 1:
-                enforce_multiplayer_limits(self)
+        if self.multiworld.players == 1:
+            # For singleplayer games, always enforce/clamp the cell counts to valid values.
+            enforce_sp_limits(self)
+        else:
+            if enforce_friendly_options:
+                # For multiplayer games, we have a host setting to make options fair/sane for other players.
+                # If this setting is enabled, enforce/clamp some friendly limitations on our options.
+                enforce_mp_friendly_limits(self)
             else:
-                enforce_singleplayer_limits(self)
+                # Even if the setting is disabled, some values must be clamped to avoid generation errors.
+                enforce_mp_absolute_limits(self)
+
+        # That's right, set the collection of thresholds again. Don't just clamp the values without updating this list!
+        self.power_cell_thresholds = [
+            self.options.fire_canyon_cell_count.value,
+            self.options.mountain_pass_cell_count.value,
+            self.options.lava_tube_cell_count.value,
+            100,  # The 100 Power Cell Door.
+        ]
+
+        # Now that the threshold list is finalized, store this for the remove function.
+        self.power_cell_thresholds_minus_one = [x - 1 for x in self.power_cell_thresholds]
 
         # Calculate the number of power cells needed for full region access, the number being replaced by traps,
         # and the number of remaining filler.
@@ -282,11 +295,6 @@ class JakAndDaxterWorld(World):
         self.options.filler_power_cells_replaced_with_traps.value = self.total_trap_cells
         self.total_filler_cells = non_prog_cells - self.total_trap_cells
 
-        # Verify that we didn't overload the trade amounts with more orbs than exist in the world.
-        # This is easy to do by accident even in a singleplayer world.
-        self.total_trade_orbs = (9 * self.options.citizen_orb_trade_amount) + (6 * self.options.oracle_orb_trade_amount)
-        verify_orb_trade_amounts(self)
-
         # Cache the orb bundle size and item name for quicker reference.
         if self.options.enable_orbsanity == options.EnableOrbsanity.option_per_level:
             self.orb_bundle_size = self.options.level_orbsanity_bundle_size.value

worlds/jakanddaxter/client.py

@@ -367,7 +367,7 @@ def find_root_directory(ctx: JakAndDaxterContext):
                         f"   Close all launchers, games, clients, and console windows, then restart Archipelago.")
 
     if not os.path.exists(settings_path):
-        msg = (f"{err_title}: the OpenGOAL settings file does not exist.\n"
+        msg = (f"{err_title}: The OpenGOAL settings file does not exist.\n"
                f"{alt_instructions}")
         ctx.on_log_error(logger, msg)
         return
@@ -375,14 +375,44 @@ def find_root_directory(ctx: JakAndDaxterContext):
     with open(settings_path, "r") as f:
         load = json.load(f)
 
-        jak1_installed = load["games"]["Jak 1"]["isInstalled"]
+        # This settings file has changed format once before, and may do so again in the future.
+        # Guard against future incompatibilities by checking the file version first, and use that to determine
+        # what JSON keys to look for next.
+        try:
+            settings_version = load["version"]
+            logger.debug(f"OpenGOAL settings file version: {settings_version}")
+        except KeyError:
+            msg = (f"{err_title}: The OpenGOAL settings file has no version number!\n"
+                   f"{alt_instructions}")
+            ctx.on_log_error(logger, msg)
+            return
+
+        try:
+            if settings_version == "2.0":
+                jak1_installed = load["games"]["Jak 1"]["isInstalled"]
+                mod_sources = load["games"]["Jak 1"]["modsInstalledVersion"]
+
+            elif settings_version == "3.0":
+                jak1_installed = load["games"]["jak1"]["isInstalled"]
+                mod_sources = load["games"]["jak1"]["mods"]
+
+            else:
+                msg = (f"{err_title}: The OpenGOAL settings file has an unknown version number ({settings_version}).\n"
+                       f"{alt_instructions}")
+                ctx.on_log_error(logger, msg)
+                return
+        except KeyError as e:
+            msg = (f"{err_title}: The OpenGOAL settings file does not contain key entry {e}!\n"
+                   f"{alt_instructions}")
+            ctx.on_log_error(logger, msg)
+            return
+
         if not jak1_installed:
             msg = (f"{err_title}: The OpenGOAL Launcher is missing a normal install of Jak 1!\n"
                    f"{alt_instructions}")
             ctx.on_log_error(logger, msg)
             return
 
-        mod_sources = load["games"]["Jak 1"]["modsInstalledVersion"]
         if mod_sources is None:
             msg = (f"{err_title}: No mod sources have been configured in the OpenGOAL Launcher!\n"
                    f"{alt_instructions}")

worlds/jakanddaxter/docs/en_Jak and Daxter The Precursor Legacy.md

@@ -18,7 +18,7 @@
 - [What do Traps do?](#what-do-traps-do)
 - [What kind of Traps are there?](#what-kind-of-traps-are-there)
 - [I got soft-locked and cannot leave, how do I get out of here?](#i-got-soft-locked-and-cannot-leave-how-do-i-get-out-of-here)
-- [Why did I get an Option Error when generating a seed, and how do I fix it?](#why-did-i-get-an-option-error-when-generating-a-seed-and-how-do-i-fix-it)
+- [How do I generate seeds with 1 Orb Orbsanity and other extreme options?](#how-do-i-generate-seeds-with-1-orb-orbsanity-and-other-extreme-options)
 - [How do I check my player options in-game?](#how-do-i-check-my-player-options-in-game)
 - [How does the HUD work?](#how-does-the-hud-work)
 - [I think I found a bug, where should I report it?](#i-think-i-found-a-bug-where-should-i-report-it)
@@ -201,16 +201,19 @@ Open the game's menu, navigate to `Options`, then `Archipelago Options`, then `W
 Selecting this option will ask if you want to be teleported to Geyser Rock. From there, you can teleport back 
 to the nearest sage's hut to continue your journey.
 
-## Why did I get an Option Error when generating a seed and how do I fix it
+## How do I generate seeds with 1 orb orbsanity and other extreme options?
 Depending on your player YAML, Jak and Daxter can have a lot of items, which can sometimes be overwhelming or 
 disruptive to multiworld games. There are also options that are mutually incompatible with each other, even in a solo
 game. To prevent the game from disrupting multiworlds, or generating an impossible solo seed, some options have
-Singleplayer and Multiplayer Minimums and Maximums, collectively called "friendly limits."
+"friendly limits" that prevent you from choosing more extreme values.
 
-If you're generating a solo game, or your multiworld host agrees to your request, you can override those limits by
-editing the `host.yaml`. In the Archipelago Launcher, click `Open host.yaml`, then search for `jakanddaxter_options`,
-then search for `enforce_friendly_options`, then change this value from `true` to `false`. Disabling this allows for 
-more disruptive and challenging options, but it may cause seed generation to fail. **Use at your own risk!**
+You can override **some**, not all, of those limits by editing the `host.yaml`. In the Archipelago Launcher, click 
+`Open host.yaml`, then search for `jakanddaxter_options`, then search for `enforce_friendly_options`, then change this 
+value from `true` to `false`. You can then generate a seed locally, and upload that to the Archipelago website to host
+for you (or host it yourself). 
+
+**Remember:** disabling this setting allows for more disruptive and challenging options, but it may cause seed 
+generation to fail. **Use at your own risk!**
 
 ## How do I check my player options in-game
 When you connect your text client to the Archipelago Server, the server will tell the game what options were chosen

worlds/jakanddaxter/docs/setup_en.md

@@ -4,7 +4,6 @@
 
 - A legally purchased copy of *Jak And Daxter: The Precursor Legacy.*
 - [The OpenGOAL Launcher](https://opengoal.dev/)
-- [The Jak and Daxter .APWORLD package](https://github.com/ArchipelaGOAL/Archipelago/releases)
 
 At this time, this method of setup works on Windows only, but Linux support is a strong likelihood in the near future as OpenGOAL itself supports Linux.
 
@@ -75,7 +74,7 @@ If you are in the middle of an async game, and you do not want to update the mod
 ### New Game
 
 - Run the Archipelago Launcher.
-- From the right-most list, find and click `Jak and Daxter Client`.
+- From the client list, find and click `Jak and Daxter Client`.
 - 3 new windows should appear:
     - The OpenGOAL compiler will launch and compile the game. They should take about 30 seconds to compile.
         - You should hear a musical cue to indicate the compilation was a success. If you do not, see the Troubleshooting section.

worlds/jakanddaxter/options.py

@@ -1,22 +1,78 @@
 from dataclasses import dataclass
 from functools import cached_property
-from Options import PerGameCommonOptions, StartInventoryPool, Toggle, Choice, Range, DefaultOnToggle, OptionCounter
+from Options import PerGameCommonOptions, StartInventoryPool, Toggle, Choice, Range, DefaultOnToggle, OptionCounter, \
+    AssembleOptions
 from .items import trap_item_table
 
 
-class StaticGetter:
-    def __init__(self, func):
-        self.fget = func
+class readonly_classproperty:
+    """This decorator is used for getting friendly or unfriendly range_end values for options like FireCanyonCellCount
+    and CitizenOrbTradeAmount. We only need to provide a getter as we will only be setting a single int to one of two
+    values."""
+    def __init__(self, getter):
+        self.getter = getter
 
     def __get__(self, instance, owner):
-        return self.fget(owner)
+        return self.getter(owner)
 
 
-@StaticGetter
+@readonly_classproperty
 def determine_range_end(cls) -> int:
-    from . import JakAndDaxterWorld
-    enforce_friendly_options = JakAndDaxterWorld.settings.enforce_friendly_options
-    return cls.friendly_maximum if enforce_friendly_options else cls.absolute_maximum
+    from . import JakAndDaxterWorld  # Avoid circular imports.
+    friendly = JakAndDaxterWorld.settings.enforce_friendly_options
+    return cls.friendly_maximum if friendly else cls.absolute_maximum
+
+
+class classproperty:
+    """This decorator (?) is used for getting and setting friendly or unfriendly option values for the Orbsanity
+    options."""
+    def __init__(self, getter, setter):
+        self.getter = getter
+        self.setter = setter
+
+    def __get__(self, obj, value):
+        return self.getter(obj)
+
+    def __set__(self, obj, value):
+        self.setter(obj, value)
+
+
+class AllowedChoiceMeta(AssembleOptions):
+    """This metaclass overrides AssembleOptions and provides inheriting classes a way to filter out "disallowed" values
+    by way of implementing get_disallowed_options. This function is used by Jak and Daxter to check host.yaml settings
+    without circular imports or breaking the settings API."""
+    _name_lookup: dict[int, str]
+    _options: dict[str, int]
+
+    def __new__(mcs, name, bases, attrs):
+        ret = super().__new__(mcs, name, bases, attrs)
+        ret._name_lookup = attrs["name_lookup"]
+        ret._options = attrs["options"]
+        return ret
+
+    def set_name_lookup(cls, value : dict[int, str]):
+        cls._name_lookup = value
+
+    def get_name_lookup(cls) -> dict[int, str]:
+        cls._name_lookup = {k: v for k, v in cls._name_lookup.items() if k not in cls.get_disallowed_options()}
+        return cls._name_lookup
+
+    def set_options(cls, value: dict[str, int]):
+        cls._options = value
+
+    def get_options(cls) -> dict[str, int]:
+        cls._options = {k: v for k, v in cls._options.items() if v not in cls.get_disallowed_options()}
+        return cls._options
+
+    def get_disallowed_options(cls):
+        return {}
+
+    name_lookup = classproperty(get_name_lookup, set_name_lookup)
+    options = classproperty(get_options, set_options)
+
+
+class AllowedChoice(Choice, metaclass=AllowedChoiceMeta):
+    pass
 
 
 class EnableMoveRandomizer(Toggle):
@@ -44,12 +100,13 @@ class EnableOrbsanity(Choice):
     default = 0
 
 
-class GlobalOrbsanityBundleSize(Choice):
+class GlobalOrbsanityBundleSize(AllowedChoice):
     """The orb bundle size for Global Orbsanity. This only applies if "Enable Orbsanity" is set to "Global."
     There are 2000 orbs in the game, so your bundle size must be a factor of 2000.
 
-    Multiplayer Minimum: 10
-    Multiplayer Maximum: 200"""
+    This value is restricted to safe minimum and maximum values to ensure valid singleplayer games and
+    non-disruptive multiplayer games, but the host can remove this restriction by turning off enforce_friendly_options
+    in host.yaml."""
     display_name = "Global Orbsanity Bundle Size"
     option_1_orb = 1
     option_2_orbs = 2
@@ -75,12 +132,33 @@ class GlobalOrbsanityBundleSize(Choice):
     friendly_maximum = 200
     default = 20
 
+    @classmethod
+    def get_disallowed_options(cls) -> set[int]:
+        try:
+            from . import JakAndDaxterWorld
+            if JakAndDaxterWorld.settings.enforce_friendly_options:
+                return {cls.option_1_orb,
+                        cls.option_2_orbs,
+                        cls.option_4_orbs,
+                        cls.option_5_orbs,
+                        cls.option_8_orbs,
+                        cls.option_250_orbs,
+                        cls.option_400_orbs,
+                        cls.option_500_orbs,
+                        cls.option_1000_orbs,
+                        cls.option_2000_orbs}
+        except ImportError:
+            pass
+        return set()
 
-class PerLevelOrbsanityBundleSize(Choice):
+
+class PerLevelOrbsanityBundleSize(AllowedChoice):
     """The orb bundle size for Per Level Orbsanity. This only applies if "Enable Orbsanity" is set to "Per Level."
     There are 50, 150, or 200 orbs per level, so your bundle size must be a factor of 50.
 
-    Multiplayer Minimum: 10"""
+    This value is restricted to safe minimum and maximum values to ensure valid singleplayer games and
+    non-disruptive multiplayer games, but the host can remove this restriction by turning off enforce_friendly_options
+    in host.yaml."""
     display_name = "Per Level Orbsanity Bundle Size"
     option_1_orb = 1
     option_2_orbs = 2
@@ -91,6 +169,18 @@ class PerLevelOrbsanityBundleSize(Choice):
     friendly_minimum = 10
     default = 25
 
+    @classmethod
+    def get_disallowed_options(cls) -> set[int]:
+        try:
+            from . import JakAndDaxterWorld
+            if JakAndDaxterWorld.settings.enforce_friendly_options:
+                return {cls.option_1_orb,
+                        cls.option_2_orbs,
+                        cls.option_5_orbs}
+        except ImportError:
+            pass
+        return set()
+
 
 class FireCanyonCellCount(Range):
     """The number of power cells you need to cross Fire Canyon. This value is restricted to a safe maximum value to
@@ -234,7 +324,7 @@ class CompletionCondition(Choice):
     option_cross_fire_canyon = 69
     option_cross_mountain_pass = 87
     option_cross_lava_tube = 89
-    option_defeat_dark_eco_plant = 6
+    # option_defeat_dark_eco_plant = 6
     option_defeat_klaww = 86
     option_defeat_gol_and_maia = 112
     option_open_100_cell_door = 116

worlds/jakanddaxter/regions.py

@@ -115,8 +115,8 @@ def create_regions(world: "JakAndDaxterWorld"):
     elif options.jak_completion_condition == CompletionCondition.option_cross_lava_tube:
         multiworld.completion_condition[player] = lambda state: state.can_reach(gmc, "Region", player)
 
-    elif options.jak_completion_condition == CompletionCondition.option_defeat_dark_eco_plant:
-        multiworld.completion_condition[player] = lambda state: state.can_reach(fjp, "Region", player)
+    # elif options.jak_completion_condition == CompletionCondition.option_defeat_dark_eco_plant:
+    #     multiworld.completion_condition[player] = lambda state: state.can_reach(fjp, "Region", player)
 
     elif options.jak_completion_condition == CompletionCondition.option_defeat_klaww:
         multiworld.completion_condition[player] = lambda state: state.can_reach(mp, "Region", player)

worlds/jakanddaxter/rules.py

@@ -1,3 +1,5 @@
+import logging
+import math
 import typing
 from BaseClasses import CollectionState
 from Options import OptionError
@@ -131,100 +133,138 @@ def can_fight(state: CollectionState, player: int) -> bool:
     return state.has_any(("Jump Dive", "Jump Kick", "Punch", "Kick"), player)
 
 
-def enforce_multiplayer_limits(world: "JakAndDaxterWorld"):
+def clamp_cell_limits(world: "JakAndDaxterWorld") -> str:
     options = world.options
     friendly_message = ""
 
-    if (options.enable_orbsanity == EnableOrbsanity.option_global
-            and (options.global_orbsanity_bundle_size.value < GlobalOrbsanityBundleSize.friendly_minimum
-                 or options.global_orbsanity_bundle_size.value > GlobalOrbsanityBundleSize.friendly_maximum)):
-        friendly_message += (f"  "
-                             f"{options.global_orbsanity_bundle_size.display_name} must be no less than "
-                             f"{GlobalOrbsanityBundleSize.friendly_minimum} and no greater than "
-                             f"{GlobalOrbsanityBundleSize.friendly_maximum} (currently "
-                             f"{options.global_orbsanity_bundle_size.value}).\n")
-
-    if (options.enable_orbsanity == EnableOrbsanity.option_per_level
-            and options.level_orbsanity_bundle_size.value < PerLevelOrbsanityBundleSize.friendly_minimum):
-        friendly_message += (f"  "
-                             f"{options.level_orbsanity_bundle_size.display_name} must be no less than "
-                             f"{PerLevelOrbsanityBundleSize.friendly_minimum} (currently "
-                             f"{options.level_orbsanity_bundle_size.value}).\n")
-
     if options.fire_canyon_cell_count.value > FireCanyonCellCount.friendly_maximum:
+        old_value = options.fire_canyon_cell_count.value
+        options.fire_canyon_cell_count.value = FireCanyonCellCount.friendly_maximum
         friendly_message += (f"  "
                              f"{options.fire_canyon_cell_count.display_name} must be no greater than "
-                             f"{FireCanyonCellCount.friendly_maximum} (currently "
-                             f"{options.fire_canyon_cell_count.value}).\n")
+                             f"{FireCanyonCellCount.friendly_maximum} (was {old_value}), "
+                             f"changed option to appropriate value.\n")
 
     if options.mountain_pass_cell_count.value > MountainPassCellCount.friendly_maximum:
+        old_value = options.mountain_pass_cell_count.value
+        options.mountain_pass_cell_count.value = MountainPassCellCount.friendly_maximum
         friendly_message += (f"  "
                              f"{options.mountain_pass_cell_count.display_name} must be no greater than "
-                             f"{MountainPassCellCount.friendly_maximum} (currently "
-                             f"{options.mountain_pass_cell_count.value}).\n")
+                             f"{MountainPassCellCount.friendly_maximum} (was {old_value}), "
+                             f"changed option to appropriate value.\n")
 
     if options.lava_tube_cell_count.value > LavaTubeCellCount.friendly_maximum:
+        old_value = options.lava_tube_cell_count.value
+        options.lava_tube_cell_count.value = LavaTubeCellCount.friendly_maximum
         friendly_message += (f"  "
                              f"{options.lava_tube_cell_count.display_name} must be no greater than "
-                             f"{LavaTubeCellCount.friendly_maximum} (currently "
-                             f"{options.lava_tube_cell_count.value}).\n")
+                             f"{LavaTubeCellCount.friendly_maximum} (was {old_value}), "
+                             f"changed option to appropriate value.\n")
+
+    return friendly_message
+
+
+def clamp_trade_total_limits(world: "JakAndDaxterWorld"):
+    """Check if we need to recalculate the 2 trade orb options so the total fits under 2000. If so let's keep them
+    proportional relative to each other. Then we'll recalculate total_trade_orbs. Remember this situation is
+    only possible if both values are greater than 0, otherwise the absolute maximums would keep them under 2000."""
+    options = world.options
+    friendly_message = ""
+
+    world.total_trade_orbs = (9 * options.citizen_orb_trade_amount) + (6 * options.oracle_orb_trade_amount)
+    if world.total_trade_orbs > 2000:
+        old_total = world.total_trade_orbs
+        old_citizen_value = options.citizen_orb_trade_amount.value
+        old_oracle_value = options.oracle_orb_trade_amount.value
+
+        coefficient = old_oracle_value / old_citizen_value
+
+        options.citizen_orb_trade_amount.value = math.floor(2000 / (9 + (6 * coefficient)))
+        options.oracle_orb_trade_amount.value = math.floor(coefficient * options.citizen_orb_trade_amount.value)
+        world.total_trade_orbs = (9 * options.citizen_orb_trade_amount) + (6 * options.oracle_orb_trade_amount)
+
+        friendly_message += (f"  "
+                             f"Required number of orbs ({old_total}) must be no greater than total orbs in the game "
+                             f"(2000). Reduced the value of {world.options.citizen_orb_trade_amount.display_name} "
+                             f"from {old_citizen_value} to {options.citizen_orb_trade_amount.value} and "
+                             f"{world.options.oracle_orb_trade_amount.display_name} from {old_oracle_value} to "
+                             f"{options.oracle_orb_trade_amount.value}.\n")
+
+    return friendly_message
+
+
+def enforce_mp_friendly_limits(world: "JakAndDaxterWorld"):
+    options = world.options
+    friendly_message = ""
+
+    if options.enable_orbsanity == EnableOrbsanity.option_global:
+        if options.global_orbsanity_bundle_size.value < GlobalOrbsanityBundleSize.friendly_minimum:
+            old_value = options.global_orbsanity_bundle_size.value
+            options.global_orbsanity_bundle_size.value = GlobalOrbsanityBundleSize.friendly_minimum
+            friendly_message += (f"  "
+                                 f"{options.global_orbsanity_bundle_size.display_name} must be no less than "
+                                 f"{GlobalOrbsanityBundleSize.friendly_minimum} (was {old_value}), "
+                                 f"changed option to appropriate value.\n")
+
+        if options.global_orbsanity_bundle_size.value > GlobalOrbsanityBundleSize.friendly_maximum:
+            old_value = options.global_orbsanity_bundle_size.value
+            options.global_orbsanity_bundle_size.value = GlobalOrbsanityBundleSize.friendly_maximum
+            friendly_message += (f"  "
+                                 f"{options.global_orbsanity_bundle_size.display_name} must be no greater than "
+                                 f"{GlobalOrbsanityBundleSize.friendly_maximum} (was {old_value}), "
+                                 f"changed option to appropriate value.\n")
+
+    if options.enable_orbsanity == EnableOrbsanity.option_per_level:
+        if options.level_orbsanity_bundle_size.value < PerLevelOrbsanityBundleSize.friendly_minimum:
+            old_value = options.level_orbsanity_bundle_size.value
+            options.level_orbsanity_bundle_size.value = PerLevelOrbsanityBundleSize.friendly_minimum
+            friendly_message += (f"  "
+                                 f"{options.level_orbsanity_bundle_size.display_name} must be no less than "
+                                 f"{PerLevelOrbsanityBundleSize.friendly_minimum} (was {old_value}), "
+                                 f"changed option to appropriate value.\n")
 
     if options.citizen_orb_trade_amount.value > CitizenOrbTradeAmount.friendly_maximum:
+        old_value = options.citizen_orb_trade_amount.value
+        options.citizen_orb_trade_amount.value = CitizenOrbTradeAmount.friendly_maximum
         friendly_message += (f"  "
                              f"{options.citizen_orb_trade_amount.display_name} must be no greater than "
-                             f"{CitizenOrbTradeAmount.friendly_maximum} (currently "
-                             f"{options.citizen_orb_trade_amount.value}).\n")
+                             f"{CitizenOrbTradeAmount.friendly_maximum} (was {old_value}), "
+                             f"changed option to appropriate value.\n")
 
     if options.oracle_orb_trade_amount.value > OracleOrbTradeAmount.friendly_maximum:
+        old_value = options.oracle_orb_trade_amount.value
+        options.oracle_orb_trade_amount.value = OracleOrbTradeAmount.friendly_maximum
         friendly_message += (f"  "
                              f"{options.oracle_orb_trade_amount.display_name} must be no greater than "
-                             f"{OracleOrbTradeAmount.friendly_maximum} (currently "
-                             f"{options.oracle_orb_trade_amount.value}).\n")
+                             f"{OracleOrbTradeAmount.friendly_maximum} (was {old_value}), "
+                             f"changed option to appropriate value.\n")
+
+    friendly_message += clamp_cell_limits(world)
+    friendly_message += clamp_trade_total_limits(world)
 
     if friendly_message != "":
-        raise OptionError(f"{world.player_name}: The options you have chosen may disrupt the multiworld. \n"
-                          f"Please adjust the following Options for a multiplayer game. \n"
-                          f"{friendly_message}"
-                          f"Or use 'random-range-x-y' instead of 'random' in your player yaml.\n"
-                          f"Or set 'enforce_friendly_options' in the seed generator's host.yaml to false. "
-                          f"(Use at your own risk!)")
+        logging.warning(f"{world.player_name}: Your options have been modified to avoid disrupting the multiworld.\n"
+                        f"{friendly_message}"
+                        f"You can access more advanced options by setting 'enforce_friendly_options' in the seed "
+                        f"generator's host.yaml to false and generating locally. (Use at your own risk!)")
 
 
-def enforce_singleplayer_limits(world: "JakAndDaxterWorld"):
-    options = world.options
+def enforce_mp_absolute_limits(world: "JakAndDaxterWorld"):
     friendly_message = ""
 
-    if options.fire_canyon_cell_count.value > FireCanyonCellCount.friendly_maximum:
-        friendly_message += (f"  "
-                             f"{options.fire_canyon_cell_count.display_name} must be no greater than "
-                             f"{FireCanyonCellCount.friendly_maximum} (currently "
-                             f"{options.fire_canyon_cell_count.value}).\n")
-
-    if options.mountain_pass_cell_count.value > MountainPassCellCount.friendly_maximum:
-        friendly_message += (f"  "
-                             f"{options.mountain_pass_cell_count.display_name} must be no greater than "
-                             f"{MountainPassCellCount.friendly_maximum} (currently "
-                             f"{options.mountain_pass_cell_count.value}).\n")
-
-    if options.lava_tube_cell_count.value > LavaTubeCellCount.friendly_maximum:
-        friendly_message += (f"  "
-                             f"{options.lava_tube_cell_count.display_name} must be no greater than "
-                             f"{LavaTubeCellCount.friendly_maximum} (currently "
-                             f"{options.lava_tube_cell_count.value}).\n")
+    friendly_message += clamp_trade_total_limits(world)
 
     if friendly_message != "":
-        raise OptionError(f"The options you have chosen may result in seed generation failures. \n"
-                          f"Please adjust the following Options for a singleplayer game. \n"
-                          f"{friendly_message}"
-                          f"Or use 'random-range-x-y' instead of 'random' in your player yaml.\n"
-                          f"Or set 'enforce_friendly_options' in your host.yaml to false. "
-                          f"(Use at your own risk!)")
+        logging.warning(f"{world.player_name}: Your options have been modified to avoid seed generation failures.\n"
+                        f"{friendly_message}")
 
 
-def verify_orb_trade_amounts(world: "JakAndDaxterWorld"):
+def enforce_sp_limits(world: "JakAndDaxterWorld"):
+    friendly_message = ""
 
-    if world.total_trade_orbs > 2000:
-        raise OptionError(f"{world.player_name}: Required number of orbs for all trades ({world.total_trade_orbs}) "
-                          f"is more than all the orbs in the game (2000). Reduce the value of either "
-                          f"{world.options.citizen_orb_trade_amount.display_name} "
-                          f"or {world.options.oracle_orb_trade_amount.display_name}.")
+    friendly_message += clamp_cell_limits(world)
+    friendly_message += clamp_trade_total_limits(world)
+
+    if friendly_message != "":
+        logging.warning(f"{world.player_name}: Your options have been modified to avoid seed generation failures.\n"
+                        f"{friendly_message}")

worlds/jakanddaxter/test/test_trades.py

@@ -4,14 +4,14 @@ from .bases import JakAndDaxterTestBase
 class TradesCostNothingTest(JakAndDaxterTestBase):
     options = {
         "enable_orbsanity": 2,
-        "global_orbsanity_bundle_size": 5,
+        "global_orbsanity_bundle_size": 10,
         "citizen_orb_trade_amount": 0,
         "oracle_orb_trade_amount": 0
     }
 
     def test_orb_items_are_filler(self):
         self.collect_all_but("")
-        self.assertNotIn("5 Precursor Orbs", self.multiworld.state.prog_items)
+        self.assertNotIn("10 Precursor Orbs", self.multiworld.state.prog_items)
 
     def test_trades_are_accessible(self):
         self.assertTrue(self.multiworld
@@ -22,15 +22,15 @@ class TradesCostNothingTest(JakAndDaxterTestBase):
 class TradesCostEverythingTest(JakAndDaxterTestBase):
     options = {
         "enable_orbsanity": 2,
-        "global_orbsanity_bundle_size": 5,
+        "global_orbsanity_bundle_size": 10,
         "citizen_orb_trade_amount": 120,
         "oracle_orb_trade_amount": 150
     }
 
     def test_orb_items_are_progression(self):
         self.collect_all_but("")
-        self.assertIn("5 Precursor Orbs", self.multiworld.state.prog_items[self.player])
-        self.assertEqual(396, self.multiworld.state.prog_items[self.player]["5 Precursor Orbs"])
+        self.assertIn("10 Precursor Orbs", self.multiworld.state.prog_items[self.player])
+        self.assertEqual(198, self.multiworld.state.prog_items[self.player]["10 Precursor Orbs"])
 
     def test_trades_are_accessible(self):
         self.collect_all_but("")

worlds/kdl3/client.py

@@ -90,7 +90,7 @@ def cmd_gift(self: "SNIClientCommandProcessor") -> None:
     async_start(update_object(self.ctx, f"Giftboxes;{self.ctx.team}", {
         f"{self.ctx.slot}":
             {
-                "IsOpen": handler.gifting,
+                "is_open": handler.gifting,
                 **kdl3_gifting_options
             }
     }))
@@ -175,11 +175,11 @@ class KDL3SNIClient(SNIClient):
             key, gift = ctx.stored_data[self.giftbox_key].popitem()
             await pop_object(ctx, self.giftbox_key, key)
             # first, special cases
-            traits = [trait["Trait"] for trait in gift["Traits"]]
+            traits = [trait["trait"] for trait in gift["traits"]]
             if "Candy" in traits or "Invincible" in traits:
                 # apply invincibility candy
                 self.item_queue.append(0x43)
-            elif "Tomato" in traits or "tomato" in gift["ItemName"].lower():
+            elif "Tomato" in traits or "tomato" in gift["item_name"].lower():
                 # apply maxim tomato
                 # only want tomatos here, no other vegetable is that good
                 self.item_queue.append(0x42)
@@ -187,7 +187,7 @@ class KDL3SNIClient(SNIClient):
                 # Apply 1-Up
                 self.item_queue.append(0x41)
             elif "Currency" in traits or "Star" in traits:
-                value = gift["ItemValue"]
+                value = gift.get("item_value", 1)
                 if value >= 50000:
                     self.item_queue.append(0x46)
                 elif value >= 30000:
@@ -210,8 +210,8 @@ class KDL3SNIClient(SNIClient):
                 # check if it's tasty
                 if any(x in traits for x in ["Consumable", "Food", "Drink", "Heal", "Health"]):
                     # it's tasty!, use quality to decide how much to heal
-                    quality = max((trait["Quality"] for trait in gift["Traits"]
-                                   if trait["Trait"] in ["Consumable", "Food", "Drink", "Heal", "Health"]))
+                    quality = max((trait.get("quality", 1.0) for trait in gift["traits"]
+                                   if trait["trait"] in ["Consumable", "Food", "Drink", "Heal", "Health"]))
                     quality = min(10, quality * 2)
                 else:
                     # it's not really edible, but he'll eat it anyway
@@ -236,23 +236,23 @@ class KDL3SNIClient(SNIClient):
         for slot, info in ctx.stored_data[self.motherbox_key].items():
             if int(slot) == ctx.slot and len(ctx.stored_data[self.motherbox_key]) > 1:
                 continue
-            desire = len(set(info["DesiredTraits"]).intersection([trait["Trait"] for trait in gift_base["Traits"]]))
+            desire = len(set(info["desired_traits"]).intersection([trait["trait"] for trait in gift_base["traits"]]))
             if desire > most_applicable:
                 most_applicable = desire
                 most_applicable_slot = int(slot)
-            elif most_applicable_slot != ctx.slot and most_applicable == -1 and info["AcceptsAnyGift"]:
+            elif most_applicable_slot == ctx.slot and most_applicable == -1 and info["accepts_any_gift"]:
                 # only send to ourselves if no one else will take it
                 most_applicable_slot = int(slot)
         # print(most_applicable, most_applicable_slot)
         item_uuid = uuid.uuid4().hex
         item = {
             **gift_base,
-            "ID": item_uuid,
-            "Sender": ctx.player_names[ctx.slot],
-            "Receiver": ctx.player_names[most_applicable_slot],
-            "SenderTeam": ctx.team,
-            "ReceiverTeam": ctx.team,  # for the moment
-            "IsRefund": False
+            "id": item_uuid,
+            "sender_slot": ctx.slot,
+            "receiver_slot": most_applicable_slot,
+            "sender_team": ctx.team,
+            "receiver_team": ctx.team,  # for the moment
+            "is_refund": False
         }
         # print(item)
         await update_object(ctx, f"Giftbox;{ctx.team};{most_applicable_slot}", {
@@ -276,8 +276,9 @@ class KDL3SNIClient(SNIClient):
             if not self.initialize_gifting:
                 self.giftbox_key = f"Giftbox;{ctx.team};{ctx.slot}"
                 self.motherbox_key = f"Giftboxes;{ctx.team}"
-                enable_gifting = await snes_read(ctx, KDL3_GIFTING_FLAG, 0x01)
-                await initialize_giftboxes(ctx, self.giftbox_key, self.motherbox_key, bool(enable_gifting[0]))
+                enable_gifting = await snes_read(ctx, KDL3_GIFTING_FLAG, 0x02)
+                await initialize_giftboxes(ctx, self.giftbox_key, self.motherbox_key,
+                                           bool(int.from_bytes(enable_gifting, "little")))
                 self.initialize_gifting = True
             # can't check debug anymore, without going and copying the value. might be important later.
             if not self.levels:
@@ -350,19 +351,19 @@ class KDL3SNIClient(SNIClient):
                     self.item_queue.append(item_idx | 0x80)
 
             # handle gifts here
-            gifting_status = await snes_read(ctx, KDL3_GIFTING_FLAG, 0x01)
-            if hasattr(ctx, "gifting") and ctx.gifting:
-                if gifting_status[0]:
+            gifting_status = int.from_bytes(await snes_read(ctx, KDL3_GIFTING_FLAG, 0x02), "little")
+            if hasattr(self, "gifting") and self.gifting:
+                if gifting_status:
                     gift = await snes_read(ctx, KDL3_GIFTING_SEND, 0x01)
                     if gift[0]:
                         # we have a gift to send
                         await self.pick_gift_recipient(ctx, gift[0])
                         snes_buffered_write(ctx, KDL3_GIFTING_SEND, bytes([0x00]))
                 else:
-                    snes_buffered_write(ctx, KDL3_GIFTING_FLAG, bytes([0x01]))
+                    snes_buffered_write(ctx, KDL3_GIFTING_FLAG, bytes([0x01, 0x00]))
             else:
-                if gifting_status[0]:
-                    snes_buffered_write(ctx, KDL3_GIFTING_FLAG, bytes([0x00]))
+                if gifting_status:
+                    snes_buffered_write(ctx, KDL3_GIFTING_FLAG, bytes([0x00, 0x00]))
 
             await snes_flush_writes(ctx)
 

worlds/kdl3/gifting.py

@@ -37,157 +37,158 @@ async def initialize_giftboxes(ctx: "SNIContext", giftbox_key: str, motherbox_ke
     ctx.set_notify(motherbox_key, giftbox_key)
     await update_object(ctx, f"Giftboxes;{ctx.team}", {f"{ctx.slot}":
                                                        {
-                                                           "IsOpen": is_open,
+                                                           "is_open": is_open,
                                                            **kdl3_gifting_options
                                                        }})
+    await update_object(ctx, f"Giftbox;{ctx.team};{ctx.slot}", {})
     ctx.client_handler.gifting = is_open
 
 
 kdl3_gifting_options = {
-    "AcceptsAnyGift": True,
-    "DesiredTraits": [
+    "accepts_any_gift": True,
+    "desired_traits": [
         "Consumable", "Food", "Drink", "Candy", "Tomato",
         "Invincible", "Life", "Heal", "Health", "Trap",
         "Goo", "Gel", "Slow", "Slowness", "Eject", "Removal"
     ],
-    "MinimumGiftVersion": 2,
+    "minimum_gift_version": 3,
 }
 
 kdl3_gifts = {
     1: {
-        "ItemName": "1-Up",
-        "Amount": 1,
-        "ItemValue": 400000,
-        "Traits": [
+        "item_name": "1-Up",
+        "amount": 1,
+        "item_value": 400000,
+        "traits": [
             {
-                "Trait": "Consumable",
-                "Quality": 1,
-                "Duration": 1,
+                "trait": "Consumable",
+                "quality": 1,
+                "duration": 1,
             },
             {
-                "Trait": "Life",
-                "Quality": 1,
-                "Duration": 1
+                "trait": "Life",
+                "quality": 1,
+                "duration": 1
             }
         ]
     },
     2: {
-        "ItemName": "Maxim Tomato",
-        "Amount": 1,
-        "ItemValue": 500000,
-        "Traits": [
+        "item_name": "Maxim Tomato",
+        "amount": 1,
+        "item_value": 500000,
+        "traits": [
             {
-                "Trait": "Consumable",
-                "Quality": 5,
-                "Duration": 1,
+                "trait": "Consumable",
+                "quality": 5,
+                "duration": 1,
             },
             {
-                "Trait": "Heal",
-                "Quality": 5,
-                "Duration": 1,
+                "trait": "Heal",
+                "quality": 5,
+                "duration": 1,
             },
             {
-                "Trait": "Food",
-                "Quality": 5,
-                "Duration": 1,
+                "trait": "Food",
+                "quality": 5,
+                "duration": 1,
             },
             {
-                "Trait": "Tomato",
-                "Quality": 5,
-                "Duration": 1,
+                "trait": "Tomato",
+                "quality": 5,
+                "duration": 1,
             },
             {
-                "Trait": "Vegetable",
-                "Quality": 5,
-                "Duration": 1,
+                "trait": "Vegetable",
+                "quality": 5,
+                "duration": 1,
             }
         ]
     },
     3: {
-        "ItemName": "Energy Drink",
-        "Amount": 1,
-        "ItemValue": 100000,
-        "Traits": [
+        "item_name": "Energy Drink",
+        "amount": 1,
+        "item_value": 100000,
+        "traits": [
             {
-                "Trait": "Consumable",
-                "Quality": 1,
-                "Duration": 1,
+                "trait": "Consumable",
+                "quality": 1,
+                "duration": 1,
             },
             {
-                "Trait": "Heal",
-                "Quality": 1,
-                "Duration": 1,
+                "trait": "Heal",
+                "quality": 1,
+                "duration": 1,
             },
             {
-                "Trait": "Drink",
-                "Quality": 1,
-                "Duration": 1,
+                "trait": "Drink",
+                "quality": 1,
+                "duration": 1,
             },
         ]
     },
     5: {
-        "ItemName": "Small Star Piece",
-        "Amount": 1,
-        "ItemValue": 10000,
-        "Traits": [
+        "item_name": "Small Star Piece",
+        "amount": 1,
+        "item_value": 10000,
+        "traits": [
             {
-                "Trait": "Currency",
-                "Quality": 1,
-                "Duration": 1,
+                "trait": "Currency",
+                "quality": 1,
+                "duration": 1,
             },
             {
-                "Trait": "Money",
-                "Quality": 1,
-                "Duration": 1,
+                "trait": "Money",
+                "quality": 1,
+                "duration": 1,
             },
             {
-                "Trait": "Star",
-                "Quality": 1,
-                "Duration": 1
+                "trait": "Star",
+                "quality": 1,
+                "duration": 1
             }
         ]
     },
     6: {
-        "ItemName": "Medium Star Piece",
-        "Amount": 1,
-        "ItemValue": 30000,
-        "Traits": [
+        "item_name": "Medium Star Piece",
+        "amount": 1,
+        "item_value": 30000,
+        "traits": [
             {
-                "Trait": "Currency",
-                "Quality": 3,
-                "Duration": 1,
+                "trait": "Currency",
+                "quality": 3,
+                "duration": 1,
             },
             {
-                "Trait": "Money",
-                "Quality": 3,
-                "Duration": 1,
+                "trait": "Money",
+                "quality": 3,
+                "duration": 1,
             },
             {
-                "Trait": "Star",
-                "Quality": 3,
-                "Duration": 1
+                "trait": "Star",
+                "quality": 3,
+                "duration": 1
             }
         ]
     },
     7: {
-        "ItemName": "Large Star Piece",
-        "Amount": 1,
-        "ItemValue": 50000,
-        "Traits": [
+        "item_name": "Large Star Piece",
+        "amount": 1,
+        "item_value": 50000,
+        "traits": [
             {
-                "Trait": "Currency",
-                "Quality": 5,
-                "Duration": 1,
+                "trait": "Currency",
+                "quality": 5,
+                "duration": 1,
             },
             {
-                "Trait": "Money",
-                "Quality": 5,
-                "Duration": 1,
+                "trait": "Money",
+                "quality": 5,
+                "duration": 1,
             },
             {
-                "Trait": "Star",
-                "Quality": 5,
-                "Duration": 1
+                "trait": "Star",
+                "quality": 5,
+                "duration": 1
             }
         ]
     },
@@ -195,90 +196,90 @@ kdl3_gifts = {
 
 kdl3_trap_gifts = {
     0: {
-        "ItemName": "Gooey Bag",
-        "Amount": 1,
-        "ItemValue": 10000,
-        "Traits": [
+        "item_name": "Gooey Bag",
+        "amount": 1,
+        "item_value": 10000,
+        "traits": [
             {
-                "Trait": "Trap",
-                "Quality": 1,
-                "Duration": 1,
+                "trait": "Trap",
+                "quality": 1,
+                "duration": 1,
             },
             {
-                "Trait": "Goo",
-                "Quality": 1,
-                "Duration": 1,
+                "trait": "Goo",
+                "quality": 1,
+                "duration": 1,
             },
             {
-                "Trait": "Gel",
-                "Quality": 1,
-                "Duration": 1
+                "trait": "Gel",
+                "quality": 1,
+                "duration": 1
             }
         ]
     },
     1: {
-        "ItemName": "Slowness",
-        "Amount": 1,
-        "ItemValue": 10000,
-        "Traits": [
+        "item_name": "Slowness",
+        "amount": 1,
+        "item_value": 10000,
+        "traits": [
             {
-                "Trait": "Trap",
-                "Quality": 1,
-                "Duration": 1,
+                "trait": "Trap",
+                "quality": 1,
+                "duration": 1,
             },
             {
-                "Trait": "Slow",
-                "Quality": 1,
-                "Duration": 1,
+                "trait": "Slow",
+                "quality": 1,
+                "duration": 1,
             },
             {
-                "Trait": "Slowness",
-                "Quality": 1,
-                "Duration": 1
+                "trait": "Slowness",
+                "quality": 1,
+                "duration": 1
             }
         ]
     },
     2: {
-        "ItemName": "Eject Ability",
-        "Amount": 1,
-        "ItemValue": 10000,
-        "Traits": [
+        "item_name": "Eject Ability",
+        "amount": 1,
+        "item_value": 10000,
+        "traits": [
             {
-                "Trait": "Trap",
-                "Quality": 1,
-                "Duration": 1,
+                "trait": "Trap",
+                "quality": 1,
+                "duration": 1,
             },
             {
-                "Trait": "Eject",
-                "Quality": 1,
-                "Duration": 1,
+                "trait": "Eject",
+                "quality": 1,
+                "duration": 1,
             },
             {
-                "Trait": "Removal",
-                "Quality": 1,
-                "Duration": 1
+                "trait": "Removal",
+                "quality": 1,
+                "duration": 1
             }
         ]
     },
     3: {
-        "ItemName": "Bad Meal",
-        "Amount": 1,
-        "ItemValue": 10000,
-        "Traits": [
+        "item_name": "Bad Meal",
+        "amount": 1,
+        "item_value": 10000,
+        "traits": [
             {
-                "Trait": "Trap",
-                "Quality": 1,
-                "Duration": 1,
+                "trait": "Trap",
+                "quality": 1,
+                "duration": 1,
             },
             {
-                "Trait": "Damage",
-                "Quality": 1,
-                "Duration": 1,
+                "trait": "Damage",
+                "quality": 1,
+                "duration": 1,
             },
             {
-                "Trait": "Food",
-                "Quality": 1,
-                "Duration": 1
+                "trait": "Food",
+                "quality": 1,
+                "duration": 1
             }
         ]
     },

worlds/kdl3/options.py

@@ -289,7 +289,7 @@ class KirbyFlavorPreset(Choice):
     option_lime = 12
     option_lavender = 13
     option_miku = 14
-    option_custom = 15
+    option_custom = -1
     default = 0
 
     @classmethod
@@ -297,7 +297,7 @@ class KirbyFlavorPreset(Choice):
         text = text.lower()
         if text == "random":
             choice_list = list(cls.name_lookup)
-            choice_list.remove(14)
+            choice_list.remove(-1)
             return cls(random.choice(choice_list))
         return super().from_text(text)
 
@@ -347,7 +347,7 @@ class GooeyFlavorPreset(Choice):
     option_orange = 11
     option_lime = 12
     option_lavender = 13
-    option_custom = 14
+    option_custom = -1
     default = 0
 
     @classmethod
@@ -355,7 +355,7 @@ class GooeyFlavorPreset(Choice):
         text = text.lower()
         if text == "random":
             choice_list = list(cls.name_lookup)
-            choice_list.remove(14)
+            choice_list.remove(-1)
             return cls(random.choice(choice_list))
         return super().from_text(text)
 

worlds/kdl3/rom.py

@@ -7,7 +7,6 @@ import hashlib
 import os
 import struct
 
-import settings
 from worlds.Files import APProcedurePatch, APTokenMixin, APTokenTypes, APPatchExtension
 from .aesthetics import get_palette_bytes, kirby_target_palettes, get_kirby_palette, gooey_target_palettes, \
     get_gooey_palette
@@ -475,8 +474,7 @@ def patch_rom(world: "KDL3World", patch: KDL3ProcedurePatch) -> None:
     patch.write_token(APTokenTypes.WRITE, 0x3D016, world.options.ow_boss_requirement.value.to_bytes(2, "little"))
     patch.write_token(APTokenTypes.WRITE, 0x3D018, world.options.consumables.value.to_bytes(2, "little"))
     patch.write_token(APTokenTypes.WRITE, 0x3D01A, world.options.starsanity.value.to_bytes(2, "little"))
-    patch.write_token(APTokenTypes.WRITE, 0x3D01C, world.options.gifting.value.to_bytes(2, "little")
-                      if world.multiworld.players > 1 else bytes([0, 0]))
+    patch.write_token(APTokenTypes.WRITE, 0x3D01C, world.options.gifting.value.to_bytes(2, "little"))
     patch.write_token(APTokenTypes.WRITE, 0x3D01E, world.options.strict_bosses.value.to_bytes(2, "little"))
     # don't write gifting for solo game, since there's no one to send anything to
 
@@ -594,9 +592,9 @@ def get_base_rom_bytes() -> bytes:
 
 
 def get_base_rom_path(file_name: str = "") -> str:
-    options: settings.Settings = settings.get_settings()
+    from . import KDL3World
     if not file_name:
-        file_name = options["kdl3_options"]["rom_file"]
+        file_name = KDL3World.settings.rom_file
     if not os.path.exists(file_name):
         file_name = Utils.user_path(file_name)
     return file_name

worlds/kh2/Client.py

@@ -34,7 +34,7 @@ class KH2Context(CommonContext):
         self.growthlevel = None
         self.kh2connected = False
         self.kh2_finished_game = False
-        self.serverconneced = False
+        self.serverconnected = False
         self.item_name_to_data = {name: data for name, data, in item_dictionary_table.items()}
         self.location_name_to_data = {name: data for name, data, in all_locations.items()}
         self.kh2_data_package = {}
@@ -47,6 +47,8 @@ class KH2Context(CommonContext):
         self.location_name_to_worlddata = {name: data for name, data, in all_world_locations.items()}
 
         self.sending = []
+        self.slot_name = None
+        self.disconnect_from_server = False
         # list used to keep track of locations+items player has. Used for disoneccting
         self.kh2_seed_save_cache = {
             "itemIndex":  -1,
@@ -185,11 +187,20 @@ class KH2Context(CommonContext):
         if password_requested and not self.password:
             await super(KH2Context, self).server_auth(password_requested)
         await self.get_username()
-        await self.send_connect()
+        # if slot name != first time login or previous name
+        # and seed name is none or saved seed name
+        if not self.slot_name and not self.kh2seedname:
+            await self.send_connect()
+        elif self.slot_name == self.auth and self.kh2seedname:
+            await self.send_connect()
+        else:
+            logger.info(f"You are trying to connect with data still cached in the client. Close client or connect to the correct slot: {self.slot_name}")
+            self.serverconnected = False
+            self.disconnect_from_server = True
 
     async def connection_closed(self):
         self.kh2connected = False
-        self.serverconneced = False
+        self.serverconnected = False
         if self.kh2seedname is not None and self.auth is not None:
             with open(self.kh2_seed_save_path_join, 'w') as f:
                 f.write(json.dumps(self.kh2_seed_save, indent=4))
@@ -197,7 +208,8 @@ class KH2Context(CommonContext):
 
     async def disconnect(self, allow_autoreconnect: bool = False):
         self.kh2connected = False
-        self.serverconneced = False
+        self.serverconnected = False
+        self.locations_checked = []
         if self.kh2seedname not in {None} and self.auth not in {None}:
             with open(self.kh2_seed_save_path_join, 'w') as f:
                 f.write(json.dumps(self.kh2_seed_save, indent=4))
@@ -239,7 +251,15 @@ class KH2Context(CommonContext):
 
     def on_package(self, cmd: str, args: dict):
         if cmd == "RoomInfo":
-            self.kh2seedname = args['seed_name']
+            if not self.kh2seedname:
+                self.kh2seedname = args['seed_name']
+            elif self.kh2seedname != args['seed_name']:
+                self.disconnect_from_server = True
+                self.serverconnected = False
+                self.kh2connected = False
+                logger.info("Connection to the wrong seed, connect to the correct seed or close the client.")
+                return
+
             self.kh2_seed_save_path = f"kh2save2{self.kh2seedname}{self.auth}.json"
             self.kh2_seed_save_path_join = os.path.join(self.game_communication_path, self.kh2_seed_save_path)
 
@@ -338,7 +358,7 @@ class KH2Context(CommonContext):
                         },
                     },
                 }
-            if start_index > self.kh2_seed_save_cache["itemIndex"] and self.serverconneced:
+            if start_index > self.kh2_seed_save_cache["itemIndex"] and self.serverconnected:
                 self.kh2_seed_save_cache["itemIndex"] = start_index
                 for item in args['items']:
                     asyncio.create_task(self.give_item(item.item, item.location))
@@ -370,12 +390,14 @@ class KH2Context(CommonContext):
             if not self.kh2:
                 self.kh2 = pymem.Pymem(process_name="KINGDOM HEARTS II FINAL MIX")
                 self.get_addresses()
-
+#
         except Exception as e:
             if self.kh2connected:
                 self.kh2connected = False
             logger.info("Game is not open.")
-        self.serverconneced = True
+
+        self.serverconnected = True
+        self.slot_name = self.auth
 
     def data_package_kh2_cache(self, loc_to_id, item_to_id):
         self.kh2_loc_name_to_id = loc_to_id
@@ -493,23 +515,38 @@ class KH2Context(CommonContext):
 
     async def give_item(self, item, location):
         try:
-            # todo: ripout all the itemtype stuff and just have one dictionary. the only thing that needs to be tracked from the server/local is abilites
-            #sleep so we can get the datapackage and not miss any items that were sent to us while we didnt have our item id dicts
+            # sleep so we can get the datapackage and not miss any items that were sent to us while we didnt have our item id dicts
             while not self.lookup_id_to_item:
                 await asyncio.sleep(0.5)
             itemname = self.lookup_id_to_item[item]
             itemdata = self.item_name_to_data[itemname]
-            # itemcode = self.kh2_item_name_to_id[itemname]
             if itemdata.ability:
                 if location in self.all_weapon_location_id:
                     return
+                # growth have reserved ability slots because of how the goa handles them
                 if itemname in {"High Jump", "Quick Run", "Dodge Roll", "Aerial Dodge", "Glide"}:
                     self.kh2_seed_save_cache["AmountInvo"]["Growth"][itemname] += 1
                     return
 
                 if itemname not in self.kh2_seed_save_cache["AmountInvo"]["Ability"]:
                     self.kh2_seed_save_cache["AmountInvo"]["Ability"][itemname] = []
-                    #  appending the slot that the ability should be in
+                #  appending the slot that the ability should be in
+                # abilities have a limit amount of slots.
+                # we start from the back going down to not mess with stuff.
+                # Front of Invo
+                # Sora:   Save+24F0+0x54 : 0x2546
+                # Donald: Save+2604+0x54 : 0x2658
+                # Goofy:  Save+2718+0x54 : 0x276C
+                # Back of Invo. Sora has 6 ability slots that are reserved
+                # Sora:   Save+24F0+0x54+0x92 : 0x25D8
+                # Donald: Save+2604+0x54+0x9C : 0x26F4
+                # Goofy:  Save+2718+0x54+0x9C : 0x2808
+                # seed has 2 scans in sora's abilities
+                # recieved second scan
+                # if len(seed_save(Scan:[ability slot 52]) < (2)amount of that ability they should have from slot data
+                # ability_slot = back of inventory that isnt taken
+                # add ability_slot to seed_save(Scan[]) so now its Scan:[ability slot 52,50]
+                # decrease back of inventory since its ability_slot is already taken
                 if len(self.kh2_seed_save_cache["AmountInvo"]["Ability"][itemname]) < \
                         self.AbilityQuantityDict[itemname]:
                     if itemname in self.sora_ability_set:
@@ -528,18 +565,21 @@ class KH2Context(CommonContext):
                     if ability_slot in self.front_ability_slots:
                         self.front_ability_slots.remove(ability_slot)
 
+            # if itemdata in {bitmask} all the forms,summons and a few other things are bitmasks
             elif itemdata.memaddr in {0x36C4, 0x36C5, 0x36C6, 0x36C0, 0x36CA}:
                 # if memaddr is in a bitmask location in memory
                 if itemname not in self.kh2_seed_save_cache["AmountInvo"]["Bitmask"]:
                     self.kh2_seed_save_cache["AmountInvo"]["Bitmask"].append(itemname)
 
+            # if itemdata in {magic}
             elif itemdata.memaddr in {0x3594, 0x3595, 0x3596, 0x3597, 0x35CF, 0x35D0}:
-                # if memaddr is in magic addresses
                 self.kh2_seed_save_cache["AmountInvo"]["Magic"][itemname] += 1
 
+            # equipment is a list instead of dict because you can only have 1 currently
             elif itemname in self.all_equipment:
                 self.kh2_seed_save_cache["AmountInvo"]["Equipment"].append(itemname)
 
+            # weapons are done differently since you can only have one and has to check it differently
             elif itemname in self.all_weapons:
                 if itemname in self.keyblade_set:
                     self.kh2_seed_save_cache["AmountInvo"]["Weapon"]["Sora"].append(itemname)
@@ -548,9 +588,11 @@ class KH2Context(CommonContext):
                 else:
                     self.kh2_seed_save_cache["AmountInvo"]["Weapon"]["Goofy"].append(itemname)
 
+            # TODO: this can just be removed and put into the else below it
             elif itemname in self.stat_increase_set:
                 self.kh2_seed_save_cache["AmountInvo"]["StatIncrease"][itemname] += 1
             else:
+                # "normal" items. They have a unique byte reserved for how many they have
                 if itemname in self.kh2_seed_save_cache["AmountInvo"]["Amount"]:
                     self.kh2_seed_save_cache["AmountInvo"]["Amount"][itemname] += 1
                 else:
@@ -930,7 +972,7 @@ def finishedGame(ctx: KH2Context):
 async def kh2_watcher(ctx: KH2Context):
     while not ctx.exit_event.is_set():
         try:
-            if ctx.kh2connected and ctx.serverconneced:
+            if ctx.kh2connected and ctx.serverconnected:
                 ctx.sending = []
                 await asyncio.create_task(ctx.checkWorldLocations())
                 await asyncio.create_task(ctx.checkLevels())
@@ -944,13 +986,19 @@ async def kh2_watcher(ctx: KH2Context):
                 if ctx.sending:
                     message = [{"cmd": 'LocationChecks', "locations": ctx.sending}]
                     await ctx.send_msgs(message)
-            elif not ctx.kh2connected and ctx.serverconneced:
-                logger.info("Game Connection lost. waiting 15 seconds until trying to reconnect.")
+            elif not ctx.kh2connected and ctx.serverconnected:
+                logger.info("Game Connection lost. trying to reconnect.")
                 ctx.kh2 = None
-                while not ctx.kh2connected and ctx.serverconneced:
-                    await asyncio.sleep(15)
-                    ctx.kh2 = pymem.Pymem(process_name="KINGDOM HEARTS II FINAL MIX")
-                    ctx.get_addresses()
+                while not ctx.kh2connected and ctx.serverconnected:
+                    try:
+                        ctx.kh2 = pymem.Pymem(process_name="KINGDOM HEARTS II FINAL MIX")
+                        ctx.get_addresses()
+                        logger.info("Game Connection Established.")
+                    except Exception as e:
+                        await asyncio.sleep(5)
+            if ctx.disconnect_from_server:
+                ctx.disconnect_from_server = False
+                await ctx.disconnect()
         except Exception as e:
             if ctx.kh2connected:
                 ctx.kh2connected = False

worlds/kh2/OpenKH.py

@@ -13,6 +13,7 @@ from worlds.Files import APPlayerContainer
 
 class KH2Container(APPlayerContainer):
     game: str = 'Kingdom Hearts 2'
+    patch_file_ending = ".zip"
 
     def __init__(self, patch_data: dict, base_path: str, output_directory: str,
         player=None, player_name: str = "", server: str = ""):

worlds/kh2/__init__.py

@@ -277,9 +277,7 @@ class KH2World(World):
         if self.options.FillerItemsLocal:
             for item in filler_items:
                 self.options.local_items.value.add(item)
-        # By imitating remote this doesn't have to be plandoded filler anymore
-        #  for location in {LocationName.JunkMedal, LocationName.JunkMedal}:
-        #    self.plando_locations[location] = random_stt_item
+
         if not self.options.SummonLevelLocationToggle:
             self.total_locations -= 6
 
@@ -400,6 +398,8 @@ class KH2World(World):
             # plando goofy get bonuses
             goofy_get_bonus_location_pool = [self.multiworld.get_location(location, self.player) for location in
                                              Goofy_Checks.keys() if Goofy_Checks[location].yml != "Keyblade"]
+            if len(goofy_get_bonus_location_pool) > len(self.goofy_get_bonus_abilities):
+                raise Exception(f"Too little abilities to fill goofy get bonus locations for player {self.player_name}.")
             for location in goofy_get_bonus_location_pool:
                 self.random.choice(self.goofy_get_bonus_abilities)
                 random_ability = self.random.choice(self.goofy_get_bonus_abilities)
@@ -416,11 +416,12 @@ class KH2World(World):
             random_ability = self.random.choice(self.donald_weapon_abilities)
             location.place_locked_item(random_ability)
             self.donald_weapon_abilities.remove(random_ability)
-
+        # if option is turned off
         if not self.options.DonaldGoofyStatsanity:
-            # plando goofy get bonuses
             donald_get_bonus_location_pool = [self.multiworld.get_location(location, self.player) for location in
                                               Donald_Checks.keys() if Donald_Checks[location].yml != "Keyblade"]
+            if len(donald_get_bonus_location_pool) > len(self.donald_get_bonus_abilities):
+                raise Exception(f"Too little abilities to fill donald get bonus locations for player {self.player_name}.")
             for location in donald_get_bonus_location_pool:
                 random_ability = self.random.choice(self.donald_get_bonus_abilities)
                 location.place_locked_item(random_ability)

worlds/ladx/LADXR/patches/marin.txt

@@ -220,7 +220,6 @@ To this day I still don't know if we inconvenienced the Mad Batter or not.
 Oh, hi #####
 People forgot I was playable in Hyrule Warriors
 Join our Discord.  Or else.
-Also try Minecraft!
 I see you're finally awake...
 OwO
 This is Todd Howard, and today I'm pleased to announce... The Elder Scrolls V: Skyrim for the Nintendo Game Boy Color!
@@ -256,7 +255,6 @@ Try Bumper Stickers!
 Try Castlevania 64!
 Try Celeste 64!
 Try ChecksFinder!
-Try Clique!
 Try Dark Souls III!
 Try DLCQuest!
 Try Donkey Kong Country 3!
@@ -269,6 +267,7 @@ Try A Hat in Time!
 Try Heretic!
 Try Hollow Knight!
 Try Hylics 2!
+Try Jak and Daxter: The Precursor Legacy!
 Try Kingdom Hearts 2!
 Try Kirby's Dream Land 3!
 Try Landstalker - The Treasures of King Nole!
@@ -281,7 +280,6 @@ Try Mario & Luigi Superstar Saga!
 Try MegaMan Battle Network 3!
 Try Meritous!
 Try The Messenger!
-Try Minecraft!
 Try Muse Dash!
 Try Noita!
 Try Ocarina of Time!
@@ -290,11 +288,10 @@ Try Pokemon Emerald!
 Try Pokemon Red and Blue!
 Try Raft!
 Try Risk of Rain 2!
-Try Rogue Legacy!
 Try Secret of Evermore!
+Try shapez!
 Try Shivers!
 Try A Short Hike!
-Try Slay the Spire!
 Try SMZ3!
 Try Sonic Adventure 2 Battle!
 Try Starcraft 2!
@@ -302,6 +299,7 @@ Try Stardew Valley!
 Try Subnautica!
 Try Sudoku!
 Try Super Mario 64!
+Try Super Mario Land 2: 6 Golden Coins!
 Try Super Mario World!
 Try Super Metroid!
 Try Terraria!
@@ -314,7 +312,6 @@ Try The Witness!
 Try Yoshi's Island!
 Try Yu-Gi-Oh! 2006!
 Try Zillion!
-Try Zork Grand Inquisitor!
 Try Old School Runescape!
 Try Kingdom Hearts!
 Try Mega Man 2!
@@ -371,7 +368,6 @@ Have they added Among Us to AP yet?
 Every copy of LADX is personalized, David.
 Looks like you're going on A Short Hike. Bring back feathers please?
 Functioning Brain is at...\nWait. This isn't Witness. Wrong game, sorry.
-Don't forget to check your Clique!\nIf, y'know, you have one. No pressure...
 :3
 Sorry ######, but your progression item is in another world.
 &newgames\n&oldgames

worlds/ladx/__init__.py

@@ -335,7 +335,9 @@ class LinksAwakeningWorld(World):
                 start_item = next((item for item in start_items if opens_new_regions(item)), None)
 
             if start_item:
-                itempool.remove(start_item)
+                # Make sure we're removing the same copy of the item that we're placing
+                # (.remove checks __eq__, which could be a different copy, so we find the first index and use .pop)
+                start_item = itempool.pop(itempool.index(start_item))
                 start_loc.place_locked_item(start_item)
             else:
                 logging.getLogger("Link's Awakening Logger").warning(f"No {self.options.tarins_gift.current_option_name} available for Tarin's Gift.")

worlds/lingo/data/LL1.yaml

@@ -4956,10 +4956,16 @@
       Outside The Initiated:
         room: Art Gallery
         door: Exit
-      The Bearer (East): True
-      The Bearer (North): True
-      The Bearer (South): True
-      The Bearer (West): True
+      The Bearer (East):
+        static_painting: True
+      The Bearer (North):
+        static_painting: True
+      The Bearer (South):
+        static_painting: True
+      The Bearer (West):
+        - static_painting: True
+        - room: The Bearer (West)
+          door: Side Area Shortcut
       Roof: True
     panels:
       Achievement:
@@ -5053,7 +5059,8 @@
           - MIDDLE
   The Bearer (East):
     entrances:
-      Cross Tower (East): True
+      Cross Tower (East):
+        static_painting: True
       Bearer Side Area:
         door: Side Area Access
       Roof: True
@@ -5084,7 +5091,8 @@
             panel: SPACE
   The Bearer (North):
     entrances:
-      Cross Tower (East): True
+      Cross Tower (North):
+        static_painting: True
       Roof: True
     panels:
       SILENT (1):
@@ -5128,7 +5136,8 @@
             panel: POTS
   The Bearer (South):
     entrances:
-      Cross Tower (North): True
+      Cross Tower (South):
+        static_painting: True
       Bearer Side Area:
         door: Side Area Shortcut
       Roof: True
@@ -5162,7 +5171,10 @@
             panel: SILENT (1)
   The Bearer (West):
     entrances:
-      Cross Tower (West): True
+      Cross Tower (West):
+        static_painting: True
+      The Bearer:
+        door: Side Area Shortcut
       Bearer Side Area:
         door: Side Area Shortcut
       Roof: True
@@ -5235,6 +5247,7 @@
       The Bearer:
         room: The Bearer
         door: East Entrance
+        static_painting: True
       Roof: True
     panels:
       WINTER:
@@ -5250,6 +5263,7 @@
       The Bearer (East):
         room: The Bearer (East)
         door: North Entrance
+        static_painting: True
       Roof: True
     panels:
       NORTH:
@@ -5270,6 +5284,7 @@
       The Bearer (North):
         room: The Bearer (North)
         door: South Entrance
+        static_painting: True
     panels:
       FIRE:
         id: Cross Room/Panel_fire_fire
@@ -5284,6 +5299,7 @@
       Bearer Side Area:
         room: Bearer Side Area
         door: West Entrance
+        static_painting: True
       Roof: True
     panels:
       DIAMONDS:
@@ -7108,6 +7124,8 @@
     entrances:
       Orange Tower Third Floor:
         warp: True
+      Art Gallery (First Floor):
+        warp: True
       Art Gallery (Second Floor):
         warp: True
       Art Gallery (Third Floor):
@@ -7125,22 +7143,6 @@
         required_door:
           room: Number Hunt
           door: Eights
-      EON:
-        id: Painting Room/Panel_eon_one
-        colors: yellow
-        tag: midyellow
-      TRUSTWORTHY:
-        id: Painting Room/Panel_to_two
-        colors: red
-        tag: midred
-      FREE:
-        id: Painting Room/Panel_free_three
-        colors: purple
-        tag: midpurp
-      OUR:
-        id: Painting Room/Panel_our_four
-        colors: blue
-        tag: midblue
       ORDER:
         id: Painting Room/Panel_order_onepathmanyturns
         tag: forbid
@@ -7159,15 +7161,8 @@
           - scenery_painting_2c
         skip_location: True
         panels:
-          - EON
-      First Floor Puzzles:
-        skip_item: True
-        location_name: Art Gallery - First Floor Puzzles
-        panels:
-          - EON
-          - TRUSTWORTHY
-          - FREE
-          - OUR
+          - room: Art Gallery (First Floor)
+            panel: EON
       Third Floor:
         painting_id:
           - scenery_painting_3b
@@ -7227,11 +7222,42 @@
           - Third Floor
           - Fourth Floor
           - Fifth Floor
+  Art Gallery (First Floor):
+    entrances:
+      Art Gallery:
+        static_painting: True
+    panels:
+      EON:
+        id: Painting Room/Panel_eon_one
+        colors: yellow
+        tag: midyellow
+      TRUSTWORTHY:
+        id: Painting Room/Panel_to_two
+        colors: red
+        tag: midred
+      FREE:
+        id: Painting Room/Panel_free_three
+        colors: purple
+        tag: midpurp
+      OUR:
+        id: Painting Room/Panel_our_four
+        colors: blue
+        tag: midblue
+    doors:
+      Puzzles:
+        skip_item: True
+        location_name: Art Gallery - First Floor Puzzles
+        panels:
+          - EON
+          - TRUSTWORTHY
+          - FREE
+          - OUR
   Art Gallery (Second Floor):
     entrances:
       Art Gallery:
         room: Art Gallery
         door: Second Floor
+        static_painting: True
     panels:
       HOUSE:
         id: Painting Room/Panel_house_neighborhood
@@ -7263,6 +7289,7 @@
       Art Gallery:
         room: Art Gallery
         door: Third Floor
+        static_painting: True
     panels:
       AN:
         id: Painting Room/Panel_an_many
@@ -7294,6 +7321,7 @@
       Art Gallery:
         room: Art Gallery
         door: Fourth Floor
+        static_painting: True
     panels:
       URNS:
         id: Painting Room/Panel_urns_turns

worlds/lingo/data/ids.yaml

@@ -727,11 +727,12 @@ panels:
     WANDER: 444975
   Art Gallery:
     EIGHT: 444976
+    ORDER: 444981
+  Art Gallery (First Floor):
     EON: 444977
     TRUSTWORTHY: 444978
     FREE: 444979
     OUR: 444980
-    ORDER: 444981
   Art Gallery (Second Floor):
     HOUSE: 444982
     PATH: 444983
@@ -1382,8 +1383,6 @@ doors:
   Art Gallery:
     Second Floor:
       item: 444558
-    First Floor Puzzles:
-      location: 445256
     Third Floor:
       item: 444559
     Fourth Floor:
@@ -1393,6 +1392,9 @@ doors:
     Exit:
       item: 444562
       location: 444981
+  Art Gallery (First Floor):
+    Puzzles:
+      location: 445256
   Art Gallery (Second Floor):
     Puzzles:
       location: 445257

worlds/lingo/datatypes.py

@@ -23,6 +23,7 @@ class EntranceType(Flag):
     SUNWARP = auto()
     WARP = auto()
     CROSSROADS_ROOF_ACCESS = auto()
+    STATIC_PAINTING = auto()
 
 
 class RoomEntrance(NamedTuple):

worlds/lingo/regions.py

@@ -30,7 +30,7 @@ def is_acceptable_pilgrimage_entrance(entrance_type: EntranceType, world: "Lingo
     allowed_entrance_types = EntranceType.NORMAL
 
     if world.options.pilgrimage_allows_paintings:
-        allowed_entrance_types |= EntranceType.PAINTING
+        allowed_entrance_types |= EntranceType.PAINTING | EntranceType.STATIC_PAINTING
 
     if world.options.pilgrimage_allows_roof_access:
         allowed_entrance_types |= EntranceType.CROSSROADS_ROOF_ACCESS
@@ -105,7 +105,8 @@ def create_regions(world: "LingoWorld") -> None:
                 regions[pilgrimage_region_name] = Region(pilgrimage_region_name, world.player, world.multiworld)
 
     # Connect all created regions now that they exist.
-    allowed_entrance_types = EntranceType.NORMAL | EntranceType.WARP | EntranceType.CROSSROADS_ROOF_ACCESS
+    allowed_entrance_types = EntranceType.NORMAL | EntranceType.WARP | EntranceType.CROSSROADS_ROOF_ACCESS | \
+                             EntranceType.STATIC_PAINTING
 
     if not painting_shuffle:
         # Don't use the vanilla painting connections if we are shuffling paintings.
@@ -156,11 +157,11 @@ def create_regions(world: "LingoWorld") -> None:
             regions[from_room].connect(regions[to_room], f"Pilgrimage Part {i+1}")
     else:
         connect_entrance(regions, regions["Starting Room"], regions["Pilgrim Antechamber"], "Sun Painting",
-                         RoomAndDoor("Pilgrim Antechamber", "Sun Painting"), EntranceType.PAINTING, False, world)
+                         RoomAndDoor("Pilgrim Antechamber", "Sun Painting"), EntranceType.STATIC_PAINTING, False, world)
 
     if early_color_hallways:
         connect_entrance(regions, regions["Starting Room"], regions["Color Hallways"], "Early Color Hallways",
-                         None, EntranceType.PAINTING, False, world)
+                         None, EntranceType.STATIC_PAINTING, False, world)
 
     if painting_shuffle:
         for warp_enter, warp_exit in world.player_logic.painting_mapping.items():