Merge branch 'main' into multiserver_discord_webhook

.github/labeler.yml

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

.github/workflows/build.yml

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

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

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

.gitignore

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

AdventureClient.py

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

BaseClasses.py

@@ -439,7 +439,7 @@ class MultiWorld():
         return self.regions.location_cache[player][location_name]
 
     def get_all_state(self, use_cache: bool, allow_partial_entrances: bool = False,
-                      collect_pre_fill_items: bool = True, perform_sweep: bool = True) -> CollectionState:
+                      collect_pre_fill_items: bool = True) -> CollectionState:
         cached = getattr(self, "_all_state", None)
         if use_cache and cached:
             return cached.copy()
@@ -453,8 +453,7 @@ class MultiWorld():
                 subworld = self.worlds[player]
                 for item in subworld.get_pre_fill_items():
                     subworld.collect(ret, item)
-        if perform_sweep:
-            ret.sweep_for_advancements()
+        ret.sweep_for_advancements()
 
         if use_cache:
             self._all_state = ret
@@ -559,9 +558,7 @@ class MultiWorld():
         else:
             return all((self.has_beaten_game(state, p) for p in range(1, self.players + 1)))
 
-    def can_beat_game(self,
-                      starting_state: Optional[CollectionState] = None,
-                      locations: Optional[Iterable[Location]] = None) -> bool:
+    def can_beat_game(self, starting_state: Optional[CollectionState] = None) -> bool:
         if starting_state:
             if self.has_beaten_game(starting_state):
                 return True
@@ -570,9 +567,7 @@ class MultiWorld():
             state = CollectionState(self)
             if self.has_beaten_game(state):
                 return True
-
-        base_locations = self.get_locations() if locations is None else locations
-        prog_locations = {location for location in base_locations if location.item
+        prog_locations = {location for location in self.get_locations() if location.item
                           and location.item.advancement and location not in state.locations_checked}
 
         while prog_locations:
@@ -741,7 +736,6 @@ class CollectionState():
     additional_copy_functions: List[Callable[[CollectionState, CollectionState], CollectionState]] = []
 
     def __init__(self, parent: MultiWorld, allow_partial_entrances: bool = False):
-        assert parent.worlds, "CollectionState created without worlds initialized in parent"
         self.prog_items = {player: Counter() for player in parent.get_all_ids()}
         self.multiworld = parent
         self.reachable_regions = {player: set() for player in parent.get_all_ids()}
@@ -1018,17 +1012,6 @@ class CollectionState():
 
         return changed
 
-    def add_item(self, item: str, player: int, count: int = 1) -> None:
-        """
-        Adds the item to state.
-
-        :param item: The item to be added.
-        :param player: The player the item is for.
-        :param count: How many of the item to add.
-        """
-        assert count > 0
-        self.prog_items[player][item] += count
-
     def remove(self, item: Item):
         changed = self.multiworld.worlds[item.player].remove(self, item)
         if changed:
@@ -1037,33 +1020,6 @@ class CollectionState():
             self.blocked_connections[item.player] = set()
             self.stale[item.player] = True
 
-    def remove_item(self, item: str, player: int, count: int = 1) -> None:
-        """
-        Removes the item from state.
-
-        :param item: The item to be removed.
-        :param player: The player the item is for.
-        :param count: How many of the item to remove.
-        """
-        assert count > 0
-        self.prog_items[player][item] -= count
-        if self.prog_items[player][item] < 1:
-            del (self.prog_items[player][item])
-
-    def set_item(self, item: str, player: int, count: int) -> None:
-        """
-        Sets the item in state equal to the provided count.
-
-        :param item: The item to modify.
-        :param player: The player the item is for.
-        :param count: How many of the item to now have.
-        """
-        assert count >= 0
-        if count == 0:
-            del (self.prog_items[player][item])
-        else:
-            self.prog_items[player][item] = count
-
 
 class EntranceType(IntEnum):
     ONE_WAY = 1
@@ -1337,8 +1293,8 @@ class Region:
         Connects current region to regions in exit dictionary. Passed region names must exist first.
 
         :param exits: exits from the region. format is {"connecting_region": "exit_name"}. if a non dict is provided,
-                      created entrances will be named "self.name -> connecting_region"
-        :param rules: rules for the exits from this region. format is {"connecting_region": rule}
+        created entrances will be named "self.name -> connecting_region"
+        :param rules: rules for the exits from this region. format is {"connecting_region", rule}
         """
         if not isinstance(exits, Dict):
             exits = dict.fromkeys(exits)
@@ -1607,19 +1563,21 @@ class Spoiler:
 
         # in the second phase, we cull each sphere such that the game is still beatable,
         # reducing each range of influence to the bare minimum required inside it
-        required_locations = {location for sphere in collection_spheres for location in sphere}
+        restore_later: Dict[Location, Item] = {}
         for num, sphere in reversed(tuple(enumerate(collection_spheres))):
             to_delete: Set[Location] = set()
             for location in sphere:
-                # we remove the location from required_locations to sweep from, and check if the game is still beatable
+                # we remove the item at location and check if game is still beatable
                 logging.debug('Checking if %s (Player %d) is required to beat the game.', location.item.name,
                               location.item.player)
-                required_locations.remove(location)
-                if multiworld.can_beat_game(state_cache[num], required_locations):
+                old_item = location.item
+                location.item = None
+                if multiworld.can_beat_game(state_cache[num]):
                     to_delete.add(location)
+                    restore_later[location] = old_item
                 else:
                     # still required, got to keep it around
-                    required_locations.add(location)
+                    location.item = old_item
 
             # cull entries in spheres for spoiler walkthrough at end
             sphere -= to_delete
@@ -1636,7 +1594,7 @@ class Spoiler:
                 logging.debug('Checking if %s (Player %d) is required to beat the game.', item.name, item.player)
                 precollected_items.remove(item)
                 multiworld.state.remove(item)
-                if not multiworld.can_beat_game(multiworld.state, required_locations):
+                if not multiworld.can_beat_game():
                     # Add the item back into `precollected_items` and collect it into `multiworld.state`.
                     multiworld.push_precollected(item)
                 else:
@@ -1678,6 +1636,9 @@ class Spoiler:
             self.create_paths(state, collection_spheres)
 
         # repair the multiworld again
+        for location, item in restore_later.items():
+            location.item = item
+
         for item in removed_precollected:
             multiworld.push_precollected(item)
 

CommonClient.py

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

FF1Client.py

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

Fill.py

@@ -138,21 +138,32 @@ def fill_restrictive(multiworld: MultiWorld, base_state: CollectionState, locati
                         # to clean that up later, so there is a chance generation fails.
                         if (not single_player_placement or location.player == item_to_place.player) \
                                 and location.can_fill(swap_state, item_to_place, perform_access_check):
-                            # Add this item to the existing placement, and
-                            # add the old item to the back of the queue
-                            spot_to_fill = placements.pop(i)
 
-                            swap_count += 1
-                            swapped_items[placed_item.player, placed_item.name, unsafe] = swap_count
+                            # Verify placing this item won't reduce available locations, which would be a useless swap.
+                            prev_state = swap_state.copy()
+                            prev_loc_count = len(
+                                multiworld.get_reachable_locations(prev_state))
 
-                            reachable_items[placed_item.player].appendleft(
-                                placed_item)
-                            item_pool.append(placed_item)
+                            swap_state.collect(item_to_place, True)
+                            new_loc_count = len(
+                                multiworld.get_reachable_locations(swap_state))
 
-                            # cleanup at the end to hopefully get better errors
-                            cleanup_required = True
+                            if new_loc_count >= prev_loc_count:
+                                # Add this item to the existing placement, and
+                                # add the old item to the back of the queue
+                                spot_to_fill = placements.pop(i)
 
-                            break
+                                swap_count += 1
+                                swapped_items[placed_item.player, placed_item.name, unsafe] = swap_count
+
+                                reachable_items[placed_item.player].appendleft(
+                                    placed_item)
+                                item_pool.append(placed_item)
+
+                                # cleanup at the end to hopefully get better errors
+                                cleanup_required = True
+
+                                break
 
                         # Item can't be placed here, restore original item
                         location.item = placed_item
@@ -890,7 +901,7 @@ def parse_planned_blocks(multiworld: MultiWorld) -> dict[int, list[PlandoItemBlo
                 worlds = set()
                 for listed_world in target_world:
                     if listed_world not in world_name_lookup:
-                        failed(f"Cannot place item to {listed_world}'s world as that world does not exist.",
+                        failed(f"Cannot place item to {target_world}'s world as that world does not exist.",
                                block.force)
                         continue
                     worlds.add(world_name_lookup[listed_world])
@@ -923,9 +934,9 @@ def parse_planned_blocks(multiworld: MultiWorld) -> dict[int, list[PlandoItemBlo
             if isinstance(locations, str):
                 locations = [locations]
 
+            locations_from_groups: list[str] = []
             resolved_locations: list[Location] = []
             for target_player in worlds:
-                locations_from_groups: list[str] = []
                 world_locations = multiworld.get_unfilled_locations(target_player)
                 for group in multiworld.worlds[target_player].location_name_groups:
                     if group in locations:
@@ -937,16 +948,13 @@ def parse_planned_blocks(multiworld: MultiWorld) -> dict[int, list[PlandoItemBlo
 
             count = block.count
             if not count:
-                count = (min(len(new_block.items), len(new_block.resolved_locations))
-                         if new_block.resolved_locations else len(new_block.items))
+                count = len(new_block.items)
             if isinstance(count, int):
                 count = {"min": count, "max": count}
             if "min" not in count:
                 count["min"] = 0
             if "max" not in count:
-                count["max"] = (min(len(new_block.items), len(new_block.resolved_locations))
-                                if new_block.resolved_locations else len(new_block.items))
-
+                count["max"] = len(new_block.items)
 
             new_block.count = count
             plando_blocks[player].append(new_block)

Generate.py

@@ -224,14 +224,10 @@ def main(args=None) -> tuple[argparse.Namespace, int]:
                             except Exception as e:
                                 raise Exception(f"Error setting {k} to {v} for player {player}") from e
 
-                    # name was not specified
-                    if player not in erargs.name:
-                        if path == args.weights_file_path:
-                            # weights file, so we need to make the name unique
-                            erargs.name[player] = f"Player{player}"
-                        else:
-                            # use the filename
-                            erargs.name[player] = os.path.splitext(os.path.split(path)[-1])[0]
+                    if path == args.weights_file_path:  # if name came from the weights file, just use base player name
+                        erargs.name[player] = f"Player{player}"
+                    elif player not in erargs.name:  # if name was not specified, generate it from filename
+                        erargs.name[player] = os.path.splitext(os.path.split(path)[-1])[0]
                     erargs.name[player] = handle_name(erargs.name[player], player, name_counter)
 
                     player += 1

Launcher.py

@@ -11,7 +11,6 @@ Additional components can be added to worlds.LauncherComponents.components.
 import argparse
 import logging
 import multiprocessing
-import os
 import shlex
 import subprocess
 import sys
@@ -42,17 +41,13 @@ def open_host_yaml():
     if is_linux:
         exe = which('sensible-editor') or which('gedit') or \
               which('xdg-open') or which('gnome-open') or which('kde-open')
+        subprocess.Popen([exe, file])
     elif is_macos:
         exe = which("open")
+        subprocess.Popen([exe, file])
     else:
         webbrowser.open(file)
-        return
 
-    env = os.environ
-    if "LD_LIBRARY_PATH" in env:
-        env = env.copy()
-        del env["LD_LIBRARY_PATH"]  # exe is a system binary, so reset LD_LIBRARY_PATH
-    subprocess.Popen([exe, file], env=env)
 
 def open_patch():
     suffixes = []
@@ -97,11 +92,7 @@ def open_folder(folder_path):
         return
 
     if exe:
-        env = os.environ
-        if "LD_LIBRARY_PATH" in env:
-            env = env.copy()
-            del env["LD_LIBRARY_PATH"]  # exe is a system binary, so reset LD_LIBRARY_PATH
-        subprocess.Popen([exe, folder_path], env=env)
+        subprocess.Popen([exe, folder_path])
     else:
         logging.warning(f"No file browser available to open {folder_path}")
 
@@ -113,48 +104,63 @@ def update_settings():
 
 components.extend([
     # Functions
-    Component("Open host.yaml", func=open_host_yaml,
-              description="Open the host.yaml file to change settings for generation, games, and more."),
-    Component("Open Patch", func=open_patch,
-              description="Open a patch file, downloaded from the room page or provided by the host."),
-    Component("Generate Template Options", func=generate_yamls,
-              description="Generate template YAMLs for currently installed games."),
-    Component("Archipelago Website", func=lambda: webbrowser.open("https://archipelago.gg/"),
-              description="Open archipelago.gg in your browser."),
-    Component("Discord Server", icon="discord", func=lambda: webbrowser.open("https://discord.gg/8Z65BR2"),
-              description="Join the Discord server to play public multiworlds, report issues, or just chat!"),
+    Component("Open host.yaml", func=open_host_yaml),
+    Component("Open Patch", func=open_patch),
+    Component("Generate Template Options", func=generate_yamls),
+    Component("Archipelago Website", func=lambda: webbrowser.open("https://archipelago.gg/")),
+    Component("Discord Server", icon="discord", func=lambda: webbrowser.open("https://discord.gg/8Z65BR2")),
     Component("Unrated/18+ Discord Server", icon="discord",
-              func=lambda: webbrowser.open("https://discord.gg/fqvNCCRsu4"),
-              description="Find unrated and 18+ games in the After Dark Discord server."),
-    Component("Browse Files", func=browse_files,
-              description="Open the Archipelago installation folder in your file browser."),
+              func=lambda: webbrowser.open("https://discord.gg/fqvNCCRsu4")),
+    Component("Browse Files", func=browse_files),
 ])
 
 
-def handle_uri(path: str) -> tuple[list[Component], Component]:
+def handle_uri(path: str, launch_args: tuple[str, ...]) -> None:
     url = urllib.parse.urlparse(path)
     queries = urllib.parse.parse_qs(url.query)
-    client_components = []
+    launch_args = (path, *launch_args)
+    client_component = []
     text_client_component = None
-    game = queries["game"][0]
+    if "game" in queries:
+        game = queries["game"][0]
+    else:  # TODO around 0.6.0 - this is for pre this change webhost uri's
+        game = "Archipelago"
     for component in components:
         if component.supports_uri and component.game_name == game:
-            client_components.append(component)
+            client_component.append(component)
         elif component.display_name == "Text Client":
             text_client_component = component
-    return client_components, text_client_component
 
+    from kvui import MDButton, MDButtonText
+    from kivymd.uix.dialog import MDDialog, MDDialogHeadlineText, MDDialogContentContainer, MDDialogSupportingText
+    from kivymd.uix.divider import MDDivider
 
-def build_uri_popup(component_list: list[Component], launch_args: tuple[str, ...]) -> None:
-    from kvui import ButtonsPrompt
-    component_options = {
-        component.display_name: component for component in component_list
-    }
-    popup = ButtonsPrompt("Connect to Multiworld",
-                          "Select client to open and connect with.",
-                          lambda component_name: run_component(component_options[component_name], *launch_args),
-                          *component_options.keys())
-    popup.open()
+    if not client_component:
+        run_component(text_client_component, *launch_args)
+        return
+    else:
+        popup_text = MDDialogSupportingText(text="Select client to open and connect with.")
+        component_buttons = [MDDivider()]
+        for component in [text_client_component, *client_component]:
+            component_buttons.append(MDButton(
+                MDButtonText(text=component.display_name),
+                on_release=lambda *args, comp=component: run_component(comp, *launch_args),
+                style="text"
+            ))
+        component_buttons.append(MDDivider())
+
+    MDDialog(
+        # Headline
+        MDDialogHeadlineText(text="Connect to Multiworld"),
+        # Text
+        popup_text,
+        # Content
+        MDDialogContentContainer(
+            *component_buttons,
+            orientation="vertical"
+        ),
+
+    ).open()
 
 
 def identify(path: None | str) -> tuple[None | str, None | Component]:
@@ -196,8 +202,7 @@ def get_exe(component: str | Component) -> Sequence[str] | None:
 def launch(exe, in_terminal=False):
     if in_terminal:
         if is_windows:
-            # intentionally using a window title with a space so it gets quoted and treated as a title
-            subprocess.Popen(["start", "Running Archipelago", *exe], shell=True)
+            subprocess.Popen(['start', *exe], shell=True)
             return
         elif is_linux:
             terminal = which('x-terminal-emulator') or which('gnome-terminal') or which('xterm')
@@ -225,7 +230,7 @@ def create_shortcut(button: Any, component: Component) -> None:
 refresh_components: Callable[[], None] | None = None
 
 
-def run_gui(launch_components: list[Component], args: Any) -> None:
+def run_gui(path: str, args: Any) -> None:
     from kvui import (ThemedApp, MDFloatLayout, MDGridLayout, ScrollBox)
     from kivy.properties import ObjectProperty
     from kivy.core.window import Window
@@ -258,12 +263,12 @@ def run_gui(launch_components: list[Component], args: Any) -> None:
         cards: list[LauncherCard]
         current_filter: Sequence[str | Type] | None
 
-        def __init__(self, ctx=None, components=None, args=None):
+        def __init__(self, ctx=None, path=None, args=None):
             self.title = self.base_title + " " + Utils.__version__
             self.ctx = ctx
             self.icon = r"data/icon.png"
             self.favorites = []
-            self.launch_components = components
+            self.launch_uri = path
             self.launch_args = args
             self.cards = []
             self.current_filter = (Type.CLIENT, Type.TOOL, Type.ADJUSTER, Type.MISC)
@@ -385,9 +390,9 @@ def run_gui(launch_components: list[Component], args: Any) -> None:
             return self.top_screen
 
         def on_start(self):
-            if self.launch_components:
-                build_uri_popup(self.launch_components, self.launch_args)
-                self.launch_components = None
+            if self.launch_uri:
+                handle_uri(self.launch_uri, self.launch_args)
+                self.launch_uri = None
                 self.launch_args = None
 
         @staticmethod
@@ -405,7 +410,7 @@ def run_gui(launch_components: list[Component], args: Any) -> None:
             if file and component:
                 run_component(component, file)
             else:
-                logging.warning(f"unable to identify component for {filename}")
+                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.
@@ -428,7 +433,7 @@ def run_gui(launch_components: list[Component], args: Any) -> None:
                                                                    for filter in self.current_filter))
             super().on_stop()
 
-    Launcher(components=launch_components, args=args).run()
+    Launcher(path=path, args=args).run()
 
     # avoiding Launcher reference leak
     # and don't try to do something with widgets after window closed
@@ -455,15 +460,7 @@ def main(args: argparse.Namespace | dict | None = None):
 
     path = args.get("Patch|Game|Component|url", None)
     if path is not None:
-        if path.startswith("archipelago://"):
-            args["args"] = (path, *args.get("args", ()))
-            # add the url arg to the passthrough args
-            components, text_client_component = handle_uri(path)
-            if not components:
-                args["component"] = text_client_component
-            else:
-                args['launch_components'] = [text_client_component, *components]
-        else:
+        if not path.startswith("archipelago://"):
             file, component = identify(path)
             if file:
                 args['file'] = file
@@ -479,7 +476,7 @@ def main(args: argparse.Namespace | dict | None = None):
     elif "component" in args:
         run_component(args["component"], *args["args"])
     elif not args["update_settings"]:
-        run_gui(args.get("launch_components", None), args.get("args", ()))
+        run_gui(path, args.get("args", ()))
 
 
 if __name__ == '__main__':

MMBN3Client.py

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

Main.py

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

MinecraftClient.py

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

MultiServer.py

@@ -458,12 +458,8 @@ class Context:
         self.generator_version = Version(*decoded_obj["version"])
         clients_ver = decoded_obj["minimum_versions"].get("clients", {})
         self.minimum_client_versions = {}
-        if self.generator_version < Version(0, 6, 2):
-            min_version = Version(0, 1, 6)
-        else:
-            min_version = min_client_version
         for player, version in clients_ver.items():
-            self.minimum_client_versions[player] = max(Version(*version), min_version)
+            self.minimum_client_versions[player] = max(Version(*version), min_client_version)
 
         self.slot_info = decoded_obj["slot_info"]
         self.games = {slot: slot_info.game for slot, slot_info in self.slot_info.items()}
@@ -2372,7 +2368,6 @@ class ServerCommandProcessor(CommonCommandProcessor):
             known_options = (f"{option}: {option_type}" for option, option_type in self.ctx.simple_options.items())
             self.output(f"Unrecognized option '{option_name}', known: {', '.join(known_options)}")
             return False
-
         if value_type == bool:
             def value_type(input_text: str):
                 return input_text.lower() not in {"off", "0", "false", "none", "null", "no"}
@@ -2406,6 +2401,75 @@ class ServerCommandProcessor(CommonCommandProcessor):
                         f"approximately totaling {Utils.format_SI_prefix(total, power=1024)}B")
         self.output("\n".join(texts))
 
+    def _cmd_discord_webhook(self, webhook_url: str):
+        """Needs to be supplied with a Discord WebHook url as parameter,
+        which will then relay the server log to a discord channel."""
+
+        import discord_webhook
+        initial_response = discord_webhook.DiscordWebhook(webhook_url, wait=True,
+                                                          content="Beginning Discord Logging").execute()
+        if initial_response.ok:
+            import queue
+            response_queue = queue.SimpleQueue()
+
+            class Emitter(threading.Thread):
+                def run(self):
+                    record: typing.Optional[logging.LogRecord] = None
+                    while True:
+                        time.sleep(1)
+                        # check for leftover record from last iteration
+                        message = record.msg if record else ""
+                        while 1:
+                            try:
+                                record = response_queue.get_nowait()
+                            except queue.Empty:
+                                break
+                            else:
+                                if record is None:
+                                    return  # shutdown
+                                if len(record.msg) > 1999:
+                                    continue  # content size limit
+                                if len(message) + len(record.msg) > 2000:
+                                    break  # reached content size limit in total
+                                else:
+                                    message += "\n" + record.msg
+                                    record = None
+                        if message:
+                            try:
+                                response = discord_webhook.DiscordWebhook(
+                                    webhook_url, rate_limit_retry=True, content=message.strip()).execute()
+                                if response.status_code not in (200, 204):
+                                    shutdown()
+                                    logging.info(f"Disabled Discord WebHook due to error code {response.status_code}.")
+                                    return
+                            # just in case to prevent an error-loop logging itself
+                            except Exception as e:
+                                shutdown()
+                                logging.error("Disabled Discord WebHook due to error.")
+                                logging.exception(e)
+                                return
+
+            emitter = Emitter()
+            emitter.daemon = True
+            emitter.start()
+
+            class DiscordLogger(logging.Handler):
+                """Logs to Discord WebHook"""
+                def emit(self, record: logging.LogRecord):
+                    response_queue.put(record)
+
+            handler = DiscordLogger()
+
+            def shutdown():
+                response_queue.put(None)
+                logging.getLogger().removeHandler(handler)
+
+            logging.getLogger().addHandler(handler)
+            self.output("Discord Link established.")
+
+        else:
+            self.output("Discord Link could not be established. Check your webhook url.")
+
 
 async def console(ctx: Context):
     import sys

NetUtils.py

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

OoTClient.py

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

Options.py

@@ -1524,11 +1524,9 @@ class PlandoItems(Option[typing.List[PlandoItem]]):
                                           f"dictionary, not {type(items)}")
                     locations = item.get("locations", [])
                     if not locations:
-                        locations = item.get("location", [])
+                        locations = item.get("location", ["Everywhere"])
                         if locations:
                             count = 1
-                        else:
-                            locations = ["Everywhere"]
                         if isinstance(locations, str):
                             locations = [locations]
                         if not isinstance(locations, list):
@@ -1678,7 +1676,6 @@ def get_option_groups(world: typing.Type[World], visibility_level: Visibility =
 
 def generate_yaml_templates(target_folder: typing.Union[str, "pathlib.Path"], generate_hidden: bool = True) -> None:
     import os
-    from inspect import cleandoc
 
     import yaml
     from jinja2 import Template
@@ -1717,21 +1714,19 @@ def generate_yaml_templates(target_folder: typing.Union[str, "pathlib.Path"], ge
         # yaml dump may add end of document marker and newlines.
         return yaml.dump(scalar).replace("...\n", "").strip()
 
-    with open(local_path("data", "options.yaml")) as f:
-        file_data = f.read()
-    template = Template(file_data)
-
     for game_name, world in AutoWorldRegister.world_types.items():
         if not world.hidden or generate_hidden:
             option_groups = get_option_groups(world)
-
-            res = template.render(
+            with open(local_path("data", "options.yaml")) as f:
+                file_data = f.read()
+            res = Template(file_data).render(
                 option_groups=option_groups,
                 __version__=__version__, game=game_name, yaml_dump=yaml_dump_scalar,
                 dictify_range=dictify_range,
-                cleandoc=cleandoc,
             )
 
+            del file_data
+
             with open(os.path.join(target_folder, get_file_safe_name(game_name) + ".yaml"), "w", encoding="utf-8-sig") as f:
                 f.write(res)
 

README.md

@@ -7,6 +7,7 @@ Currently, the following games are supported:
 
 * The Legend of Zelda: A Link to the Past
 * Factorio
+* Minecraft
 * Subnautica
 * Risk of Rain 2
 * The Legend of Zelda: Ocarina of Time
@@ -14,6 +15,7 @@ Currently, the following games are supported:
 * Super Metroid
 * Secret of Evermore
 * Final Fantasy
+* Rogue Legacy
 * VVVVVV
 * Raft
 * Super Mario 64
@@ -40,6 +42,7 @@ Currently, the following games are supported:
 * The Messenger
 * Kingdom Hearts 2
 * The Legend of Zelda: Link's Awakening DX
+* Clique
 * Adventure
 * DLC Quest
 * Noita
@@ -77,9 +80,6 @@ Currently, the following games are supported:
 * Inscryption
 * Civilization VI
 * The Legend of Zelda: The Wind Waker
-* Jak and Daxter: The Precursor Legacy
-* Super Mario Land 2: 6 Golden Coins
-* shapez
 
 For setup and instructions check out our [tutorials page](https://archipelago.gg/tutorial/).
 Downloads can be found at [Releases](https://github.com/ArchipelagoMW/Archipelago/releases), including compiled

Utils.py

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

WargrooveClient.py

@@ -2,15 +2,14 @@ from __future__ import annotations
 
 import atexit
 import os
-import pkgutil
 import sys
 import asyncio
 import random
-import typing
+import shutil
 from typing import Tuple, List, Iterable, Dict
 
-from . import WargrooveWorld
-from .Items import item_table, faction_table, CommanderData, ItemData
+from worlds.wargroove import WargrooveWorld
+from worlds.wargroove.Items import item_table, faction_table, CommanderData, ItemData
 
 import ModuleUpdate
 ModuleUpdate.update()
@@ -22,7 +21,7 @@ import logging
 if __name__ == "__main__":
     Utils.init_logging("WargrooveClient", exception_logger="Client")
 
-from NetUtils import ClientStatus
+from NetUtils import NetworkItem, ClientStatus
 from CommonClient import gui_enabled, logger, get_base_parser, ClientCommandProcessor, \
     CommonContext, server_loop
 
@@ -30,34 +29,6 @@ wg_logger = logging.getLogger("WG")
 
 
 class WargrooveClientCommandProcessor(ClientCommandProcessor):
-    def _cmd_sacrifice_summon(self):
-        """Toggles sacrifices and summons On/Off"""
-        if isinstance(self.ctx, WargrooveContext):
-            self.ctx.has_sacrifice_summon = not self.ctx.has_sacrifice_summon
-            if self.ctx.has_sacrifice_summon:
-                self.output(f"Sacrifices and summons are enabled.")
-            else:
-                unit_summon_response_file = os.path.join(self.ctx.game_communication_path, "unitSummonResponse")
-                if os.path.exists(unit_summon_response_file):
-                    os.remove(unit_summon_response_file)
-                self.output(f"Sacrifices and summons are disabled.")
-
-    def _cmd_deathlink(self):
-        """Toggles deathlink On/Off"""
-        if isinstance(self.ctx, WargrooveContext):
-            self.ctx.has_death_link = not self.ctx.has_death_link
-            Utils.async_start(self.ctx.update_death_link(self.ctx.has_death_link), name="Update Deathlink")
-            if self.ctx.has_death_link:
-                death_link_send_file = os.path.join(self.ctx.game_communication_path, "deathLinkSend")
-                if os.path.exists(death_link_send_file):
-                    os.remove(death_link_send_file)
-                self.output(f"Deathlink enabled.")
-            else:
-                death_link_receive_file = os.path.join(self.ctx.game_communication_path, "deathLinkReceive")
-                if os.path.exists(death_link_receive_file):
-                    os.remove(death_link_receive_file)
-                self.output(f"Deathlink disabled.")
-
     def _cmd_resync(self):
         """Manually trigger a resync."""
         self.output(f"Syncing items.")
@@ -87,11 +58,6 @@ class WargrooveContext(CommonContext):
     commander_defense_boost_multiplier: int = 0
     income_boost_multiplier: int = 0
     starting_groove_multiplier: float
-    has_death_link: bool = False
-    has_sacrifice_summon: bool = True
-    player_stored_units_key: str = ""
-    ai_stored_units_key: str = ""
-    max_stored_units: int = 1000
     faction_item_ids = {
         'Starter': 0,
         'Cherrystone': 52025,
@@ -105,31 +71,6 @@ class WargrooveContext(CommonContext):
         'Income Boost': 52023,
         'Commander Defense Boost': 52024,
     }
-    unit_classes = {
-        "archer",
-        "ballista",
-        "balloon",
-        "dog",
-        "dragon",
-        "giant",
-        "harpoonship",
-        "harpy",
-        "knight",
-        "mage",
-        "merman",
-        "rifleman",
-        "soldier",
-        "spearman",
-        "thief",
-        "thief_with_gold",
-        "travelboat",
-        "trebuchet",
-        "turtle",
-        "villager",
-        "wagon",
-        "warship",
-        "witch",
-    }
 
     def __init__(self, server_address, password):
         super(WargrooveContext, self).__init__(server_address, password)
@@ -137,80 +78,31 @@ class WargrooveContext(CommonContext):
         self.syncing = False
         self.awaiting_bridge = False
         # self.game_communication_path: files go in this path to pass data between us and the actual game
-        game_options = WargrooveWorld.settings
-
-        # Validate the AppData directory with Wargroove save data.
-        # By default, Windows sets an environment variable we can leverage.
-        # However, other OSes don't usually have this value set, so we need to rely on a settings value instead.
-        appdata_wargroove = None
         if "appdata" in os.environ:
-            appdata_wargroove = os.environ['appdata']
-        else:
-            try:
-                appdata_wargroove = game_options.save_directory
-            except FileNotFoundError:
-                print_error_and_close("WargrooveClient couldn't detect a path to the AppData folder.\n"
-                                      "Unable to infer required game_communication_path.\n"
-                                      "Try setting the \"save_directory\" value in your local options file "
-                                      "to the AppData folder containing your Wargroove saves.")
-        appdata_wargroove = os.path.expandvars(os.path.join(appdata_wargroove, "Chucklefish", "Wargroove"))
-        if not os.path.isdir(appdata_wargroove):
-            print_error_and_close(f"WargrooveClient couldn't find Wargroove data in your AppData folder.\n"
-                                  f"Looked in \"{appdata_wargroove}\".\n"
-                                  f"If you haven't yet booted the game at least once, boot Wargroove "
-                                  f"and then close it to attempt to fix this error.\n"
-                                  f"If the AppData folder above seems wrong, try setting the "
-                                  f"\"save_directory\" value in your local options file "
-                                  f"to the AppData folder containing your Wargroove saves.")
-
-        # Check for the Wargroove game executable path.
-        # This should always be set regardless of the OS.
-        root_directory = game_options["root_directory"]
-        if not os.path.isfile(os.path.join(root_directory, "win64_bin", "wargroove64.exe")):
-            print_error_and_close(f"WargrooveClient couldn't find wargroove64.exe in "
-                                  f"\"{root_directory}/win64_bin/\".\n"
-                                  f"Unable to infer required game_communication_path.\n"
-                                  f"Please verify the \"root_directory\" value in your local "
-                                  f"options file is set correctly.")
-        self.game_communication_path = os.path.join(root_directory, "AP")
-        if not os.path.exists(self.game_communication_path):
-            os.makedirs(self.game_communication_path)
-        self.remove_communication_files()
-        atexit.register(self.remove_communication_files)
-        if not os.path.isdir(appdata_wargroove):
-            print_error_and_close("WargrooveClient couldn't find Wargoove in appdata!"
-                                  "Boot Wargroove and then close it to attempt to fix this error")
-        mods_directory = os.path.join(appdata_wargroove, "mods", "ArchipelagoMod")
-        save_directory = os.path.join(appdata_wargroove, "save")
-
-        # Wargroove doesn't always create the mods directory, so we have to do it
-        if not os.path.isdir(mods_directory):
-            os.makedirs(mods_directory)
-        resources = ["data/mods/ArchipelagoMod/maps.dat",
-                     "data/mods/ArchipelagoMod/mod.dat",
-                     "data/mods/ArchipelagoMod/modAssets.dat",
-                     "data/save/campaign-c40a6e5b0cdf86ddac03b276691c483d.cmp",
-                     "data/save/campaign-c40a6e5b0cdf86ddac03b276691c483d.cmp.bak"]
-        file_paths = [os.path.join(mods_directory, "maps.dat"),
-                      os.path.join(mods_directory, "mod.dat"),
-                      os.path.join(mods_directory, "modAssets.dat"),
-                      os.path.join(save_directory, "campaign-c40a6e5b0cdf86ddac03b276691c483d.cmp"),
-                      os.path.join(save_directory, "campaign-c40a6e5b0cdf86ddac03b276691c483d.cmp.bak")]
-        for resource, destination in zip(resources, file_paths):
-            file_data = pkgutil.get_data("worlds.wargroove", resource)
-            if file_data is None:
+            options = Utils.get_options()
+            root_directory = os.path.join(options["wargroove_options"]["root_directory"])
+            data_directory = os.path.join("lib", "worlds", "wargroove", "data")
+            dev_data_directory = os.path.join("worlds", "wargroove", "data")
+            appdata_wargroove = os.path.expandvars(os.path.join("%APPDATA%", "Chucklefish", "Wargroove"))
+            if not os.path.isfile(os.path.join(root_directory, "win64_bin", "wargroove64.exe")):
+                print_error_and_close("WargrooveClient couldn't find wargroove64.exe. "
+                                      "Unable to infer required game_communication_path")
+            self.game_communication_path = os.path.join(root_directory, "AP")
+            if not os.path.exists(self.game_communication_path):
+                os.makedirs(self.game_communication_path)
+            self.remove_communication_files()
+            atexit.register(self.remove_communication_files)
+            if not os.path.isdir(appdata_wargroove):
+                print_error_and_close("WargrooveClient couldn't find Wargoove in appdata!"
+                                      "Boot Wargroove and then close it to attempt to fix this error")
+            if not os.path.isdir(data_directory):
+                data_directory = dev_data_directory
+            if not os.path.isdir(data_directory):
                 print_error_and_close("WargrooveClient couldn't find Wargoove mod and save files in install!")
-            with open(destination, 'wb') as f:
-                f.write(file_data)
-
-    def on_deathlink(self, data: typing.Dict[str, typing.Any]) -> None:
-        with open(os.path.join(self.game_communication_path, "deathLinkReceive"), 'w+') as f:
-            text = data.get("cause", "")
-            if text:
-                f.write(f"DeathLink: {text}")
-            else:
-                f.write(f"DeathLink: Received from {data['source']}")
-        super(WargrooveContext, self).on_deathlink(data)
+            shutil.copytree(data_directory, appdata_wargroove, dirs_exist_ok=True)
+        else:
+            print_error_and_close("WargrooveClient couldn't detect system type. "
+                                  "Unable to infer required game_communication_path")
 
     async def server_auth(self, password_requested: bool = False):
         if password_requested and not self.password:
@@ -246,25 +138,20 @@ class WargrooveContext(CommonContext):
 
     def on_package(self, cmd: str, args: dict):
         if cmd in {"Connected"}:
-            slot_data = args["slot_data"]
-            self.has_death_link = slot_data.get("death_link", False)
             filename = f"AP_settings.json"
             with open(os.path.join(self.game_communication_path, filename), 'w') as f:
-                json.dump(slot_data, f)
+                slot_data = args["slot_data"]
+                json.dump(args["slot_data"], f)
                 self.can_choose_commander = slot_data["can_choose_commander"]
                 print('can choose commander:', self.can_choose_commander)
                 self.starting_groove_multiplier = slot_data["starting_groove_multiplier"]
                 self.income_boost_multiplier = slot_data["income_boost"]
                 self.commander_defense_boost_multiplier = slot_data["commander_defense_boost"]
+                f.close()
             for ss in self.checked_locations:
                 filename = f"send{ss}"
                 with open(os.path.join(self.game_communication_path, filename), 'w') as f:
-                    pass
-
-            self.player_stored_units_key = f"wargroove_player_units_{self.team}"
-            self.ai_stored_units_key = f"wargroove_ai_units_{self.team}"
-            self.set_notify(self.player_stored_units_key, self.ai_stored_units_key)
-
+                    f.close()
             self.update_commander_data()
             self.ui.update_tracker()
 
@@ -274,6 +161,7 @@ class WargrooveContext(CommonContext):
                 filename = f"seed{i}"
                 with open(os.path.join(self.game_communication_path, filename), 'w') as f:
                     f.write(str(random.randint(0, 4294967295)))
+                    f.close()
 
         if cmd in {"RoomInfo"}:
             self.seed_name = args["seed_name"]
@@ -301,6 +189,7 @@ class WargrooveContext(CommonContext):
                         f.write(f"{item_count * self.commander_defense_boost_multiplier}")
                     else:
                         f.write(f"{item_count}")
+                    f.close()
 
                 print_filename = f"AP_{str(network_item.item)}.item.print"
                 print_path = os.path.join(self.game_communication_path, print_filename)
@@ -311,6 +200,7 @@ class WargrooveContext(CommonContext):
                                 self.item_names.lookup_in_game(network_item.item) +
                                 " from " +
                                 self.player_names[network_item.player])
+                        f.close()
             self.update_commander_data()
             self.ui.update_tracker()
 
@@ -319,7 +209,7 @@ class WargrooveContext(CommonContext):
                 for ss in self.checked_locations:
                     filename = f"send{ss}"
                     with open(os.path.join(self.game_communication_path, filename), 'w') as f:
-                        pass
+                        f.close()
 
     def run_gui(self):
         """Import kivy UI system and start running it as self.ui_task."""
@@ -495,75 +385,32 @@ class WargrooveContext(CommonContext):
 
 
 async def game_watcher(ctx: WargrooveContext):
+    from worlds.wargroove.Locations import location_table
     while not ctx.exit_event.is_set():
-        try:
-            if ctx.syncing == True:
-                sync_msg = [{'cmd': 'Sync'}]
-                if ctx.locations_checked:
-                    sync_msg.append({"cmd": "LocationChecks", "locations": list(ctx.locations_checked)})
-                await ctx.send_msgs(sync_msg)
-                ctx.syncing = False
-            sending = []
-            victory = False
-            for root, dirs, files in os.walk(ctx.game_communication_path):
-                for file in files:
-                    if file == "deathLinkSend" and ctx.has_death_link:
-                        with open(os.path.join(ctx.game_communication_path, file), 'r') as f:
-                            failed_mission = f.read()
-                            if ctx.slot is not None:
-                                await ctx.send_death(f"{ctx.player_names[ctx.slot]} failed {failed_mission}")
-                        os.remove(os.path.join(ctx.game_communication_path, file))
-                    if file.find("send") > -1:
-                        st = file.split("send", -1)[1]
-                        sending = sending+[(int(st))]
-                        os.remove(os.path.join(ctx.game_communication_path, file))
-                    if file.find("victory") > -1:
-                        victory = True
-                        os.remove(os.path.join(ctx.game_communication_path, file))
-                    if file == "unitSacrifice" or file == "unitSacrificeAI":
-                        if ctx.has_sacrifice_summon:
-                            stored_units_key = ctx.player_stored_units_key
-                            if file == "unitSacrificeAI":
-                                stored_units_key = ctx.ai_stored_units_key
-                            with open(os.path.join(ctx.game_communication_path, file), 'r') as f:
-                                unit_class = f.read()
-                                message = [{"cmd": 'Set', "key": stored_units_key,
-                                            "default": [],
-                                            "want_reply": True,
-                                            "operations": [{"operation": "add", "value": [unit_class[:64]]}]}]
-                                await ctx.send_msgs(message)
-                        os.remove(os.path.join(ctx.game_communication_path, file))
-                    if file == "unitSummonRequestAI" or file == "unitSummonRequest":
-                        if ctx.has_sacrifice_summon:
-                            stored_units_key = ctx.player_stored_units_key
-                            if file == "unitSummonRequestAI":
-                                stored_units_key = ctx.ai_stored_units_key
-                            with open(os.path.join(ctx.game_communication_path, "unitSummonResponse"), 'w') as f:
-                                if stored_units_key in ctx.stored_data:
-                                    stored_units = ctx.stored_data[stored_units_key]
-                                    if stored_units is None:
-                                        stored_units = []
-                                    wg1_stored_units = [unit for unit in stored_units if unit in ctx.unit_classes]
-                                    if len(wg1_stored_units) != 0:
-                                        summoned_unit = random.choice(wg1_stored_units)
-                                        message = [{"cmd": 'Set', "key": stored_units_key,
-                                                    "default": [],
-                                                    "want_reply": True,
-                                                    "operations": [{"operation": "remove", "value": summoned_unit[:64]}]}]
-                                        await ctx.send_msgs(message)
-                                        f.write(summoned_unit)
-                        os.remove(os.path.join(ctx.game_communication_path, file))
-
-            ctx.locations_checked = sending
-            message = [{"cmd": 'LocationChecks', "locations": sending}]
-            await ctx.send_msgs(message)
-            if not ctx.finished_game and victory:
-                await ctx.send_msgs([{"cmd": "StatusUpdate", "status": ClientStatus.CLIENT_GOAL}])
-                ctx.finished_game = True
-            await asyncio.sleep(0.1)
-
-        except Exception as err:
-            logger.warn("Exception in communication thread, a check may not have been sent: " + str(err))
+        if ctx.syncing == True:
+            sync_msg = [{'cmd': 'Sync'}]
+            if ctx.locations_checked:
+                sync_msg.append({"cmd": "LocationChecks", "locations": list(ctx.locations_checked)})
+            await ctx.send_msgs(sync_msg)
+            ctx.syncing = False
+        sending = []
+        victory = False
+        for root, dirs, files in os.walk(ctx.game_communication_path):
+            for file in files:
+                if file.find("send") > -1:
+                    st = file.split("send", -1)[1]
+                    sending = sending+[(int(st))]
+                    os.remove(os.path.join(ctx.game_communication_path, file))
+                if file.find("victory") > -1:
+                    victory = True
+                    os.remove(os.path.join(ctx.game_communication_path, file))
+        ctx.locations_checked = sending
+        message = [{"cmd": 'LocationChecks', "locations": sending}]
+        await ctx.send_msgs(message)
+        if not ctx.finished_game and victory:
+            await ctx.send_msgs([{"cmd": "StatusUpdate", "status": ClientStatus.CLIENT_GOAL}])
+            ctx.finished_game = True
+        await asyncio.sleep(0.1)
 
 
 def print_error_and_close(msg):
@@ -571,9 +418,8 @@ def print_error_and_close(msg):
     Utils.messagebox("Error", msg, error=True)
     sys.exit(1)
 
-def launch(*launch_args: str):
-    async def main():
-        args = parser.parse_args(launch_args)
+if __name__ == '__main__':
+    async def main(args):
         ctx = WargrooveContext(args.connect, args.password)
         ctx.server_task = asyncio.create_task(server_loop(ctx), name="server loop")
         if gui_enabled:
@@ -593,6 +439,7 @@ def launch(*launch_args: str):
 
     parser = get_base_parser(description="Wargroove Client, for text interfacing.")
 
+    args, rest = parser.parse_known_args()
     colorama.just_fix_windows_console()
-    asyncio.run(main())
+    asyncio.run(main(args))
     colorama.deinit()

WebHostLib/__init__.py

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

WebHostLib/downloads.py

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

WebHostLib/requirements.txt

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

WebHostLib/static/assets/minecraftTracker.js

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

WebHostLib/static/styles/minecraftTracker.css

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

WebHostLib/templates/hostGame.html

@@ -17,7 +17,9 @@
                 This page allows you to host a game which was not generated by the website. For example, if you have
                 generated a game on your own computer, you may upload the zip file created by the generator to
                 host the game here. This will also provide a tracker, and the ability for your players to download
-                their patch files.
+                their patch files if the game is core-verified. For Custom Games, you can find the patch files in
+                the output .zip file you are uploading here. You need to manually distribute those patch files to
+                your players.
             </p>
             <p>In addition to the zip file created by the generator, you may upload a multidata file here as well.</p>
             <div id="host-game-form-wrapper">

WebHostLib/templates/macros.html

@@ -26,15 +26,30 @@
                     <td>{{ patch.game }}</td>
                     <td>
                         {% if patch.data %}
-                            {% if patch.game == "VVVVVV" and room.seed.slots|length == 1 %}
+                            {% if patch.game == "Minecraft" %}
+                            <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
+                                Download APMC File...</a>
+                            {% elif patch.game == "Factorio" %}
+                            <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
+                                Download Factorio Mod...</a>
+                            {% elif patch.game == "Kingdom Hearts 2" %}
+                            <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
+                                Download Kingdom Hearts 2 Mod...</a>
+                            {% elif patch.game == "Ocarina of Time" %}
+                            <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
+                                Download APZ5 File...</a>
+                            {% elif patch.game == "VVVVVV" and room.seed.slots|length == 1 %}
                             <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
                                 Download APV6 File...</a>
                             {% elif patch.game == "Super Mario 64" and room.seed.slots|length == 1 %}
                             <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
                                 Download APSM64EX File...</a>
-                            {% elif patch.game | is_applayercontainer(patch.data, patch.player_id) %}
+                            {% elif patch.game | supports_apdeltapatch %}
                             <a href="{{ url_for("download_patch", patch_id=patch.id, room_id=room.id) }}" download>
                                 Download Patch File...</a>
+                            {% elif patch.game == "Final Fantasy Mystic Quest" %}
+                            <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
+                                Download APMQ File...</a>
                             {% else %}
                                 No file to download for this game.
                             {% endif %}

WebHostLib/templates/tracker__Minecraft.html

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

WebHostLib/tracker.py

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

WebHostLib/upload.py

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

data/client.kv

@@ -24,20 +24,9 @@
 <BaseButton>:
     ripple_color: app.theme_cls.primaryColor
     ripple_duration_in_fast: 0.2
-<MDNavigationItemBase>:
-    on_release: app.screens.switch_screens(self)
-
-    MDNavigationItemLabel:
-        text: root.text
-        theme_text_color: "Custom"
-        text_color_active: self.theme_cls.primaryColor
-        text_color_normal: 1, 1, 1, 1
-        # indicator is on icon only for some reason
-        canvas.before:
-            Color:
-                rgba: self.theme_cls.secondaryContainerColor if root.active else self.theme_cls.transparentColor
-            Rectangle:
-                size: root.size
+<MDTabsItemBase>:
+    ripple_color: app.theme_cls.primaryColor
+    ripple_duration_in_fast: 0.2
 <TooltipLabel>:
     adaptive_height: True
     theme_font_size: "Custom"
@@ -233,8 +222,3 @@
         spacing: 10
         size_hint_y: None
         height: self.minimum_height
-<MessageBoxLabel>:
-    valign: "middle"
-    halign: "center"
-    text_size: self.width, None
-    height: self.texture_size[1]

data/lua/connector_bizhawk_generic.lua

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

data/lua/connector_ff1.lua

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

data/lua/connector_mmbn3.lua

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

data/options.yaml

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

docs/CODEOWNERS

@@ -48,6 +48,9 @@
 # Civilization VI
 /worlds/civ6/ @hesto2
 
+# Clique
+/worlds/clique/ @ThePhar
+
 # Dark Souls III
 /worlds/dark_souls_3/ @Marechal-L @nex3
 
@@ -84,9 +87,6 @@
 # Inscryption
 /worlds/inscryption/ @DrBibop @Glowbuzz
 
-# Jak and Daxter: The Precursor Legacy
-/worlds/jakanddaxter/ @massimilianodelliubaldini
-
 # Kirby's Dream Land 3
 /worlds/kdl3/ @Silvris
 
@@ -118,6 +118,9 @@
 # The Messenger
 /worlds/messenger/ @alwaysintreble
 
+# Minecraft
+/worlds/minecraft/ @KonoTyran @espeon65536
+
 # Mega Man 2
 /worlds/mm2/ @Silvris
 
@@ -145,15 +148,15 @@
 # Raft
 /worlds/raft/ @SunnyBat
 
+# Rogue Legacy
+/worlds/rogue_legacy/ @ThePhar
+
 # Risk of Rain 2
 /worlds/ror2/ @kindasneaki
 
 # Saving Princess
 /worlds/saving_princess/ @LeonarthCG
 
-# shapez
-/worlds/shapez/ @BlastSlimey
-
 # Shivers
 /worlds/shivers/ @GodlFire @korydondzila
 
@@ -172,9 +175,6 @@
 # Super Mario 64
 /worlds/sm64ex/ @N00byKing
 
-# Super Mario Land 2: 6 Golden Coins
-/worlds/marioland2/ @Alchav
-
 # Super Mario World
 /worlds/smw/ @PoryGone
 
@@ -232,7 +232,7 @@
 ## Active Unmaintained Worlds
 
 # The following worlds in this repo are currently unmaintained, but currently still work in core. If any update breaks
-# compatibility, these worlds may be deleted. If you are interested in stepping up as maintainer for
+# compatibility, these worlds may be moved to `worlds_disabled`. If you are interested in stepping up as maintainer for
 # any of these worlds, please review `/docs/world maintainer.md` documentation.
 
 # Final Fantasy (1)
@@ -241,6 +241,15 @@
 # Ocarina of Time
 # /worlds/oot/
 
+## Disabled Unmaintained Worlds
+
+# The following worlds in this repo are currently unmaintained and disabled as they do not work in core. If you are
+# interested in stepping up as maintainer for any of these worlds, please review `/docs/world maintainer.md`
+# documentation.
+
+# Ori and the Blind Forest
+# /worlds_disabled/oribf/
+
 ###################
 ## Documentation ##
 ###################

docs/network diagram/network diagram.md

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

docs/network protocol.md

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

docs/options api.md

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

docs/settings api.md

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

docs/world api.md

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

docs/world maintainer.md

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

inno_setup.iss

@@ -86,7 +86,6 @@ Type: dirifempty; Name: "{app}"
 [InstallDelete]
 Type: files; Name: "{app}\*.exe"
 Type: files; Name: "{app}\data\lua\connector_pkmn_rb.lua"
-Type: files; Name: "{app}\data\lua\connector_ff1.lua"
 Type: filesandordirs; Name: "{app}\SNI\lua*"
 Type: filesandordirs; Name: "{app}\EnemizerCLI*"
 #include "installdelete.iss"
@@ -138,6 +137,11 @@ Root: HKCR; Subkey: "{#MyAppName}kdl3patch";                     ValueData: "Arc
 Root: HKCR; Subkey: "{#MyAppName}kdl3patch\DefaultIcon";         ValueData: "{app}\ArchipelagoSNIClient.exe,0";                           ValueType: string;  ValueName: "";
 Root: HKCR; Subkey: "{#MyAppName}kdl3patch\shell\open\command";  ValueData: """{app}\ArchipelagoSNIClient.exe"" ""%1""";                  ValueType: string;  ValueName: "";
 
+Root: HKCR; Subkey: ".apmc";                                     ValueData: "{#MyAppName}mcdata";         Flags: uninsdeletevalue; ValueType: string;  ValueName: "";
+Root: HKCR; Subkey: "{#MyAppName}mcdata";                        ValueData: "Archipelago Minecraft Data"; Flags: uninsdeletekey;   ValueType: string;  ValueName: "";
+Root: HKCR; Subkey: "{#MyAppName}mcdata\DefaultIcon";            ValueData: "{app}\ArchipelagoMinecraftClient.exe,0";                           ValueType: string;  ValueName: "";
+Root: HKCR; Subkey: "{#MyAppName}mcdata\shell\open\command";     ValueData: """{app}\ArchipelagoMinecraftClient.exe"" ""%1""";                  ValueType: string;  ValueName: "";
+
 Root: HKCR; Subkey: ".apz5";                                     ValueData: "{#MyAppName}n64zpf";         Flags: uninsdeletevalue; ValueType: string;  ValueName: "";
 Root: HKCR; Subkey: "{#MyAppName}n64zpf";                        ValueData: "Archipelago Ocarina of Time Patch"; Flags: uninsdeletekey;   ValueType: string;  ValueName: "";
 Root: HKCR; Subkey: "{#MyAppName}n64zpf\DefaultIcon";            ValueData: "{app}\ArchipelagoOoTClient.exe,0";                           ValueType: string;  ValueName: "";

kvui.py

@@ -6,6 +6,7 @@ import re
 import io
 import pkgutil
 from collections import deque
+
 assert "kivy" not in sys.modules, "kvui should be imported before kivy for frozen compatibility"
 
 if sys.platform == "win32":
@@ -56,14 +57,10 @@ from kivy.animation import Animation
 from kivy.uix.popup import Popup
 from kivy.uix.image import AsyncImage
 from kivymd.app import MDApp
-from kivymd.uix.dialog import MDDialog, MDDialogHeadlineText, MDDialogSupportingText, MDDialogButtonContainer
 from kivymd.uix.gridlayout import MDGridLayout
 from kivymd.uix.floatlayout import MDFloatLayout
 from kivymd.uix.boxlayout import MDBoxLayout
-from kivymd.uix.navigationbar import MDNavigationBar, MDNavigationItem
-from kivymd.uix.screen import MDScreen
-from kivymd.uix.screenmanager import MDScreenManager
-
+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
@@ -713,94 +710,72 @@ class CommandPromptTextInput(ResizableTextField):
         self.text = self._command_history[self._command_history_index]
 
 
-class MessageBoxLabel(MDLabel):
-    def __init__(self, **kwargs):
-        super().__init__(**kwargs)
-        self._label.refresh()
-
-
 class MessageBox(Popup):
+    class MessageBoxLabel(MDLabel):
+        def __init__(self, **kwargs):
+            super().__init__(**kwargs)
+            self._label.refresh()
 
     def __init__(self, title, text, error=False, **kwargs):
-        label = MessageBoxLabel(text=text)
+        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),
                          separator_color=separator_color, **kwargs)
         self.height += max(0, label.height - 18)
 
 
-class MDNavigationItemBase(MDNavigationItem):
-    text = StringProperty(None)
+class ClientTabs(MDTabsSecondary):
+    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
 
-class ButtonsPrompt(MDDialog):
-    def __init__(self, title: str, text: str, response: typing.Callable[[str], None],
-                 *prompts: str, **kwargs) -> None:
-        """
-        Customizable popup box that lets you create any number of buttons. The text of the pressed button is returned to
-        the callback.
+    def _check_panel_height(self, *args):
+        self.ids.tab_scroll.height = dp(38)
 
-        :param title: The title of the popup.
-        :param text: The message prompt in the popup.
-        :param response: A callable that will get called when the user presses a button. The prompt will not close
-         itself so should be done here if you want to close it when certain buttons are pressed.
-        :param prompts: Any number of strings to be used for the buttons.
-        """
-        layout = MDBoxLayout(orientation="vertical")
-        label = MessageBoxLabel(text=text)
-        layout.add_widget(label)
+    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)
 
-        def on_release(button: MDButton, *args) -> None:
-            response(button.text)
+            item_text_object = self._get_tab_item_text_icon_object()
 
-        buttons = [MDDivider()]
-        for prompt in prompts:
-            button = MDButton(
-                MDButtonText(text=prompt, pos_hint={"center_x": 0.5, "center_y": 0.5}),
-                on_release=on_release,
-                style="text",
-                theme_width="Custom",
-                size_hint_x=1,
-            )
-            button.text = prompt
-            buttons.extend([button, MDDivider()])
+            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,
+                )
 
-        super().__init__(
-            MDDialogHeadlineText(text=title),
-            MDDialogSupportingText(text=text),
-            MDDialogButtonContainer(*buttons, orientation="vertical"),
-            **kwargs,
-        )
+            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)
 
-
-class MDScreenManagerBase(MDScreenManager):
-    current_tab: MDNavigationItemBase
-    local_screen_names: list[str]
-
-    def __init__(self, **kwargs):
-        super().__init__(**kwargs)
-        self.local_screen_names = []
-
-    def add_widget(self, widget: Widget, *args, **kwargs) -> None:
-        super().add_widget(widget, *args, **kwargs)
-        if "index" in kwargs:
-            self.local_screen_names.insert(kwargs["index"], widget.name)
+        if not instance:
+            self.indicator.pos = (x, self.indicator.pos[1])
+            self.indicator.size = (w, self.indicator_height)
         else:
-            self.local_screen_names.append(widget.name)
+            Clock.schedule_once(update_indicator)
 
-    def switch_screens(self, new_tab: MDNavigationItemBase) -> None:
-        """
-        Called whenever the user clicks a tab to switch to a different screen.
-
-        :param new_tab: The new screen to switch to's tab.
-        """
-        name = new_tab.text
-        if self.local_screen_names.index(name) > self.local_screen_names.index(self.current_screen.name):
-            self.transition.direction = "left"
-        else:
-            self.transition.direction = "right"
-        self.current = name
-        self.current_tab = new_tab
+    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):
@@ -828,9 +803,6 @@ class GameManager(ThemedApp):
     main_area_container: MDGridLayout
     """ subclasses can add more columns beside the tabs """
 
-    tabs: MDNavigationBar
-    screens: MDScreenManagerBase
-
     def __init__(self, ctx: context_type):
         self.title = self.base_title
         self.ctx = ctx
@@ -860,7 +832,7 @@ class GameManager(ThemedApp):
     @property
     def tab_count(self):
         if hasattr(self, "tabs"):
-            return max(1, len(self.tabs.children))
+            return max(1, len(self.tabs.tab_list))
         return 1
 
     def on_start(self):
@@ -900,32 +872,30 @@ class GameManager(ThemedApp):
         self.grid.add_widget(self.progressbar)
 
         # middle part
-        self.screens = MDScreenManagerBase(pos_hint={"center_x": 0.5})
-        self.tabs = MDNavigationBar(orientation="horizontal", size_hint_y=None, height=dp(40), set_bars_color=True)
-        # bind the method to the bar for back compatibility
-        self.tabs.remove_tab = self.remove_client_tab
-        self.screens.current_tab = self.add_client_tab(
-            "All" if len(self.logging_pairs) > 1 else "Archipelago",
-            UILog(*(logging.getLogger(logger_name) for logger_name, name in self.logging_pairs)),
-        )
-        self.log_panels["All"] = self.screens.current_tab.content
-        self.screens.current_tab.active = True
+        self.tabs = ClientTabs(pos_hint={"center_x": 0.5, "center_y": 0.5})
+        self.tabs.add_widget(MDTabsItem(MDTabsItemText(text="All" if len(self.logging_pairs) > 1 else "Archipelago")))
+        self.log_panels["All"] = self.tabs.default_tab_content = UILog(*(logging.getLogger(logger_name)
+                                                                             for logger_name, name in
+                                                                             self.logging_pairs))
+        self.tabs.carousel.add_widget(self.tabs.default_tab_content)
 
         for logger_name, display_name in self.logging_pairs:
             bridge_logger = logging.getLogger(logger_name)
             self.log_panels[display_name] = UILog(bridge_logger)
             if len(self.logging_pairs) > 1:
-                self.add_client_tab(display_name, self.log_panels[display_name])
+                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())
         self.hint_log = HintLog(self.json_to_kivy_parser)
-        hint_panel = self.add_client_tab("Hints", HintLayout(self.hint_log))
         self.log_panels["Hints"] = hint_panel.content
+        hint_panel.content.add_widget(self.hint_log)
 
         self.main_area_container = MDGridLayout(size_hint_y=1, rows=1)
-        tab_container = MDGridLayout(size_hint_y=1, cols=1)
-        tab_container.add_widget(self.tabs)
-        tab_container.add_widget(self.screens)
-        self.main_area_container.add_widget(tab_container)
+        self.main_area_container.add_widget(self.tabs)
 
         self.grid.add_widget(self.main_area_container)
 
@@ -962,61 +932,25 @@ class GameManager(ThemedApp):
 
         return self.container
 
-    def add_client_tab(self, title: str, content: Widget, index: int = -1) -> MDNavigationItemBase:
-        """
-        Adds a new tab to the client window with a given title, and provides a given Widget as its content.
-        Returns the new tab widget, with the provided content being placed on the tab as content.
-
-        :param title: The title of the tab.
-        :param content: The Widget to be added as content for this tab's new MDScreen. Will also be added to the
-         returned tab as tab.content.
-        :param index: The index to insert the tab at. Defaults to -1, meaning the tab will be appended to the end.
-
-        :return: The new tab.
-        """
-        if self.tabs.children:
-            self.tabs.add_widget(MDDivider(orientation="vertical"))
-        new_tab = MDNavigationItemBase(text=title)
+    def add_client_tab(self, title: str, content: Widget, index: int = -1) -> Widget:
+        """Adds a new tab to the client window with a given title, and provides a given Widget as its content.
+         Returns the new tab widget, with the provided content being placed on the tab as content."""
+        new_tab = MDTabsItem(MDTabsItemText(text=title))
         new_tab.content = content
-        new_screen = MDScreen(name=title)
-        new_screen.add_widget(content)
-        if -1 < index <= len(self.tabs.children):
-            remapped_index = len(self.tabs.children) - index
-            self.tabs.add_widget(new_tab, index=remapped_index)
-            self.screens.add_widget(new_screen, index=index)
+        if -1 < index <= len(self.tabs.carousel.slides):
+            new_tab.bind(on_release=self.tabs.set_active_item)
+            new_tab._tabs = self.tabs
+            self.tabs.ids.container.add_widget(new_tab, index=index)
+            self.tabs.carousel.add_widget(new_tab.content, index=len(self.tabs.carousel.slides) - index)
         else:
             self.tabs.add_widget(new_tab)
-            self.screens.add_widget(new_screen)
+            self.tabs.carousel.add_widget(new_tab.content)
         return new_tab
 
-    def remove_client_tab(self, tab: MDNavigationItemBase) -> None:
-        """
-        Called to remove a tab and its screen.
-
-        :param tab: The tab to remove.
-        """
-        tab_index = self.tabs.children.index(tab)
-        # if the tab is currently active we need to swap before removing it
-        if tab == self.screens.current_tab:
-            if not tab_index:
-                # account for the divider
-                swap_index = tab_index + 2
-            else:
-                swap_index = tab_index - 2
-            self.tabs.children[swap_index].on_release()
-            # self.screens.switch_screens(self.tabs.children[swap_index])
-        # get the divider to the left if we can
-        if not tab_index:
-            divider_index = tab_index + 1
-        else:
-            divider_index = tab_index - 1
-        self.tabs.remove_widget(self.tabs.children[divider_index])
-        self.tabs.remove_widget(tab)
-        self.screens.remove_widget(self.screens.get_screen(tab.text))
-
     def update_texts(self, dt):
-        if hasattr(self.screens.current_tab.content, "fix_heights"):
-            getattr(self.screens.current_tab.content, "fix_heights")()
+        for slide in self.tabs.carousel.slides:
+            if hasattr(slide, "fix_heights"):
+                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} " \

requirements.txt

@@ -11,6 +11,7 @@ certifi>=2025.4.26
 cython>=3.0.12
 cymem>=2.0.11
 orjson>=3.10.15
+discord-webhook>=1.3.0
 typing_extensions>=4.12.2
 pyshortcuts>=1.9.1
 kivymd @ git+https://github.com/kivymd/KivyMD@5ff9d0d

setup.py

@@ -63,6 +63,8 @@ non_apworlds: set[str] = {
     "Adventure",
     "ArchipIDLE",
     "Archipelago",
+    "Clique",
+    "Final Fantasy",
     "Lufia II Ancient Cave",
     "Meritous",
     "Ocarina of Time",
@@ -371,6 +373,10 @@ class BuildExeCommand(cx_Freeze.command.build_exe.build_exe):
         assert not non_apworlds - set(AutoWorldRegister.world_types), \
             f"Unknown world {non_apworlds - set(AutoWorldRegister.world_types)} designated for .apworld"
         folders_to_remove: list[str] = []
+        disabled_worlds_folder = "worlds_disabled"
+        for entry in os.listdir(disabled_worlds_folder):
+            if os.path.isdir(os.path.join(disabled_worlds_folder, entry)):
+                folders_to_remove.append(entry)
         generate_yaml_templates(self.buildfolder / "Players" / "Templates", False)
         for worldname, worldtype in AutoWorldRegister.world_types.items():
             if worldname not in non_apworlds:
@@ -480,7 +486,7 @@ tmp="${{exe#*/}}"
 if [ ! "${{#tmp}}" -lt "${{#exe}}" ]; then
     exe="{default_exe.parent}/$exe"
 fi
-export LD_LIBRARY_PATH="${{LD_LIBRARY_PATH:+$LD_LIBRARY_PATH:}}$APPDIR/{default_exe.parent}/lib"
+export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$APPDIR/{default_exe.parent}/lib"
 $APPDIR/$exe "$@"
 """)
         launcher_filename.chmod(0o755)

test/bases.py

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

test/benchmark/locations.py

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

test/general/__init__.py

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

test/general/test_implemented.py

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

test/hosting/__main__.py

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

test/hosting/generate.py

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

test/hosting/world.py

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

worlds/AutoWorld.py

@@ -382,7 +382,7 @@ class World(metaclass=AutoWorldRegister):
     def create_items(self) -> None:
         """
         Method for creating and submitting items to the itempool. Items and Regions must *not* be created and submitted
-        to the MultiWorld after this step. If items need to be placed during pre_fill use `get_pre_fill_items`.
+        to the MultiWorld after this step. If items need to be placed during pre_fill use `get_prefill_items`.
         """
         pass
 
@@ -528,7 +528,7 @@ class World(metaclass=AutoWorldRegister):
         """Called when an item is collected in to state. Useful for things such as progressive items or currency."""
         name = self.collect_item(state, item)
         if name:
-            state.add_item(name, self.player)
+            state.prog_items[self.player][name] += 1
             return True
         return False
 
@@ -536,7 +536,9 @@ class World(metaclass=AutoWorldRegister):
         """Called when an item is removed from to state. Useful for things such as progressive items or currency."""
         name = self.collect_item(state, item, True)
         if name:
-            state.remove_item(name, self.player)
+            state.prog_items[self.player][name] -= 1
+            if state.prog_items[self.player][name] < 1:
+                del (state.prog_items[self.player][name])
             return True
         return False
 

worlds/Files.py

@@ -6,7 +6,6 @@ import zipfile
 from enum import IntEnum
 import os
 import threading
-from io import BytesIO
 
 from typing import ClassVar, Dict, List, Literal, Tuple, Any, Optional, Union, BinaryIO, overload, Sequence
 
@@ -71,18 +70,6 @@ class AutoPatchExtensionRegister(abc.ABCMeta):
 container_version: int = 6
 
 
-def is_ap_player_container(game: str, data: bytes, player: int):
-    if not zipfile.is_zipfile(BytesIO(data)):
-        return False
-    with zipfile.ZipFile(BytesIO(data), mode='r') as zf:
-        if "archipelago.json" in zf.namelist():
-            manifest = json.loads(zf.read("archipelago.json"))
-            if "game" in manifest and "player" in manifest:
-                if game == manifest["game"] and player == manifest["player"]:
-                    return True
-    return False
-
-
 class InvalidDataError(Exception):
     """
     Since games can override `read_contents` in APContainer,
@@ -91,15 +78,24 @@ class InvalidDataError(Exception):
 
 
 class APContainer:
-    """A zipfile containing at least archipelago.json, which contains a manifest json payload."""
-    version: ClassVar[int] = container_version
-    compression_level: ClassVar[int] = 9
-    compression_method: ClassVar[int] = zipfile.ZIP_DEFLATED
+    """A zipfile containing at least archipelago.json"""
+    version: int = container_version
+    compression_level: int = 9
+    compression_method: int = zipfile.ZIP_DEFLATED
+    game: Optional[str] = None
 
+    # instance attributes:
     path: Optional[str]
+    player: Optional[int]
+    player_name: str
+    server: str
 
-    def __init__(self, path: Optional[str] = None):
+    def __init__(self, path: Optional[str] = None, player: Optional[int] = None,
+                 player_name: str = "", server: str = ""):
         self.path = path
+        self.player = player
+        self.player_name = player_name
+        self.server = server
 
     def write(self, file: Optional[Union[str, BinaryIO]] = None) -> None:
         zip_file = file if file else self.path
@@ -139,60 +135,31 @@ class APContainer:
                         message = f"{arg0} - "
                 raise InvalidDataError(f"{message}This might be the incorrect world version for this file") from e
 
-    def read_contents(self, opened_zipfile: zipfile.ZipFile) -> Dict[str, Any]:
+    def read_contents(self, opened_zipfile: zipfile.ZipFile) -> None:
         with opened_zipfile.open("archipelago.json", "r") as f:
             manifest = json.load(f)
         if manifest["compatible_version"] > self.version:
             raise Exception(f"File (version: {manifest['compatible_version']}) too new "
                             f"for this handler (version: {self.version})")
-        return manifest
+        self.player = manifest["player"]
+        self.server = manifest["server"]
+        self.player_name = manifest["player_name"]
 
     def get_manifest(self) -> Dict[str, Any]:
         return {
+            "server": self.server,  # allow immediate connection to server in multiworld. Empty string otherwise
+            "player": self.player,
+            "player_name": self.player_name,
+            "game": self.game,
             # minimum version of patch system expected for patching to be successful
             "compatible_version": 5,
             "version": container_version,
         }
 
 
-class APPlayerContainer(APContainer):
-    """A zipfile containing at least archipelago.json meant for a player"""
-    game: ClassVar[Optional[str]] = None
-    patch_file_ending: str = ""
-
-    player: Optional[int]
-    player_name: str
-    server: str
-
-    def __init__(self, path: Optional[str] = None, player: Optional[int] = None,
-                 player_name: str = "", server: str = ""):
-        super().__init__(path)
-        self.player = player
-        self.player_name = player_name
-        self.server = server
-
-    def read_contents(self, opened_zipfile: zipfile.ZipFile) -> Dict[str, Any]:
-        manifest = super().read_contents(opened_zipfile)
-        self.player = manifest["player"]
-        self.server = manifest["server"]
-        self.player_name = manifest["player_name"]
-        return manifest
-
-    def get_manifest(self) -> Dict[str, Any]:
-        manifest = super().get_manifest()
-        manifest.update({
-            "server": self.server,  # allow immediate connection to server in multiworld. Empty string otherwise
-            "player": self.player,
-            "player_name": self.player_name,
-            "game": self.game,
-            "patch_file_ending": self.patch_file_ending,
-        })
-        return manifest
-
-
-class APPatch(APPlayerContainer):
+class APPatch(APContainer):
     """
-    An `APPlayerContainer` that represents a patch file.
+    An `APContainer` that represents a patch file.
     It includes the `procedure` key in the manifest to indicate that it is a patch.
 
     Your implementation should inherit from this if your output file
@@ -225,6 +192,7 @@ class APProcedurePatch(APAutoPatchInterface):
     """
     hash: Optional[str]  # base checksum of source file
     source_data: bytes
+    patch_file_ending: str = ""
     files: Dict[str, bytes]
 
     @classmethod
@@ -246,6 +214,7 @@ class APProcedurePatch(APAutoPatchInterface):
         manifest = super(APProcedurePatch, self).get_manifest()
         manifest["base_checksum"] = self.hash
         manifest["result_file_ending"] = self.result_file_ending
+        manifest["patch_file_ending"] = self.patch_file_ending
         manifest["procedure"] = self.procedure
         if self.procedure == APDeltaPatch.procedure:
             manifest["compatible_version"] = 5

worlds/LauncherComponents.py

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

worlds/_bizhawk/client.py

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

worlds/adventure/Rom.py

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

worlds/ahit/Locations.py

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

worlds/ahit/Rules.py

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

worlds/alttp/ItemPool.py

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

worlds/alttp/test/__init__.py

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

worlds/alttp/test/options/test_dungeon_fill.py

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

worlds/aquaria/Regions.py

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

worlds/checksfinder/docs/setup_en.md

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

worlds/civ_6/Container.py

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

worlds/civ_6/data/boosts.py

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

worlds/civ_6/docs/en_Civilization VI.md

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

worlds/civ_6/docs/setup_en.md

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

worlds/clique/Items.py

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

worlds/clique/Locations.py

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

worlds/clique/Options.py

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

worlds/clique/Regions.py

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

worlds/clique/Rules.py

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

worlds/clique/__init__.py

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

worlds/clique/docs/de_Clique.md

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

worlds/clique/docs/en_Clique.md

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

worlds/clique/docs/guide_de.md

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

worlds/clique/docs/guide_en.md

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

worlds/cv64/data/patches.py

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

worlds/cv64/options.py

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

worlds/cv64/rom.py

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

worlds/cvcotm/__init__.py

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

worlds/cvcotm/aesthetics.py

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

worlds/cvcotm/data/patches.py

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

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

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

worlds/cvcotm/docs/setup_en.md

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

worlds/cvcotm/rom.py

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

worlds/dark_souls_3/Locations.py

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

worlds/dark_souls_3/__init__.py

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

worlds/dark_souls_3/docs/setup_en.md

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

worlds/dkc3/Regions.py

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

worlds/dlcquest/Items.py

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

worlds/dlcquest/Rules.py

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

worlds/factorio/Client.py

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

worlds/factorio/Mod.py

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

worlds/factorio/Options.py

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

worlds/factorio/__init__.py

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