core: Don't attempt to write to the inside of an OSX App Bundle (#4380)

* core: Frozen OSX should also use Home Directory

* Use Application Support instead of homedir

* Suggested changes

.github/labeler.yml

@@ -21,7 +21,6 @@
     - '!data/**'
     - '!.run/**'
     - '!.github/**'
-    - '!worlds_disabled/**'
     - '!worlds/**'
     - '!WebHost.py'
     - '!WebHostLib/**'

.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
 

AHITClient.py

@@ -1,3 +1,4 @@
+import sys
 from worlds.ahit.Client import launch
 import Utils
 import ModuleUpdate
@@ -5,4 +6,4 @@ ModuleUpdate.update()
 
 if __name__ == "__main__":
     Utils.init_logging("AHITClient", exception_logger="Client")
-    launch()
+    launch(*sys.argv[1:])

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

@@ -9,8 +9,9 @@ from argparse import Namespace
 from collections import Counter, deque
 from collections.abc import Collection, MutableSequence
 from enum import IntEnum, IntFlag
-from typing import (AbstractSet, Any, Callable, ClassVar, Dict, Iterable, Iterator, List, Mapping, NamedTuple,
+from typing import (AbstractSet, Any, Callable, ClassVar, Dict, Iterable, Iterator, List, Literal, Mapping, NamedTuple,
                     Optional, Protocol, Set, Tuple, Union, TYPE_CHECKING)
+import dataclasses
 
 from typing_extensions import NotRequired, TypedDict
 
@@ -54,12 +55,21 @@ class HasNameAndPlayer(Protocol):
     player: int
 
 
+@dataclasses.dataclass
+class PlandoItemBlock:
+    player: int
+    from_pool: bool
+    force: bool | Literal["silent"]
+    worlds: set[int] = dataclasses.field(default_factory=set)
+    items: list[str] = dataclasses.field(default_factory=list)
+    locations: list[str] = dataclasses.field(default_factory=list)
+    resolved_locations: list[Location] = dataclasses.field(default_factory=list)
+    count: dict[str, int] = dataclasses.field(default_factory=dict)
+
+
 class MultiWorld():
     debug_types = False
     player_name: Dict[int, str]
-    plando_texts: List[Dict[str, str]]
-    plando_items: List[List[Dict[str, Any]]]
-    plando_connections: List
     worlds: Dict[int, "AutoWorld.World"]
     groups: Dict[int, Group]
     regions: RegionManager
@@ -83,6 +93,8 @@ class MultiWorld():
     start_location_hints: Dict[int, Options.StartLocationHints]
     item_links: Dict[int, Options.ItemLinks]
 
+    plando_item_blocks: Dict[int, List[PlandoItemBlock]]
+
     game: Dict[int, str]
 
     random: random.Random
@@ -160,13 +172,12 @@ class MultiWorld():
         self.local_early_items = {player: {} for player in self.player_ids}
         self.indirect_connections = {}
         self.start_inventory_from_pool: Dict[int, Options.StartInventoryPool] = {}
+        self.plando_item_blocks = {}
 
         for player in range(1, players + 1):
             def set_player_attr(attr: str, val) -> None:
                 self.__dict__.setdefault(attr, {})[player] = val
-            set_player_attr('plando_items', [])
-            set_player_attr('plando_texts', {})
-            set_player_attr('plando_connections', [])
+            set_player_attr('plando_item_blocks', [])
             set_player_attr('game', "Archipelago")
             set_player_attr('completion_condition', lambda state: True)
         self.worlds = {}
@@ -427,7 +438,8 @@ class MultiWorld():
     def get_location(self, location_name: str, player: int) -> Location:
         return self.regions.location_cache[player][location_name]
 
-    def get_all_state(self, use_cache: bool, allow_partial_entrances: bool = False) -> CollectionState:
+    def get_all_state(self, use_cache: bool, allow_partial_entrances: bool = False,
+                      collect_pre_fill_items: bool = True, perform_sweep: bool = True) -> CollectionState:
         cached = getattr(self, "_all_state", None)
         if use_cache and cached:
             return cached.copy()
@@ -436,11 +448,13 @@ class MultiWorld():
 
         for item in self.itempool:
             self.worlds[item.player].collect(ret, item)
-        for player in self.player_ids:
-            subworld = self.worlds[player]
-            for item in subworld.get_pre_fill_items():
-                subworld.collect(ret, item)
-        ret.sweep_for_advancements()
+        if collect_pre_fill_items:
+            for player in self.player_ids:
+                subworld = self.worlds[player]
+                for item in subworld.get_pre_fill_items():
+                    subworld.collect(ret, item)
+        if perform_sweep:
+            ret.sweep_for_advancements()
 
         if use_cache:
             self._all_state = ret
@@ -545,7 +559,9 @@ class MultiWorld():
         else:
             return all((self.has_beaten_game(state, p) for p in range(1, self.players + 1)))
 
-    def can_beat_game(self, starting_state: Optional[CollectionState] = None) -> bool:
+    def can_beat_game(self,
+                      starting_state: Optional[CollectionState] = None,
+                      locations: Optional[Iterable[Location]] = None) -> bool:
         if starting_state:
             if self.has_beaten_game(starting_state):
                 return True
@@ -554,7 +570,9 @@ class MultiWorld():
             state = CollectionState(self)
             if self.has_beaten_game(state):
                 return True
-        prog_locations = {location for location in self.get_locations() if location.item
+
+        base_locations = self.get_locations() if locations is None else locations
+        prog_locations = {location for location in base_locations if location.item
                           and location.item.advancement and location not in state.locations_checked}
 
         while prog_locations:
@@ -723,6 +741,7 @@ class CollectionState():
     additional_copy_functions: List[Callable[[CollectionState, CollectionState], CollectionState]] = []
 
     def __init__(self, parent: MultiWorld, allow_partial_entrances: bool = False):
+        assert parent.worlds, "CollectionState created without worlds initialized in parent"
         self.prog_items = {player: Counter() for player in parent.get_all_ids()}
         self.multiworld = parent
         self.reachable_regions = {player: set() for player in parent.get_all_ids()}
@@ -999,6 +1018,17 @@ class CollectionState():
 
         return changed
 
+    def add_item(self, item: str, player: int, count: int = 1) -> None:
+        """
+        Adds the item to state.
+
+        :param item: The item to be added.
+        :param player: The player the item is for.
+        :param count: How many of the item to add.
+        """
+        assert count > 0
+        self.prog_items[player][item] += count
+
     def remove(self, item: Item):
         changed = self.multiworld.worlds[item.player].remove(self, item)
         if changed:
@@ -1007,6 +1037,33 @@ class CollectionState():
             self.blocked_connections[item.player] = set()
             self.stale[item.player] = True
 
+    def remove_item(self, item: str, player: int, count: int = 1) -> None:
+        """
+        Removes the item from state.
+
+        :param item: The item to be removed.
+        :param player: The player the item is for.
+        :param count: How many of the item to remove.
+        """
+        assert count > 0
+        self.prog_items[player][item] -= count
+        if self.prog_items[player][item] < 1:
+            del (self.prog_items[player][item])
+
+    def set_item(self, item: str, player: int, count: int) -> None:
+        """
+        Sets the item in state equal to the provided count.
+
+        :param item: The item to modify.
+        :param player: The player the item is for.
+        :param count: How many of the item to now have.
+        """
+        assert count >= 0
+        if count == 0:
+            del (self.prog_items[player][item])
+        else:
+            self.prog_items[player][item] = count
+
 
 class EntranceType(IntEnum):
     ONE_WAY = 1
@@ -1280,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)
@@ -1550,21 +1607,19 @@ class Spoiler:
 
         # in the second phase, we cull each sphere such that the game is still beatable,
         # reducing each range of influence to the bare minimum required inside it
-        restore_later: Dict[Location, Item] = {}
+        required_locations = {location for sphere in collection_spheres for location in sphere}
         for num, sphere in reversed(tuple(enumerate(collection_spheres))):
             to_delete: Set[Location] = set()
             for location in sphere:
-                # we remove the item at location and check if game is still beatable
+                # we remove the location from required_locations to sweep from, and check if the game is still beatable
                 logging.debug('Checking if %s (Player %d) is required to beat the game.', location.item.name,
                               location.item.player)
-                old_item = location.item
-                location.item = None
-                if multiworld.can_beat_game(state_cache[num]):
+                required_locations.remove(location)
+                if multiworld.can_beat_game(state_cache[num], required_locations):
                     to_delete.add(location)
-                    restore_later[location] = old_item
                 else:
                     # still required, got to keep it around
-                    location.item = old_item
+                    required_locations.add(location)
 
             # cull entries in spheres for spoiler walkthrough at end
             sphere -= to_delete
@@ -1581,7 +1636,7 @@ class Spoiler:
                 logging.debug('Checking if %s (Player %d) is required to beat the game.', item.name, item.player)
                 precollected_items.remove(item)
                 multiworld.state.remove(item)
-                if not multiworld.can_beat_game():
+                if not multiworld.can_beat_game(multiworld.state, required_locations):
                     # Add the item back into `precollected_items` and collect it into `multiworld.state`.
                     multiworld.push_precollected(item)
                 else:
@@ -1623,9 +1678,6 @@ class Spoiler:
             self.create_paths(state, collection_spheres)
 
         # repair the multiworld again
-        for location, item in restore_later.items():
-            location.item = item
-
         for item in removed_precollected:
             multiworld.push_precollected(item)
 

CommonClient.py

@@ -266,38 +266,71 @@ class CommonContext:
     last_death_link: float = time.time()  # last send/received death link on AP layer
 
     # remaining type info
-    slot_info: typing.Dict[int, NetworkSlot]
-    server_address: typing.Optional[str]
-    password: typing.Optional[str]
-    hint_cost: typing.Optional[int]
-    hint_points: typing.Optional[int]
-    player_names: typing.Dict[int, str]
+    slot_info: dict[int, NetworkSlot]
+    """Slot Info from the server for the current connection"""
+    server_address: str | None
+    """Autoconnect address provided by the ctx constructor"""
+    password: str | None
+    """Password used for Connecting, expected by server_auth"""
+    hint_cost: int | None
+    """Current Hint Cost per Hint from the server"""
+    hint_points: int | None
+    """Current avaliable Hint Points from the server"""
+    player_names: dict[int, str]
+    """Current lookup of slot number to player display name from server (includes aliases)"""
 
     finished_game: bool
+    """
+    Bool to signal that status should be updated to Goal after reconnecting
+    to be used to ensure that a StatusUpdate packet does not get lost when disconnected
+    """
     ready: bool
-    team: typing.Optional[int]
-    slot: typing.Optional[int]
-    auth: typing.Optional[str]
-    seed_name: typing.Optional[str]
+    """Bool to keep track of state for the /ready command"""
+    team: int | None
+    """Team number of currently connected slot"""
+    slot: int | None
+    """Slot number of currently connected slot"""
+    auth: str | None
+    """Name used in Connect packet"""
+    seed_name: str | None
+    """Seed name that will be validated on opening a socket if present"""
 
     # locations
-    locations_checked: typing.Set[int]  # local state
-    locations_scouted: typing.Set[int]
-    items_received: typing.List[NetworkItem]
-    missing_locations: typing.Set[int]  # server state
-    checked_locations: typing.Set[int]  # server state
-    server_locations: typing.Set[int]  # all locations the server knows of, missing_location | checked_locations
-    locations_info: typing.Dict[int, NetworkItem]
+    locations_checked: set[int]
+    """
+    Local container of location ids checked to signal that LocationChecks should be resent after reconnecting
+    to be used to ensure that a LocationChecks packet does not get lost when disconnected
+    """
+    locations_scouted: set[int]
+    """
+    Local container of location ids scouted to signal that LocationScouts should be resent after reconnecting
+    to be used to ensure that a LocationScouts packet does not get lost when disconnected
+    """
+    items_received: list[NetworkItem]
+    """List of NetworkItems recieved from the server"""
+    missing_locations: set[int]
+    """Container of Locations that are unchecked per server state"""
+    checked_locations: set[int]
+    """Container of Locations that are checked per server state"""
+    server_locations: set[int]
+    """Container of Locations that exist per server state; a combination between missing and checked locations"""
+    locations_info: dict[int, NetworkItem]
+    """Dict of location id: NetworkItem info from LocationScouts request"""
 
     # data storage
-    stored_data: typing.Dict[str, typing.Any]
-    stored_data_notification_keys: typing.Set[str]
+    stored_data: dict[str, typing.Any]
+    """
+    Data Storage values by key that were retrieved from the server
+    any keys subscribed to with SetNotify will be kept up to date
+    """
+    stored_data_notification_keys: set[str]
+    """Current container of watched Data Storage keys, managed by ctx.set_notify"""
 
     # internals
-    # current message box through kvui
     _messagebox: typing.Optional["kvui.MessageBox"] = None
-    # message box reporting a loss of connection
+    """Current message box through kvui"""
     _messagebox_connection_loss: typing.Optional["kvui.MessageBox"] = None
+    """Message box reporting a loss of connection"""
 
     def __init__(self, server_address: typing.Optional[str] = None, password: typing.Optional[str] = None) -> None:
         # server state

FF1Client.py

@@ -1,267 +0,0 @@
-import asyncio
-import copy
-import json
-import time
-from asyncio import StreamReader, StreamWriter
-from typing import List
-
-
-import Utils
-from Utils import async_start
-from CommonClient import CommonContext, server_loop, gui_enabled, ClientCommandProcessor, logger, \
-    get_base_parser
-
-SYSTEM_MESSAGE_ID = 0
-
-CONNECTION_TIMING_OUT_STATUS = "Connection timing out. Please restart your emulator, then restart connector_ff1.lua"
-CONNECTION_REFUSED_STATUS = "Connection Refused. Please start your emulator and make sure connector_ff1.lua is running"
-CONNECTION_RESET_STATUS = "Connection was reset. Please restart your emulator, then restart connector_ff1.lua"
-CONNECTION_TENTATIVE_STATUS = "Initial Connection Made"
-CONNECTION_CONNECTED_STATUS = "Connected"
-CONNECTION_INITIAL_STATUS = "Connection has not been initiated"
-
-DISPLAY_MSGS = True
-
-
-class FF1CommandProcessor(ClientCommandProcessor):
-    def __init__(self, ctx: CommonContext):
-        super().__init__(ctx)
-
-    def _cmd_nes(self):
-        """Check NES Connection State"""
-        if isinstance(self.ctx, FF1Context):
-            logger.info(f"NES Status: {self.ctx.nes_status}")
-
-    def _cmd_toggle_msgs(self):
-        """Toggle displaying messages in EmuHawk"""
-        global DISPLAY_MSGS
-        DISPLAY_MSGS = not DISPLAY_MSGS
-        logger.info(f"Messages are now {'enabled' if DISPLAY_MSGS  else 'disabled'}")
-
-
-class FF1Context(CommonContext):
-    command_processor = FF1CommandProcessor
-    game = 'Final Fantasy'
-    items_handling = 0b111  # full remote
-
-    def __init__(self, server_address, password):
-        super().__init__(server_address, password)
-        self.nes_streams: (StreamReader, StreamWriter) = None
-        self.nes_sync_task = None
-        self.messages = {}
-        self.locations_array = None
-        self.nes_status = CONNECTION_INITIAL_STATUS
-        self.awaiting_rom = False
-        self.display_msgs = True
-
-    async def server_auth(self, password_requested: bool = False):
-        if password_requested and not self.password:
-            await super(FF1Context, self).server_auth(password_requested)
-        if not self.auth:
-            self.awaiting_rom = True
-            logger.info('Awaiting connection to NES to get Player information')
-            return
-
-        await self.send_connect()
-
-    def _set_message(self, msg: str, msg_id: int):
-        if DISPLAY_MSGS:
-            self.messages[time.time(), msg_id] = msg
-
-    def on_package(self, cmd: str, args: dict):
-        if cmd == 'Connected':
-            async_start(parse_locations(self.locations_array, self, True))
-        elif cmd == 'Print':
-            msg = args['text']
-            if ': !' not in msg:
-                self._set_message(msg, SYSTEM_MESSAGE_ID)
-
-    def on_print_json(self, args: dict):
-        if self.ui:
-            self.ui.print_json(copy.deepcopy(args["data"]))
-        else:
-            text = self.jsontotextparser(copy.deepcopy(args["data"]))
-            logger.info(text)
-        relevant = args.get("type", None) in {"Hint", "ItemSend"}
-        if relevant:
-            item = args["item"]
-            # goes to this world
-            if self.slot_concerns_self(args["receiving"]):
-                relevant = True
-            # found in this world
-            elif self.slot_concerns_self(item.player):
-                relevant = True
-            # not related
-            else:
-                relevant = False
-            if relevant:
-                item = args["item"]
-                msg = self.raw_text_parser(copy.deepcopy(args["data"]))
-                self._set_message(msg, item.item)
-
-    def run_gui(self):
-        from kvui import GameManager
-
-        class FF1Manager(GameManager):
-            logging_pairs = [
-                ("Client", "Archipelago")
-            ]
-            base_title = "Archipelago Final Fantasy 1 Client"
-
-        self.ui = FF1Manager(self)
-        self.ui_task = asyncio.create_task(self.ui.async_run(), name="UI")
-
-
-def get_payload(ctx: FF1Context):
-    current_time = time.time()
-    return json.dumps(
-        {
-            "items": [item.item for item in ctx.items_received],
-            "messages": {f'{key[0]}:{key[1]}': value for key, value in ctx.messages.items()
-                         if key[0] > current_time - 10}
-        }
-    )
-
-
-async def parse_locations(locations_array: List[int], ctx: FF1Context, force: bool):
-    if locations_array == ctx.locations_array and not force:
-        return
-    else:
-        # print("New values")
-        ctx.locations_array = locations_array
-        locations_checked = []
-        if len(locations_array) > 0xFE and locations_array[0xFE] & 0x02 != 0 and not ctx.finished_game:
-            await ctx.send_msgs([
-                {"cmd": "StatusUpdate",
-                 "status": 30}
-            ])
-            ctx.finished_game = True
-        for location in ctx.missing_locations:
-            # index will be - 0x100 or 0x200
-            index = location
-            if location < 0x200:
-                # Location is a chest
-                index -= 0x100
-                flag = 0x04
-            else:
-                # Location is an NPC
-                index -= 0x200
-                flag = 0x02
-
-            # print(f"Location: {ctx.location_names[location]}")
-            # print(f"Index: {str(hex(index))}")
-            # print(f"value: {locations_array[index] & flag != 0}")
-            if locations_array[index] & flag != 0:
-                locations_checked.append(location)
-        if locations_checked:
-            # print([ctx.location_names[location] for location in locations_checked])
-            await ctx.send_msgs([
-                {"cmd": "LocationChecks",
-                 "locations": locations_checked}
-            ])
-
-
-async def nes_sync_task(ctx: FF1Context):
-    logger.info("Starting nes connector. Use /nes for status information")
-    while not ctx.exit_event.is_set():
-        error_status = None
-        if ctx.nes_streams:
-            (reader, writer) = ctx.nes_streams
-            msg = get_payload(ctx).encode()
-            writer.write(msg)
-            writer.write(b'\n')
-            try:
-                await asyncio.wait_for(writer.drain(), timeout=1.5)
-                try:
-                    # Data will return a dict with up to two fields:
-                    # 1. A keepalive response of the Players Name (always)
-                    # 2. An array representing the memory values of the locations area (if in game)
-                    data = await asyncio.wait_for(reader.readline(), timeout=5)
-                    data_decoded = json.loads(data.decode())
-                    # print(data_decoded)
-                    if ctx.game is not None and 'locations' in data_decoded:
-                        # Not just a keep alive ping, parse
-                        async_start(parse_locations(data_decoded['locations'], ctx, False))
-                    if not ctx.auth:
-                        ctx.auth = ''.join([chr(i) for i in data_decoded['playerName'] if i != 0])
-                        if ctx.auth == '':
-                            logger.info("Invalid ROM detected. No player name built into the ROM. Please regenerate"
-                                        "the ROM using the same link but adding your slot name")
-                        if ctx.awaiting_rom:
-                            await ctx.server_auth(False)
-                except asyncio.TimeoutError:
-                    logger.debug("Read Timed Out, Reconnecting")
-                    error_status = CONNECTION_TIMING_OUT_STATUS
-                    writer.close()
-                    ctx.nes_streams = None
-                except ConnectionResetError as e:
-                    logger.debug("Read failed due to Connection Lost, Reconnecting")
-                    error_status = CONNECTION_RESET_STATUS
-                    writer.close()
-                    ctx.nes_streams = None
-            except TimeoutError:
-                logger.debug("Connection Timed Out, Reconnecting")
-                error_status = CONNECTION_TIMING_OUT_STATUS
-                writer.close()
-                ctx.nes_streams = None
-            except ConnectionResetError:
-                logger.debug("Connection Lost, Reconnecting")
-                error_status = CONNECTION_RESET_STATUS
-                writer.close()
-                ctx.nes_streams = None
-            if ctx.nes_status == CONNECTION_TENTATIVE_STATUS:
-                if not error_status:
-                    logger.info("Successfully Connected to NES")
-                    ctx.nes_status = CONNECTION_CONNECTED_STATUS
-                else:
-                    ctx.nes_status = f"Was tentatively connected but error occured: {error_status}"
-            elif error_status:
-                ctx.nes_status = error_status
-                logger.info("Lost connection to nes and attempting to reconnect. Use /nes for status updates")
-        else:
-            try:
-                logger.debug("Attempting to connect to NES")
-                ctx.nes_streams = await asyncio.wait_for(asyncio.open_connection("localhost", 52980), timeout=10)
-                ctx.nes_status = CONNECTION_TENTATIVE_STATUS
-            except TimeoutError:
-                logger.debug("Connection Timed Out, Trying Again")
-                ctx.nes_status = CONNECTION_TIMING_OUT_STATUS
-                continue
-            except ConnectionRefusedError:
-                logger.debug("Connection Refused, Trying Again")
-                ctx.nes_status = CONNECTION_REFUSED_STATUS
-                continue
-
-
-if __name__ == '__main__':
-    # Text Mode to use !hint and such with games that have no text entry
-    Utils.init_logging("FF1Client")
-
-    options = Utils.get_options()
-    DISPLAY_MSGS = options["ffr_options"]["display_msgs"]
-
-    async def main(args):
-        ctx = FF1Context(args.connect, args.password)
-        ctx.server_task = asyncio.create_task(server_loop(ctx), name="ServerLoop")
-        if gui_enabled:
-            ctx.run_gui()
-        ctx.run_cli()
-        ctx.nes_sync_task = asyncio.create_task(nes_sync_task(ctx), name="NES Sync")
-
-        await ctx.exit_event.wait()
-        ctx.server_address = None
-
-        await ctx.shutdown()
-
-        if ctx.nes_sync_task:
-            await ctx.nes_sync_task
-
-
-    import colorama
-
-    parser = get_base_parser()
-    args = parser.parse_args()
-    colorama.just_fix_windows_console()
-
-    asyncio.run(main(args))
-    colorama.deinit()

Fill.py

@@ -4,7 +4,7 @@ import logging
 import typing
 from collections import Counter, deque
 
-from BaseClasses import CollectionState, Item, Location, LocationProgressType, MultiWorld
+from BaseClasses import CollectionState, Item, Location, LocationProgressType, MultiWorld, PlandoItemBlock
 from Options import Accessibility
 
 from worlds.AutoWorld import call_all
@@ -100,7 +100,7 @@ def fill_restrictive(multiworld: MultiWorld, base_state: CollectionState, locati
             # if minimal accessibility, only check whether location is reachable if game not beatable
             if multiworld.worlds[item_to_place.player].options.accessibility == Accessibility.option_minimal:
                 perform_access_check = not multiworld.has_beaten_game(maximum_exploration_state,
-                                                                 item_to_place.player) \
+                                                                      item_to_place.player) \
                     if single_player_placement else not has_beaten_game
             else:
                 perform_access_check = True
@@ -138,32 +138,21 @@ def fill_restrictive(multiworld: MultiWorld, base_state: CollectionState, locati
                         # to clean that up later, so there is a chance generation fails.
                         if (not single_player_placement or location.player == item_to_place.player) \
                                 and location.can_fill(swap_state, item_to_place, perform_access_check):
+                            # Add this item to the existing placement, and
+                            # add the old item to the back of the queue
+                            spot_to_fill = placements.pop(i)
 
-                            # Verify placing this item won't reduce available locations, which would be a useless swap.
-                            prev_state = swap_state.copy()
-                            prev_loc_count = len(
-                                multiworld.get_reachable_locations(prev_state))
+                            swap_count += 1
+                            swapped_items[placed_item.player, placed_item.name, unsafe] = swap_count
 
-                            swap_state.collect(item_to_place, True)
-                            new_loc_count = len(
-                                multiworld.get_reachable_locations(swap_state))
+                            reachable_items[placed_item.player].appendleft(
+                                placed_item)
+                            item_pool.append(placed_item)
 
-                            if new_loc_count >= prev_loc_count:
-                                # Add this item to the existing placement, and
-                                # add the old item to the back of the queue
-                                spot_to_fill = placements.pop(i)
+                            # cleanup at the end to hopefully get better errors
+                            cleanup_required = True
 
-                                swap_count += 1
-                                swapped_items[placed_item.player, placed_item.name, unsafe] = swap_count
-
-                                reachable_items[placed_item.player].appendleft(
-                                    placed_item)
-                                item_pool.append(placed_item)
-
-                                # cleanup at the end to hopefully get better errors
-                                cleanup_required = True
-
-                                break
+                            break
 
                         # Item can't be placed here, restore original item
                         location.item = placed_item
@@ -242,7 +231,7 @@ def remaining_fill(multiworld: MultiWorld,
     unplaced_items: typing.List[Item] = []
     placements: typing.List[Location] = []
     swapped_items: typing.Counter[typing.Tuple[int, str]] = Counter()
-    total = min(len(itempool),  len(locations))
+    total = min(len(itempool), len(locations))
     placed = 0
 
     # Optimisation: Decide whether to do full location.can_fill check (respect excluded), or only check the item rule
@@ -343,8 +332,10 @@ def fast_fill(multiworld: MultiWorld,
 
 def accessibility_corrections(multiworld: MultiWorld, state: CollectionState, locations, pool=[]):
     maximum_exploration_state = sweep_from_pool(state, pool)
-    minimal_players = {player for player in multiworld.player_ids if multiworld.worlds[player].options.accessibility == "minimal"}
-    unreachable_locations = [location for location in multiworld.get_locations() if location.player in minimal_players and
+    minimal_players = {player for player in multiworld.player_ids if
+                       multiworld.worlds[player].options.accessibility == "minimal"}
+    unreachable_locations = [location for location in multiworld.get_locations() if
+                             location.player in minimal_players and
                              not location.can_reach(maximum_exploration_state)]
     for location in unreachable_locations:
         if (location.item is not None and location.item.advancement and location.address is not None and not
@@ -365,7 +356,7 @@ def inaccessible_location_rules(multiworld: MultiWorld, state: CollectionState,
     unreachable_locations = [location for location in locations if not location.can_reach(maximum_exploration_state)]
     if unreachable_locations:
         def forbid_important_item_rule(item: Item):
-            return not ((item.classification & 0b0011) and multiworld.worlds[item.player].options.accessibility != 'minimal')
+            return not ((item.classification & 0b0011) and multiworld.worlds[item.player].options.accessibility != "minimal")
 
         for location in unreachable_locations:
             add_item_rule(location, forbid_important_item_rule)
@@ -677,9 +668,9 @@ def balance_multiworld_progression(multiworld: MultiWorld) -> None:
         if multiworld.worlds[player].options.progression_balancing > 0
     }
     if not balanceable_players:
-        logging.info('Skipping multiworld progression balancing.')
+        logging.info("Skipping multiworld progression balancing.")
     else:
-        logging.info(f'Balancing multiworld progression for {len(balanceable_players)} Players.')
+        logging.info(f"Balancing multiworld progression for {len(balanceable_players)} Players.")
         logging.debug(balanceable_players)
         state: CollectionState = CollectionState(multiworld)
         checked_locations: typing.Set[Location] = set()
@@ -777,7 +768,7 @@ def balance_multiworld_progression(multiworld: MultiWorld) -> None:
                                 if player in threshold_percentages):
                             break
                         elif not balancing_sphere:
-                            raise RuntimeError('Not all required items reachable. Something went terribly wrong here.')
+                            raise RuntimeError("Not all required items reachable. Something went terribly wrong here.")
                     # Gather a set of locations which we can swap items into
                     unlocked_locations: typing.Dict[int, typing.Set[Location]] = collections.defaultdict(set)
                     for l in unchecked_locations:
@@ -793,8 +784,8 @@ def balance_multiworld_progression(multiworld: MultiWorld) -> None:
                             testing = items_to_test.pop()
                             reducing_state = state.copy()
                             for location in itertools.chain((
-                                l for l in items_to_replace
-                                if l.item.player == player
+                                    l for l in items_to_replace
+                                    if l.item.player == player
                             ), items_to_test):
                                 reducing_state.collect(location.item, True, location)
 
@@ -867,52 +858,30 @@ def swap_location_item(location_1: Location, location_2: Location, check_locked:
     location_2.item.location = location_2
 
 
-def distribute_planned(multiworld: MultiWorld) -> None:
-    def warn(warning: str, force: typing.Union[bool, str]) -> None:
-        if force in [True, 'fail', 'failure', 'none', False, 'warn', 'warning']:
-            logging.warning(f'{warning}')
+def parse_planned_blocks(multiworld: MultiWorld) -> dict[int, list[PlandoItemBlock]]:
+    def warn(warning: str, force: bool | str) -> None:
+        if isinstance(force, bool):
+            logging.warning(f"{warning}")
         else:
-            logging.debug(f'{warning}')
+            logging.debug(f"{warning}")
 
-    def failed(warning: str, force: typing.Union[bool, str]) -> None:
-        if force in [True, 'fail', 'failure']:
+    def failed(warning: str, force: bool | str) -> None:
+        if force is True:
             raise Exception(warning)
         else:
             warn(warning, force)
 
-    swept_state = multiworld.state.copy()
-    swept_state.sweep_for_advancements()
-    reachable = frozenset(multiworld.get_reachable_locations(swept_state))
-    early_locations: typing.Dict[int, typing.List[str]] = collections.defaultdict(list)
-    non_early_locations: typing.Dict[int, typing.List[str]] = collections.defaultdict(list)
-    for loc in multiworld.get_unfilled_locations():
-        if loc in reachable:
-            early_locations[loc.player].append(loc.name)
-        else:  # not reachable with swept state
-            non_early_locations[loc.player].append(loc.name)
-
     world_name_lookup = multiworld.world_name_lookup
 
-    block_value = typing.Union[typing.List[str], typing.Dict[str, typing.Any], str]
-    plando_blocks: typing.List[typing.Dict[str, typing.Any]] = []
-    player_ids = set(multiworld.player_ids)
+    plando_blocks: dict[int, list[PlandoItemBlock]] = dict()
+    player_ids: set[int] = set(multiworld.player_ids)
     for player in player_ids:
-        for block in multiworld.plando_items[player]:
-            block['player'] = player
-            if 'force' not in block:
-                block['force'] = 'silent'
-            if 'from_pool' not in block:
-                block['from_pool'] = True
-            elif not isinstance(block['from_pool'], bool):
-                from_pool_type = type(block['from_pool'])
-                raise Exception(f'Plando "from_pool" has to be boolean, not {from_pool_type} for player {player}.')
-            if 'world' not in block:
-                target_world = False
-            else:
-                target_world = block['world']
-
+        plando_blocks[player] = []
+        for block in multiworld.worlds[player].options.plando_items:
+            new_block: PlandoItemBlock = PlandoItemBlock(player, block.from_pool, block.force)
+            target_world = block.world
             if target_world is False or multiworld.players == 1:  # target own world
-                worlds: typing.Set[int] = {player}
+                worlds: set[int] = {player}
             elif target_world is True:  # target any worlds besides own
                 worlds = set(multiworld.player_ids) - {player}
             elif target_world is None:  # target all worlds
@@ -921,173 +890,201 @@ def distribute_planned(multiworld: MultiWorld) -> None:
                 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.",
-                               block['force'])
+                        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])
             elif type(target_world) == int:  # target world by slot number
                 if target_world not in range(1, multiworld.players + 1):
                     failed(
                         f"Cannot place item in world {target_world} as it is not in range of (1, {multiworld.players})",
-                        block['force'])
+                        block.force)
                     continue
                 worlds = {target_world}
             else:  # target world by slot name
                 if target_world not in world_name_lookup:
                     failed(f"Cannot place item to {target_world}'s world as that world does not exist.",
-                           block['force'])
+                           block.force)
                     continue
                 worlds = {world_name_lookup[target_world]}
-            block['world'] = worlds
+            new_block.worlds = worlds
 
-            items: block_value = []
-            if "items" in block:
-                items = block["items"]
-                if 'count' not in block:
-                    block['count'] = False
-            elif "item" in block:
-                items = block["item"]
-                if 'count' not in block:
-                    block['count'] = 1
-            else:
-                failed("You must specify at least one item to place items with plando.", block['force'])
-                continue
+            items: list[str] | dict[str, typing.Any] = block.items
             if isinstance(items, dict):
-                item_list: typing.List[str] = []
+                item_list: list[str] = []
                 for key, value in items.items():
                     if value is True:
                         value = multiworld.itempool.count(multiworld.worlds[player].create_item(key))
                     item_list += [key] * value
                 items = item_list
-            if isinstance(items, str):
-                items = [items]
-            block['items'] = items
+            new_block.items = items
 
-            locations: block_value = []
-            if 'location' in block:
-                locations = block['location']  # just allow 'location' to keep old yamls compatible
-            elif 'locations' in block:
-                locations = block['locations']
+            locations: list[str] = block.locations
             if isinstance(locations, str):
                 locations = [locations]
 
-            if isinstance(locations, dict):
-                location_list = []
-                for key, value in locations.items():
-                    location_list += [key] * value
-                locations = location_list
+            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:
+                        locations_from_groups.extend(multiworld.worlds[target_player].location_name_groups[group])
+                resolved_locations.extend(location for location in world_locations
+                                          if location.name in [*locations, *locations_from_groups])
+            new_block.locations = sorted(dict.fromkeys(locations))
+            new_block.resolved_locations = sorted(set(resolved_locations))
 
+            count = block.count
+            if not count:
+                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"] = (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)
+
+    return plando_blocks
+
+
+def resolve_early_locations_for_planned(multiworld: MultiWorld):
+    def warn(warning: str, force: bool | str) -> None:
+        if isinstance(force, bool):
+            logging.warning(f"{warning}")
+        else:
+            logging.debug(f"{warning}")
+
+    def failed(warning: str, force: bool | str) -> None:
+        if force is True:
+            raise Exception(warning)
+        else:
+            warn(warning, force)
+
+    swept_state = multiworld.state.copy()
+    swept_state.sweep_for_advancements()
+    reachable = frozenset(multiworld.get_reachable_locations(swept_state))
+    early_locations: dict[int, list[Location]] = collections.defaultdict(list)
+    non_early_locations: dict[int, list[Location]] = collections.defaultdict(list)
+    for loc in multiworld.get_unfilled_locations():
+        if loc in reachable:
+            early_locations[loc.player].append(loc)
+        else:  # not reachable with swept state
+            non_early_locations[loc.player].append(loc)
+
+    for player in multiworld.plando_item_blocks:
+        removed = []
+        for block in multiworld.plando_item_blocks[player]:
+            locations = block.locations
+            resolved_locations = block.resolved_locations
+            worlds = block.worlds
             if "early_locations" in locations:
-                locations.remove("early_locations")
                 for target_player in worlds:
-                    locations += early_locations[target_player]
+                    resolved_locations += early_locations[target_player]
             if "non_early_locations" in locations:
-                locations.remove("non_early_locations")
                 for target_player in worlds:
-                    locations += non_early_locations[target_player]
+                    resolved_locations += non_early_locations[target_player]
 
-            block['locations'] = list(dict.fromkeys(locations))
+            if block.count["max"] > len(block.items):
+                count = block.count["max"]
+                failed(f"Plando count {count} greater than items specified", block.force)
+                block.count["max"] = len(block.items)
+                if block.count["min"] > len(block.items):
+                    block.count["min"] = len(block.items)
+            if block.count["max"] > len(block.resolved_locations) > 0:
+                count = block.count["max"]
+                failed(f"Plando count {count} greater than locations specified", block.force)
+                block.count["max"] = len(block.resolved_locations)
+                if block.count["min"] > len(block.resolved_locations):
+                    block.count["min"] = len(block.resolved_locations)
+            block.count["target"] = multiworld.random.randint(block.count["min"],
+                                                                     block.count["max"])
 
-            if not block['count']:
-                block['count'] = (min(len(block['items']), len(block['locations'])) if
-                                  len(block['locations']) > 0 else len(block['items']))
-            if isinstance(block['count'], int):
-                block['count'] = {'min': block['count'], 'max': block['count']}
-            if 'min' not in block['count']:
-                block['count']['min'] = 0
-            if 'max' not in block['count']:
-                block['count']['max'] = (min(len(block['items']), len(block['locations'])) if
-                                         len(block['locations']) > 0 else len(block['items']))
-            if block['count']['max'] > len(block['items']):
-                count = block['count']
-                failed(f"Plando count {count} greater than items specified", block['force'])
-                block['count'] = len(block['items'])
-            if block['count']['max'] > len(block['locations']) > 0:
-                count = block['count']
-                failed(f"Plando count {count} greater than locations specified", block['force'])
-                block['count'] = len(block['locations'])
-            block['count']['target'] = multiworld.random.randint(block['count']['min'], block['count']['max'])
+            if not block.count["target"]:
+                removed.append(block)
 
-            if block['count']['target'] > 0:
-                plando_blocks.append(block)
+        for block in removed:
+            multiworld.plando_item_blocks[player].remove(block)
+
+
+def distribute_planned_blocks(multiworld: MultiWorld, plando_blocks: list[PlandoItemBlock]):
+    def warn(warning: str, force: bool | str) -> None:
+        if isinstance(force, bool):
+            logging.warning(f"{warning}")
+        else:
+            logging.debug(f"{warning}")
+
+    def failed(warning: str, force: bool | str) -> None:
+        if force is True:
+            raise Exception(warning)
+        else:
+            warn(warning, force)
 
     # shuffle, but then sort blocks by number of locations minus number of items,
     # so less-flexible blocks get priority
     multiworld.random.shuffle(plando_blocks)
-    plando_blocks.sort(key=lambda block: (len(block['locations']) - block['count']['target']
-                                          if len(block['locations']) > 0
-                                          else len(multiworld.get_unfilled_locations(player)) - block['count']['target']))
-
+    plando_blocks.sort(key=lambda block: (len(block.resolved_locations) - block.count["target"]
+                                          if len(block.resolved_locations) > 0
+                                          else len(multiworld.get_unfilled_locations(block.player)) -
+                                          block.count["target"]))
     for placement in plando_blocks:
-        player = placement['player']
+        player = placement.player
         try:
-            worlds = placement['world']
-            locations = placement['locations']
-            items = placement['items']
-            maxcount = placement['count']['target']
-            from_pool = placement['from_pool']
+            worlds = placement.worlds
+            locations = placement.resolved_locations
+            items = placement.items
+            maxcount = placement.count["target"]
+            from_pool = placement.from_pool
 
-            candidates = list(multiworld.get_unfilled_locations_for_players(locations, sorted(worlds)))
-            multiworld.random.shuffle(candidates)
-            multiworld.random.shuffle(items)
-            count = 0
-            err: typing.List[str] = []
-            successful_pairs: typing.List[typing.Tuple[int, Item, Location]] = []
-            claimed_indices: typing.Set[typing.Optional[int]] = set()
-            for item_name in items:
-                index_to_delete: typing.Optional[int] = None
-                if from_pool:
-                    try:
-                        # If from_pool, try to find an existing item with this name & player in the itempool and use it
-                        index_to_delete, item = next(
-                            (i, item) for i, item in enumerate(multiworld.itempool)
-                            if item.player == player and item.name == item_name and i not in claimed_indices
-                        )
-                    except StopIteration:
-                        warn(
-                        f"Could not remove {item_name} from pool for {multiworld.player_name[player]} as it's already missing from it.",
-                        placement['force'])
-                        item = multiworld.worlds[player].create_item(item_name)
-                else:
-                    item = multiworld.worlds[player].create_item(item_name)
-
-                for location in reversed(candidates):
-                    if (location.address is None) == (item.code is None):  # either both None or both not None
-                        if not location.item:
-                            if location.item_rule(item):
-                                if location.can_fill(multiworld.state, item, False):
-                                    successful_pairs.append((index_to_delete, item, location))
-                                    claimed_indices.add(index_to_delete)
-                                    candidates.remove(location)
-                                    count = count + 1
-                                    break
-                                else:
-                                    err.append(f"Can't place item at {location} due to fill condition not met.")
-                            else:
-                                err.append(f"{item_name} not allowed at {location}.")
-                        else:
-                            err.append(f"Cannot place {item_name} into already filled location {location}.")
+            item_candidates = []
+            if from_pool:
+                instances = [item for item in multiworld.itempool if item.player == player and item.name in items]
+                for item in multiworld.random.sample(items, maxcount):
+                    candidate = next((i for i in instances if i.name == item), None)
+                    if candidate is None:
+                        warn(f"Could not remove {item} from pool for {multiworld.player_name[player]} as "
+                             f"it's already missing from it", placement.force)
+                        candidate = multiworld.worlds[player].create_item(item)
                     else:
-                        err.append(f"Mismatch between {item_name} and {location}, only one is an event.")
-
-                if count == maxcount:
-                    break
-            if count < placement['count']['min']:
-                m = placement['count']['min']
-                failed(
-                    f"Plando block failed to place {m - count} of {m} item(s) for {multiworld.player_name[player]}, error(s): {' '.join(err)}",
-                    placement['force'])
-
-            # Sort indices in reverse so we can remove them one by one
-            successful_pairs = sorted(successful_pairs, key=lambda successful_pair: successful_pair[0] or 0, reverse=True)
-
-            for (index, item, location) in successful_pairs:
-                multiworld.push_item(location, item, collect=False)
-                location.locked = True
-                logging.debug(f"Plando placed {item} at {location}")
-                if index is not None:  # If this item is from_pool and was found in the pool, remove it.
-                    multiworld.itempool.pop(index)
+                        multiworld.itempool.remove(candidate)
+                        instances.remove(candidate)
+                    item_candidates.append(candidate)
+            else:
+                item_candidates = [multiworld.worlds[player].create_item(item)
+                                   for item in multiworld.random.sample(items, maxcount)]
+            if any(item.code is None for item in item_candidates) \
+               and not all(item.code is None for item in item_candidates):
+                failed(f"Plando block for player {player} ({multiworld.player_name[player]}) contains both "
+                       f"event items and non-event items. "
+                       f"Event items: {[item for item in item_candidates if item.code is None]}, "
+                       f"Non-event items: {[item for item in item_candidates if item.code is not None]}",
+                       placement.force)
+                continue
+            else:
+                is_real = item_candidates[0].code is not None
+            candidates = [candidate for candidate in locations if candidate.item is None
+                          and bool(candidate.address) == is_real]
+            multiworld.random.shuffle(candidates)
+            allstate = multiworld.get_all_state(False)
+            mincount = placement.count["min"]
+            allowed_margin = len(item_candidates) - mincount
+            fill_restrictive(multiworld, allstate, candidates, item_candidates, lock=True,
+                             allow_partial=True, name="Plando Main Fill")
 
+            if len(item_candidates) > allowed_margin:
+                failed(f"Could not place {len(item_candidates)} "
+                       f"of {mincount + allowed_margin} item(s) "
+                       f"for {multiworld.player_name[player]}, "
+                       f"remaining items: {item_candidates}",
+                       placement.force)
+            if from_pool:
+                multiworld.itempool.extend([item for item in item_candidates if item.code is not None])
         except Exception as e:
             raise Exception(
                 f"Error running plando for player {player} ({multiworld.player_name[player]})") from e

Generate.py

@@ -10,8 +10,8 @@ import sys
 import urllib.parse
 import urllib.request
 from collections import Counter
-from typing import Any, Dict, Tuple, Union
 from itertools import chain
+from typing import Any
 
 import ModuleUpdate
 
@@ -77,7 +77,7 @@ def get_seed_name(random_source) -> str:
     return f"{random_source.randint(0, pow(10, seeddigits) - 1)}".zfill(seeddigits)
 
 
-def main(args=None) -> Tuple[argparse.Namespace, int]:
+def main(args=None) -> tuple[argparse.Namespace, int]:
     # __name__ == "__main__" check so unittests that already imported worlds don't trip this.
     if __name__ == "__main__" and "worlds" in sys.modules:
         raise Exception("Worlds system should not be loaded before logging init.")
@@ -95,7 +95,7 @@ def main(args=None) -> Tuple[argparse.Namespace, int]:
         logging.info("Race mode enabled. Using non-deterministic random source.")
         random.seed()  # reset to time-based random source
 
-    weights_cache: Dict[str, Tuple[Any, ...]] = {}
+    weights_cache: dict[str, tuple[Any, ...]] = {}
     if args.weights_file_path and os.path.exists(args.weights_file_path):
         try:
             weights_cache[args.weights_file_path] = read_weights_yamls(args.weights_file_path)
@@ -180,7 +180,7 @@ def main(args=None) -> Tuple[argparse.Namespace, int]:
     erargs.name = {}
     erargs.csv_output = args.csv_output
 
-    settings_cache: Dict[str, Tuple[argparse.Namespace, ...]] = \
+    settings_cache: dict[str, tuple[argparse.Namespace, ...]] = \
         {fname: (tuple(roll_settings(yaml, args.plando) for yaml in yamls) if args.sameoptions else None)
          for fname, yamls in weights_cache.items()}
 
@@ -212,7 +212,7 @@ def main(args=None) -> Tuple[argparse.Namespace, int]:
         path = player_path_cache[player]
         if path:
             try:
-                settings: Tuple[argparse.Namespace, ...] = settings_cache[path] if settings_cache[path] else \
+                settings: tuple[argparse.Namespace, ...] = settings_cache[path] if settings_cache[path] else \
                     tuple(roll_settings(yaml, args.plando) for yaml in weights_cache[path])
                 for settingsObject in settings:
                     for k, v in vars(settingsObject).items():
@@ -224,10 +224,14 @@ def main(args=None) -> Tuple[argparse.Namespace, int]:
                             except Exception as e:
                                 raise Exception(f"Error setting {k} to {v} for player {player}") from e
 
-                    if path == args.weights_file_path:  # if name came from the weights file, just use base player name
-                        erargs.name[player] = f"Player{player}"
-                    elif player not in erargs.name:  # if name was not specified, generate it from filename
-                        erargs.name[player] = os.path.splitext(os.path.split(path)[-1])[0]
+                    # name was not specified
+                    if player not in erargs.name:
+                        if path == args.weights_file_path:
+                            # weights file, so we need to make the name unique
+                            erargs.name[player] = f"Player{player}"
+                        else:
+                            # use the filename
+                            erargs.name[player] = os.path.splitext(os.path.split(path)[-1])[0]
                     erargs.name[player] = handle_name(erargs.name[player], player, name_counter)
 
                     player += 1
@@ -242,7 +246,7 @@ def main(args=None) -> Tuple[argparse.Namespace, int]:
     return erargs, seed
 
 
-def read_weights_yamls(path) -> Tuple[Any, ...]:
+def read_weights_yamls(path) -> tuple[Any, ...]:
     try:
         if urllib.parse.urlparse(path).scheme in ('https', 'file'):
             yaml = str(urllib.request.urlopen(path).read(), "utf-8-sig")
@@ -334,12 +338,6 @@ def handle_name(name: str, player: int, name_counter: Counter):
     return new_name
 
 
-def roll_percentage(percentage: Union[int, float]) -> bool:
-    """Roll a percentage chance.
-    percentage is expected to be in range [0, 100]"""
-    return random.random() < (float(percentage) / 100)
-
-
 def update_weights(weights: dict, new_weights: dict, update_type: str, name: str) -> dict:
     logging.debug(f'Applying {new_weights}')
     cleaned_weights = {}
@@ -384,7 +382,7 @@ def update_weights(weights: dict, new_weights: dict, update_type: str, name: str
     return weights
 
 
-def roll_meta_option(option_key, game: str, category_dict: Dict) -> Any:
+def roll_meta_option(option_key, game: str, category_dict: dict) -> Any:
     from worlds import AutoWorldRegister
 
     if not game:
@@ -405,7 +403,7 @@ def roll_linked_options(weights: dict) -> dict:
         if "name" not in option_set:
             raise ValueError("One of your linked options does not have a name.")
         try:
-            if roll_percentage(option_set["percentage"]):
+            if Options.roll_percentage(option_set["percentage"]):
                 logging.debug(f"Linked option {option_set['name']} triggered.")
                 new_options = option_set["options"]
                 for category_name, category_options in new_options.items():
@@ -438,7 +436,7 @@ def roll_triggers(weights: dict, triggers: list, valid_keys: set) -> dict:
             trigger_result = get_choice("option_result", option_set)
             result = get_choice(key, currently_targeted_weights)
             currently_targeted_weights[key] = result
-            if result == trigger_result and roll_percentage(get_choice("percentage", option_set, 100)):
+            if result == trigger_result and Options.roll_percentage(get_choice("percentage", option_set, 100)):
                 for category_name, category_options in option_set["options"].items():
                     currently_targeted_weights = weights
                     if category_name:
@@ -542,10 +540,6 @@ def roll_settings(weights: dict, plando_options: PlandoOptions = PlandoOptions.b
         handle_option(ret, game_weights, option_key, option, plando_options)
         valid_keys.add(option_key)
 
-    # TODO remove plando_items after moving it to the options system
-    valid_keys.add("plando_items")
-    if PlandoOptions.items in plando_options:
-        ret.plando_items = copy.deepcopy(game_weights.get("plando_items", []))
     if ret.game == "A Link to the Past":
         # TODO there are still more LTTP options not on the options system
         valid_keys |= {"sprite_pool", "sprite", "random_sprite_on_event"}

Launcher.py

@@ -11,14 +11,16 @@ Additional components can be added to worlds.LauncherComponents.components.
 import argparse
 import logging
 import multiprocessing
+import os
 import shlex
 import subprocess
 import sys
 import urllib.parse
 import webbrowser
+from collections.abc import Callable, Sequence
 from os.path import isfile
 from shutil import which
-from typing import Callable, Optional, Sequence, Tuple, Union, Any
+from typing import Any
 
 if __name__ == "__main__":
     import ModuleUpdate
@@ -40,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 = []
@@ -91,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}")
 
@@ -103,66 +113,51 @@ 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."),
 ])
 
 
-def handle_uri(path: str, launch_args: Tuple[str, ...]) -> None:
+def handle_uri(path: str) -> tuple[list[Component], Component]:
     url = urllib.parse.urlparse(path)
     queries = urllib.parse.parse_qs(url.query)
-    launch_args = (path, *launch_args)
-    client_component = []
+    client_components = []
     text_client_component = None
-    if "game" in queries:
-        game = queries["game"][0]
-    else:  # TODO around 0.6.0 - this is for pre this change webhost uri's
-        game = "Archipelago"
+    game = queries["game"][0]
     for component in components:
         if component.supports_uri and component.game_name == game:
-            client_component.append(component)
+            client_components.append(component)
         elif component.display_name == "Text Client":
             text_client_component = component
-
-    from kvui import MDButton, MDButtonText
-    from kivymd.uix.dialog import MDDialog, MDDialogHeadlineText, MDDialogContentContainer, MDDialogSupportingText
-    from kivymd.uix.divider import MDDivider
-
-    if not client_component:
-        run_component(text_client_component, *launch_args)
-        return
-    else:
-        popup_text = MDDialogSupportingText(text="Select client to open and connect with.")
-        component_buttons = [MDDivider()]
-        for component in [text_client_component, *client_component]:
-            component_buttons.append(MDButton(
-                MDButtonText(text=component.display_name),
-                on_release=lambda *args, comp=component: run_component(comp, *launch_args),
-                style="text"
-            ))
-        component_buttons.append(MDDivider())
-
-    MDDialog(
-        # Headline
-        MDDialogHeadlineText(text="Connect to Multiworld"),
-        # Text
-        popup_text,
-        # Content
-        MDDialogContentContainer(
-            *component_buttons,
-            orientation="vertical"
-        ),
-
-    ).open()
+    return client_components, text_client_component
 
 
-def identify(path: Union[None, str]) -> Tuple[Union[None, str], Union[None, Component]]:
+def build_uri_popup(component_list: list[Component], launch_args: tuple[str, ...]) -> None:
+    from kvui import ButtonsPrompt
+    component_options = {
+        component.display_name: component for component in component_list
+    }
+    popup = ButtonsPrompt("Connect to Multiworld",
+                          "Select client to open and connect with.",
+                          lambda component_name: run_component(component_options[component_name], *launch_args),
+                          *component_options.keys())
+    popup.open()
+
+
+def identify(path: None | str) -> tuple[None | str, None | Component]:
     if path is None:
         return None, None
     for component in components:
@@ -173,7 +168,7 @@ def identify(path: Union[None, str]) -> Tuple[Union[None, str], Union[None, Comp
     return None, None
 
 
-def get_exe(component: Union[str, Component]) -> Optional[Sequence[str]]:
+def get_exe(component: str | Component) -> Sequence[str] | None:
     if isinstance(component, str):
         name = component
         component = None
@@ -201,7 +196,8 @@ def get_exe(component: Union[str, Component]) -> Optional[Sequence[str]]:
 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')
@@ -226,10 +222,10 @@ def create_shortcut(button: Any, component: Component) -> None:
     button.menu.dismiss()
 
 
-refresh_components: Optional[Callable[[], None]] = None
+refresh_components: Callable[[], None] | None = None
 
 
-def run_gui(path: str, args: Any) -> None:
+def run_gui(launch_components: list[Component], args: Any) -> None:
     from kvui import (ThemedApp, MDFloatLayout, MDGridLayout, ScrollBox)
     from kivy.properties import ObjectProperty
     from kivy.core.window import Window
@@ -262,12 +258,12 @@ def run_gui(path: str, args: Any) -> None:
         cards: list[LauncherCard]
         current_filter: Sequence[str | Type] | None
 
-        def __init__(self, ctx=None, path=None, args=None):
+        def __init__(self, ctx=None, components=None, args=None):
             self.title = self.base_title + " " + Utils.__version__
             self.ctx = ctx
             self.icon = r"data/icon.png"
             self.favorites = []
-            self.launch_uri = path
+            self.launch_components = components
             self.launch_args = args
             self.cards = []
             self.current_filter = (Type.CLIENT, Type.TOOL, Type.ADJUSTER, Type.MISC)
@@ -389,9 +385,9 @@ def run_gui(path: str, args: Any) -> None:
             return self.top_screen
 
         def on_start(self):
-            if self.launch_uri:
-                handle_uri(self.launch_uri, self.launch_args)
-                self.launch_uri = None
+            if self.launch_components:
+                build_uri_popup(self.launch_components, self.launch_args)
+                self.launch_components = None
                 self.launch_args = None
 
         @staticmethod
@@ -409,7 +405,7 @@ def run_gui(path: str, args: Any) -> None:
             if file and component:
                 run_component(component, file)
             else:
-                logging.warning(f"unable to identify component for {file}")
+                logging.warning(f"unable to identify component for {filename}")
 
         def _on_keyboard(self, window: Window, key: int, scancode: int, codepoint: str, modifier: list[str]):
             # Activate search as soon as we start typing, no matter if we are focused on the search box or not.
@@ -432,7 +428,7 @@ def run_gui(path: str, args: Any) -> None:
                                                                    for filter in self.current_filter))
             super().on_stop()
 
-    Launcher(path=path, args=args).run()
+    Launcher(components=launch_components, args=args).run()
 
     # avoiding Launcher reference leak
     # and don't try to do something with widgets after window closed
@@ -451,7 +447,7 @@ def run_component(component: Component, *args):
         logging.warning(f"Component {component} does not appear to be executable.")
 
 
-def main(args: Optional[Union[argparse.Namespace, dict]] = None):
+def main(args: argparse.Namespace | dict | None = None):
     if isinstance(args, argparse.Namespace):
         args = {k: v for k, v in args._get_kwargs()}
     elif not args:
@@ -459,7 +455,15 @@ def main(args: Optional[Union[argparse.Namespace, dict]] = None):
 
     path = args.get("Patch|Game|Component|url", None)
     if path is not None:
-        if not path.startswith("archipelago://"):
+        if path.startswith("archipelago://"):
+            args["args"] = (path, *args.get("args", ()))
+            # add the url arg to the passthrough args
+            components, text_client_component = handle_uri(path)
+            if not components:
+                args["component"] = text_client_component
+            else:
+                args['launch_components'] = [text_client_component, *components]
+        else:
             file, component = identify(path)
             if file:
                 args['file'] = file
@@ -475,7 +479,7 @@ def main(args: Optional[Union[argparse.Namespace, dict]] = None):
     elif "component" in args:
         run_component(args["component"], *args["args"])
     elif not args["update_settings"]:
-        run_gui(path, args.get("args", ()))
+        run_gui(args.get("launch_components", None), args.get("args", ()))
 
 
 if __name__ == '__main__':

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

@@ -7,14 +7,13 @@ import tempfile
 import time
 import zipfile
 import zlib
-from typing import Dict, List, Optional, Set, Tuple, Union
 
 import worlds
-from BaseClasses import CollectionState, Item, Location, LocationProgressType, MultiWorld, Region
-from Fill import FillError, balance_multiworld_progression, distribute_items_restrictive, distribute_planned, \
-    flood_items
+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 Options import StartInventoryPool
-from Utils import __version__, output_path, version_tuple, get_settings
+from Utils import __version__, output_path, version_tuple
 from settings import get_settings
 from worlds import AutoWorld
 from worlds.generic.Rules import exclusion_rules, locality_rules
@@ -22,7 +21,7 @@ from worlds.generic.Rules import exclusion_rules, locality_rules
 __all__ = ["main"]
 
 
-def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = None):
+def main(args, seed=None, baked_server_options: dict[str, object] | None = None):
     if not baked_server_options:
         baked_server_options = get_settings().server_options.as_dict()
     assert isinstance(baked_server_options, dict)
@@ -37,9 +36,6 @@ def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = No
     logger = logging.getLogger()
     multiworld.set_seed(seed, args.race, str(args.outputname) if args.outputname else None)
     multiworld.plando_options = args.plando_options
-    multiworld.plando_items = args.plando_items.copy()
-    multiworld.plando_texts = args.plando_texts.copy()
-    multiworld.plando_connections = args.plando_connections.copy()
     multiworld.game = args.game.copy()
     multiworld.player_name = args.name.copy()
     multiworld.sprite = args.sprite.copy()
@@ -135,13 +131,15 @@ def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = No
         multiworld.worlds[1].options.non_local_items.value = set()
         multiworld.worlds[1].options.local_items.value = set()
 
+    multiworld.plando_item_blocks = parse_planned_blocks(multiworld)
+
     AutoWorld.call_all(multiworld, "connect_entrances")
     AutoWorld.call_all(multiworld, "generate_basic")
 
     # remove starting inventory from pool items.
     # Because some worlds don't actually create items during create_items this has to be as late as possible.
     fallback_inventory = StartInventoryPool({})
-    depletion_pool: Dict[int, Dict[str, int]] = {
+    depletion_pool: dict[int, dict[str, int]] = {
         player: getattr(multiworld.worlds[player].options, "start_inventory_from_pool", fallback_inventory).value.copy()
         for player in multiworld.player_ids
     }
@@ -150,7 +148,7 @@ def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = No
     }
 
     if target_per_player:
-        new_itempool: List[Item] = []
+        new_itempool: list[Item] = []
 
         # Make new itempool with start_inventory_from_pool items removed
         for item in multiworld.itempool:
@@ -179,8 +177,9 @@ def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = No
         multiworld._all_state = None
 
     logger.info("Running Item Plando.")
-
-    distribute_planned(multiworld)
+    resolve_early_locations_for_planned(multiworld)
+    distribute_planned_blocks(multiworld, [x for player in multiworld.plando_item_blocks
+                                           for x in multiworld.plando_item_blocks[player]])
 
     logger.info('Running Pre Main Fill.')
 
@@ -233,7 +232,7 @@ def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = No
                     pool.submit(AutoWorld.call_single, multiworld, "generate_output", player, temp_dir))
 
             # collect ER hint info
-            er_hint_data: Dict[int, Dict[int, str]] = {}
+            er_hint_data: dict[int, dict[int, str]] = {}
             AutoWorld.call_all(multiworld, 'extend_hint_information', er_hint_data)
 
             def write_multidata():
@@ -274,7 +273,7 @@ def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = No
                         for player in multiworld.groups[location.item.player]["players"]:
                             precollected_hints[player].add(hint)
 
-                locations_data: Dict[int, Dict[int, Tuple[int, int, int]]] = {player: {} for player in multiworld.player_ids}
+                locations_data: dict[int, dict[int, tuple[int, int, int]]] = {player: {} for player in multiworld.player_ids}
                 for location in multiworld.get_filled_locations():
                     if type(location.address) == int:
                         assert location.item.code is not None, "item code None should be event, " \
@@ -303,12 +302,12 @@ def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = No
                 }
                 data_package["Archipelago"] = worlds.network_data_package["games"]["Archipelago"]
 
-                checks_in_area: Dict[int, Dict[str, Union[int, List[int]]]] = {}
+                checks_in_area: dict[int, dict[str, int | list[int]]] = {}
 
                 # get spheres -> filter address==None -> skip empty
-                spheres: List[Dict[int, Set[int]]] = []
+                spheres: list[dict[int, set[int]]] = []
                 for sphere in multiworld.get_sendable_spheres():
-                    current_sphere: Dict[int, Set[int]] = collections.defaultdict(set)
+                    current_sphere: dict[int, set[int]] = collections.defaultdict(set)
                     for sphere_location in sphere:
                         current_sphere[sphere_location.player].add(sphere_location.address)
 

MinecraftClient.py

@@ -1,344 +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
-
-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["minecraft_options"].get("java", "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 = Utils.get_options()
-    channel = args.channel or options["minecraft_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["minecraft_options"]["forge_directory"]
-    max_heap = options["minecraft_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()

MultiServer.py

@@ -458,8 +458,12 @@ class Context:
         self.generator_version = Version(*decoded_obj["version"])
         clients_ver = decoded_obj["minimum_versions"].get("clients", {})
         self.minimum_client_versions = {}
+        if self.generator_version < Version(0, 6, 2):
+            min_version = Version(0, 1, 6)
+        else:
+            min_version = min_client_version
         for player, version in clients_ver.items():
-            self.minimum_client_versions[player] = max(Version(*version), min_client_version)
+            self.minimum_client_versions[player] = max(Version(*version), min_version)
 
         self.slot_info = decoded_obj["slot_info"]
         self.games = {slot: slot_info.game for slot, slot_info in self.slot_info.items()}
@@ -1826,7 +1830,7 @@ async def process_client_cmd(ctx: Context, client: Client, args: dict):
             ctx.clients[team][slot].append(client)
             client.version = args['version']
             client.tags = args['tags']
-            client.no_locations = "TextOnly" in client.tags or "Tracker" in client.tags
+            client.no_locations = bool(client.tags & _non_game_messages.keys())
             # set NoText for old PopTracker clients that predate the tag to save traffic
             client.no_text = "NoText" in client.tags or ("PopTracker" in client.tags and client.version < (0, 5, 1))
             connected_packet = {
@@ -1900,7 +1904,7 @@ async def process_client_cmd(ctx: Context, client: Client, args: dict):
                 old_tags = client.tags
                 client.tags = args["tags"]
                 if set(old_tags) != set(client.tags):
-                    client.no_locations = 'TextOnly' in client.tags or 'Tracker' in client.tags
+                    client.no_locations = bool(client.tags & _non_game_messages.keys())
                     client.no_text = "NoText" in client.tags or (
                         "PopTracker" in client.tags and client.version < (0, 5, 1)
                     )
@@ -1990,9 +1994,14 @@ async def process_client_cmd(ctx: Context, client: Client, args: dict):
             ctx.save()
             for slot in concerning_slots:
                 ctx.on_changed_hints(client.team, slot)
-        
+
         elif cmd == 'StatusUpdate':
-            update_client_status(ctx, client, args["status"])
+            if client.no_locations and args["status"] == ClientStatus.CLIENT_GOAL:
+                await ctx.send_msgs(client, [{'cmd': 'InvalidPacket', "type": "cmd",
+                                              "text": "Trackers can't register Goal Complete",
+                                              "original_cmd": cmd}])
+            else:
+                update_client_status(ctx, client, args["status"])
 
         elif cmd == 'Say':
             if "text" not in args or type(args["text"]) is not str or not args["text"].isprintable():

OoTClient.py

@@ -12,6 +12,7 @@ from CommonClient import CommonContext, server_loop, gui_enabled, \
 import Utils
 from Utils import async_start
 from worlds import network_data_package
+from worlds.oot import OOTWorld
 from worlds.oot.Rom import Rom, compress_rom_file
 from worlds.oot.N64Patch import apply_patch_file
 from worlds.oot.Utils import data_path
@@ -280,7 +281,7 @@ async def n64_sync_task(ctx: OoTContext):
 
 
 async def run_game(romfile):
-    auto_start = Utils.get_options()["oot_options"].get("rom_start", True)
+    auto_start = OOTWorld.settings.rom_start
     if auto_start is True:
         import webbrowser
         webbrowser.open(romfile)
@@ -295,7 +296,7 @@ async def patch_and_run_game(apz5_file):
     decomp_path = base_name + '-decomp.z64'
     comp_path = base_name + '.z64'
     # Load vanilla ROM, patch file, compress ROM
-    rom_file_name = Utils.get_options()["oot_options"]["rom_file"]
+    rom_file_name = OOTWorld.settings.rom_file
     rom = Rom(rom_file_name)
 
     sub_file = None

Options.py

@@ -24,6 +24,12 @@ if typing.TYPE_CHECKING:
     import pathlib
 
 
+def roll_percentage(percentage: int | float) -> bool:
+    """Roll a percentage chance.
+    percentage is expected to be in range [0, 100]"""
+    return random.random() < (float(percentage) / 100)
+
+
 class OptionError(ValueError):
     pass
 
@@ -1019,7 +1025,7 @@ class PlandoTexts(Option[typing.List[PlandoText]], VerifyKeys):
         if isinstance(data, typing.Iterable):
             for text in data:
                 if isinstance(text, typing.Mapping):
-                    if random.random() < float(text.get("percentage", 100)/100):
+                    if roll_percentage(text.get("percentage", 100)):
                         at = text.get("at", None)
                         if at is not None:
                             if isinstance(at, dict):
@@ -1045,7 +1051,7 @@ class PlandoTexts(Option[typing.List[PlandoText]], VerifyKeys):
                         else:
                             raise OptionError("\"at\" must be a valid string or weighted list of strings!")
                 elif isinstance(text, PlandoText):
-                    if random.random() < float(text.percentage/100):
+                    if roll_percentage(text.percentage):
                         texts.append(text)
                 else:
                     raise Exception(f"Cannot create plando text from non-dictionary type, got {type(text)}")
@@ -1169,7 +1175,7 @@ class PlandoConnections(Option[typing.List[PlandoConnection]], metaclass=Connect
         for connection in data:
             if isinstance(connection, typing.Mapping):
                 percentage = connection.get("percentage", 100)
-                if random.random() < float(percentage / 100):
+                if roll_percentage(percentage):
                     entrance = connection.get("entrance", None)
                     if is_iterable_except_str(entrance):
                         entrance = random.choice(sorted(entrance))
@@ -1187,7 +1193,7 @@ class PlandoConnections(Option[typing.List[PlandoConnection]], metaclass=Connect
                         percentage
                     ))
             elif isinstance(connection, PlandoConnection):
-                if random.random() < float(connection.percentage / 100):
+                if roll_percentage(connection.percentage):
                     value.append(connection)
             else:
                 raise Exception(f"Cannot create connection from non-Dict type, got {type(connection)}.")
@@ -1469,6 +1475,133 @@ class ItemLinks(OptionList):
             link["item_pool"] = list(pool)
 
 
+@dataclass(frozen=True)
+class PlandoItem:
+    items: list[str] | dict[str, typing.Any]
+    locations: list[str]
+    world: int | str | bool | None | typing.Iterable[str] | set[int] = False
+    from_pool: bool = True
+    force: bool | typing.Literal["silent"] = "silent"
+    count: int | bool | dict[str, int] = False
+    percentage: int = 100
+
+
+class PlandoItems(Option[typing.List[PlandoItem]]):
+    """Generic items plando."""
+    default = ()
+    supports_weighting = False
+    display_name = "Plando Items"
+
+    def __init__(self, value: typing.Iterable[PlandoItem]) -> None:
+        self.value = list(deepcopy(value))
+        super().__init__()
+
+    @classmethod
+    def from_any(cls, data: typing.Any) -> Option[typing.List[PlandoItem]]:
+        if not isinstance(data, typing.Iterable):
+            raise OptionError(f"Cannot create plando items from non-Iterable type, got {type(data)}")
+
+        value: typing.List[PlandoItem] = []
+        for item in data:
+            if isinstance(item, typing.Mapping):
+                percentage = item.get("percentage", 100)
+                if not isinstance(percentage, int):
+                    raise OptionError(f"Plando `percentage` has to be int, not {type(percentage)}.")
+                if not (0 <= percentage <= 100):
+                    raise OptionError(f"Plando `percentage` has to be between 0 and 100 (inclusive) not {percentage}.")
+                if roll_percentage(percentage):
+                    count = item.get("count", False)
+                    items = item.get("items", [])
+                    if not items:
+                        items = item.get("item", None)  # explicitly throw an error here if not present
+                        if not items:
+                            raise OptionError("You must specify at least one item to place items with plando.")
+                        count = 1
+                    if isinstance(items, str):
+                        items = [items]
+                    elif not isinstance(items, (dict, list)):
+                        raise OptionError(f"Plando 'items' has to be string, list, or "
+                                          f"dictionary, not {type(items)}")
+                    locations = item.get("locations", [])
+                    if not locations:
+                        locations = item.get("location", [])
+                        if locations:
+                            count = 1
+                        else:
+                            locations = ["Everywhere"]
+                        if isinstance(locations, str):
+                            locations = [locations]
+                        if not isinstance(locations, list):
+                            raise OptionError(f"Plando `location` has to be string or list, not {type(locations)}")
+                    world = item.get("world", False)
+                    from_pool = item.get("from_pool", True)
+                    force = item.get("force", "silent")
+                    if not isinstance(from_pool, bool):
+                        raise OptionError(f"Plando 'from_pool' has to be true or false, not {from_pool!r}.")
+                    if not (isinstance(force, bool) or force == "silent"):
+                        raise OptionError(f"Plando `force` has to be true or false or `silent`, not {force!r}.")
+                    value.append(PlandoItem(items, locations, world, from_pool, force, count, percentage))
+            elif isinstance(item, PlandoItem):
+                if roll_percentage(item.percentage):
+                    value.append(item)
+            else:
+                raise OptionError(f"Cannot create plando item from non-Dict type, got {type(item)}.")
+        return cls(value)
+
+    def verify(self, world: typing.Type[World], player_name: str, plando_options: "PlandoOptions") -> None:
+        if not self.value:
+            return
+        from BaseClasses import PlandoOptions
+        if not (PlandoOptions.items & plando_options):
+            # plando is disabled but plando options were given so overwrite the options
+            self.value = []
+            logging.warning(f"The plando items module is turned off, "
+                            f"so items for {player_name} will be ignored.")
+        else:
+            # filter down item groups
+            for plando in self.value:
+                # confirm a valid count
+                if isinstance(plando.count, dict):
+                    if "min" in plando.count and "max" in plando.count:
+                        if plando.count["min"] > plando.count["max"]:
+                            raise OptionError("Plando cannot have count `min` greater than `max`.")
+                items_copy = plando.items.copy()
+                if isinstance(plando.items, dict):
+                    for item in items_copy:
+                        if item in world.item_name_groups:
+                            value = plando.items.pop(item)
+                            group = world.item_name_groups[item]
+                            filtered_items = sorted(group.difference(list(plando.items.keys())))
+                            if not filtered_items:
+                                raise OptionError(f"Plando `items` contains the group \"{item}\" "
+                                                  f"and every item in it. This is not allowed.")
+                            if value is True:
+                                for key in filtered_items:
+                                    plando.items[key] = True
+                            else:
+                                for key in random.choices(filtered_items, k=value):
+                                    plando.items[key] = plando.items.get(key, 0) + 1
+                else:
+                    assert isinstance(plando.items, list)  # pycharm can't figure out the hinting without the hint
+                    for item in items_copy:
+                        if item in world.item_name_groups:
+                            plando.items.remove(item)
+                            plando.items.extend(sorted(world.item_name_groups[item]))
+
+    @classmethod
+    def get_option_name(cls, value: list[PlandoItem]) -> str:
+        return ", ".join(["(%s: %s)" % (item.items, item.locations) for item in value])  #TODO: see what a better way to display would be
+
+    def __getitem__(self, index: typing.SupportsIndex) -> PlandoItem:
+        return self.value.__getitem__(index)
+
+    def __iter__(self) -> typing.Iterator[PlandoItem]:
+        yield from self.value
+
+    def __len__(self) -> int:
+        return len(self.value)
+
+        
 class Removed(FreeText):
     """This Option has been Removed."""
     rich_text_doc = True
@@ -1491,6 +1624,7 @@ class PerGameCommonOptions(CommonOptions):
     exclude_locations: ExcludeLocations
     priority_locations: PriorityLocations
     item_links: ItemLinks
+    plando_items: PlandoItems
 
 
 @dataclass
@@ -1544,6 +1678,7 @@ def get_option_groups(world: typing.Type[World], visibility_level: Visibility =
 
 def generate_yaml_templates(target_folder: typing.Union[str, "pathlib.Path"], generate_hidden: bool = True) -> None:
     import os
+    from inspect import cleandoc
 
     import yaml
     from jinja2 import Template
@@ -1582,19 +1717,21 @@ def generate_yaml_templates(target_folder: typing.Union[str, "pathlib.Path"], ge
         # yaml dump may add end of document marker and newlines.
         return yaml.dump(scalar).replace("...\n", "").strip()
 
+    with open(local_path("data", "options.yaml")) as f:
+        file_data = f.read()
+    template = Template(file_data)
+
     for game_name, world in AutoWorldRegister.world_types.items():
         if not world.hidden or generate_hidden:
             option_groups = get_option_groups(world)
-            with open(local_path("data", "options.yaml")) as f:
-                file_data = f.read()
-            res = Template(file_data).render(
+
+            res = template.render(
                 option_groups=option_groups,
                 __version__=__version__, game=game_name, yaml_dump=yaml_dump_scalar,
                 dictify_range=dictify_range,
+                cleandoc=cleandoc,
             )
 
-            del file_data
-
             with open(os.path.join(target_folder, get_file_safe_name(game_name) + ".yaml"), "w", encoding="utf-8-sig") as f:
                 f.write(res)
 

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
@@ -80,6 +79,9 @@ Currently, the following games are supported:
 * Inscryption
 * Civilization VI
 * The Legend of Zelda: The Wind Waker
+* Jak and Daxter: The Precursor Legacy
+* Super Mario Land 2: 6 Golden Coins
+* shapez
 
 For setup and instructions check out our [tutorials page](https://archipelago.gg/tutorial/).
 Downloads can be found at [Releases](https://github.com/ArchipelagoMW/Archipelago/releases), including compiled

Utils.py

@@ -139,8 +139,11 @@ def local_path(*path: str) -> str:
             local_path.cached_path = os.path.dirname(os.path.abspath(sys.argv[0]))
     else:
         import __main__
-        if hasattr(__main__, "__file__") and os.path.isfile(__main__.__file__):
+        if globals().get("__file__") and os.path.isfile(__file__):
             # we are running in a normal Python environment
+            local_path.cached_path = os.path.dirname(os.path.abspath(__file__))
+        elif hasattr(__main__, "__file__") and os.path.isfile(__main__.__file__):
+            # we are running in a normal Python environment, but AP was imported weirdly
             local_path.cached_path = os.path.dirname(os.path.abspath(__main__.__file__))
         else:
             # pray
@@ -163,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
@@ -174,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()
@@ -223,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
@@ -537,6 +549,8 @@ def init_logging(name: str, loglevel: typing.Union[str, int] = logging.INFO,
         if add_timestamp:
             stream_handler.setFormatter(formatter)
         root_logger.addHandler(stream_handler)
+        if hasattr(sys.stdout, "reconfigure"):
+            sys.stdout.reconfigure(encoding="utf-8", errors="replace")
 
     # Relay unhandled exceptions to logger.
     if not getattr(sys.excepthook, "_wrapped", False):  # skip if already modified
@@ -703,25 +717,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:
@@ -755,21 +774,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:
@@ -796,9 +812,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()
@@ -809,10 +822,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/__init__.py

@@ -80,10 +80,8 @@ def register():
     """Import submodules, triggering their registering on flask routing.
     Note: initializes worlds subsystem."""
     # has automatic patch integration
-    import worlds.AutoWorld
     import worlds.Files
-    app.jinja_env.filters['supports_apdeltapatch'] = lambda game_name: \
-        game_name in worlds.Files.AutoPatchRegister.patch_types
+    app.jinja_env.filters['is_applayercontainer'] = worlds.Files.is_ap_player_container
 
     from WebHostLib.customserver import run_server_process
     # to trigger app routing picking up on it

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,30 +26,15 @@
                     <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 == "Factorio" %}
-                            <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
-                                Download Factorio Mod...</a>
-                            {% elif patch.game == "Kingdom Hearts 2" %}
-                            <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
-                                Download Kingdom Hearts 2 Mod...</a>
-                            {% elif patch.game == "Ocarina of Time" %}
-                            <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
-                                Download APZ5 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 %}
                             <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
                                 Download APSM64EX File...</a>
-                            {% elif patch.game | supports_apdeltapatch %}
+                            {% elif patch.game | is_applayercontainer(patch.data, patch.player_id) %}
                             <a href="{{ url_for("download_patch", patch_id=patch.id, room_id=room.id) }}" download>
                                 Download Patch File...</a>
-                            {% elif patch.game == "Final Fantasy Mystic Quest" %}
-                            <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
-                                Download APMQ File...</a>
                             {% else %}
                                 No file to download for this game.
                             {% endif %}

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"
@@ -222,3 +233,8 @@
         spacing: 10
         size_hint_y: None
         height: self.minimum_height
+<MessageBoxLabel>:
+    valign: "middle"
+    halign: "center"
+    text_size: self.width, None
+    height: self.texture_size[1]

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_ff1.lua

@@ -1,462 +0,0 @@
-local socket = require("socket")
-local json = require('json')
-local math = require('math')
-require("common")
-
-local STATE_OK = "Ok"
-local STATE_TENTATIVELY_CONNECTED = "Tentatively Connected"
-local STATE_INITIAL_CONNECTION_MADE = "Initial Connection Made"
-local STATE_UNINITIALIZED = "Uninitialized"
-
-local ITEM_INDEX = 0x03
-local WEAPON_INDEX = 0x07
-local ARMOR_INDEX = 0x0B
-
-local goldLookup = {
-    [0x16C] = 10,
-    [0x16D] = 20,
-    [0x16E] = 25,
-    [0x16F] = 30,
-    [0x170] = 55,
-    [0x171] = 70,
-    [0x172] = 85,
-    [0x173] = 110,
-    [0x174] = 135,
-    [0x175] = 155,
-    [0x176] = 160,
-    [0x177] = 180,
-    [0x178] = 240,
-    [0x179] = 255,
-    [0x17A] = 260,
-    [0x17B] = 295,
-    [0x17C] = 300,
-    [0x17D] = 315,
-    [0x17E] = 330,
-    [0x17F] = 350,
-    [0x180] = 385,
-    [0x181] = 400,
-    [0x182] = 450,
-    [0x183] = 500,
-    [0x184] = 530,
-    [0x185] = 575,
-    [0x186] = 620,
-    [0x187] = 680,
-    [0x188] = 750,
-    [0x189] = 795,
-    [0x18A] = 880,
-    [0x18B] = 1020,
-    [0x18C] = 1250,
-    [0x18D] = 1455,
-    [0x18E] = 1520,
-    [0x18F] = 1760,
-    [0x190] = 1975,
-    [0x191] = 2000,
-    [0x192] = 2750,
-    [0x193] = 3400,
-    [0x194] = 4150,
-    [0x195] = 5000,
-    [0x196] = 5450,
-    [0x197] = 6400,
-    [0x198] = 6720,
-    [0x199] = 7340,
-    [0x19A] = 7690,
-    [0x19B] = 7900,
-    [0x19C] = 8135,
-    [0x19D] = 9000,
-    [0x19E] = 9300,
-    [0x19F] = 9500,
-    [0x1A0] = 9900,
-    [0x1A1] = 10000,
-    [0x1A2] = 12350,
-    [0x1A3] = 13000,
-    [0x1A4] = 13450,
-    [0x1A5] = 14050,
-    [0x1A6] = 14720,
-    [0x1A7] = 15000,
-    [0x1A8] = 17490,
-    [0x1A9] = 18010,
-    [0x1AA] = 19990,
-    [0x1AB] = 20000,
-    [0x1AC] = 20010,
-    [0x1AD] = 26000,
-    [0x1AE] = 45000,
-    [0x1AF] = 65000
-}
-
-local extensionConsumableLookup = {
-    [432] = 0x3C,
-    [436] = 0x3C,
-    [440] = 0x3C,
-    [433] = 0x3D,
-    [437] = 0x3D,
-    [441] = 0x3D,
-    [434] = 0x3E,
-    [438] = 0x3E,
-    [442] = 0x3E,
-    [435] = 0x3F,
-    [439] = 0x3F,
-    [443] = 0x3F
-}
-
-local noOverworldItemsLookup = {
-    [499] = 0x2B,
-    [500] = 0x12,
-}
-
-local consumableStacks = nil
-local prevstate = ""
-local curstate =  STATE_UNINITIALIZED
-local ff1Socket = nil
-local frame = 0
-
-local isNesHawk = false
-
-
---Sets correct memory access functions based on whether NesHawk or QuickNES is loaded
-local function defineMemoryFunctions()
-	local memDomain = {}
-	local domains = memory.getmemorydomainlist()
-	if domains[1] == "System Bus" then
-		--NesHawk
-		isNesHawk = true
-		memDomain["systembus"] = function() memory.usememorydomain("System Bus") end
-		memDomain["saveram"]   = function() memory.usememorydomain("Battery RAM") end
-		memDomain["rom"]       = function() memory.usememorydomain("PRG ROM") end
-	elseif domains[1] == "WRAM" then
-		--QuickNES
-		memDomain["systembus"] = function() memory.usememorydomain("System Bus") end
-		memDomain["saveram"]   = function() memory.usememorydomain("WRAM") end
-		memDomain["rom"]       = function() memory.usememorydomain("PRG ROM") end
-	end
-	return memDomain
-end
-
-local memDomain = defineMemoryFunctions()
-
-local function StateOKForMainLoop()
-    memDomain.saveram()
-    local A = u8(0x102) -- Party Made
-    local B = u8(0x0FC)
-    local C = u8(0x0A3)
-    return A ~= 0x00 and not (A== 0xF2 and B == 0xF2 and C == 0xF2)
-end
-
-function generateLocationChecked()
-    memDomain.saveram()
-    data = uRange(0x01FF, 0x101)
-    data[0] = nil
-    return data
-end
-
-function setConsumableStacks()
-    memDomain.rom()
-    consumableStacks = {}
-    -- In order shards, tent, cabin, house, heal, pure, soft, ext1, ext2, ext3, ex4
-    consumableStacks[0x35] = 1
-    consumableStacks[0x36] = u8(0x47400) + 1
-    consumableStacks[0x37] = u8(0x47401) + 1
-    consumableStacks[0x38] = u8(0x47402) + 1
-    consumableStacks[0x39] = u8(0x47403) + 1
-    consumableStacks[0x3A] = u8(0x47404) + 1
-    consumableStacks[0x3B] = u8(0x47405) + 1
-    consumableStacks[0x3C] = u8(0x47406) + 1
-    consumableStacks[0x3D] = u8(0x47407) + 1
-    consumableStacks[0x3E] = u8(0x47408) + 1
-    consumableStacks[0x3F] = u8(0x47409) + 1
-end
-
-function getEmptyWeaponSlots()
-    memDomain.saveram()
-    ret = {}
-    count = 1
-    slot1 = uRange(0x118, 0x4)
-    slot2 = uRange(0x158, 0x4)
-    slot3 = uRange(0x198, 0x4)
-    slot4 = uRange(0x1D8, 0x4)
-    for i,v in pairs(slot1) do
-        if v == 0 then
-            ret[count] = 0x118 + i
-            count = count + 1
-        end
-    end
-    for i,v in pairs(slot2) do
-        if v == 0 then
-            ret[count] = 0x158 + i
-            count = count + 1
-        end
-    end
-    for i,v in pairs(slot3) do
-        if v == 0 then
-            ret[count] = 0x198 + i
-            count = count + 1
-        end
-    end
-    for i,v in pairs(slot4) do
-        if v == 0 then
-            ret[count] = 0x1D8 + i
-            count = count + 1
-        end
-    end
-    return ret
-end
-
-function getEmptyArmorSlots()
-    memDomain.saveram()
-    ret = {}
-    count = 1
-    slot1 = uRange(0x11C, 0x4)
-    slot2 = uRange(0x15C, 0x4)
-    slot3 = uRange(0x19C, 0x4)
-    slot4 = uRange(0x1DC, 0x4)
-    for i,v in pairs(slot1) do
-        if v == 0 then
-            ret[count] = 0x11C + i
-            count = count + 1
-        end
-    end
-    for i,v in pairs(slot2) do
-        if v == 0 then
-            ret[count] = 0x15C + i
-            count = count + 1
-        end
-    end
-    for i,v in pairs(slot3) do
-        if v == 0 then
-            ret[count] = 0x19C + i
-            count = count + 1
-        end
-    end
-    for i,v in pairs(slot4) do
-        if v == 0 then
-            ret[count] = 0x1DC + i
-            count = count + 1
-        end
-    end
-    return ret
-end
-local function slice (tbl, s, e)
-    local pos, new = 1, {}
-    for i = s + 1, e do
-        new[pos] = tbl[i]
-        pos = pos + 1
-    end
-    return new
-end
-function processBlock(block)
-    local msgBlock = block['messages']
-    if msgBlock ~= nil then
-        for i, v in pairs(msgBlock) do
-            if itemMessages[i] == nil then
-                local msg = {TTL=450, message=v, color=0xFFFF0000}
-                itemMessages[i] = msg
-            end
-        end
-    end
-    local itemsBlock = block["items"]
-    memDomain.saveram()
-    isInGame = u8(0x102)
-    if itemsBlock ~= nil and isInGame ~= 0x00 then
-        if consumableStacks == nil then
-            setConsumableStacks()
-        end
-        memDomain.saveram()
---         print('ITEMBLOCK: ')
---         print(itemsBlock)
-        itemIndex = u8(ITEM_INDEX)
---         print('ITEMINDEX: '..itemIndex)
-        for i, v in pairs(slice(itemsBlock, itemIndex, #itemsBlock)) do
-            -- Minus the offset and add to the correct domain
-            local memoryLocation = v
-            if v >= 0x100 and v <= 0x114 then
-                -- This is a key item
-                memoryLocation = memoryLocation - 0x0E0
-                wU8(memoryLocation, 0x01)
-            elseif v >= 0x1E0 and v <= 0x1F2 then
-                -- This is a movement item
-                -- Minus Offset (0x100) - movement offset (0xE0)
-                memoryLocation = memoryLocation - 0x1E0
-                -- Canal is a flipped bit
-                if memoryLocation == 0x0C then
-                    wU8(memoryLocation, 0x00)
-                else
-                    wU8(memoryLocation, 0x01)
-                end
-            elseif v >= 0x1F3 and v <= 0x1F4 then
-                -- NoOverworld special items
-                memoryLocation = noOverworldItemsLookup[v]
-                wU8(memoryLocation, 0x01)
-            elseif v >= 0x16C and v <= 0x1AF then
-                -- This is a gold item
-                amountToAdd = goldLookup[v]
-                biggest = u8(0x01E)
-                medium = u8(0x01D)
-                smallest = u8(0x01C)
-                currentValue = 0x10000 * biggest + 0x100 * medium + smallest
-                newValue = currentValue + amountToAdd
-                newBiggest = math.floor(newValue / 0x10000)
-                newMedium = math.floor(math.fmod(newValue, 0x10000) / 0x100)
-                newSmallest = math.floor(math.fmod(newValue, 0x100))
-                wU8(0x01E, newBiggest)
-                wU8(0x01D, newMedium)
-                wU8(0x01C, newSmallest)
-            elseif v >= 0x115 and v <= 0x11B then
-                -- This is a regular consumable OR a shard
-                -- Minus Offset (0x100) + item offset (0x20)
-                memoryLocation = memoryLocation - 0x0E0
-                currentValue = u8(memoryLocation)
-                amountToAdd = consumableStacks[memoryLocation]
-                if currentValue < 99 then
-                    wU8(memoryLocation, currentValue + amountToAdd)
-                end
-            elseif v >= 0x1B0  and v <= 0x1BB then
-                -- This is an extension consumable
-                memoryLocation = extensionConsumableLookup[v]
-                currentValue = u8(memoryLocation)
-                amountToAdd = consumableStacks[memoryLocation]
-                if currentValue < 99 then
-                    value = currentValue + amountToAdd
-                    if value > 99 then
-                        value = 99
-                    end
-                    wU8(memoryLocation, value)
-                end
-            end
-        end
-        if #itemsBlock > itemIndex then
-            wU8(ITEM_INDEX, #itemsBlock)
-        end
-
-        memDomain.saveram()
-        weaponIndex = u8(WEAPON_INDEX)
-        emptyWeaponSlots = getEmptyWeaponSlots()
-        lastUsedWeaponIndex = weaponIndex
---         print('WEAPON_INDEX: '.. weaponIndex)
-        memDomain.saveram()
-        for i, v in pairs(slice(itemsBlock, weaponIndex, #itemsBlock)) do
-            if v >= 0x11C and v <= 0x143 then
-                -- Minus the offset and add to the correct domain
-                local itemValue = v - 0x11B
-                if #emptyWeaponSlots > 0 then
-                    slot = table.remove(emptyWeaponSlots, 1)
-                    wU8(slot, itemValue)
-                    lastUsedWeaponIndex = weaponIndex + i
-                else
-                    break
-                end
-            end
-        end
-        if lastUsedWeaponIndex ~= weaponIndex then
-            wU8(WEAPON_INDEX, lastUsedWeaponIndex)
-        end
-        memDomain.saveram()
-        armorIndex = u8(ARMOR_INDEX)
-        emptyArmorSlots = getEmptyArmorSlots()
-        lastUsedArmorIndex = armorIndex
---         print('ARMOR_INDEX: '.. armorIndex)
-        memDomain.saveram()
-        for i, v in pairs(slice(itemsBlock, armorIndex, #itemsBlock)) do
-            if v >= 0x144 and v <= 0x16B then
-                -- Minus the offset and add to the correct domain
-                local itemValue = v - 0x143
-                if #emptyArmorSlots > 0 then
-                    slot = table.remove(emptyArmorSlots, 1)
-                    wU8(slot, itemValue)
-                    lastUsedArmorIndex = armorIndex + i
-                else
-                    break
-                end
-            end
-        end
-        if lastUsedArmorIndex ~= armorIndex then
-            wU8(ARMOR_INDEX, lastUsedArmorIndex)
-        end
-    end
-end
-
-function receive()
-    l, e = ff1Socket:receive()
-    if e == 'closed' then
-        if curstate == STATE_OK then
-            print("Connection closed")
-        end
-        curstate = STATE_UNINITIALIZED
-        return
-    elseif e == 'timeout' then
-        print("timeout")
-        return
-    elseif e ~= nil then
-        print(e)
-        curstate = STATE_UNINITIALIZED
-        return
-    end
-    processBlock(json.decode(l))
-
-    -- Determine Message to send back
-    memDomain.rom()
-    local playerName = uRange(0x7BCBF, 0x41)
-    playerName[0] = nil
-    local retTable = {}
-    retTable["playerName"] = playerName
-    if StateOKForMainLoop() then
-        retTable["locations"] = generateLocationChecked()
-    end
-    msg = json.encode(retTable).."\n"
-    local ret, error = ff1Socket:send(msg)
-    if ret == nil then
-        print(error)
-    elseif curstate == STATE_INITIAL_CONNECTION_MADE then
-        curstate = STATE_TENTATIVELY_CONNECTED
-    elseif curstate == STATE_TENTATIVELY_CONNECTED then
-        print("Connected!")
-        itemMessages["(0,0)"] = {TTL=240, message="Connected", color="green"}
-        curstate = STATE_OK
-    end
-end
-
-function main()
-    if not checkBizHawkVersion() then
-        return
-    end
-    server, error = socket.bind('localhost', 52980)
-
-    while true do
-        gui.drawEllipse(248, 9, 6, 6, "Black", "Yellow")
-        frame = frame + 1
-        drawMessages()
-        if not (curstate == prevstate) then
-            -- console.log("Current state: "..curstate)
-            prevstate = curstate
-        end
-        if (curstate == STATE_OK) or (curstate == STATE_INITIAL_CONNECTION_MADE) or (curstate == STATE_TENTATIVELY_CONNECTED) then
-            if (frame % 60 == 0) then
-                gui.drawEllipse(248, 9, 6, 6, "Black", "Blue")
-                receive()
-            else
-                gui.drawEllipse(248, 9, 6, 6, "Black", "Green")
-            end
-        elseif (curstate == STATE_UNINITIALIZED) then
-            gui.drawEllipse(248, 9, 6, 6, "Black", "White")
-            if  (frame % 60 == 0) then
-                gui.drawEllipse(248, 9, 6, 6, "Black", "Yellow")
-
-                drawText(5, 8, "Waiting for client", 0xFFFF0000)
-                drawText(5, 32, "Please start FF1Client.exe", 0xFFFF0000)
-
-                -- Advance so the messages are drawn
-                emu.frameadvance()
-                server:settimeout(2)
-                print("Attempting to connect")
-                local client, timeout = server:accept()
-                if timeout == nil then
-                    -- print('Initial Connection Made')
-                    curstate = STATE_INITIAL_CONNECTION_MADE
-                    ff1Socket = client
-                    ff1Socket:settimeout(0)
-                end
-            end
-        end
-        emu.frameadvance()
-    end
-end
-
-main()

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')

data/options.yaml

@@ -51,10 +51,9 @@ requires:
   {%- for option_key, option in group_options.items() %}
   {{ option_key }}:
     {%- if option.__doc__ %}
-    # {{ option.__doc__
+    # {{ cleandoc(option.__doc__)
         | trim
-        | replace('\n\n', '\n    \n')
-        | replace('\n    ', '\n# ')
+        | replace('\n', '\n# ')
         | indent(4, first=False)
       }}
     {%- endif -%}

docs/CODEOWNERS

@@ -87,6 +87,9 @@
 # Inscryption
 /worlds/inscryption/ @DrBibop @Glowbuzz
 
+# Jak and Daxter: The Precursor Legacy
+/worlds/jakanddaxter/ @massimilianodelliubaldini
+
 # Kirby's Dream Land 3
 /worlds/kdl3/ @Silvris
 
@@ -118,9 +121,6 @@
 # The Messenger
 /worlds/messenger/ @alwaysintreble
 
-# Minecraft
-/worlds/minecraft/ @KonoTyran @espeon65536
-
 # Mega Man 2
 /worlds/mm2/ @Silvris
 
@@ -157,6 +157,9 @@
 # Saving Princess
 /worlds/saving_princess/ @LeonarthCG
 
+# shapez
+/worlds/shapez/ @BlastSlimey
+
 # Shivers
 /worlds/shivers/ @GodlFire @korydondzila
 
@@ -175,6 +178,9 @@
 # Super Mario 64
 /worlds/sm64ex/ @N00byKing
 
+# Super Mario Land 2: 6 Golden Coins
+/worlds/marioland2/ @Alchav
+
 # Super Mario World
 /worlds/smw/ @PoryGone
 
@@ -232,7 +238,7 @@
 ## Active Unmaintained Worlds
 
 # The following worlds in this repo are currently unmaintained, but currently still work in core. If any update breaks
-# compatibility, these worlds may be moved to `worlds_disabled`. If you are interested in stepping up as maintainer for
+# compatibility, these worlds may be deleted. If you are interested in stepping up as maintainer for
 # any of these worlds, please review `/docs/world maintainer.md` documentation.
 
 # Final Fantasy (1)
@@ -241,15 +247,6 @@
 # Ocarina of Time
 # /worlds/oot/
 
-## Disabled Unmaintained Worlds
-
-# The following worlds in this repo are currently unmaintained and disabled as they do not work in core. If you are
-# interested in stepping up as maintainer for any of these worlds, please review `/docs/world maintainer.md`
-# documentation.
-
-# Ori and the Blind Forest
-# /worlds_disabled/oribf/
-
 ###################
 ## Documentation ##
 ###################

docs/apworld_dev_faq.md

@@ -122,3 +122,21 @@ Concrete examples of soft logic include:
 - Buying expensive shop items might logically require access to a place where you can quickly farm money, or logically require access to enough parts of the game that checking other locations should naturally generate enough money without grinding.
 
 Remember that all items referenced by logic (however hard or soft) must be `progression`. Since you typically don't want to turn a ton of `filler` items into `progression` just for this, it's common to e.g. write money logic using only the rare "$100" item, so the dozens of "$1" and "$10" items in your world can remain `filler`.
+
+---
+
+### What if my game has "missable" or "one-time-only" locations or region connections?
+
+Archipelago logic assumes that once a region or location becomes reachable, it stays reachable forever, no matter what 
+the player does in-game. Slightly more formally: Receiving an AP item must never cause a region connection or location 
+to "go out of logic" (become unreachable when it was previously reachable), and receiving AP items is the only kind of 
+state change that AP logic acknowledges. No other actions or events can change reachability.
+
+So when the game itself does not follow this assumption, the options are:
+- Modify the game to make that location/connection repeatable
+- If there are both missable and repeatable ways to check the location/traverse the connection, then write logic for 
+  only the repeatable ways
+- Don't generate the missable location/connection at all
+  - For connections, any logical regions will still need to be reachable through other, *repeatable* connections
+  - For locations, this may require game changes to remove the vanilla item if it affects logic
+- Decide that resetting the save file is part of the game's logic, and warn players about that

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
 

docs/network protocol.md

@@ -231,11 +231,11 @@ Sent to clients after a client requested this message be sent to them, more info
 Sent to clients if the server caught a problem with a packet. This only occurs for errors that are explicitly checked for.
 
 #### Arguments
-| Name | Type | Notes |
-| ---- | ---- | ----- |
-| type | str | The [PacketProblemType](#PacketProblemType) that was detected in the packet. |
-| original_cmd | Optional[str] | The `cmd` argument of the faulty packet, will be `None` if the `cmd` failed to be parsed. |
-| text | str | A descriptive message of the problem at hand. |
+| Name | Type        | Notes |
+| ---- |-------------| ----- |
+| type | str         | The [PacketProblemType](#PacketProblemType) that was detected in the packet. |
+| original_cmd | str \| None | The `cmd` argument of the faulty packet, will be `None` if the `cmd` failed to be parsed. |
+| text | str         | A descriptive message of the problem at hand. |
 
 ##### PacketProblemType
 `PacketProblemType` indicates the type of problem that was detected in the faulty packet, the known problem types are below but others may be added in the future.
@@ -551,14 +551,14 @@ In JSON this may look like:
 Message nodes sent along with [PrintJSON](#PrintJSON) packet to be reconstructed into a legible message. The nodes are intended to be read in the order they are listed in the packet.
 
 ```python
-from typing import TypedDict, Optional
+from typing import TypedDict
 class JSONMessagePart(TypedDict):
-    type: Optional[str]
-    text: Optional[str]
-    color: Optional[str] # only available if type is a color
-    flags: Optional[int] # only available if type is an item_id or item_name
-    player: Optional[int] # only available if type is either item or location
-    hint_status: Optional[HintStatus] # only available if type is hint_status
+    type: str | None
+    text: str | None
+    color: str | None # only available if type is a color
+    flags: int | None # only available if type is an item_id or item_name
+    player: int | None # only available if type is either item or location
+    hint_status: HintStatus | None # only available if type is hint_status
 ```
 
 `type` is used to denote the intent of the message part. This can be used to indicate special information which may be rendered differently depending on client. How these types are displayed in Archipelago's ALttP client is not the end-all be-all. Other clients may choose to interpret and display these messages differently.

docs/options api.md

@@ -333,7 +333,7 @@ within the world.
 ### TextChoice
 Like choice allows you to predetermine options and has all of the same comparison methods and handling. Also accepts any
 user defined string as a valid option, so will either need to be validated by adding a validation step to the option
-class or within world, if necessary. Value for this class is `Union[str, int]` so if you need the value at a specified
+class or within world, if necessary. Value for this class is `str | int` so if you need the value at a specified
 point, `self.options.my_option.current_key` will always return a string.
 
 ### PlandoBosses

docs/settings api.md

@@ -102,17 +102,16 @@ In worlds, this should only be used for the top level to avoid issues when upgra
 
 ### Bool
 
-Since `bool` can not be subclassed, use the `settings.Bool` helper in a `typing.Union` to get a comment in host.yaml.
+Since `bool` can not be subclassed, use the `settings.Bool` helper in a union to get a comment in host.yaml.
 
 ```python
 import settings
-import typing
 
 class MySettings(settings.Group):
     class MyBool(settings.Bool):
         """Doc string"""
 
-    my_value: typing.Union[MyBool, bool] = True
+    my_value: MyBool | bool = True
 ```
 
 ### UserFilePath
@@ -134,15 +133,15 @@ Checks the file against [md5s](#md5s) by default.
 
 Resolves to an executable (varying file extension based on platform)
 
-#### description: Optional\[str\]
+#### description: str | None
 
 Human-readable name to use in file browser
 
-#### copy_to: Optional\[str\]
+#### copy_to: str | None
 
 Instead of storing the path, copy the file.
 
-#### md5s: List[Union[str, bytes]]
+#### md5s: list[str | bytes]
 
 Provide md5 hashes as hex digests or raw bytes for automatic validation.
 

docs/tests.md

@@ -11,8 +11,13 @@ found in the [general test directory](/test/general).
 ## Defining World Tests
 
 In order to run tests from your world, you will need to create a `test` package within your world package. This can be
-done by creating a `test` directory with a file named `__init__.py` inside it inside your world. By convention, a base
-for your world tests can be created in this file that you can then import into other modules.
+done by creating a `test` directory inside your world with an (empty) `__init__.py` inside it. By convention, a base
+for your world tests can be created in `bases.py` or any file that does not start with `test`, that you can then import
+into other modules. All tests should be defined in files named `test_*.py` (all lower case) and be member functions
+(named `test_*`) of classes (named `Test*` or `*Test`) that inherit from `unittest.TestCase` or a test base.
+
+Defining anything inside `test/__init__.py` is deprecated. Defining TestBase there was previously the norm; however,
+it complicates test discovery because some worlds also put actual tests into `__init__.py`.
 
 ### WorldTestBase
 
@@ -21,7 +26,7 @@ interactions in the world interact as expected, you will want to use the [WorldT
 comes with the basics for test setup as well as a few preloaded tests that most worlds might want to check on varying
 options combinations.
 
-Example `/worlds/<my_game>/test/__init__.py`:
+Example `/worlds/<my_game>/test/bases.py`:
 
 ```python
 from test.bases import WorldTestBase
@@ -49,7 +54,7 @@ with `test_`.
 Example `/worlds/<my_game>/test/test_chest_access.py`:
 
 ```python
-from . import MyGameTestBase
+from .bases import MyGameTestBase
 
 
 class TestChestAccess(MyGameTestBase):
@@ -119,8 +124,12 @@ variable to keep all the benefits of the test framework while not running the ma
 #### Using Pycharm
 
 In PyCharm, running all tests can be done by right-clicking the root test directory and selecting Run 'Archipelago Unittests'. 
-Unless you configured PyCharm to use pytest as a test runner, you may get import failures. To solve this, edit the run configuration, 
-and set the working directory to the Archipelago directory which contains all the project files. 
+If you have never previously run ModuleUpdate.py, then you will need to do this once before the tests will run. 
+You can run ModuleUpdate.py by right-clicking ModuleUpdate.py and selecting `Run 'ModuleUpdate'`. 
+After running ModuleUpdate.py you may still get a `ModuleNotFoundError: No module named 'flask'` for the webhost tests. 
+If this happens, run WebHost.py by right-clicking it and selecting `Run 'WebHost'`. Make sure to press enter when prompted. 
+Unless you configured PyCharm to use pytest as a test runner, you may get import failures. To solve this, 
+edit the run configuration, and set the working directory to the Archipelago directory which contains all the project files. 
 
 If you only want to run your world's defined tests, repeat the steps for the test directory within your world.
 Your working directory should be the directory of your world in the worlds directory and the script should be the 

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
@@ -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)`

docs/world maintainer.md

@@ -65,5 +65,5 @@ date, voting members and final result in the commit message.
 
 ## Handling of Unmaintained Worlds
 
-As long as worlds are known to work for the most part, they can stay included. Once a world becomes broken it shall be
-moved from `worlds/` to `worlds_disabled/`.
+As long as worlds are known to work for the most part, they can stay included. Once the world becomes broken, it shall 
+be deleted.

inno_setup.iss

@@ -86,6 +86,7 @@ Type: dirifempty; Name: "{app}"
 [InstallDelete]
 Type: files; Name: "{app}\*.exe"
 Type: files; Name: "{app}\data\lua\connector_pkmn_rb.lua"
+Type: files; Name: "{app}\data\lua\connector_ff1.lua"
 Type: filesandordirs; Name: "{app}\SNI\lua*"
 Type: filesandordirs; Name: "{app}\EnemizerCLI*"
 #include "installdelete.iss"
@@ -137,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

@@ -6,7 +6,6 @@ import re
 import io
 import pkgutil
 from collections import deque
-
 assert "kivy" not in sys.modules, "kvui should be imported before kivy for frozen compatibility"
 
 if sys.platform == "win32":
@@ -57,10 +56,14 @@ from kivy.animation import Animation
 from kivy.uix.popup import Popup
 from kivy.uix.image import AsyncImage
 from kivymd.app import MDApp
+from kivymd.uix.dialog import MDDialog, MDDialogHeadlineText, MDDialogSupportingText, MDDialogButtonContainer
 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
@@ -710,72 +713,94 @@ class CommandPromptTextInput(ResizableTextField):
         self.text = self._command_history[self._command_history_index]
 
 
+class MessageBoxLabel(MDLabel):
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self._label.refresh()
+
+
 class MessageBox(Popup):
-    class MessageBoxLabel(MDLabel):
-        def __init__(self, **kwargs):
-            super().__init__(**kwargs)
-            self._label.refresh()
 
     def __init__(self, title, text, error=False, **kwargs):
-        label = MessageBox.MessageBoxLabel(text=text)
+        label = MessageBoxLabel(text=text)
         separator_color = [217 / 255, 129 / 255, 122 / 255, 1.] if error else [47 / 255., 167 / 255., 212 / 255, 1.]
         super().__init__(title=title, content=label, size_hint=(0.5, None), width=max(100, int(label.width) + 40),
                          separator_color=separator_color, **kwargs)
         self.height += max(0, label.height - 18)
 
 
-class ClientTabs(MDTabsSecondary):
-    carousel: MDTabsCarousel
-    lock_swiping = True
+class MDNavigationItemBase(MDNavigationItem):
+    text = StringProperty(None)
 
-    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 _check_panel_height(self, *args):
-        self.ids.tab_scroll.height = dp(38)
+class ButtonsPrompt(MDDialog):
+    def __init__(self, title: str, text: str, response: typing.Callable[[str], None],
+                 *prompts: str, **kwargs) -> None:
+        """
+        Customizable popup box that lets you create any number of buttons. The text of the pressed button is returned to
+        the callback.
 
-    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)
+        :param title: The title of the popup.
+        :param text: The message prompt in the popup.
+        :param response: A callable that will get called when the user presses a button. The prompt will not close
+         itself so should be done here if you want to close it when certain buttons are pressed.
+        :param prompts: Any number of strings to be used for the buttons.
+        """
+        layout = MDBoxLayout(orientation="vertical")
+        label = MessageBoxLabel(text=text)
+        layout.add_widget(label)
 
-            item_text_object = self._get_tab_item_text_icon_object()
+        def on_release(button: MDButton, *args) -> None:
+            response(button.text)
 
-            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,
-                )
+        buttons = [MDDivider()]
+        for prompt in prompts:
+            button = MDButton(
+                MDButtonText(text=prompt, pos_hint={"center_x": 0.5, "center_y": 0.5}),
+                on_release=on_release,
+                style="text",
+                theme_width="Custom",
+                size_hint_x=1,
+            )
+            button.text = prompt
+            buttons.extend([button, MDDivider()])
 
-            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)
+        super().__init__(
+            MDDialogHeadlineText(text=title),
+            MDDialogSupportingText(text=text),
+            MDDialogButtonContainer(*buttons, orientation="vertical"),
+            **kwargs,
+        )
 
-        if not instance:
-            self.indicator.pos = (x, self.indicator.pos[1])
-            self.indicator.size = (w, self.indicator_height)
+
+class MDScreenManagerBase(MDScreenManager):
+    current_tab: MDNavigationItemBase
+    local_screen_names: list[str]
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.local_screen_names = []
+
+    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):
@@ -803,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
@@ -832,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):
@@ -872,30 +900,30 @@ 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 = MDGridLayout(size_hint_y=1, cols=1)
         self.main_area_container.add_widget(self.tabs)
+        self.main_area_container.add_widget(self.screens)
 
         self.grid.add_widget(self.main_area_container)
 
@@ -932,25 +960,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} " \

pytest.ini

@@ -1,5 +1,5 @@
 [pytest]
-python_files = test_*.py Test*.py  # TODO: remove Test* once all worlds have been ported
+python_files = test_*.py Test*.py __init__.py  # TODO: remove Test* once all worlds have been ported
 python_classes = Test
 python_functions = test
 testpaths =

settings.py

@@ -10,9 +10,10 @@ import sys
 import types
 import typing
 import warnings
+from collections.abc import Iterator, Sequence
 from enum import IntEnum
 from threading import Lock
-from typing import cast, Any, BinaryIO, ClassVar, Dict, Iterator, List, Optional, TextIO, Tuple, Union, TypeVar
+from typing import cast, Any, BinaryIO, ClassVar, TextIO, TypeVar, Union
 
 __all__ = [
     "get_settings", "fmt_doc", "no_gui",
@@ -23,7 +24,7 @@ __all__ = [
 
 no_gui = False
 skip_autosave = False
-_world_settings_name_cache: Dict[str, str] = {}  # TODO: cache on disk and update when worlds change
+_world_settings_name_cache: dict[str, str] = {}  # TODO: cache on disk and update when worlds change
 _world_settings_name_cache_updated = False
 _lock = Lock()
 
@@ -53,7 +54,7 @@ def fmt_doc(cls: type, level: int) -> str:
 
 
 class Group:
-    _type_cache: ClassVar[Optional[Dict[str, Any]]] = None
+    _type_cache: ClassVar[dict[str, Any] | None] = None
     _dumping: bool = False
     _has_attr: bool = False
     _changed: bool = False
@@ -106,7 +107,7 @@ class Group:
                                         self.__dict__.values()))
 
     @classmethod
-    def get_type_hints(cls) -> Dict[str, Any]:
+    def get_type_hints(cls) -> dict[str, Any]:
         """Returns resolved type hints for the class"""
         if cls._type_cache is None:
             if not cls.__annotations__ or not isinstance(next(iter(cls.__annotations__.values())), str):
@@ -124,10 +125,10 @@ class Group:
             return self[key]
         return default
 
-    def items(self) -> List[Tuple[str, Any]]:
+    def items(self) -> list[tuple[str, Any]]:
         return [(key, getattr(self, key)) for key in self]
 
-    def update(self, dct: Dict[str, Any]) -> None:
+    def update(self, dct: dict[str, Any]) -> None:
         assert isinstance(dct, dict), f"{self.__class__.__name__}.update called with " \
                                       f"{dct.__class__.__name__} instead of dict."
 
@@ -196,7 +197,7 @@ class Group:
                         warnings.warn(f"{self.__class__.__name__}.{k} "
                                       f"assigned from incompatible type {type(v).__name__}")
 
-    def as_dict(self, *args: str, downcast: bool = True) -> Dict[str, Any]:
+    def as_dict(self, *args: str, downcast: bool = True) -> dict[str, Any]:
         return {
             name: _to_builtin(cast(object, getattr(self, name))) if downcast else getattr(self, name)
             for name in self if not args or name in args
@@ -211,7 +212,7 @@ class Group:
         f.write(f"{indent}{yaml_line}")
 
     @classmethod
-    def _dump_item(cls, name: Optional[str], attr: object, f: TextIO, level: int) -> None:
+    def _dump_item(cls, name: str | None, attr: object, f: TextIO, level: int) -> None:
         """Write a group, dict or sequence item to f, where attr can be a scalar or a collection"""
 
         # lazy construction of yaml Dumper to avoid loading Utils early
@@ -223,7 +224,7 @@ class Group:
                     def represent_mapping(self, tag: str, mapping: Any, flow_style: Any = None) -> MappingNode:
                         from yaml import ScalarNode
                         res: MappingNode = super().represent_mapping(tag, mapping, flow_style)
-                        pairs = cast(List[Tuple[ScalarNode, Any]], res.value)
+                        pairs = cast(list[tuple[ScalarNode, Any]], res.value)
                         for k, v in pairs:
                             k.style = None  # remove quotes from keys
                         return res
@@ -329,9 +330,9 @@ class Path(str):
     """Marks the file as required and opens a file browser when missing"""
     is_exe: bool = False
     """Special cross-platform handling for executables"""
-    description: Optional[str] = None
+    description: str | None = None
     """Title to display when browsing for the file"""
-    copy_to: Optional[str] = None
+    copy_to: str | None = None
     """If not None, copy to AP folder instead of linking it"""
 
     @classmethod
@@ -339,7 +340,7 @@ class Path(str):
         """Overload and raise to validate input files from browse"""
         pass
 
-    def browse(self: T, **kwargs: Any) -> Optional[T]:
+    def browse(self: T, **kwargs: Any) -> T | None:
         """Opens a file browser to search for the file"""
         raise NotImplementedError(f"Please use a subclass of Path for {self.__class__.__name__}")
 
@@ -369,12 +370,12 @@ class _LocalPath(str):
 class FilePath(Path):
     # path to a file
 
-    md5s: ClassVar[List[Union[str, bytes]]] = []
+    md5s: ClassVar[list[str | bytes]] = []
     """MD5 hashes for default validator."""
 
     def browse(self: T,
-               filetypes: Optional[typing.Sequence[typing.Tuple[str, typing.Sequence[str]]]] = None, **kwargs: Any)\
-            -> Optional[T]:
+               filetypes: Sequence[tuple[str, Sequence[str]]] | None = None, **kwargs: Any)\
+            -> T | None:
         from Utils import open_filename, is_windows
         if not filetypes:
             if self.is_exe:
@@ -439,7 +440,7 @@ class FilePath(Path):
 class FolderPath(Path):
     # path to a folder
 
-    def browse(self: T, **kwargs: Any) -> Optional[T]:
+    def browse(self: T, **kwargs: Any) -> T | None:
         from Utils import open_directory
         res = open_directory(f"Select {self.description or self.__class__.__name__}", self)
         if res:
@@ -597,16 +598,16 @@ class ServerOptions(Group):
         OFF = 0
         ON = 1
 
-    host: Optional[str] = None
+    host: str | None = None
     port: int = 38281
-    password: Optional[str] = None
-    multidata: Optional[str] = None
-    savefile: Optional[str] = None
+    password: str | None = None
+    multidata: str | None = None
+    savefile: str | None = None
     disable_save: bool = False
     loglevel: str = "info"
     logtime: bool = False
-    server_password: Optional[ServerPassword] = None
-    disable_item_cheat: Union[DisableItemCheat, bool] = False
+    server_password: ServerPassword | None = None
+    disable_item_cheat: DisableItemCheat | bool = False
     location_check_points: LocationCheckPoints = LocationCheckPoints(1)
     hint_cost: HintCost = HintCost(10)
     release_mode: ReleaseMode = ReleaseMode("auto")
@@ -702,7 +703,7 @@ does nothing if not found
         """
 
     sni_path: SNIPath = SNIPath("SNI")
-    snes_rom_start: Union[SnesRomStart, bool] = True
+    snes_rom_start: SnesRomStart | bool = True
 
 
 class BizHawkClientOptions(Group):
@@ -721,7 +722,7 @@ class BizHawkClientOptions(Group):
         """
 
     emuhawk_path: EmuHawkPath = EmuHawkPath(None)
-    rom_start: Union[RomStart, bool] = True
+    rom_start: RomStart | bool = True
 
 
 # Top-level group with lazy loading of worlds
@@ -733,7 +734,7 @@ class Settings(Group):
     sni_options: SNIOptions = SNIOptions()
     bizhawkclient_options: BizHawkClientOptions = BizHawkClientOptions()
 
-    _filename: Optional[str] = None
+    _filename: str | None = None
 
     def __getattribute__(self, key: str) -> Any:
         if key.startswith("_") or key in self.__class__.__dict__:
@@ -787,7 +788,7 @@ class Settings(Group):
 
         return super().__getattribute__(key)
 
-    def __init__(self, location: Optional[str]):  # change to PathLike[str] once we drop 3.8?
+    def __init__(self, location: str | None):  # change to PathLike[str] once we drop 3.8?
         super().__init__()
         if location:
             from Utils import parse_yaml
@@ -821,7 +822,7 @@ class Settings(Group):
             import atexit
             atexit.register(autosave)
 
-    def save(self, location: Optional[str] = None) -> None:  # as above
+    def save(self, location: str | None = None) -> None:  # as above
         from Utils import parse_yaml
         location = location or self._filename
         assert location, "No file specified"
@@ -854,7 +855,7 @@ class Settings(Group):
         super().dump(f, level)
 
     @property
-    def filename(self) -> Optional[str]:
+    def filename(self) -> str | None:
         return self._filename
 
 
@@ -867,7 +868,7 @@ def get_settings() -> Settings:
         if not res:
             from Utils import user_path, local_path
             filenames = ("options.yaml", "host.yaml")
-            locations: List[str] = []
+            locations: list[str] = []
             if os.path.join(os.getcwd()) != local_path():
                 locations += filenames  # use files from cwd only if it's not the local_path
             locations += [user_path(filename) for filename in filenames]

setup.py

@@ -1,22 +1,20 @@
 import base64
 import datetime
+import io
+import json
 import os
 import platform
 import shutil
+import subprocess
 import sys
 import sysconfig
+import threading
+import urllib.request
 import warnings
 import zipfile
-import urllib.request
-import io
-import json
-import threading
-import subprocess
-
+from collections.abc import Iterable, Sequence
 from hashlib import sha3_512
 from pathlib import Path
-from typing import Dict, Iterable, List, Optional, Sequence, Set, Tuple, Union
-
 
 # This is a bit jank. We need cx-Freeze to be able to run anything from this script, so install it
 requirement = 'cx-Freeze==8.0.0'
@@ -60,13 +58,12 @@ from Cython.Build import cythonize
 
 
 # On  Python < 3.10 LogicMixin is not currently supported.
-non_apworlds: Set[str] = {
+non_apworlds: set[str] = {
     "A Link to the Past",
     "Adventure",
     "ArchipIDLE",
     "Archipelago",
     "Clique",
-    "Final Fantasy",
     "Lufia II Ancient Cave",
     "Meritous",
     "Ocarina of Time",
@@ -147,7 +144,7 @@ def download_SNI() -> None:
         print(f"No SNI found for system spec {platform_name} {machine_name}")
 
 
-signtool: Optional[str]
+signtool: str | None
 if os.path.exists("X:/pw.txt"):
     print("Using signtool")
     with open("X:/pw.txt", encoding="utf-8-sig") as f:
@@ -205,7 +202,7 @@ def remove_sprites_from_folder(folder: Path) -> None:
             os.remove(folder / file)
 
 
-def _threaded_hash(filepath: Union[str, Path]) -> str:
+def _threaded_hash(filepath: str | Path) -> str:
     hasher = sha3_512()
     hasher.update(open(filepath, "rb").read())
     return base64.b85encode(hasher.digest()).decode()
@@ -255,7 +252,7 @@ class BuildExeCommand(cx_Freeze.command.build_exe.build_exe):
         self.libfolder = Path(self.buildfolder, "lib")
         self.library = Path(self.libfolder, "library.zip")
 
-    def installfile(self, path: Path, subpath: Optional[Union[str, Path]] = None, keep_content: bool = False) -> None:
+    def installfile(self, path: Path, subpath: str | Path | None = None, keep_content: bool = False) -> None:
         folder = self.buildfolder
         if subpath:
             folder /= subpath
@@ -374,11 +371,7 @@ class BuildExeCommand(cx_Freeze.command.build_exe.build_exe):
         from worlds.AutoWorld import AutoWorldRegister
         assert not non_apworlds - set(AutoWorldRegister.world_types), \
             f"Unknown world {non_apworlds - set(AutoWorldRegister.world_types)} designated for .apworld"
-        folders_to_remove: List[str] = []
-        disabled_worlds_folder = "worlds_disabled"
-        for entry in os.listdir(disabled_worlds_folder):
-            if os.path.isdir(os.path.join(disabled_worlds_folder, entry)):
-                folders_to_remove.append(entry)
+        folders_to_remove: list[str] = []
         generate_yaml_templates(self.buildfolder / "Players" / "Templates", False)
         for worldname, worldtype in AutoWorldRegister.world_types.items():
             if worldname not in non_apworlds:
@@ -446,12 +439,12 @@ class AppImageCommand(setuptools.Command):
         ("app-exec=", None, "The application to run inside the image."),
         ("yes", "y", 'Answer "yes" to all questions.'),
     ]
-    build_folder: Optional[Path]
-    dist_file: Optional[Path]
-    app_dir: Optional[Path]
+    build_folder: Path | None
+    dist_file: Path | None
+    app_dir: Path | None
     app_name: str
-    app_exec: Optional[Path]
-    app_icon: Optional[Path]  # source file
+    app_exec: Path | None
+    app_icon: Path | None  # source file
     app_id: str  # lower case name, used for icon and .desktop
     yes: bool
 
@@ -488,12 +481,12 @@ tmp="${{exe#*/}}"
 if [ ! "${{#tmp}}" -lt "${{#exe}}" ]; then
     exe="{default_exe.parent}/$exe"
 fi
-export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$APPDIR/{default_exe.parent}/lib"
+export LD_LIBRARY_PATH="${{LD_LIBRARY_PATH:+$LD_LIBRARY_PATH:}}$APPDIR/{default_exe.parent}/lib"
 $APPDIR/$exe "$@"
 """)
         launcher_filename.chmod(0o755)
 
-    def install_icon(self, src: Path, name: Optional[str] = None, symlink: Optional[Path] = None) -> None:
+    def install_icon(self, src: Path, name: str | None = None, symlink: Path | None = None) -> None:
         assert self.app_dir, "Invalid app_dir"
         try:
             from PIL import Image
@@ -556,7 +549,7 @@ $APPDIR/$exe "$@"
         subprocess.call(f'ARCH={build_arch} ./appimagetool -n "{self.app_dir}" "{self.dist_file}"', shell=True)
 
 
-def find_libs(*args: str) -> Sequence[Tuple[str, str]]:
+def find_libs(*args: str) -> Sequence[tuple[str, str]]:
     """Try to find system libraries to be included."""
     if not args:
         return []
@@ -564,7 +557,7 @@ def find_libs(*args: str) -> Sequence[Tuple[str, str]]:
     arch = build_arch.replace('_', '-')
     libc = 'libc6'  # we currently don't support musl
 
-    def parse(line: str) -> Tuple[Tuple[str, str, str], str]:
+    def parse(line: str) -> tuple[tuple[str, str, str], str]:
         lib, path = line.strip().split(' => ')
         lib, typ = lib.split(' ', 1)
         for test_arch in ('x86-64', 'i386', 'aarch64'):
@@ -589,8 +582,8 @@ def find_libs(*args: str) -> Sequence[Tuple[str, str]]:
             k: v for k, v in (parse(line) for line in data if "=>" in line)
         }
 
-    def find_lib(lib: str, arch: str, libc: str) -> Optional[str]:
-        cache: Dict[Tuple[str, str, str], str] = getattr(find_libs, "cache")
+    def find_lib(lib: str, arch: str, libc: str) -> str | None:
+        cache: dict[tuple[str, str, str], str] = getattr(find_libs, "cache")
         for k, v in cache.items():
             if k == (lib, arch, libc):
                 return v
@@ -599,7 +592,7 @@ def find_libs(*args: str) -> Sequence[Tuple[str, str]]:
                 return v
         return None
 
-    res: List[Tuple[str, str]] = []
+    res: list[tuple[str, str]] = []
     for arg in args:
         # try exact match, empty libc, empty arch, empty arch and libc
         file = find_lib(arg, arch, libc)

test/bases.py

@@ -159,7 +159,6 @@ class WorldTestBase(unittest.TestCase):
         self.multiworld.game[self.player] = self.game
         self.multiworld.player_name = {self.player: "Tester"}
         self.multiworld.set_seed(seed)
-        self.multiworld.state = CollectionState(self.multiworld)
         random.seed(self.multiworld.seed)
         self.multiworld.seed_name = get_seed_name(random)  # only called to get same RNG progression as Generate.py
         args = Namespace()
@@ -168,6 +167,7 @@ class WorldTestBase(unittest.TestCase):
                 1: option.from_any(self.options.get(name, option.default))
             })
         self.multiworld.set_options(args)
+        self.multiworld.state = CollectionState(self.multiworld)
         self.world = self.multiworld.worlds[self.player]
         for step in gen_steps:
             call_all(self.multiworld, step)

test/benchmark/locations.py

@@ -59,13 +59,13 @@ def run_locations_benchmark():
                     multiworld.game[1] = game
                     multiworld.player_name = {1: "Tester"}
                     multiworld.set_seed(0)
-                    multiworld.state = CollectionState(multiworld)
                     args = argparse.Namespace()
                     for name, option in AutoWorld.AutoWorldRegister.world_types[game].options_dataclass.type_hints.items():
                         setattr(args, name, {
                             1: option.from_any(getattr(option, "default"))
                         })
                     multiworld.set_options(args)
+                    multiworld.state = CollectionState(multiworld)
 
                     gc.collect()
                     for step in self.gen_steps:

test/general/__init__.py

@@ -49,7 +49,6 @@ def setup_multiworld(worlds: Union[List[Type[World]], Type[World]], steps: Tuple
     multiworld.game = {player: world_type.game for player, world_type in enumerate(worlds, 1)}
     multiworld.player_name = {player: f"Tester{player}" for player in multiworld.player_ids}
     multiworld.set_seed(seed)
-    multiworld.state = CollectionState(multiworld)
     args = Namespace()
     for player, world_type in enumerate(worlds, 1):
         for key, option in world_type.options_dataclass.type_hints.items():
@@ -57,6 +56,7 @@ def setup_multiworld(worlds: Union[List[Type[World]], Type[World]], steps: Tuple
             updated_options[player] = option.from_any(option.default)
             setattr(args, key, updated_options)
     multiworld.set_options(args)
+    multiworld.state = CollectionState(multiworld)
     for step in steps:
         call_all(multiworld, step)
     return multiworld

test/general/test_implemented.py

@@ -53,6 +53,22 @@ class TestImplemented(unittest.TestCase):
         if failed_world_loads:
             self.fail(f"The following worlds failed to load: {failed_world_loads}")
 
+    def test_prefill_items(self):
+        """Test that every world can reach every location from allstate before pre_fill."""
+        for gamename, world_type in AutoWorldRegister.world_types.items():
+            if gamename not in ("Archipelago", "Sudoku", "Final Fantasy", "Test Game"):
+                with self.subTest(gamename):
+                    multiworld = setup_solo_multiworld(world_type, ("generate_early", "create_regions", "create_items",
+                                                                    "set_rules", "connect_entrances", "generate_basic"))
+                    allstate = multiworld.get_all_state(False)
+                    locations = multiworld.get_locations()
+                    reachable = multiworld.get_reachable_locations(allstate)
+                    unreachable = [location for location in locations if location not in reachable]
+
+                    self.assertTrue(not unreachable,
+                                    f"Locations were not reachable with all state before prefill: "
+                                    f"{unreachable}. Seed: {multiworld.seed}")
+                    
     def test_explicit_indirect_conditions_spheres(self):
         """Tests that worlds using explicit indirect conditions produce identical spheres as when using implicit
         indirect conditions"""

test/general/test_state.py

@@ -26,4 +26,4 @@ class TestBase(unittest.TestCase):
                 for step in self.test_steps:
                     with self.subTest("Step", step=step):
                         call_all(multiworld, step)
-                        self.assertTrue(multiworld.get_all_state(False, True))
+                        self.assertTrue(multiworld.get_all_state(False, allow_partial_entrances=True))

test/hosting/world.py

@@ -1,13 +1,12 @@
 import re
 import shutil
 from pathlib import Path
-from typing import Dict
 
 
 __all__ = ["copy", "delete"]
 
 
-_new_worlds: Dict[str, str] = {}
+_new_worlds: dict[str, str] = {}
 
 
 def copy(src: str, dst: str) -> None:

worlds/AutoWorld.py

@@ -528,7 +528,7 @@ class World(metaclass=AutoWorldRegister):
         """Called when an item is collected in to state. Useful for things such as progressive items or currency."""
         name = self.collect_item(state, item)
         if name:
-            state.prog_items[self.player][name] += 1
+            state.add_item(name, self.player)
             return True
         return False
 
@@ -536,9 +536,7 @@ class World(metaclass=AutoWorldRegister):
         """Called when an item is removed from to state. Useful for things such as progressive items or currency."""
         name = self.collect_item(state, item, True)
         if name:
-            state.prog_items[self.player][name] -= 1
-            if state.prog_items[self.player][name] < 1:
-                del (state.prog_items[self.player][name])
+            state.remove_item(name, self.player)
             return True
         return False
 

worlds/Files.py

@@ -6,6 +6,7 @@ import zipfile
 from enum import IntEnum
 import os
 import threading
+from io import BytesIO
 
 from typing import ClassVar, Dict, List, Literal, Tuple, Any, Optional, Union, BinaryIO, overload, Sequence
 
@@ -70,6 +71,18 @@ class AutoPatchExtensionRegister(abc.ABCMeta):
 container_version: int = 6
 
 
+def is_ap_player_container(game: str, data: bytes, player: int):
+    if not zipfile.is_zipfile(BytesIO(data)):
+        return False
+    with zipfile.ZipFile(BytesIO(data), mode='r') as zf:
+        if "archipelago.json" in zf.namelist():
+            manifest = json.loads(zf.read("archipelago.json"))
+            if "game" in manifest and "player" in manifest:
+                if game == manifest["game"] and player == manifest["player"]:
+                    return True
+    return False
+
+
 class InvalidDataError(Exception):
     """
     Since games can override `read_contents` in APContainer,
@@ -78,24 +91,15 @@ class InvalidDataError(Exception):
 
 
 class APContainer:
-    """A zipfile containing at least archipelago.json"""
-    version: int = container_version
-    compression_level: int = 9
-    compression_method: int = zipfile.ZIP_DEFLATED
-    game: Optional[str] = None
+    """A zipfile containing at least archipelago.json, which contains a manifest json payload."""
+    version: ClassVar[int] = container_version
+    compression_level: ClassVar[int] = 9
+    compression_method: ClassVar[int] = zipfile.ZIP_DEFLATED
 
-    # instance attributes:
     path: Optional[str]
-    player: Optional[int]
-    player_name: str
-    server: str
 
-    def __init__(self, path: Optional[str] = None, player: Optional[int] = None,
-                 player_name: str = "", server: str = ""):
+    def __init__(self, path: Optional[str] = None):
         self.path = path
-        self.player = player
-        self.player_name = player_name
-        self.server = server
 
     def write(self, file: Optional[Union[str, BinaryIO]] = None) -> None:
         zip_file = file if file else self.path
@@ -135,31 +139,60 @@ class APContainer:
                         message = f"{arg0} - "
                 raise InvalidDataError(f"{message}This might be the incorrect world version for this file") from e
 
-    def read_contents(self, opened_zipfile: zipfile.ZipFile) -> None:
+    def read_contents(self, opened_zipfile: zipfile.ZipFile) -> Dict[str, Any]:
         with opened_zipfile.open("archipelago.json", "r") as f:
             manifest = json.load(f)
         if manifest["compatible_version"] > self.version:
             raise Exception(f"File (version: {manifest['compatible_version']}) too new "
                             f"for this handler (version: {self.version})")
-        self.player = manifest["player"]
-        self.server = manifest["server"]
-        self.player_name = manifest["player_name"]
+        return manifest
 
     def get_manifest(self) -> Dict[str, Any]:
         return {
-            "server": self.server,  # allow immediate connection to server in multiworld. Empty string otherwise
-            "player": self.player,
-            "player_name": self.player_name,
-            "game": self.game,
             # minimum version of patch system expected for patching to be successful
             "compatible_version": 5,
             "version": container_version,
         }
 
 
-class APPatch(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
+    server: str
+
+    def __init__(self, path: Optional[str] = None, player: Optional[int] = None,
+                 player_name: str = "", server: str = ""):
+        super().__init__(path)
+        self.player = player
+        self.player_name = player_name
+        self.server = server
+
+    def read_contents(self, opened_zipfile: zipfile.ZipFile) -> Dict[str, Any]:
+        manifest = super().read_contents(opened_zipfile)
+        self.player = manifest["player"]
+        self.server = manifest["server"]
+        self.player_name = manifest["player_name"]
+        return manifest
+
+    def get_manifest(self) -> Dict[str, Any]:
+        manifest = super().get_manifest()
+        manifest.update({
+            "server": self.server,  # allow immediate connection to server in multiworld. Empty string otherwise
+            "player": self.player,
+            "player_name": self.player_name,
+            "game": self.game,
+            "patch_file_ending": self.patch_file_ending,
+        })
+        return manifest
+
+
+class APPatch(APPlayerContainer):
     """
-    An `APContainer` that represents a patch file.
+    An `APPlayerContainer` that represents a patch file.
     It includes the `procedure` key in the manifest to indicate that it is a patch.
 
     Your implementation should inherit from this if your output file
@@ -192,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
@@ -214,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,30 +210,27 @@ 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')),
     Component('OoT Adjuster', 'OoTAdjuster'),
-    # FF1
-    Component('FF1 Client', 'FF1Client'),
     # TLoZ
     Component('Zelda 1 Client', 'Zelda1Client', file_identifier=SuffixIdentifier('.aptloz')),
     # ChecksFinder
     Component('ChecksFinder Client', 'ChecksFinderClient'),
     # Starcraft 2
     Component('Starcraft 2 Client', 'Starcraft2Client'),
-    # Wargroove
-    Component('Wargroove Client', 'WargrooveClient'),
     # Zillion
     Component('Zillion Client', 'ZillionClient',
               file_identifier=SuffixIdentifier('.apzl')),
@@ -246,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/adventure/Rom.py

@@ -182,10 +182,11 @@ class AdventureDeltaPatch(APPatch, metaclass=AutoPatchRegister):
                                     json.dumps(self.rom_deltas),
                                     compress_type=zipfile.ZIP_LZMA)
 
-    def read_contents(self, opened_zipfile: zipfile.ZipFile):
-        super(AdventureDeltaPatch, self).read_contents(opened_zipfile)
+    def read_contents(self, opened_zipfile: zipfile.ZipFile) -> dict[str, Any]:
+        manifest = super(AdventureDeltaPatch, self).read_contents(opened_zipfile)
         self.foreign_items = AdventureDeltaPatch.read_foreign_items(opened_zipfile)
         self.autocollect_items = AdventureDeltaPatch.read_autocollect_items(opened_zipfile)
+        return manifest
 
     @classmethod
     def get_source_data(cls) -> bytes:

worlds/ahit/Client.py

@@ -238,10 +238,10 @@ async def proxy_loop(ctx: AHITContext):
         logger.info("Aborting AHIT Proxy Client due to errors")
 
 
-def launch():
+def launch(*launch_args: str):
     async def main():
         parser = get_base_parser()
-        args = parser.parse_args()
+        args = parser.parse_args(launch_args)
 
         ctx = AHITContext(args.connect, args.password)
         logger.info("Starting A Hat in Time proxy server")

worlds/ahit/Locations.py

@@ -477,7 +477,7 @@ act_completions = {
     "Act Completion (Rush Hour)": LocData(2000311210, "Rush Hour",
                                           dlc_flags=HatDLC.dlc2,
                                           hookshot=True,
-                                          required_hats=[HatType.ICE, HatType.BREWING]),
+                                          required_hats=[HatType.ICE, HatType.BREWING, HatType.DWELLER]),
 
     "Act Completion (Time Rift - Rumbi Factory)": LocData(2000312736, "Time Rift - Rumbi Factory",
                                                           dlc_flags=HatDLC.dlc2),

worlds/ahit/Rules.py

@@ -455,7 +455,7 @@ def set_moderate_rules(world: "HatInTimeWorld"):
             if "Pink Paw Station Thug" in key and is_location_valid(world, key):
                 set_rule(world.multiworld.get_location(key, world.player), lambda state: True)
 
-        # Moderate: clear Rush Hour without Hookshot
+        # Moderate: clear Rush Hour without Hookshot or Dweller Mask
         set_rule(world.multiworld.get_location("Act Completion (Rush Hour)", world.player),
                  lambda state: state.has("Metro Ticket - Pink", world.player)
                  and state.has("Metro Ticket - Yellow", world.player)

worlds/ahit/__init__.py

@@ -16,9 +16,9 @@ from worlds.LauncherComponents import Component, components, icon_paths, launch
 from Utils import local_path
 
 
-def launch_client():
+def launch_client(*args: str):
     from .Client import launch
-    launch_component(launch, name="AHITClient")
+    launch_component(launch, name="AHITClient", args=args)
 
 
 components.append(Component("A Hat in Time Client", "AHITClient", func=launch_client,

worlds/alttp/EntranceRandomizer.py

@@ -54,16 +54,13 @@ def parse_arguments(argv, no_defaults=False):
     ret = parser.parse_args(argv)
 
     # cannot be set through CLI currently
-    ret.plando_items = []
-    ret.plando_texts = {}
-    ret.plando_connections = []
 
     if multiargs.multi:
         defaults = copy.deepcopy(ret)
         for player in range(1, multiargs.multi + 1):
             playerargs = parse_arguments(shlex.split(getattr(ret, f"p{player}")), True)
 
-            for name in ["plando_items", "plando_texts", "plando_connections", "game", "sprite", "sprite_pool"]:
+            for name in ["game", "sprite", "sprite_pool"]:
                 value = getattr(defaults, name) if getattr(playerargs, name) is None else getattr(playerargs, name)
                 if player == 1:
                     setattr(ret, name, {1: value})

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/__init__.py

@@ -505,20 +505,20 @@ class ALTTPWorld(World):
     def pre_fill(self):
         from Fill import fill_restrictive, FillError
         attempts = 5
-        world = self.multiworld
-        player = self.player
-        all_state = world.get_all_state(use_cache=True)
+        all_state = self.multiworld.get_all_state(use_cache=False)
         crystals = [self.create_item(name) for name in ['Red Pendant', 'Blue Pendant', 'Green Pendant', 'Crystal 1', 'Crystal 2', 'Crystal 3', 'Crystal 4', 'Crystal 7', 'Crystal 5', 'Crystal 6']]
-        crystal_locations = [world.get_location('Turtle Rock - Prize', player),
-                             world.get_location('Eastern Palace - Prize', player),
-                             world.get_location('Desert Palace - Prize', player),
-                             world.get_location('Tower of Hera - Prize', player),
-                             world.get_location('Palace of Darkness - Prize', player),
-                             world.get_location('Thieves\' Town - Prize', player),
-                             world.get_location('Skull Woods - Prize', player),
-                             world.get_location('Swamp Palace - Prize', player),
-                             world.get_location('Ice Palace - Prize', player),
-                             world.get_location('Misery Mire - Prize', player)]
+        for crystal in crystals:
+            all_state.remove(crystal)
+        crystal_locations = [self.get_location('Turtle Rock - Prize'),
+                             self.get_location('Eastern Palace - Prize'),
+                             self.get_location('Desert Palace - Prize'),
+                             self.get_location('Tower of Hera - Prize'),
+                             self.get_location('Palace of Darkness - Prize'),
+                             self.get_location('Thieves\' Town - Prize'),
+                             self.get_location('Skull Woods - Prize'),
+                             self.get_location('Swamp Palace - Prize'),
+                             self.get_location('Ice Palace - Prize'),
+                             self.get_location('Misery Mire - Prize')]
         placed_prizes = {loc.item.name for loc in crystal_locations if loc.item}
         unplaced_prizes = [crystal for crystal in crystals if crystal.name not in placed_prizes]
         empty_crystal_locations = [loc for loc in crystal_locations if not loc.item]
@@ -526,8 +526,8 @@ class ALTTPWorld(World):
             try:
                 prizepool = unplaced_prizes.copy()
                 prize_locs = empty_crystal_locations.copy()
-                world.random.shuffle(prize_locs)
-                fill_restrictive(world, all_state, prize_locs, prizepool, True, lock=True,
+                self.multiworld.random.shuffle(prize_locs)
+                fill_restrictive(self.multiworld, all_state, prize_locs, prizepool, True, lock=True,
                                  name="LttP Dungeon Prizes")
             except FillError as e:
                 lttp_logger.exception("Failed to place dungeon prizes (%s). Will retry %s more times", e,
@@ -541,7 +541,7 @@ class ALTTPWorld(World):
         if self.options.mode == 'standard' and self.options.small_key_shuffle \
                 and self.options.small_key_shuffle != small_key_shuffle.option_universal and \
                 self.options.small_key_shuffle != small_key_shuffle.option_own_dungeons:
-            world.local_early_items[player]["Small Key (Hyrule Castle)"] = 1
+            self.multiworld.local_early_items[self.player]["Small Key (Hyrule Castle)"] = 1
 
     @classmethod
     def stage_pre_fill(cls, world):
@@ -811,12 +811,15 @@ class ALTTPWorld(World):
         return GetBeemizerItem(self.multiworld, self.player, item)
 
     def get_pre_fill_items(self):
-        res = []
+        res = [self.create_item(name) for name in ('Red Pendant', 'Blue Pendant', 'Green Pendant', 'Crystal 1',
+                                                   'Crystal 2', 'Crystal 3', 'Crystal 4', 'Crystal 7', 'Crystal 5',
+                                                   'Crystal 6')]
         if self.dungeon_local_item_names:
             for dungeon in self.dungeons.values():
                 for item in dungeon.all_items:
                     if item.name in self.dungeon_local_item_names:
                         res.append(item)
+
         return res
 
     def fill_slot_data(self):

worlds/alttp/test/__init__.py

@@ -10,12 +10,12 @@ class LTTPTestBase(unittest.TestCase):
         from worlds.alttp.Options import Medallion
         self.multiworld = MultiWorld(1)
         self.multiworld.game[1] = "A Link to the Past"
-        self.multiworld.state = CollectionState(self.multiworld)
         self.multiworld.set_seed(None)
         args = Namespace()
         for name, option in AutoWorldRegister.world_types["A Link to the Past"].options_dataclass.type_hints.items():
             setattr(args, name, {1: option.from_any(getattr(option, "default"))})
         self.multiworld.set_options(args)
+        self.multiworld.state = CollectionState(self.multiworld)
         self.world = self.multiworld.worlds[1]
         # by default medallion access is randomized, for unittests we set it to vanilla
         self.world.options.misery_mire_medallion.value = Medallion.option_ether

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/blasphemous/__init__.py

@@ -207,7 +207,6 @@ class BlasphemousWorld(World):
         if not self.options.skill_randomizer:
             self.place_items_from_dict(skill_dict)
         
-
     def place_items_from_set(self, location_set: Set[str], name: str):
         for loc in location_set:
             self.get_location(loc).place_locked_item(self.create_item(name))

worlds/checksfinder/docs/setup_en.md

@@ -3,7 +3,8 @@
 ## Required Software
 
 - ChecksFinder from
-  the [Github releases Page for the game](https://github.com/jonloveslegos/ChecksFinder/releases) (latest version)
+  the [Github releases Page for the game](https://github.com/jonloveslegos/ChecksFinder/releases) (latest version), or 
+  from the [itch.io Page for the game](https://suncat0.itch.io/checksfinder) (including web version)
 
 ## Configuring your YAML file
 
@@ -18,13 +19,13 @@ You can customize your options by visiting the [ChecksFinder Player Options Page
 
 ## Joining a MultiWorld Game
 
-1. Start ChecksFinder
-2. Enter the following information:
-    - Enter the server url (starting from `wss://` for https connection like archipelago.gg, and starting from `ws://` for http connection and local multiserver)
-    - Enter server port
-    - Enter the name of the slot you wish to connect to
-    - Enter the room password (optional)
-    - Press `Play Online` to connect
-3. Start playing!
-
-Game options and controls are described in the readme on the github repository for the game
+1. Start ChecksFinder and press `Play Online`
+2. Switch to the console window/tab
+3. Enter the following information:
+    - Server url
+    - Server port
+    - The name of the slot you wish to connect to
+    - The room password (optional)
+4. Press `Connect` to connect
+5. Switch to the game window/tab
+6. Start playing!

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/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,

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/dark_souls_3/Items.py

@@ -511,7 +511,7 @@ _vanilla_items = [
     DS3ItemData("Elkhorn Round Shield",                0x0133C510, DS3ItemCategory.SHIELD_INFUSIBLE),
     DS3ItemData("Warrior's Round Shield",              0x0133EC20, DS3ItemCategory.SHIELD_INFUSIBLE),
     DS3ItemData("Caduceus Round Shield",               0x01341330, DS3ItemCategory.SHIELD_INFUSIBLE),
-    DS3ItemData("Red and White Shield",                0x01343A40, DS3ItemCategory.SHIELD_INFUSIBLE),
+    DS3ItemData("Red and White Round Shield",          0x01343A40, DS3ItemCategory.SHIELD_INFUSIBLE),
     DS3ItemData("Blessed Red and White Shield+1",      0x01343FB9, DS3ItemCategory.SHIELD),
     DS3ItemData("Plank Shield",                        0x01346150, DS3ItemCategory.SHIELD_INFUSIBLE),
     DS3ItemData("Leather Shield",                      0x01348860, DS3ItemCategory.SHIELD_INFUSIBLE),

worlds/dark_souls_3/Locations.py

@@ -706,7 +706,7 @@ location_tables: Dict[str, List[DS3LocationData]] = {
         DS3LocationData("US: Whip - back alley, behind wooden wall", "Whip", hidden=True),
         DS3LocationData("US: Great Scythe - building by white tree, balcony", "Great Scythe"),
         DS3LocationData("US: Homeward Bone - foot, drop overlook", "Homeward Bone",
-                        static='02,0:53100540::'),
+                        static='02,0:53100950::'),
         DS3LocationData("US: Large Soul of a Deserted Corpse - around corner by Cliff Underside",
                         "Large Soul of a Deserted Corpse", hidden=True),  # Hidden corner
         DS3LocationData("US: Ember - behind burning tree", "Ember"),
@@ -732,8 +732,9 @@ location_tables: Dict[str, List[DS3LocationData]] = {
                         missable=True),  # requires projectile
         DS3LocationData("US: Flame Stoneplate Ring - hanging corpse by Mound-Maker transport",
                         "Flame Stoneplate Ring"),
-        DS3LocationData("US: Red and White Shield - chasm, hanging corpse", "Red and White Shield",
-                        static="02,0:53100740::", missable=True),  # requires projectile
+        DS3LocationData("US: Red and White Round Shield - chasm, hanging corpse",
+                        "Red and White Round Shield", static="02,0:53100740::",
+                        missable=True),  # requires projectile
         DS3LocationData("US: Small Leather Shield - first building, hanging corpse by entrance",
                         "Small Leather Shield"),
         DS3LocationData("US: Pale Tongue - tower village, hanging corpse", "Pale Tongue"),
@@ -883,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",
@@ -1886,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 = (
@@ -273,9 +277,7 @@ class DarkSouls3World(World):
                     self.player,
                     location,
                     parent = new_region,
-                    event = True,
                 )
-                event_item.code = None
                 new_location.place_locked_item(event_item)
                 if location.name in excluded:
                     excluded.remove(location.name)
@@ -707,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
@@ -1288,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/locations_en.md

@@ -2239,7 +2239,7 @@ static _Dark Souls III_ randomizer].
 <tr><td>US: Pyromancy Flame - Cornyx</td><td>Given by Cornyx in Firelink Shrine or dropped.</td></tr>
 <tr><td>US: Red Bug Pellet - tower village building, basement</td><td>On the floor of the building after the Fire Demon encounter</td></tr>
 <tr><td>US: Red Hilted Halberd - chasm crypt</td><td>In the skeleton area accessible from Grave Key or dropping down from near Eygon</td></tr>
-<tr><td>US: Red and White Shield - chasm, hanging corpse</td><td>On a hanging corpse in the ravine accessible with the Grave Key or dropping down near Eygon, to the entrance of Irina&#x27;s prison. Must be shot down with an arrow or projective.</td></tr>
+<tr><td>US: Red and White Round Shield - chasm, hanging corpse</td><td>On a hanging corpse in the ravine accessible with the Grave Key or dropping down near Eygon, to the entrance of Irina&#x27;s prison. Must be shot down with an arrow or projective.</td></tr>
 <tr><td>US: Reinforced Club - by white tree</td><td>Near the Birch Tree where giant shoots arrows</td></tr>
 <tr><td>US: Repair Powder - first building, balcony</td><td>On the balcony of the first Undead Settlement building</td></tr>
 <tr><td>US: Rusted Coin - awning above Dilapidated Bridge</td><td>On a wooden ledge near the Dilapidated Bridge bonfire. Must be jumped to from near Cathedral Evangelist enemy</td></tr>

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/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

@@ -63,10 +63,11 @@ recipe_time_ranges = {
 }
 
 
-class FactorioModFile(worlds.Files.APContainer):
+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/__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/ff1/Client.py

@@ -0,0 +1,328 @@
+import logging
+from collections import deque
+from typing import TYPE_CHECKING
+
+from NetUtils import ClientStatus
+
+import worlds._bizhawk as bizhawk
+from worlds._bizhawk.client import BizHawkClient
+
+if TYPE_CHECKING:
+    from worlds._bizhawk.context import BizHawkClientContext
+
+
+base_id = 7000
+logger = logging.getLogger("Client")
+
+
+rom_name_location = 0x07FFE3
+locations_array_start = 0x200
+locations_array_length = 0x100
+items_obtained = 0x03
+gp_location_low = 0x1C
+gp_location_middle = 0x1D
+gp_location_high = 0x1E
+weapons_arrays_starts = [0x118, 0x158, 0x198, 0x1D8]
+armors_arrays_starts = [0x11C, 0x15C, 0x19C, 0x1DC]
+status_a_location = 0x102
+status_b_location = 0x0FC
+status_c_location = 0x0A3
+
+key_items = ["Lute", "Crown", "Crystal", "Herb", "Key", "Tnt", "Adamant", "Slab", "Ruby", "Rod",
+             "Floater", "Chime", "Tail", "Cube", "Bottle", "Oxyale", "EarthOrb", "FireOrb", "WaterOrb", "AirOrb"]
+
+consumables = ["Shard", "Tent", "Cabin", "House", "Heal", "Pure", "Soft"]
+
+weapons = ["WoodenNunchucks", "SmallKnife", "WoodenRod", "Rapier", "IronHammer", "ShortSword", "HandAxe", "Scimitar",
+           "IronNunchucks", "LargeKnife", "IronStaff", "Sabre", "LongSword", "GreatAxe", "Falchon", "SilverKnife",
+           "SilverSword", "SilverHammer", "SilverAxe", "FlameSword", "IceSword", "DragonSword", "GiantSword",
+           "SunSword", "CoralSword", "WereSword", "RuneSword", "PowerRod", "LightAxe", "HealRod", "MageRod", "Defense",
+           "WizardRod", "Vorpal", "CatClaw", "ThorHammer", "BaneSword", "Katana", "Xcalber", "Masamune"]
+
+armor = ["Cloth", "WoodenArmor", "ChainArmor", "IronArmor", "SteelArmor", "SilverArmor", "FlameArmor", "IceArmor",
+         "OpalArmor", "DragonArmor", "Copper", "Silver", "Gold", "Opal", "WhiteShirt", "BlackShirt", "WoodenShield",
+         "IronShield", "SilverShield", "FlameShield", "IceShield", "OpalShield", "AegisShield", "Buckler", "ProCape",
+         "Cap", "WoodenHelm", "IronHelm", "SilverHelm", "OpalHelm", "HealHelm", "Ribbon", "Gloves", "CopperGauntlets",
+         "IronGauntlets", "SilverGauntlets", "ZeusGauntlets", "PowerGauntlets", "OpalGauntlets", "ProRing"]
+
+gold_items = ["Gold10", "Gold20", "Gold25", "Gold30", "Gold55", "Gold70", "Gold85", "Gold110", "Gold135", "Gold155",
+              "Gold160", "Gold180", "Gold240", "Gold255", "Gold260", "Gold295", "Gold300", "Gold315", "Gold330",
+              "Gold350", "Gold385", "Gold400", "Gold450", "Gold500", "Gold530", "Gold575", "Gold620", "Gold680",
+              "Gold750", "Gold795", "Gold880", "Gold1020", "Gold1250", "Gold1455", "Gold1520", "Gold1760", "Gold1975",
+              "Gold2000", "Gold2750", "Gold3400", "Gold4150", "Gold5000", "Gold5450", "Gold6400", "Gold6720",
+              "Gold7340", "Gold7690", "Gold7900", "Gold8135", "Gold9000", "Gold9300", "Gold9500", "Gold9900",
+              "Gold10000", "Gold12350", "Gold13000", "Gold13450", "Gold14050", "Gold14720", "Gold15000", "Gold17490",
+              "Gold18010", "Gold19990", "Gold20000", "Gold20010", "Gold26000", "Gold45000", "Gold65000"]
+
+extended_consumables = ["FullCure", "Phoenix", "Blast", "Smoke",
+                        "Refresh", "Flare", "Black", "Guard",
+                        "Quick", "HighPotion", "Wizard", "Cloak"]
+
+ext_consumables_lookup = {"FullCure": "Ext1", "Phoenix": "Ext2", "Blast": "Ext3", "Smoke": "Ext4",
+                          "Refresh": "Ext1", "Flare": "Ext2", "Black": "Ext3", "Guard": "Ext4",
+                          "Quick": "Ext1", "HighPotion": "Ext2", "Wizard": "Ext3", "Cloak": "Ext4"}
+
+ext_consumables_locations = {"Ext1": 0x3C, "Ext2": 0x3D, "Ext3": 0x3E, "Ext4": 0x3F}
+
+
+movement_items = ["Ship", "Bridge", "Canal", "Canoe"]
+
+no_overworld_items = ["Sigil", "Mark"]
+
+
+class FF1Client(BizHawkClient):
+    game = "Final Fantasy"
+    system = "NES"
+
+    weapons_queue: deque[int]
+    armor_queue: deque[int]
+    consumable_stack_amounts: dict[str, int] | None
+
+    def __init__(self) -> None:
+        self.wram = "RAM"
+        self.sram = "WRAM"
+        self.rom = "PRG ROM"
+        self.consumable_stack_amounts = None
+        self.weapons_queue = deque()
+        self.armor_queue = deque()
+        self.guard_character = 0x00
+
+    async def validate_rom(self, ctx: "BizHawkClientContext") -> bool:
+        try:
+            # Check ROM name/patch version
+            rom_name = ((await bizhawk.read(ctx.bizhawk_ctx, [(rom_name_location, 0x0D, self.rom)]))[0])
+            rom_name = rom_name.decode("ascii")
+            if rom_name != "FINAL FANTASY":
+                return False  # Not a Final Fantasy 1 ROM
+        except bizhawk.RequestFailedError:
+            return False  # Not able to get a response, say no for now
+
+        ctx.game = self.game
+        ctx.items_handling = 0b111
+        ctx.want_slot_data = True
+        # Resetting these in case of switching ROMs
+        self.consumable_stack_amounts = None
+        self.weapons_queue = deque()
+        self.armor_queue = deque()
+
+        return True
+
+    async def game_watcher(self, ctx: "BizHawkClientContext") -> None:
+        if ctx.server is None:
+            return
+
+        if ctx.slot is None:
+            return
+        try:
+            self.guard_character = await self.read_sram_value(ctx, status_a_location)
+            # If the first character's name starts with a 0 value, we're at the title screen/character creation.
+            # In that case, don't allow any read/writes.
+            # We do this by setting the guard to 1 because that's neither a valid character nor the initial value.
+            if self.guard_character == 0:
+                self.guard_character = 0x01
+
+            if self.consumable_stack_amounts is None:
+                self.consumable_stack_amounts = {}
+                self.consumable_stack_amounts["Shard"] = 1
+                other_consumable_amounts = await self.read_rom(ctx, 0x47400, 10)
+                self.consumable_stack_amounts["Tent"] = other_consumable_amounts[0] + 1
+                self.consumable_stack_amounts["Cabin"] = other_consumable_amounts[1] + 1
+                self.consumable_stack_amounts["House"] = other_consumable_amounts[2] + 1
+                self.consumable_stack_amounts["Heal"] = other_consumable_amounts[3] + 1
+                self.consumable_stack_amounts["Pure"] = other_consumable_amounts[4] + 1
+                self.consumable_stack_amounts["Soft"] = other_consumable_amounts[5] + 1
+                self.consumable_stack_amounts["Ext1"] = other_consumable_amounts[6] + 1
+                self.consumable_stack_amounts["Ext2"] = other_consumable_amounts[7] + 1
+                self.consumable_stack_amounts["Ext3"] = other_consumable_amounts[8] + 1
+                self.consumable_stack_amounts["Ext4"] = other_consumable_amounts[9] + 1
+
+            await self.location_check(ctx)
+            await self.received_items_check(ctx)
+            await self.process_weapons_queue(ctx)
+            await self.process_armor_queue(ctx)
+
+        except bizhawk.RequestFailedError:
+            # The connector didn't respond. Exit handler and return to main loop to reconnect
+            pass
+
+    async def location_check(self, ctx: "BizHawkClientContext"):
+        locations_data = await self.read_sram_values_guarded(ctx, locations_array_start, locations_array_length)
+        if locations_data is None:
+            return
+        locations_checked = []
+        if len(locations_data) > 0xFE and locations_data[0xFE] & 0x02 != 0 and not ctx.finished_game:
+            await ctx.send_msgs([
+                {"cmd": "StatusUpdate",
+                 "status": ClientStatus.CLIENT_GOAL}
+            ])
+            ctx.finished_game = True
+        for location in ctx.missing_locations:
+            # index will be - 0x100 or 0x200
+            index = location
+            if location < 0x200:
+                # Location is a chest
+                index -= 0x100
+                flag = 0x04
+            else:
+                # Location is an NPC
+                index -= 0x200
+                flag = 0x02
+            if locations_data[index] & flag != 0:
+                locations_checked.append(location)
+
+        found_locations = await ctx.check_locations(locations_checked)
+        for location in found_locations:
+            ctx.locations_checked.add(location)
+            location_name = ctx.location_names.lookup_in_game(location)
+            logger.info(
+                f'New Check: {location_name} ({len(ctx.locations_checked)}/'
+                f'{len(ctx.missing_locations) + len(ctx.checked_locations)})')
+
+
+    async def received_items_check(self, ctx: "BizHawkClientContext") -> None:
+        assert self.consumable_stack_amounts, "shouldn't call this function without reading consumable_stack_amounts"
+        write_list: list[tuple[int, list[int], str]] = []
+        items_received_count = await self.read_sram_value_guarded(ctx, items_obtained)
+        if items_received_count is None:
+            return
+        if items_received_count < len(ctx.items_received):
+            current_item = ctx.items_received[items_received_count]
+            current_item_id = current_item.item
+            current_item_name = ctx.item_names.lookup_in_game(current_item_id, ctx.game)
+            if current_item_name in key_items:
+                location = current_item_id - 0xE0
+                write_list.append((location, [1], self.sram))
+            elif current_item_name in movement_items:
+                location = current_item_id - 0x1E0
+                if current_item_name != "Canal":
+                    write_list.append((location, [1], self.sram))
+                else:
+                    write_list.append((location, [0], self.sram))
+            elif current_item_name in no_overworld_items:
+                if current_item_name == "Sigil":
+                    location = 0x28
+                else:
+                    location = 0x12
+                write_list.append((location, [1], self.sram))
+            elif current_item_name in gold_items:
+                gold_amount = int(current_item_name[4:])
+                current_gold_value = await self.read_sram_values_guarded(ctx, gp_location_low, 3)
+                if current_gold_value is None:
+                    return
+                current_gold = int.from_bytes(current_gold_value, "little")
+                new_gold = min(gold_amount + current_gold, 999999)
+                lower_byte = new_gold % (2 ** 8)
+                middle_byte = (new_gold // (2 ** 8)) % (2 ** 8)
+                upper_byte = new_gold // (2 ** 16)
+                write_list.append((gp_location_low, [lower_byte], self.sram))
+                write_list.append((gp_location_middle, [middle_byte], self.sram))
+                write_list.append((gp_location_high, [upper_byte], self.sram))
+            elif current_item_name in consumables:
+                location = current_item_id - 0xE0
+                current_value = await self.read_sram_value_guarded(ctx, location)
+                if current_value is None:
+                    return
+                amount_to_add = self.consumable_stack_amounts[current_item_name]
+                new_value = min(current_value + amount_to_add, 99)
+                write_list.append((location, [new_value], self.sram))
+            elif current_item_name in extended_consumables:
+                ext_name = ext_consumables_lookup[current_item_name]
+                location = ext_consumables_locations[ext_name]
+                current_value = await self.read_sram_value_guarded(ctx, location)
+                if current_value is None:
+                    return
+                amount_to_add = self.consumable_stack_amounts[ext_name]
+                new_value = min(current_value + amount_to_add, 99)
+                write_list.append((location, [new_value], self.sram))
+            elif current_item_name in weapons:
+                self.weapons_queue.appendleft(current_item_id - 0x11B)
+            elif current_item_name in armor:
+                self.armor_queue.appendleft(current_item_id - 0x143)
+            write_list.append((items_obtained, [items_received_count + 1], self.sram))
+            write_successful = await self.write_sram_values_guarded(ctx, write_list)
+            if write_successful:
+                await bizhawk.display_message(ctx.bizhawk_ctx, f"Received {current_item_name}")
+
+    async def process_weapons_queue(self, ctx: "BizHawkClientContext"):
+        empty_slots = deque()
+        char1_slots = await self.read_sram_values_guarded(ctx, weapons_arrays_starts[0], 4)
+        char2_slots = await self.read_sram_values_guarded(ctx, weapons_arrays_starts[1], 4)
+        char3_slots = await self.read_sram_values_guarded(ctx, weapons_arrays_starts[2], 4)
+        char4_slots = await self.read_sram_values_guarded(ctx, weapons_arrays_starts[3], 4)
+        if char1_slots is None or char2_slots is None or char3_slots is None or char4_slots is None:
+            return
+        for i, slot in enumerate(char1_slots):
+            if slot == 0:
+                empty_slots.appendleft(weapons_arrays_starts[0] + i)
+        for i, slot in enumerate(char2_slots):
+            if slot == 0:
+                empty_slots.appendleft(weapons_arrays_starts[1] + i)
+        for i, slot in enumerate(char3_slots):
+            if slot == 0:
+                empty_slots.appendleft(weapons_arrays_starts[2] + i)
+        for i, slot in enumerate(char4_slots):
+            if slot == 0:
+                empty_slots.appendleft(weapons_arrays_starts[3] + i)
+        while len(empty_slots) > 0 and len(self.weapons_queue) > 0:
+            current_slot = empty_slots.pop()
+            current_weapon = self.weapons_queue.pop()
+            await self.write_sram_guarded(ctx, current_slot, current_weapon)
+
+    async def process_armor_queue(self, ctx: "BizHawkClientContext"):
+        empty_slots = deque()
+        char1_slots = await self.read_sram_values_guarded(ctx, armors_arrays_starts[0], 4)
+        char2_slots = await self.read_sram_values_guarded(ctx, armors_arrays_starts[1], 4)
+        char3_slots = await self.read_sram_values_guarded(ctx, armors_arrays_starts[2], 4)
+        char4_slots = await self.read_sram_values_guarded(ctx, armors_arrays_starts[3], 4)
+        if char1_slots is None or char2_slots is None or char3_slots is None or char4_slots is None:
+            return
+        for i, slot in enumerate(char1_slots):
+            if slot == 0:
+                empty_slots.appendleft(armors_arrays_starts[0] + i)
+        for i, slot in enumerate(char2_slots):
+            if slot == 0:
+                empty_slots.appendleft(armors_arrays_starts[1] + i)
+        for i, slot in enumerate(char3_slots):
+            if slot == 0:
+                empty_slots.appendleft(armors_arrays_starts[2] + i)
+        for i, slot in enumerate(char4_slots):
+            if slot == 0:
+                empty_slots.appendleft(armors_arrays_starts[3] + i)
+        while len(empty_slots) > 0 and len(self.armor_queue) > 0:
+            current_slot = empty_slots.pop()
+            current_armor = self.armor_queue.pop()
+            await self.write_sram_guarded(ctx, current_slot, current_armor)
+
+
+    async def read_sram_value(self, ctx: "BizHawkClientContext", location: int):
+        value = ((await bizhawk.read(ctx.bizhawk_ctx, [(location, 1, self.sram)]))[0])
+        return int.from_bytes(value, "little")
+
+    async def read_sram_values_guarded(self, ctx: "BizHawkClientContext", location: int, size: int):
+        value = await bizhawk.guarded_read(ctx.bizhawk_ctx,
+                                           [(location, size, self.sram)],
+                                           [(status_a_location, [self.guard_character], self.sram)])
+        if value is None:
+            return None
+        return value[0]
+
+    async def read_sram_value_guarded(self, ctx: "BizHawkClientContext", location: int):
+        value = await bizhawk.guarded_read(ctx.bizhawk_ctx,
+                                           [(location, 1, self.sram)],
+                                           [(status_a_location, [self.guard_character], self.sram)])
+        if value is None:
+            return None
+        return int.from_bytes(value[0], "little")
+
+    async def read_rom(self, ctx: "BizHawkClientContext", location: int, size: int):
+        return (await bizhawk.read(ctx.bizhawk_ctx, [(location, size, self.rom)]))[0]
+
+    async def write_sram_guarded(self, ctx: "BizHawkClientContext", location: int, value: int):
+        return await bizhawk.guarded_write(ctx.bizhawk_ctx,
+                                           [(location, [value], self.sram)],
+                                           [(status_a_location, [self.guard_character], self.sram)])
+
+    async def write_sram_values_guarded(self, ctx: "BizHawkClientContext", write_list):
+        return await bizhawk.guarded_write(ctx.bizhawk_ctx,
+                                           write_list,
+                                           [(status_a_location, [self.guard_character], self.sram)])

worlds/ff1/Items.py

@@ -1,5 +1,5 @@
 import json
-from pathlib import Path
+import pkgutil
 from typing import Dict, Set, NamedTuple, List
 
 from BaseClasses import Item, ItemClassification
@@ -37,15 +37,13 @@ class FF1Items:
     _item_table_lookup: Dict[str, ItemData] = {}
 
     def _populate_item_table_from_data(self):
-        base_path = Path(__file__).parent
-        file_path = (base_path / "data/items.json").resolve()
-        with open(file_path) as file:
-            items = json.load(file)
-            # Hardcode progression and categories for now
-            self._item_table = [ItemData(name, code, "FF1Item", ItemClassification.progression if name in
-                                FF1_PROGRESSION_LIST else ItemClassification.useful if name in FF1_USEFUL_LIST else
-                                ItemClassification.filler) for name, code in items.items()]
-            self._item_table_lookup = {item.name: item for item in self._item_table}
+        file = pkgutil.get_data(__name__, "data/items.json").decode("utf-8")
+        items = json.loads(file)
+        # Hardcode progression and categories for now
+        self._item_table = [ItemData(name, code, "FF1Item", ItemClassification.progression if name in
+                            FF1_PROGRESSION_LIST else ItemClassification.useful if name in FF1_USEFUL_LIST else
+                            ItemClassification.filler) for name, code in items.items()]
+        self._item_table_lookup = {item.name: item for item in self._item_table}
 
     def _get_item_table(self) -> List[ItemData]:
         if not self._item_table or not self._item_table_lookup:

worlds/ff1/Locations.py

@@ -1,5 +1,5 @@
 import json
-from pathlib import Path
+import pkgutil
 from typing import Dict, NamedTuple, List, Optional
 
 from BaseClasses import Region, Location, MultiWorld
@@ -18,13 +18,11 @@ class FF1Locations:
     _location_table_lookup: Dict[str, LocationData] = {}
 
     def _populate_item_table_from_data(self):
-        base_path = Path(__file__).parent
-        file_path = (base_path / "data/locations.json").resolve()
-        with open(file_path) as file:
-            locations = json.load(file)
-            # Hardcode progression and categories for now
-            self._location_table = [LocationData(name, code) for name, code in locations.items()]
-            self._location_table_lookup = {item.name: item for item in self._location_table}
+        file = pkgutil.get_data(__name__, "data/locations.json")
+        locations = json.loads(file)
+        # Hardcode progression and categories for now
+        self._location_table = [LocationData(name, code) for name, code in locations.items()]
+        self._location_table_lookup = {item.name: item for item in self._location_table}
 
     def _get_location_table(self) -> List[LocationData]:
         if not self._location_table or not self._location_table_lookup:

worlds/ff1/__init__.py

@@ -7,6 +7,7 @@ from .Items import ItemData, FF1Items, FF1_STARTER_ITEMS, FF1_PROGRESSION_LIST,
 from .Locations import EventId, FF1Locations, generate_rule, CHAOS_TERMINATED_EVENT
 from .Options import FF1Options
 from ..AutoWorld import World, WebWorld
+from .Client import FF1Client
 
 
 class FF1Settings(settings.Group):

worlds/ff1/docs/en_Final Fantasy.md

@@ -22,11 +22,6 @@ All items can appear in other players worlds, including consumables, shards, wea
 
 ## What does another world's item look like in Final Fantasy
 
-All local and remote items appear the same. Final Fantasy will say that you received an item, then BOTH the client log and the
-emulator will display what was found external to the in-game text box.
+All local and remote items appear the same. Final Fantasy will say that you received an item, then the client log will 
+display what was found external to the in-game text box.
 
-## Unique Local Commands
-The following commands are only available when using the FF1Client for the Final Fantasy Randomizer.
-
-- `/nes` Shows the current status of the NES connection.
-- `/toggle_msgs` Toggle displaying messages in EmuHawk

worlds/ff1/docs/multiworld_en.md

@@ -2,10 +2,10 @@
 
 ## Required Software
 
-- The FF1Client
-    - Bundled with Archipelago: [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases)
-- The BizHawk emulator. Versions 2.3.1 and higher are supported. Version 2.7 is recommended
-    - [BizHawk at TASVideos](https://tasvideos.org/BizHawk)
+- BizHawk: [BizHawk Releases from TASVideos](https://tasvideos.org/BizHawk/ReleaseHistory)
+  - Detailed installation instructions for BizHawk can be found at the above link.
+  - Windows users must run the prerequisite installer first, which can also be found at the above link.
+- The built-in BizHawk client, which can be installed [here](https://github.com/ArchipelagoMW/Archipelago/releases)
 - Your legally obtained Final Fantasy (USA Edition) ROM file, probably named `Final Fantasy (USA).nes`. Neither
   Archipelago.gg nor the Final Fantasy Randomizer Community can supply you with this.
 
@@ -13,7 +13,7 @@
 
 1. Download and install the latest version of Archipelago.
     1. On Windows, download Setup.Archipelago.<HighestVersion\>.exe and run it
-2. Assign EmuHawk version 2.3.1 or higher as your default program for launching `.nes` files.
+2. Assign EmuHawk as your default program for launching `.nes` files.
     1. Extract your BizHawk folder to your Desktop, or somewhere you will remember. Below are optional additional steps
        for loading ROMs more conveniently
         1. Right-click on a ROM file and select **Open with...**
@@ -46,7 +46,7 @@ please refer to the [game agnostic setup guide](/tutorial/Archipelago/setup/en).
 
 Once the Archipelago server has been hosted:
 
-1. Navigate to your Archipelago install folder and run `ArchipelagoFF1Client.exe`
+1. Navigate to your Archipelago install folder and run `ArchipelagoBizhawkClient.exe`
 2. Notice the `/connect command` on the server hosting page (It should look like `/connect archipelago.gg:*****`
    where ***** are numbers)
 3. Type the connect command into the client OR add the port to the pre-populated address on the top bar (it should
@@ -54,16 +54,11 @@ Once the Archipelago server has been hosted:
 
 ### Running Your Game and Connecting to the Client Program
 
-1. Open EmuHawk 2.3.1 or higher and load your ROM OR click your ROM file if it is already associated with the
+1. Open EmuHawk and load your ROM OR click your ROM file if it is already associated with the
    extension `*.nes`
-2. Navigate to where you installed Archipelago, then to `data/lua`, and drag+drop the `connector_ff1.lua` script onto
-   the main EmuHawk window.
-    1. You could instead open the Lua Console manually, click `Script` 〉 `Open Script`, and navigate to
-       `connector_ff1.lua` with the file picker.
-    2. If it gives a `NLua.Exceptions.LuaScriptException: .\socket.lua:13: module 'socket.core' not found:` exception
-       close your emulator entirely, restart it and re-run these steps
-    3. If it says `Must use a version of BizHawk 2.3.1 or higher`, double-check your BizHawk version by clicking **
-       Help** -> **About**
+2. Navigate to where you installed Archipelago, then to `data/lua`, and drag+drop the `connector_bizhawk_generic.lua` 
+script onto the main EmuHawk window. You can also instead open the Lua Console manually, click `Script` 〉 `Open Script`,
+and navigate to `connector_bizhawk_generic.lua` with the file picker.
 
 ## Play the game
 

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/hylics2/__init__.py

@@ -127,6 +127,10 @@ class Hylics2World(World):
                 tv = tvs.pop()
                 self.get_location(tv).place_locked_item(self.create_item(gesture))
 
+    def get_pre_fill_items(self) -> List["Item"]:
+        if self.options.gesture_shuffle:
+            return [self.create_item(gesture["name"]) for gesture in Items.gesture_item_table.values()]
+        return []
 
     def fill_slot_data(self) -> Dict[str, Any]:
         slot_data: Dict[str, Any] = {

worlds/jakanddaxter/__init__.py

@@ -0,0 +1,512 @@
+# Python standard libraries
+from collections import defaultdict
+from math import ceil
+from typing import Any, ClassVar, Callable, Union, cast
+
+# Archipelago imports
+import settings
+from worlds.AutoWorld import World, WebWorld
+from worlds.LauncherComponents import components, Component, launch_subprocess, Type, icon_paths
+from BaseClasses import (Item,
+                         ItemClassification as ItemClass,
+                         Tutorial,
+                         CollectionState)
+from Options import OptionGroup
+
+# Jak imports
+from . import options
+from .game_id import jak1_id, jak1_name, jak1_max
+from .items import (JakAndDaxterItem,
+                    OrbAssoc,
+                    item_table,
+                    cell_item_table,
+                    scout_item_table,
+                    special_item_table,
+                    move_item_table,
+                    orb_item_table,
+                    trap_item_table)
+from .levels import level_table, level_table_with_global
+from .locations import (JakAndDaxterLocation,
+                        location_table,
+                        cell_location_table,
+                        scout_location_table,
+                        special_location_table,
+                        cache_location_table,
+                        orb_location_table)
+from .regions import create_regions
+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,
+                   special_locations as specials,
+                   orb_cache_locations as caches,
+                   orb_locations as orbs)
+from .regs.region_base import JakAndDaxterRegion
+
+
+def launch_client():
+    from . import client
+    launch_subprocess(client.launch, name="JakAndDaxterClient")
+
+
+components.append(Component("Jak and Daxter Client",
+                            func=launch_client,
+                            component_type=Type.CLIENT,
+                            icon="precursor_orb"))
+
+icon_paths["precursor_orb"] = f"ap:{__name__}/icons/precursor_orb.png"
+
+
+class JakAndDaxterSettings(settings.Group):
+    class RootDirectory(settings.UserFolderPath):
+        """Path to folder containing the ArchipelaGOAL mod executables (gk.exe and goalc.exe).
+        Ensure this path contains forward slashes (/) only. This setting only applies if
+        Auto Detect Root Directory is set to false."""
+        description = "ArchipelaGOAL Root Directory"
+
+    class AutoDetectRootDirectory(settings.Bool):
+        """Attempt to find the OpenGOAL installation and the mod executables (gk.exe and goalc.exe)
+        automatically. If set to true, the ArchipelaGOAL Root Directory setting is ignored."""
+        description = "ArchipelaGOAL Auto Detect Root Directory"
+
+    class EnforceFriendlyOptions(settings.Bool):
+        """Enforce friendly player options in both single and multiplayer seeds. Disabling this allows for
+        more disruptive and challenging options, but may impact seed generation. Use at your own risk!"""
+        description = "ArchipelaGOAL Enforce Friendly Options"
+
+    root_directory: RootDirectory = RootDirectory(
+        "%programfiles%/OpenGOAL-Launcher/features/jak1/mods/JakMods/archipelagoal")
+    # Don't ever change these type hints again.
+    auto_detect_root_directory: Union[AutoDetectRootDirectory, bool] = True
+    enforce_friendly_options: Union[EnforceFriendlyOptions, bool] = True
+
+
+class JakAndDaxterWebWorld(WebWorld):
+    setup_en = Tutorial(
+        "Multiworld Setup Guide",
+        "A guide to setting up ArchipelaGOAL (Archipelago on OpenGOAL).",
+        "English",
+        "setup_en.md",
+        "setup/en",
+        ["markustulliuscicero"]
+    )
+
+    tutorials = [setup_en]
+    bug_report_page = "https://github.com/ArchipelaGOAL/Archipelago/issues"
+
+    option_groups = [
+        OptionGroup("Orbsanity", [
+            options.EnableOrbsanity,
+            options.GlobalOrbsanityBundleSize,
+            options.PerLevelOrbsanityBundleSize,
+        ]),
+        OptionGroup("Power Cell Counts", [
+            options.EnableOrderedCellCounts,
+            options.FireCanyonCellCount,
+            options.MountainPassCellCount,
+            options.LavaTubeCellCount,
+        ]),
+        OptionGroup("Orb Trade Counts", [
+            options.CitizenOrbTradeAmount,
+            options.OracleOrbTradeAmount,
+        ]),
+        OptionGroup("Traps", [
+            options.FillerPowerCellsReplacedWithTraps,
+            options.FillerOrbBundlesReplacedWithTraps,
+            options.TrapEffectDuration,
+            options.TrapWeights,
+        ]),
+    ]
+
+
+class JakAndDaxterWorld(World):
+    """
+    Jak and Daxter: The Precursor Legacy is a 2001 action platformer developed by Naughty Dog
+    for the PlayStation 2. The game follows the eponymous protagonists, a young boy named Jak
+    and his friend Daxter, who has been transformed into an ottsel. With the help of Samos
+    the Sage of Green Eco and his daughter Keira, the pair travel north in search of a cure for Daxter,
+    discovering artifacts created by an ancient race known as the Precursors along the way. When the
+    rogue sages Gol and Maia Acheron plan to flood the world with Dark Eco, they must stop their evil plan
+    and save the world.
+    """
+    # ID, name, version
+    game = jak1_name
+    required_client_version = (0, 5, 0)
+
+    # Options
+    settings: ClassVar[JakAndDaxterSettings]
+    options_dataclass = options.JakAndDaxterOptions
+    options: options.JakAndDaxterOptions
+
+    # Web world
+    web = JakAndDaxterWebWorld()
+
+    # Stored as {ID: Name} pairs, these must now be swapped to {Name: ID} pairs.
+    # Remember, the game ID and various offsets for each item type have already been calculated.
+    item_name_to_id = {name: k for k, name in item_table.items()}
+    location_name_to_id = {name: k for k, name in location_table.items()}
+    item_name_groups = {
+        "Power Cells": set(cell_item_table.values()),
+        "Scout Flies": set(scout_item_table.values()),
+        "Specials": set(special_item_table.values()),
+        "Moves": set(move_item_table.values()),
+        "Precursor Orbs": set(orb_item_table.values()),
+        "Traps": set(trap_item_table.values()),
+    }
+    location_name_groups = {
+        "Power Cells": set(cell_location_table.values()),
+        "Power Cells - GR": set(cells.locGR_cellTable.values()),
+        "Power Cells - SV": set(cells.locSV_cellTable.values()),
+        "Power Cells - FJ": set(cells.locFJ_cellTable.values()),
+        "Power Cells - SB": set(cells.locSB_cellTable.values()),
+        "Power Cells - MI": set(cells.locMI_cellTable.values()),
+        "Power Cells - FC": set(cells.locFC_cellTable.values()),
+        "Power Cells - RV": set(cells.locRV_cellTable.values()),
+        "Power Cells - PB": set(cells.locPB_cellTable.values()),
+        "Power Cells - LPC": set(cells.locLPC_cellTable.values()),
+        "Power Cells - BS": set(cells.locBS_cellTable.values()),
+        "Power Cells - MP": set(cells.locMP_cellTable.values()),
+        "Power Cells - VC": set(cells.locVC_cellTable.values()),
+        "Power Cells - SC": set(cells.locSC_cellTable.values()),
+        "Power Cells - SM": set(cells.locSM_cellTable.values()),
+        "Power Cells - LT": set(cells.locLT_cellTable.values()),
+        "Power Cells - GMC": set(cells.locGMC_cellTable.values()),
+        "Scout Flies": set(scout_location_table.values()),
+        "Scout Flies - GR": set(scouts.locGR_scoutTable.values()),
+        "Scout Flies - SV": set(scouts.locSV_scoutTable.values()),
+        "Scout Flies - FJ": set(scouts.locFJ_scoutTable.values()),
+        "Scout Flies - SB": set(scouts.locSB_scoutTable.values()),
+        "Scout Flies - MI": set(scouts.locMI_scoutTable.values()),
+        "Scout Flies - FC": set(scouts.locFC_scoutTable.values()),
+        "Scout Flies - RV": set(scouts.locRV_scoutTable.values()),
+        "Scout Flies - PB": set(scouts.locPB_scoutTable.values()),
+        "Scout Flies - LPC": set(scouts.locLPC_scoutTable.values()),
+        "Scout Flies - BS": set(scouts.locBS_scoutTable.values()),
+        "Scout Flies - MP": set(scouts.locMP_scoutTable.values()),
+        "Scout Flies - VC": set(scouts.locVC_scoutTable.values()),
+        "Scout Flies - SC": set(scouts.locSC_scoutTable.values()),
+        "Scout Flies - SM": set(scouts.locSM_scoutTable.values()),
+        "Scout Flies - LT": set(scouts.locLT_scoutTable.values()),
+        "Scout Flies - GMC": set(scouts.locGMC_scoutTable.values()),
+        "Specials": set(special_location_table.values()),
+        "Orb Caches": set(cache_location_table.values()),
+        "Precursor Orbs": set(orb_location_table.values()),
+        "Precursor Orbs - GR": set(orbs.locGR_orbBundleTable.values()),
+        "Precursor Orbs - SV": set(orbs.locSV_orbBundleTable.values()),
+        "Precursor Orbs - FJ": set(orbs.locFJ_orbBundleTable.values()),
+        "Precursor Orbs - SB": set(orbs.locSB_orbBundleTable.values()),
+        "Precursor Orbs - MI": set(orbs.locMI_orbBundleTable.values()),
+        "Precursor Orbs - FC": set(orbs.locFC_orbBundleTable.values()),
+        "Precursor Orbs - RV": set(orbs.locRV_orbBundleTable.values()),
+        "Precursor Orbs - PB": set(orbs.locPB_orbBundleTable.values()),
+        "Precursor Orbs - LPC": set(orbs.locLPC_orbBundleTable.values()),
+        "Precursor Orbs - BS": set(orbs.locBS_orbBundleTable.values()),
+        "Precursor Orbs - MP": set(orbs.locMP_orbBundleTable.values()),
+        "Precursor Orbs - VC": set(orbs.locVC_orbBundleTable.values()),
+        "Precursor Orbs - SC": set(orbs.locSC_orbBundleTable.values()),
+        "Precursor Orbs - SM": set(orbs.locSM_orbBundleTable.values()),
+        "Precursor Orbs - LT": set(orbs.locLT_orbBundleTable.values()),
+        "Precursor Orbs - GMC": set(orbs.locGMC_orbBundleTable.values()),
+        "Trades": {location_table[cells.to_ap_id(k)] for k in
+                   {11, 12, 31, 32, 33, 96, 97, 98, 99, 13, 14, 34, 35, 100, 101}},
+        "'Free 7 Scout Flies' Power Cells": set(cells.loc7SF_cellTable.values()),
+    }
+
+    # These functions and variables are Options-driven, keep them as instance variables here so that we don't clog up
+    # the seed generation routines with options checking. So we set these once, and then just use them as needed.
+    can_trade: Callable[[CollectionState, int, int | None], bool]
+    total_orbs: int = 2000
+    orb_bundle_item_name: str = ""
+    orb_bundle_size: int = 0
+    total_trade_orbs: int = 0
+    total_prog_orb_bundles: int = 0
+    total_trap_orb_bundles: int = 0
+    total_filler_orb_bundles: int = 0
+    total_power_cells: int = 101
+    total_prog_cells: int = 0
+    total_trap_cells: int = 0
+    total_filler_cells: int = 0
+    power_cell_thresholds: list[int]
+    power_cell_thresholds_minus_one: list[int]
+    trap_weights: tuple[list[str], list[int]]
+
+    # Store these dictionaries for speed improvements.
+    level_to_regions: dict[str, list[JakAndDaxterRegion]]  # Contains all levels and regions.
+    level_to_orb_regions: dict[str, list[JakAndDaxterRegion]]  # Contains only regions which contain orbs.
+
+    # Handles various options validation, rules enforcement, and caching of important information.
+    def generate_early(self) -> None:
+
+        # Initialize the level-region dictionary.
+        self.level_to_regions = defaultdict(list)
+        self.level_to_orb_regions = defaultdict(list)
+
+        # Cache the power cell threshold values for quicker reference.
+        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.
+        ]
+
+        # Order the thresholds ascending and set the options values to the new order.
+        if self.options.enable_ordered_cell_counts:
+            self.power_cell_thresholds.sort()
+            self.options.fire_canyon_cell_count.value = self.power_cell_thresholds[0]
+            self.options.mountain_pass_cell_count.value = self.power_cell_thresholds[1]
+            self.options.lava_tube_cell_count.value = self.power_cell_thresholds[2]
+
+        # 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 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:
+                # 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.
+        if self.options.jak_completion_condition == options.CompletionCondition.option_open_100_cell_door:
+            self.total_prog_cells = 100
+        else:
+            self.total_prog_cells = max(self.power_cell_thresholds[:3])
+        non_prog_cells = self.total_power_cells - self.total_prog_cells
+        self.total_trap_cells = min(self.options.filler_power_cells_replaced_with_traps.value, non_prog_cells)
+        self.options.filler_power_cells_replaced_with_traps.value = self.total_trap_cells
+        self.total_filler_cells = non_prog_cells - self.total_trap_cells
+
+        # 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
+            self.orb_bundle_item_name = orb_item_table[self.orb_bundle_size]
+        elif self.options.enable_orbsanity == options.EnableOrbsanity.option_global:
+            self.orb_bundle_size = self.options.global_orbsanity_bundle_size.value
+            self.orb_bundle_item_name = orb_item_table[self.orb_bundle_size]
+        else:
+            self.orb_bundle_size = 0
+            self.orb_bundle_item_name = ""
+
+        # Calculate the number of orb bundles needed for trades, the number being replaced by traps,
+        # and the number of remaining filler. If Orbsanity is off, default values of 0 will prevail for all.
+        if self.orb_bundle_size > 0:
+            total_orb_bundles = self.total_orbs // self.orb_bundle_size
+            self.total_prog_orb_bundles = ceil(self.total_trade_orbs / self.orb_bundle_size)
+            non_prog_orb_bundles = total_orb_bundles - self.total_prog_orb_bundles
+            self.total_trap_orb_bundles = min(self.options.filler_orb_bundles_replaced_with_traps.value,
+                                              non_prog_orb_bundles)
+            self.options.filler_orb_bundles_replaced_with_traps.value = self.total_trap_orb_bundles
+            self.total_filler_orb_bundles = non_prog_orb_bundles - self.total_trap_orb_bundles
+        else:
+            self.options.filler_orb_bundles_replaced_with_traps.value = 0
+
+        self.trap_weights = self.options.trap_weights.weights_pair
+
+        # Options drive which trade rules to use, so they need to be setup before we create_regions.
+        set_orb_trade_rule(self)
+
+    # This will also set Locations, Location access rules, Region access rules, etc.
+    def create_regions(self) -> None:
+        create_regions(self)
+
+        # Don't forget to add the created regions to the multiworld!
+        for level in self.level_to_regions:
+            self.multiworld.regions.extend(self.level_to_regions[level])
+
+            # As a lazy measure, let's also fill level_to_orb_regions here.
+            # This should help speed up orbsanity calculations.
+            self.level_to_orb_regions[level] = [reg for reg in self.level_to_regions[level] if reg.orb_count > 0]
+
+        # from Utils import visualize_regions
+        # visualize_regions(self.multiworld.get_region("Menu", self.player), "jakanddaxter.puml")
+
+    def item_data_helper(self, item: int) -> list[tuple[int, ItemClass, OrbAssoc, int]]:
+        """
+        Helper function to reuse some nasty if/else trees. This outputs a list of pairs of item count and class.
+        For instance, not all 101 power cells need to be marked progression if you only need 72 to beat the game.
+        So we will have 72 Progression Power Cells, and 29 Filler Power Cells.
+        """
+        data: list[tuple[int, ItemClass, OrbAssoc, int]] = []
+
+        # Make N Power Cells. We only want AP's Progression Fill routine to handle the amount of cells we need
+        # to reach the furthest possible region. Even for early completion goals, all areas in the game must be
+        # reachable or generation will fail. TODO - Option-driven region creation would be an enormous refactor.
+        if item in range(jak1_id, jak1_id + scouts.fly_offset):
+            data.append((self.total_prog_cells, ItemClass.progression_skip_balancing, OrbAssoc.IS_POWER_CELL, 0))
+            data.append((self.total_filler_cells, ItemClass.filler, OrbAssoc.IS_POWER_CELL, 0))
+
+        # Make 7 Scout Flies per level.
+        elif item in range(jak1_id + scouts.fly_offset, jak1_id + specials.special_offset):
+            data.append((7, ItemClass.progression_skip_balancing, OrbAssoc.NEVER_UNLOCKS_ORBS, 0))
+
+        # Make only 1 of each Special Item.
+        elif item in range(jak1_id + specials.special_offset, jak1_id + caches.orb_cache_offset):
+            data.append((1, ItemClass.progression | ItemClass.useful, OrbAssoc.ALWAYS_UNLOCKS_ORBS, 0))
+
+        # Make only 1 of each Move Item.
+        elif item in range(jak1_id + caches.orb_cache_offset, jak1_id + orbs.orb_offset):
+            data.append((1, ItemClass.progression | ItemClass.useful, OrbAssoc.ALWAYS_UNLOCKS_ORBS, 0))
+
+        # Make N Precursor Orb bundles. Like Power Cells, only a fraction of these will be marked as Progression
+        # with the remainder as Filler, but they are still entirely fungible. See collect function for why these
+        # are OrbAssoc.NEVER_UNLOCKS_ORBS.
+        elif item in range(jak1_id + orbs.orb_offset, jak1_max - max(trap_item_table)):
+            data.append((self.total_prog_orb_bundles, ItemClass.progression_skip_balancing,
+                         OrbAssoc.NEVER_UNLOCKS_ORBS, self.orb_bundle_size))
+            data.append((self.total_filler_orb_bundles, ItemClass.filler,
+                         OrbAssoc.NEVER_UNLOCKS_ORBS, self.orb_bundle_size))
+
+        # We will manually create trap items as needed.
+        elif item in range(jak1_max - max(trap_item_table), jak1_max):
+            data.append((0, ItemClass.trap, OrbAssoc.NEVER_UNLOCKS_ORBS, 0))
+
+        # We will manually create filler items as needed.
+        elif item == jak1_max:
+            data.append((0, ItemClass.filler, OrbAssoc.NEVER_UNLOCKS_ORBS, 0))
+
+        # If we try to make items with ID's higher than we've defined, something has gone wrong.
+        else:
+            raise KeyError(f"Tried to fill item pool with unknown ID {item}.")
+
+        return data
+
+    def create_items(self) -> None:
+        items_made: int = 0
+        for item_name in self.item_name_to_id:
+            item_id = self.item_name_to_id[item_name]
+
+            # Handle Move Randomizer option.
+            # If it is OFF, put all moves in your starting inventory instead of the item pool,
+            # then fill the item pool with a corresponding amount of filler items.
+            if item_name in self.item_name_groups["Moves"] and not self.options.enable_move_randomizer:
+                self.multiworld.push_precollected(self.create_item(item_name))
+                self.multiworld.itempool.append(self.create_filler())
+                items_made += 1
+                continue
+
+            # Handle Orbsanity option.
+            # If it is OFF, don't add any orb bundles to the item pool, period.
+            # If it is ON, don't add any orb bundles that don't match the chosen option.
+            if (item_name in self.item_name_groups["Precursor Orbs"]
+                    and (self.options.enable_orbsanity == options.EnableOrbsanity.option_off
+                         or item_name != self.orb_bundle_item_name)):
+                continue
+
+            # Skip Traps for now.
+            if item_name in self.item_name_groups["Traps"]:
+                continue
+
+            # In almost every other scenario, do this. Not all items with the same name will have the same item class.
+            data = self.item_data_helper(item_id)
+            for (count, classification, orb_assoc, orb_amount) in data:
+                self.multiworld.itempool += [JakAndDaxterItem(item_name, classification, item_id,
+                                                              self.player, orb_assoc, orb_amount)
+                                             for _ in range(count)]
+                items_made += count
+
+        # Handle Traps (for real).
+        # Manually fill the item pool with a weighted assortment of trap items, equal to the sum of
+        # total_trap_cells + total_trap_orb_bundles. Only do this if one or more traps have weights > 0.
+        names, weights = self.trap_weights
+        if sum(weights):
+            total_traps = self.total_trap_cells + self.total_trap_orb_bundles
+            trap_list = self.random.choices(names, weights=weights, k=total_traps)
+            self.multiworld.itempool += [self.create_item(trap_name) for trap_name in trap_list]
+            items_made += total_traps
+
+        # Handle Unfilled Locations.
+        # Add an amount of filler items equal to the number of locations yet to be filled.
+        # This is the final set of items we will add to the pool.
+        all_regions = self.multiworld.get_regions(self.player)
+        total_locations = sum(reg.location_count for reg in cast(list[JakAndDaxterRegion], all_regions))
+        total_filler = total_locations - items_made
+        self.multiworld.itempool += [self.create_filler() for _ in range(total_filler)]
+
+    def create_item(self, name: str) -> Item:
+        item_id = self.item_name_to_id[name]
+
+        # Use first tuple (will likely be the most important).
+        _, classification, orb_assoc, orb_amount = self.item_data_helper(item_id)[0]
+        return JakAndDaxterItem(name, classification, item_id, self.player, orb_assoc, orb_amount)
+
+    def get_filler_item_name(self) -> str:
+        return "Green Eco Pill"
+
+    def collect(self, state: CollectionState, item: JakAndDaxterItem) -> bool:
+        change = super().collect(state, item)
+        if change:
+            # Orbsanity as an option is no-factor to these conditions. Matching the item name implies Orbsanity is ON,
+            # so we don't need to check the option. When Orbsanity is OFF, there won't even be any orb bundle items
+            # to collect.
+
+            # Orb items do not intrinsically unlock anything that contains more Reachable Orbs, so they do not need to
+            # set the cache to stale. They just change how many orbs you have to trade with.
+            if item.orb_amount > 0:
+                state.prog_items[self.player]["Tradeable Orbs"] += self.orb_bundle_size  # Give a bundle of Trade Orbs
+
+            # Power Cells DO unlock new regions that contain more Reachable Orbs - the connector levels and new
+            # hub levels - BUT they only do that when you have a number of them equal to one of the threshold values.
+            elif (item.orb_assoc == OrbAssoc.ALWAYS_UNLOCKS_ORBS
+                  or (item.orb_assoc == OrbAssoc.IS_POWER_CELL
+                      and state.count("Power Cell", self.player) in self.power_cell_thresholds)):
+                state.prog_items[self.player]["Reachable Orbs Fresh"] = False
+
+            # However, every other item that does not have an appropriate OrbAssoc that changes the CollectionState
+            # should NOT set the cache to stale, because they did not make it possible to reach more orb locations
+            # (level unlocks, region unlocks, etc.).
+        return change
+
+    def remove(self, state: CollectionState, item: JakAndDaxterItem) -> bool:
+        change = super().remove(state, item)
+        if change:
+
+            # Do the same thing we did in collect, except subtract trade orbs instead of add.
+            if item.orb_amount > 0:
+                state.prog_items[self.player]["Tradeable Orbs"] -= self.orb_bundle_size  # Take a bundle of Trade Orbs
+
+            # Ditto Power Cells, but check thresholds - 1, because we potentially crossed the threshold in the opposite
+            # direction. E.g. we've removed the 20th power cell, our count is now 19, so we should stale the cache.
+            elif (item.orb_assoc == OrbAssoc.ALWAYS_UNLOCKS_ORBS
+                  or (item.orb_assoc == OrbAssoc.IS_POWER_CELL
+                      and state.count("Power Cell", self.player) in self.power_cell_thresholds_minus_one)):
+                state.prog_items[self.player]["Reachable Orbs Fresh"] = False
+
+        return change
+
+    def fill_slot_data(self) -> dict[str, Any]:
+        options_dict = self.options.as_dict("enable_move_randomizer",
+                                            "enable_orbsanity",
+                                            "global_orbsanity_bundle_size",
+                                            "level_orbsanity_bundle_size",
+                                            "fire_canyon_cell_count",
+                                            "mountain_pass_cell_count",
+                                            "lava_tube_cell_count",
+                                            "citizen_orb_trade_amount",
+                                            "oracle_orb_trade_amount",
+                                            "filler_power_cells_replaced_with_traps",
+                                            "filler_orb_bundles_replaced_with_traps",
+                                            "trap_effect_duration",
+                                            "trap_weights",
+                                            "jak_completion_condition",
+                                            "require_punch_for_klaww",
+                                            )
+        return options_dict