Fix using the wrong variable for slot lookup

.github/pyright-config.json

@@ -2,7 +2,6 @@
   "include": [
     "../BizHawkClient.py",
     "../Patch.py",
-    "../test/param.py",
     "../test/general/test_groups.py",
     "../test/general/test_helpers.py",
     "../test/general/test_memory.py",

.github/workflows/analyze-modified-files.yml

@@ -65,7 +65,7 @@ jobs:
         continue-on-error: false
         if: env.diff != '' && matrix.task == 'flake8'
         run: |
-          flake8 --count --select=E9,F63,F7,F82 --ignore F824 --show-source --statistics ${{ env.diff }}
+          flake8 --count --select=E9,F63,F7,F82 --show-source --statistics ${{ env.diff }}
 
       - name: "flake8: Lint modified files"
         continue-on-error: true

.github/workflows/build.yml

@@ -21,17 +21,12 @@ env:
   ENEMIZER_VERSION: 7.1
   APPIMAGETOOL_VERSION: 13
 
-permissions:  # permissions required for attestation
-  id-token: 'write'
-  attestations: 'write'
-
 jobs:
   # build-release-macos: # LF volunteer
 
-  build-win: # RCs and releases may still be built and signed by hand
+  build-win: # RCs will still be built and signed by hand
     runs-on: windows-latest
     steps:
-      # - copy code below to release.yml -
       - uses: actions/checkout@v4
       - name: Install python
         uses: actions/setup-python@v5
@@ -70,18 +65,6 @@ jobs:
           $contents = Get-ChildItem -Path setups/*.exe -Force -Recurse
           $SETUP_NAME=$contents[0].Name
           echo "SETUP_NAME=$SETUP_NAME" >> $Env:GITHUB_ENV
-      # - copy code above to release.yml -
-      - name: Attest Build
-        if: ${{ github.event_name == 'workflow_dispatch' }}
-        uses: actions/attest-build-provenance@v2
-        with:
-          subject-path: |
-            build/exe.*/ArchipelagoLauncher.exe
-            build/exe.*/ArchipelagoLauncherDebug.exe
-            build/exe.*/ArchipelagoGenerate.exe
-            build/exe.*/ArchipelagoServer.exe
-            dist/${{ env.ZIP_NAME }}
-            setups/${{ env.SETUP_NAME }}
       - name: Check build loads expected worlds
         shell: bash
         run: |
@@ -116,8 +99,8 @@ jobs:
           if-no-files-found: error
           retention-days: 7  # keep for 7 days, should be enough
 
-  build-ubuntu2204:
+  build-ubuntu2004:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-20.04
     steps:
       # - copy code below to release.yml -
       - uses: actions/checkout@v4
@@ -149,7 +132,7 @@ jobs:
           # charset-normalizer was somehow incomplete in the github runner
           "${{ env.PYTHON }}" -m venv venv
           source venv/bin/activate
-          "${{ env.PYTHON }}" -m pip install --upgrade pip "PyGObject<3.51.0" charset-normalizer
+          "${{ env.PYTHON }}" -m pip install --upgrade pip PyGObject charset-normalizer
           python setup.py build_exe --yes bdist_appimage --yes
           echo -e "setup.py build output:\n `ls build`"
           echo -e "setup.py dist output:\n `ls dist`"
@@ -159,16 +142,6 @@ jobs:
           echo "APPIMAGE_NAME=$APPIMAGE_NAME" >> $GITHUB_ENV
           echo "TAR_NAME=$TAR_NAME" >> $GITHUB_ENV
       # - copy code above to release.yml -
-      - name: Attest Build
-        if: ${{ github.event_name == 'workflow_dispatch' }}
-        uses: actions/attest-build-provenance@v2
-        with:
-          subject-path: |
-            build/exe.*/ArchipelagoLauncher
-            build/exe.*/ArchipelagoGenerate
-            build/exe.*/ArchipelagoServer
-            dist/${{ env.APPIMAGE_NAME }}*
-            dist/${{ env.TAR_NAME }}
       - name: Build Again
         run: |
           source venv/bin/activate

.github/workflows/ctest.yml

@@ -11,7 +11,7 @@ on:
       - '**.hh?'
       - '**.hpp'
       - '**.hxx'
-      - '**/CMakeLists.txt'
+      - '**.CMakeLists'
       - '.github/workflows/ctest.yml'
   pull_request:
     paths:
@@ -21,7 +21,7 @@ on:
       - '**.hh?'
       - '**.hpp'
       - '**.hxx'
-      - '**/CMakeLists.txt'
+      - '**.CMakeLists'
       - '.github/workflows/ctest.yml'
 
 jobs:
@@ -36,9 +36,9 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - uses: ilammy/msvc-dev-cmd@0b201ec74fa43914dc39ae48a89fd1d8cb592756
+    - uses: ilammy/msvc-dev-cmd@v1
       if: startsWith(matrix.os,'windows')
-    - uses: Bacondish2023/setup-googletest@49065d1f7a6d21f6134864dd65980fe5dbe06c73
+    - uses: Bacondish2023/setup-googletest@v1
       with:
         build-type: 'Release'
     - name: Build tests

.github/workflows/release.yml

@@ -11,11 +11,6 @@ env:
   ENEMIZER_VERSION: 7.1
   APPIMAGETOOL_VERSION: 13
 
-permissions:  # permissions required for attestation
-  id-token: 'write'
-  attestations: 'write'
-  contents: 'write'  # additionally required for release
-
 jobs:
   create-release:
     runs-on: ubuntu-latest
@@ -31,79 +26,11 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+  # build-release-windows: # this is done by hand because of signing
   # build-release-macos: # LF volunteer
 
-  build-release-win:
+  build-release-ubuntu2004:
-    runs-on: windows-latest
+    runs-on: ubuntu-20.04
-    if: ${{ true }}  # change to false to skip if release is built by hand
-    needs: create-release
-    steps:
-      - name: Set env
-        shell: bash
-        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
-      # - code below copied from build.yml -
-      - uses: actions/checkout@v4
-      - name: Install python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '~3.12.7'
-          check-latest: true
-      - name: Download run-time dependencies
-        run: |
-          Invoke-WebRequest -Uri https://github.com/Ijwu/Enemizer/releases/download/${Env:ENEMIZER_VERSION}/win-x64.zip -OutFile enemizer.zip
-          Expand-Archive -Path enemizer.zip -DestinationPath EnemizerCLI -Force
-          choco install innosetup --version=6.2.2 --allow-downgrade
-      - name: Build
-        run: |
-          python -m pip install --upgrade pip
-          python setup.py build_exe --yes
-          if ( $? -eq $false ) {
-            Write-Error "setup.py failed!"
-            exit 1
-          }
-          $NAME="$(ls build | Select-String -Pattern 'exe')".Split('.',2)[1]
-          $ZIP_NAME="Archipelago_$NAME.7z"
-          echo "$NAME -> $ZIP_NAME"
-          echo "ZIP_NAME=$ZIP_NAME" >> $Env:GITHUB_ENV
-          New-Item -Path dist -ItemType Directory -Force
-          cd build
-          Rename-Item "exe.$NAME" Archipelago
-          7z a -mx=9 -mhe=on -ms "../dist/$ZIP_NAME" Archipelago
-          Rename-Item Archipelago "exe.$NAME"  # inno_setup.iss expects the original name
-      - name: Build Setup
-        run: |
-          & "${env:ProgramFiles(x86)}\Inno Setup 6\iscc.exe" inno_setup.iss /DNO_SIGNTOOL
-          if ( $? -eq $false ) {
-            Write-Error "Building setup failed!"
-            exit 1
-          }
-          $contents = Get-ChildItem -Path setups/*.exe -Force -Recurse
-          $SETUP_NAME=$contents[0].Name
-          echo "SETUP_NAME=$SETUP_NAME" >> $Env:GITHUB_ENV
-      # - code above copied from build.yml -
-      - name: Attest Build
-        uses: actions/attest-build-provenance@v2
-        with:
-          subject-path: |
-            build/exe.*/ArchipelagoLauncher.exe
-            build/exe.*/ArchipelagoLauncherDebug.exe
-            build/exe.*/ArchipelagoGenerate.exe
-            build/exe.*/ArchipelagoServer.exe
-            setups/*
-      - name: Add to Release
-        uses: softprops/action-gh-release@975c1b265e11dd76618af1c374e7981f9a6ff44a
-        with:
-          draft: true  # see above
-          prerelease: false
-          name: Archipelago ${{ env.RELEASE_VERSION }}
-          files: |
-            setups/*
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-  build-release-ubuntu2204:
-    runs-on: ubuntu-22.04
-    needs: create-release
     steps:
       - name: Set env
         run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
@@ -137,7 +64,7 @@ jobs:
           # charset-normalizer was somehow incomplete in the github runner
           "${{ env.PYTHON }}" -m venv venv
           source venv/bin/activate
-          "${{ env.PYTHON }}" -m pip install --upgrade pip "PyGObject<3.51.0" charset-normalizer
+          "${{ env.PYTHON }}" -m pip install --upgrade pip PyGObject charset-normalizer
           python setup.py build_exe --yes bdist_appimage --yes
           echo -e "setup.py build output:\n `ls build`"
           echo -e "setup.py dist output:\n `ls dist`"
@@ -147,14 +74,6 @@ jobs:
           echo "APPIMAGE_NAME=$APPIMAGE_NAME" >> $GITHUB_ENV
           echo "TAR_NAME=$TAR_NAME" >> $GITHUB_ENV
       # - code above copied from build.yml -
-      - name: Attest Build
-        uses: actions/attest-build-provenance@v2
-        with:
-          subject-path: |
-            build/exe.*/ArchipelagoLauncher
-            build/exe.*/ArchipelagoGenerate
-            build/exe.*/ArchipelagoServer
-            dist/*
       - name: Add to Release
         uses: softprops/action-gh-release@975c1b265e11dd76618af1c374e7981f9a6ff44a
         with:

.gitignore

@@ -4,13 +4,11 @@
 *_Spoiler.txt
 *.bmbp
 *.apbp
-*.apcivvi
 *.apl2ac
 *.apm3
 *.apmc
 *.apz5
 *.aptloz
-*.aptww
 *.apemerald
 *.pyc
 *.pyd

AdventureClient.py

@@ -511,7 +511,7 @@ if __name__ == '__main__':
 
     import colorama
 
-    colorama.just_fix_windows_console()
+    colorama.init()
 
     asyncio.run(main())
     colorama.deinit()

BaseClasses.py

@@ -223,7 +223,7 @@ class MultiWorld():
                               AutoWorld.AutoWorldRegister.world_types[self.game[player]].options_dataclass.type_hints}
         for option_key in all_keys:
             option = Utils.DeprecateDict(f"Getting options from multiworld is now deprecated. "
-                                         f"Please use `self.options.{option_key}` instead.", True)
+                                         f"Please use `self.options.{option_key}` instead.")
             option.update(getattr(args, option_key, {}))
             setattr(self, option_key, option)
 
@@ -616,7 +616,7 @@ class MultiWorld():
         locations: Set[Location] = set()
         events: Set[Location] = set()
         for location in self.get_filled_locations():
-            if type(location.item.code) is int and type(location.address) is int:
+            if type(location.item.code) is int:
                 locations.add(location)
             else:
                 events.add(location)
@@ -1022,6 +1022,9 @@ class Entrance:
     connected_region: Optional[Region] = None
     randomization_group: int
     randomization_type: EntranceType
+    # LttP specific, TODO: should make a LttPEntrance
+    addresses = None
+    target = None
 
     def __init__(self, player: int, name: str = "", parent: Optional[Region] = None,
                  randomization_group: int = 0, randomization_type: EntranceType = EntranceType.ONE_WAY) -> None:
@@ -1040,8 +1043,10 @@ class Entrance:
 
         return False
 
-    def connect(self, region: Region) -> None:
+    def connect(self, region: Region, addresses: Any = None, target: Any = None) -> None:
         self.connected_region = region
+        self.target = target
+        self.addresses = addresses
         region.entrances.append(self)
 
     def is_valid_source_transition(self, er_state: "ERPlacementState") -> bool:
@@ -1101,9 +1106,6 @@ class Region:
         def __len__(self) -> int:
             return self._list.__len__()
 
-        def __iter__(self):
-            return iter(self._list)
-
         # This seems to not be needed, but that's a bit suspicious.
         # def __del__(self):
         #     self.clear()
@@ -1198,48 +1200,6 @@ class Region:
         for location, address in locations.items():
             self.locations.append(location_type(self.player, location, address, self))
 
-    def add_event(
-        self,
-        location_name: str,
-        item_name: str | None = None,
-        rule: Callable[[CollectionState], bool] | None = None,
-        location_type: type[Location] | None = None,
-        item_type: type[Item] | None = None,
-        show_in_spoiler: bool = True,
-    ) -> Item:
-        """
-        Adds an event location/item pair to the region.
-
-        :param location_name: Name for the event location.
-        :param item_name: Name for the event item. If not provided, defaults to location_name.
-        :param rule: Callable to determine access for this event location within its region.
-        :param location_type: Location class to create the event location with. Defaults to BaseClasses.Location.
-        :param item_type: Item class to create the event item with. Defaults to BaseClasses.Item.
-        :param show_in_spoiler: Will be passed along to the created event Location's show_in_spoiler attribute.
-        :return: The created Event Item
-        """
-        if location_type is None:
-            location_type = Location
-
-        if item_name is None:
-            item_name = location_name
-
-        if item_type is None:
-            item_type = Item
-
-        event_location = location_type(self.player, location_name, None, self)
-        event_location.show_in_spoiler = show_in_spoiler
-        if rule is not None:
-            event_location.access_rule = rule
-
-        event_item = item_type(item_name, ItemClassification.progression, None, self.player)
-
-        event_location.place_locked_item(event_item)
-
-        self.locations.append(event_location)
-
-        return event_item
-
     def connect(self, connecting_region: Region, name: Optional[str] = None,
                 rule: Optional[Callable[[CollectionState], bool]] = None) -> Entrance:
         """
@@ -1350,6 +1310,9 @@ class Location:
         multiworld = self.parent_region.multiworld if self.parent_region and self.parent_region.multiworld else None
         return multiworld.get_name_string_for_object(self) if multiworld else f'{self.name} (Player {self.player})'
 
+    def __hash__(self):
+        return hash((self.name, self.player))
+
     def __lt__(self, other: Location):
         return (self.player, self.name) < (other.player, other.name)
 
@@ -1453,10 +1416,6 @@ class Item:
     def flags(self) -> int:
         return self.classification.as_flag()
 
-    @property
-    def is_event(self) -> bool:
-        return self.code is None
-
     def __eq__(self, other: object) -> bool:
         if not isinstance(other, Item):
             return NotImplemented

CommonClient.py

@@ -196,11 +196,25 @@ class CommonContext:
             self.lookup_type: typing.Literal["item", "location"] = lookup_type
             self._unknown_item: typing.Callable[[int], str] = lambda key: f"Unknown {lookup_type} (ID: {key})"
             self._archipelago_lookup: typing.Dict[int, str] = {}
+            self._flat_store: typing.Dict[int, str] = Utils.KeyedDefaultDict(self._unknown_item)
             self._game_store: typing.Dict[str, typing.ChainMap[int, str]] = collections.defaultdict(
                 lambda: collections.ChainMap(self._archipelago_lookup, Utils.KeyedDefaultDict(self._unknown_item)))
+            self.warned: bool = False
 
         # noinspection PyTypeChecker
         def __getitem__(self, key: str) -> typing.Mapping[int, str]:
+            # TODO: In a future version (0.6.0?) this should be simplified by removing implicit id lookups support.
+            if isinstance(key, int):
+                if not self.warned:
+                    # Use warnings instead of logger to avoid deprecation message from appearing on user side.
+                    self.warned = True
+                    warnings.warn(f"Implicit name lookup by id only is deprecated and only supported to maintain "
+                                  f"backwards compatibility for now. If multiple games share the same id for a "
+                                  f"{self.lookup_type}, name could be incorrect. Please use "
+                                  f"`{self.lookup_type}_names.lookup_in_game()` or "
+                                  f"`{self.lookup_type}_names.lookup_in_slot()` instead.")
+                return self._flat_store[key]  # type: ignore
+
             return self._game_store[key]
 
         def __len__(self) -> int:
@@ -240,6 +254,7 @@ class CommonContext:
             id_to_name_lookup_table = Utils.KeyedDefaultDict(self._unknown_item)
             id_to_name_lookup_table.update({code: name for name, code in name_to_id_lookup_table.items()})
             self._game_store[game] = collections.ChainMap(self._archipelago_lookup, id_to_name_lookup_table)
+            self._flat_store.update(id_to_name_lookup_table)  # Only needed for legacy lookup method.
             if game == "Archipelago":
                 # Keep track of the Archipelago data package separately so if it gets updated in a custom datapackage,
                 # it updates in all chain maps automatically.
@@ -341,6 +356,7 @@ class CommonContext:
 
         self.item_names = self.NameLookupDict(self, "item")
         self.location_names = self.NameLookupDict(self, "location")
+        self.versions = {}
         self.checksums = {}
 
         self.jsontotextparser = JSONtoTextParser(self)
@@ -397,8 +413,7 @@ class CommonContext:
             await self.server.socket.close()
         if self.server_task is not None:
             await self.server_task
-        if self.ui:
+        self.ui.update_hints()
-            self.ui.update_hints()
 
     async def send_msgs(self, msgs: typing.List[typing.Any]) -> None:
         """ `msgs` JSON serializable """
@@ -555,6 +570,7 @@ class CommonContext:
     
     # DataPackage
     async def prepare_data_package(self, relevant_games: typing.Set[str],
+                                   remote_date_package_versions: typing.Dict[str, int],
                                    remote_data_package_checksums: typing.Dict[str, str]):
         """Validate that all data is present for the current multiworld.
         Download, assimilate and cache missing data from the server."""
@@ -563,26 +579,33 @@ class CommonContext:
 
         needed_updates: typing.Set[str] = set()
         for game in relevant_games:
-            if game not in remote_data_package_checksums:
+            if game not in remote_date_package_versions and game not in remote_data_package_checksums:
                 continue
 
+            remote_version: int = remote_date_package_versions.get(game, 0)
             remote_checksum: typing.Optional[str] = remote_data_package_checksums.get(game)
 
-            if not remote_checksum:  # custom data package and no checksum for this game
+            if remote_version == 0 and not remote_checksum:  # custom data package and no checksum for this game
                 needed_updates.add(game)
                 continue
 
+            cached_version: int = self.versions.get(game, 0)
             cached_checksum: typing.Optional[str] = self.checksums.get(game)
             # no action required if cached version is new enough
-            if remote_checksum != cached_checksum:
+            if (not remote_checksum and (remote_version > cached_version or remote_version == 0)) \
+                    or remote_checksum != cached_checksum:
+                local_version: int = network_data_package["games"].get(game, {}).get("version", 0)
                 local_checksum: typing.Optional[str] = network_data_package["games"].get(game, {}).get("checksum")
-                if remote_checksum == local_checksum:
+                if ((remote_checksum or remote_version <= local_version and remote_version != 0)
+                        and remote_checksum == local_checksum):
                     self.update_game(network_data_package["games"][game], game)
                 else:
                     cached_game = Utils.load_data_package_for_checksum(game, remote_checksum)
+                    cache_version: int = cached_game.get("version", 0)
                     cache_checksum: typing.Optional[str] = cached_game.get("checksum")
                     # download remote version if cache is not new enough
-                    if remote_checksum != cache_checksum:
+                    if (not remote_checksum and (remote_version > cache_version or remote_version == 0)) \
+                            or remote_checksum != cache_checksum:
                         needed_updates.add(game)
                     else:
                         self.update_game(cached_game, game)
@@ -592,6 +615,7 @@ class CommonContext:
     def update_game(self, game_package: dict, game: str):
         self.item_names.update_game(game, game_package["item_name_to_id"])
         self.location_names.update_game(game, game_package["location_name_to_id"])
+        self.versions[game] = game_package.get("version", 0)
         self.checksums[game] = game_package.get("checksum")
 
     def update_data_package(self, data_package: dict):
@@ -600,6 +624,9 @@ class CommonContext:
 
     def consume_network_data_package(self, data_package: dict):
         self.update_data_package(data_package)
+        current_cache = Utils.persistent_load().get("datapackage", {}).get("games", {})
+        current_cache.update(data_package["games"])
+        Utils.persistent_store("datapackage", "games", current_cache)
         logger.info(f"Got new ID/Name DataPackage for {', '.join(data_package['games'])}")
         for game, game_data in data_package["games"].items():
             Utils.store_data_package_for_checksum(game, game_data)
@@ -862,8 +889,9 @@ async def process_server_cmd(ctx: CommonContext, args: dict):
                         logger.info('    %s (Player %d)' % (network_player.alias, network_player.slot))
 
             # update data package
+            data_package_versions = args.get("datapackage_versions", {})
             data_package_checksums = args.get("datapackage_checksums", {})
-            await ctx.prepare_data_package(set(args["games"]), data_package_checksums)
+            await ctx.prepare_data_package(set(args["games"]), data_package_versions, data_package_checksums)
 
             await ctx.server_auth(args['password'])
 
@@ -1100,7 +1128,7 @@ def run_as_textclient(*args):
     args = handle_url_arg(args, parser=parser)
 
     # use colorama to display colored text highlighting on windows
-    colorama.just_fix_windows_console()
+    colorama.init()
 
     asyncio.run(main(args))
     colorama.deinit()

FF1Client.py

@@ -261,7 +261,7 @@ if __name__ == '__main__':
 
     parser = get_base_parser()
     args = parser.parse_args()
-    colorama.just_fix_windows_console()
+    colorama.init()
 
     asyncio.run(main(args))
     colorama.deinit()

FactorioClient.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+import ModuleUpdate
+ModuleUpdate.update()
+
+from worlds.factorio.Client import check_stdin, launch
+import Utils
+
+if __name__ == "__main__":
+    Utils.init_logging("FactorioClient", exception_logger="Client")
+    check_stdin()
+    launch()

Fill.py

@@ -75,11 +75,9 @@ def fill_restrictive(multiworld: MultiWorld, base_state: CollectionState, locati
                 items_to_place.append(reachable_items[next_player].pop())
 
         for item in items_to_place:
-            # The items added into `reachable_items` are placed starting from the end of each deque in
+            for p, pool_item in enumerate(item_pool):
-            # `reachable_items`, so the items being placed are more likely to be found towards the end of `item_pool`.
-            for p, pool_item in enumerate(reversed(item_pool), start=1):
                 if pool_item is item:
-                    del item_pool[-p]
+                    item_pool.pop(p)
                     break
 
         maximum_exploration_state = sweep_from_pool(
@@ -350,10 +348,10 @@ def accessibility_corrections(multiworld: MultiWorld, state: CollectionState, lo
         if (location.item is not None and location.item.advancement and location.address is not None and not
                 location.locked and location.item.player not in minimal_players):
             pool.append(location.item)
+            state.remove(location.item)
             location.item = None
             if location in state.advancements:
                 state.advancements.remove(location)
-                state.remove(location.item)
             locations.append(location)
     if pool and locations:
         locations.sort(key=lambda loc: loc.progress_type != LocationProgressType.PRIORITY)
@@ -502,15 +500,13 @@ def distribute_items_restrictive(multiworld: MultiWorld,
 
     if prioritylocations:
         # "priority fill"
-        maximum_exploration_state = sweep_from_pool(multiworld.state)
+        fill_restrictive(multiworld, multiworld.state, prioritylocations, progitempool,
-        fill_restrictive(multiworld, maximum_exploration_state, prioritylocations, progitempool,
                          single_player_placement=single_player, swap=False, on_place=mark_for_locking,
                          name="Priority", one_item_per_player=True, allow_partial=True)
 
         if prioritylocations:
             # retry with one_item_per_player off because some priority fills can fail to fill with that optimization
-            maximum_exploration_state = sweep_from_pool(multiworld.state)
+            fill_restrictive(multiworld, multiworld.state, prioritylocations, progitempool,
-            fill_restrictive(multiworld, maximum_exploration_state, prioritylocations, progitempool,
                             single_player_placement=single_player, swap=False, on_place=mark_for_locking,
                             name="Priority Retry", one_item_per_player=False)
         accessibility_corrections(multiworld, multiworld.state, prioritylocations, progitempool)
@@ -518,15 +514,14 @@ def distribute_items_restrictive(multiworld: MultiWorld,
 
     if progitempool:
         # "advancement/progression fill"
-        maximum_exploration_state = sweep_from_pool(multiworld.state)
         if panic_method == "swap":
-            fill_restrictive(multiworld, maximum_exploration_state, defaultlocations, progitempool, swap=True,
+            fill_restrictive(multiworld, multiworld.state, defaultlocations, progitempool, swap=True,
                              name="Progression", single_player_placement=single_player)
         elif panic_method == "raise":
-            fill_restrictive(multiworld, maximum_exploration_state, defaultlocations, progitempool, swap=False,
+            fill_restrictive(multiworld, multiworld.state, defaultlocations, progitempool, swap=False,
                              name="Progression", single_player_placement=single_player)
         elif panic_method == "start_inventory":
-            fill_restrictive(multiworld, maximum_exploration_state, defaultlocations, progitempool, swap=False,
+            fill_restrictive(multiworld, multiworld.state, defaultlocations, progitempool, swap=False,
                              allow_partial=True, name="Progression", single_player_placement=single_player)
             if progitempool:
                 for item in progitempool:

Generate.py

@@ -54,22 +54,12 @@ def mystery_argparse():
     parser.add_argument("--skip_output", action="store_true",
                         help="Skips generation assertion and output stages and skips multidata and spoiler output. "
                              "Intended for debugging and testing purposes.")
-    parser.add_argument("--spoiler_only", action="store_true",
-                        help="Skips generation assertion and multidata, outputting only a spoiler log. "
-                             "Intended for debugging and testing purposes.")
     args = parser.parse_args()
-
-    if args.skip_output and args.spoiler_only:
-        parser.error("Cannot mix --skip_output and --spoiler_only")
-    elif args.spoiler == 0 and args.spoiler_only:
-        parser.error("Cannot use --spoiler_only when --spoiler=0. Use --skip_output or set --spoiler to a different value")
-
     if not os.path.isabs(args.weights_file_path):
         args.weights_file_path = os.path.join(args.player_files_path, args.weights_file_path)
     if not os.path.isabs(args.meta_file_path):
         args.meta_file_path = os.path.join(args.player_files_path, args.meta_file_path)
     args.plando: PlandoOptions = PlandoOptions.from_option_string(args.plando)
-
     return args
 
 
@@ -118,8 +108,6 @@ def main(args=None) -> Tuple[argparse.Namespace, int]:
             raise Exception("Cannot mix --sameoptions with --meta")
     else:
         meta_weights = None
-
-
     player_id = 1
     player_files = {}
     for file in os.scandir(args.player_files_path):
@@ -176,7 +164,6 @@ def main(args=None) -> Tuple[argparse.Namespace, int]:
     erargs.outputpath = args.outputpath
     erargs.skip_prog_balancing = args.skip_prog_balancing
     erargs.skip_output = args.skip_output
-    erargs.spoiler_only = args.spoiler_only
     erargs.name = {}
     erargs.csv_output = args.csv_output
 
@@ -252,20 +239,7 @@ def read_weights_yamls(path) -> Tuple[Any, ...]:
     except Exception as e:
         raise Exception(f"Failed to read weights ({path})") from e
 
-    from yaml.error import MarkedYAMLError
+    return tuple(parse_yamls(yaml))
-    try:
-        return tuple(parse_yamls(yaml))
-    except MarkedYAMLError as ex:
-        if ex.problem_mark:
-            lines = yaml.splitlines()
-            if ex.context_mark:
-                relevant_lines = "\n".join(lines[ex.context_mark.line:ex.problem_mark.line+1])
-            else:
-                relevant_lines = lines[ex.problem_mark.line]
-            error_line = " " * ex.problem_mark.column + "^"
-            raise Exception(f"{ex.context} {ex.problem} on line {ex.problem_mark.line}:"
-                            f"\n{relevant_lines}\n{error_line}")
-        raise ex
 
 
 def interpret_on_off(value) -> bool:
@@ -305,30 +279,22 @@ def get_choice(option, root, value=None) -> Any:
     raise RuntimeError(f"All options specified in \"{option}\" are weighted as zero.")
 
 
-class SafeFormatter(string.Formatter):
+class SafeDict(dict):
-    def get_value(self, key, args, kwargs):
+    def __missing__(self, key):
-        if isinstance(key, int):
+        return '{' + key + '}'
-            if key < len(args):
-                return args[key]
-            else:
-                return "{" + str(key) + "}"
-        else:
-            return kwargs.get(key, "{" + key + "}")
 
 
 def handle_name(name: str, player: int, name_counter: Counter):
     name_counter[name.lower()] += 1
     number = name_counter[name.lower()]
     new_name = "%".join([x.replace("%number%", "{number}").replace("%player%", "{player}") for x in name.split("%%")])
-
+    new_name = string.Formatter().vformat(new_name, (), SafeDict(number=number,
-    new_name = SafeFormatter().vformat(new_name, (), {"number": number,
+                                                                 NUMBER=(number if number > 1 else ''),
-                                                      "NUMBER": (number if number > 1 else ''),
+                                                                 player=player,
-                                                      "player": player,
+                                                                 PLAYER=(player if player > 1 else '')))
-                                                      "PLAYER": (player if player > 1 else '')})
     # Run .strip twice for edge case where after the initial .slice new_name has a leading whitespace.
     # Could cause issues for some clients that cannot handle the additional whitespace.
     new_name = new_name.strip()[:16].strip()
-
     if new_name == "Archipelago":
         raise Exception(f"You cannot name yourself \"{new_name}\"")
     return new_name
@@ -469,14 +435,6 @@ def handle_option(ret: argparse.Namespace, game_weights: dict, option_key: str,
 
 
 def roll_settings(weights: dict, plando_options: PlandoOptions = PlandoOptions.bosses):
-    """
-    Roll options from specified weights, usually originating from a .yaml options file.
-
-    Important note:
-    The same weights dict is shared between all slots using the same yaml (e.g. generic weights file for filler slots).
-    This means it should never be modified without making a deepcopy first.
-    """
-
     from worlds import AutoWorldRegister
 
     if "linked_options" in weights:

Launcher.py

@@ -1,14 +1,16 @@
 """
-Archipelago Launcher
+Archipelago launcher for bundled app.
 
-* If run with a patch file as argument, launch corresponding client with the patch file as an argument.
+* if run with APBP as argument, launch corresponding client.
-* If run with component name as argument, run it passing argv[2:] as arguments.
+* if run with executable as argument, run it passing argv[2:] as arguments
-* If run without arguments or unknown arguments, open launcher GUI.
+* if run without arguments, open launcher GUI
 
-Additional components can be added to worlds.LauncherComponents.components.
+Scroll down to components= to add components to the launcher as well as setup.py
 """
 
+
 import argparse
+import itertools
 import logging
 import multiprocessing
 import shlex
@@ -18,11 +20,10 @@ import urllib.parse
 import webbrowser
 from os.path import isfile
 from shutil import which
-from typing import Callable, Optional, Sequence, Tuple, Union, Any
+from typing import Callable, Optional, Sequence, Tuple, Union
 
 if __name__ == "__main__":
     import ModuleUpdate
-
     ModuleUpdate.update()
 
 import settings
@@ -84,16 +85,12 @@ def browse_files():
 def open_folder(folder_path):
     if is_linux:
         exe = which('xdg-open') or which('gnome-open') or which('kde-open')
+        subprocess.Popen([exe, folder_path])
     elif is_macos:
         exe = which("open")
-    else:
-        webbrowser.open(folder_path)
-        return
-
-    if exe:
         subprocess.Popen([exe, folder_path])
     else:
-        logging.warning(f"No file browser available to open {folder_path}")
+        webbrowser.open(folder_path)
 
 
 def update_settings():
@@ -108,8 +105,7 @@ components.extend([
     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("Unrated/18+ Discord Server", icon="discord",
+    Component("Unrated/18+ Discord Server", icon="discord", func=lambda: webbrowser.open("https://discord.gg/fqvNCCRsu4")),
-              func=lambda: webbrowser.open("https://discord.gg/fqvNCCRsu4")),
     Component("Browse Files", func=browse_files),
 ])
 
@@ -118,7 +114,7 @@ def handle_uri(path: str, launch_args: Tuple[str, ...]) -> None:
     url = urllib.parse.urlparse(path)
     queries = urllib.parse.parse_qs(url.query)
     launch_args = (path, *launch_args)
-    client_component = []
+    client_component = None
     text_client_component = None
     if "game" in queries:
         game = queries["game"][0]
@@ -126,40 +122,49 @@ def handle_uri(path: str, launch_args: Tuple[str, ...]) -> None:
         game = "Archipelago"
     for component in components:
         if component.supports_uri and component.game_name == game:
-            client_component.append(component)
+            client_component = component
         elif component.display_name == "Text Client":
             text_client_component = component
 
-    from kvui import MDButton, MDButtonText
+    if client_component is None:
-    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(
+    from kvui import App, Button, BoxLayout, Label, Window
-        # Headline
-        MDDialogHeadlineText(text="Connect to Multiworld"),
-        # Text
-        popup_text,
-        # Content
-        MDDialogContentContainer(
-            *component_buttons,
-            orientation="vertical"
-        ),
 
-    ).open()
+    class Popup(App):
+        def __init__(self):
+            self.title = "Connect to Multiworld"
+            self.icon = r"data/icon.png"
+            super().__init__()
+
+        def build(self):
+            layout = BoxLayout(orientation="vertical")
+            layout.add_widget(Label(text="Select client to open and connect with."))
+            button_row = BoxLayout(orientation="horizontal", size_hint=(1, 0.4))
+
+            text_client_button = Button(
+                text=text_client_component.display_name,
+                on_release=lambda *args: run_component(text_client_component, *launch_args)
+            )
+            button_row.add_widget(text_client_button)
+
+            game_client_button = Button(
+                text=client_component.display_name,
+                on_release=lambda *args: run_component(client_component, *launch_args)
+            )
+            button_row.add_widget(game_client_button)
+
+            layout.add_widget(button_row)
+
+            return layout
+
+        def _stop(self, *largs):
+            # see run_gui Launcher _stop comment for details
+            self.root_window.close()
+            super()._stop(*largs)
+
+    Popup().run()
 
 
 def identify(path: Union[None, str]) -> Tuple[Union[None, str], Union[None, Component]]:
@@ -215,189 +220,100 @@ def launch(exe, in_terminal=False):
     subprocess.Popen(exe)
 
 
-def create_shortcut(button: Any, component: Component) -> None:
-    from pyshortcuts import make_shortcut
-    script = sys.argv[0]
-    wkdir = Utils.local_path()
-
-    script = f"{script} \"{component.display_name}\""
-    make_shortcut(script, name=f"Archipelago {component.display_name}", icon=local_path("data", "icon.ico"),
-                  startmenu=False, terminal=False, working_dir=wkdir)
-    button.menu.dismiss()
-
-
 refresh_components: Optional[Callable[[], None]] = None
 
 
-def run_gui(path: str, args: Any) -> None:
+def run_gui():
-    from kvui import (ThemedApp, MDFloatLayout, MDGridLayout, ScrollBox)
+    from kvui import App, ContainerLayout, GridLayout, Button, Label, ScrollBox, Widget, ApAsyncImage
-    from kivy.properties import ObjectProperty
     from kivy.core.window import Window
-    from kivy.metrics import dp
+    from kivy.uix.relativelayout import RelativeLayout
-    from kivymd.uix.button import MDIconButton, MDButton
-    from kivymd.uix.card import MDCard
-    from kivymd.uix.menu import MDDropdownMenu
-    from kivymd.uix.snackbar import MDSnackbar, MDSnackbarText
-    from kivymd.uix.textfield import MDTextField
 
-    from kivy.lang.builder import Builder
+    class Launcher(App):
-
-    class LauncherCard(MDCard):
-        component: Component | None
-        image: str
-        context_button: MDIconButton = ObjectProperty(None)
-
-        def __init__(self, *args, component: Component | None = None, image_path: str = "", **kwargs):
-            self.component = component
-            self.image = image_path
-            super().__init__(args, kwargs)
-
-    class Launcher(ThemedApp):
         base_title: str = "Archipelago Launcher"
-        top_screen: MDFloatLayout = ObjectProperty(None)
+        container: ContainerLayout
-        navigation: MDGridLayout = ObjectProperty(None)
+        grid: GridLayout
-        grid: MDGridLayout = ObjectProperty(None)
+        _tool_layout: Optional[ScrollBox] = None
-        button_layout: ScrollBox = ObjectProperty(None)
+        _client_layout: Optional[ScrollBox] = None
-        search_box: MDTextField = ObjectProperty(None)
-        cards: list[LauncherCard]
-        current_filter: Sequence[str | Type] | None
 
-        def __init__(self, ctx=None, path=None, args=None):
+        def __init__(self, ctx=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_args = args
-            self.cards = []
-            self.current_filter = (Type.CLIENT, Type.TOOL, Type.ADJUSTER, Type.MISC)
-            persistent = Utils.persistent_load()
-            if "launcher" in persistent:
-                if "favorites" in persistent["launcher"]:
-                    self.favorites.extend(persistent["launcher"]["favorites"])
-                if "filter" in persistent["launcher"]:
-                    if persistent["launcher"]["filter"]:
-                        filters = []
-                        for filter in persistent["launcher"]["filter"].split(", "):
-                            if filter == "favorites":
-                                filters.append(filter)
-                            else:
-                                filters.append(Type[filter])
-                        self.current_filter = filters
             super().__init__()
 
-        def set_favorite(self, caller):
+        def _refresh_components(self) -> None:
-            if caller.component.display_name in self.favorites:
-                self.favorites.remove(caller.component.display_name)
-                caller.icon = "star-outline"
-            else:
-                self.favorites.append(caller.component.display_name)
-                caller.icon = "star"
 
-        def build_card(self, component: Component) -> LauncherCard:
+            def build_button(component: Component) -> Widget:
-            """
-                Builds a card widget for a given component.
-
-                :param component: The component associated with the button.
-
-                :return: The created Card Widget.
                 """
-            button_card = LauncherCard(component=component,
+                Builds a button widget for a given component.
-                                       image_path=icon_paths[component.icon])
 
-            def open_menu(caller):
+                Args:
-                caller.menu.open()
+                    component (Component): The component associated with the button.
 
-            menu_items = [
+                Returns:
-                {
+                    None. The button is added to the parent grid layout.
-                    "text": "Add shortcut on desktop",
-                    "leading_icon": "laptop",
-                    "on_release": lambda: create_shortcut(button_card.context_button, component)
-                }
-            ]
-            button_card.context_button.menu = MDDropdownMenu(caller=button_card.context_button, items=menu_items)
-            button_card.context_button.bind(on_release=open_menu)
 
-            return button_card
+                """
-
+                button = Button(text=component.display_name, size_hint_y=None, height=40)
-        def _refresh_components(self, type_filter: Sequence[str | Type] | None = None) -> None:
+                button.component = component
-            if not type_filter:
+                button.bind(on_release=self.component_action)
-                type_filter = [Type.CLIENT, Type.ADJUSTER, Type.TOOL, Type.MISC]
+                if component.icon != "icon":
-            favorites = "favorites" in type_filter
+                    image = ApAsyncImage(source=icon_paths[component.icon],
+                                         size=(38, 38), size_hint=(None, 1), pos=(5, 0))
+                    box_layout = RelativeLayout(size_hint_y=None, height=40)
+                    box_layout.add_widget(button)
+                    box_layout.add_widget(image)
+                    return box_layout
+                return button
 
             # clear before repopulating
-            assert self.button_layout, "must call `build` first"
+            assert self._tool_layout and self._client_layout, "must call `build` first"
-            tool_children = reversed(self.button_layout.layout.children)
+            tool_children = reversed(self._tool_layout.layout.children)
             for child in tool_children:
-                self.button_layout.layout.remove_widget(child)
+                self._tool_layout.layout.remove_widget(child)
+            client_children = reversed(self._client_layout.layout.children)
+            for child in client_children:
+                self._client_layout.layout.remove_widget(child)
 
-            cards = [card for card in self.cards if card.component.type in type_filter
+            _tools = {c.display_name: c for c in components if c.type == Type.TOOL}
-                     or favorites and card.component.display_name in self.favorites]
+            _clients = {c.display_name: c for c in components if c.type == Type.CLIENT}
+            _adjusters = {c.display_name: c for c in components if c.type == Type.ADJUSTER}
+            _miscs = {c.display_name: c for c in components if c.type == Type.MISC}
 
-            self.current_filter = type_filter
+            for (tool, client) in itertools.zip_longest(itertools.chain(
-
+                _tools.items(), _miscs.items(), _adjusters.items()
-            for card in cards:
+            ), _clients.items()):
-                self.button_layout.layout.add_widget(card)
+                # column 1
-
+                if tool:
-            top = self.button_layout.children[0].y + self.button_layout.children[0].height \
+                    self._tool_layout.layout.add_widget(build_button(tool[1]))
-                           - self.button_layout.height
+                # column 2
-            scroll_percent = self.button_layout.convert_distance_to_scroll(0, top)
+                if client:
-            self.button_layout.scroll_y = max(0, min(1, scroll_percent[1]))
+                    self._client_layout.layout.add_widget(build_button(client[1]))
-
-        def filter_clients_by_type(self, caller: MDButton):
-            self._refresh_components(caller.type)
-            self.search_box.text = ""
-
-        def filter_clients_by_name(self, caller: MDTextField, name: str) -> None:
-            if len(name) == 0:
-                self._refresh_components(self.current_filter)
-                return
-
-            sub_matches = [
-                card for card in self.cards
-                if name.lower() in card.component.display_name.lower() and card.component.type != Type.HIDDEN
-            ]
-            self.button_layout.layout.clear_widgets()
-            for card in sub_matches:
-                self.button_layout.layout.add_widget(card)
 
         def build(self):
-            self.top_screen = Builder.load_file(Utils.local_path("data/launcher.kv"))
+            self.container = ContainerLayout()
-            self.grid = self.top_screen.ids.grid
+            self.grid = GridLayout(cols=2)
-            self.navigation = self.top_screen.ids.navigation
+            self.container.add_widget(self.grid)
-            self.button_layout = self.top_screen.ids.button_layout
+            self.grid.add_widget(Label(text="General", size_hint_y=None, height=40))
-            self.search_box = self.top_screen.ids.search_box
+            self.grid.add_widget(Label(text="Clients", size_hint_y=None, height=40))
-            self.set_colors()
+            self._tool_layout = ScrollBox()
-            self.top_screen.md_bg_color = self.theme_cls.backgroundColor
+            self._tool_layout.layout.orientation = "vertical"
+            self.grid.add_widget(self._tool_layout)
+            self._client_layout = ScrollBox()
+            self._client_layout.layout.orientation = "vertical"
+            self.grid.add_widget(self._client_layout)
+
+            self._refresh_components()
 
             global refresh_components
             refresh_components = self._refresh_components
 
             Window.bind(on_drop_file=self._on_drop_file)
-            Window.bind(on_keyboard=self._on_keyboard)
 
-            for component in components:
+            return self.container
-                self.cards.append(self.build_card(component))
-
-            self._refresh_components(self.current_filter)
-
-            # Uncomment to re-enable the Kivy console/live editor
-            # Ctrl-E to enable it, make sure numlock/capslock is disabled
-            # from kivy.modules.console import create_console
-            # create_console(Window, self.top_screen)
-
-            return self.top_screen
-
-        def on_start(self):
-            if self.launch_uri:
-                handle_uri(self.launch_uri, self.launch_args)
-                self.launch_uri = None
-                self.launch_args = None
 
         @staticmethod
         def component_action(button):
-            MDSnackbar(MDSnackbarText(text="Opening in a new window..."), y=dp(24), pos_hint={"center_x": 0.5},
-                       size_hint_x=0.5).open()
             if button.component.func:
                 button.component.func()
             else:
@@ -411,28 +327,13 @@ def run_gui(path: str, args: Any) -> None:
             else:
                 logging.warning(f"unable to identify component for {file}")
 
-        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.
-            # Focus first, then capture the first character we type, otherwise it gets swallowed and lost.
-            # Limit text input to ASCII non-control characters (space bar to tilde).
-            if not self.search_box.focus:
-                self.search_box.focus = True
-                if key in range(32, 126):
-                    self.search_box.text += codepoint
-
         def _stop(self, *largs):
             # ran into what appears to be https://groups.google.com/g/kivy-users/c/saWDLoYCSZ4 with PyCharm.
             # Closing the window explicitly cleans it up.
             self.root_window.close()
             super()._stop(*largs)
 
-        def on_stop(self):
+    Launcher().run()
-            Utils.persistent_store("launcher", "favorites", self.favorites)
-            Utils.persistent_store("launcher", "filter", ", ".join(filter.name if isinstance(filter, Type) else filter
-                                                                   for filter in self.current_filter))
-            super().on_stop()
-
-    Launcher(path=path, args=args).run()
 
     # avoiding Launcher reference leak
     # and don't try to do something with widgets after window closed
@@ -459,14 +360,16 @@ 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://"):
-            file, component = identify(path)
+            handle_uri(path, args.get("args", ()))
-            if file:
+            return
-                args['file'] = file
+        file, component = identify(path)
-            if component:
+        if file:
-                args['component'] = component
+            args['file'] = file
-            if not component:
+        if component:
-                logging.warning(f"Could not identify Component responsible for {path}")
+            args['component'] = component
+        if not component:
+            logging.warning(f"Could not identify Component responsible for {path}")
 
     if args["update_settings"]:
         update_settings()
@@ -475,7 +378,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()
 
 
 if __name__ == '__main__':
@@ -497,7 +400,6 @@ if __name__ == '__main__':
     main(parser.parse_args())
 
     from worlds.LauncherComponents import processes
-
     for process in processes:
         # we await all child processes to close before we tear down the process host
         # this makes it feel like each one is its own program, as the Launcher is closed now

LinksAwakeningClient.py

@@ -26,14 +26,12 @@ import typing
 from CommonClient import (CommonContext, get_base_parser, gui_enabled, logger,
                           server_loop)
 from NetUtils import ClientStatus
-from worlds.ladx import LinksAwakeningWorld
 from worlds.ladx.Common import BASE_ID as LABaseID
 from worlds.ladx.GpsTracker import GpsTracker
-from worlds.ladx.TrackerConsts import storage_key
 from worlds.ladx.ItemTracker import ItemTracker
 from worlds.ladx.LADXR.checkMetadata import checkMetadataTable
 from worlds.ladx.Locations import get_locations_to_id, meta_to_name
-from worlds.ladx.Tracker import LocationTracker, MagpieBridge, Check
+from worlds.ladx.Tracker import LocationTracker, MagpieBridge
 
 
 class GameboyException(Exception):
@@ -52,6 +50,22 @@ class BadRetroArchResponse(GameboyException):
     pass
 
 
+def magpie_logo():
+    from kivy.uix.image import CoreImage
+    binary_data = """
+iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAAXN
+SR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA
+7DAcdvqGQAAADGSURBVDhPhVLBEcIwDHOYhjHCBuXHj2OTbAL8+
+MEGZIxOQ1CinOOk0Op0bmo7tlXXeR9FJMYDLOD9mwcLjQK7+hSZ
+wgcWMZJOAGeGKtChNHFL0j+FZD3jSCuo0w7l03wDrWdg00C4/aW
+eDEYNenuzPOfPspBnxf0kssE80vN0L8361j10P03DK4x6FHabuV
+ear8fHme+b17rwSjbAXeUMLb+EVTV2QHm46MWQanmnydA98KsVS
+XkV+qFpGQXrLhT/fqraQeQLuplpNH5g+WkAAAAASUVORK5CYII="""
+    binary_data = base64.b64decode(binary_data)
+    data = io.BytesIO(binary_data)
+    return CoreImage(data, ext="png").texture
+
+
 class LAClientConstants:
     # Connector version
     VERSION = 0x01
@@ -86,23 +100,19 @@ class LAClientConstants:
     WRamCheckSize = 0x4
     WRamSafetyValue = bytearray([0]*WRamCheckSize)
 
-    wRamStart = 0xC000
-    hRamStart = 0xFF80
-    hRamSize = 0x80
-
     MinGameplayValue = 0x06
     MaxGameplayValue = 0x1A
     VictoryGameplayAndSub = 0x0102
 
+
 class RAGameboy():
     cache = []
+    cache_start = 0
+    cache_size = 0
     last_cache_read = None
     socket = None
 
     def __init__(self, address, port) -> None:
-        self.cache_start = LAClientConstants.wRamStart
-        self.cache_size = LAClientConstants.hRamStart + LAClientConstants.hRamSize - LAClientConstants.wRamStart
-
         self.address = address
         self.port = port
         self.socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
@@ -121,14 +131,9 @@ class RAGameboy():
     async def get_retroarch_status(self):
         return await self.send_command("GET_STATUS")
 
-    def set_checks_range(self, checks_start, checks_size):
+    def set_cache_limits(self, cache_start, cache_size):
-        self.checks_start = checks_start
+        self.cache_start = cache_start
-        self.checks_size = checks_size
+        self.cache_size = cache_size
-
-    def set_location_range(self, location_start, location_size, critical_addresses):
-        self.location_start = location_start
-        self.location_size = location_size
-        self.critical_location_addresses = critical_addresses
 
     def send(self, b):
         if type(b) is str:
@@ -183,57 +188,21 @@ class RAGameboy():
         if not await self.check_safe_gameplay():
             return
 
-        attempts = 0
+        cache = []
-        while True:
+        remaining_size = self.cache_size
-            # RA doesn't let us do an atomic read of a large enough block of RAM
+        while remaining_size:
-            # Some bytes can't change in between reading location_block and hram_block
+            block = await self.async_read_memory(self.cache_start + len(cache), remaining_size)
-            location_block = await self.read_memory_block(self.location_start, self.location_size)
+            remaining_size -= len(block)
-            hram_block = await self.read_memory_block(LAClientConstants.hRamStart, LAClientConstants.hRamSize)
+            cache += block
-            verification_block = await self.read_memory_block(self.location_start, self.location_size)
-
-            valid = True
-            for address in self.critical_location_addresses:
-                if location_block[address - self.location_start] != verification_block[address - self.location_start]:
-                    valid = False
-
-            if valid:
-                break
-
-            attempts += 1
-
-            # Shouldn't really happen, but keep it from choking
-            if attempts > 5:
-                return
-
-        checks_block = await self.read_memory_block(self.checks_start, self.checks_size)
 
         if not await self.check_safe_gameplay():
             return
 
-        self.cache = bytearray(self.cache_size)
+        self.cache = cache
-
-        start = self.checks_start - self.cache_start
-        self.cache[start:start + len(checks_block)] = checks_block
-
-        start = self.location_start - self.cache_start
-        self.cache[start:start + len(location_block)] = location_block
-
-        start = LAClientConstants.hRamStart - self.cache_start
-        self.cache[start:start + len(hram_block)] = hram_block
-
         self.last_cache_read = time.time()
 
-    async def read_memory_block(self, address: int, size: int):
-        block = bytearray()
-        remaining_size = size
-        while remaining_size:
-            chunk = await self.async_read_memory(address + len(block), remaining_size)
-            remaining_size -= len(chunk)
-            block += chunk
-
-        return block
-
     async def read_memory_cache(self, addresses):
+        # TODO: can we just update once per frame?
         if not self.last_cache_read or self.last_cache_read + 0.1 < time.time():
             await self.update_cache()
         if not self.cache:
@@ -390,12 +359,11 @@ class LinksAwakeningClient():
         auth = binascii.hexlify(await self.gameboy.async_read_memory(0x0134, 12)).decode()
         self.auth = auth
 
-    async def wait_and_init_tracker(self, magpie: MagpieBridge):
+    async def wait_and_init_tracker(self):
         await self.wait_for_game_ready()
         self.tracker = LocationTracker(self.gameboy)
         self.item_tracker = ItemTracker(self.gameboy)
         self.gps_tracker = GpsTracker(self.gameboy)
-        magpie.gps_tracker = self.gps_tracker
 
     async def recved_item_from_ap(self, item_id, from_player, next_index):
         # Don't allow getting an item until you've got your first check
@@ -437,11 +405,9 @@ class LinksAwakeningClient():
         return (await self.gameboy.read_memory_cache([LAClientConstants.wGameplayType]))[LAClientConstants.wGameplayType] == 1
 
     async def main_tick(self, item_get_cb, win_cb, deathlink_cb):
-        await self.gameboy.update_cache()
         await self.tracker.readChecks(item_get_cb)
         await self.item_tracker.readItems()
         await self.gps_tracker.read_location()
-        await self.gps_tracker.read_entrances()
 
         current_health = (await self.gameboy.read_memory_cache([LAClientConstants.wLinkHealth]))[LAClientConstants.wLinkHealth]
         if self.deathlink_debounce and current_health != 0:
@@ -491,7 +457,7 @@ class LinksAwakeningContext(CommonContext):
     la_task = None
     client = None
     # TODO: does this need to re-read on reset?
-    found_checks = set()
+    found_checks = []
     last_resend = time.time()
 
     magpie_enabled = False
@@ -499,10 +465,6 @@ class LinksAwakeningContext(CommonContext):
     magpie_task = None
     won = False
 
-    @property
-    def slot_storage_key(self):
-        return f"{self.slot_info[self.slot].name}_{storage_key}"
-
     def __init__(self, server_address: typing.Optional[str], password: typing.Optional[str], magpie: typing.Optional[bool]) -> None:
         self.client = LinksAwakeningClient()
         self.slot_data = {}
@@ -514,9 +476,9 @@ class LinksAwakeningContext(CommonContext):
 
     def run_gui(self) -> None:
         import webbrowser
-        from kvui import GameManager
+        import kvui
-        from kivy.metrics import dp
+        from kvui import Button, GameManager
-        from kivymd.uix.button import MDButton, MDButtonText
+        from kivy.uix.image import Image
 
         class LADXManager(GameManager):
             logging_pairs = [
@@ -529,27 +491,23 @@ class LinksAwakeningContext(CommonContext):
                 b = super().build()
 
                 if self.ctx.magpie_enabled:
-                    button = MDButton(MDButtonText(text="Open Tracker"), style="filled", size=(dp(100), dp(70)), radius=5,
+                    button = Button(text="", size=(30, 30), size_hint_x=None,
-                                      size_hint_x=None, size_hint_y=None, pos_hint={"center_y": 0.55},
+                                    on_press=lambda _: webbrowser.open('https://magpietracker.us/?enable_autotracker=1'))
-                                      on_press=lambda _: webbrowser.open('https://magpietracker.us/?enable_autotracker=1'))
+                    image = Image(size=(16, 16), texture=magpie_logo())
-                    button.height = self.server_connect_bar.height
+                    button.add_widget(image)
-                    self.connect_layout.add_widget(button)
 
+                    def set_center(_, center):
+                        image.center = center
+                    button.bind(center=set_center)
+
+                    self.connect_layout.add_widget(button)
                 return b
 
         self.ui = LADXManager(self)
         self.ui_task = asyncio.create_task(self.ui.async_run(), name="UI")
 
-    async def send_new_entrances(self, entrances: typing.Dict[str, str]):
+    async def send_checks(self):
-        # Store the entrances we find on the server for future sessions
+        message = [{"cmd": 'LocationChecks', "locations": self.found_checks}]
-        message = [{
-            "cmd": "Set",
-            "key": self.slot_storage_key,
-            "default": {},
-            "want_reply": False,
-            "operations": [{"operation": "update", "value": entrances}],
-        }]
-
         await self.send_msgs(message)
 
     had_invalid_slot_data = None
@@ -579,19 +537,13 @@ class LinksAwakeningContext(CommonContext):
             await self.send_msgs(message)
             self.won = True
 
-    async def request_found_entrances(self):
-        await self.send_msgs([{"cmd": "Get", "keys": [self.slot_storage_key]}])
-
-        # Ask for updates so that players can co-op entrances in a seed
-        await self.send_msgs([{"cmd": "SetNotify", "keys": [self.slot_storage_key]}])
-
     async def on_deathlink(self, data: typing.Dict[str, typing.Any]) -> None:
         if self.ENABLE_DEATHLINK:
             self.client.pending_deathlink = True
 
     def new_checks(self, item_ids, ladxr_ids):
-        self.found_checks.update(item_ids)
+        self.found_checks += item_ids
-        create_task_log_exception(self.check_locations(self.found_checks))
+        create_task_log_exception(self.send_checks())
         if self.magpie_enabled:
             create_task_log_exception(self.magpie.send_new_checks(ladxr_ids))
 
@@ -619,40 +571,16 @@ class LinksAwakeningContext(CommonContext):
         if cmd == "Connected":
             self.game = self.slot_info[self.slot].game
             self.slot_data = args.get("slot_data", {})
-            # This is sent to magpie over local websocket to make its own connection
-            self.slot_data.update({
-                "server_address": self.server_address,
-                "slot_name": self.player_names[self.slot],
-                "password": self.password,
-            })
-
-            # We can process linked items on already-checked checks now that we have slot_data
-            if self.client.tracker:
-                checked_checks = set(self.client.tracker.all_checks) - set(self.client.tracker.remaining_checks)
-                self.add_linked_items(checked_checks)
             
         # TODO - use watcher_event
         if cmd == "ReceivedItems":
             for index, item in enumerate(args["items"], start=args["index"]):
                 self.client.recvd_checks[index] = item
 
-        if cmd == "Retrieved" and self.magpie_enabled and self.slot_storage_key in args["keys"]:
-            self.client.gps_tracker.receive_found_entrances(args["keys"][self.slot_storage_key])
-
-        if cmd == "SetReply" and self.magpie_enabled and args["key"] == self.slot_storage_key:
-            self.client.gps_tracker.receive_found_entrances(args["value"])
-
     async def sync(self):
         sync_msg = [{'cmd': 'Sync'}]
         await self.send_msgs(sync_msg)
 
-    def add_linked_items(self, checks: typing.List[Check]):
-        for check in checks:
-            if check.value and check.linkedItem:
-                linkedItem = check.linkedItem
-                if 'condition' not in linkedItem or (self.slot_data and linkedItem['condition'](self.slot_data)):
-                    self.client.item_tracker.setExtraItem(check.linkedItem['item'], check.linkedItem['qty'])
-
     item_id_lookup = get_locations_to_id()
 
     async def run_game_loop(self):
@@ -661,8 +589,6 @@ class LinksAwakeningContext(CommonContext):
                 checkMetadataTable[check.id])] for check in ladxr_checks]
             self.new_checks(checks, [check.id for check in ladxr_checks])
 
-            self.add_linked_items(ladxr_checks)
-
         async def victory():
             await self.send_victory()
 
@@ -696,38 +622,21 @@ class LinksAwakeningContext(CommonContext):
                 if not self.client.recvd_checks:
                     await self.sync()
 
-                await self.client.wait_and_init_tracker(self.magpie)
+                await self.client.wait_and_init_tracker()
 
-                min_tick_duration = 0.1
-                last_tick = time.time()
                 while True:
                     await self.client.main_tick(on_item_get, victory, deathlink)
-
+                    await asyncio.sleep(0.1)
                     now = time.time()
-                    tick_duration = now - last_tick
-                    sleep_duration = max(min_tick_duration - tick_duration, 0)
-                    await asyncio.sleep(sleep_duration)
-
-                    last_tick = now
-
                     if self.last_resend + 5.0 < now:
                         self.last_resend = now
-                        await self.check_locations(self.found_checks)
+                        await self.send_checks()
                     if self.magpie_enabled:
                         try:
                             self.magpie.set_checks(self.client.tracker.all_checks)
                             await self.magpie.set_item_tracker(self.client.item_tracker)
-                            if self.slot_data and "slot_data" in self.magpie.features and not self.magpie.has_sent_slot_data:
+                            await self.magpie.send_gps(self.client.gps_tracker)
-                                self.magpie.slot_data = self.slot_data
+                            self.magpie.slot_data = self.slot_data
-                                await self.magpie.send_slot_data()
-
-                            if self.client.gps_tracker.needs_found_entrances:
-                                await self.request_found_entrances()
-                                self.client.gps_tracker.needs_found_entrances = False
-
-                            new_entrances = await self.magpie.send_gps(self.client.gps_tracker)
-                            if new_entrances:
-                                await self.send_new_entrances(new_entrances)
                         except Exception:
                             # Don't let magpie errors take out the client
                             pass
@@ -738,8 +647,8 @@ class LinksAwakeningContext(CommonContext):
                 await asyncio.sleep(1.0)
 
 def run_game(romfile: str) -> None:
-    auto_start = LinksAwakeningWorld.settings.rom_start
+    auto_start = typing.cast(typing.Union[bool, str],
-
+                            Utils.get_options()["ladx_options"].get("rom_start", True))
     if auto_start is True:
         import webbrowser
         webbrowser.open(romfile)
@@ -796,6 +705,6 @@ async def main():
     await ctx.shutdown()
 
 if __name__ == '__main__':
-    colorama.just_fix_windows_console()
+    colorama.init()
     asyncio.run(main())
     colorama.deinit()

MMBN3Client.py

@@ -370,7 +370,7 @@ if __name__ == "__main__":
 
     import colorama
 
-    colorama.just_fix_windows_console()
+    colorama.init()
 
     asyncio.run(main())
     colorama.deinit()

Main.py

@@ -56,18 +56,32 @@ def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = No
     logger.info(f"Found {len(AutoWorld.AutoWorldRegister.world_types)} World Types:")
     longest_name = max(len(text) for text in AutoWorld.AutoWorldRegister.world_types)
 
+    max_item = 0
+    max_location = 0
+    for cls in AutoWorld.AutoWorldRegister.world_types.values():
+        if cls.item_id_to_name:
+            max_item = max(max_item, max(cls.item_id_to_name))
+            max_location = max(max_location, max(cls.location_id_to_name))
+
+    item_digits = len(str(max_item))
+    location_digits = len(str(max_location))
     item_count = len(str(max(len(cls.item_names) for cls in AutoWorld.AutoWorldRegister.world_types.values())))
     location_count = len(str(max(len(cls.location_names) for cls in AutoWorld.AutoWorldRegister.world_types.values())))
+    del max_item, max_location
 
     for name, cls in AutoWorld.AutoWorldRegister.world_types.items():
         if not cls.hidden and len(cls.item_names) > 0:
-            logger.info(f" {name:{longest_name}}: Items: {len(cls.item_names):{item_count}} | "
+            logger.info(f" {name:{longest_name}}: {len(cls.item_names):{item_count}} "
-                        f"Locations: {len(cls.location_names):{location_count}}")
+                        f"Items (IDs: {min(cls.item_id_to_name):{item_digits}} - "
+                        f"{max(cls.item_id_to_name):{item_digits}}) | "
+                        f"{len(cls.location_names):{location_count}} "
+                        f"Locations (IDs: {min(cls.location_id_to_name):{location_digits}} - "
+                        f"{max(cls.location_id_to_name):{location_digits}})")
 
-    del item_count, location_count
+    del item_digits, location_digits, item_count, location_count
 
     # This assertion method should not be necessary to run if we are not outputting any multidata.
-    if not args.skip_output and not args.spoiler_only:
+    if not args.skip_output:
         AutoWorld.call_stage(multiworld, "assert_generate")
 
     AutoWorld.call_all(multiworld, "generate_early")
@@ -210,15 +224,6 @@ def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = No
     logger.info(f'Beginning output...')
     outfilebase = 'AP_' + multiworld.seed_name
 
-    if args.spoiler_only:
-        if args.spoiler > 1:
-            logger.info('Calculating playthrough.')
-            multiworld.spoiler.create_playthrough(create_paths=args.spoiler > 2)
-
-        multiworld.spoiler.to_file(output_path('%s_Spoiler.txt' % outfilebase))
-        logger.info('Done. Skipped multidata modification. Total time: %s', time.perf_counter() - start)
-        return multiworld
-
     output = tempfile.TemporaryDirectory()
     with output as temp_dir:
         output_players = [player for player in multiworld.player_ids if AutoWorld.World.generate_output.__code__
@@ -301,7 +306,6 @@ def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = No
                     game_world.game: worlds.network_data_package["games"][game_world.game]
                     for game_world in multiworld.worlds.values()
                 }
-                data_package["Archipelago"] = worlds.network_data_package["games"]["Archipelago"]
 
                 checks_in_area: Dict[int, Dict[str, Union[int, List[int]]]] = {}
 

MultiServer.py

@@ -46,9 +46,8 @@ from NetUtils import Endpoint, ClientStatus, NetworkItem, decode, encode, Networ
     SlotType, LocationStore, Hint, HintStatus
 from BaseClasses import ItemClassification
 
-
+min_client_version = Version(0, 1, 6)
-min_client_version = Version(0, 5, 0)
+colorama.init()
-colorama.just_fix_windows_console()
 
 
 def remove_from_list(container, value):
@@ -67,13 +66,9 @@ def pop_from_container(container, value):
     return container
 
 
-def update_container_unique(container, entries):
+def update_dict(dictionary, entries):
-    if isinstance(container, list):
+    dictionary.update(entries)
-        existing_container_as_set = set(container)
+    return dictionary
-        container.extend([entry for entry in entries if entry not in existing_container_as_set])
-    else:
-        container.update(entries)
-    return container
 
 
 def queue_gc():
@@ -114,7 +109,7 @@ modify_functions = {
     # lists/dicts:
     "remove": remove_from_list,
     "pop": pop_from_container,
-    "update": update_container_unique,
+    "update": update_dict,
 }
 
 
@@ -1983,13 +1978,11 @@ async def process_client_cmd(ctx: Context, client: Client, args: dict):
             new_hint = new_hint.re_prioritize(ctx, status)
             if hint == new_hint:
                 return
-
+            ctx.replace_hint(client.team, hint.finding_player, hint, new_hint)
-            concerning_slots = ctx.slot_set(hint.receiving_player) | {hint.finding_player}
+            ctx.replace_hint(client.team, hint.receiving_player, hint, new_hint)
-            for slot in concerning_slots:
-                ctx.replace_hint(client.team, slot, hint, new_hint)
             ctx.save()
-            for slot in concerning_slots:
+            ctx.on_changed_hints(client.team, hint.finding_player)
-                ctx.on_changed_hints(client.team, slot)
+            ctx.on_changed_hints(client.team, hint.receiving_player)
         
         elif cmd == 'StatusUpdate':
             update_client_status(ctx, client, args["status"])
@@ -2044,7 +2037,7 @@ async def process_client_cmd(ctx: Context, client: Client, args: dict):
                 value = func(value, operation["value"])
             ctx.stored_data[args["key"]] = args["value"] = value
             targets = set(ctx.stored_data_notification_clients[args["key"]])
-            if args.get("want_reply", False):
+            if args.get("want_reply", True):
                 targets.add(client)
             if targets:
                 ctx.broadcast(targets, [args])
@@ -2419,10 +2412,8 @@ async def console(ctx: Context):
 
 
 def parse_args() -> argparse.Namespace:
-    from settings import get_settings
-
     parser = argparse.ArgumentParser()
-    defaults = get_settings().server_options.as_dict()
+    defaults = Utils.get_settings()["server_options"].as_dict()
     parser.add_argument('multidata', nargs="?", default=defaults["multidata"])
     parser.add_argument('--host', default=defaults["host"])
     parser.add_argument('--port', default=defaults["port"], type=int)

OoTClient.py

@@ -346,7 +346,7 @@ if __name__ == '__main__':
 
     import colorama
 
-    colorama.just_fix_windows_console()
+    colorama.init()
 
     asyncio.run(main())
     colorama.deinit()

Options.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import abc
-import collections
 import functools
 import logging
 import math
@@ -867,49 +866,15 @@ class OptionDict(Option[typing.Dict[str, typing.Any]], VerifyKeys, typing.Mappin
     def __len__(self) -> int:
         return self.value.__len__()
 
-    # __getitem__ fallback fails for Counters, so we define this explicitly
-    def __contains__(self, item) -> bool:
-        return item in self.value
 
-
+class ItemDict(OptionDict):
-class OptionCounter(OptionDict):
-    min: int | None = None
-    max: int | None = None
-
-    def __init__(self, value: dict[str, int]) -> None:
-        super(OptionCounter, self).__init__(collections.Counter(value))
-
-    def verify(self, world: type[World], player_name: str, plando_options: PlandoOptions) -> None:
-        super(OptionCounter, self).verify(world, player_name, plando_options)
-
-        range_errors = []
-
-        if self.max is not None:
-            range_errors += [
-                f"\"{key}: {value}\" is higher than maximum allowed value {self.max}."
-                for key, value in self.value.items() if value > self.max
-            ]
-
-        if self.min is not None:
-            range_errors += [
-                f"\"{key}: {value}\" is lower than minimum allowed value {self.min}."
-                for key, value in self.value.items() if value < self.min
-            ]
-
-        if range_errors:
-            range_errors = [f"For option {getattr(self, 'display_name', self)}:"] + range_errors
-            raise OptionError("\n".join(range_errors))
-
-
-class ItemDict(OptionCounter):
     verify_item_name = True
 
-    min = 0
+    def __init__(self, value: typing.Dict[str, int]):
-
+        if any(item_count is None for item_count in value.values()):
-    def __init__(self, value: dict[str, int]) -> None:
+            raise Exception("Items must have counts associated with them. Please provide positive integer values in the format \"item\": count .")
-        # Backwards compatibility: Cull 0s to make "in" checks behave the same as when this wasn't a OptionCounter
+        if any(item_count < 1 for item_count in value.values()):
-        value = {item_name: amount for item_name, amount in value.items() if amount != 0}
+            raise Exception("Cannot have non-positive item counts.")
-
         super(ItemDict, self).__init__(value)
 
 
@@ -1292,47 +1257,42 @@ class CommonOptions(metaclass=OptionsMetaProperty):
     progression_balancing: ProgressionBalancing
     accessibility: Accessibility
 
-    def as_dict(
+    def as_dict(self,
-            self,
+                *option_names: str,
-            *option_names: str,
+                casing: typing.Literal["snake", "camel", "pascal", "kebab"] = "snake",
-            casing: typing.Literal["snake", "camel", "pascal", "kebab"] = "snake",
+                toggles_as_bools: bool = False) -> typing.Dict[str, typing.Any]:
-            toggles_as_bools: bool = False,
-    ) -> dict[str, typing.Any]:
         """
         Returns a dictionary of [str, Option.value]
 
-        :param option_names: Names of the options to get the values of.
+        :param option_names: names of the options to return
-        :param casing: Casing of the keys to return. Supports `snake`, `camel`, `pascal`, `kebab`.
+        :param casing: case of the keys to return. Supports `snake`, `camel`, `pascal`, `kebab`
-        :param toggles_as_bools: Whether toggle options should be returned as bools instead of ints.
+        :param toggles_as_bools: whether toggle options should be output as bools instead of strings
-
-        :return: A dictionary of each option name to the value of its Option. If the option is an OptionSet, the value
-        will be returned as a sorted list.
         """
         assert option_names, "options.as_dict() was used without any option names."
         option_results = {}
         for option_name in option_names:
-            if option_name not in type(self).type_hints:
+            if option_name in type(self).type_hints:
-                raise ValueError(f"{option_name} not found in {tuple(type(self).type_hints)}")
+                if casing == "snake":
-
+                    display_name = option_name
-            if casing == "snake":
+                elif casing == "camel":
-                display_name = option_name
+                    split_name = [name.title() for name in option_name.split("_")]
-            elif casing == "camel":
+                    split_name[0] = split_name[0].lower()
-                split_name = [name.title() for name in option_name.split("_")]
+                    display_name = "".join(split_name)
-                split_name[0] = split_name[0].lower()
+                elif casing == "pascal":
-                display_name = "".join(split_name)
+                    display_name = "".join([name.title() for name in option_name.split("_")])
-            elif casing == "pascal":
+                elif casing == "kebab":
-                display_name = "".join([name.title() for name in option_name.split("_")])
+                    display_name = option_name.replace("_", "-")
-            elif casing == "kebab":
+                else:
-                display_name = option_name.replace("_", "-")
+                    raise ValueError(f"{casing} is invalid casing for as_dict. "
+                                     "Valid names are 'snake', 'camel', 'pascal', 'kebab'.")
+                value = getattr(self, option_name).value
+                if isinstance(value, set):
+                    value = sorted(value)
+                elif toggles_as_bools and issubclass(type(self).type_hints[option_name], Toggle):
+                    value = bool(value)
+                option_results[display_name] = value
             else:
-                raise ValueError(f"{casing} is invalid casing for as_dict. "
+                raise ValueError(f"{option_name} not found in {tuple(type(self).type_hints)}")
-                                 "Valid names are 'snake', 'camel', 'pascal', 'kebab'.")
-            value = getattr(self, option_name).value
-            if isinstance(value, set):
-                value = sorted(value)
-            elif toggles_as_bools and issubclass(type(self).type_hints[option_name], Toggle):
-                value = bool(value)
-            option_results[display_name] = value
         return option_results
 
 
@@ -1353,7 +1313,6 @@ class StartInventory(ItemDict):
     verify_item_name = True
     display_name = "Start Inventory"
     rich_text_doc = True
-    max = 10000
 
 
 class StartInventoryPool(StartInventory):
@@ -1620,7 +1579,6 @@ def dump_player_options(multiworld: MultiWorld) -> None:
             player_output = {
                 "Game": multiworld.game[player],
                 "Name": multiworld.get_player_name(player),
-                "ID": player,
             }
             output.append(player_output)
             for option_key, option in world.options_dataclass.type_hints.items():
@@ -1633,7 +1591,7 @@ def dump_player_options(multiworld: MultiWorld) -> None:
                     game_option_names.append(display_name)
 
     with open(output_path(f"generate_{multiworld.seed_name}.csv"), mode="w", newline="") as file:
-        fields = ["ID", "Game", "Name", *all_option_names]
+        fields = ["Game", "Name", *all_option_names]
         writer = DictWriter(file, fields)
         writer.writeheader()
         writer.writerows(output)

README.md

@@ -9,6 +9,7 @@ Currently, the following games are supported:
 * Factorio
 * Minecraft
 * Subnautica
+* Slay the Spire
 * Risk of Rain 2
 * The Legend of Zelda: Ocarina of Time
 * Timespinner
@@ -62,6 +63,7 @@ Currently, the following games are supported:
 * TUNIC
 * Kirby's Dream Land 3
 * Celeste 64
+* Zork Grand Inquisitor
 * Castlevania 64
 * A Short Hike
 * Yoshi's Island
@@ -78,8 +80,6 @@ Currently, the following games are supported:
 * Saving Princess
 * Castlevania: Circle of the Moon
 * Inscryption
-* Civilization VI
-* The Legend of Zelda: The Wind Waker
 
 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

SNIClient.py

@@ -735,6 +735,6 @@ async def main() -> None:
 
 
 if __name__ == '__main__':
-    colorama.just_fix_windows_console()
+    colorama.init()
     asyncio.run(main())
     colorama.deinit()

UndertaleClient.py

@@ -500,7 +500,7 @@ def main():
 
     import colorama
 
-    colorama.just_fix_windows_console()
+    colorama.init()
 
     asyncio.run(_main())
     colorama.deinit()

Utils.py

@@ -47,7 +47,7 @@ class Version(typing.NamedTuple):
         return ".".join(str(item) for item in self)
 
 
-__version__ = "0.6.2"
+__version__ = "0.6.0"
 version_tuple = tuplize_version(__version__)
 
 is_linux = sys.platform.startswith("linux")
@@ -114,8 +114,6 @@ def cache_self1(function: typing.Callable[[S, T], RetType]) -> typing.Callable[[
             cache[arg] = res
             return res
 
-    wrap.__defaults__ = function.__defaults__
-
     return wrap
 
 
@@ -429,9 +427,6 @@ class RestrictedUnpickler(pickle.Unpickler):
     def find_class(self, module: str, name: str) -> type:
         if module == "builtins" and name in safe_builtins:
             return getattr(builtins, name)
-        # used by OptionCounter
-        if module == "collections" and name == "Counter":
-            return collections.Counter
         # used by MultiServer -> savegame/multidata
         if module == "NetUtils" and name in {"NetworkItem", "ClientStatus", "Hint",
                                              "SlotType", "NetworkSlot", "HintStatus"}:
@@ -448,8 +443,7 @@ class RestrictedUnpickler(pickle.Unpickler):
             else:
                 mod = importlib.import_module(module)
             obj = getattr(mod, name)
-            if issubclass(obj, (self.options_module.Option, self.options_module.PlandoConnection,
+            if issubclass(obj, (self.options_module.Option, self.options_module.PlandoConnection)):
-                                self.options_module.PlandoText)):
                 return obj
         # Forbid everything else.
         raise pickle.UnpicklingError(f"global '{module}.{name}' is forbidden")
@@ -635,8 +629,6 @@ def get_fuzzy_results(input_word: str, word_list: typing.Collection[str], limit:
     import jellyfish
 
     def get_fuzzy_ratio(word1: str, word2: str) -> float:
-        if word1 == word2:
-            return 1.01
         return (1 - jellyfish.damerau_levenshtein_distance(word1.lower(), word2.lower())
                 / max(len(word1), len(word2)))
 
@@ -657,10 +649,8 @@ def get_intended_text(input_text: str, possible_answers) -> typing.Tuple[str, bo
     picks = get_fuzzy_results(input_text, possible_answers, limit=2)
     if len(picks) > 1:
         dif = picks[0][1] - picks[1][1]
-        if picks[0][1] == 101:
+        if picks[0][1] == 100:
             return picks[0][0], True, "Perfect Match"
-        elif picks[0][1] == 100:
-            return picks[0][0], True, "Case Insensitive Perfect Match"
         elif picks[0][1] < 75:
             return picks[0][0], False, f"Didn't find something that closely matches '{input_text}', " \
                                        f"did you mean '{picks[0][0]}'? ({picks[0][1]}% sure)"

WargrooveClient.py

@@ -214,11 +214,17 @@ class WargrooveContext(CommonContext):
     def run_gui(self):
         """Import kivy UI system and start running it as self.ui_task."""
         from kvui import GameManager, HoverBehavior, ServerToolTip
-        from kivymd.uix.tab import MDTabsItem, MDTabsItemText
+        from kivy.uix.tabbedpanel import TabbedPanelItem
         from kivy.lang import Builder
+        from kivy.uix.button import Button
         from kivy.uix.togglebutton import ToggleButton
         from kivy.uix.boxlayout import BoxLayout
+        from kivy.uix.gridlayout import GridLayout
+        from kivy.uix.image import AsyncImage, Image
+        from kivy.uix.stacklayout import StackLayout
         from kivy.uix.label import Label
+        from kivy.properties import ColorProperty
+        from kivy.uix.image import Image
         import pkgutil
 
         class TrackerLayout(BoxLayout):
@@ -440,6 +446,6 @@ if __name__ == '__main__':
     parser = get_base_parser(description="Wargroove Client, for text interfacing.")
 
     args, rest = parser.parse_known_args()
-    colorama.just_fix_windows_console()
+    colorama.init()
     asyncio.run(main(args))
     colorama.deinit()

WebHostLib/api/user.py

@@ -28,6 +28,6 @@ def get_seeds():
         response.append({
             "seed_id": seed.id,
             "creation_time": seed.creation_time,
-            "players": get_players(seed),
+            "players": get_players(seed.slots),
         })
     return jsonify(response)

WebHostLib/autolauncher.py

@@ -9,7 +9,7 @@ from threading import Event, Thread
 from typing import Any
 from uuid import UUID
 
-from pony.orm import db_session, select, commit, PrimaryKey
+from pony.orm import db_session, select, commit
 
 from Utils import restricted_loads
 from .locker import Locker, AlreadyRunningException
@@ -36,21 +36,12 @@ def handle_generation_failure(result: BaseException):
         logging.exception(e)
 
 
-def _mp_gen_game(gen_options: dict, meta: dict[str, Any] | None = None, owner=None, sid=None) -> PrimaryKey | None:
-    from setproctitle import setproctitle
-
-    setproctitle(f"Generator ({sid})")
-    res = gen_game(gen_options, meta=meta, owner=owner, sid=sid)
-    setproctitle(f"Generator (idle)")
-    return res
-
-
 def launch_generator(pool: multiprocessing.pool.Pool, generation: Generation):
     try:
         meta = json.loads(generation.meta)
         options = restricted_loads(generation.options)
         logging.info(f"Generating {generation.id} for {len(options)} players")
-        pool.apply_async(_mp_gen_game, (options,),
+        pool.apply_async(gen_game, (options,),
                          {"meta": meta,
                           "sid": generation.id,
                           "owner": generation.owner},
@@ -64,10 +55,6 @@ def launch_generator(pool: multiprocessing.pool.Pool, generation: Generation):
 
 
 def init_generator(config: dict[str, Any]) -> None:
-    from setproctitle import setproctitle
-
-    setproctitle("Generator (idle)")
-
     try:
         import resource
     except ModuleNotFoundError:

WebHostLib/customserver.py

@@ -117,7 +117,6 @@ class WebHostContext(Context):
         self.gamespackage = {"Archipelago": static_gamespackage.get("Archipelago", {})}  # this may be modified by _load
         self.item_name_groups = {"Archipelago": static_item_name_groups.get("Archipelago", {})}
         self.location_name_groups = {"Archipelago": static_location_name_groups.get("Archipelago", {})}
-        missing_checksum = False
 
         for game in list(multidata.get("datapackage", {})):
             game_data = multidata["datapackage"][game]
@@ -133,13 +132,11 @@ class WebHostContext(Context):
                         continue
                     else:
                         self.logger.warning(f"Did not find game_data_package for {game}: {game_data['checksum']}")
-            else:
-                missing_checksum = True  # Game rolled on old AP and will load data package from multidata
             self.gamespackage[game] = static_gamespackage.get(game, {})
             self.item_name_groups[game] = static_item_name_groups.get(game, {})
             self.location_name_groups[game] = static_location_name_groups.get(game, {})
 
-        if not game_data_packages and not missing_checksum:
+        if not game_data_packages:
             # all static -> use the static dicts directly
             self.gamespackage = static_gamespackage
             self.item_name_groups = static_item_name_groups
@@ -227,9 +224,6 @@ def set_up_logging(room_id) -> logging.Logger:
 def run_server_process(name: str, ponyconfig: dict, static_server_data: dict,
                        cert_file: typing.Optional[str], cert_key_file: typing.Optional[str],
                        host: str, rooms_to_run: multiprocessing.Queue, rooms_shutting_down: multiprocessing.Queue):
-    from setproctitle import setproctitle
-
-    setproctitle(name)
     Utils.init_logging(name)
     try:
         import resource
@@ -250,23 +244,8 @@ def run_server_process(name: str, ponyconfig: dict, static_server_data: dict,
         raise Exception("Worlds system should not be loaded in the custom server.")
 
     import gc
-
+    ssl_context = load_server_cert(cert_file, cert_key_file) if cert_file else None
-    if not cert_file:
+    del cert_file, cert_key_file, ponyconfig
-        def get_ssl_context():
-            return None
-    else:
-        load_date = None
-        ssl_context = load_server_cert(cert_file, cert_key_file)
-
-        def get_ssl_context():
-            nonlocal load_date, ssl_context
-            today = datetime.date.today()
-            if load_date != today:
-                ssl_context = load_server_cert(cert_file, cert_key_file)
-                load_date = today
-            return ssl_context
-
-    del ponyconfig
     gc.collect()  # free intermediate objects used during setup
 
     loop = asyncio.get_event_loop()
@@ -281,12 +260,12 @@ def run_server_process(name: str, ponyconfig: dict, static_server_data: dict,
                 assert ctx.server is None
                 try:
                     ctx.server = websockets.serve(
-                        functools.partial(server, ctx=ctx), ctx.host, ctx.port, ssl=get_ssl_context())
+                        functools.partial(server, ctx=ctx), ctx.host, ctx.port, ssl=ssl_context)
 
                     await ctx.server
                 except OSError:  # likely port in use
                     ctx.server = websockets.serve(
-                        functools.partial(server, ctx=ctx), ctx.host, 0, ssl=get_ssl_context())
+                        functools.partial(server, ctx=ctx), ctx.host, 0, ssl=ssl_context)
 
                     await ctx.server
                 port = 0

WebHostLib/generate.py

@@ -135,7 +135,6 @@ def gen_game(gen_options: dict, meta: Optional[Dict[str, Any]] = None, owner=Non
                                                                        {"bosses", "items", "connections", "texts"}))
         erargs.skip_prog_balancing = False
         erargs.skip_output = False
-        erargs.spoiler_only = False
         erargs.csv_output = False
 
         name_counter = Counter()

WebHostLib/misc.py

@@ -35,12 +35,6 @@ def start_playing():
 @app.route('/games/<string:game>/info/<string:lang>')
 @cache.cached()
 def game_info(game, lang):
-    try:
-        world = AutoWorldRegister.world_types[game]
-        if lang not in world.web.game_info_languages:
-            raise KeyError("Sorry, this game's info page is not available in that language yet.")
-    except KeyError:
-        return abort(404)
     return render_template('gameInfo.html', game=game, lang=lang, theme=get_world_theme(game))
 
 
@@ -58,12 +52,6 @@ def games():
 @app.route('/tutorial/<string:game>/<string:file>/<string:lang>')
 @cache.cached()
 def tutorial(game, file, lang):
-    try:
-        world = AutoWorldRegister.world_types[game]
-        if lang not in [tut.link.split("/")[1] for tut in world.web.tutorials]:
-            raise KeyError("Sorry, the tutorial is not available in that language yet.")
-    except KeyError:
-        return abort(404)
     return render_template("tutorial.html", game=game, file=file, lang=lang, theme=get_world_theme(game))
 
 

WebHostLib/options.py

@@ -6,7 +6,7 @@ from typing import Dict, Union
 from docutils.core import publish_parts
 
 import yaml
-from flask import redirect, render_template, request, Response, abort
+from flask import redirect, render_template, request, Response
 
 import Options
 from Utils import local_path
@@ -108,7 +108,7 @@ def option_presets(game: str) -> Response:
                     f"Expected {option.special_range_names.keys()} or {option.range_start}-{option.range_end}."
 
                 presets[preset_name][preset_option_name] = option.value
-            elif isinstance(option, (Options.Range, Options.OptionSet, Options.OptionList, Options.OptionCounter)):
+            elif isinstance(option, (Options.Range, Options.OptionSet, Options.OptionList, Options.ItemDict)):
                 presets[preset_name][preset_option_name] = option.value
             elif isinstance(preset_option, str):
                 # Ensure the option value is valid for Choice and Toggle options
@@ -142,10 +142,7 @@ def weighted_options_old():
 @app.route("/games/<string:game>/weighted-options")
 @cache.cached()
 def weighted_options(game: str):
-    try:
+    return render_options_page("weightedOptions/weightedOptions.html", game, is_complex=True)
-        return render_options_page("weightedOptions/weightedOptions.html", game, is_complex=True)
-    except KeyError:
-        return abort(404)
 
 
 @app.route("/games/<string:game>/generate-weighted-yaml", methods=["POST"])
@@ -200,10 +197,7 @@ def generate_weighted_yaml(game: str):
 @app.route("/games/<string:game>/player-options")
 @cache.cached()
 def player_options(game: str):
-    try:
+    return render_options_page("playerOptions/playerOptions.html", game, is_complex=False)
-        return render_options_page("playerOptions/playerOptions.html", game, is_complex=False)
-    except KeyError:
-        return abort(404)
 
 
 # YAML generator for player-options
@@ -222,7 +216,7 @@ def generate_yaml(game: str):
 
         for key, val in options.copy().items():
             key_parts = key.rsplit("||", 2)
-            # Detect and build OptionCounter options from their name pattern
+            # Detect and build ItemDict options from their name pattern
             if key_parts[-1] == "qty":
                 if key_parts[0] not in options:
                     options[key_parts[0]] = {}

WebHostLib/requirements.txt

@@ -1,12 +1,11 @@
-flask>=3.1.0
+flask>=3.0.3
-werkzeug>=3.1.3
+werkzeug>=3.0.6
 pony>=0.7.19
-waitress>=3.0.2
+waitress>=3.0.0
 Flask-Caching>=2.3.0
-Flask-Compress>=1.17
+Flask-Compress>=1.15
-Flask-Limiter>=3.12
+Flask-Limiter>=3.8.0
-bokeh>=3.6.3
+bokeh>=3.5.2
-markupsafe>=3.0.2
+markupsafe>=2.1.5
 Markdown>=3.7
 mdx-breakless-lists>=1.0.1
-setproctitle>=1.3.5

WebHostLib/static/assets/gameInfo.js

@@ -23,6 +23,7 @@ window.addEventListener('load', () => {
         showdown.setOption('strikethrough', true);
         showdown.setOption('literalMidWordUnderscores', true);
         gameInfo.innerHTML += (new showdown.Converter()).makeHtml(results);
+        adjustHeaderWidth();
 
         // Reset the id of all header divs to something nicer
         for (const header of document.querySelectorAll('h1, h2, h3, h4, h5, h6')) {
@@ -41,5 +42,10 @@ window.addEventListener('load', () => {
                 scrollTarget?.scrollIntoView();
             }
         });
+    }).catch((error) => {
+        console.error(error);
+        gameInfo.innerHTML =
+            `<h2>This page is out of logic!</h2>
+            <h3>Click <a href="${window.location.origin}">here</a> to return to safety.</h3>`;
     });
 });

WebHostLib/static/assets/hostGame.js

@@ -6,4 +6,6 @@ window.addEventListener('load', () => {
     document.getElementById('file-input').addEventListener('change', () => {
         document.getElementById('host-game-form').submit();
     });
+
+    adjustFooterHeight();
 });

WebHostLib/static/assets/styleController.js

@@ -0,0 +1,47 @@
+const adjustFooterHeight = () => {
+  // If there is no footer on this page, do nothing
+  const footer = document.getElementById('island-footer');
+  if (!footer) { return; }
+
+  // If the body is taller than the window, also do nothing
+  if (document.body.offsetHeight > window.innerHeight) {
+    footer.style.marginTop = '0';
+    return;
+  }
+
+  // Add a margin-top to the footer to position it at the bottom of the screen
+  const sibling = footer.previousElementSibling;
+  const margin = (window.innerHeight - sibling.offsetTop - sibling.offsetHeight - footer.offsetHeight);
+  if (margin < 1) {
+    footer.style.marginTop = '0';
+    return;
+  }
+  footer.style.marginTop = `${margin}px`;
+};
+
+const adjustHeaderWidth = () => {
+  // If there is no header, do nothing
+  const header = document.getElementById('base-header');
+  if (!header) { return; }
+
+  const tempDiv = document.createElement('div');
+  tempDiv.style.width = '100px';
+  tempDiv.style.height = '100px';
+  tempDiv.style.overflow = 'scroll';
+  tempDiv.style.position = 'absolute';
+  tempDiv.style.top = '-500px';
+  document.body.appendChild(tempDiv);
+  const scrollbarWidth = tempDiv.offsetWidth - tempDiv.clientWidth;
+  document.body.removeChild(tempDiv);
+
+  const documentRoot = document.compatMode === 'BackCompat' ? document.body : document.documentElement;
+  const margin = (documentRoot.scrollHeight > documentRoot.clientHeight) ? 0-scrollbarWidth : 0;
+  document.getElementById('base-header-right').style.marginRight = `${margin}px`;
+};
+
+window.addEventListener('load', () => {
+  window.addEventListener('resize', adjustFooterHeight);
+  window.addEventListener('resize', adjustHeaderWidth);
+  adjustFooterHeight();
+  adjustHeaderWidth();
+});

WebHostLib/static/assets/tutorial.js

@@ -25,6 +25,7 @@ window.addEventListener('load', () => {
         showdown.setOption('literalMidWordUnderscores', true);
         showdown.setOption('disableForced4SpacesIndentedSublists', true);
         tutorialWrapper.innerHTML += (new showdown.Converter()).makeHtml(results);
+        adjustHeaderWidth();
 
         const title = document.querySelector('h1')
         if (title) {
@@ -48,5 +49,10 @@ window.addEventListener('load', () => {
                 scrollTarget?.scrollIntoView();
             }
         });
+    }).catch((error) => {
+        console.error(error);
+        tutorialWrapper.innerHTML =
+            `<h2>This page is out of logic!</h2>
+            <h3>Click <a href="${window.location.origin}/tutorial">here</a> to return to safety.</h3>`;
     });
 });

WebHostLib/static/styles/globalStyles.css

@@ -36,13 +36,6 @@ html{
 
 body{
     margin: 0;
-    display: flex;
-    flex-direction: column;
-    min-height: calc(100vh - 110px);
-}
-
-main {
-    flex-grow: 1;
 }
 
 a{

WebHostLib/static/styles/timespinnerTracker.css

@@ -75,27 +75,6 @@
 #inventory-table img.acquired.green{ /*32CD32*/
     filter: hue-rotate(84deg) saturate(10) brightness(0.7);
 }
-#inventory-table img.acquired.hotpink{ /*FF69B4*/
-    filter: sepia(100%) hue-rotate(300deg) saturate(10);
-}
-#inventory-table img.acquired.lightsalmon{ /*FFA07A*/
-    filter: sepia(100%) hue-rotate(347deg) saturate(10);
-}
-#inventory-table img.acquired.crimson{ /*DB143B*/
-    filter: sepia(100%) hue-rotate(318deg) saturate(10) brightness(0.86);
-}
-
-#inventory-table span{
-    color: #B4B4A0;
-    font-size: 40px;
-    max-width: 40px;
-    max-height: 40px;
-    filter: grayscale(100%) contrast(75%) brightness(30%);
-}
-
-#inventory-table span.acquired{
-    filter: none;
-}
 
 #inventory-table div.image-stack{
     display: grid;

WebHostLib/templates/404.html

@@ -1,6 +1,5 @@
 {% extends 'pageWrapper.html' %}
 {% import "macros.html" as macros %}
-{% set show_footer = True %}
 
 {% block head %}
     <title>Page Not Found (404)</title>
@@ -14,4 +13,5 @@
         The page you're looking for doesn&apos;t exist.<br />
         <a href="/">Click here to return to safety.</a>
     </div>
+    {% include 'islandFooter.html' %}
 {% endblock %}

WebHostLib/templates/hostGame.html

@@ -1,5 +1,4 @@
 {% extends 'pageWrapper.html' %}
-{% set show_footer = True %}
 
 {% block head %}
     <title>Upload Multidata</title>
@@ -28,4 +27,6 @@
             </div>
         </div>
     </div>
+
+    {% include 'islandFooter.html' %}
 {% endblock %}

WebHostLib/templates/landing.html

@@ -1,5 +1,4 @@
 {% extends 'pageWrapper.html' %}
-{% set show_footer = True %}
 
 {% block head %}
     <title>Archipelago</title>
@@ -58,4 +57,5 @@
             </div>
         </div>
     </div>
+    {% include 'islandFooter.html' %}
 {% endblock %}

WebHostLib/templates/pageWrapper.html

@@ -5,29 +5,26 @@
     <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/tooltip.css") }}" />
     <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/cookieNotice.css") }}" />
     <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/globalStyles.css") }}" />
+    <script type="application/ecmascript" src="{{ url_for('static', filename="assets/styleController.js") }}"></script>
     <script type="application/ecmascript" src="{{ url_for('static', filename="assets/cookieNotice.js") }}"></script>
     {% block head %}
         <title>Archipelago</title>
     {% endblock %}
 </head>
 <body>
-    <main>
-        {% with messages = get_flashed_messages() %}
-            {% if messages %}
-                <div>
-                    {% for message in messages | unique %}
-                        <div class="user-message">{{ message }}</div>
-                    {% endfor %}
-                </div>
-            {% endif %}
-        {% endwith %}
 
-        {% block body %}
+{% with messages = get_flashed_messages() %}
-        {% endblock %}
+    {% if messages %}
-    </main>
+        <div>
-
+            {% for message in messages | unique %}
-    {% if show_footer %}
+                <div class="user-message">{{ message }}</div>
-        {% include "islandFooter.html" %}
+            {% endfor %}
+        </div>
     {% endif %}
+{% endwith %}
+
+{% block body %}
+{% endblock %}
+
 </body>
 </html>

WebHostLib/templates/playerOptions/macros.html

@@ -111,19 +111,10 @@
     </div>
 {% endmacro %}
 
-{% macro OptionCounter(option_name, option) %}
+{% macro ItemDict(option_name, option) %}
-    {% set relevant_keys = option.valid_keys %}
-    {% if not relevant_keys %}
-        {% if option.verify_item_name %}
-            {% set relevant_keys = world.item_names %}
-        {% elif option.verify_location_name %}
-            {% set relevant_keys = world.location_names %}
-        {% endif %}
-    {% endif %}
-
     {{ OptionTitle(option_name, option) }}
     <div class="option-container">
-        {% for item_name in (relevant_keys if relevant_keys is ordered else relevant_keys|sort) %}
+        {% for item_name in (option.valid_keys|sort if (option.valid_keys|length > 0) else world.item_names|sort) %}
             <div class="option-entry">
                 <label for="{{ option_name }}-{{ item_name }}-qty">{{ item_name }}</label>
                 <input type="number" id="{{ option_name }}-{{ item_name }}-qty" name="{{ option_name }}||{{ item_name }}||qty" value="{{ option.default[item_name]|default("0") }}" data-option-name="{{ option_name }}" data-item-name="{{ item_name }}" />
@@ -222,7 +213,7 @@
 {% endmacro %}
 
 {% macro RandomizeButton(option_name, option) %}
-    <div class="randomize-button" data-tooltip="Pick a random value for this option.">
+    <div class="randomize-button" data-tooltip="Toggle randomization for this option!">
         <label for="random-{{ option_name }}">
             <input type="checkbox" id="random-{{ option_name }}" name="random-{{ option_name }}" class="randomize-checkbox" data-option-name="{{ option_name }}" {{ "checked" if option.default == "random" }} />
             🎲

WebHostLib/templates/playerOptions/playerOptions.html

@@ -93,10 +93,8 @@
                                         {% elif issubclass(option, Options.FreeText) %}
                                             {{ inputs.FreeText(option_name, option) }}
 
-                                        {% elif issubclass(option, Options.OptionCounter) and (
+                                        {% elif issubclass(option, Options.ItemDict) and option.verify_item_name %}
-                                            option.valid_keys or option.verify_item_name or option.verify_location_name
+                                            {{ inputs.ItemDict(option_name, option) }}
-                                        ) %}
-                                            {{ inputs.OptionCounter(option_name, option) }}
 
                                         {% elif issubclass(option, Options.OptionList) and option.valid_keys %}
                                             {{ inputs.OptionList(option_name, option) }}
@@ -135,10 +133,8 @@
                                         {% elif issubclass(option, Options.FreeText) %}
                                             {{ inputs.FreeText(option_name, option) }}
 
-                                        {% elif issubclass(option, Options.OptionCounter) and (
+                                        {% elif issubclass(option, Options.ItemDict) and option.verify_item_name %}
-                                            option.valid_keys or option.verify_item_name or option.verify_location_name
+                                            {{ inputs.ItemDict(option_name, option) }}
-                                        ) %}
-                                            {{ inputs.OptionCounter(option_name, option) }}
 
                                         {% elif issubclass(option, Options.OptionList) and option.valid_keys %}
                                             {{ inputs.OptionList(option_name, option) }}

WebHostLib/templates/seedError.html

@@ -1,6 +1,5 @@
 {% extends 'pageWrapper.html' %}
 {% import "macros.html" as macros %}
-{% set show_footer = True %}
 
 {% block head %}
     <title>Generation failed, please retry.</title>
@@ -16,4 +15,5 @@
             {{ seed_error }}
         </div>
     </div>
+    {% include 'islandFooter.html' %}
 {% endblock %}

WebHostLib/templates/startPlaying.html

@@ -1,5 +1,4 @@
 {% extends 'pageWrapper.html' %}
-{% set show_footer = True %}
 
 {% block head %}
     <title>Start Playing</title>
@@ -27,4 +26,6 @@
             </p>
         </div>
     </div>
+
+    {% include 'islandFooter.html' %}
 {% endblock %}

WebHostLib/templates/tracker__Timespinner.html

@@ -99,52 +99,6 @@
                 {% endif %}
                 </div>
             </div>
-            {% if 'PrismBreak' in options or 'LockKeyAmadeus' in options or 'GateKeep' in options %}
-            <div class="table-row">
-                {% if 'PrismBreak' in options %}
-                <div class="C1">
-                    <div class="image-stack">
-                        <div class="stack-front">
-                            <div class="stack-top-left">
-                                <img src="{{ icons['Laser Access'] }}" class="hotpink {{ 'acquired' if 'Laser Access A' in acquired_items }}" title="Laser Access A" />
-                            </div>
-                            <div class="stack-top-right">
-                                <img src="{{ icons['Laser Access'] }}" class="lightsalmon {{ 'acquired' if 'Laser Access I' in acquired_items }}" title="Laser Access I" />
-                            </div>
-                            <div class="stack-bottum-left">
-                                <img src="{{ icons['Laser Access'] }}" class="crimson {{ 'acquired' if 'Laser Access M' in acquired_items }}" title="Laser Access M" />
-                            </div>
-                        </div>
-                    </div>
-		</div>
-                {% endif %}
-                {% if 'LockKeyAmadeus' in options %}
-                <div class="C2">
-                    <div class="image-stack">
-                        <div class="stack-front">
-                            <div class="stack-top-left">
-                                <img src="{{ icons['Lab Glasses'] }}" class="{{ 'acquired' if 'Lab Access Genza' in acquired_items }}" title="Lab Access Genza" />
-                            </div>
-                            <div class="stack-top-right">
-                                <img src="{{ icons['Eye Orb'] }}" class="{{ 'acquired' if 'Lab Access Dynamo' in acquired_items }}" title="Lab Access Dynamo" />
-                            </div>
-                            <div class="stack-bottum-left">
-                                <img src="{{ icons['Lab Coat'] }}" class="{{ 'acquired' if 'Lab Access Research' in acquired_items }}" title="Lab Access Research" />
-                            </div>
-                            <div class="stack-bottum-right">
-                                <img src="{{ icons['Demon'] }}" class="{{ 'acquired' if 'Lab Access Experiment' in acquired_items }}" title="Lab Access Experiment" />
-                            </div>
-                        </div>
-                    </div>
-		</div>
-                {% endif %}
-                {% if 'GateKeep' in options %}
-                <div class="C3">
-                    <span class="{{ 'acquired' if 'Drawbridge Key' in acquired_items }}" title="Drawbridge Key">&#10070;</span>
-		</div>
-                {% endif %}
-	    </div>
-            {% endif %}
         </div>
 
         <table id="location-table">

WebHostLib/templates/userContent.html

@@ -29,8 +29,7 @@
     <div id="user-content-wrapper" class="markdown">
         <div id="user-content" class="grass-island">
             <h1>User Content</h1>
-            Below is a list of all the content you have generated on this site. Rooms and seeds are listed separately.<br/>
+            Below is a list of all the content you have generated on this site. Rooms and seeds are listed separately.
-            Sessions can be saved or synced across devices using the <a href="{{url_for('show_session')}}">Sessions Page.</a>
 
             <h2>Your Rooms</h2>
             {% if rooms %}

WebHostLib/templates/viewSeed.html

@@ -1,6 +1,5 @@
 {% extends 'pageWrapper.html' %}
 {% import "macros.html" as macros %}
-{% set show_footer = True %}
 
 {% block head %}
     <title>View Seed {{ seed.id|suuid }}</title>
@@ -51,4 +50,5 @@
             </table>
         </div>
     </div>
+    {% include 'islandFooter.html' %}
 {% endblock %}

WebHostLib/templates/waitSeed.html

@@ -1,12 +1,9 @@
 {% extends 'pageWrapper.html' %}
 {% import "macros.html" as macros %}
-{% set show_footer = True %}
 
 {% block head %}
     <title>Generation in Progress</title>
-    <noscript>
+    <meta http-equiv="refresh" content="1">
-        <meta http-equiv="refresh" content="1">
-    </noscript>
     <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/waitSeed.css") }}"/>
 {% endblock %}
 
@@ -18,34 +15,5 @@
             Waiting for game to generate, this page auto-refreshes to check.
         </div>
     </div>
-    <script>
+    {% include 'islandFooter.html' %}
-        const waitSeedDiv = document.getElementById("wait-seed");
-        async function checkStatus() {
-            try {
-                const response = await fetch("{{ url_for('api.wait_seed_api', seed=seed_id) }}");
-                if (response.status !== 202) {
-                    // Seed is ready; reload page to load seed page.
-                    location.reload();
-                    return;
-                }
-
-                const data = await response.json();
-                waitSeedDiv.innerHTML = `
-                    <h1>Generation in Progress</h1>
-                    <p>${data.text}</p>
-                `;
-
-                setTimeout(checkStatus, 1000); // Continue polling.
-            } catch (error) {
-                waitSeedDiv.innerHTML = `
-                    <h1>Progress Unknown</h1>
-                    <p>${error.message}<br />(Last checked: ${new Date().toLocaleTimeString()})</p>
-                `;
-
-                setTimeout(checkStatus, 1000);
-            }
-        }
-
-        setTimeout(checkStatus, 1000);
-    </script>
 {% endblock %}

WebHostLib/templates/weightedOptions/macros.html

@@ -113,18 +113,9 @@
     {{ TextChoice(option_name, option) }}
 {% endmacro %}
 
-{% macro OptionCounter(option_name, option, world) %}
+{% macro ItemDict(option_name, option, world) %}
-    {% set relevant_keys = option.valid_keys %}
-    {% if not relevant_keys %}
-        {% if option.verify_item_name %}
-            {% set relevant_keys = world.item_names %}
-        {% elif option.verify_location_name %}
-            {% set relevant_keys = world.location_names %}
-        {% endif %}
-    {% endif %}
-
     <div class="dict-container">
-        {% for item_name in (relevant_keys if relevant_keys is ordered else relevant_keys|sort) %}
+        {% for item_name in (option.valid_keys|sort if (option.valid_keys|length > 0) else world.item_names|sort) %}
             <div class="dict-entry">
                 <label for="{{ option_name }}-{{ item_name }}-qty">{{ item_name }}</label>
                 <input

WebHostLib/templates/weightedOptions/weightedOptions.html

@@ -83,10 +83,8 @@
                                 {% elif issubclass(option, Options.FreeText) %}
                                     {{ inputs.FreeText(option_name, option) }}
 
-                                {% elif issubclass(option, Options.OptionCounter) and (
+                                {% elif issubclass(option, Options.ItemDict) and option.verify_item_name %}
-                                    option.valid_keys or option.verify_item_name or option.verify_location_name
+                                    {{ inputs.ItemDict(option_name, option, world) }}
-                                ) %}
-                                    {{ inputs.OptionCounter(option_name, option, world) }}
 
                                 {% elif issubclass(option, Options.OptionList) and option.valid_keys %}
                                     {{ inputs.OptionList(option_name, option) }}
@@ -102,7 +100,7 @@
 
                                 {% else %}
                                     <div class="unsupported-option">
-                                        This option cannot be modified here. Please edit your .yaml file manually.
+                                        This option is not supported. Please edit your .yaml file manually.
                                     </div>
 
                                 {% endif %}

WebHostLib/tracker.py

@@ -1071,11 +1071,6 @@ if "Timespinner" in network_data_package["games"]:
             "Plasma Orb":          "https://timespinnerwiki.com/mediawiki/images/4/44/Plasma_Orb.png",
             "Kobo":                "https://timespinnerwiki.com/mediawiki/images/c/c6/Familiar_Kobo.png",
             "Merchant Crow":       "https://timespinnerwiki.com/mediawiki/images/4/4e/Familiar_Crow.png",
-            "Laser Access":        "https://timespinnerwiki.com/mediawiki/images/9/99/Historical_Documents.png",
-            "Lab Glasses":         "https://timespinnerwiki.com/mediawiki/images/4/4a/Lab_Glasses.png",
-            "Eye Orb":             "https://timespinnerwiki.com/mediawiki/images/a/a4/Eye_Orb.png",
-            "Lab Coat":            "https://timespinnerwiki.com/mediawiki/images/5/51/Lab_Coat.png", 
-            "Demon":               "https://timespinnerwiki.com/mediawiki/images/f/f8/Familiar_Demon.png", 
         }
 
         timespinner_location_ids = {
@@ -1123,9 +1118,6 @@ if "Timespinner" in network_data_package["games"]:
             timespinner_location_ids["Ancient Pyramid"] += [
                 1337237, 1337238, 1337239,
                 1337240, 1337241, 1337242, 1337243, 1337244, 1337245]
-        if (slot_data["PyramidStart"]):
-            timespinner_location_ids["Ancient Pyramid"] += [
-                1337233, 1337234, 1337235]
 
         display_data = {}
 

Zelda1Client.py

@@ -386,7 +386,7 @@ if __name__ == '__main__':
     parser.add_argument('diff_file', default="", type=str, nargs="?",
                         help='Path to a Archipelago Binary Patch file')
     args = parser.parse_args()
-    colorama.just_fix_windows_console()
+    colorama.init()
 
     asyncio.run(main(args))
     colorama.deinit()

data/client.kv

@@ -14,60 +14,23 @@
     salmon: "FA8072"  # typically trap item
     white: "FFFFFF"  # not used, if you want to change the generic text color change color in Label
     orange: "FF7700"  # Used for command echo
-    # KivyMD theming parameters
+<Label>:
-    theme_style: "Dark" # Light/Dark
+    color: "FFFFFF"
-    primary_palette: "Lightsteelblue" # Many options
+<TabbedPanel>:
-    dynamic_scheme_name: "VIBRANT"
+    tab_width: root.width / app.tab_count
-    dynamic_scheme_contrast: 0.0
-<MDLabel>:
-    color: self.theme_cls.primaryColor
-<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
 <TooltipLabel>:
-    adaptive_height: True
+    text_size: self.width, None
-    theme_font_size: "Custom"
+    size_hint_y: None
-    font_size: "20dp"
+    height: self.texture_size[1]
+    font_size: dp(20)
     markup: True
-    halign: "left"
 <SelectableLabel>:
-    size_hint: 1, None
-    theme_text_color: "Custom"
-    text_color: 1, 1, 1, 1
     canvas.before:
         Color:
-            rgba: (self.theme_cls.primaryColor[0], self.theme_cls.primaryColor[1], self.theme_cls.primaryColor[2], .3) if self.selected else self.theme_cls.surfaceContainerLowestColor
+            rgba: (.0, 0.9, .1, .3) if self.selected else (0.2, 0.2, 0.2, 1)
         Rectangle:
             size: self.size
             pos: self.pos
-<MarkupDropdownItem>
-    orientation: "vertical"
-
-    MDLabel:
-        text: root.text
-        valign: "center"
-        padding_x: "12dp"
-        shorten: True
-        shorten_from: "right"
-        theme_text_color: "Custom"
-        markup: True
-        text_color:
-            app.theme_cls.onSurfaceVariantColor \
-            if not root.text_color else \
-            root.text_color
-
-    MDDivider:
-        md_bg_color:
-            ( \
-            app.theme_cls.outlineVariantColor \
-            if not root.divider_color \
-            else root.divider_color \
-            ) \
-            if root.divider else \
-            (0, 0, 0, 0)
 <UILog>:
     messages: 1000 # amount of messages stored in client logs.
     cols: 1
@@ -86,7 +49,7 @@
 <HintLabel>:
     canvas.before:
         Color:
-            rgba: (.0, 0.9, .1, .3) if self.selected else self.theme_cls.surfaceContainerHighColor if self.striped else self.theme_cls.surfaceContainerLowColor
+            rgba: (.0, 0.9, .1, .3) if self.selected else (0.2, 0.2, 0.2, 1) if self.striped else (0.18, 0.18, 0.18, 1)
         Rectangle:
             size: self.size
             pos: self.pos
@@ -163,12 +126,9 @@
 <ToolTip>:
     size: self.texture_size
     size_hint: None, None
-    theme_font_size: "Custom"
     font_size: dp(18)
     pos_hint: {'center_y': 0.5, 'center_x': 0.5}
     halign: "left"
-    theme_text_color: "Custom"
-    text_color: (1, 1, 1, 1)
     canvas.before:
         Color:
             rgba: 0.2, 0.2, 0.2, 1
@@ -187,38 +147,8 @@
             rectangle: self.x-2, self.y-2, self.width+4, self.height+4
 <ServerToolTip>:
     pos_hint: {'center_y': 0.5, 'center_x': 0.5}
-<AutocompleteHintInput>:
+<AutocompleteHintInput>
     size_hint_y: None
-    height: "30dp"
+    height: dp(30)
     multiline: False
     write_tab: False
-    pos_hint: {"center_x": 0.5, "center_y": 0.5}
-<ConnectBarTextInput>:
-    height: "30dp"
-    multiline: False
-    write_tab: False
-    role: "medium"
-    size_hint_y: None
-    pos_hint: {"center_x": 0.5, "center_y": 0.5}
-<CommandPromptTextInput>:
-    size_hint_y: None
-    height: "30dp"
-    multiline: False
-    write_tab: False
-    pos_hint: {"center_x": 0.5, "center_y": 0.5}
-<MessageBoxLabel>:
-    theme_text_color: "Custom"
-    text_color: 1, 1, 1, 1
-<ScrollBox>:
-    layout: layout
-    bar_width: "12dp"
-    scroll_wheel_distance: 40
-    do_scroll_x: False
-    scroll_type: ['bars', 'content']
-
-    MDBoxLayout:
-        id: layout
-        orientation: "vertical"
-        spacing: 10
-        size_hint_y: None
-        height: self.minimum_height

data/launcher.kv

@@ -1,161 +0,0 @@
-<LauncherCard>:
-    id: main
-    style: "filled"
-    padding: "4dp"
-    size_hint: 1, None
-    height: "75dp"
-    context_button: context
-    focus_behavior: False
-
-    MDRelativeLayout:
-        ApAsyncImage:
-            source: main.image
-            size: (48, 48)
-            size_hint: None, None
-            pos_hint: {"center_x": 0.1, "center_y": 0.5}
-
-        MDLabel:
-            text: main.component.display_name
-            pos_hint:{"center_x": 0.5, "center_y": 0.75 if main.component.description else 0.65}
-            halign: "center"
-            font_style: "Title"
-            role: "medium"
-            theme_text_color: "Custom"
-            text_color: app.theme_cls.primaryColor
-
-        MDLabel:
-            text: main.component.description
-            pos_hint: {"center_x": 0.5, "center_y": 0.35}
-            halign: "center"
-            role: "small"
-            theme_text_color: "Custom"
-            text_color: app.theme_cls.primaryColor
-
-        MDIconButton:
-            component: main.component
-            icon: "star" if self.component.display_name in app.favorites else "star-outline"
-            style: "standard"
-            pos_hint:{"center_x": 0.85, "center_y": 0.8}
-            theme_text_color: "Custom"
-            text_color: app.theme_cls.primaryColor
-            detect_visible: False
-            on_release: app.set_favorite(self)
-
-        MDIconButton:
-            id: context
-            icon: "menu"
-            style: "standard"
-            pos_hint:{"center_x": 0.95, "center_y": 0.8}
-            theme_text_color: "Custom"
-            text_color: app.theme_cls.primaryColor
-            detect_visible: False
-
-        MDButton:
-            pos_hint:{"center_x": 0.9, "center_y": 0.25}
-            size_hint_y: None
-            height: "25dp"
-            component: main.component
-            on_release: app.component_action(self)
-            detect_visible: False
-            MDButtonText:
-                text: "Open"
-
-
-#:import Type worlds.LauncherComponents.Type
-MDFloatLayout:
-    id: top_screen
-
-    MDGridLayout:
-        id: grid
-        cols: 2
-        spacing: "5dp"
-        padding: "10dp"
-
-        MDGridLayout:
-            id: navigation
-            cols: 1
-            size_hint_x: 0.25
-
-            MDButton:
-                id: all
-                style: "text"
-                type: (Type.CLIENT, Type.TOOL, Type.ADJUSTER, Type.MISC)
-                on_release: app.filter_clients_by_type(self)
-
-                MDButtonIcon:
-                    icon: "asterisk"
-                MDButtonText:
-                    text: "All"
-            MDButton:
-                id: client
-                style: "text"
-                type: (Type.CLIENT, )
-                on_release: app.filter_clients_by_type(self)
-
-                MDButtonIcon:
-                    icon: "controller"
-                MDButtonText:
-                    text: "Client"
-            MDButton:
-                id: Tool
-                style: "text"
-                type: (Type.TOOL, )
-                on_release: app.filter_clients_by_type(self)
-
-                MDButtonIcon:
-                    icon: "desktop-classic"
-                MDButtonText:
-                    text: "Tool"
-            MDButton:
-                id: adjuster
-                style: "text"
-                type: (Type.ADJUSTER, )
-                on_release: app.filter_clients_by_type(self)
-
-                MDButtonIcon:
-                    icon: "wrench"
-                MDButtonText:
-                    text: "Adjuster"
-            MDButton:
-                id: misc
-                style: "text"
-                type: (Type.MISC, )
-                on_release: app.filter_clients_by_type(self)
-
-                MDButtonIcon:
-                    icon: "dots-horizontal-circle-outline"
-                MDButtonText:
-                    text: "Misc"
-
-            MDButton:
-                id: favorites
-                style: "text"
-                type: ("favorites", )
-                on_release: app.filter_clients_by_type(self)
-
-                MDButtonIcon:
-                    icon: "star"
-                MDButtonText:
-                    text: "Favorites"
-
-            MDNavigationDrawerDivider:
-
-
-        MDGridLayout:
-            id: main_layout
-            cols: 1
-            spacing: "10dp"
-
-            MDTextField:
-                id: search_box
-                mode: "outlined"
-                set_text: app.filter_clients_by_name
-
-                MDTextFieldLeadingIcon:
-                    icon: "magnify"
-
-                MDTextFieldHintText:
-                    text: "Search"
-
-            ScrollBox:
-                id: button_layout

docs/CODEOWNERS

@@ -45,9 +45,6 @@
 # ChecksFinder
 /worlds/checksfinder/ @SunCatMC
 
-# Civilization VI
-/worlds/civ6/ @hesto2
-
 # Clique
 /worlds/clique/ @ThePhar
 
@@ -184,6 +181,9 @@
 # Secret of Evermore
 /worlds/soe/ @black-sliver
 
+# Slay the Spire
+/worlds/spire/ @KonoTyran
+
 # Stardew Valley
 /worlds/stardew_valley/ @agilbert1412
 
@@ -211,9 +211,6 @@
 # Wargroove
 /worlds/wargroove/ @FlySniper
 
-# The Wind Waker
-/worlds/tww/ @tanjo3
-
 # The Witness
 /worlds/witness/ @NewSoupVi @blastron
 
@@ -229,6 +226,10 @@
 # Zillion
 /worlds/zillion/ @beauxq
 
+# Zork Grand Inquisitor
+/worlds/zork_grand_inquisitor/ @nbrochu
+
+
 ## Active Unmaintained Worlds
 
 # The following worlds in this repo are currently unmaintained, but currently still work in core. If any update breaks

docs/adding games.md

@@ -1,8 +1,5 @@
 # Adding Games
 
-Like all contributions to Archipelago, New Game implementations should follow the [Contributing](/docs/contributing.md)
-guide.
-
 Adding a new game to Archipelago has two major parts:
 
 * Game Modification to communicate with Archipelago server (hereafter referred to as "client")
@@ -16,51 +13,30 @@ it will not be detailed here.
 
 The client is an intermediary program between the game and the Archipelago server. This can either be a direct
 modification to the game, an external program, or both. This can be implemented in nearly any modern language, but it
-must fulfill a few requirements in order to function as expected. Libraries for most modern languages and the spec for 
+must fulfill a few requirements in order to function as expected. The specific requirements the game client must follow
-various packets can be found in the [network protocol](/docs/network%20protocol.md) API reference document.
+to behave as expected are:
-
-### Hard Requirements
-
-In order for the game client to behave as expected, it must be able to perform these functions:
 
 * Handle both secure and unsecure websocket connections
-* Reconnect if the connection is unstable and lost while playing
+* Detect and react when a location has been "checked" by the player by sending a network packet to the server
+* Receive and parse network packets when the player receives an item from the server, and reward it to the player on
+demand
+  * **Any** of your items can be received any number of times, up to and far surpassing those that the game might
+normally expect from features such as starting inventory, item link replacement, or item cheating
+  * Players and the admin can cheat items to the player at any time with a server command, and these items may not have
+a player or location attributed to them
 * Be able to change the port for saved connection info
   * Rooms hosted on the website attempt to reserve their port, but since there are a limited number of ports, this
-    privilege can be lost, requiring the room to be moved to a new port
+privilege can be lost, requiring the room to be moved to a new port
+* Reconnect if the connection is unstable and lost while playing
+* Keep an index for items received in order to resync. The ItemsReceived Packets are a single list with guaranteed 
+order.
+* Receive items that were sent to the player while they were not connected to the server
+  * The player being able to complete checks while offline and sending them when reconnecting is a good bonus, but not 
+strictly required
 * Send a status update packet alerting the server that the player has completed their goal
 
-Regarding items and locations, the game client must be able to handle these tasks:
+Libraries for most modern languages and the spec for various packets can be found in the
-
+[network protocol](/docs/network%20protocol.md) API reference document.
-#### Location Handling
-
-Send a network packet to the server when it detects a location has been "checked" by the player in-game.
-
-* If actions were taken in game that would usually trigger a location check, and those actions can only ever be taken 
-  once, but the client was not connected when they happened: The client must send those location checks on connection 
-  so that they are not permanently lost, e.g. by reading flags in the game state or save file.
-
-#### Item Handling
-
-Receive and parse network packets from the server when the player receives an item.
-
-* It must reward items to the player on demand, as items can come from other players at any time.
-* It must be able to reward copies of an item, up to and beyond the number the game normally expects. This may happen
-  due to features such as starting inventory, item link replacement, admin commands, or item cheating. **Any** of 
-  your items can be received **any** number of times.
-* Admins and players may use server commands to create items without a player or location attributed to them. The
-  client must be able to handle these items.
-* It must keep an index for items received in order to resync. The ItemsReceived Packets are a single list with a
-  guaranteed order.
-* It must be able to receive items that were sent to the player while they were not connected to the server.
-
-### Encouraged Features
-
-These are "nice to have" features for a client, but they are not strictly required. It is encouraged to add them 
-if possible.
-
-* If your client appears in the Archipelago Launcher, you may define an icon for it that differentiates it from
-  other clients. The icon size is 48x48 pixels, but smaller or larger images will scale to that size.
 
 ## World
 
@@ -68,94 +44,35 @@ The world is your game integration for the Archipelago generator, webhost, and m
 information necessary for creating the items and locations to be randomized, the logic for item placement, the 
 datapackage information so other game clients can recognize your game data, and documentation. Your world must be
 written as a Python package to be loaded by Archipelago. This is currently done by creating a fork of the Archipelago
-repository and creating a new world package in `/worlds/`. 
+repository and creating a new world package in `/worlds/`. A bare minimum world implementation must satisfy the 
+following requirements:
 
-The base World class can be found in [AutoWorld](/worlds/AutoWorld.py). Methods available for your world to call 
+* A folder within `/worlds/` that contains an `__init__.py`
-during generation can be found in [BaseClasses](/BaseClasses.py) and [Fill](/Fill.py). Some examples and documentation 
+* A `World` subclass where you create your world and define all of its rules
-regarding the API can be found in the [world api doc](/docs/world%20api.md). Before publishing, make sure to also 
+* A unique game name
-check out [world maintainer.md](/docs/world%20maintainer.md).
+* For webhost documentation and behaviors, a `WebWorld` subclass that must be instantiated in the `World` class 
-
+definition
-### Hard Requirements
+  * The game_info doc must follow the format `{language_code}_{game_name}.md`
-
-A bare minimum world implementation must satisfy the following requirements:
-
-* It has a folder with the name of your game (or an abbreviation) under `/worlds/` 
-* The `/worlds/{game}` folder contains an `__init__.py`
-* Any subfolders within `/worlds/{game}` that contain `*.py` files also contain an `__init__.py` for frozen build 
-  packaging
-* The game folder has at least one game_info doc named with follow the format `{language_code}_{game_name}.md`
-* The game folder has at least one setup doc
-* There must be a `World` subclass in your game folder (typically in `/worlds/{game}/__init__.py`) where you create 
-  your world and define all of its rules and features
-
-Within the `World` subclass you should also have:
-
-* A [unique game name](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L260)
-* An [instance](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L295) of a `WebWorld` 
-subclass for webhost documentation and behaviors
-  * In your `WebWorld`, if you wrote a game_info doc in more than one language, override the list of 
-    [game info languages](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L210) with the 
-    ones you include.
-  * In your `WebWorld`, override the list of 
-    [tutorials](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L213) with each tutorial
-    or setup doc you included in the game folder.
 * A mapping for items and locations defining their names and ids for clients to be able to identify them. These are 
-  `item_name_to_id` and `location_name_to_id`, respectively.
+`item_name_to_id` and `location_name_to_id`, respectively.
-* An implementation of `create_item` that can create an item when called by either your code or by another process 
+* Create an item when `create_item` is called both by your code and externally
-  within Archipelago
-* At least one `Region` for your player to start from (i.e. the Origin Region)
-  * The default name of this region is "Menu" but you may configure a different name with 
-    [origin_region_name](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L298-L299)
-* A non-zero number of locations, added to your regions
-* A non-zero number of items **equal** to the number of locations, added to the multiworld itempool
-  * In rare cases, there may be 0-location-0-item games, but this is extremely atypical.
-* A set 
-  [completion condition](https://github.com/ArchipelagoMW/Archipelago/blob/main/BaseClasses.py#L77) (aka "goal") for
-  the player.
-  * Use your player as the index (`multiworld.completion_condition[player]`) for your world's completion goal.
-
-### Encouraged Features
-
-These are "nice to have" features for a world, but they are not strictly required. It is encouraged to add them 
-if possible.
-
-* An implementation of
-  [get_filler_item_name](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L473)
-  * By default, this function chooses any item name from `item_name_to_id`, so you want to limit it to only the true
-    filler items.
 * An `options_dataclass` defining the options players have available to them
-  * This should be accompanied by a type hint for `options` with the same class name
+* A `Region` for your player with the name "Menu" to start from
-* A [bug report page](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L220)
+* Create a non-zero number of locations and add them to your regions
-* A list of [option groups](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L226) 
+* Create a non-zero number of items **equal** to the number of locations and add them to the multiworld itempool
-  for better organization on the webhost
+* All items submitted to the multiworld itempool must not be manually placed by the World. If you need to place specific 
-* A dictionary of [options presets](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L223)
+items, there are multiple ways to do so, but they should not be added to the multiworld itempool.
-  for player convenience
-* A dictionary of [item name groups](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L273)
-  for player convenience
-* A dictionary of 
-  [location name groups](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L276)
-  for player convenience
-  * Other games may also benefit from your name group dictionaries for hints, features, etc.
 
-### Discouraged or Prohibited Behavior
+Notable caveats:
-
+* The "Menu" region will always be considered the "start" for the player
-These are behaviors or implementations that are known to cause various issues. Some of these points have notable
+* The "Menu" region is *always* considered accessible; i.e. the player is expected to always be able to return to the
-workarounds or preferred methods which should be used instead:
-
-* All items submitted to the multiworld itempool must not be manually placed by the World. 
-  * If you need to place specific items, there are multiple ways to do so, but they should not be added to the 
-    multiworld itempool.
-* It is not allowed to use `eval` for most reasons, chiefly due to security concerns. 
-* It is discouraged to use PyYAML (i.e. `yaml.load`) directly due to security concerns.
-  * When possible, use `Utils.parse_yaml` instead, as this defaults to the safe loader and the faster C parser.
-* When submitting regions or items to the multiworld (`multiworld.regions` and `multiworld.itempool` respectively), 
-  do **not** use `=` as this will overwrite all elements for all games in the seed.
-  * Instead, use `append`, `extend`, or `+=`.
-
-### Notable Caveats
-
-* The Origin Region will always be considered the "start" for the player
-* The Origin Region is *always* considered accessible; i.e. the player is expected to always be able to return to the
 start of the game from anywhere
+* When submitting regions or items to the multiworld (multiworld.regions and multiworld.itempool respectively), use 
+`append`, `extend`, or `+=`. **Do not use `=`**
 * Regions are simply containers for locations that share similar access rules. They do not have to map to 
 concrete, physical areas within your game and can be more abstract like tech trees or a questline.
+
+The base World class can be found in [AutoWorld](/worlds/AutoWorld.py). Methods available for your world to call during
+generation can be found in [BaseClasses](/BaseClasses.py) and [Fill](/Fill.py). Some examples and documentation 
+regarding the API can be found in the [world api doc](/docs/world%20api.md).
+Before publishing, make sure to also check out [world maintainer.md](/docs/world%20maintainer.md).

docs/apworld_dev_faq.md

@@ -8,11 +8,7 @@ including [Contributing](contributing.md), [Adding Games](<adding games.md>), an
 
 ### My game has a restrictive start that leads to fill errors
 
-A "restrictive start" here means having a combination of very few sphere 1 locations and potentially requiring more
+Hint to the Generator that an item needs to be in sphere one with local_early_items. Here, `1` represents the number of "Sword" items to attempt to place in sphere one.
-than one item to get a player to sphere 2.
-
-One way to fix this is to hint to the Generator that an item needs to be in sphere one with local_early_items. 
-Here, `1` represents the number of "Sword" items the Generator will attempt to place in sphere one.
 ```py
 early_item_name = "Sword"
 self.multiworld.local_early_items[self.player][early_item_name] = 1
@@ -22,19 +18,15 @@ Some alternative ways to try to fix this problem are:
 * Add more locations to sphere one of your world, potentially only when there would be a restrictive start
 * Pre-place items yourself, such as during `create_items`
 * Put items into the player's starting inventory using `push_precollected`
-* Raise an exception, such as an `OptionError` during `generate_early`, to disallow options that would lead to a
+* Raise an exception, such as an `OptionError` during `generate_early`, to disallow options that would lead to a restrictive start
-  restrictive start
 
 ---
 
-### I have multiple options that change the item/location pool counts and need to make sure I am not submitting more/fewer items than locations
+### I have multiple settings that change the item/location pool counts and need to balance them out
 
-In an ideal situation your system for producing locations and items wouldn't leave any opportunity for them to be
+In an ideal situation your system for producing locations and items wouldn't leave any opportunity for them to be unbalanced. But in real, complex situations, that might be unfeasible.
-unbalanced. But in real, complex situations, that might be unfeasible.
 
-If that's the case, you can create extra filler based on the difference between your unfilled locations and your
+If that's the case, you can create extra filler based on the difference between your unfilled locations and your itempool by comparing [get_unfilled_locations](https://github.com/ArchipelagoMW/Archipelago/blob/main/BaseClasses.py#:~:text=get_unfilled_locations) to your list of items to submit
-itempool by comparing [get_unfilled_locations](https://github.com/ArchipelagoMW/Archipelago/blob/main/BaseClasses.py#:~:text=get_unfilled_locations)
-to your list of items to submit
 
 Note: to use self.create_filler(), self.get_filler_item_name() should be defined to only return valid filler item names
 ```py
@@ -47,8 +39,7 @@ for _ in range(total_locations - len(item_pool)):
 self.multiworld.itempool += item_pool
 ```
 
-A faster alternative to the `for` loop would be to use a
+A faster alternative to the `for` loop would be to use a [list comprehension](https://docs.python.org/3/tutorial/datastructures.html#list-comprehensions):
-[list comprehension](https://docs.python.org/3/tutorial/datastructures.html#list-comprehensions):
 ```py
 item_pool += [self.create_filler() for _ in range(total_locations - len(item_pool))]
 ```
@@ -57,68 +48,21 @@ item_pool += [self.create_filler() for _ in range(total_locations - len(item_poo
 
 ### I learned about indirect conditions in the world API document, but I want to know more. What are they and why are they necessary?
 
-The world API document mentions how to use `multiworld.register_indirect_condition` to register indirect conditions and
+The world API document mentions how to use `multiworld.register_indirect_condition` to register indirect conditions and **when** you should use them, but not *how* they work and *why* they are necessary. This is because the explanation is quite complicated.
-**when** you should use them, but not *how* they work and *why* they are necessary. This is because the explanation is
-quite complicated.
 
-Region sweep (the algorithm that determines which regions are reachable) is a Breadth-First Search of the region graph.
+Region sweep (the algorithm that determines which regions are reachable) is a Breadth-First Search of the region graph. It starts from the origin region, checks entrances one by one, and adds newly reached regions and their entrances to the queue until there is nothing more to check.
-It starts from the origin region, checks entrances one by one, and adds newly reached regions and their entrances to
-the queue until there is nothing more to check.
 
-For performance reasons, AP only checks every entrance once. However, if an entrance's access_rule depends on region
+For performance reasons, AP only checks every entrance once. However, if an entrance's access_rule depends on region access, then the following may happen:
-access, then the following may happen:
+1. The entrance is checked and determined to be nontraversable because the region in its access_rule hasn't been reached yet during the graph search.
-1. The entrance is checked and determined to be nontraversable because the region in its access_rule hasn't been
-   reached yet during the graph search.
 2. Then, the region in its access_rule is determined to be reachable.
 
 This entrance *would* be in logic if it were rechecked, but it won't be rechecked this cycle.
-To account for this case, AP would have to recheck all entrances every time a new region is reached until no new
+To account for this case, AP would have to recheck all entrances every time a new region is reached until no new regions are reached.
-regions are reached.
 
-An indirect condition is how you can manually define that a specific entrance needs to be rechecked during region sweep
+An indirect condition is how you can manually define that a specific entrance needs to be rechecked during region sweep if a specific region is reached during it.
-if a specific region is reached during it.
+This keeps most of the performance upsides. Even in a game making heavy use of indirect conditions (ex: The Witness), using them is significantly faster than just "rechecking each entrance until nothing new is found".
-This keeps most of the performance upsides. Even in a game making heavy use of indirect conditions (ex: The Witness),
+The reason entrance access rules using `location.can_reach` and `entrance.can_reach` are also affected is because they call `region.can_reach` on their respective parent/source region.
-using them is significantly faster than just "rechecking each entrance until nothing new is found".
-The reason entrance access rules using `location.can_reach` and `entrance.can_reach` are also affected is because they
-call `region.can_reach` on their respective parent/source region.
 
-We recognize it can feel like a trap since it will not alert you when you are missing an indirect condition,
+We recognize it can feel like a trap since it will not alert you when you are missing an indirect condition, and that some games have very complex access rules.
-and that some games have very complex access rules.
+As of [PR #3682 (Core: Region handling customization)](https://github.com/ArchipelagoMW/Archipelago/pull/3682) being merged, it is possible for a world to opt out of indirect conditions entirely, instead using the system of checking each entrance whenever a region has been reached, although this does come with a performance cost.
-As of [PR #3682 (Core: Region handling customization)](https://github.com/ArchipelagoMW/Archipelago/pull/3682)
+Opting out of using indirect conditions should only be used by games that *really* need it. For most games, it should be reasonable to know all entrance &rarr; region dependencies, making indirect conditions preferred because they are much faster.
-being merged, it is possible for a world to opt out of indirect conditions entirely, instead using the system of
-checking each entrance whenever a region has been reached, although this does come with a performance cost.
-Opting out of using indirect conditions should only be used by games that *really* need it. For most games, it should
-be reasonable to know all entrance &rarr; region dependencies, making indirect conditions preferred because they are
-much faster.
-
----
-
-### I uploaded the generated output of my world to the webhost and webhost is erroring on corrupted multidata
-
-The error `Could not load multidata. File may be corrupted or incompatible.` occurs when uploading a locally generated
-file where there is an issue with the multidata contained within it. It may come with a description like
-`(No module named 'worlds.myworld')` or `(global 'worlds.myworld.names.ItemNames' is forbidden)`
-
-Pickling is a way to compress python objects such that they can be decompressed and be used to rebuild the
-python objects. This means that if one of your custom class instances ends up in the multidata, the server would not
-be able to load that custom class to decompress the data, which can fail either because the custom class is unknown
-(because it cannot load your world module) or the class it's attempting to import to decompress is deemed unsafe.
-
-Common situations where this can happen include:
-* Using Option instances directly in slot_data. Ex: using `options.option_name` instead of `options.option_name.value`.
-  Also, consider using the `options.as_dict("option_name", "option_two")` helper.
-* Using enums as Location/Item names in the datapackage. When building out `location_name_to_id` and `item_name_to_id`,
-  make sure that you are not using your enum class for either the names or ids in these mappings.
-
----
-
-### Some locations are technically possible to check with few or no items, but they'd be very tedious or frustrating. How do worlds deal with this?
-
-Sometimes the game can be modded to skip these locations or make them less tedious. But when this issue is due to a fundamental aspect of the game, then the general answer is "soft logic" (and its subtypes like "combat logic", "money logic", etc.). For example: you can logically require that a player have several helpful items before fighting the final boss, even if a skilled player technically needs no items to beat it. Randomizer logic should describe what's *fun* rather than what's technically possible.
-
-Concrete examples of soft logic include:
-- Defeating a boss might logically require health upgrades, damage upgrades, certain weapons, etc. that aren't strictly necessary.
-- Entering a high-level area might logically require access to enough other parts of the game that checking other locations should naturally get the player to the soft-required level.
-- 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`.

docs/network diagram/network diagram.md

@@ -117,6 +117,8 @@ flowchart LR
     %% Java Based Games
     subgraph Java
         JM[Mod with Archipelago.MultiClient.Java]
+        STS[Slay the Spire]
+        JM <-- Mod the Spire --> STS
         subgraph Minecraft
             MCS[Minecraft Forge Server]
             JMC[Any Java Minecraft Clients]

docs/network protocol.md

@@ -470,7 +470,7 @@ The following operations can be applied to a datastorage key
 | right_shift | Applies a bitwise right-shift to the current value of the key by `value`. |
 | remove | List only: removes the first instance of `value` found in the list. |
 | pop | List or Dict: for lists it will remove the index of the `value` given. for dicts it removes the element with the specified key of `value`. |
-| update | List or Dict: Adds the elements of `value` to the container if they weren't already present. In the case of a Dict, already present keys will have their corresponding values updated. |
+| update | Dict only: Updates the dictionary with the specified elements given in `value` creating new keys, or updating old ones if they previously existed. |
 
 ### SetNotify
 Used to register your current session for receiving all [SetReply](#SetReply) packages of certain keys to allow your client to keep track of changes.
@@ -756,8 +756,8 @@ Tags are represented as a list of strings, the common client tags follow:
 ### DeathLink
 A special kind of Bounce packet that can be supported by any AP game. It targets the tag "DeathLink" and carries the following data:
 
-| Name   | Type  | Notes                                                                                                                                                                            |
+| Name   | Type  | Notes                                                                                                                                                  |
-|--------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+|--------|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
-| time   | float | Unix Time Stamp of time of death.                                                                                                                                                |
+| time   | float | Unix Time Stamp of time of death.                                                                                                                      |
-| cause  | str   | Optional. Text to explain the cause of death. When provided, or checked, if the string is non-empty, it should contain the player name, ex. "Berserker was run over by a train." |
+| cause  | str   | Optional. Text to explain the cause of death. When provided, or checked, this should contain the player name, ex. "Berserker was run over by a train." |
-| source | str   | Name of the player who first died. Can be a slot name, but can also be a name from within a multiplayer game.                                                                    |
+| source | str   | Name of the player who first died. Can be a slot name, but can also be a name from within a multiplayer game.                                          |

docs/options api.md

@@ -352,15 +352,8 @@ template. If you set a [Schema](https://pypi.org/project/schema/) on the class w
 options system will automatically validate the user supplied data against the schema to ensure it's in the correct
 format.
 
-### OptionCounter
-This is a special case of OptionDict where the dictionary values can only be integers.  
-It returns a [collections.Counter](https://docs.python.org/3/library/collections.html#collections.Counter).
-This means that if you access a key that isn't present, its value will be 0.  
-The upside of using an OptionCounter (instead of an OptionDict with integer values) is that an OptionCounter can be
-displayed on the Options page on WebHost.
-
 ### ItemDict
-An OptionCounter that will verify that every key in the dictionary is a valid name for an item for your world.
+Like OptionDict, except this will verify that every key in the dictionary is a valid name for an item for your world.
 
 ### OptionList
 This option defines a List, where the user can add any number of strings to said list, allowing duplicate values. You

docs/tests.md

@@ -73,47 +73,15 @@ When tests are run, this class will create a multiworld with a single player hav
 generic tests, as well as the new custom test. Each test method definition will create its own separate solo multiworld
 that will be cleaned up after. If you don't want to run the generic tests on a base, `run_default_tests` can be
 overridden. For more information on what methods are available to your class, check the
-[WorldTestBase definition](/test/bases.py#L106).
+[WorldTestBase definition](/test/bases.py#L104).
 
 #### Alternatives to WorldTestBase
 
-Unit tests can also be created using [TestBase](/test/bases.py#L16) or
+Unit tests can also be created using [TestBase](/test/bases.py#L14) or
 [unittest.TestCase](https://docs.python.org/3/library/unittest.html#unittest.TestCase) depending on your use case. These
 may be useful for generating a multiworld under very specific constraints without using the generic world setup, or for
 testing portions of your code that can be tested without relying on a multiworld to be created first.
 
-#### Parametrization
-
-When defining a test that needs to cover a range of inputs it is useful to parameterize (to run the same test
-for multiple inputs) the base test. Some important things to consider when attempting to parametrize your test are:
-
-* [Subtests](https://docs.python.org/3/library/unittest.html#distinguishing-test-iterations-using-subtests)
-  can be used to have parametrized assertions that show up similar to individual tests but without the overhead
-  of needing to instantiate multiple tests; however, subtests can not be multithreaded and do not have individual
-  timing data, so they are not suitable for slow tests.
-
-* Archipelago's tests are test-runner-agnostic. That means tests are not allowed to use e.g. `@pytest.mark.parametrize`.
-  Instead, we define our own parametrization helpers in [test.param](/test/param.py).
-
-* Classes inheriting from `WorldTestBase`, including those created by the helpers in `test.param`, will run all
-  base tests by default, make sure the produced tests actually do what you aim for and do not waste a lot of
-  extra CPU time. Consider using `TestBase` or `unittest.TestCase` directly
-  or setting `WorldTestBase.run_default_tests` to False.
-
-#### Performance Considerations
-
-Archipelago is big enough that the runtime of unittests can have an impact on productivity.
-
-Individual tests should take less than a second, so they can be properly multithreaded.
-
-Ideally, thorough tests are directed at actual code/functionality. Do not just create and/or fill a ton of individual
-Multiworlds that spend most of the test time outside what you actually want to test.
-
-Consider generating/validating "random" games as part of your APWorld release workflow rather than having that be part
-of continuous integration, and add minimal reproducers to the "normal" tests for problems that were found.
-You can use [@unittest.skipIf](https://docs.python.org/3/library/unittest.html#unittest.skipIf) with an environment
-variable to keep all the benefits of the test framework while not running the marked tests by default.
-
 ## Running Tests
 
 #### Using Pycharm
@@ -132,11 +100,3 @@ next to the run and debug buttons.
 #### Running Tests without Pycharm
 
 Run `pip install pytest pytest-subtests`, then use your IDE to run tests or run `pytest` from the source folder.
-
-#### Running Tests Multithreaded
-
-pytest can run multiple test runners in parallel with the pytest-xdist extension.
-
-Install with `pip install pytest-xdist`.
-
-Run with `pytest -n12` to spawn 12 process that each run 1/12th of the tests.

docs/world api.md

@@ -291,7 +291,7 @@ like entrance randomization in logic.
 
 Regions have a list called `exits`, containing `Entrance` objects representing transitions to other regions.
 
-There must be one special region (Called "Menu" by default, but configurable using [origin_region_name](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L298-L299)),
+There must be one special region (Called "Menu" by default, but configurable using [origin_region_name](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L295-L296)),
 from which the logic unfolds. AP assumes that a player will always be able to return to this starting region by resetting the game ("Save and quit").
 
 ### Entrances
@@ -331,7 +331,7 @@ Even doing `state.can_reach_location` or `state.can_reach_entrance` is problemat
 You can use `multiworld.register_indirect_condition(region, entrance)` to explicitly tell the generator that, when a given region becomes accessible, it is necessary to re-check a specific entrance.
 You **must** use `multiworld.register_indirect_condition` if you perform this kind of `can_reach` from an entrance access rule, unless you have a **very** good technical understanding of the relevant code and can reason why it will never lead to problems in your case.
 
-Alternatively, you can set [world.explicit_indirect_conditions = False](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L301-L304),
+Alternatively, you can set [world.explicit_indirect_conditions = False](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/AutoWorld.py#L298-L301),
 avoiding the need for indirect conditions at the expense of performance.
 
 ### Item Rules
@@ -561,7 +561,7 @@ from .items import is_progression  # this is just a dummy
 
 
 def create_item(self, item: str) -> MyGameItem:
-    # this is called when AP wants to create an item by name (for plando, start inventory, item links) or when you call it from your own code
+    # this is called when AP wants to create an item by name (for plando) or when you call it from your own code
     classification = ItemClassification.progression if is_progression(item) else ItemClassification.filler
     return MyGameItem(item, classification, self.item_name_to_id[item], self.player)
 
@@ -606,8 +606,8 @@ from .items import get_item_type
 
 def set_rules(self) -> None:
     # For some worlds this step can be omitted if either a Logic mixin 
-    # (see below) is used or it's easier to apply the rules from data during
+    # (see below) is used, it's easier to apply the rules from data during
-    # location generation
+    # location generation or everything is in generate_basic
 
     # set a simple rule for an region
     set_rule(self.multiworld.get_entrance("Boss Door", self.player),

entrance_rando.py

@@ -50,15 +50,13 @@ class EntranceLookup:
     _random: random.Random
     _expands_graph_cache: dict[Entrance, bool]
     _coupled: bool
-    _usable_exits: set[Entrance]
 
-    def __init__(self, rng: random.Random, coupled: bool, usable_exits: set[Entrance]):
+    def __init__(self, rng: random.Random, coupled: bool):
         self.dead_ends = EntranceLookup.GroupLookup()
         self.others = EntranceLookup.GroupLookup()
         self._random = rng
         self._expands_graph_cache = {}
         self._coupled = coupled
-        self._usable_exits = usable_exits
 
     def _can_expand_graph(self, entrance: Entrance) -> bool:
         """
@@ -97,8 +95,7 @@ class EntranceLookup:
                 # randomizable exits which are not reverse of the incoming entrance.
                 # uncoupled mode is an exception because in this case going back in the door you just came in could
                 # actually lead somewhere new
-                if (not exit_.connected_region and (not self._coupled or exit_.name != entrance.name)
+                if not exit_.connected_region and (not self._coupled or exit_.name != entrance.name):
-                        and exit_ in self._usable_exits):
                     self._expands_graph_cache[entrance] = True
                     return True
                 elif exit_.connected_region and exit_.connected_region not in visited:
@@ -160,16 +157,17 @@ class ERPlacementState:
     def placed_regions(self) -> set[Region]:
         return self.collection_state.reachable_regions[self.world.player]
 
-    def find_placeable_exits(self, check_validity: bool, usable_exits: list[Entrance]) -> list[Entrance]:
+    def find_placeable_exits(self, check_validity: bool) -> list[Entrance]:
         if check_validity:
             blocked_connections = self.collection_state.blocked_connections[self.world.player]
-            placeable_randomized_exits = [ex for ex in usable_exits
+            blocked_connections = sorted(blocked_connections, key=lambda x: x.name)
-                                          if not ex.connected_region
+            placeable_randomized_exits = [connection for connection in blocked_connections
-                                          and ex in blocked_connections
+                                          if not connection.connected_region
-                                          and ex.is_valid_source_transition(self)]
+                                          and connection.is_valid_source_transition(self)]
         else:
             # this is on a beaten minimal attempt, so any exit anywhere is fair game
-            placeable_randomized_exits = [ex for ex in usable_exits if not ex.connected_region]
+            placeable_randomized_exits = [ex for region in self.world.multiworld.get_regions(self.world.player)
+                                          for ex in region.exits if not ex.connected_region]
         self.world.random.shuffle(placeable_randomized_exits)
         return placeable_randomized_exits
 
@@ -183,8 +181,7 @@ class ERPlacementState:
         self.placements.append(source_exit)
         self.pairings.append((source_exit.name, target_entrance.name))
 
-    def test_speculative_connection(self, source_exit: Entrance, target_entrance: Entrance,
+    def test_speculative_connection(self, source_exit: Entrance, target_entrance: Entrance) -> bool:
-                                    usable_exits: set[Entrance]) -> bool:
         copied_state = self.collection_state.copy()
         # simulated connection. A real connection is unsafe because the region graph is shallow-copied and would
         # propagate back to the real multiworld.
@@ -201,9 +198,6 @@ class ERPlacementState:
             # ignore the source exit, and, if coupled, the reverse exit. They're not actually new
             if _exit.name == source_exit.name or (self.coupled and _exit.name == target_entrance.name):
                 continue
-            # make sure we are only paying attention to usable exits
-            if _exit not in usable_exits:
-                continue
             # technically this should be is_valid_source_transition, but that may rely on side effects from
             # on_connect, which have not happened here (because we didn't do a real connection, and if we did, we would
             # not want them to persist). can_reach is a close enough approximation most of the time.
@@ -268,19 +262,14 @@ def bake_target_group_lookup(world: World, get_target_groups: Callable[[int], li
     return { group: get_target_groups(group) for group in unique_groups }
 
 
-def disconnect_entrance_for_randomization(entrance: Entrance, target_group: int | None = None,
+def disconnect_entrance_for_randomization(entrance: Entrance, target_group: int | None = None) -> None:
-                                          one_way_target_name: str | None = None) -> None:
     """
     Given an entrance in a "vanilla" region graph, splits that entrance to prepare it for randomization
-    in randomize_entrances. This should be done after setting the type and group of the entrance. Because it attempts
+    in randomize_entrances. This should be done after setting the type and group of the entrance.
-    to meet strict entrance naming requirements for coupled mode, this function may produce unintuitive results when
-    called only on a single entrance; it produces eventually-correct outputs only after calling it on all entrances.
 
     :param entrance: The entrance which will be disconnected in preparation for randomization.
     :param target_group: The group to assign to the created ER target. If not specified, the group from
                          the original entrance will be copied.
-    :param one_way_target_name: The name of the created ER target if `entrance` is one-way. This argument
-                                is required for one-way entrances and is ignored otherwise.
     """
     child_region = entrance.connected_region
     parent_region = entrance.parent_region
@@ -295,11 +284,8 @@ def disconnect_entrance_for_randomization(entrance: Entrance, target_group: int
         # targets in the child region will be created when the other direction edge is disconnected
         target = parent_region.create_er_target(entrance.name)
     else:
-        # for 1-ways, the child region needs a target. naming is not a concern for coupling so we
+        # for 1-ways, the child region needs a target and coupling/naming is not a concern
-        # allow it to be user provided (and require it, to prevent an unhelpful assumed name in pairings)
+        target = child_region.create_er_target(child_region.name)
-        if not one_way_target_name:
-            raise ValueError("Cannot disconnect a one-way entrance without a target name specified")
-        target = child_region.create_er_target(one_way_target_name)
     target.randomization_type = entrance.randomization_type
     target.randomization_group = target_group or entrance.randomization_group
 
@@ -336,28 +322,10 @@ def randomize_entrances(
 
     start_time = time.perf_counter()
     er_state = ERPlacementState(world, coupled)
+    entrance_lookup = EntranceLookup(world.random, coupled)
     # similar to fill, skip validity checks on entrances if the game is beatable on minimal accessibility
     perform_validity_check = True
 
-    if not er_targets:
-        er_targets = sorted([entrance for region in world.multiworld.get_regions(world.player)
-                             for entrance in region.entrances if not entrance.parent_region], key=lambda x: x.name)
-    if not exits:
-        exits = sorted([ex for region in world.multiworld.get_regions(world.player)
-                        for ex in region.exits if not ex.connected_region], key=lambda x: x.name)
-    if len(er_targets) != len(exits):
-        raise EntranceRandomizationError(f"Unable to randomize entrances due to a mismatched count of "
-                                         f"entrances ({len(er_targets)}) and exits ({len(exits)}.")
-
-    # used when membership checks are needed on the exit list, e.g. speculative sweep
-    exits_set = set(exits)
-    entrance_lookup = EntranceLookup(world.random, coupled, exits_set)
-    for entrance in er_targets:
-        entrance_lookup.add(entrance)
-
-    # place the menu region and connected start region(s)
-    er_state.collection_state.update_reachable_regions(world.player)
-
     def do_placement(source_exit: Entrance, target_entrance: Entrance) -> None:
         placed_exits, removed_entrances = er_state.connect(source_exit, target_entrance)
         # remove the placed targets from consideration
@@ -369,37 +337,9 @@ def randomize_entrances(
         if on_connect:
             on_connect(er_state, placed_exits)
 
-    def needs_speculative_sweep(dead_end: bool, require_new_exits: bool, placeable_exits: list[Entrance]) -> bool:
-        # speculative sweep is expensive. We currently only do it as a last resort, if we might cap off the graph
-        # entirely
-        if len(placeable_exits) > 1:
-            return False
-
-        # in certain stages of randomization we either expect or don't care if the search space shrinks.
-        # we should never speculative sweep here.
-        if dead_end or not require_new_exits or not perform_validity_check:
-            return False
-
-        # edge case - if all dead ends have pre-placed progression or indirect connections, they are pulled forward
-        # into the non dead end stage. In this case, and only this case, it's possible that the last connection may
-        # actually be placeable in stage 1. We need to skip speculative sweep in this case because we expect the graph
-        # to get capped off.
-
-        # check to see if we are proposing the last placement
-        if not coupled:
-            # in uncoupled, this check is easy as there will only be one target.
-            is_last_placement = len(entrance_lookup) == 1
-        else:
-            # a bit harder, there may be 1 or 2 targets depending on if the exit to place is one way or two way.
-            # if it is two way, we can safely assume that one of the targets is the logical pair of the exit.
-            desired_target_count = 2 if placeable_exits[0].randomization_type == EntranceType.TWO_WAY else 1
-            is_last_placement = len(entrance_lookup) == desired_target_count
-        # if it's not the last placement, we need a sweep
-        return not is_last_placement
-
     def find_pairing(dead_end: bool, require_new_exits: bool) -> bool:
         nonlocal perform_validity_check
-        placeable_exits = er_state.find_placeable_exits(perform_validity_check, exits)
+        placeable_exits = er_state.find_placeable_exits(perform_validity_check)
         for source_exit in placeable_exits:
             target_groups = target_group_lookup[source_exit.randomization_group]
             for target_entrance in entrance_lookup.get_targets(target_groups, dead_end, preserve_group_order):
@@ -410,10 +350,12 @@ def randomize_entrances(
                 # very last exit and check whatever exits we open up are functionally accessible.
                 # this requirement can be ignored on a beaten minimal, islands are no issue there.
                 exit_requirement_satisfied = (not perform_validity_check or not require_new_exits
-                                              or target_entrance.connected_region not in er_state.placed_regions)
+                                                or target_entrance.connected_region not in er_state.placed_regions)
+                needs_speculative_sweep = (not dead_end and require_new_exits and perform_validity_check
+                                           and len(placeable_exits) == 1)
                 if exit_requirement_satisfied and source_exit.can_connect_to(target_entrance, dead_end, er_state):
-                    if (needs_speculative_sweep(dead_end, require_new_exits, placeable_exits)
+                    if (needs_speculative_sweep
-                            and not er_state.test_speculative_connection(source_exit, target_entrance, exits_set)):
+                            and not er_state.test_speculative_connection(source_exit, target_entrance)):
                         continue
                     do_placement(source_exit, target_entrance)
                     return True
@@ -465,6 +407,21 @@ def randomize_entrances(
                 f"All unplaced entrances: {unplaced_entrances}\n"
                 f"All unplaced exits: {unplaced_exits}")
 
+    if not er_targets:
+        er_targets = sorted([entrance for region in world.multiworld.get_regions(world.player)
+                             for entrance in region.entrances if not entrance.parent_region], key=lambda x: x.name)
+    if not exits:
+        exits = sorted([ex for region in world.multiworld.get_regions(world.player)
+                        for ex in region.exits if not ex.connected_region], key=lambda x: x.name)
+    if len(er_targets) != len(exits):
+        raise EntranceRandomizationError(f"Unable to randomize entrances due to a mismatched count of "
+                                         f"entrances ({len(er_targets)}) and exits ({len(exits)}.")
+    for entrance in er_targets:
+        entrance_lookup.add(entrance)
+
+    # place the menu region and connected start region(s)
+    er_state.collection_state.update_reachable_regions(world.player)
+
     # stage 1 - try to place all the non-dead-end entrances
     while entrance_lookup.others:
         if not find_pairing(dead_end=False, require_new_exits=True):

inno_setup.iss

@@ -45,8 +45,7 @@ MinVersion={#min_windows}
 Name: "english"; MessagesFile: "compiler:Default.isl"
 
 [Tasks]
-Name: "desktopicon"; Description: "{cm:CreateDesktopIcon}";
+Name: "desktopicon"; Description: "{cm:CreateDesktopIcon}"; GroupDescription: "{cm:AdditionalIcons}";
-Name: "deletelib"; Description: "Clean existing /lib folder and subfolders including /worlds (leave checked if unsure)"; Check: ShouldShowDeleteLibTask
 
 [Types]
 Name: "full"; Description: "Full installation"
@@ -84,8 +83,18 @@ Filename: "{app}\ArchipelagoLauncher"; Description: "{cm:LaunchProgram,{#StringC
 Type: dirifempty; Name: "{app}"
 
 [InstallDelete]
-Type: files; Name: "{app}\*.exe"
+Type: files; Name: "{app}\lib\worlds\_bizhawk.apworld"
+Type: files; Name: "{app}\ArchipelagoLttPClient.exe"
+Type: files; Name: "{app}\ArchipelagoPokemonClient.exe"
 Type: files; Name: "{app}\data\lua\connector_pkmn_rb.lua"
+Type: filesandordirs; Name: "{app}\lib\worlds\rogue-legacy"
+Type: dirifempty; Name: "{app}\lib\worlds\rogue-legacy"
+Type: files; Name: "{app}\lib\worlds\sc2wol.apworld"
+Type: filesandordirs; Name: "{app}\lib\worlds\sc2wol"
+Type: dirifempty; Name: "{app}\lib\worlds\sc2wol"
+Type: filesandordirs; Name: "{app}\lib\worlds\bk_sudoku"
+Type: dirifempty; Name: "{app}\lib\worlds\bk_sudoku"
+Type: files; Name: "{app}\ArchipelagoLauncher(DEBUG).exe"
 Type: filesandordirs; Name: "{app}\SNI\lua*"
 Type: filesandordirs; Name: "{app}\EnemizerCLI*"
 #include "installdelete.iss"
@@ -212,11 +221,6 @@ Root: HKCR; Subkey: "{#MyAppName}ygo06patch";                     ValueData: "Ar
 Root: HKCR; Subkey: "{#MyAppName}ygo06patch\DefaultIcon";         ValueData: "{app}\ArchipelagoBizHawkClient.exe,0";                           ValueType: string;  ValueName: "";
 Root: HKCR; Subkey: "{#MyAppName}ygo06patch\shell\open\command";  ValueData: """{app}\ArchipelagoBizHawkClient.exe"" ""%1""";                  ValueType: string;  ValueName: "";
 
-Root: HKCR; Subkey: ".apcivvi";                                   ValueData: "{#MyAppName}apcivvipatch";        Flags: uninsdeletevalue; ValueType: string;  ValueName: "";
-Root: HKCR; Subkey: "{#MyAppName}apcivvipatch";                     ValueData: "Archipelago Civilization 6 Patch"; Flags: uninsdeletekey;   ValueType: string;  ValueName: "";
-Root: HKCR; Subkey: "{#MyAppName}apcivvipatch\DefaultIcon";         ValueData: "{app}\ArchipelagoLauncher.exe,0";                           ValueType: string;  ValueName: "";
-Root: HKCR; Subkey: "{#MyAppName}apcivvipatch\shell\open\command";  ValueData: """{app}\ArchipelagoLauncher.exe"" ""%1""";                  ValueType: string;  ValueName: "";
-
 Root: HKCR; Subkey: ".archipelago";                              ValueData: "{#MyAppName}multidata";        Flags: uninsdeletevalue; ValueType: string;  ValueName: "";
 Root: HKCR; Subkey: "{#MyAppName}multidata";                     ValueData: "Archipelago Server Data";      Flags: uninsdeletekey;   ValueType: string;  ValueName: "";
 Root: HKCR; Subkey: "{#MyAppName}multidata\DefaultIcon";         ValueData: "{app}\ArchipelagoServer.exe,0";                         ValueType: string;  ValueName: "";
@@ -252,17 +256,3 @@ begin
     Result := True;
   end;
 end;
-
-function ShouldShowDeleteLibTask: Boolean;
-begin
-  Result := DirExists(ExpandConstant('{app}\lib'));
-end;
-
-procedure CurStepChanged(CurStep: TSetupStep);
-begin
-  if CurStep = ssInstall then
-  begin
-    if WizardIsTaskSelected('deletelib') then
-      DelTree(ExpandConstant('{app}\lib'), True, True, True);
-  end;
-end;

kvui.py

@@ -35,7 +35,8 @@ from kivy.config import Config
 Config.set("input", "mouse", "mouse,disable_multitouch")
 Config.set("kivy", "exit_on_escape", "0")
 Config.set("graphics", "multisamples", "0")  # multisamples crash old intel drivers
-from kivymd.uix.divider import MDDivider
+
+from kivy.app import App
 from kivy.core.window import Window
 from kivy.core.clipboard import Clipboard
 from kivy.core.text.markup import MarkupLabel
@@ -43,34 +44,32 @@ from kivy.core.image import ImageLoader, ImageLoaderBase, ImageData
 from kivy.base import ExceptionHandler, ExceptionManager
 from kivy.clock import Clock
 from kivy.factory import Factory
-from kivy.properties import BooleanProperty, ObjectProperty, NumericProperty, StringProperty
+from kivy.properties import BooleanProperty, ObjectProperty, NumericProperty
-from kivy.metrics import dp, sp
+from kivy.metrics import dp
+from kivy.effects.scroll import ScrollEffect
 from kivy.uix.widget import Widget
+from kivy.uix.button import Button
+from kivy.uix.gridlayout import GridLayout
 from kivy.uix.layout import Layout
+from kivy.uix.textinput import TextInput
+from kivy.uix.scrollview import ScrollView
+from kivy.uix.recycleview import RecycleView
+from kivy.uix.tabbedpanel import TabbedPanel, TabbedPanelItem
+from kivy.uix.boxlayout import BoxLayout
+from kivy.uix.floatlayout import FloatLayout
+from kivy.uix.label import Label
+from kivy.uix.progressbar import ProgressBar
+from kivy.uix.dropdown import DropDown
 from kivy.utils import escape_markup
 from kivy.lang import Builder
 from kivy.uix.recycleview.views import RecycleDataViewBehavior
-from kivy.uix.behaviors import FocusBehavior, ToggleButtonBehavior
+from kivy.uix.behaviors import FocusBehavior
 from kivy.uix.recycleboxlayout import RecycleBoxLayout
 from kivy.uix.recycleview.layout import LayoutSelectionBehavior
 from kivy.animation import Animation
 from kivy.uix.popup import Popup
+from kivy.uix.dropdown import DropDown
 from kivy.uix.image import AsyncImage
-from kivymd.app import MDApp
-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.menu import MDDropdownMenu
-from kivymd.uix.menu.menu import MDDropdownTextItem
-from kivymd.uix.dropdownitem import MDDropDownItem, MDDropDownItemText
-from kivymd.uix.button import MDButton, MDButtonText, MDButtonIcon, MDIconButton
-from kivymd.uix.label import MDLabel, MDIcon
-from kivymd.uix.recycleview import MDRecycleView
-from kivymd.uix.textfield.textfield import MDTextField
-from kivymd.uix.progressindicator import MDLinearProgressIndicator
-from kivymd.uix.scrollview import MDScrollView
-from kivymd.uix.tooltip import MDTooltip, MDTooltipPlain
 
 fade_in_animation = Animation(opacity=0, duration=0) + Animation(opacity=1, duration=0.25)
 
@@ -87,113 +86,6 @@ else:
 remove_between_brackets = re.compile(r"\[.*?]")
 
 
-class ThemedApp(MDApp):
-    def set_colors(self):
-        text_colors = KivyJSONtoTextParser.TextColors()
-        self.theme_cls.theme_style = text_colors.theme_style
-        self.theme_cls.primary_palette = text_colors.primary_palette
-        self.theme_cls.dynamic_scheme_name = text_colors.dynamic_scheme_name
-        self.theme_cls.dynamic_scheme_contrast = text_colors.dynamic_scheme_contrast
-
-
-class ImageIcon(MDButtonIcon, AsyncImage):
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.image = ApAsyncImage(**kwargs)
-        self.add_widget(self.image)
-
-    def add_widget(self, widget, index=0, canvas=None):
-        return super(MDIcon, self).add_widget(widget)
-
-
-class ImageButton(MDIconButton):
-    def __init__(self, **kwargs):
-        image_args = dict()
-        for kwarg in ("fit_mode", "image_size", "color", "source", "texture"):
-            val = kwargs.pop(kwarg, "None")
-            if val != "None":
-                image_args[kwarg.replace("image_", "")] = val
-        super().__init__()
-        self.image = ApAsyncImage(**image_args)
-
-        def set_center(button, center):
-            self.image.center_x = self.center_x
-            self.image.center_y = self.center_y
-
-        self.bind(center=set_center)
-        self.add_widget(self.image)
-
-    def add_widget(self, widget, index=0, canvas=None):
-        return super(MDIcon, self).add_widget(widget)
-
-
-class ScrollBox(MDScrollView):
-    layout: MDBoxLayout = ObjectProperty(None)
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-
-
-# thanks kivymd
-class ToggleButton(MDButton, ToggleButtonBehavior):
-    def __init__(self, *args, **kwargs):
-        super(ToggleButton, self).__init__(*args, **kwargs)
-        self.bind(state=self._update_bg)
-
-    def _update_bg(self, _, state: str):
-        if self.disabled:
-            return
-        if self.theme_bg_color == "Primary":
-            self.theme_bg_color = "Custom"
-
-        if state == "down":
-            self.md_bg_color = self.theme_cls.primaryColor
-            for child in self.children:
-                if child.theme_text_color == "Primary":
-                    child.theme_text_color = "Custom"
-                if child.theme_icon_color == "Primary":
-                    child.theme_icon_color = "Custom"
-                child.text_color = self.theme_cls.onPrimaryColor
-                child.icon_color = self.theme_cls.onPrimaryColor
-        else:
-            self.md_bg_color = self.theme_cls.surfaceContainerLowestColor
-            for child in self.children:
-                if child.theme_text_color == "Primary":
-                    child.theme_text_color = "Custom"
-                if child.theme_icon_color == "Primary":
-                    child.theme_icon_color = "Custom"
-                child.text_color = self.theme_cls.primaryColor
-                child.icon_color = self.theme_cls.primaryColor
-
-
-# thanks kivymd
-class ResizableTextField(MDTextField):
-    """
-    Resizable MDTextField that manually overrides the builtin sizing.
-
-    Note that in order to use this, the sizing must be specified from within a .kv rule.
-    """
-    def __init__(self, *args, **kwargs):
-        # cursed rules override
-        rules = Builder.match(self)
-        textfield = next((rule for rule in rules if rule.name == f"<MDTextField>"), None)
-        if textfield:
-            subclasses = rules[rules.index(textfield) + 1:]
-            for subclass in subclasses:
-                height_rule = subclass.properties.get("height", None)
-                if height_rule:
-                    height_rule.ignore_prev = True
-        super().__init__(*args, **kwargs)
-
-
-def on_release(self: MDButton, *args):
-    super(MDButton, self).on_release(args)
-    self.on_leave()
-
-
-MDButton.on_release = on_release
-
-
 # I was surprised to find this didn't already exist in kivy :(
 class HoverBehavior(object):
     """originally from https://stackoverflow.com/a/605348110"""
@@ -233,7 +125,7 @@ class HoverBehavior(object):
 Factory.register("HoverBehavior", HoverBehavior)
 
 
-class ToolTip(MDTooltipPlain):
+class ToolTip(Label):
     pass
 
 
@@ -241,30 +133,49 @@ class ServerToolTip(ToolTip):
     pass
 
 
-class HovererableLabel(HoverBehavior, MDLabel):
+class ScrollBox(ScrollView):
+    layout: BoxLayout
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.layout = BoxLayout(size_hint_y=None)
+        self.layout.bind(minimum_height=self.layout.setter("height"))
+        self.add_widget(self.layout)
+        self.effect_cls = ScrollEffect
+        self.bar_width = dp(12)
+        self.scroll_type = ["content", "bars"]
+
+
+class HovererableLabel(HoverBehavior, Label):
     pass
 
 
-class TooltipLabel(HovererableLabel, MDTooltip):
+class TooltipLabel(HovererableLabel):
-    tooltip_display_delay = 0.1
+    tooltip = None
 
     def create_tooltip(self, text, x, y):
         text = text.replace("<br>", "\n").replace("&amp;", "&").replace("&bl;", "[").replace("&br;", "]")
-        # position float layout
+        if self.tooltip:
-        center_x, center_y = self.to_window(self.center_x, self.center_y)
-        self.shift_y = y - center_y
-        shift_x = center_x - x
-        if shift_x > 0:
-            self.shift_left = shift_x
-        else:
-            self.shift_right = shift_x
-
-        if self._tooltip:
             # update
-            self._tooltip.text = text
+            self.tooltip.children[0].text = text
         else:
-            self._tooltip = ToolTip(text=text, pos_hint={})
+            self.tooltip = FloatLayout()
-            self.display_tooltip()
+            tooltip_label = ToolTip(text=text)
+            self.tooltip.add_widget(tooltip_label)
+            fade_in_animation.start(self.tooltip)
+            App.get_running_app().root.add_widget(self.tooltip)
+
+        # handle left-side boundary to not render off-screen
+        x = max(x, 3 + self.tooltip.children[0].texture_size[0] / 2)
+
+        # position float layout
+        self.tooltip.x = x - self.tooltip.width / 2
+        self.tooltip.y = y - self.tooltip.height / 2 + 48
+
+    def remove_tooltip(self):
+        if self.tooltip:
+            App.get_running_app().root.remove_widget(self.tooltip)
+            self.tooltip = None
 
     def on_mouse_pos(self, window, pos):
         if not self.get_root_window():
@@ -291,30 +202,26 @@ class TooltipLabel(HovererableLabel, MDTooltip):
 
     def on_leave(self):
         self.remove_tooltip()
-        self._tooltip = None
 
 
-class ServerLabel(HoverBehavior, MDTooltip, MDBoxLayout):
+class ServerLabel(HovererableLabel):
-    tooltip_display_delay = 0.1
-    text: str = StringProperty("Server:")
-
     def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
+        super(HovererableLabel, self).__init__(*args, **kwargs)
-        self.add_widget(MDIcon(icon="information", font_size=sp(15)))
+        self.layout = FloatLayout()
-        self.add_widget(TooltipLabel(text=self.text, pos_hint={"center_x": 0.5, "center_y": 0.5},
+        self.popuplabel = ServerToolTip(text="Test")
-                                     font_size=sp(15)))
+        self.layout.add_widget(self.popuplabel)
-        self._tooltip = ServerToolTip(text="Test")
 
     def on_enter(self):
-        self._tooltip.text = self.get_text()
+        self.popuplabel.text = self.get_text()
-        self.display_tooltip()
+        App.get_running_app().root.add_widget(self.layout)
+        fade_in_animation.start(self.layout)
 
     def on_leave(self):
-        self.animation_tooltip_dismiss()
+        App.get_running_app().root.remove_widget(self.layout)
 
     @property
     def ctx(self) -> context_type:
-        return MDApp.get_running_app().ctx
+        return App.get_running_app().ctx
 
     def get_text(self):
         if self.ctx.server:
@@ -355,11 +262,11 @@ class ServerLabel(HoverBehavior, MDTooltip, MDBoxLayout):
             return "No current server connection. \nPlease connect to an Archipelago server."
 
 
-class MainLayout(MDGridLayout):
+class MainLayout(GridLayout):
     pass
 
 
-class ContainerLayout(MDFloatLayout):
+class ContainerLayout(FloatLayout):
     pass
 
 
@@ -379,11 +286,6 @@ class SelectableLabel(RecycleDataViewBehavior, TooltipLabel):
         return super(SelectableLabel, self).refresh_view_attrs(
             rv, index, data)
 
-    def on_size(self, instance_label, size: list) -> None:
-        super().on_size(instance_label, size)
-        if self.parent:
-            self.width = self.parent.width
-
     def on_touch_down(self, touch):
         """ Add selection on touch down """
         if super(SelectableLabel, self).on_touch_down(touch):
@@ -394,10 +296,10 @@ class SelectableLabel(RecycleDataViewBehavior, TooltipLabel):
             else:
                 # Not a fan of the following few lines, but they work.
                 temp = MarkupLabel(text=self.text).markup
-                text = "".join(part for part in temp if not part.startswith("["))
+                text = "".join(part for part in temp if not part.startswith(("[color", "[/color]", "[ref=", "[/ref]")))
-                cmdinput = MDApp.get_running_app().textinput
+                cmdinput = App.get_running_app().textinput
                 if not cmdinput.text:
-                    input_text = get_input_text_from_response(text, MDApp.get_running_app().last_autofillable_command)
+                    input_text = get_input_text_from_response(text, App.get_running_app().last_autofillable_command)
                     if input_text is not None:
                         cmdinput.text = input_text
 
@@ -409,117 +311,31 @@ class SelectableLabel(RecycleDataViewBehavior, TooltipLabel):
         self.selected = is_selected
 
         
-class MarkupDropdownTextItem(MDDropdownTextItem):
+class AutocompleteHintInput(TextInput):
-    def __init__(self):
-        super().__init__()
-        for child in self.children:
-            if child.__class__ == MDLabel:
-                child.markup = True
-    # Currently, this only lets us do markup on text that does not have any icons
-    # Create new TextItems as needed
-
-
-class MarkupDropdown(MDDropdownMenu):
-    def on_items(self, instance, value: list) -> None:
-        """
-        The method sets the class that will be used to create the menu item.
-        """
-
-        items = []
-        viewclass = "MarkupDropdownTextItem"
-
-        for data in value:
-            if "viewclass" not in data:
-                if (
-                    "leading_icon" not in data
-                    and "trailing_icon" not in data
-                    and "trailing_text" not in data
-                ):
-                    viewclass = "MarkupDropdownTextItem"
-                elif (
-                    "leading_icon" in data
-                    and "trailing_icon" not in data
-                    and "trailing_text" not in data
-                ):
-                    viewclass = "MDDropdownLeadingIconItem"
-                elif (
-                    "leading_icon" not in data
-                    and "trailing_icon" in data
-                    and "trailing_text" not in data
-                ):
-                    viewclass = "MDDropdownTrailingIconItem"
-                elif (
-                    "leading_icon" not in data
-                    and "trailing_icon" in data
-                    and "trailing_text" in data
-                ):
-                    viewclass = "MDDropdownTrailingIconTextItem"
-                elif (
-                    "leading_icon" in data
-                    and "trailing_icon" in data
-                    and "trailing_text" in data
-                ):
-                    viewclass = "MDDropdownLeadingTrailingIconTextItem"
-                elif (
-                    "leading_icon" in data
-                    and "trailing_icon" in data
-                    and "trailing_text" not in data
-                ):
-                    viewclass = "MDDropdownLeadingTrailingIconItem"
-                elif (
-                    "leading_icon" not in data
-                    and "trailing_icon" not in data
-                    and "trailing_text" in data
-                ):
-                    viewclass = "MDDropdownTrailingTextItem"
-                elif (
-                    "leading_icon" in data
-                    and "trailing_icon" not in data
-                    and "trailing_text" in data
-                ):
-                    viewclass = "MDDropdownLeadingIconTrailingTextItem"
-
-                data["viewclass"] = viewclass
-
-            if "height" not in data:
-                data["height"] = dp(48)
-
-            items.append(data)
-
-        self._items = items
-        # Update items in view
-        if hasattr(self, "menu"):
-            self.menu.data = self._items
-
-
-class AutocompleteHintInput(ResizableTextField):
     min_chars = NumericProperty(3)
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
-        self.dropdown = MarkupDropdown(caller=self, position="bottom", border_margin=dp(2), width=self.width)
+        self.dropdown = DropDown()
+        self.dropdown.bind(on_select=lambda instance, x: setattr(self, 'text', x))
         self.bind(on_text_validate=self.on_message)
-        self.bind(width=lambda instance, x: setattr(self.dropdown, "width", x))
 
     def on_message(self, instance):
-        MDApp.get_running_app().commandprocessor("!hint "+instance.text)
+        App.get_running_app().commandprocessor("!hint "+instance.text)
 
     def on_text(self, instance, value):
         if len(value) >= self.min_chars:
-            self.dropdown.items.clear()
+            self.dropdown.clear_widgets()
-            ctx: context_type = MDApp.get_running_app().ctx
+            ctx: context_type = App.get_running_app().ctx
             if not ctx.game:
                 return
             item_names = ctx.item_names._game_store[ctx.game].values()
 
-            def on_press(text):
+            def on_press(button: Button):
-                split_text = MarkupLabel(text=text).markup
+                split_text = MarkupLabel(text=button.text).markup
-                self.set_text(self, "".join(text_frag for text_frag in split_text
+                return self.dropdown.select("".join(text_frag for text_frag in split_text
-                                            if not text_frag.startswith("[")))
+                                                    if not text_frag.startswith("[")))
-                self.dropdown.dismiss()
-                self.focus = True
-
             lowered = value.lower()
             for item_name in item_names:
                 try:
@@ -529,29 +345,20 @@ class AutocompleteHintInput(ResizableTextField):
                 else:
                     text = escape_markup(item_name)
                     text = text[:index] + "[b]" + text[index:index+len(value)]+"[/b]"+text[index+len(value):]
-                    self.dropdown.items.append({
+                    btn = Button(text=text, size_hint_y=None, height=dp(30), markup=True)
-                        "text": text,
+                    btn.bind(on_release=on_press)
-                        "on_release": lambda txt=text: on_press(txt),
+                    self.dropdown.add_widget(btn)
-                        "markup": True
+            if not self.dropdown.attach_to:
-                    })
+                self.dropdown.open(self)
-            if not self.dropdown.parent:
-                self.dropdown.open()
         else:
             self.dropdown.dismiss()
 
 
-status_icons = {
+class HintLabel(RecycleDataViewBehavior, BoxLayout):
-    HintStatus.HINT_NO_PRIORITY: "information",
-    HintStatus.HINT_PRIORITY: "exclamation-thick",
-    HintStatus.HINT_AVOID: "alert"
-}
-
-
-class HintLabel(RecycleDataViewBehavior, MDBoxLayout):
     selected = BooleanProperty(False)
     striped = BooleanProperty(False)
     index = None
-    dropdown: MDDropdownMenu
+    dropdown: DropDown
 
     def __init__(self):
         super(HintLabel, self).__init__()
@@ -562,28 +369,29 @@ class HintLabel(RecycleDataViewBehavior, MDBoxLayout):
         self.entrance_text = ""
         self.status_text = ""
         self.hint = {}
+        for child in self.children:
+            child.bind(texture_size=self.set_height)
 
-        ctx = MDApp.get_running_app().ctx
-        menu_items = []
 
-        for status in (HintStatus.HINT_NO_PRIORITY, HintStatus.HINT_PRIORITY, HintStatus.HINT_AVOID):
+        ctx = App.get_running_app().ctx
-            name = status_names[status]
+        self.dropdown = DropDown()
-            status_button = MDDropDownItem(MDDropDownItemText(text=name), size_hint_y=None, height=dp(50))
-            status_button.status = status
-            menu_items.append({
-                "text": name,
-                "leading_icon": status_icons[status],
-                "on_release": lambda x=status: select(self, x)
-            })
 
-        self.dropdown = MDDropdownMenu(caller=self.ids["status"], items=menu_items)
+        def set_value(button):
+            self.dropdown.select(button.status)
 
         def select(instance, data):
             ctx.update_hint(self.hint["location"],
                             self.hint["finding_player"],
                             data)
 
-        self.dropdown.bind(on_release=self.dropdown.dismiss)
+        for status in (HintStatus.HINT_NO_PRIORITY, HintStatus.HINT_PRIORITY, HintStatus.HINT_AVOID):
+            name = status_names[status]
+            status_button = Button(text=name, size_hint_y=None, height=dp(50))
+            status_button.status = status
+            status_button.bind(on_release=set_value)
+            self.dropdown.add_widget(status_button)
+
+        self.dropdown.bind(on_select=select)
 
     def set_height(self, instance, value):
         self.height = max([child.texture_size[1] for child in self.children])
@@ -598,6 +406,7 @@ class HintLabel(RecycleDataViewBehavior, MDBoxLayout):
         self.entrance_text = data["entrance"]["text"]
         self.status_text = data["status"]["text"]
         self.hint = data["status"]["hint"]
+        self.height = self.minimum_height
         return super(HintLabel, self).refresh_view_attrs(rv, index, data)
 
     def on_touch_down(self, touch):
@@ -610,10 +419,10 @@ class HintLabel(RecycleDataViewBehavior, MDBoxLayout):
                 if status_label.collide_point(*touch.pos):
                     if self.hint["status"] == HintStatus.HINT_FOUND:
                         return
-                    ctx = MDApp.get_running_app().ctx
+                    ctx = App.get_running_app().ctx
                     if ctx.slot_concerns_self(self.hint["receiving_player"]):  # If this player owns this hint
                         # open a dropdown
-                        self.dropdown.open()
+                        self.dropdown.open(self.ids["status"])
                 elif self.selected:
                     self.parent.clear_selection()
                 else:
@@ -622,7 +431,8 @@ class HintLabel(RecycleDataViewBehavior, MDBoxLayout):
                                     if self.entrance_text != "Vanilla"
                                     else "", ". (", self.status_text.lower(), ")"))
                     temp = MarkupLabel(text).markup
-                    text = "".join(part for part in temp if not part.startswith("["))
+                    text = "".join(
+                        part for part in temp if not part.startswith(("[color", "[/color]", "[ref=", "[/ref]")))
                     Clipboard.copy(escape_markup(text).replace("&amp;", "&").replace("&bl;", "[").replace("&br;", "]"))
                     return self.parent.select_with_touch(self.index, touch)
         else:
@@ -645,7 +455,7 @@ class HintLabel(RecycleDataViewBehavior, MDBoxLayout):
                     else:
                         parent.sort_key = key
                         parent.reversed = False
-                    MDApp.get_running_app().update_hints()
+                    App.get_running_app().update_hints()
 
     def apply_selection(self, rv, index, is_selected):
         """ Respond to the selection of items in the view. """
@@ -653,7 +463,7 @@ class HintLabel(RecycleDataViewBehavior, MDBoxLayout):
             self.selected = is_selected
 
 
-class ConnectBarTextInput(ResizableTextField):
+class ConnectBarTextInput(TextInput):
     def insert_text(self, substring, from_undo=False):
         s = substring.replace("\n", "").replace("\r", "")
         return super(ConnectBarTextInput, self).insert_text(s, from_undo=from_undo)
@@ -663,7 +473,7 @@ def is_command_input(string: str) -> bool:
     return len(string) > 0 and string[0] in "/!"
 
 
-class CommandPromptTextInput(ResizableTextField):
+class CommandPromptTextInput(TextInput):
     MAXIMUM_HISTORY_MESSAGES = 50
 
     def __init__(self, **kwargs) -> None:
@@ -711,96 +521,32 @@ class CommandPromptTextInput(ResizableTextField):
 
 
 class MessageBox(Popup):
-    class MessageBoxLabel(MDLabel):
+    class MessageBoxLabel(Label):
         def __init__(self, **kwargs):
             super().__init__(**kwargs)
             self._label.refresh()
+            self.size = self._label.texture.size
+            if self.width + 50 > Window.width:
+                self.text_size[0] = Window.width - 50
+                self._label.refresh()
+                self.size = self._label.texture.size
 
     def __init__(self, title, text, error=False, **kwargs):
         label = MessageBox.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),
+        super().__init__(title=title, content=label, size_hint=(None, None), width=max(100, int(label.width) + 40),
                          separator_color=separator_color, **kwargs)
         self.height += max(0, label.height - 18)
 
 
-class ClientTabs(MDTabsSecondary):
+class GameManager(App):
-    carousel: MDTabsCarousel
-    lock_swiping = True
-
-    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)
-
-    def update_indicator(
-        self, x: float = 0.0, w: float = 0.0, instance: MDTabsItem = None
-    ) -> None:
-        def update_indicator(*args):
-            indicator_pos = (0, 0)
-            indicator_size = (0, 0)
-
-            item_text_object = self._get_tab_item_text_icon_object()
-
-            if item_text_object:
-                indicator_pos = (
-                    instance.x + dp(12),
-                    self.indicator.pos[1]
-                    if not self._tabs_carousel
-                    else self._tabs_carousel.height,
-                )
-                indicator_size = (
-                    instance.width - dp(24),
-                    self.indicator_height,
-                )
-
-            Animation(
-                pos=indicator_pos,
-                size=indicator_size,
-                d=0 if not self.indicator_anim else self.indicator_duration,
-                t=self.indicator_transition,
-            ).start(self.indicator)
-
-        if not instance:
-            self.indicator.pos = (x, self.indicator.pos[1])
-            self.indicator.size = (w, self.indicator_height)
-        else:
-            Clock.schedule_once(update_indicator)
-
-    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)
-
-
-class CommandButton(MDButton, MDTooltip):
-    def __init__(self, *args, manager: "GameManager", **kwargs):
-        super().__init__(*args, **kwargs)
-        self.manager = manager
-        self._tooltip = ToolTip(text="Test")
-
-    def on_enter(self):
-        self._tooltip.text = self.manager.commandprocessor.get_help_text()
-        self._tooltip.font_size = dp(20 - (len(self._tooltip.text) // 400))  # mostly guessing on the numbers here
-        self.display_tooltip()
-
-    def on_leave(self):
-        self.animation_tooltip_dismiss()
-
-
-class GameManager(ThemedApp):
     logging_pairs = [
         ("Client", "Archipelago"),
     ]
     base_title: str = "Archipelago Client"
     last_autofillable_command: str
 
-    main_area_container: MDGridLayout
+    main_area_container: GridLayout
     """ subclasses can add more columns beside the tabs """
 
     def __init__(self, ctx: context_type):
@@ -835,58 +581,45 @@ class GameManager(ThemedApp):
             return max(1, len(self.tabs.tab_list))
         return 1
 
-    def on_start(self):
-        def on_start(*args):
-            self.root.md_bg_color = self.theme_cls.backgroundColor
-        super().on_start()
-        Clock.schedule_once(on_start)
-
     def build(self) -> Layout:
-        self.set_colors()
         self.container = ContainerLayout()
 
         self.grid = MainLayout()
         self.grid.cols = 1
-        self.connect_layout = MDBoxLayout(orientation="horizontal", size_hint_y=None, height=dp(40),
+        self.connect_layout = BoxLayout(orientation="horizontal", size_hint_y=None, height=dp(30))
-                                          spacing=5, padding=(5, 10))
         # top part
-        server_label = ServerLabel(width=dp(75))
+        server_label = ServerLabel()
         self.connect_layout.add_widget(server_label)
         self.server_connect_bar = ConnectBarTextInput(text=self.ctx.suggested_address or "archipelago.gg:",
-                                                      pos_hint={"center_x": 0.5, "center_y": 0.5})
+                                                      size_hint_y=None,
+                                                      height=dp(30), multiline=False, write_tab=False)
 
         def connect_bar_validate(sender):
             if not self.ctx.server:
                 self.connect_button_action(sender)
 
-        self.server_connect_bar.height = dp(30)
         self.server_connect_bar.bind(on_text_validate=connect_bar_validate)
         self.connect_layout.add_widget(self.server_connect_bar)
-        self.server_connect_button = MDButton(MDButtonText(text="Connect"), style="filled", size=(dp(100), dp(70)),
+        self.server_connect_button = Button(text="Connect", size=(dp(100), dp(30)), size_hint_y=None, size_hint_x=None)
-                                              size_hint_x=None, size_hint_y=None, radius=5, pos_hint={"center_y": 0.55})
         self.server_connect_button.bind(on_press=self.connect_button_action)
-        self.server_connect_button.height = self.server_connect_bar.height
         self.connect_layout.add_widget(self.server_connect_button)
         self.grid.add_widget(self.connect_layout)
-        self.progressbar = MDLinearProgressIndicator(size_hint_y=None, height=3)
+        self.progressbar = ProgressBar(size_hint_y=None, height=3)
         self.grid.add_widget(self.progressbar)
 
         # middle part
-        self.tabs = ClientTabs(pos_hint={"center_x": 0.5, "center_y": 0.5})
+        self.tabs = TabbedPanel(size_hint_y=1)
-        self.tabs.add_widget(MDTabsItem(MDTabsItemText(text="All" if len(self.logging_pairs) > 1 else "Archipelago")))
+        self.tabs.default_tab_text = "All"
         self.log_panels["All"] = self.tabs.default_tab_content = UILog(*(logging.getLogger(logger_name)
-                                                                             for logger_name, name in
+                                                                         for logger_name, name in
-                                                                             self.logging_pairs))
+                                                                         self.logging_pairs))
-        self.tabs.carousel.add_widget(self.tabs.default_tab_content)
 
         for logger_name, display_name in self.logging_pairs:
             bridge_logger = logging.getLogger(logger_name)
-            self.log_panels[display_name] = UILog(bridge_logger)
+            panel = TabbedPanelItem(text=display_name)
+            self.log_panels[display_name] = panel.content = 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)
 
         hint_panel = self.add_client_tab("Hints", HintLayout())
@@ -894,21 +627,21 @@ class GameManager(ThemedApp):
         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)
+        if len(self.logging_pairs) == 1:
+            self.tabs.default_tab_text = "Archipelago"
+
+        self.main_area_container = GridLayout(size_hint_y=1, rows=1)
         self.main_area_container.add_widget(self.tabs)
 
         self.grid.add_widget(self.main_area_container)
 
         # bottom part
-        bottom_layout = MDBoxLayout(orientation="horizontal", size_hint_y=None, height=dp(40), spacing=5, padding=(5, 10))
+        bottom_layout = BoxLayout(orientation="horizontal", size_hint_y=None, height=dp(30))
-        info_button = CommandButton(MDButtonText(text="Command:", halign="left"), manager=self, radius=5,
+        info_button = Button(size=(dp(100), dp(30)), text="Command:", size_hint_x=None)
-                                    style="filled", size=(dp(100), dp(70)), size_hint_x=None, size_hint_y=None,
-                                    pos_hint={"center_y": 0.575})
         info_button.bind(on_release=self.command_button_action)
         bottom_layout.add_widget(info_button)
-        self.textinput = CommandPromptTextInput(size_hint_y=None, multiline=False, write_tab=False)
+        self.textinput = CommandPromptTextInput(size_hint_y=None, height=dp(30), multiline=False, write_tab=False)
         self.textinput.bind(on_text_validate=self.on_message)
-        info_button.height = self.textinput.height
         self.textinput.text_validate_unfocus = False
         bottom_layout.add_widget(self.textinput)
         self.grid.add_widget(bottom_layout)
@@ -924,43 +657,29 @@ class GameManager(ThemedApp):
         self.server_connect_bar.focus = True
         self.server_connect_bar.select_text(port_start if port_start > 0 else host_start, len(s))
 
-        # Uncomment to enable the kivy live editor console
-        # Press Ctrl-E (with numlock/capslock) disabled to open
-        # from kivy.core.window import Window
-        # from kivy.modules import console
-        # console.create_console(Window, self.container)
-
         return self.container
 
-    def add_client_tab(self, title: str, content: Widget, index: int = -1) -> Widget:
+    def add_client_tab(self, title: str, content: Widget) -> 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))
+        new_tab = TabbedPanelItem(text=title)
         new_tab.content = content
-        if -1 < index <= len(self.tabs.carousel.slides):
+        self.tabs.add_widget(new_tab)
-            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)
-        else:
-            self.tabs.add_widget(new_tab)
-            self.tabs.carousel.add_widget(new_tab.content)
         return new_tab
 
     def update_texts(self, dt):
-        for slide in self.tabs.carousel.slides:
+        if hasattr(self.tabs.content.children[0], "fix_heights"):
-            if hasattr(slide, "fix_heights"):
+            self.tabs.content.children[0].fix_heights()  # TODO: remove this when Kivy fixes this upstream
-                slide.fix_heights()  # TODO: remove this when Kivy fixes this upstream
         if self.ctx.server:
             self.title = self.base_title + " " + Utils.__version__ + \
                          f" | Connected to: {self.ctx.server_address} " \
                          f"{'.'.join(str(e) for e in self.ctx.server_version)}"
-            self.server_connect_button._button_text.text = "Disconnect"
+            self.server_connect_button.text = "Disconnect"
             self.server_connect_bar.readonly = True
             self.progressbar.max = len(self.ctx.checked_locations) + len(self.ctx.missing_locations)
             self.progressbar.value = len(self.ctx.checked_locations)
         else:
-            self.server_connect_button._button_text.text = "Connect"
+            self.server_connect_button.text = "Connect"
             self.server_connect_bar.readonly = False
             self.title = self.base_title + " " + Utils.__version__
             self.progressbar.value = 0
@@ -1023,8 +742,8 @@ class GameManager(ThemedApp):
 
     def enable_energy_link(self):
         if not hasattr(self, "energy_link_label"):
-            self.energy_link_label = MDLabel(text="Energy Link: Standby",
+            self.energy_link_label = Label(text="Energy Link: Standby",
-                                           size_hint_x=None, width=150, halign="center")
+                                           size_hint_x=None, width=150)
             self.connect_layout.add_widget(self.energy_link_label)
 
     def set_new_energy_link_value(self):
@@ -1060,9 +779,8 @@ class LogtoUI(logging.Handler):
             self.on_log(self.format(record))
 
 
-class UILog(MDRecycleView):
+class UILog(RecycleView):
     messages: typing.ClassVar[int]  # comes from kv file
-    adaptive_height = True
 
     def __init__(self, *loggers_to_handle, **kwargs):
         super(UILog, self).__init__(**kwargs)
@@ -1089,23 +807,16 @@ class UILog(MDRecycleView):
                 element.height = element.texture_size[1]
 
 
-class HintLayout(MDBoxLayout):
+class HintLayout(BoxLayout):
     orientation = "vertical"
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        boxlayout = MDBoxLayout(orientation="horizontal", size_hint_y=None, height=dp(40))
+        boxlayout = BoxLayout(orientation="horizontal", size_hint_y=None, height=dp(30))
-        boxlayout.add_widget(MDLabel(text="New Hint:", size_hint_x=None, size_hint_y=None,
+        boxlayout.add_widget(Label(text="New Hint:", size_hint_x=None, size_hint_y=None, height=dp(30)))
-                                     height=dp(40), width=dp(75), halign="center", valign="center"))
         boxlayout.add_widget(AutocompleteHintInput())
         self.add_widget(boxlayout)
 
-    def fix_heights(self):
-        for child in self.children:
-            fix_func = getattr(child, "fix_heights", None)
-            if fix_func:
-                fix_func()
-
         
 status_names: typing.Dict[HintStatus, str] = {
     HintStatus.HINT_FOUND: "Found",
@@ -1129,7 +840,8 @@ status_sort_weights: dict[HintStatus, int] = {
     HintStatus.HINT_PRIORITY: 4,
 }
 
-class HintLog(MDRecycleView):
+
+class HintLog(RecycleView):
     header = {
         "receiving": {"text": "[u]Receiving Player[/u]"},
         "item": {"text": "[u]Item[/u]"},
@@ -1140,7 +852,7 @@ class HintLog(MDRecycleView):
                    "hint": {"receiving_player": -1, "location": -1, "finding_player": -1, "status": ""}},
         "striped": True,
     }
-    data: list[typing.Any]
+
     sort_key: str = ""
     reversed: bool = True
 
@@ -1153,7 +865,7 @@ class HintLog(MDRecycleView):
         if not hints:  # Fix the scrolling looking visually wrong in some edge cases
             self.scroll_y = 1.0
         data = []
-        ctx = MDApp.get_running_app().ctx
+        ctx = App.get_running_app().ctx
         for hint in hints:
             if not hint.get("status"): # Allows connecting to old servers
                 hint["status"] = HintStatus.HINT_FOUND if hint["found"] else HintStatus.HINT_UNSPECIFIED
@@ -1203,7 +915,6 @@ class HintLog(MDRecycleView):
 
 
 class ApAsyncImage(AsyncImage):
-
     def is_uri(self, filename: str) -> bool:
         if filename.startswith("ap:"):
             return True
@@ -1218,8 +929,7 @@ class ImageLoaderPkgutil(ImageLoaderBase):
         data = pkgutil.get_data(module, path)
         return self._bytes_to_data(data)
 
-    @staticmethod
+    def _bytes_to_data(self, data: typing.Union[bytes, bytearray]) -> typing.List[ImageData]:
-    def _bytes_to_data(data: typing.Union[bytes, bytearray]) -> typing.List[ImageData]:
         loader = next(loader for loader in ImageLoader.loaders if loader.can_load_memory())
         return loader.load(loader, io.BytesIO(data))
 
@@ -1249,23 +959,7 @@ class E(ExceptionHandler):
 class KivyJSONtoTextParser(JSONtoTextParser):
     # dummy class to absorb kvlang definitions
     class TextColors(Widget):
-        white: str = StringProperty("FFFFFF")
+        pass
-        black: str = StringProperty("000000")
-        red: str = StringProperty("EE0000")
-        green: str = StringProperty("00FF7F")
-        yellow: str = StringProperty("FAFAD2")
-        blue: str = StringProperty("6495ED")
-        magenta: str = StringProperty("EE00EE")
-        cyan: str = StringProperty("00EEEE")
-        slateblue: str = StringProperty("6D8BE8")
-        plum: str = StringProperty("AF99EF")
-        salmon: str = StringProperty("FA8072")
-        orange: str = StringProperty("FF7700")
-        # KivyMD parameters
-        theme_style: str = StringProperty("Dark")
-        primary_palette: str = StringProperty("Lightsteelblue")
-        dynamic_scheme_name: str = StringProperty("VIBRANT")
-        dynamic_scheme_contrast: int = NumericProperty(0)
 
     def __init__(self, *args, **kwargs):
         # we grab the color definitions from the .kv file, then overwrite the JSONtoTextParser default entries

requirements.txt

@@ -1,17 +1,14 @@
 colorama>=0.4.6
 websockets>=13.0.1,<14
 PyYAML>=6.0.2
-jellyfish>=1.1.3
+jellyfish>=1.1.0
-jinja2>=3.1.6
+jinja2>=3.1.4
 schema>=0.7.7
-kivy>=2.3.1
+kivy>=2.3.0
-bsdiff4>=1.2.6
+bsdiff4>=1.2.4
-platformdirs>=4.3.6
+platformdirs>=4.2.2
-certifi>=2025.4.26
+certifi>=2024.12.14
-cython>=3.0.12
+cython>=3.0.11
-cymem>=2.0.11
+cymem>=2.0.8
-orjson>=3.10.15
+orjson>=3.10.7
 typing_extensions>=4.12.2
-pyshortcuts>=1.9.1
-kivymd @ git+https://github.com/kivymd/KivyMD@5ff9d0d
-kivymd>=2.0.1.dev0

setup.py

@@ -19,7 +19,7 @@ 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'
+requirement = 'cx-Freeze==7.2.0'
 try:
     import pkg_resources
     try:
@@ -72,6 +72,7 @@ non_apworlds: Set[str] = {
     "Ocarina of Time",
     "Overcooked! 2",
     "Raft",
+    "Slay the Spire",
     "Sudoku",
     "Super Mario 64",
     "VVVVVV",
@@ -153,7 +154,7 @@ if os.path.exists("X:/pw.txt"):
     with open("X:/pw.txt", encoding="utf-8-sig") as f:
         pw = f.read()
     signtool = r'signtool sign /f X:/_SITS_Zertifikat_.pfx /p "' + pw + \
-               r'" /fd sha256 /td sha256 /tr http://timestamp.digicert.com/ '
+               r'" /fd sha256 /tr http://timestamp.digicert.com/ '
 else:
     signtool = None
 
@@ -628,13 +629,12 @@ cx_Freeze.setup(
     ext_modules=cythonize("_speedups.pyx"),
     options={
         "build_exe": {
-            "packages": ["worlds", "kivy", "cymem", "websockets", "kivymd"],
+            "packages": ["worlds", "kivy", "cymem", "websockets"],
             "includes": [],
             "excludes": ["numpy", "Cython", "PySide2", "PIL",
-                         "pandas"],
+                         "pandas", "zstandard"],
-            "zip_includes": [],
             "zip_include_packages": ["*"],
-            "zip_exclude_packages": ["worlds", "sc2", "kivymd"],
+            "zip_exclude_packages": ["worlds", "sc2"],
             "include_files": [],  # broken in cx 6.14.0, we use more special sauce now
             "include_msvcr": False,
             "replace_paths": ["*."],

test/cpp/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.16)
+cmake_minimum_required(VERSION 3.5)
 project(ap-cpp-tests)
 
 enable_testing()
@@ -7,8 +7,8 @@ find_package(GTest REQUIRED)
 
 if (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
     add_definitions("/source-charset:utf-8")
-    # set(CMAKE_CXX_FLAGS_DEBUG "/MDd") # this is the default
+    set(CMAKE_CXX_FLAGS_DEBUG "/MTd")
-    # set(CMAKE_CXX_FLAGS_RELEASE "/MD") # this is the default
+    set(CMAKE_CXX_FLAGS_RELEASE "/MT")
 elseif (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
     # enable static analysis for gcc
     add_compile_options(-fanalyzer -Werror)

test/general/test_entrance_rando.py

@@ -1,4 +1,3 @@
-from typing import Callable
 import unittest
 from enum import IntEnum
 
@@ -35,7 +34,7 @@ def generate_entrance_pair(region: Region, name_suffix: str, group: int):
 
 
 def generate_disconnected_region_grid(multiworld: MultiWorld, grid_side_length: int, region_size: int = 0,
-                                      region_creator: Callable[[str, int, MultiWorld], Region] = Region):
+                                      region_type: type[Region] = Region):
     """
     Generates a grid-like region structure for ER testing, where menu is connected to the top-left region, and each
     region "in vanilla" has 2 2-way exits going either down or to the right, until reaching the goal region in the
@@ -45,7 +44,7 @@ def generate_disconnected_region_grid(multiworld: MultiWorld, grid_side_length:
         for col in range(grid_side_length):
             index = row * grid_side_length + col
             name = f"region{index}"
-            region = region_creator(name, 1, multiworld)
+            region = region_type(name, 1, multiworld)
             multiworld.regions.append(region)
             generate_locations(region_size, 1, region=region, tag=f"_{name}")
 
@@ -66,10 +65,8 @@ class TestEntranceLookup(unittest.TestCase):
         """tests that get_targets shuffles targets between groups when requested"""
         multiworld = generate_test_multiworld()
         generate_disconnected_region_grid(multiworld, 5)
-        exits_set = set([ex for region in multiworld.get_regions(1)
-                        for ex in region.exits if not ex.connected_region])
 
-        lookup = EntranceLookup(multiworld.worlds[1].random, coupled=True, usable_exits=exits_set)
+        lookup = EntranceLookup(multiworld.worlds[1].random, coupled=True)
         er_targets = [entrance for region in multiworld.get_regions(1)
                       for entrance in region.entrances if not entrance.parent_region]
         for entrance in er_targets:
@@ -89,10 +86,8 @@ class TestEntranceLookup(unittest.TestCase):
         """tests that get_targets does not shuffle targets between groups when requested"""
         multiworld = generate_test_multiworld()
         generate_disconnected_region_grid(multiworld, 5)
-        exits_set = set([ex for region in multiworld.get_regions(1)
-                        for ex in region.exits if not ex.connected_region])
 
-        lookup = EntranceLookup(multiworld.worlds[1].random, coupled=True, usable_exits=exits_set)
+        lookup = EntranceLookup(multiworld.worlds[1].random, coupled=True)
         er_targets = [entrance for region in multiworld.get_regions(1)
                       for entrance in region.entrances if not entrance.parent_region]
         for entrance in er_targets:
@@ -104,30 +99,6 @@ class TestEntranceLookup(unittest.TestCase):
         group_order = [prev := group.randomization_group for group in retrieved_targets if prev != group.randomization_group]
         self.assertEqual([ERTestGroups.TOP, ERTestGroups.BOTTOM], group_order)
 
-    def test_selective_dead_ends(self):
-        """test that entrances that EntranceLookup has not been told to consider are ignored when finding dead-ends"""
-        multiworld = generate_test_multiworld()
-        generate_disconnected_region_grid(multiworld, 5)
-        exits_set = set([ex for region in multiworld.get_regions(1)
-                        for ex in region.exits if not ex.connected_region
-                         and ex.name != "region20_right" and ex.name != "region21_left"])
-
-        lookup = EntranceLookup(multiworld.worlds[1].random, coupled=True, usable_exits=exits_set)
-        er_targets = [entrance for region in multiworld.get_regions(1)
-                      for entrance in region.entrances if not entrance.parent_region and
-                      entrance.name != "region20_right" and entrance.name != "region21_left"]
-        for entrance in er_targets:
-            lookup.add(entrance)
-        # region 20 is the bottom left corner of the grid, and therefore only has a right entrance from region 21
-        # and a top entrance from region 15; since we've told lookup to ignore the right entrance from region 21,
-        # the top entrance from region 15 should be considered a dead-end
-        dead_end_region = multiworld.get_region("region20", 1)
-        for dead_end in dead_end_region.entrances:
-            if dead_end.name == "region20_top":
-                break
-        # there should be only this one dead-end
-        self.assertTrue(dead_end in lookup.dead_ends)
-        self.assertEqual(len(lookup.dead_ends), 1)
 
 class TestBakeTargetGroupLookup(unittest.TestCase):
     def test_lookup_generation(self):
@@ -177,7 +148,7 @@ class TestDisconnectForRandomization(unittest.TestCase):
         e.randomization_group = 1
         e.connect(r2)
 
-        disconnect_entrance_for_randomization(e, one_way_target_name="foo")
+        disconnect_entrance_for_randomization(e)
 
         self.assertIsNone(e.connected_region)
         self.assertEqual([], r1.entrances)
@@ -187,22 +158,10 @@ class TestDisconnectForRandomization(unittest.TestCase):
 
         self.assertEqual(1, len(r2.entrances))
         self.assertIsNone(r2.entrances[0].parent_region)
-        self.assertEqual("foo", r2.entrances[0].name)
+        self.assertEqual("r2", r2.entrances[0].name)
         self.assertEqual(EntranceType.ONE_WAY, r2.entrances[0].randomization_type)
         self.assertEqual(1, r2.entrances[0].randomization_group)
 
-    def test_disconnect_default_1way_no_vanilla_target_raises(self):
-        multiworld = generate_test_multiworld()
-        r1 = Region("r1", 1, multiworld)
-        r2 = Region("r2", 1, multiworld)
-        e = r1.create_exit("e")
-        e.randomization_type = EntranceType.ONE_WAY
-        e.randomization_group = 1
-        e.connect(r2)
-
-        with self.assertRaises(ValueError):
-            disconnect_entrance_for_randomization(e)
-
     def test_disconnect_uses_alternate_group(self):
         multiworld = generate_test_multiworld()
         r1 = Region("r1", 1, multiworld)
@@ -212,7 +171,7 @@ class TestDisconnectForRandomization(unittest.TestCase):
         e.randomization_group = 1
         e.connect(r2)
 
-        disconnect_entrance_for_randomization(e, 2, "foo")
+        disconnect_entrance_for_randomization(e, 2)
 
         self.assertIsNone(e.connected_region)
         self.assertEqual([], r1.entrances)
@@ -222,7 +181,7 @@ class TestDisconnectForRandomization(unittest.TestCase):
 
         self.assertEqual(1, len(r2.entrances))
         self.assertIsNone(r2.entrances[0].parent_region)
-        self.assertEqual("foo", r2.entrances[0].name)
+        self.assertEqual("r2", r2.entrances[0].name)
         self.assertEqual(EntranceType.ONE_WAY, r2.entrances[0].randomization_type)
         self.assertEqual(2, r2.entrances[0].randomization_group)
 
@@ -259,7 +218,7 @@ class TestRandomizeEntrances(unittest.TestCase):
         self.assertEqual(80, len(result.pairings))
         self.assertEqual(80, len(result.placements))
 
-    def test_coupled(self):
+    def test_coupling(self):
         """tests that in coupled mode, all 2 way transitions have an inverse"""
         multiworld = generate_test_multiworld()
         generate_disconnected_region_grid(multiworld, 5)
@@ -277,36 +236,6 @@ class TestRandomizeEntrances(unittest.TestCase):
         # if we didn't visit every placement the verification on_connect doesn't really mean much
         self.assertEqual(len(result.placements), seen_placement_count)
 
-    def test_uncoupled_succeeds_stage1_indirect_condition(self):
-        multiworld = generate_test_multiworld()
-        menu = multiworld.get_region("Menu", 1)
-        generate_entrance_pair(menu, "_right", ERTestGroups.RIGHT)
-        end = Region("End", 1, multiworld)
-        multiworld.regions.append(end)
-        generate_entrance_pair(end, "_left", ERTestGroups.LEFT)
-        multiworld.register_indirect_condition(end, None)
-
-        result = randomize_entrances(multiworld.worlds[1], False, directionally_matched_group_lookup)
-        self.assertSetEqual({
-            ("Menu_right", "End_left"),
-            ("End_left", "Menu_right")
-        }, set(result.pairings))
-
-    def test_coupled_succeeds_stage1_indirect_condition(self):
-        multiworld = generate_test_multiworld()
-        menu = multiworld.get_region("Menu", 1)
-        generate_entrance_pair(menu, "_right", ERTestGroups.RIGHT)
-        end = Region("End", 1, multiworld)
-        multiworld.regions.append(end)
-        generate_entrance_pair(end, "_left", ERTestGroups.LEFT)
-        multiworld.register_indirect_condition(end, None)
-
-        result = randomize_entrances(multiworld.worlds[1], True, directionally_matched_group_lookup)
-        self.assertSetEqual({
-            ("Menu_right", "End_left"),
-            ("End_left", "Menu_right")
-        }, set(result.pairings))
-
     def test_uncoupled(self):
         """tests that in uncoupled mode, no transitions have an (intentional) inverse"""
         multiworld = generate_test_multiworld()
@@ -466,7 +395,7 @@ class TestRandomizeEntrances(unittest.TestCase):
             entrance_type = CustomEntrance
 
         multiworld = generate_test_multiworld()
-        generate_disconnected_region_grid(multiworld, 5, region_creator=CustomRegion)
+        generate_disconnected_region_grid(multiworld, 5, region_type=CustomRegion)
 
         self.assertRaises(EntranceRandomizationError, randomize_entrances, multiworld.worlds[1], False,
                           directionally_matched_group_lookup)

test/general/test_ids.py

@@ -47,39 +47,13 @@ class TestIDs(unittest.TestCase):
         """Test that a game doesn't have item id overlap within its own datapackage"""
         for gamename, world_type in AutoWorldRegister.world_types.items():
             with self.subTest(game=gamename):
-                len_item_id_to_name = len(world_type.item_id_to_name)
+                self.assertEqual(len(world_type.item_id_to_name), len(world_type.item_name_to_id))
-                len_item_name_to_id = len(world_type.item_name_to_id)
-
-                if len_item_id_to_name != len_item_name_to_id:
-                    self.assertCountEqual(
-                        world_type.item_id_to_name.values(), 
-                        world_type.item_name_to_id.keys(),
-                        "\nThese items have overlapping ids with other items in its own world")
-                    self.assertCountEqual(
-                        world_type.item_id_to_name.keys(), 
-                        world_type.item_name_to_id.values(),
-                        "\nThese items have overlapping names with other items in its own world")
-                    
-                self.assertEqual(len_item_id_to_name, len_item_name_to_id)
 
     def test_duplicate_location_ids(self):
         """Test that a game doesn't have location id overlap within its own datapackage"""
         for gamename, world_type in AutoWorldRegister.world_types.items():
             with self.subTest(game=gamename):
-                len_location_id_to_name = len(world_type.location_id_to_name)
+                self.assertEqual(len(world_type.location_id_to_name), len(world_type.location_name_to_id))
-                len_location_name_to_id = len(world_type.location_name_to_id)
-
-                if len_location_id_to_name != len_location_name_to_id:
-                    self.assertCountEqual(
-                        world_type.location_id_to_name.values(), 
-                        world_type.location_name_to_id.keys(),
-                        "\nThese locations have overlapping ids with other locations in its own world")
-                    self.assertCountEqual(
-                        world_type.location_id_to_name.keys(), 
-                        world_type.location_name_to_id.values(),
-                        "\nThese locations have overlapping names with other locations in its own world")
-
-                self.assertEqual(len_location_id_to_name, len_location_name_to_id)
 
     def test_postgen_datapackage(self):
         """Generates a solo multiworld and checks that the datapackage is still valid"""

test/general/test_items.py

@@ -1,11 +1,6 @@
 import unittest
-from argparse import Namespace
-from typing import Type
 
-from BaseClasses import CollectionState, MultiWorld
+from worlds.AutoWorld import AutoWorldRegister, call_all
-from Fill import distribute_items_restrictive
-from Options import ItemLinks
-from worlds.AutoWorld import AutoWorldRegister, World, call_all
 from . import setup_solo_multiworld
 
 
@@ -13,31 +8,12 @@ class TestBase(unittest.TestCase):
     def test_create_item(self):
         """Test that a world can successfully create all items in its datapackage"""
         for game_name, world_type in AutoWorldRegister.world_types.items():
-            multiworld = setup_solo_multiworld(world_type, steps=("generate_early", "create_regions", "create_items"))
+            proxy_world = setup_solo_multiworld(world_type, ()).worlds[1]
-            proxy_world = multiworld.worlds[1]
             for item_name in world_type.item_name_to_id:
-                test_state = CollectionState(multiworld)
                 with self.subTest("Create Item", item_name=item_name, game_name=game_name):
                     item = proxy_world.create_item(item_name)
-
-                with self.subTest("Item Name", item_name=item_name, game_name=game_name):
                     self.assertEqual(item.name, item_name)
 
-                if item.advancement:
-                    with self.subTest("Item State Collect", item_name=item_name, game_name=game_name):
-                        test_state.collect(item, True)
-
-                    with self.subTest("Item State Remove", item_name=item_name, game_name=game_name):
-                        test_state.remove(item)
-
-                        self.assertEqual(test_state.prog_items, multiworld.state.prog_items,
-                                         "Item Collect -> Remove should restore empty state.")
-                else:
-                    with self.subTest("Item State Collect No Change", item_name=item_name, game_name=game_name):
-                        # Non-Advancement should not modify state.
-                        test_state.collect(item)
-                        self.assertEqual(test_state.prog_items, multiworld.state.prog_items)
-
     def test_item_name_group_has_valid_item(self):
         """Test that all item name groups contain valid items. """
         # This cannot test for Event names that you may have declared for logic, only sendable Items.
@@ -88,47 +64,6 @@ class TestBase(unittest.TestCase):
                 for item in multiworld.itempool:
                     self.assertIn(item.name, world_type.item_name_to_id)
 
-    def test_item_links(self) -> None:
-        """
-        Tests item link creation by creating a multiworld of 2 worlds for every game and linking their items together.
-        """
-        def setup_link_multiworld(world: Type[World], link_replace: bool) -> None:
-            multiworld = MultiWorld(2)
-            multiworld.game = {1: world.game, 2: world.game}
-            multiworld.player_name = {1: "Linker 1", 2: "Linker 2"}
-            multiworld.set_seed()
-            item_link_group = [{
-                "name": "ItemLinkTest",
-                "item_pool": ["Everything"],
-                "link_replacement": link_replace,
-                "replacement_item": None,
-            }]
-            args = Namespace()
-            for name, option in world.options_dataclass.type_hints.items():
-                setattr(args, name, {1: option.from_any(option.default), 2: option.from_any(option.default)})
-            setattr(args, "item_links",
-                    {1: ItemLinks.from_any(item_link_group), 2: ItemLinks.from_any(item_link_group)})
-            multiworld.set_options(args)
-            multiworld.set_item_links()
-            # groups get added to state during its constructor so this has to be after item links are set
-            multiworld.state = CollectionState(multiworld)
-            gen_steps = ("generate_early", "create_regions", "create_items", "set_rules", "connect_entrances", "generate_basic")
-            for step in gen_steps:
-                call_all(multiworld, step)
-            # link the items together and attempt to fill
-            multiworld.link_items()
-            multiworld._all_state = None
-            call_all(multiworld, "pre_fill")
-            distribute_items_restrictive(multiworld)
-            call_all(multiworld, "post_fill")
-            self.assertTrue(multiworld.can_beat_game(CollectionState(multiworld)), f"seed = {multiworld.seed}")
-
-        for game_name, world_type in AutoWorldRegister.world_types.items():
-            with self.subTest("Can generate with link replacement", game=game_name):
-                setup_link_multiworld(world_type, True)
-            with self.subTest("Can generate without link replacement", game=game_name):
-                setup_link_multiworld(world_type, False)
-
     def test_itempool_not_modified(self):
         """Test that worlds don't modify the itempool after `create_items`"""
         gen_steps = ("generate_early", "create_regions", "create_items")

test/general/test_packages.py

@@ -1,14 +0,0 @@
-import unittest
-import os
-
-
-class TestPackages(unittest.TestCase):
-    def test_packages_have_init(self):
-        """Test that all world folders containing .py files also have a __init__.py file,
-        to indicate full package rather than namespace package."""
-        import Utils
-
-        worlds_path = Utils.local_path("worlds")
-        for dirpath, dirnames, filenames in os.walk(worlds_path):
-            with self.subTest(directory=dirpath):
-                self.assertEqual("__init__.py" in filenames, any(file.endswith(".py") for file in filenames))

test/general/test_patches.py

@@ -1,11 +0,0 @@
-import unittest
-from worlds.AutoWorld import AutoWorldRegister
-from worlds.Files import AutoPatchRegister
-
-
-class TestPatches(unittest.TestCase):
-    def test_patch_name_matches_game(self) -> None:
-        for game_name in AutoPatchRegister.patch_types:
-            with self.subTest(game=game_name):
-                self.assertIn(game_name, AutoWorldRegister.world_types.keys(),
-                              f"Patch '{game_name}' does not match the name of any world.")

test/general/test_requirements.py

@@ -1,19 +0,0 @@
-import unittest
-import os
-
-
-class TestBase(unittest.TestCase):
-    def test_requirements_file_ends_on_newline(self):
-        """Test that all requirements files end on a newline"""
-        import Utils
-        requirements_files = [Utils.local_path("requirements.txt"),
-                              Utils.local_path("WebHostLib", "requirements.txt")]
-        worlds_path = Utils.local_path("worlds")
-        for entry in os.listdir(worlds_path):
-            requirements_path = os.path.join(worlds_path, entry, "requirements.txt")
-            if os.path.isfile(requirements_path):
-                requirements_files.append(requirements_path)
-        for requirements_file in requirements_files:
-            with self.subTest(path=requirements_file):
-                with open(requirements_file) as f:
-                    self.assertEqual(f.read()[-1], "\n")

test/hosting/client.py

@@ -80,8 +80,8 @@ class Client:
             "version": {
                 "class": "Version",
                 "major": 0,
-                "minor": 6,
+                "minor": 4,
-                "build": 0,
+                "build": 6,
             },
             "items_handling": 0,
             "tags": [],

test/multiworld/test_multiworlds.py

@@ -1,5 +1,5 @@
 import unittest
-from typing import ClassVar, List, Tuple
+from typing import List, Tuple
 from unittest import TestCase
 
 from BaseClasses import CollectionState, Location, MultiWorld
@@ -7,7 +7,6 @@ from Fill import distribute_items_restrictive
 from Options import Accessibility
 from worlds.AutoWorld import AutoWorldRegister, call_all, call_single
 from ..general import gen_steps, setup_multiworld
-from ..param import classvar_matrix
 
 
 class MultiworldTestBase(TestCase):
@@ -64,18 +63,15 @@ class TestAllGamesMultiworld(MultiworldTestBase):
             self.assertTrue(self.fulfills_accessibility(), "Collected all locations, but can't beat the game")
 
 
-@classvar_matrix(game=AutoWorldRegister.world_types.keys())
 class TestTwoPlayerMulti(MultiworldTestBase):
-    game: ClassVar[str]
-
     def test_two_player_single_game_fills(self) -> None:
         """Tests that a multiworld of two players for each registered game world can generate."""
-        world_type = AutoWorldRegister.world_types[self.game]
+        for world_type in AutoWorldRegister.world_types.values():
-        self.multiworld = setup_multiworld([world_type, world_type], ())
+            self.multiworld = setup_multiworld([world_type, world_type], ())
-        for world in self.multiworld.worlds.values():
+            for world in self.multiworld.worlds.values():
-            world.options.accessibility.value = Accessibility.option_full
+                world.options.accessibility.value = Accessibility.option_full
-        self.assertSteps(gen_steps)
+            self.assertSteps(gen_steps)
-        with self.subTest("filling multiworld", games=world_type.game, seed=self.multiworld.seed):
+            with self.subTest("filling multiworld", games=world_type.game, seed=self.multiworld.seed):
-            distribute_items_restrictive(self.multiworld)
+                distribute_items_restrictive(self.multiworld)
-            call_all(self.multiworld, "post_fill")
+                call_all(self.multiworld, "post_fill")
-            self.assertTrue(self.fulfills_accessibility(), "Collected all locations, but can't beat the game")
+                self.assertTrue(self.fulfills_accessibility(), "Collected all locations, but can't beat the game")

test/param.py

@@ -1,46 +0,0 @@
-import itertools
-import sys
-from typing import Any, Callable, Iterable
-
-
-def classvar_matrix(**kwargs: Iterable[Any]) -> Callable[[type], None]:
-    """
-    Create a new class for each variation of input, allowing to generate a TestCase matrix / parametrization that
-    supports multi-threading and has better reporting for ``unittest --durations=...`` and ``pytest --durations=...``
-    than subtests.
-
-    The kwargs will be set as ClassVars in the newly created classes. Use as ::
-
-        @classvar_matrix(var_name=[value1, value2])
-        class MyTestCase(unittest.TestCase):
-            var_name: typing.ClassVar[...]
-
-    :param kwargs: A dict of ClassVars to set, where key is the variable name and value is a list of all values.
-    :return: A decorator to be applied to a class.
-    """
-    keys: tuple[str]
-    values: Iterable[Iterable[Any]]
-    keys, values = zip(*kwargs.items())
-    values = map(lambda v: sorted(v) if isinstance(v, (set, frozenset)) else v, values)
-    permutations_dicts = [dict(zip(keys, v)) for v in itertools.product(*values)]
-
-    def decorator(cls: type) -> None:
-        mod = sys.modules[cls.__module__]
-
-        for permutation in permutations_dicts:
-
-            class Unrolled(cls):  # type: ignore
-                pass
-
-            for k, v in permutation.items():
-                setattr(Unrolled, k, v)
-            params = ", ".join([f"{k}={repr(v)}" for k, v in permutation.items()])
-            params = f"{{{params}}}"
-
-            Unrolled.__module__ = cls.__module__
-            Unrolled.__qualname__ = f"{cls.__qualname__}{params}"
-            setattr(mod, f"{cls.__name__}{params}", Unrolled)
-
-        return None
-
-    return decorator

test/programs/test_common_client.py

@@ -47,6 +47,17 @@ class TestCommonContext(unittest.IsolatedAsyncioTestCase):
         assert "Archipelago" in self.ctx.item_names, "Archipelago item names entry does not exist"
         assert "Archipelago" in self.ctx.location_names, "Archipelago location names entry does not exist"
 
+    async def test_implicit_name_lookups(self):
+        # Items
+        assert self.ctx.item_names[2**54 + 1] == "Test Item 1 - Safe"
+        assert self.ctx.item_names[2**54 + 3] == f"Unknown item (ID: {2**54+3})"
+        assert self.ctx.item_names[-1] == "Nothing"
+
+        # Locations
+        assert self.ctx.location_names[2**54 + 1] == "Test Location 1 - Safe"
+        assert self.ctx.location_names[2**54 + 3] == f"Unknown location (ID: {2**54+3})"
+        assert self.ctx.location_names[-1] == "Cheat Console"
+
     async def test_explicit_name_lookups(self):
         # Items
         assert self.ctx.item_names["__TestGame1"][2**54+1] == "Test Item 1 - Safe"

test/utils/test_caches.py

@@ -35,19 +35,6 @@ class TestCacheSelf1(unittest.TestCase):
         self.assertFalse(o1.func(1) is o1.func(2))
         self.assertFalse(o1.func(1) is o2.func(1))
 
-    def test_cache_default(self) -> None:
-        class Cls:
-            @cache_self1
-            def func(self, _: Any = 1) -> object:
-                return object()
-
-        o1 = Cls()
-        o2 = Cls()
-        self.assertIs(o1.func(), o1.func())
-        self.assertIs(o1.func(1), o1.func())
-        self.assertIsNot(o1.func(2), o1.func())
-        self.assertIsNot(o1.func(), o2.func())
-
     def test_gc(self) -> None:
         # verify that we don't keep a global reference
         import gc

test/webhost/test_option_presets.py

@@ -2,7 +2,7 @@ import unittest
 
 from BaseClasses import PlandoOptions
 from worlds import AutoWorldRegister
-from Options import OptionCounter, NamedRange, NumericOption, OptionList, OptionSet
+from Options import ItemDict, NamedRange, NumericOption, OptionList, OptionSet
 
 
 class TestOptionPresets(unittest.TestCase):
@@ -19,7 +19,7 @@ class TestOptionPresets(unittest.TestCase):
                             # pass in all plando options in case a preset wants to require certain plando options
                             # for some reason
                             option.verify(world_type, "Test Player", PlandoOptions(sum(PlandoOptions)))
-                            supported_types = [NumericOption, OptionSet, OptionList, OptionCounter]
+                            supported_types = [NumericOption, OptionSet, OptionList, ItemDict]
                             if not any([issubclass(option.__class__, t) for t in supported_types]):
                                 self.fail(f"'{option_name}' in preset '{preset_name}' for game '{game_name}' "
                                           f"is not a supported type for webhost. "

test/worlds/__init__.py

@@ -12,7 +12,7 @@ def load_tests(loader, standard_tests, pattern):
     all_tests = [
         test_case for folder in folders if os.path.exists(folder)
         for test_collection in loader.discover(folder, top_level_dir=file_path)
-        for test_suite in test_collection if isinstance(test_suite, unittest.suite.TestSuite)
+        for test_suite in test_collection
         for test_case in test_suite
     ]
 

worlds/AutoSNIClient.py

@@ -9,8 +9,7 @@ from worlds.LauncherComponents import Component, SuffixIdentifier, Type, compone
 if TYPE_CHECKING:
     from SNIClient import SNIContext
 
-component = Component('SNI Client', 'SNIClient', component_type=Type.CLIENT, file_identifier=SuffixIdentifier(".apsoe"),
+component = Component('SNI Client', 'SNIClient', component_type=Type.CLIENT, file_identifier=SuffixIdentifier(".apsoe"))
-                      description="A client for connecting to SNES consoles via Super Nintendo Interface.")
 components.append(component)
 
 

worlds/AutoWorld.py

@@ -12,7 +12,6 @@ from typing import (Any, Callable, ClassVar, Dict, FrozenSet, Iterable, List, Ma
 
 from Options import item_and_loc_options, ItemsAccessibility, OptionGroup, PerGameCommonOptions
 from BaseClasses import CollectionState
-from Utils import deprecate
 
 if TYPE_CHECKING:
     from BaseClasses import MultiWorld, Item, Location, Tutorial, Region, Entrance
@@ -76,20 +75,19 @@ class AutoWorldRegister(type):
         # TODO - remove this once all worlds use options dataclasses
         if "options_dataclass" not in dct and "option_definitions" in dct:
             # TODO - switch to deprecate after a version
-            deprecate(f"{name} Assigned options through option_definitions which is now deprecated. "
+            if __debug__:
-                      "Please use options_dataclass instead.")
+                logging.warning(f"{name} Assigned options through option_definitions which is now deprecated. "
+                                "Please use options_dataclass instead.")
             dct["options_dataclass"] = make_dataclass(f"{name}Options", dct["option_definitions"].items(),
                                                       bases=(PerGameCommonOptions,))
 
         # construct class
         new_class = super().__new__(mcs, name, bases, dct)
-        new_class.__file__ = sys.modules[new_class.__module__].__file__
         if "game" in dct:
             if dct["game"] in AutoWorldRegister.world_types:
-                raise RuntimeError(f"""Game {dct["game"]} already registered in 
+                raise RuntimeError(f"""Game {dct["game"]} already registered.""")
-                {AutoWorldRegister.world_types[dct["game"]].__file__} when attempting to register from
-                {new_class.__file__}.""")
             AutoWorldRegister.world_types[dct["game"]] = new_class
+        new_class.__file__ = sys.modules[new_class.__module__].__file__
         if ".apworld" in new_class.__file__:
             new_class.zip_path = pathlib.Path(new_class.__file__).parents[1]
         if "settings_key" not in dct:
@@ -112,16 +110,6 @@ class AutoLogicRegister(type):
             elif not item_name.startswith("__"):
                 if hasattr(CollectionState, item_name):
                     raise Exception(f"Name conflict on Logic Mixin {name} trying to overwrite {item_name}")
-
-                assert callable(function) or "init_mixin" in dct, (
-                    f"{name} defined class variable {item_name} without also having init_mixin.\n\n"
-                    "Explanation:\n"
-                    "Class variables that will be mutated need to be inintialized as instance variables in init_mixin.\n"
-                    "If your LogicMixin variables aren't actually mutable / you don't intend to mutate them, "
-                    "there is no point in using LogixMixin.\n"
-                    "LogicMixin exists to track custom state variables that change when items are collected/removed."
-                )
-
                 setattr(CollectionState, item_name, function)
         return new_class
 
@@ -485,7 +473,7 @@ class World(metaclass=AutoWorldRegister):
     def get_filler_item_name(self) -> str:
         """Called when the item pool needs to be filled with additional items to match location count."""
         logging.warning(f"World {self} is generating a filler item without custom filler pool.")
-        return self.random.choice(tuple(self.item_name_to_id.keys()))
+        return self.multiworld.random.choice(tuple(self.item_name_to_id.keys()))
 
     @classmethod
     def create_group(cls, multiworld: "MultiWorld", new_player_id: int, players: Set[int]) -> World:

worlds/LauncherComponents.py

@@ -27,8 +27,6 @@ class Component:
     """
     display_name: str
     """Used as the GUI button label and the component name in the CLI args"""
-    description: str
-    """Optional description displayed on the GUI underneath the display name"""
     type: Type
     """
     Enum "Type" classification of component intent, for filtering in the Launcher GUI
@@ -60,9 +58,8 @@ class Component:
     def __init__(self, display_name: str, script_name: Optional[str] = None, frozen_name: Optional[str] = None,
                  cli: bool = False, icon: str = 'icon', component_type: Optional[Type] = None,
                  func: Optional[Callable] = None, file_identifier: Optional[Callable[[str], bool]] = None,
-                 game_name: Optional[str] = None, supports_uri: Optional[bool] = False, description: str = "") -> None:
+                 game_name: Optional[str] = None, supports_uri: Optional[bool] = False):
         self.display_name = display_name
-        self.description = description
         self.script_name = script_name
         self.frozen_name = frozen_name or f'Archipelago{script_name}' if script_name else None
         self.icon = icon
@@ -91,6 +88,7 @@ processes = weakref.WeakSet()
 
 
 def launch_subprocess(func: Callable, name: str | None = None, args: Tuple[str, ...] = ()) -> None:
+    global processes
     import multiprocessing
     process = multiprocessing.Process(target=func, name=name, args=args)
     process.start()

worlds/_bizhawk/context.py

@@ -41,7 +41,6 @@ class BizHawkClientCommandProcessor(ClientCommandProcessor):
 
 class BizHawkClientContext(CommonContext):
     command_processor = BizHawkClientCommandProcessor
-    server_seed_name: str | None = None
     auth_status: AuthStatus
     password_requested: bool
     client_handler: BizHawkClient | None
@@ -69,8 +68,6 @@ class BizHawkClientContext(CommonContext):
         if cmd == "Connected":
             self.slot_data = args.get("slot_data", None)
             self.auth_status = AuthStatus.AUTHENTICATED
-        elif cmd == "RoomInfo":
-            self.server_seed_name = args.get("seed_name", None)
 
         if self.client_handler is not None:
             self.client_handler.on_package(self, cmd, args)
@@ -103,7 +100,6 @@ class BizHawkClientContext(CommonContext):
 
     async def disconnect(self, allow_autoreconnect: bool=False):
         self.auth_status = AuthStatus.NOT_AUTHENTICATED
-        self.server_seed_name = None
         await super().disconnect(allow_autoreconnect)
 
 
@@ -276,6 +272,6 @@ def launch(*launch_args: str) -> None:
 
     Utils.init_logging("BizHawkClient", exception_logger="Client")
     import colorama
-    colorama.just_fix_windows_console()
+    colorama.init()
     asyncio.run(main())
     colorama.deinit()

worlds/adventure/__init__.py

@@ -238,12 +238,14 @@ class AdventureWorld(World):
 
     def create_regions(self) -> None:
         create_regions(self.options, self.multiworld, self.player, self.dragon_rooms)
+
+    set_rules = set_rules
+
+    def generate_basic(self) -> None:
         self.multiworld.get_location("Chalice Home", self.player).place_locked_item(
             self.create_event("Victory", ItemClassification.progression))
         self.multiworld.completion_condition[self.player] = lambda state: state.has("Victory", self.player)
 
-    set_rules = set_rules
-
     def pre_fill(self):
         # Place empty items in filler locations here, to limit
         # the number of exported empty items and the density of stuff in overworld.

worlds/ahit/Client.py

@@ -261,6 +261,6 @@ def launch():
     # options = Utils.get_options()
 
     import colorama
-    colorama.just_fix_windows_console()
+    colorama.init()
     asyncio.run(main())
     colorama.deinit()

worlds/ahit/Locations.py

@@ -206,7 +206,7 @@ ahit_locations = {
     "Subcon Village - Graveyard Ice Cube": LocData(2000325077, "Subcon Forest Area"),
     "Subcon Village - House Top": LocData(2000325471, "Subcon Forest Area"),
     "Subcon Village - Ice Cube House": LocData(2000325469, "Subcon Forest Area"),
-    "Subcon Village - Snatcher Statue Chest": LocData(2000323730, "Subcon Forest Behind Boss Firewall"),
+    "Subcon Village - Snatcher Statue Chest": LocData(2000323730, "Subcon Forest Area", paintings=1),
     "Subcon Village - Stump Platform Chest": LocData(2000323729, "Subcon Forest Area"),
     "Subcon Forest - Giant Tree Climb": LocData(2000325470, "Subcon Forest Area"),
 
@@ -233,7 +233,7 @@ ahit_locations = {
     "Subcon Forest - Long Tree Climb Chest": LocData(2000323734, "Subcon Forest Area",
                                                      required_hats=[HatType.DWELLER], paintings=2),
 
-    "Subcon Forest - Boss Arena Chest": LocData(2000323735, "Subcon Forest Boss Arena"),
+    "Subcon Forest - Boss Arena Chest": LocData(2000323735, "Subcon Forest Area"),
 
     "Subcon Forest - Manor Rooftop": LocData(2000325466, "Subcon Forest Area",
                                              hit_type=HitType.dweller_bell, paintings=1),
@@ -411,7 +411,7 @@ act_completions = {
     "Act Completion (Mail Delivery Service)": LocData(2000312032, "Mail Delivery Service",
                                                       required_hats=[HatType.SPRINT]),
 
-    "Act Completion (Your Contract has Expired)": LocData(2000311390, "Your Contract has Expired - Post Fight",
+    "Act Completion (Your Contract has Expired)": LocData(2000311390, "Your Contract has Expired",
                                                           hit_type=HitType.umbrella),
 
     "Act Completion (Time Rift - Pipe)": LocData(2000313069, "Time Rift - Pipe", hookshot=True),
@@ -976,6 +976,7 @@ event_locs = {
     **snatcher_coins,
     "HUMT Access": LocData(0, "Heating Up Mafia Town"),
     "TOD Access": LocData(0, "Toilet of Doom"),
+    "YCHE Access": LocData(0, "Your Contract has Expired"),
     "AFR Access": LocData(0, "Alpine Free Roam"),
     "TIHS Access": LocData(0, "The Illness has Spread"),
 

worlds/ahit/Options.py

@@ -2,7 +2,7 @@ from typing import List, TYPE_CHECKING, Dict, Any
 from schema import Schema, Optional
 from dataclasses import dataclass
 from worlds.AutoWorld import PerGameCommonOptions
-from Options import Range, Toggle, DeathLink, Choice, OptionDict, DefaultOnToggle, OptionGroup, StartInventoryPool
+from Options import Range, Toggle, DeathLink, Choice, OptionDict, DefaultOnToggle, OptionGroup
 
 if TYPE_CHECKING:
     from . import HatInTimeWorld
@@ -625,8 +625,6 @@ class ParadeTrapWeight(Range):
 
 @dataclass
 class AHITOptions(PerGameCommonOptions):
-    start_inventory_from_pool: StartInventoryPool
-
     EndGoal:                  EndGoal
     ActRandomizer:            ActRandomizer
     ActPlando:                ActPlando

worlds/ahit/Regions.py

@@ -347,7 +347,7 @@ def create_regions(world: "HatInTimeWorld"):
     sf_act3 = create_region_and_connect(world, "Toilet of Doom", "Subcon Forest - Act 3", subcon_forest)
     sf_act4 = create_region_and_connect(world, "Queen Vanessa's Manor", "Subcon Forest - Act 4", subcon_forest)
     sf_act5 = create_region_and_connect(world, "Mail Delivery Service", "Subcon Forest - Act 5", subcon_forest)
-    sf_finale = create_region_and_connect(world, "Your Contract has Expired", "Subcon Forest - Finale", subcon_forest)
+    create_region_and_connect(world, "Your Contract has Expired", "Subcon Forest - Finale", subcon_forest)
 
     # ------------------------------------------- ALPINE SKYLINE ------------------------------------------ #
     alpine_skyline = create_region_and_connect(world, "Alpine Skyline",  "Telescope -> Alpine Skyline", spaceship)
@@ -386,24 +386,11 @@ def create_regions(world: "HatInTimeWorld"):
     create_rift_connections(world, create_region(world, "Time Rift - Bazaar"))
 
     sf_area: Region = create_region(world, "Subcon Forest Area")
-    sf_behind_boss_firewall: Region = create_region(world, "Subcon Forest Behind Boss Firewall")
-    sf_boss_arena: Region = create_region(world, "Subcon Forest Boss Arena")
-    sf_area.connect(sf_behind_boss_firewall, "SF Area -> SF Behind Boss Firewall")
-    sf_behind_boss_firewall.connect(sf_boss_arena, "SF Behind Boss Firewall -> SF Boss Arena")
     sf_act1.connect(sf_area, "Subcon Forest Entrance CO")
     sf_act2.connect(sf_area, "Subcon Forest Entrance SW")
     sf_act3.connect(sf_area, "Subcon Forest Entrance TOD")
     sf_act4.connect(sf_area, "Subcon Forest Entrance QVM")
     sf_act5.connect(sf_area, "Subcon Forest Entrance MDS")
-    # YCHE puts the player directly in the boss arena, with no access to the rest of Subcon Forest by default.
-    sf_finale.connect(sf_boss_arena, "Subcon Forest Entrance YCHE")
-    # To support the Snatcher Hover expert logic for Act Completion (Your Contract has Expired), the act completion has
-    # to go in a separate region because the Snatcher Hover gives direct access to the Act Completion, but does not
-    # give access to the act itself.
-    sf_finale_post_fight: Region = create_region(world, "Your Contract has Expired - Post Fight")
-    # This connection must never have any rules placed on it because they will not be inherited when setting up act
-    # connections, only the rules for the entrances to the act and the rules for the Act Completion are inherited.
-    sf_finale.connect(sf_finale_post_fight, "YCHE -> YCHE - Post Fight")
 
     create_rift_connections(world, create_region(world, "Time Rift - Sleepy Subcon"))
     create_rift_connections(world, create_region(world, "Time Rift - Pipe"))
@@ -960,16 +947,6 @@ def get_shuffled_region(world: "HatInTimeWorld", region: str) -> str:
                     return name
 
 
-def get_region_shuffled_to(world: "HatInTimeWorld", region: str) -> str:
-    if world.options.ActRandomizer:
-        original_ci: str = chapter_act_info[region]
-        shuffled_ci = world.act_connections[original_ci]
-        return next(act_name for act_name, ci in chapter_act_info.items()
-                    if ci == shuffled_ci)
-    else:
-        return region
-
-
 def get_region_location_count(world: "HatInTimeWorld", region_name: str, included_only: bool = True) -> int:
     count = 0
     region = world.multiworld.get_region(region_name, world.player)

worlds/ahit/Rules.py

@@ -481,8 +481,9 @@ def set_hard_rules(world: "HatInTimeWorld"):
     set_rule(world.multiworld.get_location("Subcon Forest - Dweller Platforming Tree B", world.player),
              lambda state: has_paintings(state, world, 3))
 
-    # Cherry bridge over boss arena gap
+    # Cherry bridge over boss arena gap (painting still expected)
-    set_rule(world.get_entrance("SF Behind Boss Firewall -> SF Boss Arena"), lambda state: True)
+    set_rule(world.multiworld.get_location("Subcon Forest - Boss Arena Chest", world.player),
+             lambda state: has_paintings(state, world, 1, False) or state.has("YCHE Access", world.player))
 
     set_rule(world.multiworld.get_location("Subcon Forest - Noose Treehouse", world.player),
              lambda state: has_paintings(state, world, 2, True))
@@ -565,61 +566,27 @@ def set_expert_rules(world: "HatInTimeWorld"):
              lambda state: True)
 
     # Expert: Cherry Hovering
-    # Skipping the boss firewall is possible with a Cherry Hover.
+    subcon_area = world.multiworld.get_region("Subcon Forest Area", world.player)
-    set_rule(world.get_entrance("SF Area -> SF Behind Boss Firewall"),
+    yche = world.multiworld.get_region("Your Contract has Expired", world.player)
-             lambda state: has_paintings(state, world, 1, True))
+    entrance = yche.connect(subcon_area, "Subcon Forest Entrance YCHE")
-    # The boss arena gap can be crossed in reverse with a Cherry Hover.
-    subcon_boss_arena = world.get_region("Subcon Forest Boss Arena")
-    subcon_behind_boss_firewall = world.get_region("Subcon Forest Behind Boss Firewall")
-    subcon_boss_arena.connect(subcon_behind_boss_firewall, "SF Boss Arena -> SF Behind Boss Firewall")
 
-    subcon_area = world.get_region("Subcon Forest Area")
+    if world.options.NoPaintingSkips:
-
+        add_rule(entrance, lambda state: has_paintings(state, world, 1))
-    # The boss firewall can be skipped in reverse with a Cherry Hover, but it is not possible to remove the boss
-    # firewall from reverse because the paintings to burn to remove the firewall are on the other side of the firewall.
-    # Therefore, a painting skip is required. The paintings could be burned by already having access to
-    # "Subcon Forest Area" through another entrance, but making a new connection to "Subcon Forest Area" in that case
-    # would be pointless.
-    if not world.options.NoPaintingSkips:
-        # The import cannot be done at the module-level because it would cause a circular import.
-        from .Regions import get_region_shuffled_to
-
-        subcon_behind_boss_firewall.connect(subcon_area, "SF Behind Boss Firewall -> SF Area")
-
-        # Because the Your Contract has Expired entrance can now reach "Subcon Forest Area", it needs to be connected to
-        # each of the Subcon Forest Time Rift entrances, like the other Subcon Forest Acts.
-        yche = world.get_region("Your Contract has Expired")
-
-        def connect_to_shuffled_act_at(original_act_name):
-            region_name = get_region_shuffled_to(world, original_act_name)
-            return yche.connect(world.get_region(region_name), f"{original_act_name} Portal - Entrance YCHE")
-
-        # Rules copied from `Rules.set_rift_rules()` with painting logic removed because painting skips must be
-        # available.
-        entrance = connect_to_shuffled_act_at("Time Rift - Pipe")
-        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Subcon Forest - Act 2"))
-        reg_act_connection(world, world.get_entrance("Subcon Forest - Act 2").connected_region, entrance)
-
-        entrance = connect_to_shuffled_act_at("Time Rift - Village")
-        add_rule(entrance, lambda state: can_clear_required_act(state, world, "Subcon Forest - Act 4"))
-        reg_act_connection(world, world.get_entrance("Subcon Forest - Act 4").connected_region, entrance)
-
-        entrance = connect_to_shuffled_act_at("Time Rift - Sleepy Subcon")
-        add_rule(entrance, lambda state: has_relic_combo(state, world, "UFO"))
 
     set_rule(world.multiworld.get_location("Act Completion (Toilet of Doom)", world.player),
              lambda state: can_use_hookshot(state, world) and can_hit(state, world)
              and has_paintings(state, world, 1, True))
 
     # Set painting rules only. Skipping paintings is determined in has_paintings
+    set_rule(world.multiworld.get_location("Subcon Forest - Boss Arena Chest", world.player),
+             lambda state: has_paintings(state, world, 1, True))
     set_rule(world.multiworld.get_location("Subcon Forest - Magnet Badge Bush", world.player),
              lambda state: has_paintings(state, world, 3, True))
 
     # You can cherry hover to Snatcher's post-fight cutscene, which completes the level without having to fight him
-    yche_post_fight = world.get_region("Your Contract has Expired - Post Fight")
+    subcon_area.connect(yche, "Snatcher Hover")
-    subcon_area.connect(yche_post_fight, "Snatcher Hover")
+    set_rule(world.multiworld.get_location("Act Completion (Your Contract has Expired)", world.player),
-    # Cherry Hover from YCHE also works, so there are no requirements for the Act Completion.
+             lambda state: True)
-    set_rule(world.get_location("Act Completion (Your Contract has Expired)"), lambda state: True)
 
     if world.is_dlc2():
         # Expert: clear Rush Hour with nothing
@@ -714,18 +681,12 @@ def set_subcon_rules(world: "HatInTimeWorld"):
              lambda state: can_use_hat(state, world, HatType.BREWING) or state.has("Umbrella", world.player)
              or can_use_hat(state, world, HatType.DWELLER))
 
-    # You can't skip over the boss arena wall without cherry hover.
+    # You can't skip over the boss arena wall without cherry hover, so these two need to be set this way
-    set_rule(world.get_entrance("SF Area -> SF Behind Boss Firewall"),
+    set_rule(world.multiworld.get_location("Subcon Forest - Boss Arena Chest", world.player),
-             lambda state: has_paintings(state, world, 1, False))
+             lambda state: state.has("TOD Access", world.player) and can_use_hookshot(state, world)
+             and has_paintings(state, world, 1, False) or state.has("YCHE Access", world.player))
 
-    # The hookpoints to cross the boss arena gap are only present in Toilet of Doom.
+    # The painting wall can't be skipped without cherry hover, which is Expert
-    set_rule(world.get_entrance("SF Behind Boss Firewall -> SF Boss Arena"),
-             lambda state: state.has("TOD Access", world.player)
-             and can_use_hookshot(state, world))
-
-    # The Act Completion is in the Toilet of Doom region, so the same rules as passing the boss firewall and crossing
-    # the boss arena gap are required. "TOD Access" is implied from the region so does not need to be included in the
-    # rule.
     set_rule(world.multiworld.get_location("Act Completion (Toilet of Doom)", world.player),
              lambda state: can_use_hookshot(state, world) and can_hit(state, world)
              and has_paintings(state, world, 1, False))

worlds/ahit/__init__.py

@@ -1,6 +1,6 @@
 from BaseClasses import Item, ItemClassification, Tutorial, Location, MultiWorld
 from .Items import item_table, create_item, relic_groups, act_contracts, create_itempool, get_shop_trap_name, \
-    calculate_yarn_costs, alps_hooks, junk_weights
+    calculate_yarn_costs, alps_hooks
 from .Regions import create_regions, randomize_act_entrances, chapter_act_info, create_events, get_shuffled_region
 from .Locations import location_table, contract_locations, is_location_valid, get_location_names, TASKSANITY_START_ID, \
     get_total_locations
@@ -78,9 +78,6 @@ class HatInTimeWorld(World):
         self.nyakuza_thug_items: Dict[str, int] = {}
         self.badge_seller_count: int = 0
 
-    def get_filler_item_name(self) -> str:
-        return self.random.choices(list(junk_weights.keys()), weights=junk_weights.values(), k=1)[0]
-
     def generate_early(self):
         adjust_options(self)