MultiServer: Don't send password required indicator if the password is empty string (user intention is likely no password)

Risk of rain 2: Revert breaking naming change

.github/workflows/unittests.yml

@@ -20,7 +20,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install flake8 pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        python ModuleUpdate.py --yes --force
     - name: Unittests
       run: |
         pytest test

.gitignore

@@ -4,9 +4,13 @@
 *_Spoiler.txt
 *.bmbp
 *.apbp
+*.apmc
+*.apz5
 *.pyc
 *.pyd
 *.sfc
+*.z64
+*.n64
 *.wixobj
 *.lck
 *.db3
@@ -16,7 +20,6 @@
 *.apsave
 
 build
-/build_factorio/
 bundle/components.wxs
 dist
 README.html
@@ -38,6 +41,7 @@ success.txt
 output/
 Output Logs/
 /factorio/
+/Minecraft Forge Server/
 /WebHostLib/static/generated
 
 # Byte-compiled / optimized / DLL files

CommonClient.py

@@ -3,17 +3,25 @@ import logging
 import typing
 import asyncio
 import urllib.parse
+import sys
+import os
 
 import websockets
 
 import Utils
 from MultiServer import CommandProcessor
-from NetUtils import Endpoint, decode, NetworkItem, encode, JSONtoTextParser, color, ClientStatus
+from NetUtils import Endpoint, decode, NetworkItem, encode, JSONtoTextParser, ClientStatus, Permission
 from Utils import Version
 from worlds import network_data_package, AutoWorldRegister
 
 logger = logging.getLogger("Client")
 
+gui_enabled = Utils.is_frozen() or "--nogui" not in sys.argv
+
+log_folder = Utils.local_path("logs")
+os.makedirs(log_folder, exist_ok=True)
+
+
 class ClientCommandProcessor(CommandProcessor):
     def __init__(self, ctx: CommonContext):
         self.ctx = ctx
@@ -49,7 +57,7 @@ class ClientCommandProcessor(CommandProcessor):
         """List all missing location checks, from your local game state"""
         count = 0
         checked_count = 0
-        for location, location_id in AutoWorldRegister.world_types[self.ctx.game].item_name_to_id.items():
+        for location, location_id in AutoWorldRegister.world_types[self.ctx.game].location_name_to_id.items():
             if location_id < 0:
                 continue
             if location_id not in self.ctx.locations_checked:
@@ -68,8 +76,6 @@ class ClientCommandProcessor(CommandProcessor):
             self.output("No missing location checks found.")
         return True
 
-
-
     def _cmd_ready(self):
         self.ctx.ready = not self.ctx.ready
         if self.ctx.ready:
@@ -83,11 +89,14 @@ class ClientCommandProcessor(CommandProcessor):
     def default(self, raw: str):
         asyncio.create_task(self.ctx.send_msgs([{"cmd": "Say", "text": raw}]))
 
+
 class CommonContext():
-    starting_reconnect_delay = 5
-    current_reconnect_delay = starting_reconnect_delay
-    command_processor = ClientCommandProcessor
-    game: None
+    starting_reconnect_delay: int = 5
+    current_reconnect_delay: int = starting_reconnect_delay
+    command_processor: int = ClientCommandProcessor
+    game = None
+    ui = None
+    keep_alive_task = None
 
     def __init__(self, server_address, password):
         # server state
@@ -124,6 +133,9 @@ class CommonContext():
         self.jsontotextparser = JSONtoTextParser(self)
         self.set_getters(network_data_package)
 
+        # execution
+        self.keep_alive_task = asyncio.create_task(keep_alive(self))
+
     async def connection_closed(self):
         self.auth = None
         self.items_received = []
@@ -140,16 +152,17 @@ class CommonContext():
             if local_package and local_package["version"] > network_data_package["version"]:
                 data_package: dict = local_package
         elif network:  # check if data from server is newer
-            for key, value in data_package.items():
-                if type(value) == dict:  # convert to int keys
-                    data_package[key] = \
-                        {int(subkey) if subkey.isdigit() else subkey: subvalue for subkey, subvalue in value.items()}
 
             if data_package["version"] > network_data_package["version"]:
                 Utils.persistent_store("datapackage", "latest", network_data_package)
 
-        item_lookup: dict = data_package["lookup_any_item_id_to_name"]
-        locations_lookup: dict = data_package["lookup_any_location_id_to_name"]
+        item_lookup: dict = {}
+        locations_lookup: dict = {}
+        for game, gamedata in data_package["games"].items():
+            for item_name, item_id in gamedata["item_name_to_id"].items():
+                item_lookup[item_id] = item_name
+            for location_name, location_id in gamedata["location_name_to_id"].items():
+                locations_lookup[location_id] = location_name
 
         def get_item_name_from_id(code: int):
             return item_lookup.get(code, f'Unknown item (ID:{code})')
@@ -186,7 +199,10 @@ class CommonContext():
     def event_invalid_slot(self):
         raise Exception('Invalid Slot; please verify that you have connected to the correct world.')
 
-    async def server_auth(self, password_requested):
+    def event_invalid_game(self):
+        raise Exception('Invalid Game; please verify that you connected with the right game to the correct world.')
+
+    async def server_auth(self, password_requested: bool = False):
         if password_requested and not self.password:
             logger.info('Enter the password required to join this game:')
             self.password = await self.console_input()
@@ -196,7 +212,7 @@ class CommonContext():
         self.input_requests += 1
         return await self.input_queue.get()
 
-    async def connect(self, address= None):
+    async def connect(self, address=None):
         await self.disconnect()
         self.server_task = asyncio.create_task(server_loop(self, address))
 
@@ -204,7 +220,28 @@ class CommonContext():
         logger.info(args["text"])
 
     def on_print_json(self, args: dict):
-        logger.info(self.jsontotextparser(args["data"]))
+        if self.ui:
+            self.ui.print_json(args["data"])
+        else:
+            text = self.jsontotextparser(args["data"])
+            logger.info(text)
+
+    def on_package(self, cmd: str, args: dict):
+        """For custom package handling in subclasses."""
+        pass
+
+
+async def keep_alive(ctx: CommonContext, seconds_between_checks=100):
+    """some ISPs/network configurations drop TCP connections if no payload is sent (ignore TCP-keep-alive)
+     so we send a payload to prevent drop and if we were dropped anyway this will cause an auto-reconnect."""
+    seconds_elapsed = 0
+    while not ctx.exit_event.is_set():
+        await asyncio.sleep(1)  # short sleep to not block program shutdown
+        if ctx.server and ctx.slot:
+            seconds_elapsed += 1
+            if seconds_elapsed > seconds_between_checks:
+                await ctx.send_msgs([{"cmd": "Bounce", "slots": [ctx.slot]}])
+                seconds_elapsed = 0
 
 
 async def server_loop(ctx: CommonContext, address=None):
@@ -240,13 +277,13 @@ async def server_loop(ctx: CommonContext, address=None):
             logger.error('Unable to connect to multiworld server at cached address. '
                          'Please use the connect button above.')
         else:
-            logger.error('Connection refused by the multiworld server')
+            logger.exception('Connection refused by the multiworld server')
+    except websockets.InvalidURI:
+        logger.exception('Failed to connect to the multiworld server (invalid URI)')
     except (OSError, websockets.InvalidURI):
-        logger.error('Failed to connect to the multiworld server')
+        logger.exception('Failed to connect to the multiworld server')
     except Exception as e:
-        logger.error('Lost connection to the multiworld server, type /connect to reconnect')
-        if not isinstance(e, websockets.WebSocketException):
-            logger.exception(e)
+        logger.exception('Lost connection to the multiworld server, type /connect to reconnect')
     finally:
         await ctx.connection_closed()
         if ctx.server_address:
@@ -282,14 +319,17 @@ async def process_server_cmd(ctx: CommonContext, args: dict):
             logger.info("Server protocol tags: " + ", ".join(args["tags"]))
             if args['password']:
                 logger.info('Password required')
-            logger.info(f"Forfeit setting: {args['forfeit_mode']}")
-            logger.info(f"Remaining setting: {args['remaining_mode']}")
-            logger.info(f"A !hint costs {args['hint_cost']}% of checks points and you get {args['location_check_points']}"
-                         f" for each location checked. Use !hint for more information.")
+
+            for permission_name, permission_flag in args.get("permissions", {}).items():
+                flag = Permission(permission_flag)
+                logger.info(f"{permission_name.capitalize()} permission: {flag.name}")
+            logger.info(
+                f"A !hint costs {args['hint_cost']}% of your total location count as points"
+                f" and you get {args['location_check_points']}"
+                f" for each location checked. Use !hint for more information.")
             ctx.hint_cost = int(args['hint_cost'])
             ctx.check_points = int(args['location_check_points'])
-            ctx.forfeit_mode = args['forfeit_mode']
-            ctx.remaining_mode = args['remaining_mode']
+
             if len(args['players']) < 1:
                 logger.info('No player connected')
             else:
@@ -313,7 +353,8 @@ async def process_server_cmd(ctx: CommonContext, args: dict):
         errors = args["errors"]
         if 'InvalidSlot' in errors:
             ctx.event_invalid_slot()
-
+        elif 'InvalidGame' in errors:
+            ctx.event_invalid_game()
         elif 'SlotAlreadyTaken' in errors:
             raise Exception('Player slot already in use for that team')
         elif 'IncompatibleVersion' in errors:
@@ -388,9 +429,14 @@ async def process_server_cmd(ctx: CommonContext, args: dict):
     elif cmd == 'InvalidPacket':
         logger.warning(f"Invalid Packet of {args['type']}: {args['text']}")
 
+    elif cmd == "Bounced":
+        pass
+
     else:
         logger.debug(f"unknown command {cmd}")
 
+    ctx.on_package(cmd, args)
+
 
 async def console_loop(ctx: CommonContext):
     import sys
@@ -410,4 +456,79 @@ async def console_loop(ctx: CommonContext):
             if input_text:
                 commandprocessor(input_text)
         except Exception as e:
-            logging.exception(e)
+            logger.exception(e)
+
+
+def init_logging(name: str):
+    if gui_enabled:
+        logging.basicConfig(format='[%(name)s]: %(message)s', level=logging.INFO,
+                            filename=os.path.join(log_folder, f"{name}.txt"), filemode="w", force=True)
+    else:
+        logging.basicConfig(format='[%(name)s]: %(message)s', level=logging.INFO, force=True)
+        logging.getLogger().addHandler(logging.FileHandler(os.path.join(log_folder, f"{name}.txt"), "w"))
+
+
+if __name__ == '__main__':
+    # Text Mode to use !hint and such with games that have no text entry
+    init_logging("TextClient")
+
+    class TextContext(CommonContext):
+        async def server_auth(self, password_requested: bool = False):
+            if password_requested and not self.password:
+                await super(TextContext, self).server_auth(password_requested)
+            if not self.auth:
+                logger.info('Enter slot name:')
+                self.auth = await self.console_input()
+
+            await self.send_msgs([{"cmd": 'Connect',
+                                   'password': self.password, 'name': self.auth, 'version': Utils.version_tuple,
+                                   'tags': ['AP', 'IgnoreGame'],
+                                   'uuid': Utils.get_unique_identifier(), 'game': self.game
+                                   }])
+
+    async def main(args):
+        ctx = TextContext(args.connect, args.password)
+        ctx.server_task = asyncio.create_task(server_loop(ctx), name="ServerLoop")
+        if gui_enabled:
+            input_task = None
+            from kvui import TextManager
+            ctx.ui = TextManager(ctx)
+            ui_task = asyncio.create_task(ctx.ui.async_run(), name="UI")
+        else:
+            input_task = asyncio.create_task(console_loop(ctx), name="Input")
+            ui_task = None
+        await ctx.exit_event.wait()
+
+        ctx.server_address = None
+        if ctx.server and not ctx.server.socket.closed:
+            await ctx.server.socket.close()
+        if ctx.server_task:
+            await ctx.server_task
+
+        while ctx.input_requests > 0:
+            ctx.input_queue.put_nowait(None)
+            ctx.input_requests -= 1
+
+        if ui_task:
+            await ui_task
+
+        if input_task:
+            input_task.cancel()
+
+
+    import argparse
+    import colorama
+
+    parser = argparse.ArgumentParser(description="Gameless Archipelago Client, for text interfaction.")
+    parser.add_argument('--connect', default=None, help='Address of the multiworld host.')
+    parser.add_argument('--password', default=None, help='Password of the multiworld host.')
+    if not Utils.is_frozen():  # Frozen state has no cmd window in the first place
+        parser.add_argument('--nogui', default=False, action='store_true', help="Turns off Client GUI.")
+
+    args, rest = parser.parse_known_args()
+    colorama.init()
+
+    loop = asyncio.get_event_loop()
+    loop.run_until_complete(main(args))
+    loop.close()
+    colorama.deinit()

FactorioClient.py

@@ -4,133 +4,24 @@ import logging
 import json
 import string
 import copy
-import sys
 import subprocess
 import factorio_rcon
 
 import colorama
 import asyncio
 from queue import Queue
-from CommonClient import CommonContext, server_loop, console_loop, ClientCommandProcessor, logger
+from CommonClient import CommonContext, server_loop, console_loop, ClientCommandProcessor, logger, gui_enabled, \
+    init_logging
 from MultiServer import mark_raw
 
 import Utils
 import random
-from NetUtils import RawJSONtoTextParser, NetworkItem, ClientStatus, JSONtoTextParser, JSONMessagePart
+from NetUtils import NetworkItem, ClientStatus, JSONtoTextParser, JSONMessagePart
 
-from worlds.factorio.Technologies import lookup_id_to_name
+from worlds.factorio import Factorio
 
-os.makedirs("logs", exist_ok=True)
+init_logging("FactorioClient")
 
-# Log to file in gui case
-if getattr(sys, "frozen", False) and not "--nogui" in sys.argv:
-    logging.basicConfig(format='[%(name)s]: %(message)s', level=logging.INFO,
-                        filename=os.path.join("logs", "FactorioClient.txt"), filemode="w")
-else:
-    logging.basicConfig(format='[%(name)s]: %(message)s', level=logging.INFO)
-    logging.getLogger().addHandler(logging.FileHandler(os.path.join("logs", "FactorioClient.txt"), "w"))
-
-gui_enabled = Utils.is_frozen() or "--nogui" not in sys.argv
-
-def get_kivy_app():
-    os.environ["KIVY_NO_CONSOLELOG"] = "1"
-    os.environ["KIVY_NO_FILELOG"] = "1"
-    os.environ["KIVY_NO_ARGS"] = "1"
-    from kivy.app import App
-    from kivy.base import ExceptionHandler, ExceptionManager, Config
-    from kivy.uix.gridlayout import GridLayout
-    from kivy.uix.textinput import TextInput
-    from kivy.uix.recycleview import RecycleView
-    from kivy.uix.tabbedpanel import TabbedPanel, TabbedPanelItem
-    from kivy.lang import Builder
-
-
-    class FactorioManager(App):
-        def __init__(self, ctx):
-            super(FactorioManager, self).__init__()
-            self.ctx = ctx
-            self.commandprocessor = ctx.command_processor(ctx)
-            self.icon = r"data/icon.png"
-
-        def build(self):
-            self.grid = GridLayout()
-            self.grid.cols = 1
-
-            self.tabs = TabbedPanel()
-            self.tabs.default_tab_text = "All"
-            self.title = "Archipelago Factorio Client"
-            pairs = [
-                ("Client", "Archipelago"),
-                ("FactorioServer", "Factorio Server Log"),
-                ("FactorioWatcher", "Bridge Data Log"),
-            ]
-            self.tabs.default_tab_content = UILog(*(logging.getLogger(logger_name) for logger_name, name in pairs))
-            for logger_name, display_name in pairs:
-                bridge_logger = logging.getLogger(logger_name)
-                panel = TabbedPanelItem(text=display_name)
-                panel.content = UILog(bridge_logger)
-                self.tabs.add_widget(panel)
-
-            self.grid.add_widget(self.tabs)
-            textinput = TextInput(size_hint_y=None, height=30, multiline=False)
-            textinput.bind(on_text_validate=self.on_message)
-            self.grid.add_widget(textinput)
-            self.commandprocessor("/help")
-            return self.grid
-
-        def on_stop(self):
-            self.ctx.exit_event.set()
-
-        def on_message(self, textinput: TextInput):
-            try:
-                input_text = textinput.text.strip()
-                textinput.text = ""
-
-                if self.ctx.input_requests > 0:
-                    self.ctx.input_requests -= 1
-                    self.ctx.input_queue.put_nowait(input_text)
-                elif input_text:
-                    self.commandprocessor(input_text)
-            except Exception as e:
-                logger.exception(e)
-
-        def on_address(self, text: str):
-            print(text)
-
-
-    class LogtoUI(logging.Handler):
-        def __init__(self, on_log):
-            super(LogtoUI, self).__init__(logging.DEBUG)
-            self.on_log = on_log
-
-        def handle(self, record: logging.LogRecord) -> None:
-            self.on_log(record)
-
-
-    class UILog(RecycleView):
-        cols = 1
-
-        def __init__(self, *loggers_to_handle, **kwargs):
-            super(UILog, self).__init__(**kwargs)
-            self.data = []
-            for logger in loggers_to_handle:
-                logger.addHandler(LogtoUI(self.on_log))
-
-        def on_log(self, record: logging.LogRecord) -> None:
-            self.data.append({"text": record.getMessage()})
-
-
-    class E(ExceptionHandler):
-        def handle_exception(self, inst):
-            logger.exception(inst)
-            return ExceptionManager.RAISE
-
-
-    ExceptionManager.add_handler(E())
-
-    Config.set("input", "mouse", "mouse,disable_multitouch")
-    Builder.load_file(Utils.local_path("data", "client.kv"))
-    return FactorioManager
 
 class FactorioCommandProcessor(ClientCommandProcessor):
     ctx: FactorioContext
@@ -139,64 +30,80 @@ class FactorioCommandProcessor(ClientCommandProcessor):
     def _cmd_factorio(self, text: str) -> bool:
         """Send the following command to the bound Factorio Server."""
         if self.ctx.rcon_client:
+            # TODO: Print the command non-silently only for race seeds, or otherwise block anything but /factorio /save in race seeds.
+            self.ctx.print_to_game(f"/factorio {text}")
             result = self.ctx.rcon_client.send_command(text)
             if result:
                 self.output(result)
             return True
         return False
 
-    def _cmd_connect(self, address: str = "") -> bool:
-        """Connect to a MultiWorld Server"""
-        if not self.ctx.auth:
-            if self.ctx.rcon_client:
-                get_info(self.ctx, self.ctx.rcon_client)  # retrieve current auth code
-            else:
-                self.output("Cannot connect to a server with unknown own identity, bridge to Factorio first.")
-        return super(FactorioCommandProcessor, self)._cmd_connect(address)
+    def _cmd_resync(self):
+        """Manually trigger a resync."""
+        self.ctx.awaiting_bridge = True
 
 
 class FactorioContext(CommonContext):
     command_processor = FactorioCommandProcessor
     game = "Factorio"
 
+    # updated by spinup server
+    mod_version: Utils.Version = Utils.Version(0, 0, 0)
+
     def __init__(self, server_address, password):
         super(FactorioContext, self).__init__(server_address, password)
         self.send_index = 0
         self.rcon_client = None
         self.awaiting_bridge = False
-        self.raw_json_text_parser = RawJSONtoTextParser(self)
         self.factorio_json_text_parser = FactorioJSONtoTextParser(self)
 
-    async def server_auth(self, password_requested):
+    async def server_auth(self, password_requested: bool = False):
         if password_requested and not self.password:
             await super(FactorioContext, self).server_auth(password_requested)
 
-        await self.send_msgs([{"cmd": 'Connect',
-                               'password': self.password, 'name': self.auth, 'version': Utils.version_tuple,
-                               'tags': ['AP'],
-                               'uuid': Utils.get_unique_identifier(), 'game': "Factorio"
-                               }])
+        if not self.auth:
+            if self.rcon_client:
+                get_info(self, self.rcon_client)  # retrieve current auth code
+            else:
+                raise Exception("Cannot connect to a server with unknown own identity, "
+                                "bridge to Factorio first.")
+
+        await self.send_msgs([{
+            "cmd": 'Connect',
+            'password': self.password,
+            'name': self.auth,
+            'version': Utils.version_tuple,
+            'tags': ['AP'],
+            'uuid': Utils.get_unique_identifier(),
+            'game': "Factorio"
+        }])
 
     def on_print(self, args: dict):
         logger.info(args["text"])
         if self.rcon_client:
-            cleaned_text = args['text'].replace('"', '')
-            self.rcon_client.send_command(f"/sc game.print(\"[font=default-large-bold]Archipelago:[/font] "
-                                          f"{cleaned_text}\")")
+            self.print_to_game(args['text'])
 
     def on_print_json(self, args: dict):
-        text = self.raw_json_text_parser(copy.deepcopy(args["data"]))
-        logger.info(text)
         if self.rcon_client:
-            text = self.factorio_json_text_parser(args["data"])
-            cleaned_text = text.replace('"', '')
-            self.rcon_client.send_command(f"/sc game.print(\"[font=default-large-bold]Archipelago:[/font] "
-                                          f"{cleaned_text}\")")
+            text = self.factorio_json_text_parser(copy.deepcopy(args["data"]))
+            self.print_to_game(text)
+        super(FactorioContext, self).on_print_json(args)
 
     @property
     def savegame_name(self) -> str:
         return f"AP_{self.seed_name}_{self.auth}.zip"
 
+    def print_to_game(self, text):
+        self.rcon_client.send_command(f"/ap-print [font=default-large-bold]Archipelago:[/font] "
+                                      f"{text}")
+
+    def on_package(self, cmd: str, args: dict):
+        if cmd == "Connected":
+            # catch up sync anything that is already cleared.
+            if args["checked_locations"]:
+                self.rcon_client.send_commands({item_name: f'/ap-get-technology ap-{item_name}-\t-1' for
+                                                item_name in args["checked_locations"]})
+
 
 async def game_watcher(ctx: FactorioContext):
     bridge_logger = logging.getLogger("FactorioWatcher")
@@ -207,9 +114,9 @@ async def game_watcher(ctx: FactorioContext):
                 ctx.awaiting_bridge = False
                 data = json.loads(ctx.rcon_client.send_command("/ap-sync"))
                 if data["slot_name"] != ctx.auth:
-                    logger.warning(f"Connected World is not the expected one {data['slot_name']} != {ctx.auth}")
+                    bridge_logger.warning(f"Connected World is not the expected one {data['slot_name']} != {ctx.auth}")
                 elif data["seed_name"] != ctx.seed_name:
-                    logger.warning(
+                    bridge_logger.warning(
                         f"Connected Multiworld is not the expected one {data['seed_name']} != {ctx.seed_name}")
                 else:
                     data = data["info"]
@@ -276,23 +183,28 @@ async def factorio_server_watcher(ctx: FactorioContext):
                 factorio_server_logger.info(msg)
                 if not ctx.rcon_client and "Starting RCON interface at IP ADDR:" in msg:
                     ctx.rcon_client = factorio_rcon.RCONClient("localhost", rcon_port, rcon_password)
-                    # trigger lua interface confirmation
-                    ctx.rcon_client.send_command("/sc game.print('Starting Archipelago Bridge')")
-                    ctx.rcon_client.send_command("/sc game.print('Starting Archipelago Bridge')")
+                    if not ctx.server:
+                        logger.info("Established bridge to Factorio Server. "
+                                    "Ready to connect to Archipelago via /connect")
+
                 if not ctx.awaiting_bridge and "Archipelago Bridge Data available for game tick " in msg:
                     ctx.awaiting_bridge = True
+
             if ctx.rcon_client:
+                commands = {}
                 while ctx.send_index < len(ctx.items_received):
                     transfer_item: NetworkItem = ctx.items_received[ctx.send_index]
                     item_id = transfer_item.item
                     player_name = ctx.player_names[transfer_item.player]
-                    if item_id not in lookup_id_to_name:
-                        logging.error(f"Cannot send unknown item ID: {item_id}")
+                    if item_id not in Factorio.item_id_to_name:
+                        factorio_server_logger.error(f"Cannot send unknown item ID: {item_id}")
                     else:
-                        item_name = lookup_id_to_name[item_id]
+                        item_name = Factorio.item_id_to_name[item_id]
                         factorio_server_logger.info(f"Sending {item_name} to Nauvis from {player_name}.")
-                        ctx.rcon_client.send_command(f'/ap-get-technology {item_name}\t{ctx.send_index}\t{player_name}')
+                        commands[ctx.send_index] = f'/ap-get-technology {item_name}\t{ctx.send_index}\t{player_name}'
                     ctx.send_index += 1
+                if commands:
+                    ctx.rcon_client.send_commands(commands)
             await asyncio.sleep(0.1)
 
     except Exception as e:
@@ -312,7 +224,7 @@ def get_info(ctx, rcon_client):
     ctx.seed_name = info["seed_name"]
 
 
-async def factorio_spinup_server(ctx: FactorioContext):
+async def factorio_spinup_server(ctx: FactorioContext) -> bool:
     savegame_name = os.path.abspath("Archipelago.zip")
     if not os.path.exists(savegame_name):
         logger.info(f"Creating savegame {savegame_name}")
@@ -335,23 +247,29 @@ async def factorio_spinup_server(ctx: FactorioContext):
             while not factorio_queue.empty():
                 msg = factorio_queue.get()
                 factorio_server_logger.info(msg)
+                if "Loading mod AP-" in msg and msg.endswith("(data.lua)"):
+                    parts = msg.split()
+                    ctx.mod_version = Utils.Version(*(int(number) for number in parts[-2].split(".")))
                 if not rcon_client and "Starting RCON interface at IP ADDR:" in msg:
                     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.")
                     get_info(ctx, rcon_client)
-
             await asyncio.sleep(0.01)
 
     except Exception as e:
-        logging.exception(e)
-        logging.error("Aborted Factorio Server Bridge")
+        logger.exception(e)
+        logger.error("Aborted Factorio Server Bridge")
         ctx.exit_event.set()
 
     else:
-        logger.info(f"Got World Information from AP Mod for seed {ctx.seed_name} in slot {ctx.auth}")
-
+        logger.info(
+            f"Got World Information from AP Mod {tuple(ctx.mod_version)} for seed {ctx.seed_name} in slot {ctx.auth}")
+        return True
     finally:
         factorio_process.terminate()
         factorio_process.wait(5)
+    return False
 
 
 async def main(args):
@@ -359,26 +277,28 @@ async def main(args):
     ctx.server_task = asyncio.create_task(server_loop(ctx), name="ServerLoop")
     if gui_enabled:
         input_task = None
-        ui_app = get_kivy_app()(ctx)
-        ui_task = asyncio.create_task(ui_app.async_run(), name="UI")
+        from kvui import FactorioManager
+        ctx.ui = FactorioManager(ctx)
+        ui_task = asyncio.create_task(ctx.ui.async_run(), name="UI")
     else:
         input_task = asyncio.create_task(console_loop(ctx), name="Input")
         ui_task = None
     factorio_server_task = asyncio.create_task(factorio_spinup_server(ctx), name="FactorioSpinupServer")
-    await factorio_server_task
-    factorio_server_task = asyncio.create_task(factorio_server_watcher(ctx), name="FactorioServer")
-    progression_watcher = asyncio.create_task(
-        game_watcher(ctx), name="FactorioProgressionWatcher")
+    succesful_launch = await factorio_server_task
+    if succesful_launch:
+        factorio_server_task = asyncio.create_task(factorio_server_watcher(ctx), name="FactorioServer")
+        progression_watcher = asyncio.create_task(
+            game_watcher(ctx), name="FactorioProgressionWatcher")
 
-    await ctx.exit_event.wait()
-    ctx.server_address = None
+        await ctx.exit_event.wait()
+        ctx.server_address = None
 
-    await progression_watcher
-    await factorio_server_task
+        await progression_watcher
+        await factorio_server_task
 
     if ctx.server and not ctx.server.socket.closed:
         await ctx.server.socket.close()
-    if ctx.server_task is not None:
+    if ctx.server_task:
         await ctx.server_task
 
     while ctx.input_requests > 0:
@@ -411,7 +331,7 @@ if __name__ == '__main__':
 
     parser = argparse.ArgumentParser(description="Optional arguments to FactorioClient follow. "
                                                  "Remaining arguments get passed into bound Factorio instance."
-                                                 "Refer to factorio --help for those.")
+                                                 "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('--connect', default=None, help='Address of the multiworld host.')
@@ -422,18 +342,19 @@ if __name__ == '__main__':
     args, rest = parser.parse_known_args()
     colorama.init()
     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))
+    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")
     options = Utils.get_options()
     executable = options["factorio_options"]["executable"]
-    bin_dir = os.path.dirname(executable)
-    if not os.path.exists(bin_dir):
-        raise FileNotFoundError(f"Path {bin_dir} does not exist or could not be accessed.")
-    if not os.path.isdir(bin_dir):
-        raise FileNotFoundError(f"Path {bin_dir} is not a directory.")
-    if not os.path.exists(executable):
-        if os.path.exists(executable + ".exe"):
+
+    if not os.path.exists(os.path.dirname(executable)):
+        raise FileNotFoundError(f"Path {os.path.dirname(executable)} does not exist or could not be accessed.")
+    if os.path.isdir(executable):  # user entered a path to a directory, let's find the executable therein
+        executable = os.path.join(executable, "factorio")
+    if not os.path.isfile(executable):
+        if os.path.isfile(executable + ".exe"):
             executable = executable + ".exe"
         else:
             raise FileNotFoundError(f"Path {executable} is not an executable file.")

Fill.py

@@ -4,9 +4,8 @@ import collections
 import itertools
 
 from BaseClasses import CollectionState, Location, MultiWorld
-from worlds.alttp.Items import ItemFactory
-from worlds.alttp.Regions import key_drop_data
 from worlds.generic import PlandoItem
+from worlds.AutoWorld import call_all
 
 
 class FillError(RuntimeError):
@@ -37,7 +36,7 @@ def fill_restrictive(world: MultiWorld, base_state: CollectionState, locations,
         has_beaten_game = world.has_beaten_game(maximum_exploration_state)
 
         for item_to_place in items_to_place:
-            if world.accessibility[item_to_place.player] == 'none':
+            if world.accessibility[item_to_place.player] == 'minimal':
                 perform_access_check = not world.has_beaten_game(maximum_exploration_state,
                                                                  item_to_place.player) if single_player_placement else not has_beaten_game
             else:
@@ -53,7 +52,7 @@ def fill_restrictive(world: MultiWorld, base_state: CollectionState, locations,
             else:
                 # we filled all reachable spots. Maybe the game can be beaten anyway?
                 unplaced_items.append(item_to_place)
-                if world.accessibility[item_to_place.player] != 'none' and world.can_beat_game():
+                if world.accessibility[item_to_place.player] != 'minimal' and world.can_beat_game():
                     logging.warning(
                         f'Not all items placed. Game beatable anyway. (Could not place {item_to_place})')
                     continue
@@ -69,7 +68,7 @@ def fill_restrictive(world: MultiWorld, base_state: CollectionState, locations,
     itempool.extend(unplaced_items)
 
 
-def distribute_items_restrictive(world: MultiWorld, gftower_trash=False, fill_locations=None):
+def distribute_items_restrictive(world: MultiWorld, fill_locations=None):
     # If not passed in, then get a shuffled list of locations to fill in
     if not fill_locations:
         fill_locations = world.get_unfilled_locations()
@@ -80,6 +79,7 @@ def distribute_items_restrictive(world: MultiWorld, gftower_trash=False, fill_lo
     progitempool = []
     nonexcludeditempool = []
     localrestitempool = {player: [] for player in range(1, world.players + 1)}
+    nonlocalrestitempool = []
     restitempool = []
 
     for item in world.itempool:
@@ -87,57 +87,16 @@ def distribute_items_restrictive(world: MultiWorld, gftower_trash=False, fill_lo
             progitempool.append(item)
         elif item.never_exclude:  # this only gets nonprogression items which should not appear in excluded locations
             nonexcludeditempool.append(item)
-        elif item.name in world.local_items[item.player]:
+        elif item.name in world.local_items[item.player].value:
             localrestitempool[item.player].append(item)
+        elif item.name in world.non_local_items[item.player].value:
+            nonlocalrestitempool.append(item)
         else:
             restitempool.append(item)
 
-    standard_keyshuffle_players = set()
-
-    # fill in gtower locations with trash first
-    for player in world.get_game_players("A Link to the Past"):
-        if not gftower_trash or not world.ganonstower_vanilla[player] or \
-                world.logic[player] in {'owglitches', 'hybridglitches', "nologic"}:
-            gtower_trash_count = 0
-        elif 'triforcehunt' in world.goal[player] and ('local' in world.goal[player] or world.players == 1):
-            gtower_trash_count = world.random.randint(world.crystals_needed_for_gt[player] * 2,
-                                                      world.crystals_needed_for_gt[player] * 4)
-        else:
-            gtower_trash_count = world.random.randint(0, world.crystals_needed_for_gt[player] * 2)
-
-        if gtower_trash_count:
-            gtower_locations = [location for location in fill_locations if
-                                'Ganons Tower' in location.name and location.player == player]
-            world.random.shuffle(gtower_locations)
-            trashcnt = 0
-            localrest = localrestitempool[player]
-            if localrest:
-                gt_item_pool = restitempool + localrest
-                world.random.shuffle(gt_item_pool)
-            else:
-                gt_item_pool = restitempool.copy()
-
-            while gtower_locations and gt_item_pool and trashcnt < gtower_trash_count:
-                spot_to_fill = gtower_locations.pop()
-                item_to_place = gt_item_pool.pop()
-                if item_to_place in localrest:
-                    localrest.remove(item_to_place)
-                else:
-                    restitempool.remove(item_to_place)
-                world.push_item(spot_to_fill, item_to_place, False)
-                fill_locations.remove(spot_to_fill)
-                trashcnt += 1
-        if world.mode[player] == 'standard' and world.keyshuffle[player] is True:
-            standard_keyshuffle_players.add(player)
-
-
-    # Make sure the escape small key is placed first in standard with key shuffle to prevent running out of spots
-    if standard_keyshuffle_players:
-        progitempool.sort(
-            key=lambda item: 1 if item.name == 'Small Key (Hyrule Castle)' and
-                                  item.player in standard_keyshuffle_players else 0)
-
     world.random.shuffle(fill_locations)
+    call_all(world, "fill_hook", progitempool, nonexcludeditempool, localrestitempool, nonlocalrestitempool, restitempool, fill_locations)
+
     fill_restrictive(world, world.state, fill_locations, progitempool)
 
     if nonexcludeditempool:
@@ -162,15 +121,20 @@ def distribute_items_restrictive(world: MultiWorld, gftower_trash=False, fill_lo
                 world.push_item(spot_to_fill, item_to_place, False)
                 fill_locations.remove(spot_to_fill)
 
+    for item_to_place in nonlocalrestitempool:
+        for i, location in enumerate(fill_locations):
+            if location.player != item_to_place.player:
+                world.push_item(fill_locations.pop(i), item_to_place, False)
+                break
+        else:
+            logging.warning(f"Could not place non_local_item {item_to_place} among {fill_locations}, tossing.")
+
     world.random.shuffle(fill_locations)
 
     restitempool, fill_locations = fast_fill(world, restitempool, fill_locations)
-    unplaced = [item for item in progitempool + restitempool]
+    unplaced = progitempool + restitempool
     unfilled = [location.name for location in fill_locations]
 
-    for location in fill_locations:
-        world.push_item(location, ItemFactory('Nothing', location.player), False)
-
     if unplaced or unfilled:
         logging.warning(f'Unplaced items({len(unplaced)}): {unplaced} - Unfilled Locations({len(unfilled)}): {unfilled}')
 
@@ -232,7 +196,7 @@ def flood_items(world: MultiWorld):
         location_list = world.get_reachable_locations()
         world.random.shuffle(location_list)
         for location in location_list:
-            if location.item is not None and not location.item.advancement and not location.item.smallkey and not location.item.bigkey:
+            if location.item is not None and not location.item.advancement:
                 # safe to replace
                 replace_item = location.item
                 replace_item.location = None
@@ -373,6 +337,8 @@ def swap_location_item(location_1: Location, location_2: Location, check_locked=
 
 
 def distribute_planned(world: MultiWorld):
+    # TODO: remove. Preferably by implementing key drop
+    from worlds.alttp.Regions import key_drop_data
     world_name_lookup = world.world_name_lookup
 
     for player in world.player_ids:
@@ -383,7 +349,7 @@ def distribute_planned(world: MultiWorld):
                     placement.warn(
                         f"Can't place '{placement.item}' at '{placement.location}', as key drop shuffle locations are not supported yet.")
                     continue
-                item = ItemFactory(placement.item, player)
+                item = world.worlds[player].create_item(placement.item)
                 target_world: int = placement.world
                 if target_world is False or world.players == 1:
                     target_world = player  # in own world
@@ -444,4 +410,4 @@ def distribute_planned(world: MultiWorld):
                     except ValueError:
                         placement.warn(f"Could not remove {item} from pool as it's already missing from it.")
         except Exception as e:
-            raise Exception(f"Error running plando for player {player} ({world.player_names[player]})") from e
+            raise Exception(f"Error running plando for player {player} ({world.player_name[player]})") from e

Generate.py

@@ -17,12 +17,10 @@ from worlds.generic import PlandoItem, PlandoConnection
 from Utils import parse_yaml, version_tuple, __version__, tuplize_version, get_options
 from worlds.alttp.EntranceRandomizer import parse_arguments
 from Main import main as ERmain
-from Main import get_seed, seeddigits
+from BaseClasses import seeddigits, get_seed
 import Options
-from worlds.alttp.Items import item_name_groups, item_table
 from worlds.alttp import Bosses
 from worlds.alttp.Text import TextTable
-from worlds.alttp.Regions import location_table, key_drop_data
 from worlds.AutoWorld import AutoWorldRegister
 
 categories = set(AutoWorldRegister.world_types)
@@ -40,7 +38,6 @@ def mystery_argparse():
                         help="Input directory for player files.")
     parser.add_argument('--seed', help='Define seed number to generate.', type=int)
     parser.add_argument('--multi', default=defaults["players"], type=lambda value: min(max(int(value), 1), 255))
-    parser.add_argument('--teams', default=1, type=lambda value: max(int(value), 1))
     parser.add_argument('--spoiler', type=int, default=defaults["spoiler"])
     parser.add_argument('--rom', default=options["lttp_options"]["rom_file"], help="Path to the 1.0 JP LttP Baserom.")
     parser.add_argument('--enemizercli', default=defaults["enemizer_path"])
@@ -114,21 +111,19 @@ def main(args=None, callback=ERmain):
                 player_id += 1
 
     args.multi = max(player_id-1, args.multi)
-    print(f"Generating for {args.multi} player{'s' if args.multi > 1 else ''}, {seed_name} Seed {seed}")
+    print(f"Generating for {args.multi} player{'s' if args.multi > 1 else ''}, {seed_name} Seed {seed} with plando: "
+          f"{', '.join(args.plando)}")
 
     if not weights_cache:
         raise Exception(f"No weights found. Provide a general weights file ({args.weights_file_path}) or individual player files. "
                         f"A mix is also permitted.")
     erargs = parse_arguments(['--multi', str(args.multi)])
     erargs.seed = seed
-    erargs.name = {x: "" for x in range(1, args.multi + 1)}  # only so it can be overwrittin in mystery
-    erargs.create_spoiler = args.spoiler > 0
     erargs.glitch_triforce = options["generator"]["glitch_triforce_room"]
+    erargs.spoiler = args.spoiler
     erargs.race = args.race
-    erargs.skip_playthrough = args.spoiler < 2
     erargs.outputname = seed_name
     erargs.outputpath = args.outputpath
-    erargs.teams = args.teams
 
     # set up logger
     if args.log_level:
@@ -179,6 +174,8 @@ def main(args=None, callback=ERmain):
                             getattr(erargs, k)[player] = v
                         except AttributeError:
                             setattr(erargs, k, {player: v})
+                        except Exception as e:
+                            raise Exception(f"Error setting {k} to {v} for player {player}") from e
             except Exception as e:
                 raise ValueError(f"File {path} is destroyed. Please fix your yaml.") from e
         else:
@@ -189,8 +186,9 @@ def main(args=None, callback=ERmain):
             erargs.name[player] = os.path.splitext(os.path.split(path)[-1])[0]
         erargs.name[player] = handle_name(erargs.name[player], player, name_counter)
 
-    erargs.names = ",".join(erargs.name[i] for i in range(1, args.multi + 1))
-    del (erargs.name)
+    if len(set(erargs.name.values())) != len(erargs.name):
+        raise Exception(f"Names have to be unique. Names: {erargs.name}")
+
     if args.yaml_output:
         import yaml
         important = {}
@@ -239,7 +237,7 @@ def convert_to_on_off(value):
     return {True: "on", False: "off"}.get(value, value)
 
 
-def get_choice(option, root, value=None) -> typing.Any:
+def get_choice_legacy(option, root, value=None) -> typing.Any:
     if option not in root:
         return value
     if type(root[option]) is list:
@@ -254,6 +252,20 @@ def get_choice(option, root, value=None) -> typing.Any:
     raise RuntimeError(f"All options specified in \"{option}\" are weighted as zero.")
 
 
+def get_choice(option, root, value=None) -> typing.Any:
+    if option not in root:
+        return value
+    if type(root[option]) is list:
+        return random.choices(root[option])[0]
+    if type(root[option]) is not dict:
+        return root[option]
+    if not root[option]:
+        return value
+    if any(root[option].values()):
+        return random.choices(list(root[option].keys()), weights=list(map(int, root[option].values())))[0]
+    raise RuntimeError(f"All options specified in \"{option}\" are weighted as zero.")
+
+
 class SafeDict(dict):
     def __missing__(self, key):
         return '{' + key + '}'
@@ -267,7 +279,7 @@ def handle_name(name: str, player: int, name_counter: Counter):
                                                                                                    name] > 1 else ''),
                                                                  player=player,
                                                                  PLAYER=(player if player > 1 else '')))
-    new_name = new_name.strip().replace(' ', '_')[:16]
+    new_name = new_name.strip()[:16]
     if new_name == "Archipelago":
         raise Exception(f"You cannot name yourself \"{new_name}\"")
     return new_name
@@ -412,6 +424,32 @@ def get_plando_bosses(boss_shuffle: str, plando_options: typing.Set[str]) -> str
         raise Exception(f"Boss Shuffle {boss_shuffle} is unknown and boss plando is turned off.")
 
 
+def handle_option(ret: argparse.Namespace, game_weights: dict, option_key: str, option: type(Options.Option)):
+    if option_key in game_weights:
+        try:
+            if not option.supports_weighting:
+                player_option = option.from_any(game_weights[option_key])
+            else:
+                player_option = option.from_any(get_choice(option_key, game_weights))
+            setattr(ret, option_key, player_option)
+        except Exception as e:
+            raise Exception(f"Error generating option {option_key} in {ret.game}") from e
+        else:
+            # verify item names existing
+            if getattr(player_option, "verify_item_name", False):
+                for item_name in player_option.value:
+                    if item_name not in AutoWorldRegister.world_types[ret.game].item_names:
+                        raise Exception(f"Item {item_name} from option {player_option} "
+                                        f"is not a valid item name from {ret.game}")
+            elif getattr(player_option, "verify_location_name", False):
+                for location_name in player_option.value:
+                    if location_name not in AutoWorldRegister.world_types[ret.game].location_names:
+                        raise Exception(f"Location {location_name} from option {player_option} "
+                                        f"is not a valid location name from {ret.game}")
+    else:
+        setattr(ret, option_key, option(option.default))
+
+
 def roll_settings(weights: dict, plando_options: typing.Set[str] = frozenset(("bosses",))):
     if "linked_options" in weights:
         weights = roll_linked_options(weights)
@@ -438,63 +476,26 @@ def roll_settings(weights: dict, plando_options: typing.Set[str] = frozenset(("b
                                     f"which are not enabled.")
 
     ret = argparse.Namespace()
+    for option_key in Options.per_game_common_options:
+        if option_key in weights:
+            raise Exception(f"Option {option_key} has to be in a game's section, not on its own.")
+
     ret.name = get_choice('name', weights)
-    ret.accessibility = get_choice('accessibility', weights)
-    ret.progression_balancing = get_choice('progression_balancing', weights, True)
+    for option_key, option in Options.common_options.items():
+        setattr(ret, option_key, option.from_any(get_choice(option_key, weights, option.default)))
     ret.game = get_choice("game", weights)
     if ret.game not in weights:
         raise Exception(f"No game options for selected game \"{ret.game}\" found.")
     world_type = AutoWorldRegister.world_types[ret.game]
     game_weights = weights[ret.game]
-    ret.local_items = set()
-    for item_name in game_weights.get('local_items', []):
-        items = world_type.item_name_groups.get(item_name, {item_name})
-        for item in items:
-            if item in world_type.item_names:
-                ret.local_items.add(item)
-            else:
-                raise Exception(f"Could not force item {item} to be world-local, as it was not recognized.")
-
-    ret.non_local_items = set()
-    for item_name in game_weights.get('non_local_items', []):
-        items = world_type.item_name_groups.get(item_name, {item_name})
-        for item in items:
-            if item in world_type.item_names:
-                ret.non_local_items.add(item)
-            else:
-                raise Exception(f"Could not force item {item} to be world-non-local, as it was not recognized.")
-
-    inventoryweights = game_weights.get('start_inventory', {})
-    startitems = []
-    for item in inventoryweights.keys():
-        itemvalue = get_choice(item, inventoryweights)
-        if isinstance(itemvalue, int):
-            for i in range(int(itemvalue)):
-                startitems.append(item)
-        elif itemvalue:
-            startitems.append(item)
-    ret.startinventory = startitems
-    ret.start_hints = set(game_weights.get('start_hints', []))
-
-    ret.excluded_locations = set()
-    for location in game_weights.get('exclude_locations', []):
-        if location in world_type.location_names: 
-            ret.excluded_locations.add(location)
-        else:
-            raise Exception(f"Could not exclude location {location}, as it was not recognized.")
 
     if ret.game in AutoWorldRegister.world_types:
-        for option_name, option in AutoWorldRegister.world_types[ret.game].options.items():
-            if option_name in game_weights:
-                try:
-                    if issubclass(option, Options.OptionDict):
-                        setattr(ret, option_name, option.from_any(game_weights[option_name]))
-                    else:
-                        setattr(ret, option_name, option.from_any(get_choice(option_name, game_weights)))
-                except Exception as e:
-                    raise Exception(f"Error generating option {option_name} in {ret.game}") from e
-            else:
-                setattr(ret, option_name, option(option.default))
+        for option_key, option in world_type.options.items():
+            handle_option(ret, game_weights, option_key, option)
+        for option_key, option in Options.per_game_common_options.items():
+            handle_option(ret, game_weights, option_key, option)
+        if "items" in plando_options:
+            ret.plando_items = roll_item_plando(world_type, game_weights)
         if ret.game == "Minecraft":
             # bad hardcoded behavior to make this work for now
             ret.plando_connections = []
@@ -514,8 +515,48 @@ def roll_settings(weights: dict, plando_options: typing.Set[str] = frozenset(("b
     return ret
 
 
+def roll_item_plando(world_type, weights):
+    plando_items = []
+
+    def add_plando_item(item: str, location: str):
+        if item not in world_type.item_name_to_id:
+            raise Exception(f"Could not plando item {item} as the item was not recognized")
+        if location not in world_type.location_name_to_id:
+            raise Exception(
+                f"Could not plando item {item} at location {location} as the location was not recognized")
+        plando_items.append(PlandoItem(item, location, location_world, from_pool, force))
+
+    options = weights.get("plando_items", [])
+    for placement in options:
+        if roll_percentage(get_choice_legacy("percentage", placement, 100)):
+            from_pool = get_choice_legacy("from_pool", placement, PlandoItem._field_defaults["from_pool"])
+            location_world = get_choice_legacy("world", placement, PlandoItem._field_defaults["world"])
+            force = str(get_choice_legacy("force", placement, PlandoItem._field_defaults["force"])).lower()
+            if "items" in placement and "locations" in placement:
+                items = placement["items"]
+                locations = placement["locations"]
+                if isinstance(items, dict):
+                    item_list = []
+                    for key, value in items.items():
+                        item_list += [key] * value
+                    items = item_list
+                if not items or not locations:
+                    raise Exception("You must specify at least one item and one location to place items.")
+                random.shuffle(items)
+                random.shuffle(locations)
+                for item, location in zip(items, locations):
+                    add_plando_item(item, location)
+            else:
+                item = get_choice_legacy("item", placement, get_choice_legacy("items", placement))
+                location = get_choice_legacy("location", placement)
+                add_plando_item(item, location)
+    return plando_items
+
+
 def roll_alttp_settings(ret: argparse.Namespace, weights, plando_options):
-    glitches_required = get_choice('glitches_required', weights)
+    if "dungeon_items" in weights and get_choice_legacy('dungeon_items', weights, "none") != "none":
+        raise Exception(f"dungeon_items key in A Link to the Past was removed, but is present in these weights as {get_choice_legacy('dungeon_items', weights, False)}.")
+    glitches_required = get_choice_legacy('glitches_required', weights)
     if glitches_required not in [None, 'none', 'no_logic', 'overworld_glitches', 'hybrid_major_glitches', 'minor_glitches']:
         logging.warning("Only NMG, OWG, HMG and No Logic supported")
         glitches_required = 'none'
@@ -523,7 +564,7 @@ def roll_alttp_settings(ret: argparse.Namespace, weights, plando_options):
                  'minor_glitches': 'minorglitches', 'hybrid_major_glitches': 'hybridglitches'}[
         glitches_required]
 
-    ret.dark_room_logic = get_choice("dark_room_logic", weights, "lamp")
+    ret.dark_room_logic = get_choice_legacy("dark_room_logic", weights, "lamp")
     if not ret.dark_room_logic:  # None/False
         ret.dark_room_logic = "none"
     if ret.dark_room_logic == "sconces":
@@ -531,93 +572,63 @@ def roll_alttp_settings(ret: argparse.Namespace, weights, plando_options):
     if ret.dark_room_logic not in {"lamp", "torches", "none"}:
         raise ValueError(f"Unknown Dark Room Logic: \"{ret.dark_room_logic}\"")
 
-    ret.restrict_dungeon_item_on_boss = get_choice('restrict_dungeon_item_on_boss', weights, False)
-
-    dungeon_items = get_choice('dungeon_items', weights)
-    if dungeon_items == 'full' or dungeon_items == True:
-        dungeon_items = 'mcsb'
-    elif dungeon_items == 'standard':
-        dungeon_items = ""
-    elif not dungeon_items:
-        dungeon_items = ""
-    if "u" in dungeon_items:
-        dungeon_items.replace("s", "")
-
-    ret.mapshuffle = get_choice('map_shuffle', weights, 'm' in dungeon_items)
-    ret.compassshuffle = get_choice('compass_shuffle', weights, 'c' in dungeon_items)
-    ret.keyshuffle = get_choice('smallkey_shuffle', weights,
-                                'universal' if 'u' in dungeon_items else 's' in dungeon_items)
-    ret.bigkeyshuffle = get_choice('bigkey_shuffle', weights, 'b' in dungeon_items)
-
-    entrance_shuffle = get_choice('entrance_shuffle', weights, 'vanilla')
+    entrance_shuffle = get_choice_legacy('entrance_shuffle', weights, 'vanilla')
     if entrance_shuffle.startswith('none-'):
         ret.shuffle = 'vanilla'
     else:
         ret.shuffle = entrance_shuffle if entrance_shuffle != 'none' else 'vanilla'
 
-    goal = get_choice('goals', weights, 'ganon')
+    goal = get_choice_legacy('goals', weights, 'ganon')
 
     ret.goal = goals[goal]
 
     # TODO consider moving open_pyramid to an automatic variable in the core roller, set to True when
     # fast ganon + ganon at hole
-    ret.open_pyramid = get_choice('open_pyramid', weights, 'goal')
+    ret.open_pyramid = get_choice_legacy('open_pyramid', weights, 'goal')
 
-    extra_pieces = get_choice('triforce_pieces_mode', weights, 'available')
+    extra_pieces = get_choice_legacy('triforce_pieces_mode', weights, 'available')
 
-    ret.triforce_pieces_required = LttPOptions.TriforcePieces.from_any(get_choice('triforce_pieces_required', weights, 20))
+    ret.triforce_pieces_required = LttPOptions.TriforcePieces.from_any(get_choice_legacy('triforce_pieces_required', weights, 20))
 
     # sum a percentage to required
     if extra_pieces == 'percentage':
-        percentage = max(100, float(get_choice('triforce_pieces_percentage', weights, 150))) / 100
+        percentage = max(100, float(get_choice_legacy('triforce_pieces_percentage', weights, 150))) / 100
         ret.triforce_pieces_available = int(round(ret.triforce_pieces_required * percentage, 0))
     # vanilla mode (specify how many pieces are)
     elif extra_pieces == 'available':
         ret.triforce_pieces_available = LttPOptions.TriforcePieces.from_any(
-            get_choice('triforce_pieces_available', weights, 30))
+            get_choice_legacy('triforce_pieces_available', weights, 30))
     # required pieces + fixed extra
     elif extra_pieces == 'extra':
-        extra_pieces = max(0, int(get_choice('triforce_pieces_extra', weights, 10)))
+        extra_pieces = max(0, int(get_choice_legacy('triforce_pieces_extra', weights, 10)))
         ret.triforce_pieces_available = ret.triforce_pieces_required + extra_pieces
 
     # change minimum to required pieces to avoid problems
     ret.triforce_pieces_available = min(max(ret.triforce_pieces_required, int(ret.triforce_pieces_available)), 90)
 
-    ret.shop_shuffle = get_choice('shop_shuffle', weights, '')
+    ret.shop_shuffle = get_choice_legacy('shop_shuffle', weights, '')
     if not ret.shop_shuffle:
         ret.shop_shuffle = ''
 
-    ret.mode = get_choice("mode", weights)
-    ret.retro = get_choice("retro", weights)
+    ret.mode = get_choice_legacy("mode", weights)
 
-    ret.hints = get_choice('hints', weights)
+    ret.difficulty = get_choice_legacy('item_pool', weights)
 
-    ret.swordless = get_choice('swordless', weights, False)
+    ret.item_functionality = get_choice_legacy('item_functionality', weights)
 
-    ret.difficulty = get_choice('item_pool', weights)
-
-    ret.item_functionality = get_choice('item_functionality', weights)
-
-    boss_shuffle = get_choice('boss_shuffle', weights)
+    boss_shuffle = get_choice_legacy('boss_shuffle', weights)
     ret.shufflebosses = get_plando_bosses(boss_shuffle, plando_options)
 
-    ret.enemy_shuffle = bool(get_choice('enemy_shuffle', weights, False))
-
-    ret.killable_thieves = get_choice('killable_thieves', weights, False)
-    ret.tile_shuffle = get_choice('tile_shuffle', weights, False)
-    ret.bush_shuffle = get_choice('bush_shuffle', weights, False)
-
     ret.enemy_damage = {None: 'default',
                         'default': 'default',
                         'shuffled': 'shuffled',
-                        'random': 'chaos'
-                        }[get_choice('enemy_damage', weights)]
+                        'random': 'chaos', # to be removed
+                        'chaos': 'chaos',
+                        }[get_choice_legacy('enemy_damage', weights)]
 
-    ret.enemy_health = get_choice('enemy_health', weights)
+    ret.enemy_health = get_choice_legacy('enemy_health', weights)
 
-    ret.shufflepots = get_choice('pot_shuffle', weights)
-
-    ret.beemizer = int(get_choice('beemizer', weights, 0))
+    ret.beemizer = int(get_choice_legacy('beemizer', weights, 0))
 
     ret.timer = {'none': False,
                  None: False,
@@ -626,21 +637,19 @@ def roll_alttp_settings(ret: argparse.Namespace, weights, plando_options):
                  'timed_ohko': 'timed-ohko',
                  'ohko': 'ohko',
                  'timed_countdown': 'timed-countdown',
-                 'display': 'display'}[get_choice('timer', weights, False)]
+                 'display': 'display'}[get_choice_legacy('timer', weights, False)]
 
-    ret.countdown_start_time = int(get_choice('countdown_start_time', weights, 10))
-    ret.red_clock_time = int(get_choice('red_clock_time', weights, -2))
-    ret.blue_clock_time = int(get_choice('blue_clock_time', weights, 2))
-    ret.green_clock_time = int(get_choice('green_clock_time', weights, 4))
+    ret.countdown_start_time = int(get_choice_legacy('countdown_start_time', weights, 10))
+    ret.red_clock_time = int(get_choice_legacy('red_clock_time', weights, -2))
+    ret.blue_clock_time = int(get_choice_legacy('blue_clock_time', weights, 2))
+    ret.green_clock_time = int(get_choice_legacy('green_clock_time', weights, 4))
 
-    ret.dungeon_counters = get_choice('dungeon_counters', weights, 'default')
+    ret.dungeon_counters = get_choice_legacy('dungeon_counters', weights, 'default')
 
-    ret.progressive = convert_to_on_off(get_choice('progressive', weights, 'on'))
+    ret.shuffle_prizes = get_choice_legacy('shuffle_prizes', weights, "g")
 
-    ret.shuffle_prizes = get_choice('shuffle_prizes', weights, "g")
-
-    ret.required_medallions = [get_choice("misery_mire_medallion", weights, "random"),
-                               get_choice("turtle_rock_medallion", weights, "random")]
+    ret.required_medallions = [get_choice_legacy("misery_mire_medallion", weights, "random"),
+                               get_choice_legacy("turtle_rock_medallion", weights, "random")]
 
     for index, medallion in enumerate(ret.required_medallions):
         ret.required_medallions[index] = {"ether": "Ether", "quake": "Quake", "bombos": "Bombos", "random": "random"} \
@@ -648,88 +657,45 @@ def roll_alttp_settings(ret: argparse.Namespace, weights, plando_options):
         if not ret.required_medallions[index]:
             raise Exception(f"unknown Medallion {medallion} for {'misery mire' if index == 0 else 'turtle rock'}")
 
-    ret.glitch_boots = get_choice('glitch_boots', weights, True)
-
-    if get_choice("local_keys", weights, "l" in dungeon_items):
-        # () important for ordering of commands, without them the Big Keys section is part of the Small Key else
-        ret.local_items |= item_name_groups["Small Keys"] if ret.keyshuffle else set()
-        ret.local_items |= item_name_groups["Big Keys"] if ret.bigkeyshuffle else set()
-
-    ret.plando_items = []
-    if "items" in plando_options:
-
-        def add_plando_item(item: str, location: str):
-            if item not in item_table:
-                raise Exception(f"Could not plando item {item} as the item was not recognized")
-            if location not in location_table and location not in key_drop_data:
-                raise Exception(
-                    f"Could not plando item {item} at location {location} as the location was not recognized")
-            ret.plando_items.append(PlandoItem(item, location, location_world, from_pool, force))
-
-        options = weights.get("plando_items", [])
-        for placement in options:
-            if roll_percentage(get_choice("percentage", placement, 100)):
-                from_pool = get_choice("from_pool", placement, PlandoItem._field_defaults["from_pool"])
-                location_world = get_choice("world", placement, PlandoItem._field_defaults["world"])
-                force = str(get_choice("force", placement, PlandoItem._field_defaults["force"])).lower()
-                if "items" in placement and "locations" in placement:
-                    items = placement["items"]
-                    locations = placement["locations"]
-                    if isinstance(items, dict):
-                        item_list = []
-                        for key, value in items.items():
-                            item_list += [key] * value
-                        items = item_list
-                    if not items or not locations:
-                        raise Exception("You must specify at least one item and one location to place items.")
-                    random.shuffle(items)
-                    random.shuffle(locations)
-                    for item, location in zip(items, locations):
-                        add_plando_item(item, location)
-                else:
-                    item = get_choice("item", placement, get_choice("items", placement))
-                    location = get_choice("location", placement)
-                    add_plando_item(item, location)
-
     ret.plando_texts = {}
     if "texts" in plando_options:
         tt = TextTable()
         tt.removeUnwantedText()
         options = weights.get("plando_texts", [])
         for placement in options:
-            if roll_percentage(get_choice("percentage", placement, 100)):
-                at = str(get_choice("at", placement))
+            if roll_percentage(get_choice_legacy("percentage", placement, 100)):
+                at = str(get_choice_legacy("at", placement))
                 if at not in tt:
                     raise Exception(f"No text target \"{at}\" found.")
-                ret.plando_texts[at] = str(get_choice("text", placement))
+                ret.plando_texts[at] = str(get_choice_legacy("text", placement))
 
     ret.plando_connections = []
     if "connections" in plando_options:
         options = weights.get("plando_connections", [])
         for placement in options:
-            if roll_percentage(get_choice("percentage", placement, 100)):
+            if roll_percentage(get_choice_legacy("percentage", placement, 100)):
                 ret.plando_connections.append(PlandoConnection(
-                    get_choice("entrance", placement),
-                    get_choice("exit", placement),
-                    get_choice("direction", placement, "both")
+                    get_choice_legacy("entrance", placement),
+                    get_choice_legacy("exit", placement),
+                    get_choice_legacy("direction", placement, "both")
                 ))
 
     ret.sprite_pool = weights.get('sprite_pool', [])
-    ret.sprite = get_choice('sprite', weights, "Link")
+    ret.sprite = get_choice_legacy('sprite', weights, "Link")
     if 'random_sprite_on_event' in weights:
         randomoneventweights = weights['random_sprite_on_event']
-        if get_choice('enabled', randomoneventweights, False):
+        if get_choice_legacy('enabled', randomoneventweights, False):
             ret.sprite = 'randomon'
-            ret.sprite += '-hit' if get_choice('on_hit', randomoneventweights, True) else ''
-            ret.sprite += '-enter' if get_choice('on_enter', randomoneventweights, False) else ''
-            ret.sprite += '-exit' if get_choice('on_exit', randomoneventweights, False) else ''
-            ret.sprite += '-slash' if get_choice('on_slash', randomoneventweights, False) else ''
-            ret.sprite += '-item' if get_choice('on_item', randomoneventweights, False) else ''
-            ret.sprite += '-bonk' if get_choice('on_bonk', randomoneventweights, False) else ''
-            ret.sprite = 'randomonall' if get_choice('on_everything', randomoneventweights, False) else ret.sprite
+            ret.sprite += '-hit' if get_choice_legacy('on_hit', randomoneventweights, True) else ''
+            ret.sprite += '-enter' if get_choice_legacy('on_enter', randomoneventweights, False) else ''
+            ret.sprite += '-exit' if get_choice_legacy('on_exit', randomoneventweights, False) else ''
+            ret.sprite += '-slash' if get_choice_legacy('on_slash', randomoneventweights, False) else ''
+            ret.sprite += '-item' if get_choice_legacy('on_item', randomoneventweights, False) else ''
+            ret.sprite += '-bonk' if get_choice_legacy('on_bonk', randomoneventweights, False) else ''
+            ret.sprite = 'randomonall' if get_choice_legacy('on_everything', randomoneventweights, False) else ret.sprite
             ret.sprite = 'randomonnone' if ret.sprite == 'randomon' else ret.sprite
 
-            if (not ret.sprite_pool or get_choice('use_weighted_sprite_pool', randomoneventweights, False)) \
+            if (not ret.sprite_pool or get_choice_legacy('use_weighted_sprite_pool', randomoneventweights, False)) \
                     and 'sprite' in weights:  # Use sprite as a weighted sprite pool, if a sprite pool is not already defined.
                 for key, value in weights['sprite'].items():
                     if key.startswith('random'):
@@ -737,20 +703,10 @@ def roll_alttp_settings(ret: argparse.Namespace, weights, plando_options):
                     else:
                         ret.sprite_pool += [key] * int(value)
 
-    ret.disablemusic = get_choice('disablemusic', weights, False)
-    ret.triforcehud = get_choice('triforcehud', weights, 'hide_goal')
-    ret.quickswap = get_choice('quickswap', weights, True)
-    ret.fastmenu = get_choice('menuspeed', weights, "normal")
-    ret.reduceflashing = get_choice('reduceflashing', weights, False)
-    ret.heartcolor = get_choice('heartcolor', weights, "red")
-    ret.heartbeep = convert_to_on_off(get_choice('heartbeep', weights, "normal"))
-    ret.ow_palettes = get_choice('ow_palettes', weights, "default")
-    ret.uw_palettes = get_choice('uw_palettes', weights, "default")
-    ret.hud_palettes = get_choice('hud_palettes', weights, "default")
-    ret.sword_palettes = get_choice('sword_palettes', weights, "default")
-    ret.shield_palettes = get_choice('shield_palettes', weights, "default")
-    ret.link_palettes = get_choice('link_palettes', weights, "default")
-
 
 if __name__ == '__main__':
+    import atexit
+    confirmation = atexit.register(input, "Press enter to close.")
     main()
+    # in case of error-free exit should not need confirmation
+    atexit.unregister(confirmation)

LttPAdjuster.py

@@ -19,7 +19,7 @@ from tkinter import Tk, Frame, Label, StringVar, Entry, filedialog, messagebox,
 from urllib.parse import urlparse
 from urllib.request import urlopen
 
-from worlds.alttp.Rom import Sprite, LocalRom, apply_rom_settings
+from worlds.alttp.Rom import Sprite, LocalRom, apply_rom_settings, get_base_rom_bytes
 from Utils import output_path, local_path, open_file
 
 
@@ -44,7 +44,7 @@ def main():
                         help='Path to an ALttP JAP(1.0) rom to use as a base.')
     parser.add_argument('--loglevel', default='info', const='info', nargs='?',
                         choices=['error', 'info', 'warning', 'debug'], help='Select level of logging for output.')
-    parser.add_argument('--fastmenu', default='normal', const='normal', nargs='?',
+    parser.add_argument('--menuspeed', default='normal', const='normal', nargs='?',
                         choices=['normal', 'instant', 'double', 'triple', 'quadruple', 'half'],
                         help='''\
                              Select the rate at which the menu opens and closes.
@@ -100,6 +100,7 @@ def main():
     parser.add_argument('--names', default='', type=str)
     parser.add_argument('--update_sprites', action='store_true', help='Update Sprite Database, then exit.')
     args = parser.parse_args()
+    args.music = not args.disablemusic
     if args.update_sprites:
         run_sprite_update()
         sys.exit()
@@ -150,7 +151,7 @@ def adjust(args):
     if hasattr(args, "world"):
         world = getattr(args, "world")
 
-    apply_rom_settings(rom, args.heartbeep, args.heartcolor, args.quickswap, args.fastmenu, args.disablemusic,
+    apply_rom_settings(rom, args.heartbeep, args.heartcolor, args.quickswap, args.menuspeed, args.music,
                        args.sprite, palettes_options, reduceflashing=args.reduceflashing or racerom, world=world)
     path = output_path(f'{os.path.basename(args.rom)[:-4]}_adjusted.sfc')
     rom.write_to_file(path)
@@ -195,14 +196,14 @@ def adjustGUI():
         guiargs = Namespace()
         guiargs.heartbeep = rom_vars.heartbeepVar.get()
         guiargs.heartcolor = rom_vars.heartcolorVar.get()
-        guiargs.fastmenu = rom_vars.fastMenuVar.get()
+        guiargs.menuspeed = rom_vars.menuspeedVar.get()
         guiargs.ow_palettes = rom_vars.owPalettesVar.get()
         guiargs.uw_palettes = rom_vars.uwPalettesVar.get()
         guiargs.hud_palettes = rom_vars.hudPalettesVar.get()
         guiargs.sword_palettes = rom_vars.swordPalettesVar.get()
         guiargs.shield_palettes = rom_vars.shieldPalettesVar.get()
         guiargs.quickswap = bool(rom_vars.quickSwapVar.get())
-        guiargs.disablemusic = bool(rom_vars.disableMusicVar.get())
+        guiargs.music = bool(rom_vars.MusicVar.get())
         guiargs.reduceflashing = bool(rom_vars.disableFlashingVar.get())
         guiargs.rom = romVar2.get()
         guiargs.baserom = romVar.get()
@@ -221,7 +222,6 @@ def adjustGUI():
         else:
             messagebox.showinfo(title="Success", message=f"Rom patched successfully to {path}")
             from Utils import persistent_store
-            from worlds.alttp.Rom import Sprite
             if isinstance(guiargs.sprite, Sprite):
                 guiargs.sprite = guiargs.sprite.name
             persistent_store("adjuster", "last_settings_3", guiargs)
@@ -411,9 +411,8 @@ def get_rom_frame(parent=None):
 
     def RomSelect():
         rom = filedialog.askopenfilename(filetypes=[("Rom Files", (".sfc", ".smc")), ("All Files", "*")])
-        import Patch
         try:
-            Patch.get_base_rom_bytes(rom)  # throws error on checksum fail
+            get_base_rom_bytes(rom)  # throws error on checksum fail
         except Exception as e:
             logging.exception(e)
             messagebox.showerror(title="Error while reading ROM", message=str(e))
@@ -439,9 +438,10 @@ def get_rom_options_frame(parent=None):
         romOptionsFrame.rowconfigure(i, weight=1)
     vars = Namespace()
 
-    vars.disableMusicVar = IntVar()
-    disableMusicCheckbutton = Checkbutton(romOptionsFrame, text="Disable music", variable=vars.disableMusicVar)
-    disableMusicCheckbutton.grid(row=0, column=0, sticky=E)
+    vars.MusicVar = IntVar()
+    vars.MusicVar.set(1)
+    MusicCheckbutton = Checkbutton(romOptionsFrame, text="Music", variable=vars.MusicVar)
+    MusicCheckbutton.grid(row=0, column=0, sticky=E)
 
     vars.disableFlashingVar = IntVar(value=1)
     disableFlashingCheckbutton = Checkbutton(romOptionsFrame, text="Disable flashing (anti-epilepsy)", variable=vars.disableFlashingVar)
@@ -485,14 +485,14 @@ def get_rom_options_frame(parent=None):
     quickSwapCheckbutton = Checkbutton(romOptionsFrame, text="L/R Quickswapping", variable=vars.quickSwapVar)
     quickSwapCheckbutton.grid(row=1, column=0, sticky=E)
 
-    fastMenuFrame = Frame(romOptionsFrame)
-    fastMenuFrame.grid(row=1, column=1, sticky=E)
-    fastMenuLabel = Label(fastMenuFrame, text='Menu speed')
-    fastMenuLabel.pack(side=LEFT)
-    vars.fastMenuVar = StringVar()
-    vars.fastMenuVar.set('normal')
-    fastMenuOptionMenu = OptionMenu(fastMenuFrame, vars.fastMenuVar, 'normal', 'instant', 'double', 'triple', 'quadruple', 'half')
-    fastMenuOptionMenu.pack(side=LEFT)
+    menuspeedFrame = Frame(romOptionsFrame)
+    menuspeedFrame.grid(row=1, column=1, sticky=E)
+    menuspeedLabel = Label(menuspeedFrame, text='Menu speed')
+    menuspeedLabel.pack(side=LEFT)
+    vars.menuspeedVar = StringVar()
+    vars.menuspeedVar.set('normal')
+    menuspeedOptionMenu = OptionMenu(menuspeedFrame, vars.menuspeedVar, 'normal', 'instant', 'double', 'triple', 'quadruple', 'half')
+    menuspeedOptionMenu.pack(side=LEFT)
 
     heartcolorFrame = Frame(romOptionsFrame)
     heartcolorFrame.grid(row=2, column=0, sticky=E)
@@ -518,7 +518,7 @@ def get_rom_options_frame(parent=None):
     owPalettesLabel.pack(side=LEFT)
     vars.owPalettesVar = StringVar()
     vars.owPalettesVar.set('default')
-    owPalettesOptionMenu = OptionMenu(owPalettesFrame, vars.owPalettesVar, 'default', 'random', 'blackout', 'grayscale', 'negative', 'classic', 'dizzy', 'sick', 'puke')
+    owPalettesOptionMenu = OptionMenu(owPalettesFrame, vars.owPalettesVar, 'default', 'good', 'blackout', 'grayscale', 'negative', 'classic', 'dizzy', 'sick', 'puke')
     owPalettesOptionMenu.pack(side=LEFT)
 
     uwPalettesFrame = Frame(romOptionsFrame)
@@ -527,7 +527,7 @@ def get_rom_options_frame(parent=None):
     uwPalettesLabel.pack(side=LEFT)
     vars.uwPalettesVar = StringVar()
     vars.uwPalettesVar.set('default')
-    uwPalettesOptionMenu = OptionMenu(uwPalettesFrame, vars.uwPalettesVar, 'default', 'random', 'blackout', 'grayscale', 'negative', 'classic', 'dizzy', 'sick', 'puke')
+    uwPalettesOptionMenu = OptionMenu(uwPalettesFrame, vars.uwPalettesVar, 'default', 'good', 'blackout', 'grayscale', 'negative', 'classic', 'dizzy', 'sick', 'puke')
     uwPalettesOptionMenu.pack(side=LEFT)
 
     hudPalettesFrame = Frame(romOptionsFrame)
@@ -536,7 +536,7 @@ def get_rom_options_frame(parent=None):
     hudPalettesLabel.pack(side=LEFT)
     vars.hudPalettesVar = StringVar()
     vars.hudPalettesVar.set('default')
-    hudPalettesOptionMenu = OptionMenu(hudPalettesFrame, vars.hudPalettesVar, 'default', 'random', 'blackout', 'grayscale', 'negative', 'classic', 'dizzy', 'sick', 'puke')
+    hudPalettesOptionMenu = OptionMenu(hudPalettesFrame, vars.hudPalettesVar, 'default', 'good', 'blackout', 'grayscale', 'negative', 'classic', 'dizzy', 'sick', 'puke')
     hudPalettesOptionMenu.pack(side=LEFT)
 
     swordPalettesFrame = Frame(romOptionsFrame)
@@ -545,7 +545,7 @@ def get_rom_options_frame(parent=None):
     swordPalettesLabel.pack(side=LEFT)
     vars.swordPalettesVar = StringVar()
     vars.swordPalettesVar.set('default')
-    swordPalettesOptionMenu = OptionMenu(swordPalettesFrame, vars.swordPalettesVar, 'default', 'random', 'blackout', 'grayscale', 'negative', 'classic', 'dizzy', 'sick', 'puke')
+    swordPalettesOptionMenu = OptionMenu(swordPalettesFrame, vars.swordPalettesVar, 'default', 'good', 'blackout', 'grayscale', 'negative', 'classic', 'dizzy', 'sick', 'puke')
     swordPalettesOptionMenu.pack(side=LEFT)
 
     shieldPalettesFrame = Frame(romOptionsFrame)
@@ -554,7 +554,7 @@ def get_rom_options_frame(parent=None):
     shieldPalettesLabel.pack(side=LEFT)
     vars.shieldPalettesVar = StringVar()
     vars.shieldPalettesVar.set('default')
-    shieldPalettesOptionMenu = OptionMenu(shieldPalettesFrame, vars.shieldPalettesVar, 'default', 'random', 'blackout', 'grayscale', 'negative', 'classic', 'dizzy', 'sick', 'puke')
+    shieldPalettesOptionMenu = OptionMenu(shieldPalettesFrame, vars.shieldPalettesVar, 'default', 'good', 'blackout', 'grayscale', 'negative', 'classic', 'dizzy', 'sick', 'puke')
     shieldPalettesOptionMenu.pack(side=LEFT)
 
     spritePoolFrame = Frame(romOptionsFrame)

LttPClient.py

@@ -1,16 +1,19 @@
 import argparse
 import atexit
+exit_func = atexit.register(input, "Press enter to close.")
+import threading
 import time
 import multiprocessing
 import os
 import subprocess
 import base64
 import shutil
+import logging
+import asyncio
 from json import loads, dumps
 
 from Utils import get_item_name_from_id
 
-exit_func = atexit.register(input, "Press enter to close.")
 
 import ModuleUpdate
 
@@ -23,12 +26,14 @@ from NetUtils import *
 from worlds.alttp import Regions, Shops
 from worlds.alttp import Items
 import Utils
-from CommonClient import CommonContext, server_loop, logger, console_loop, ClientCommandProcessor
+from CommonClient import CommonContext, server_loop, console_loop, ClientCommandProcessor, gui_enabled, init_logging
 
+init_logging("LttPClient")
+
+snes_logger = logging.getLogger("SNES")
 
 from MultiServer import mark_raw
 
-
 class LttPCommandProcessor(ClientCommandProcessor):
     def _cmd_slow_mode(self, toggle: str = ""):
         """Toggle slow mode, which limits how fast you send / receive items."""
@@ -40,10 +45,26 @@ class LttPCommandProcessor(ClientCommandProcessor):
         self.output(f"Setting slow mode to {self.ctx.slow_mode}")
 
     @mark_raw
-    def _cmd_snes(self, snes_address: str = "") -> bool:
-        """Connect to a snes. Optionally include network address of a snes to connect to, otherwise show available devices"""
+    def _cmd_snes(self, snes_options: str = "") -> bool:
+        """Connect to a snes. Optionally include network address of a snes to connect to, otherwise show available devices; and a SNES device number if more than one SNES is detected"""
+        
+        snes_address = self.ctx.snes_address
+        snes_device_number = -1
+        
+        options = snes_options.split()
+        num_options = len(options)
+        
+        if num_options > 0:
+            snes_address = options[0]
+            
+        if num_options > 1:
+            try:
+                snes_device_number = int(options[1])
+            except:
+                pass
+
         self.ctx.snes_reconnect_address = None
-        asyncio.create_task(snes_connect(self.ctx, snes_address if snes_address else self.ctx.snes_address))
+        asyncio.create_task(snes_connect(self.ctx, snes_address, snes_device_number))
         return True
 
     def _cmd_snes_close(self) -> bool:
@@ -71,6 +92,7 @@ class Context(CommonContext):
         self.snes_recv_queue = asyncio.Queue()
         self.snes_request_lock = asyncio.Lock()
         self.snes_write_buffer = []
+        self.snes_connector_lock = threading.Lock()
 
         self.awaiting_rom = False
         self.rom = None
@@ -91,7 +113,7 @@ class Context(CommonContext):
             await super(Context, self).server_auth(password_requested)
         if self.rom is None:
             self.awaiting_rom = True
-            logger.info(
+            snes_logger.info(
                 'No ROM detected, awaiting snes connection to authenticate to the multiworld server (/snes)')
             return
         self.awaiting_rom = False
@@ -420,19 +442,21 @@ def launch_sni(ctx: Context):
                 sni_path = os.path.join(sni_path, file)
 
     if os.path.isfile(sni_path):
-        logger.info(f"Attempting to start {sni_path}")
+        snes_logger.info(f"Attempting to start {sni_path}")
         import subprocess
-        subprocess.Popen(sni_path, cwd=os.path.dirname(sni_path), stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+        if Utils.is_frozen(): # if it spawns a visible console, may as well populate it
+            subprocess.Popen(sni_path, cwd=os.path.dirname(sni_path))
+        else:
+            subprocess.Popen(sni_path, cwd=os.path.dirname(sni_path), stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
     else:
-        logger.info(
+        snes_logger.info(
             f"Attempt to start SNI was aborted as path {sni_path} was not found, "
             f"please start it yourself if it is not running")
 
 
 async def _snes_connect(ctx: Context, address: str):
     address = f"ws://{address}" if "://" not in address else address
-
-    logger.info("Connecting to SNI at %s ..." % address)
+    snes_logger.info("Connecting to SNI at %s ..." % address)
     seen_problems = set()
     succesful = False
     while not succesful:
@@ -444,7 +468,7 @@ async def _snes_connect(ctx: Context, address: str):
             # only tell the user about new problems, otherwise silently lay in wait for a working connection
             if problem not in seen_problems:
                 seen_problems.add(problem)
-                logger.error(f"Error connecting to SNI ({problem})")
+                snes_logger.error(f"Error connecting to SNI ({problem})")
 
                 if len(seen_problems) == 1:
                     # this is the first problem. Let's try launching SNI if it isn't already running
@@ -467,7 +491,7 @@ async def get_snes_devices(ctx: Context):
     devices = reply['Results'] if 'Results' in reply and len(reply['Results']) > 0 else None
 
     if not devices:
-        logger.info('No SNES device found. Please connect a SNES device to SNI.')
+        snes_logger.info('No SNES device found. Please connect a SNES device to SNI.')
         while not devices:
             await asyncio.sleep(1)
             await socket.send(dumps(DeviceList_Request))
@@ -479,12 +503,16 @@ async def get_snes_devices(ctx: Context):
     return devices
 
 
-async def snes_connect(ctx: Context, address):
+async def snes_connect(ctx: Context, address, deviceIndex = -1):
     global SNES_RECONNECT_DELAY
     if ctx.snes_socket is not None and ctx.snes_state == SNESState.SNES_CONNECTED:
-        logger.error('Already connected to snes')
+        if ctx.rom:
+            snes_logger.error('Already connected to SNES, with rom loaded.')
+        else:
+            snes_logger.error('Already connected to SNI, likely awaiting a device.')
         return
 
+    device = None
     recv_task = None
     ctx.snes_state = SNESState.SNES_CONNECTING
     socket = await _snes_connect(ctx, address)
@@ -493,19 +521,33 @@ async def snes_connect(ctx: Context, address):
 
     try:
         devices = await get_snes_devices(ctx)
+        numDevices = len(devices)
 
-        if len(devices) == 1:
+        if numDevices == 1:
             device = devices[0]
         elif ctx.snes_reconnect_address:
             if ctx.snes_attached_device[1] in devices:
                 device = ctx.snes_attached_device[1]
             else:
                 device = devices[ctx.snes_attached_device[0]]
-        else:
+        elif numDevices > 1:
+            if deviceIndex == -1:
+                snes_logger.info("Found " + str(numDevices) + " SNES devices; connect to one with /snes <address> <device number>:")
+
+                for idx, availableDevice in enumerate(devices):
+                    snes_logger.info(str(idx + 1) + ": " + availableDevice)
+
+            elif (deviceIndex < 0) or (deviceIndex - 1) > numDevices:
+                snes_logger.warning("SNES device number out of range")
+
+            else:
+                device = devices[deviceIndex - 1]
+            
+        if device is None:
             await snes_disconnect(ctx)
             return
 
-        logger.info("Attaching to " + device)
+        snes_logger.info("Attaching to " + device)
 
         Attach_Request = {
             "Opcode": "Attach",
@@ -518,6 +560,7 @@ async def snes_connect(ctx: Context, address):
         ctx.snes_reconnect_address = address
         recv_task = asyncio.create_task(snes_recv_loop(ctx))
         SNES_RECONNECT_DELAY = ctx.starting_reconnect_delay
+        snes_logger.info(f"Attached to {device}")
 
     except Exception as e:
         if recv_task is not None:
@@ -530,9 +573,9 @@ async def snes_connect(ctx: Context, address):
                 ctx.snes_socket = None
             ctx.snes_state = SNESState.SNES_DISCONNECTED
         if not ctx.snes_reconnect_address:
-            logger.error("Error connecting to snes (%s)" % e)
+            snes_logger.error("Error connecting to snes (%s)" % e)
         else:
-            logger.error(f"Error connecting to snes, attempt again in {SNES_RECONNECT_DELAY}s")
+            snes_logger.error(f"Error connecting to snes, attempt again in {SNES_RECONNECT_DELAY}s")
             asyncio.create_task(snes_autoreconnect(ctx))
         SNES_RECONNECT_DELAY *= 2
 
@@ -559,11 +602,11 @@ async def snes_recv_loop(ctx: Context):
     try:
         async for msg in ctx.snes_socket:
             ctx.snes_recv_queue.put_nowait(msg)
-        logger.warning("Snes disconnected")
+        snes_logger.warning("Snes disconnected")
     except Exception as e:
         if not isinstance(e, websockets.WebSocketException):
-            logger.exception(e)
-        logger.error("Lost connection to the snes, type /snes to reconnect")
+            snes_logger.exception(e)
+        snes_logger.error("Lost connection to the snes, type /snes to reconnect")
     finally:
         socket, ctx.snes_socket = ctx.snes_socket, None
         if socket is not None and not socket.closed:
@@ -576,7 +619,7 @@ async def snes_recv_loop(ctx: Context):
         ctx.rom = None
 
         if ctx.snes_reconnect_address:
-            logger.info(f"...reconnecting in {SNES_RECONNECT_DELAY}s")
+            snes_logger.info(f"...reconnecting in {SNES_RECONNECT_DELAY}s")
             asyncio.create_task(snes_autoreconnect(ctx))
 
 
@@ -605,10 +648,10 @@ async def snes_read(ctx: Context, address, size):
                 break
 
         if len(data) != size:
-            logger.error('Error reading %s, requested %d bytes, received %d' % (hex(address), size, len(data)))
+            snes_logger.error('Error reading %s, requested %d bytes, received %d' % (hex(address), size, len(data)))
             if len(data):
-                logger.error(str(data))
-                logger.warning('Communication Failure with SNI')
+                snes_logger.error(str(data))
+                snes_logger.warning('Communication Failure with SNI')
             if ctx.snes_socket is not None and not ctx.snes_socket.closed:
                 await ctx.snes_socket.close()
             return None
@@ -634,7 +677,7 @@ async def snes_write(ctx: Context, write_list):
                     await ctx.snes_socket.send(dumps(PutAddress_Request))
                     await ctx.snes_socket.send(data)
                 else:
-                    logger.warning(f"Could not send data to SNES: {data}")
+                    snes_logger.warning(f"Could not send data to SNES: {data}")
         except websockets.ConnectionClosed:
             return False
 
@@ -673,7 +716,7 @@ async def track_locations(ctx: Context, roomid, roomdata):
         new_locations.append(location_id)
         ctx.locations_checked.add(location_id)
         location = ctx.location_name_getter(location_id)
-        logger.info(f'New Check: {location} ({len(ctx.locations_checked)}/{len(ctx.missing_locations) + len(ctx.checked_locations)})')
+        snes_logger.info(f'New Check: {location} ({len(ctx.locations_checked)}/{len(ctx.missing_locations) + len(ctx.checked_locations)})')
 
     try:
         if roomid in location_shop_ids:
@@ -682,7 +725,7 @@ async def track_locations(ctx: Context, roomid, roomdata):
                 if int(b) and (Shops.SHOP_ID_START + cnt) not in ctx.locations_checked:
                     new_check(Shops.SHOP_ID_START + cnt)
     except Exception as e:
-        logger.info(f"Exception: {e}")
+        snes_logger.info(f"Exception: {e}")
 
     for location_id, (loc_roomid, loc_mask) in location_table_uw_id.items():
         try:
@@ -691,7 +734,7 @@ async def track_locations(ctx: Context, roomid, roomdata):
                     roomdata << 4) & loc_mask != 0:
                 new_check(location_id)
         except Exception as e:
-            logger.exception(f"Exception: {e}")
+            snes_logger.exception(f"Exception: {e}")
 
     uw_begin = 0x129
     ow_end = uw_end = 0
@@ -774,7 +817,7 @@ async def game_watcher(ctx: Context):
                 await ctx.server_auth(False)
 
         if ctx.auth and ctx.auth != ctx.rom:
-            logger.warning("ROM change detected, please reconnect to the multiworld server")
+            snes_logger.warning("ROM change detected, please reconnect to the multiworld server")
             await ctx.disconnect()
 
         gamemode = await snes_read(ctx, WRAM_START + 0x10, 1)
@@ -857,6 +900,8 @@ async def main():
     parser.add_argument('--loglevel', default='info', choices=['debug', 'info', 'warning', 'error', 'critical'])
     parser.add_argument('--founditems', default=False, action='store_true',
                         help='Show items found by other players for themselves.')
+    if not Utils.is_frozen():  # Frozen state has no cmd window in the first place
+        parser.add_argument('--nogui', default=False, action='store_true', help="Turns off Client GUI.")
     args = parser.parse_args()
     logging.basicConfig(format='%(message)s', level=getattr(logging, args.loglevel.upper(), logging.INFO))
     if args.diff_file:
@@ -865,7 +910,7 @@ async def main():
         meta, romfile = Patch.create_rom_file(args.diff_file)
         args.connect = meta["server"]
         logging.info(f"Wrote rom file to {romfile}")
-        adjustedromfile, adjusted = Utils.get_adjuster_settings(romfile)
+        adjustedromfile, adjusted = Utils.get_adjuster_settings(romfile, gui_enabled)
         if adjusted:
             try:
                 shutil.move(adjustedromfile, romfile)
@@ -875,22 +920,32 @@ async def main():
         asyncio.create_task(run_game(adjustedromfile if adjusted else romfile))
 
     ctx = Context(args.snes, args.connect, args.password)
-    input_task = asyncio.create_task(console_loop(ctx), name="Input")
-
     if ctx.server_task is None:
         ctx.server_task = asyncio.create_task(server_loop(ctx), name="ServerLoop")
-    asyncio.create_task(snes_connect(ctx, ctx.snes_address))
+
+    if gui_enabled:
+        input_task = None
+        from kvui import LttPManager
+        ctx.ui = LttPManager(ctx)
+        ui_task = asyncio.create_task(ctx.ui.async_run(), name="UI")
+    else:
+        input_task = asyncio.create_task(console_loop(ctx), name="Input")
+        ui_task = None
+
+    snes_connect_task = asyncio.create_task(snes_connect(ctx, ctx.snes_address))
     watcher_task = asyncio.create_task(game_watcher(ctx), name="GameWatcher")
 
     await ctx.exit_event.wait()
+    if snes_connect_task:
+        snes_connect_task.cancel()
     ctx.server_address = None
     ctx.snes_reconnect_address = None
 
     await watcher_task
 
-    if ctx.server is not None and not ctx.server.socket.closed:
+    if ctx.server and not ctx.server.socket.closed:
         await ctx.server.socket.close()
-    if ctx.server_task is not None:
+    if ctx.server_task:
         await ctx.server_task
 
     if ctx.snes_socket is not None and not ctx.snes_socket.closed:
@@ -900,7 +955,11 @@ async def main():
         ctx.input_queue.put_nowait(None)
         ctx.input_requests -= 1
 
-    await input_task
+    if ui_task:
+        await ui_task
+
+    if input_task:
+        input_task.cancel()
 
 
 if __name__ == '__main__':

Main.py

@@ -1,48 +1,34 @@
-from itertools import zip_longest
+from itertools import zip_longest, chain
 import logging
 import os
-import random
 import time
 import zlib
 import concurrent.futures
 import pickle
 import tempfile
 import zipfile
-from typing import Dict, Tuple
+from typing import Dict, Tuple, Optional
 
-from BaseClasses import MultiWorld, CollectionState, Region, Item
+from BaseClasses import MultiWorld, CollectionState, Region, RegionType
 from worlds.alttp.Items import item_name_groups
 from worlds.alttp.Regions import lookup_vanilla_location_to_entrance
-from worlds.alttp.Rom import patch_rom, patch_race_rom, patch_enemizer, apply_rom_settings, LocalRom, get_hash_string
-from worlds.alttp.Dungeons import fill_dungeons, fill_dungeons_restrictive
 from Fill import distribute_items_restrictive, flood_items, balance_multiworld_progression, distribute_planned
-from worlds.alttp.Shops import ShopSlotFill, SHOP_ID_START, total_shop_slots, FillDisabledShopSlots
-from worlds.alttp.ItemPool import difficulties, fill_prizes
-from Utils import output_path, parse_player_names, get_options, __version__, version_tuple
+from worlds.alttp.Shops import SHOP_ID_START, total_shop_slots, FillDisabledShopSlots
+from Utils import output_path, get_options, __version__, version_tuple
 from worlds.generic.Rules import locality_rules, exclusion_rules
 from worlds import AutoWorld
-import Patch
-
-seeddigits = 20
 
 
-def get_seed(seed=None):
-    if seed is None:
-        random.seed(None)
-        return random.randint(0, pow(10, seeddigits) - 1)
-    return seed
+ordered_areas = (
+    'Light World', 'Dark World', 'Hyrule Castle', 'Agahnims Tower', 'Eastern Palace', 'Desert Palace',
+    'Tower of Hera', 'Palace of Darkness', 'Swamp Palace', 'Skull Woods', 'Thieves Town', 'Ice Palace',
+    'Misery Mire', 'Turtle Rock', 'Ganons Tower', "Total"
+)
 
 
-def get_same_seed(world: MultiWorld, seed_def: tuple) -> str:
-    seeds: Dict[tuple, str] = getattr(world, "__named_seeds", {})
-    if seed_def in seeds:
-        return seeds[seed_def]
-    seeds[seed_def] = str(world.random.randint(0, 2 ** 64))
-    world.__named_seeds = seeds
-    return seeds[seed_def]
-
-
-def main(args, seed=None):
+def main(args, seed=None, baked_server_options: Optional[Dict[str, object]] = None):
+    if not baked_server_options:
+        baked_server_options = get_options()["server_options"]
     if args.outputpath:
         os.makedirs(args.outputpath, exist_ok=True)
         output_path.cached_path = args.outputpath
@@ -52,146 +38,86 @@ def main(args, seed=None):
     # initialize the world
     world = MultiWorld(args.multi)
 
-    logger = logging.getLogger('')
-    world.seed = get_seed(seed)
-    if args.race:
-        world.secure()
-    else:
-        world.random.seed(world.seed)
-    world.seed_name = str(args.outputname if args.outputname else world.seed)
+    logger = logging.getLogger()
+    world.set_seed(seed, args.race, str(args.outputname if args.outputname else world.seed))
 
     world.shuffle = args.shuffle.copy()
     world.logic = args.logic.copy()
     world.mode = args.mode.copy()
-    world.swordless = args.swordless.copy()
     world.difficulty = args.difficulty.copy()
     world.item_functionality = args.item_functionality.copy()
     world.timer = args.timer.copy()
-    world.progressive = args.progressive.copy()
     world.goal = args.goal.copy()
-    world.local_items = args.local_items.copy()
+
     if hasattr(args, "algorithm"):  # current GUI options
         world.algorithm = args.algorithm
         world.shuffleganon = args.shuffleganon
         world.custom = args.custom
         world.customitemarray = args.customitemarray
 
-    world.accessibility = args.accessibility.copy()
-    world.retro = args.retro.copy()
-
-    world.hints = args.hints.copy()
-
-    world.mapshuffle = args.mapshuffle.copy()
-    world.compassshuffle = args.compassshuffle.copy()
-    world.keyshuffle = args.keyshuffle.copy()
-    world.bigkeyshuffle = args.bigkeyshuffle.copy()
     world.open_pyramid = args.open_pyramid.copy()
     world.boss_shuffle = args.shufflebosses.copy()
-    world.enemy_shuffle = args.enemy_shuffle.copy()
     world.enemy_health = args.enemy_health.copy()
     world.enemy_damage = args.enemy_damage.copy()
-    world.killable_thieves = args.killable_thieves.copy()
-    world.bush_shuffle = args.bush_shuffle.copy()
-    world.tile_shuffle = args.tile_shuffle.copy()
     world.beemizer = args.beemizer.copy()
     world.timer = args.timer.copy()
     world.countdown_start_time = args.countdown_start_time.copy()
     world.red_clock_time = args.red_clock_time.copy()
     world.blue_clock_time = args.blue_clock_time.copy()
     world.green_clock_time = args.green_clock_time.copy()
-    world.shufflepots = args.shufflepots.copy()
-    world.progressive = args.progressive.copy()
     world.dungeon_counters = args.dungeon_counters.copy()
-    world.glitch_boots = args.glitch_boots.copy()
     world.triforce_pieces_available = args.triforce_pieces_available.copy()
     world.triforce_pieces_required = args.triforce_pieces_required.copy()
     world.shop_shuffle = args.shop_shuffle.copy()
-    world.progression_balancing = args.progression_balancing.copy()
     world.shuffle_prizes = args.shuffle_prizes.copy()
     world.sprite_pool = args.sprite_pool.copy()
     world.dark_room_logic = args.dark_room_logic.copy()
     world.plando_items = args.plando_items.copy()
     world.plando_texts = args.plando_texts.copy()
     world.plando_connections = args.plando_connections.copy()
-    world.er_seeds = getattr(args, "er_seeds", {})
-    world.restrict_dungeon_item_on_boss = args.restrict_dungeon_item_on_boss.copy()
     world.required_medallions = args.required_medallions.copy()
     world.game = args.game.copy()
     world.set_options(args)
+    world.player_name = args.name.copy()
+    world.enemizer = args.enemizercli
+    world.sprite = args.sprite.copy()
     world.glitch_triforce = args.glitch_triforce  # This is enabled/disabled globally, no per player option.
 
-    world.slot_seeds = {player: random.Random(world.random.getrandbits(64)) for player in
-                        range(1, world.players + 1)}
-
-    AutoWorld.call_all(world, "generate_early")
-
-    # system for sharing ER layouts
-    for player in world.get_game_players("A Link to the Past"):
-        world.er_seeds[player] = str(world.random.randint(0, 2 ** 64))
-
-        if "-" in world.shuffle[player]:
-            shuffle, seed = world.shuffle[player].split("-", 1)
-            world.shuffle[player] = shuffle
-            if shuffle == "vanilla":
-                world.er_seeds[player] = "vanilla"
-            elif seed.startswith("group-") or args.race:
-                world.er_seeds[player] = get_same_seed(world, (
-                shuffle, seed, world.retro[player], world.mode[player], world.logic[player]))
-            else:  # not a race or group seed, use set seed as is.
-                world.er_seeds[player] = seed
-        elif world.shuffle[player] == "vanilla":
-            world.er_seeds[player] = "vanilla"
-
     logger.info('Archipelago Version %s  -  Seed: %s\n', __version__, world.seed)
 
     logger.info("Found World Types:")
     longest_name = max(len(text) for text in AutoWorld.AutoWorldRegister.world_types)
+    numlength = 8
     for name, cls in AutoWorld.AutoWorldRegister.world_types.items():
-        logger.info(f"  {name:{longest_name}}: {len(cls.item_names):3} Items | {len(cls.location_names):3} Locations")
+        if not cls.hidden:
+            logger.info(f"  {name:{longest_name}}: {len(cls.item_names):3} Items | "
+                        f"{len(cls.location_names):3} Locations")
+            logger.info(f"  Item IDs: {min(cls.item_id_to_name):{numlength}} - "
+                        f"{max(cls.item_id_to_name):{numlength}} | "
+                        f"Location IDs: {min(cls.location_id_to_name):{numlength}} - "
+                        f"{max(cls.location_id_to_name):{numlength}}")
 
-    parsed_names = parse_player_names(args.names, world.players, args.teams)
-    world.teams = len(parsed_names)
-    for i, team in enumerate(parsed_names, 1):
-        if world.players > 1:
-            logger.info('%s%s', 'Team%d: ' % i if world.teams > 1 else 'Players: ', ', '.join(team))
-        for player, name in enumerate(team, 1):
-            world.player_names[player].append(name)
+    AutoWorld.call_all(world, "generate_early")
 
     logger.info('')
-    for player in world.get_game_players("A Link to the Past"):
-        world.difficulty_requirements[player] = difficulties[world.difficulty[player]]
 
     for player in world.player_ids:
-        for item_name in args.startinventory[player]:
-            world.push_precollected(world.create_item(item_name, player))
+        for item_name, count in world.start_inventory[player].value.items():
+            for _ in range(count):
+                world.push_precollected(world.create_item(item_name, player))
 
     for player in world.player_ids:
         if player in world.get_game_players("A Link to the Past"):
             # enforce pre-defined local items.
             if world.goal[player] in ["localtriforcehunt", "localganontriforcehunt"]:
-                world.local_items[player].add('Triforce Piece')
-
-            # dungeon items can't be in non-local if the appropriate dungeon item shuffle setting is not set.
-            if not world.mapshuffle[player]:
-                world.non_local_items[player] -= item_name_groups['Maps']
-
-            if not world.compassshuffle[player]:
-                world.non_local_items[player] -= item_name_groups['Compasses']
-
-            if not world.keyshuffle[player]:
-                world.non_local_items[player] -= item_name_groups['Small Keys']
-            # This could probably use a more elegant solution.
-            elif world.keyshuffle[player] == True and world.mode[player] == "Standard":
-                world.local_items[player].add("Small Key (Hyrule Castle)")
-            if not world.bigkeyshuffle[player]:
-                world.non_local_items[player] -= item_name_groups['Big Keys']
+                world.local_items[player].value.add('Triforce Piece')
 
             # Not possible to place pendants/crystals out side of boss prizes yet.
-            world.non_local_items[player] -= item_name_groups['Pendants']
-            world.non_local_items[player] -= item_name_groups['Crystals']
+            world.non_local_items[player].value -= item_name_groups['Pendants']
+            world.non_local_items[player].value -= item_name_groups['Crystals']
 
         # items can't be both local and non-local, prefer local
-        world.non_local_items[player] -= world.local_items[player]
+        world.non_local_items[player].value -= world.local_items[player].value
 
     logger.info('Creating World.')
     AutoWorld.call_all(world, "create_regions")
@@ -203,11 +129,14 @@ def main(args, seed=None):
     if world.players > 1:
         for player in world.player_ids:
             locality_rules(world, player)
+    else:
+        world.non_local_items[1].value = set()
+        world.local_items[1].value = set()
 
     AutoWorld.call_all(world, "set_rules")
 
     for player in world.player_ids:
-        exclusion_rules(world, player, args.excluded_locations[player])
+        exclusion_rules(world, player, world.exclude_locations[player].value)
 
     AutoWorld.call_all(world, "generate_basic")
 
@@ -218,309 +147,198 @@ def main(args, seed=None):
 
     distribute_planned(world)
 
-    logger.info('Placing Dungeon Prizes.')
+    logger.info('Running Pre Main Fill.')
 
-    fill_prizes(world)
-
-    logger.info('Placing Dungeon Items.')
-
-    if world.algorithm in ['balanced', 'vt26'] or any(
-            list(args.mapshuffle.values()) + list(args.compassshuffle.values()) +
-            list(args.keyshuffle.values()) + list(args.bigkeyshuffle.values())):
-        fill_dungeons_restrictive(world)
-    else:
-        fill_dungeons(world)
+    AutoWorld.call_all(world, "pre_fill")
 
     logger.info('Fill the world.')
 
     if world.algorithm == 'flood':
         flood_items(world)  # different algo, biased towards early game progress items
-    elif world.algorithm == 'vt25':
-        distribute_items_restrictive(world, False)
-    elif world.algorithm == 'vt26':
-        distribute_items_restrictive(world, True)
     elif world.algorithm == 'balanced':
-        distribute_items_restrictive(world, True)
+        distribute_items_restrictive(world)
 
-    logger.info("Filling Shop Slots")
-
-    ShopSlotFill(world)
+    AutoWorld.call_all(world, 'post_fill')
 
     if world.players > 1:
         balance_multiworld_progression(world)
 
-    logger.info('Generating output files.')
+    logger.info(f'Beginning output...')
     outfilebase = 'AP_' + world.seed_name
-    rom_names = []
-
-    def _gen_rom(team: int, player: int, output_directory:str):
-        use_enemizer = (world.boss_shuffle[player] != 'none' or world.enemy_shuffle[player]
-                        or world.enemy_health[player] != 'default' or world.enemy_damage[player] != 'default'
-                        or world.shufflepots[player] or world.bush_shuffle[player]
-                        or world.killable_thieves[player])
-
-        rom = LocalRom(args.rom)
-
-        patch_rom(world, rom, player, team, use_enemizer)
-
-        if use_enemizer:
-            patch_enemizer(world, team, player, rom, args.enemizercli, output_directory)
-
-        if args.race:
-            patch_race_rom(rom, world, player)
-
-        world.spoiler.hashes[(player, team)] = get_hash_string(rom.hash)
-
-        palettes_options = {}
-        palettes_options['dungeon'] = args.uw_palettes[player]
-        palettes_options['overworld'] = args.ow_palettes[player]
-        palettes_options['hud'] = args.hud_palettes[player]
-        palettes_options['sword'] = args.sword_palettes[player]
-        palettes_options['shield'] = args.shield_palettes[player]
-        palettes_options['link'] = args.link_palettes[player]
-
-        apply_rom_settings(rom, args.heartbeep[player], args.heartcolor[player], args.quickswap[player],
-                           args.fastmenu[player], args.disablemusic[player], args.sprite[player],
-                           palettes_options, world, player, True,
-                           reduceflashing=args.reduceflashing[player] or args.race,
-                           triforcehud=args.triforcehud[player])
-
-        mcsb_name = ''
-        if all([world.mapshuffle[player], world.compassshuffle[player], world.keyshuffle[player],
-                world.bigkeyshuffle[player]]):
-            mcsb_name = '-keysanity'
-        elif [world.mapshuffle[player], world.compassshuffle[player], world.keyshuffle[player],
-              world.bigkeyshuffle[player]].count(True) == 1:
-            mcsb_name = '-mapshuffle' if world.mapshuffle[player] else \
-                '-compassshuffle' if world.compassshuffle[player] else \
-                    '-universal_keys' if world.keyshuffle[player] == "universal" else \
-                        '-keyshuffle' if world.keyshuffle[player] else '-bigkeyshuffle'
-        elif any([world.mapshuffle[player], world.compassshuffle[player], world.keyshuffle[player],
-                  world.bigkeyshuffle[player]]):
-            mcsb_name = '-%s%s%s%sshuffle' % (
-                'M' if world.mapshuffle[player] else '', 'C' if world.compassshuffle[player] else '',
-                'U' if world.keyshuffle[player] == "universal" else 'S' if world.keyshuffle[player] else '',
-                'B' if world.bigkeyshuffle[player] else '')
-
-        outfilepname = f'_P{player}'
-        outfilepname += f"_{world.player_names[player][team].replace(' ', '_')}" \
-            if world.player_names[player][team] != 'Player%d' % player else ''
-        outfilestuffs = {
-            "logic": world.logic[player],  # 0
-            "difficulty": world.difficulty[player],  # 1
-            "item_functionality": world.item_functionality[player],  # 2
-            "mode": world.mode[player],  # 3
-            "goal": world.goal[player],  # 4
-            "timer": str(world.timer[player]),  # 5
-            "shuffle": world.shuffle[player],  # 6
-            "algorithm": world.algorithm,  # 7
-            "mscb": mcsb_name,  # 8
-            "retro": world.retro[player],  # 9
-            "progressive": world.progressive,  # A
-            "hints": 'True' if world.hints[player] else 'False'  # B
-        }
-        #                  0  1  2  3  4 5  6  7 8 9 A B
-        outfilesuffix = ('_%s_%s-%s-%s-%s%s_%s-%s%s%s%s%s' % (
-            #  0          1      2      3    4     5    6      7     8        9         A     B           C
-            # _noglitches_normal-normal-open-ganon-ohko_simple-balanced-keysanity-retro-prog_random-nohints
-            # _noglitches_normal-normal-open-ganon     _simple-balanced-keysanity-retro
-            # _noglitches_normal-normal-open-ganon     _simple-balanced-keysanity      -prog_random
-            # _noglitches_normal-normal-open-ganon     _simple-balanced-keysanity                  -nohints
-            outfilestuffs["logic"],  # 0
-
-            outfilestuffs["difficulty"],  # 1
-            outfilestuffs["item_functionality"],  # 2
-            outfilestuffs["mode"],  # 3
-            outfilestuffs["goal"],  # 4
-            "" if outfilestuffs["timer"] in ['False', 'none', 'display'] else "-" + outfilestuffs["timer"],  # 5
-
-            outfilestuffs["shuffle"],  # 6
-            outfilestuffs["algorithm"],  # 7
-            outfilestuffs["mscb"],  # 8
-
-            "-retro" if outfilestuffs["retro"] == "True" else "",  # 9
-            "-prog_" + outfilestuffs["progressive"] if outfilestuffs["progressive"] in ['off', 'random'] else "",  # A
-            "-nohints" if not outfilestuffs["hints"] == "True" else "")  # B
-                         ) if not args.outputname else ''
-        rompath = os.path.join(output_directory, f'{outfilebase}{outfilepname}{outfilesuffix}.sfc')
-        rom.write_to_file(rompath, hide_enemizer=True)
-        Patch.create_patch_file(rompath, player=player, player_name=world.player_names[player][team])
-        os.unlink(rompath)
-        return player, team, bytes(rom.name)
-
-    pool = concurrent.futures.ThreadPoolExecutor()
 
     output = tempfile.TemporaryDirectory()
     with output as temp_dir:
-        check_accessibility_task = pool.submit(world.fulfills_accessibility)
-        rom_futures = []
-        output_file_futures = []
-        for team in range(world.teams):
-            for player in world.get_game_players("A Link to the Past"):
-                rom_futures.append(pool.submit(_gen_rom, team, player, temp_dir))
-        for player in world.player_ids:
-            output_file_futures.append(pool.submit(AutoWorld.call_single, world, "generate_output", player, temp_dir))
+        with concurrent.futures.ThreadPoolExecutor(world.players + 2) as pool:
+            check_accessibility_task = pool.submit(world.fulfills_accessibility)
 
-        def get_entrance_to_region(region: Region):
-            for entrance in region.entrances:
-                if entrance.parent_region.type in (RegionType.DarkWorld, RegionType.LightWorld, RegionType.Generic):
-                    return entrance
-            for entrance in region.entrances:  # BFS might be better here, trying DFS for now.
-                return get_entrance_to_region(entrance.parent_region)
+            output_file_futures = [pool.submit(AutoWorld.call_stage, world, "generate_output", temp_dir)]
+            for player in world.player_ids:
+                # skip starting a thread for methods that say "pass".
+                if AutoWorld.World.generate_output.__code__ is not world.worlds[player].generate_output.__code__:
+                    output_file_futures.append(
+                        pool.submit(AutoWorld.call_single, world, "generate_output", player, temp_dir))
 
-        # collect ER hint info
-        er_hint_data = {player: {} for player in world.get_game_players("A Link to the Past") if
-                        world.shuffle[player] != "vanilla" or world.retro[player]}
-        from worlds.alttp.Regions import RegionType
-        for region in world.regions:
-            if region.player in er_hint_data and region.locations:
-                main_entrance = get_entrance_to_region(region)
-                for location in region.locations:
-                    if type(location.address) == int:  # skips events and crystals
-                        if lookup_vanilla_location_to_entrance[location.address] != main_entrance.name:
-                            er_hint_data[region.player][location.address] = main_entrance.name
+            def get_entrance_to_region(region: Region):
+                for entrance in region.entrances:
+                    if entrance.parent_region.type in (RegionType.DarkWorld, RegionType.LightWorld, RegionType.Generic):
+                        return entrance
+                for entrance in region.entrances:  # BFS might be better here, trying DFS for now.
+                    return get_entrance_to_region(entrance.parent_region)
 
-        ordered_areas = ('Light World', 'Dark World', 'Hyrule Castle', 'Agahnims Tower', 'Eastern Palace', 'Desert Palace',
-                         'Tower of Hera', 'Palace of Darkness', 'Swamp Palace', 'Skull Woods', 'Thieves Town', 'Ice Palace',
-                         'Misery Mire', 'Turtle Rock', 'Ganons Tower', "Total")
+            # collect ER hint info
+            er_hint_data = {player: {} for player in world.get_game_players("A Link to the Past") if
+                            world.shuffle[player] != "vanilla" or world.retro[player]}
 
-        checks_in_area = {player: {area: list() for area in ordered_areas}
-                          for player in range(1, world.players + 1)}
+            for region in world.regions:
+                if region.player in er_hint_data and region.locations:
+                    main_entrance = get_entrance_to_region(region)
+                    for location in region.locations:
+                        if type(location.address) == int:  # skips events and crystals
+                            if lookup_vanilla_location_to_entrance[location.address] != main_entrance.name:
+                                er_hint_data[region.player][location.address] = main_entrance.name
 
-        for player in range(1, world.players + 1):
-            checks_in_area[player]["Total"] = 0
 
-        for location in [loc for loc in world.get_filled_locations() if type(loc.address) is int]:
-            main_entrance = get_entrance_to_region(location.parent_region)
-            if location.game != "A Link to the Past":
-                checks_in_area[location.player]["Light World"].append(location.address)
-            elif location.parent_region.dungeon:
-                dungeonname = {'Inverted Agahnims Tower': 'Agahnims Tower',
-                               'Inverted Ganons Tower': 'Ganons Tower'} \
-                    .get(location.parent_region.dungeon.name, location.parent_region.dungeon.name)
-                checks_in_area[location.player][dungeonname].append(location.address)
-            elif main_entrance.parent_region.type == RegionType.LightWorld:
-                checks_in_area[location.player]["Light World"].append(location.address)
-            elif main_entrance.parent_region.type == RegionType.DarkWorld:
-                checks_in_area[location.player]["Dark World"].append(location.address)
-            checks_in_area[location.player]["Total"] += 1
 
-        oldmancaves = []
-        takeanyregions = ["Old Man Sword Cave", "Take-Any #1", "Take-Any #2", "Take-Any #3", "Take-Any #4"]
-        for index, take_any in enumerate(takeanyregions):
-            for region in [world.get_region(take_any, player) for player in range(1, world.players + 1) if
-                           world.retro[player]]:
-                item = world.create_item(region.shop.inventory[(0 if take_any == "Old Man Sword Cave" else 1)]['item'],
-                                         region.player)
-                player = region.player
-                location_id = SHOP_ID_START + total_shop_slots + index
+            checks_in_area = {player: {area: list() for area in ordered_areas}
+                              for player in range(1, world.players + 1)}
 
-                main_entrance = get_entrance_to_region(region)
-                if main_entrance.parent_region.type == RegionType.LightWorld:
-                    checks_in_area[player]["Light World"].append(location_id)
-                else:
-                    checks_in_area[player]["Dark World"].append(location_id)
-                checks_in_area[player]["Total"] += 1
+            for player in range(1, world.players + 1):
+                checks_in_area[player]["Total"] = 0
 
-                er_hint_data[player][location_id] = main_entrance.name
-                oldmancaves.append(((location_id, player), (item.code, player)))
-
-        FillDisabledShopSlots(world)
-
-        def write_multidata(roms, outputs):
-            import base64
-            import NetUtils
-            for future in roms:
-                rom_name = future.result()
-                rom_names.append(rom_name)
-            slot_data = {}
-            client_versions = {}
-            minimum_versions = {"server": (0, 1, 1), "clients": client_versions}
-            games = {}
-            for slot in world.player_ids:
-                client_versions[slot] = world.worlds[slot].get_required_client_version()
-                games[slot] = world.game[slot]
-            connect_names = {base64.b64encode(rom_name).decode(): (team, slot) for
-                             slot, team, rom_name in rom_names}
-            precollected_items = {player: [] for player in range(1, world.players + 1)}
-            for item in world.precollected_items:
-                precollected_items[item.player].append(item.code)
-            precollected_hints = {player: set() for player in range(1, world.players + 1)}
-            # for now special case Factorio tech_tree_information
-            sending_visible_players = set()
-            for player in world.get_game_players("Factorio"):
-                if world.tech_tree_information[player].value == 2:
-                    sending_visible_players.add(player)
-
-            for i, team in enumerate(parsed_names):
-                for player, name in enumerate(team, 1):
-                    if player not in world.get_game_players("A Link to the Past"):
-                        connect_names[name] = (i, player)
-
-            for slot in world.player_ids:
-                slot_data[slot] = world.worlds[slot].fill_slot_data()
-
-            locations_data: Dict[int, Dict[int, Tuple[int, int]]] = {player: {} for player in world.player_ids}
             for location in world.get_filled_locations():
-                if type(location.address) == int:
-                    locations_data[location.player][location.address] = location.item.code, location.item.player
-                    if location.player in sending_visible_players and location.item.player != location.player:
-                        hint = NetUtils.Hint(location.item.player, location.player, location.address,
-                                             location.item.code, False)
-                        precollected_hints[location.player].add(hint)
-                        precollected_hints[location.item.player].add(hint)
-                    elif location.item.name in args.start_hints[location.item.player]:
-                        hint = NetUtils.Hint(location.item.player, location.player, location.address,
-                                             location.item.code, False,
-                                             er_hint_data.get(location.player, {}).get(location.address, ""))
-                        precollected_hints[location.player].add(hint)
-                        precollected_hints[location.item.player].add(hint)
+                if type(location.address) is int:
+                    main_entrance = get_entrance_to_region(location.parent_region)
+                    if location.game != "A Link to the Past":
+                        checks_in_area[location.player]["Light World"].append(location.address)
+                    elif location.parent_region.dungeon:
+                        dungeonname = {'Inverted Agahnims Tower': 'Agahnims Tower',
+                                       'Inverted Ganons Tower': 'Ganons Tower'} \
+                            .get(location.parent_region.dungeon.name, location.parent_region.dungeon.name)
+                        checks_in_area[location.player][dungeonname].append(location.address)
+                    elif main_entrance.parent_region.type == RegionType.LightWorld:
+                        checks_in_area[location.player]["Light World"].append(location.address)
+                    elif main_entrance.parent_region.type == RegionType.DarkWorld:
+                        checks_in_area[location.player]["Dark World"].append(location.address)
+                    checks_in_area[location.player]["Total"] += 1
 
-            multidata = zlib.compress(pickle.dumps({
-                "slot_data": slot_data,
-                "games": games,
-                "names": parsed_names,
-                "connect_names": connect_names,
-                "remote_items": {player for player in world.player_ids if
-                                 world.worlds[player].remote_items},
-                "locations": locations_data,
-                "checks_in_area": checks_in_area,
-                "server_options": get_options()["server_options"],
-                "er_hint_data": er_hint_data,
-                "precollected_items": precollected_items,
-                "precollected_hints": precollected_hints,
-                "version": tuple(version_tuple),
-                "tags": ["AP"],
-                "minimum_versions": minimum_versions,
-                "seed_name": world.seed_name
-            }), 9)
+            oldmancaves = []
+            takeanyregions = ["Old Man Sword Cave", "Take-Any #1", "Take-Any #2", "Take-Any #3", "Take-Any #4"]
+            for index, take_any in enumerate(takeanyregions):
+                for region in [world.get_region(take_any, player) for player in
+                               world.get_game_players("A Link to the Past") if world.retro[player]]:
+                    item = world.create_item(
+                        region.shop.inventory[(0 if take_any == "Old Man Sword Cave" else 1)]['item'],
+                        region.player)
+                    player = region.player
+                    location_id = SHOP_ID_START + total_shop_slots + index
 
-            with open(os.path.join(temp_dir, '%s.archipelago' % outfilebase), 'wb') as f:
-                f.write(bytes([1]))  # version of format
-                f.write(multidata)
-            for future in outputs:
-                future.result()  # collect errors if they occured
+                    main_entrance = get_entrance_to_region(region)
+                    if main_entrance.parent_region.type == RegionType.LightWorld:
+                        checks_in_area[player]["Light World"].append(location_id)
+                    else:
+                        checks_in_area[player]["Dark World"].append(location_id)
+                    checks_in_area[player]["Total"] += 1
 
-        multidata_task = pool.submit(write_multidata, rom_futures, output_file_futures)
-        if not check_accessibility_task.result():
-            if not world.can_beat_game():
-                raise Exception("Game appears as unbeatable. Aborting.")
-            else:
-                logger.warning("Location Accessibility requirements not fulfilled.")
-        if multidata_task:
-            multidata_task.result()  # retrieve exception if one exists
-        pool.shutdown()  # wait for all queued tasks to complete
-        if not args.skip_playthrough:
+                    er_hint_data[player][location_id] = main_entrance.name
+                    oldmancaves.append(((location_id, player), (item.code, player)))
+
+            FillDisabledShopSlots(world)
+
+            def write_multidata():
+                import NetUtils
+                slot_data = {}
+                client_versions = {}
+                minimum_versions = {"server": (0, 1, 1), "clients": client_versions}
+                games = {}
+                for slot in world.player_ids:
+                    client_versions[slot] = world.worlds[slot].get_required_client_version()
+                    games[slot] = world.game[slot]
+                precollected_items = {player: [item.code for item in world_precollected]
+                                      for player, world_precollected in world.precollected_items.items()}
+                precollected_hints = {player: set() for player in range(1, world.players + 1)}
+                # for now special case Factorio tech_tree_information
+                sending_visible_players = set()
+
+                for slot in world.player_ids:
+                    slot_data[slot] = world.worlds[slot].fill_slot_data()
+                    if world.worlds[slot].sending_visible:
+                        sending_visible_players.add(slot)
+
+                def precollect_hint(location):
+                    hint = NetUtils.Hint(location.item.player, location.player, location.address,
+                                         location.item.code, False)
+                    precollected_hints[location.player].add(hint)
+                    precollected_hints[location.item.player].add(hint)
+
+                locations_data: Dict[int, Dict[int, Tuple[int, int]]] = {player: {} for player in world.player_ids}
+                for location in world.get_filled_locations():
+                    if type(location.address) == int:
+                        # item code None should be event, location.address should then also be None
+                        assert location.item.code is not None
+                        locations_data[location.player][location.address] = location.item.code, location.item.player
+                        if location.player in sending_visible_players:
+                            precollect_hint(location)
+                        elif location.name in world.start_location_hints[location.player]:
+                            precollect_hint(location)
+                        elif location.item.name in world.start_hints[location.item.player]:
+                            precollect_hint(location)
+
+                multidata = {
+                    "slot_data": slot_data,
+                    "games": games,
+                    "names": [[name for player, name in sorted(world.player_name.items())]],
+                    "connect_names": {name: (0, player) for player, name in world.player_name.items()},
+                    "remote_items": {player for player in world.player_ids if
+                                     world.worlds[player].remote_items},
+                    "remote_start_inventory": {player for player in world.player_ids if
+                                               world.worlds[player].remote_start_inventory},
+                    "locations": locations_data,
+                    "checks_in_area": checks_in_area,
+                    "server_options": baked_server_options,
+                    "er_hint_data": er_hint_data,
+                    "precollected_items": precollected_items,
+                    "precollected_hints": precollected_hints,
+                    "version": tuple(version_tuple),
+                    "tags": ["AP"],
+                    "minimum_versions": minimum_versions,
+                    "seed_name": world.seed_name
+                }
+                AutoWorld.call_all(world, "modify_multidata", multidata)
+
+                multidata = zlib.compress(pickle.dumps(multidata), 9)
+
+                with open(os.path.join(temp_dir, f'{outfilebase}.archipelago'), 'wb') as f:
+                    f.write(bytes([1]))  # version of format
+                    f.write(multidata)
+
+            multidata_task = pool.submit(write_multidata)
+            if not check_accessibility_task.result():
+                if not world.can_beat_game():
+                    raise Exception("Game appears as unbeatable. Aborting.")
+                else:
+                    logger.warning("Location Accessibility requirements not fulfilled.")
+
+            # retrieve exceptions via .result() if they occured.
+            if multidata_task:
+                multidata_task.result()
+            for i, future in enumerate(concurrent.futures.as_completed(output_file_futures), start=1):
+                if i % 10 == 0 or i == len(output_file_futures):
+                    logger.info(f'Generating output files ({i}/{len(output_file_futures)}).')
+                future.result()
+
+        if args.spoiler > 1:
             logger.info('Calculating playthrough.')
             create_playthrough(world)
-        if args.create_spoiler:  # needs spoiler.hashes to be filled, that depend on rom_futures being done
+
+        if args.spoiler:
             world.spoiler.to_file(os.path.join(temp_dir, '%s_Spoiler.txt' % outfilebase))
+
         zipfilename = output_path(f"AP_{world.seed_name}.zip")
         logger.info(f'Creating final archive at {zipfilename}.')
         with zipfile.ZipFile(zipfilename, mode="w", compression=zipfile.ZIP_DEFLATED,
                              compresslevel=9) as zf:
             for file in os.scandir(temp_dir):
-                zf.write(os.path.join(temp_dir, file), arcname=file.name)
+                zf.write(file.path, arcname=file.name)
 
     logger.info('Done. Enjoy. Total Time: %s', time.perf_counter() - start)
     return world
@@ -536,7 +354,6 @@ def create_playthrough(world):
     sphere_candidates = set(prog_locations)
     logging.debug('Building up collection spheres.')
     while sphere_candidates:
-        state.sweep_for_events(key_only=True)
 
         # build up spheres of collection radius.
         # Everything in each sphere is independent from each other in dependencies and only depends on lower spheres
@@ -556,7 +373,7 @@ def create_playthrough(world):
             logging.debug('The following items could not be reached: %s', ['%s (Player %d) at %s (Player %d)' % (
                 location.item.name, location.item.player, location.name, location.player) for location in
                                                                            sphere_candidates])
-            if any([world.accessibility[location.item.player] != 'none' for location in sphere_candidates]):
+            if any([world.accessibility[location.item.player] != 'minimal' for location in sphere_candidates]):
                 raise RuntimeError(f'Not all progression items reachable ({sphere_candidates}). '
                                    f'Something went terribly wrong here.')
             else:
@@ -586,9 +403,9 @@ def create_playthrough(world):
 
     # second phase, sphere 0
     removed_precollected = []
-    for item in (i for i in world.precollected_items if i.advancement):
+    for item in (i for i in chain.from_iterable(world.precollected_items.values()) if i.advancement):
         logging.debug('Checking if %s (Player %d) is required to beat the game.', item.name, item.player)
-        world.precollected_items.remove(item)
+        world.precollected_items[item.player].remove(item)
         world.state.remove(item)
         if not world.can_beat_game():
             world.push_precollected(item)
@@ -641,21 +458,20 @@ def create_playthrough(world):
             {str(location): get_path(state, location.parent_region) for sphere in collection_spheres for location in
              sphere if location.player == player})
         if player in world.get_game_players("A Link to the Past"):
-            for path in dict(world.spoiler.paths).values():
-                if any(exit == 'Pyramid Fairy' for (_, exit) in path):
-                    if world.mode[player] != 'inverted':
-                        world.spoiler.paths[str(world.get_region('Big Bomb Shop', player))] = get_path(state,
-                                                                                                       world.get_region(
-                                                                                                           'Big Bomb Shop',
-                                                                                                           player))
-                    else:
-                        world.spoiler.paths[str(world.get_region('Inverted Big Bomb Shop', player))] = get_path(state,
-                                                                                                                world.get_region(
-                                                                                                                    'Inverted Big Bomb Shop',
-                                                                                                                    player))
+            # If Pyramid Fairy Entrance needs to be reached, also path to Big Bomb Shop
+            # Maybe move the big bomb over to the Event system instead?
+            if any(exit_path == 'Pyramid Fairy' for path in world.spoiler.paths.values() for (_, exit_path) in path):
+                if world.mode[player] != 'inverted':
+                    world.spoiler.paths[str(world.get_region('Big Bomb Shop', player))] = \
+                        get_path(state, world.get_region('Big Bomb Shop', player))
+                else:
+                    world.spoiler.paths[str(world.get_region('Inverted Big Bomb Shop', player))] = \
+                        get_path(state, world.get_region('Inverted Big Bomb Shop', player))
 
     # we can finally output our playthrough
-    world.spoiler.playthrough = {"0": sorted([str(item) for item in world.precollected_items if item.advancement])}
+    world.spoiler.playthrough = {"0": sorted([str(item) for item in
+                                              chain.from_iterable(world.precollected_items.values())
+                                              if item.advancement])}
 
     for i, sphere in enumerate(collection_spheres):
         world.spoiler.playthrough[str(i + 1)] = {str(location): str(location.item) for location in sorted(sphere)}

MinecraftClient.py

@@ -0,0 +1,185 @@
+import argparse
+import os, sys
+import re
+import atexit
+from subprocess import Popen
+from shutil import copyfile
+from base64 import b64decode
+from time import strftime
+
+import requests
+
+import Utils
+
+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".')
+
+
+# Find Forge jar file; raise error if not found 
+def find_forge_jar(forge_dir):
+    for entry in os.scandir(forge_dir):
+        if ".jar" in entry.name and "forge" in entry.name:
+            print(f"Found forge .jar: {entry.name}")
+            return entry.name
+    raise FileNotFoundError(f"Could not find forge .jar in {forge_dir}.")
+
+
+# Create mods folder if needed; find AP randomizer jar; return None if not found.
+def find_ap_randomizer_jar(forge_dir):
+    mods_dir = os.path.join(forge_dir, 'mods')
+    if os.path.isdir(mods_dir):
+        ap_mod_re = re.compile(r"^aprandomizer-[\d\.]+\.jar$")
+        for entry in os.scandir(mods_dir):
+            match = ap_mod_re.match(entry.name)
+            if match:
+                print(f"Found AP randomizer mod: {match.group()}")
+                return match.group()
+        return None
+    else:
+        os.mkdir(mods_dir)
+        print(f"Created mods folder in {forge_dir}")
+        return None
+
+
+# Create APData folder if needed; clean .apmc files from APData; copy given .apmc into directory.
+def replace_apmc_files(forge_dir, apmc_file):
+    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)
+        print(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)
+                print(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)))
+        print(f"Copied {os.path.basename(apmc_file)} to {apdata_dir}")
+
+
+# Check mod version, download new mod from GitHub releases page if needed. 
+def update_mod(forge_dir):
+    ap_randomizer = find_ap_randomizer_jar(forge_dir)
+
+    client_releases_endpoint = "https://api.github.com/repos/KonoTyran/Minecraft_AP_Randomizer/releases"
+    resp = requests.get(client_releases_endpoint)
+    if resp.status_code == 200:  # OK
+        latest_release = resp.json()[0]
+        if ap_randomizer != latest_release['assets'][0]['name']:
+            print(f"A new release of the Minecraft AP randomizer mod was found: {latest_release['assets'][0]['name']}")
+            if ap_randomizer is not None:
+                print(f"Your current mod is {ap_randomizer}.")
+            else:
+                print(f"You do not have the AP randomizer mod installed.")
+            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', latest_release['assets'][0]['name'])
+                print("Downloading AP randomizer mod. This may take a moment...")
+                apmod_resp = requests.get(latest_release['assets'][0]['browser_download_url'])
+                if apmod_resp.status_code == 200: 
+                    with open(new_ap_mod, 'wb') as f:
+                        f.write(apmod_resp.content)
+                        print(f"Wrote new mod file to {new_ap_mod}")
+                    if old_ap_mod is not None:
+                        os.remove(old_ap_mod)
+                        print(f"Removed old mod file from {old_ap_mod}")
+                else:
+                    print(f"Error retrieving the randomizer mod (status code {apmod_resp.status_code}).")
+                    print(f"Please report this issue on the Archipelago Discord server.")
+                    sys.exit(1)
+    else:
+        print(f"Error checking for randomizer mod updates (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)
+
+
+# Check if the EULA is agreed to, and prompt the user to read and agree if necessary.
+def check_eula(forge_dir):
+    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
+            print("You need to agree to the Minecraft EULA in order to run the server.")
+            print("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()
+                print(f"Set {eula_path} to true")
+            else:
+                sys.exit(0)
+
+
+# Run the Forge server. Return process object
+def run_forge_server(forge_dir, heap_arg):
+    forge_server = find_forge_jar(forge_dir)
+
+    java_exe = os.path.abspath(os.path.join('jre8', 'bin', 'java.exe'))
+    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(max_heap).group()
+    if heap_arg[-1] in ['b', 'B']:
+        heap_arg = heap_arg[:-1]
+    heap_arg = "-Xmx" + heap_arg
+
+    argstring = ' '.join([java_exe, heap_arg, "-jar", forge_server, "-nogui"])
+    print(f"Running Forge server: {argstring}")
+    os.chdir(forge_dir)
+    return Popen(argstring)
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser()
+    parser.add_argument("apmc_file", default=None, nargs='?', help="Path to an Archipelago Minecraft data file (.apmc)")
+
+    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()
+    forge_dir = options["minecraft_options"]["forge_directory"]
+    max_heap = options["minecraft_options"]["max_heap_size"]
+
+    if apmc_file is not None and not os.path.isfile(apmc_file):
+        raise FileNotFoundError(f"Path {apmc_file} does not exist or could not be accessed.")
+    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)
+    replace_apmc_files(forge_dir, apmc_file)
+    check_eula(forge_dir)
+    server_process = run_forge_server(forge_dir, max_heap)
+    server_process.wait()

ModuleUpdate.py

@@ -23,10 +23,13 @@ def update_command():
         subprocess.call([sys.executable, '-m', 'pip', 'install', '-r', file, '--upgrade'])
 
 
-def update():
+def update(yes = False, force = False):
     global update_ran
     if not update_ran:
         update_ran = True
+        if force:
+            update_command()
+            return
         for req_file in requirements_files:
             path = os.path.join(os.path.dirname(sys.argv[0]), req_file)
             if not os.path.exists(path):
@@ -38,12 +41,19 @@ def update():
                     try:
                         pkg_resources.require(requirement)
                     except pkg_resources.ResolutionError:
-                        import traceback
-                        traceback.print_exc()
-                        input(f'Requirement {requirement} is not satisfied, press enter to install it')
+                        if not yes:
+                            import traceback
+                            traceback.print_exc()
+                            input(f'Requirement {requirement} is not satisfied, press enter to install it')
                         update_command()
                         return
 
 
 if __name__ == "__main__":
-    update()
+    import argparse
+    parser = argparse.ArgumentParser(description='Install archipelago requirements')
+    parser.add_argument('-y', '--yes', dest='yes', action='store_true', help='answer "yes" to all questions')
+    parser.add_argument('-f', '--force', dest='force', action='store_true', help='force update')
+    args = parser.parse_args()
+
+    update(args.yes, args.force)

MultiServer.py

@@ -26,15 +26,17 @@ from prompt_toolkit.patch_stdout import patch_stdout
 from fuzzywuzzy import process as fuzzy_process
 
 from worlds.AutoWorld import AutoWorldRegister
+
 proxy_worlds = {name: world(None, 0) for name, world in AutoWorldRegister.world_types.items()}
 from worlds import network_data_package, lookup_any_item_id_to_name, lookup_any_location_id_to_name
 import Utils
 from Utils import get_item_name_from_id, get_location_name_from_id, \
     version_tuple, restricted_loads, Version
-from NetUtils import Node, Endpoint, ClientStatus, NetworkItem, decode, NetworkPlayer
+from NetUtils import Endpoint, ClientStatus, NetworkItem, decode, encode, NetworkPlayer, Permission
 
 colorama.init()
 
+
 class Client(Endpoint):
     version = Version(0, 0, 0)
     tags: typing.List[str] = []
@@ -50,9 +52,14 @@ class Client(Endpoint):
         self.messageprocessor = client_message_processor(ctx, self)
         self.ctx = weakref.ref(ctx)
 
+
 team_slot = typing.Tuple[int, int]
 
-class Context(Node):
+
+class Context:
+    dumper = staticmethod(encode)
+    loader = staticmethod(decode)
+
     simple_options = {"hint_cost": int,
                       "location_check_points": int,
                       "server_password": str,
@@ -64,8 +71,10 @@ class Context(Node):
 
     def __init__(self, host: str, port: int, server_password: str, password: str, location_check_points: int,
                  hint_cost: int, item_cheat: bool, forfeit_mode: str = "disabled", remaining_mode: str = "disabled",
-                 auto_shutdown: typing.SupportsFloat = 0, compatibility: int = 2):
+                 auto_shutdown: typing.SupportsFloat = 0, compatibility: int = 2, log_network: bool = False):
         super(Context, self).__init__()
+        self.log_network = log_network
+        self.endpoints = []
         self.compatibility: int = compatibility
         self.shutdown_task = None
         self.data_filename = None
@@ -76,6 +85,7 @@ class Context(Node):
         self.connect_names = {}  # names of slots clients can connect to
         self.allow_forfeits = {}
         self.remote_items = set()
+        self.remote_start_inventory = set()
         self.locations: typing.Dict[int, typing.Dict[int, typing.Tuple[int, int]]] = {}
         self.host = host
         self.port = port
@@ -111,17 +121,104 @@ class Context(Node):
         self.games: typing.Dict[int, str] = {}
         self.minimum_client_versions: typing.Dict[int, Utils.Version] = {}
         self.seed_name = ""
+        self.random = random.Random()
 
-    def get_hint_cost(self, slot):
-        if self.hint_cost:
-            return max(0, int(self.hint_cost * 0.01 * len(self.locations[slot])))
-        return 0
+    # General networking
+
+    async def send_msgs(self, endpoint: Endpoint, msgs: typing.Iterable[dict]) -> bool:
+        if not endpoint.socket or not endpoint.socket.open:
+            return False
+        msg = self.dumper(msgs)
+        try:
+            await endpoint.socket.send(msg)
+        except websockets.ConnectionClosed:
+            logging.exception(f"Exception during send_msgs, could not send {msg}")
+            await self.disconnect(endpoint)
+        else:
+            if self.log_network:
+                logging.info(f"Outgoing message: {msg}")
+            return True
+
+    async def send_encoded_msgs(self, endpoint: Endpoint, msg: str) -> bool:
+        if not endpoint.socket or not endpoint.socket.open:
+            return False
+        try:
+            await endpoint.socket.send(msg)
+        except websockets.ConnectionClosed:
+            logging.exception("Exception during send_encoded_msgs")
+            await self.disconnect(endpoint)
+        else:
+            if self.log_network:
+                logging.info(f"Outgoing message: {msg}")
+            return True
+
+    async def broadcast_send_encoded_msgs(self, endpoints: typing.Iterable[Endpoint], msg: str) -> bool:
+        sockets = []
+        for endpoint in endpoints:
+            if endpoint.socket and endpoint.socket.open:
+                sockets.append(endpoint.socket)
+        try:
+            websockets.broadcast(sockets, msg)
+        except RuntimeError:
+            logging.exception("Exception during broadcast_send_encoded_msgs")
+        else:
+            if self.log_network:
+                logging.info(f"Outgoing broadcast: {msg}")
+            return True
+
+    def broadcast_all(self, msgs):
+        msgs = self.dumper(msgs)
+        endpoints = (endpoint for endpoint in self.endpoints if endpoint.auth)
+        asyncio.create_task(self.broadcast_send_encoded_msgs(endpoints, msgs))
+
+    def broadcast_team(self, team: int, msgs):
+        msgs = self.dumper(msgs)
+        endpoints = (endpoint for endpoint in self.endpoints if endpoint.auth and endpoint.team == team)
+        asyncio.create_task(self.broadcast_send_encoded_msgs(endpoints, msgs))
+
+    def broadcast(self, endpoints: typing.Iterable[Endpoint], msgs):
+        msgs = self.dumper(msgs)
+        asyncio.create_task(self.broadcast_send_encoded_msgs(endpoints, msgs))
+
+    async def disconnect(self, endpoint):
+        if endpoint in self.endpoints:
+            self.endpoints.remove(endpoint)
+        await on_client_disconnected(self, endpoint)
+
+    # text
+
+    def notify_all(self, text):
+        logging.info("Notice (all): %s" % text)
+        self.broadcast_all([{"cmd": "Print", "text": text}])
+
+    def notify_client(self, client: Client, text: str):
+        if not client.auth:
+            return
+        logging.info("Notice (Player %s in team %d): %s" % (client.name, client.team + 1, text))
+        asyncio.create_task(self.send_msgs(client, [{"cmd": "Print", "text": text}]))
+
+    def notify_client_multiple(self, client: Client, texts: typing.List[str]):
+        if not client.auth:
+            return
+        asyncio.create_task(self.send_msgs(client, [{"cmd": "Print", "text": text} for text in texts]))
+
+    # loading
 
     def load(self, multidatapath: str, use_embedded_server_options: bool = False):
-        with open(multidatapath, 'rb') as f:
-            data = f.read()
+        if multidatapath.lower().endswith(".zip"):
+            import zipfile
+            with zipfile.ZipFile(multidatapath) as zf:
+                for file in zf.namelist():
+                    if file.endswith(".archipelago"):
+                        data = zf.read(file)
+                        break
+                else:
+                    raise Exception("No .archipelago found in archive.")
+        else:
+            with open(multidatapath, 'rb') as f:
+                data = f.read()
 
-            self._load(self._decompress(data), use_embedded_server_options)
+        self._load(self._decompress(data), use_embedded_server_options)
         self.data_filename = multidatapath
 
     @staticmethod
@@ -147,8 +244,10 @@ class Context(Node):
                 self.player_names[team, player] = name
                 self.player_name_lookup[name] = team, player
         self.seed_name = decoded_obj["seed_name"]
+        self.random.seed(self.seed_name)
         self.connect_names = decoded_obj['connect_names']
         self.remote_items = decoded_obj['remote_items']
+        self.remote_start_inventory = decoded_obj.get('remote_start_inventory', decoded_obj['remote_items'])
         self.locations = decoded_obj['locations']
         self.slot_data = decoded_obj['slot_data']
         self.er_hint_data = {int(player): {int(address): name for address, name in loc_data.items()}
@@ -157,7 +256,7 @@ class Context(Node):
         # award remote-items start inventory:
         for team in range(len(decoded_obj['names'])):
             for slot, item_codes in decoded_obj["precollected_items"].items():
-                if slot in self.remote_items:
+                if slot in self.remote_start_inventory:
                     self.received_items[team, slot] = [NetworkItem(item_code, -2, 0) for item_code in item_codes]
             for slot, hints in decoded_obj["precollected_hints"].items():
                 self.hints[team, slot].update(hints)
@@ -165,27 +264,7 @@ class Context(Node):
             server_options = decoded_obj.get("server_options", {})
             self._set_options(server_options)
 
-    def get_players_package(self):
-        return [NetworkPlayer(t, p, self.get_aliased_name(t, p), n) for (t, p), n in self.player_names.items()]
-
-    def _set_options(self, server_options: dict):
-        for key, value in server_options.items():
-            data_type = self.simple_options.get(key, None)
-            if data_type is not None:
-                if value not in {False, True, None}:  # some can be boolean OR text, such as password
-                    try:
-                        value = data_type(value)
-                    except Exception as e:
-                        try:
-                            raise Exception(f"Could not set server option {key}, skipping.") from e
-                        except Exception as e:
-                            logging.exception(e)
-                logging.debug(f"Setting server option {key} to {value} from supplied multidata")
-                setattr(self, key, value)
-            elif key == "disable_item_cheat":
-                self.item_cheat = not bool(value)
-            else:
-                logging.debug(f"Unrecognized server option {key}")
+    # saving
 
     def save(self, now=False) -> bool:
         if self.saving:
@@ -213,8 +292,10 @@ class Context(Node):
         self.saving = enabled
         if self.saving:
             if not self.save_filename:
-                self.save_filename = (self.data_filename[:-11] if self.data_filename.endswith('.archipelago') else (
-                        self.data_filename + '_')) + 'apsave'
+                import os
+                name, ext = os.path.splitext(self.data_filename)
+                self.save_filename = name + '.apsave' if ext.lower() in ('.archipelago', '.zip') \
+                    else self.data_filename + '_' + 'apsave'
             try:
                 with open(self.save_filename, 'rb') as f:
                     save_data = restricted_loads(zlib.decompress(f.read()))
@@ -242,13 +323,6 @@ class Context(Node):
             import atexit
             atexit.register(self._save, True)  # make sure we save on exit too
 
-    def recheck_hints(self):
-        for team, slot in self.hints:
-            self.hints[team, slot] = {
-                hint.re_check(self, team) for hint in
-                self.hints[team, slot]
-            }
-
     def get_save(self) -> dict:
         self.recheck_hints()
         d = {
@@ -263,6 +337,7 @@ class Context(Node):
                 (key, value.timestamp()) for key, value in self.client_activity_timers.items()),
             "client_connection_timers": tuple(
                 (key, value.timestamp()) for key, value in self.client_connection_timers.items()),
+            "random_state": self.random.getstate()
         }
 
         return d
@@ -283,47 +358,53 @@ class Context(Node):
             {tuple(key): datetime.datetime.fromtimestamp(value, datetime.timezone.utc) for key, value
              in savedata["client_activity_timers"]})
         self.location_checks.update(savedata["location_checks"])
-
+        if "random_state" in savedata:
+            self.random.setstate(savedata["random_state"])
         logging.info(f'Loaded save file with {sum([len(p) for p in self.received_items.values()])} received items '
                      f'for {len(self.received_items)} players')
 
+    # rest
+
+    def get_hint_cost(self, slot):
+        if self.hint_cost:
+            return max(0, int(self.hint_cost * 0.01 * len(self.locations[slot])))
+        return 0
+
+    def recheck_hints(self):
+        for team, slot in self.hints:
+            self.hints[team, slot] = {
+                hint.re_check(self, team) for hint in
+                self.hints[team, slot]
+            }
+
+    def get_players_package(self):
+        return [NetworkPlayer(t, p, self.get_aliased_name(t, p), n) for (t, p), n in self.player_names.items()]
+
+    def _set_options(self, server_options: dict):
+        for key, value in server_options.items():
+            data_type = self.simple_options.get(key, None)
+            if data_type is not None:
+                if value not in {False, True, None}:  # some can be boolean OR text, such as password
+                    try:
+                        value = data_type(value)
+                    except Exception as e:
+                        try:
+                            raise Exception(f"Could not set server option {key}, skipping.") from e
+                        except Exception as e:
+                            logging.exception(e)
+                logging.debug(f"Setting server option {key} to {value} from supplied multidata")
+                setattr(self, key, value)
+            elif key == "disable_item_cheat":
+                self.item_cheat = not bool(value)
+            else:
+                logging.debug(f"Unrecognized server option {key}")
+
     def get_aliased_name(self, team: int, slot: int):
         if (team, slot) in self.name_aliases:
             return f"{self.name_aliases[team, slot]} ({self.player_names[team, slot]})"
         else:
             return self.player_names[team, slot]
 
-    def notify_all(self, text):
-        logging.info("Notice (all): %s" % text)
-        self.broadcast_all([{"cmd": "Print", "text": text}])
-
-    def notify_client(self, client: Client, text: str):
-        if not client.auth:
-            return
-        logging.info("Notice (Player %s in team %d): %s" % (client.name, client.team + 1, text))
-        asyncio.create_task(self.send_msgs(client, [{"cmd": "Print", "text": text}]))
-
-    def notify_client_multiple(self, client: Client, texts: typing.List[str]):
-        if not client.auth:
-            return
-        asyncio.create_task(self.send_msgs(client, [{"cmd": "Print", "text": text} for text in texts]))
-
-    def broadcast_team(self, team, msgs):
-        msgs = self.dumper(msgs)
-        for client in self.endpoints:
-            if client.auth and client.team == team:
-                asyncio.create_task(self.send_encoded_msgs(client, msgs))
-
-    def broadcast_all(self, msgs):
-        msgs = self.dumper(msgs)
-        for endpoint in self.endpoints:
-            if endpoint.auth:
-                asyncio.create_task(self.send_encoded_msgs(endpoint, msgs))
-
-    async def disconnect(self, endpoint):
-        await super(Context, self).disconnect(endpoint)
-        await on_client_disconnected(self, endpoint)
-
 
 def notify_hints(ctx: Context, team: int, hints: typing.List[NetUtils.Hint]):
     concerns = collections.defaultdict(list)
@@ -380,7 +461,7 @@ async def server(websocket, path, ctx: Context):
 async def on_client_connected(ctx: Context, client: Client):
     await ctx.send_msgs(client, [{
         'cmd': 'RoomInfo',
-        'password': ctx.password is not None,
+        'password': bool(ctx.password),
         'players': [
             NetworkPlayer(client.team, client.slot, ctx.name_aliases.get((client.team, client.slot), client.name),
                           client.name) for client
@@ -389,8 +470,10 @@ async def on_client_connected(ctx: Context, client: Client):
         # Name them by feature or fork, as you feel is appropriate.
         'tags': ctx.tags,
         'version': Utils.version_tuple,
+        # TODO ~0.2.0 remove forfeit_mode and remaining_mode in favor of permissions
         'forfeit_mode': ctx.forfeit_mode,
         'remaining_mode': ctx.remaining_mode,
+        'permissions': get_permissions(ctx),
         'hint_cost': ctx.hint_cost,
         'location_check_points': ctx.location_check_points,
         'datapackage_version': network_data_package["version"],
@@ -400,6 +483,13 @@ async def on_client_connected(ctx: Context, client: Client):
     }])
 
 
+def get_permissions(ctx) -> typing.Dict[str, Permission]:
+    return {
+        "forfeit": Permission.from_text(ctx.forfeit_mode),
+        "remaining": Permission.from_text(ctx.remaining_mode),
+    }
+
+
 async def on_client_disconnected(ctx: Context, client: Client):
     if client.auth:
         await on_client_left(ctx, client)
@@ -409,8 +499,13 @@ async def on_client_joined(ctx: Context, client: Client):
     update_client_status(ctx, client, ClientStatus.CLIENT_CONNECTED)
     version_str = '.'.join(str(x) for x in client.version)
     ctx.notify_all(
-        f"{ctx.get_aliased_name(client.team, client.slot)} (Team #{client.team + 1}) has joined the game. "
+        f"{ctx.get_aliased_name(client.team, client.slot)} (Team #{client.team + 1}) "
+        f"playing {ctx.games[client.slot]} has joined. "
         f"Client({version_str}), {client.tags}).")
+    # TODO: remove with 0.2
+    if client.version < Version(0, 1, 7):
+        ctx.notify_client(client,
+                          "Warning: Your client's datapackage handling may be unsupported soon. (Version < 0.1.7)")
 
     ctx.client_connection_timers[client.team, client.slot] = datetime.datetime.now(datetime.timezone.utc)
 
@@ -882,30 +977,28 @@ class ClientMessageProcessor(CommonCommandProcessor):
             self.output("Cheating is disabled.")
             return False
 
-    @mark_raw
-    def _cmd_hint(self, item_or_location: str = "") -> bool:
-        """Use !hint {item_name/location_name}, for example !hint Lamp or !hint Link's House. """
+    def get_hints(self, input_text: str, explicit_location: bool = False) -> bool:
         points_available = get_client_points(self.ctx, self.client)
-        if not item_or_location:
-            self.output(f"A hint costs {self.ctx.get_hint_cost(self.client.slot)} points. "
-                        f"You have {points_available} points.")
+        if not input_text:
             hints = {hint.re_check(self.ctx, self.client.team) for hint in
                      self.ctx.hints[self.client.team, self.client.slot]}
             self.ctx.hints[self.client.team, self.client.slot] = hints
             notify_hints(self.ctx, self.client.team, list(hints))
+            self.output(f"A hint costs {self.ctx.get_hint_cost(self.client.slot)} points. "
+                        f"You have {points_available} points.")
             return True
         else:
             world = proxy_worlds[self.ctx.games[self.client.slot]]
-            item_name, usable, response = get_intended_text(item_or_location, world.all_names)
+            item_name, usable, response = get_intended_text(input_text, world.all_names if not explicit_location else world.location_names)
             if usable:
                 if item_name in world.hint_blacklist:
                     self.output(f"Sorry, \"{item_name}\" is marked as non-hintable.")
                     hints = []
-                elif item_name in world.item_name_groups:
+                elif item_name in world.item_name_groups and not explicit_location:
                     hints = []
                     for item in world.item_name_groups[item_name]:
                         hints.extend(collect_hints(self.ctx, self.client.team, self.client.slot, item))
-                elif item_name in world.item_names:  # item name
+                elif item_name in world.item_names and not explicit_location:  # item name
                     hints = collect_hints(self.ctx, self.client.team, self.client.slot, item_name)
                 else:  # location name
                     hints = collect_hints_location(self.ctx, self.client.team, self.client.slot, item_name)
@@ -924,11 +1017,11 @@ class ClientMessageProcessor(CommonCommandProcessor):
                         if not not_found_hints:  # everything's been found, no need to pay
                             can_pay = 1000
                         elif cost:
-                            can_pay = points_available // cost
+                            can_pay = int((points_available // cost) > 0)  # limit to 1 new hint per call
                         else:
                             can_pay = 1000
 
-                        random.shuffle(not_found_hints)
+                        self.ctx.random.shuffle(not_found_hints)
 
                         hints = found_hints
                         while can_pay > 0:
@@ -938,19 +1031,25 @@ class ClientMessageProcessor(CommonCommandProcessor):
                             hints.append(hint)
                             can_pay -= 1
                             self.ctx.hints_used[self.client.team, self.client.slot] += 1
+                            points_available = get_client_points(self.ctx, self.client)
 
                             if not hint.found:
                                 self.ctx.hints[self.client.team, hint.finding_player].add(hint)
                                 self.ctx.hints[self.client.team, hint.receiving_player].add(hint)
 
                         if not_found_hints:
-                            if hints:
+                            if hints and cost and int((points_available // cost) == 0):
                                 self.output(
-                                    "Could not pay for everything. Rerun the hint later with more points to get the remaining hints.")
+                                    f"There may be more hintables, however, you cannot afford to pay for any more. "
+                                    f" You have {points_available} and need at least "
+                                    f"{self.ctx.get_hint_cost(self.client.slot)}.")
+                            elif hints:
+                                self.output(
+                                    "There may be more hintables, you can rerun the command to find more.")
                             else:
                                 self.output(f"You can't afford the hint. "
                                             f"You have {points_available} points and need at least "
-                                            f"{self.ctx.get_hint_cost(self.client.slot)}")
+                                            f"{self.ctx.get_hint_cost(self.client.slot)}.")
                         notify_hints(self.ctx, self.client.team, hints)
                         self.ctx.save()
                         return True
@@ -962,6 +1061,22 @@ class ClientMessageProcessor(CommonCommandProcessor):
                 self.output(response)
                 return False
 
+    @mark_raw
+    def _cmd_hint(self, item_or_location: str = "") -> bool:
+        """Use !hint {item_name/location_name},
+        for example !hint Lamp or !hint Link's House to get a spoiler peek for that location or item.
+        If hint costs are on, this will only give you one new result,
+        you can rerun the command to get more in that case."""
+        return self.get_hints(item_or_location)
+
+    @mark_raw
+    def _cmd_hint_location(self, location: str = "") -> bool:
+        """Use !hint_location {location_name},
+        for example !hint atomic-bomb to get a spoiler peek for that location.
+        (In the case of factorio, or any other game where item names and location names are identical,
+        this command must be used explicitly.)"""
+        return self.get_hints(location, True)
+
 
 def get_checked_checks(ctx: Context, client: Client) -> typing.List[int]:
     return [location_id for
@@ -1010,8 +1125,8 @@ async def process_client_cmd(ctx: Context, client: Client, args: dict):
         else:
             team, slot = ctx.connect_names[args['name']]
             game = ctx.games[slot]
-            if args['game'] != game:
-                errors.add('InvalidSlot')
+            if "IgnoreGame" not in args["tags"] and args['game'] != game:
+                errors.add('InvalidGame')
             # this can only ever be 0 or 1 elements
             clients = [c for c in ctx.endpoints if c.auth and c.slot == slot and c.team == team]
             if clients:
@@ -1088,7 +1203,8 @@ async def process_client_cmd(ctx: Context, client: Client, args: dict):
             locs = []
             for location in args["locations"]:
                 if type(location) is not int or location not in lookup_any_location_id_to_name:
-                    await ctx.send_msgs(client, [{'cmd': 'InvalidPacket', "type": "arguments", "text": 'LocationScouts'}])
+                    await ctx.send_msgs(client,
+                                        [{'cmd': 'InvalidPacket', "type": "arguments", "text": 'LocationScouts'}])
                     return
                 target_item, target_player = ctx.locations[client.slot][location]
                 locs.append(NetworkItem(target_item, location, target_player))
@@ -1098,13 +1214,26 @@ async def process_client_cmd(ctx: Context, client: Client, args: dict):
         elif cmd == 'StatusUpdate':
             update_client_status(ctx, client, args["status"])
 
-        if cmd == 'Say':
+        elif cmd == 'Say':
             if "text" not in args or type(args["text"]) is not str or not args["text"].isprintable():
                 await ctx.send_msgs(client, [{'cmd': 'InvalidPacket', "type": "arguments", "text": 'Say'}])
                 return
 
             client.messageprocessor(args["text"])
 
+        elif cmd == "Bounce":
+            games = set(args.get("games", []))
+            tags = set(args.get("tags", []))
+            slots = set(args.get("slots", []))
+            args["cmd"] = "Bounced"
+            msg = ctx.dumper([args])
+
+            for bounceclient in ctx.endpoints:
+                if client.team == bounceclient.team and (ctx.games[bounceclient.slot] in games or
+                                                         set(bounceclient.tags) & tags or
+                                                         bounceclient.slot in slots):
+                    await ctx.send_encoded_msgs(bounceclient, msg)
+
 
 def update_client_status(ctx: Context, client: Client, new_status: ClientStatus):
     current = ctx.client_game_state[client.team, client.slot]
@@ -1114,6 +1243,8 @@ def update_client_status(ctx: Context, client: Client, new_status: ClientStatus)
             ctx.notify_all(finished_msg)
             if "auto" in ctx.forfeit_mode:
                 forfeit_player(ctx, client.team, client.slot)
+            elif proxy_worlds[ctx.games[client.slot]].forced_auto_forfeit:
+                forfeit_player(ctx, client.team, client.slot)
 
         ctx.client_game_state[client.team, client.slot] = new_status
 
@@ -1299,6 +1430,8 @@ class ServerCommandProcessor(CommonCommandProcessor):
                     return input_text
             setattr(self.ctx, option_name, attrtype(option))
             self.output(f"Set option {option_name} to {getattr(self.ctx, option_name)}")
+            if option_name in {"forfeit_mode", "remaining_mode"}:
+                self.ctx.broadcast_all([{"cmd": "RoomUpdate", 'permissions': get_permissions(self.ctx)}])
             return True
         else:
             known = (f"{option}:{otype}" for option, otype in self.ctx.simple_options.items())
@@ -1398,8 +1531,7 @@ async def main(args: argparse.Namespace):
 
     ctx = Context(args.host, args.port, args.server_password, args.password, args.location_check_points,
                   args.hint_cost, not args.disable_item_cheat, args.forfeit_mode, args.remaining_mode,
-                  args.auto_shutdown, args.compatibility)
-    ctx.log_network = args.log_network
+                  args.auto_shutdown, args.compatibility, args.log_network)
     data_filename = args.multidata
 
     try:
@@ -1410,19 +1542,6 @@ async def main(args: argparse.Namespace):
             root.withdraw()
             data_filename = tkinter.filedialog.askopenfilename(filetypes=(("Multiworld data", "*.archipelago *.zip"),))
 
-        if data_filename.endswith(".zip"):
-            import zipfile
-            with zipfile.ZipFile(data_filename) as zf:
-                for file in zf.namelist():
-                    if file.endswith(".archipelago"):
-                        import os
-                        data_filename = os.path.join(os.path.dirname(data_filename), file)
-                        with open(data_filename, "wb") as f:
-                            f.write(zf.read(file))
-                        break
-                else:
-                    raise Exception("No .archipelago found in archive.")
-
         ctx.load(data_filename, args.use_embedded_options)
 
     except Exception as e:

NetUtils.py

@@ -1,6 +1,4 @@
 from __future__ import annotations
-import asyncio
-import logging
 import typing
 import enum
 from json import JSONEncoder, JSONDecoder
@@ -27,6 +25,25 @@ class ClientStatus(enum.IntEnum):
     CLIENT_GOAL = 30
 
 
+class Permission(enum.IntEnum):
+    disabled = 0b000  # 0, completely disables access
+    enabled = 0b001  # 1, allows manual use
+    goal = 0b010  # 2, allows manual use after goal completion
+    auto = 0b110  # 6, forces use after goal completion, only works for forfeit
+    auto_enabled = 0b111  # 7, forces use after goal completion, allows manual use any time
+
+    @staticmethod
+    def from_text(text: str):
+        data = 0
+        if "auto" in text:
+            data |= 0b110
+        elif "goal" in text:
+            data |= 0b010
+        if "enabled" in text:
+            data |= 0b001
+        return Permission(data)
+
+
 class NetworkPlayer(typing.NamedTuple):
     team: int
     slot: int
@@ -94,52 +111,6 @@ def _object_hook(o: typing.Any) -> typing.Any:
 decode = JSONDecoder(object_hook=_object_hook).decode
 
 
-class Node:
-    endpoints: typing.List
-    dumper = staticmethod(encode)
-    loader = staticmethod(decode)
-
-    def __init__(self):
-        self.endpoints = []
-        super(Node, self).__init__()
-        self.log_network = 0
-
-    def broadcast_all(self, msgs):
-        msgs = self.dumper(msgs)
-        for endpoint in self.endpoints:
-            asyncio.create_task(self.send_encoded_msgs(endpoint, msgs))
-
-    async def send_msgs(self, endpoint: Endpoint, msgs: typing.Iterable[dict]) -> bool:
-        if not endpoint.socket or not endpoint.socket.open:
-            return False
-        msg = self.dumper(msgs)
-        try:
-            await endpoint.socket.send(msg)
-        except websockets.ConnectionClosed:
-            logging.exception(f"Exception during send_msgs, could not send {msg}")
-            await self.disconnect(endpoint)
-        else:
-            if self.log_network:
-                logging.info(f"Outgoing message: {msg}")
-            return True
-
-    async def send_encoded_msgs(self, endpoint: Endpoint, msg: str) -> bool:
-        if not endpoint.socket or not endpoint.socket.open:
-            return False
-        try:
-            await endpoint.socket.send(msg)
-        except websockets.ConnectionClosed:
-            logging.exception("Exception during send_encoded_msgs")
-            await self.disconnect(endpoint)
-        else:
-            if self.log_network:
-                logging.info(f"Outgoing message: {msg}")
-            return True
-
-    async def disconnect(self, endpoint):
-        if endpoint in self.endpoints:
-            self.endpoints.remove(endpoint)
-
 
 class Endpoint:
     socket: websockets.WebSocketServerProtocol
@@ -198,8 +169,8 @@ class JSONtoTextParser(metaclass=HandlerMeta):
         return "".join(self.handle_node(section) for section in input_object)
 
     def handle_node(self, node: JSONMessagePart):
-        type = node.get("type", None)
-        handler = self.handlers.get(type, self.handlers["text"])
+        node_type = node.get("type", None)
+        handler = self.handlers.get(node_type, self.handlers["text"])
         return handler(node)
 
     def _handle_color(self, node: JSONMessagePart):
@@ -244,7 +215,7 @@ class JSONtoTextParser(metaclass=HandlerMeta):
         return self._handle_item_name(node)
 
     def _handle_entrance_name(self, node: JSONMessagePart):
-        node["color"] = 'white_bg;black'
+        node["color"] = 'blue'
         return self._handle_color(node)
 
 

Options.py

@@ -7,12 +7,15 @@ class AssembleOptions(type):
     def __new__(mcs, name, bases, attrs):
         options = attrs["options"] = {}
         name_lookup = attrs["name_lookup"] = {}
+        # merge parent class options
         for base in bases:
-            if hasattr(base, "options"):
+            if getattr(base, "options", None):
                 options.update(base.options)
-                name_lookup.update(name_lookup)
+                name_lookup.update(base.name_lookup)
         new_options = {name[7:].lower(): option_id for name, option_id in attrs.items() if
                        name.startswith("option_")}
+        if "random" in new_options:
+            raise Exception("Choice option 'random' cannot be manually assigned.")
         attrs["name_lookup"].update({option_id: name for name, option_id in new_options.items()})
         options.update(new_options)
 
@@ -26,28 +29,50 @@ class AssembleOptions(type):
                 def validate(self, *args, **kwargs):
                     func(self, *args, **kwargs)
                     self.value = self.schema.validate(self.value)
+
                 return validate
+
             attrs["__init__"] = validate_decorator(attrs["__init__"])
         return super(AssembleOptions, mcs).__new__(mcs, name, bases, attrs)
 
+
 class Option(metaclass=AssembleOptions):
     value: int
     name_lookup: typing.Dict[int, str]
     default = 0
 
-    def __repr__(self):
-        return f"{self.__class__.__name__}({self.get_option_name()})"
+    # convert option_name_long into Name Long as displayname, otherwise name_long is the result.
+    # Handled in get_option_name()
+    autodisplayname = False
+
+    # can be weighted between selections
+    supports_weighting = True
+
+    def __repr__(self) -> str:
+        return f"{self.__class__.__name__}({self.get_current_option_name()})"
 
     def __hash__(self):
         return hash(self.value)
 
-    def get_option_name(self):
+    @property
+    def current_key(self) -> str:
         return self.name_lookup[self.value]
 
-    def __int__(self):
+    def get_current_option_name(self) -> str:
+        """For display purposes."""
+        return self.get_option_name(self.value)
+
+    @classmethod
+    def get_option_name(cls, value: typing.Any) -> str:
+        if cls.autodisplayname:
+            return cls.name_lookup[value].replace("_", " ").title()
+        else:
+            return cls.name_lookup[value]
+
+    def __int__(self) -> int:
         return self.value
 
-    def __bool__(self):
+    def __bool__(self) -> bool:
         return bool(self.value)
 
     @classmethod
@@ -61,6 +86,7 @@ class Toggle(Option):
     default = 0
 
     def __init__(self, value: int):
+        assert value == 0 or value == 1
         self.value = value
 
     @classmethod
@@ -95,20 +121,30 @@ class Toggle(Option):
     def __int__(self):
         return int(self.value)
 
-    def get_option_name(self):
-        return bool(self.value)
+    @classmethod
+    def get_option_name(cls, value):
+        return ["No", "Yes"][int(value)]
+
 
 class DefaultOnToggle(Toggle):
     default = 1
 
+
 class Choice(Option):
+    autodisplayname = True
+
     def __init__(self, value: int):
         self.value: int = value
 
     @classmethod
     def from_text(cls, text: str) -> Choice:
+        text = text.lower()
+        # TODO: turn on after most people have adjusted their yamls to no longer have suboptions with "random" in them
+        # maybe in 0.2?
+        # if text == "random":
+        #     return cls(random.choice(list(cls.options.values())))
         for optionname, value in cls.options.items():
-            if optionname == text.lower():
+            if optionname == text:
                 return cls(value)
         raise KeyError(
             f'Could not find option "{text}" for "{cls.__name__}", '
@@ -120,6 +156,36 @@ class Choice(Option):
             return cls(data)
         return cls.from_text(str(data))
 
+    def __eq__(self, other):
+        if isinstance(other, self.__class__):
+            return other.value == self.value
+        elif isinstance(other, str):
+            assert other in self.options
+            return other == self.current_key
+        elif isinstance(other, int):
+            assert other in self.name_lookup
+            return other == self.value
+        elif isinstance(other, bool):
+            return other == bool(self.value)
+        else:
+            raise TypeError(f"Can't compare {self.__class__.__name__} with {other.__class__.__name__}")
+
+    def __ne__(self, other):
+        if isinstance(other, self.__class__):
+            return other.value != self.value
+        elif isinstance(other, str):
+            assert other in self.options
+            return other != self.current_key
+        elif isinstance(other, int):
+            assert other in self.name_lookup
+            return other != self.value
+        elif isinstance(other, bool):
+            return other != bool(self.value)
+        elif other is None:
+            return False
+        else:
+            raise TypeError(f"Can't compare {self.__class__.__name__} with {other.__class__.__name__}")
+
 
 class Range(Option, int):
     range_start = 0
@@ -152,8 +218,8 @@ class Range(Option, int):
             return cls(data)
         return cls.from_text(str(data))
 
-    def get_option_name(self):
-        return str(self.value)
+    def get_option_name(self, value):
+        return str(value)
 
     def __str__(self):
         return str(self.value)
@@ -178,9 +244,11 @@ class OptionNameSet(Option):
 
 class OptionDict(Option):
     default = {}
+    supports_weighting = False
+    value: typing.Dict[str, typing.Any]
 
     def __init__(self, value: typing.Dict[str, typing.Any]):
-        self.value: typing.Dict[str, typing.Any] = value
+        self.value = value
 
     @classmethod
     def from_any(cls, data: typing.Dict[str, typing.Any]) -> OptionDict:
@@ -189,31 +257,151 @@ class OptionDict(Option):
         else:
             raise NotImplementedError(f"Cannot Convert from non-dictionary, got {type(data)}")
 
-    def get_option_name(self):
-        return str(self.value)
+    def get_option_name(self, value):
+        return ", ".join(f"{key}: {v}" for key, v in value.items())
+
+    def __contains__(self, item):
+        return item in self.value
+
+
+class OptionList(Option):
+    default = []
+    supports_weighting = False
+    value: list
+
+    def __init__(self, value: typing.List[str, typing.Any]):
+        self.value = value
+        super(OptionList, self).__init__()
+
+    @classmethod
+    def from_text(cls, text: str):
+        return cls([option.strip() for option in text.split(",")])
+
+    @classmethod
+    def from_any(cls, data: typing.Any):
+        if type(data) == list:
+            return cls(data)
+        return cls.from_text(str(data))
+
+    def get_option_name(self, value):
+        return ", ".join(value)
+
+    def __contains__(self, item):
+        return item in self.value
+
+
+class OptionSet(Option):
+    default = frozenset()
+    supports_weighting = False
+    value: set
+
+    def __init__(self, value: typing.Union[typing.Set[str, typing.Any], typing.List[str, typing.Any]]):
+        self.value = set(value)
+        super(OptionSet, self).__init__()
+
+    @classmethod
+    def from_text(cls, text: str):
+        return cls([option.strip() for option in text.split(",")])
+
+    @classmethod
+    def from_any(cls, data: typing.Any):
+        if type(data) == list:
+            return cls(data)
+        elif type(data) == set:
+            return cls(data)
+        return cls.from_text(str(data))
+
+    def get_option_name(self, value):
+        return ", ".join(value)
+
+    def __contains__(self, item):
+        return item in self.value
 
 
 local_objective = Toggle  # local triforce pieces, local dungeon prizes etc.
 
 
 class Accessibility(Choice):
+    """Set rules for reachability of your items/locations.
+    Locations: ensure everything can be reached and acquired.
+    Items: ensure all logically relevant items can be acquired.
+    Minimal: ensure what is needed to reach your goal can be acquired."""
+
     option_locations = 0
     option_items = 1
-    option_beatable = 2
+    option_minimal = 2
+    alias_none = 2
+    default = 1
 
 
+class ProgressionBalancing(DefaultOnToggle):
+    """A system that moves progression earlier, to try and prevent the player from getting stuck and bored early."""
+
+
+common_options = {
+    "progression_balancing": ProgressionBalancing,
+    "accessibility": Accessibility
+}
+
+
+class ItemSet(OptionSet):
+    # implemented by Generate
+    verify_item_name = True
+
+
+class LocalItems(ItemSet):
+    """Forces these items to be in their native world."""
+    displayname = "Local Items"
+
+
+class NonLocalItems(ItemSet):
+    """Forces these items to be outside their native world."""
+    displayname = "Not Local Items"
+
+
+class StartInventory(OptionDict):
+    """Start with these items."""
+    verify_item_name = True
+    displayname = "Start Inventory"
+
+
+class StartHints(ItemSet):
+    """Start with these item's locations prefilled into the !hint command."""
+    displayname = "Start Hints"
+
+
+class StartLocationHints(OptionSet):
+    displayname = "Start Location Hints"
+
+
+class ExcludeLocations(OptionSet):
+    """Prevent these locations from having an important item"""
+    displayname = "Excluded Locations"
+    verify_location_name = True
+
+
+per_game_common_options = {
+    "local_items": LocalItems,
+    "non_local_items": NonLocalItems,
+    "start_inventory": StartInventory,
+    "start_hints": StartHints,
+    "start_location_hints": StartLocationHints,
+    "exclude_locations": OptionSet
+}
+
 if __name__ == "__main__":
 
     from worlds.alttp.Options import Logic
     import argparse
-    mapshuffle = Toggle
-    compassshuffle = Toggle
+
+    map_shuffle = Toggle
+    compass_shuffle = Toggle
     keyshuffle = Toggle
-    bigkeyshuffle = Toggle
+    bigkey_shuffle = Toggle
     hints = Toggle
     test = argparse.Namespace()
     test.logic = Logic.from_text("no_logic")
-    test.mapshuffle = mapshuffle.from_text("ON")
+    test.map_shuffle = map_shuffle.from_text("ON")
     test.hints = hints.from_text('OFF')
     try:
         test.logic = Logic.from_text("overworld_glitches_typo")
@@ -223,7 +411,7 @@ if __name__ == "__main__":
         test.logic_owg = Logic.from_text("owg")
     except KeyError as e:
         print(e)
-    if test.mapshuffle:
-        print("Mapshuffle is on")
+    if test.map_shuffle:
+        print("map_shuffle is on")
     print(f"Hints are {bool(test.hints)}")
     print(test)

Patch.py

@@ -2,7 +2,6 @@ import bsdiff4
 import yaml
 import os
 import lzma
-import hashlib
 import threading
 import concurrent.futures
 import zipfile
@@ -10,37 +9,13 @@ import sys
 from typing import Tuple, Optional
 
 import Utils
-from worlds.alttp.Rom import JAP10HASH
+
 
 current_patch_version = 2
 
 
-def get_base_rom_path(file_name: str = "") -> str:
-    options = Utils.get_options()
-    if not file_name:
-        file_name = options["lttp_options"]["rom_file"]
-    if not os.path.exists(file_name):
-        file_name = Utils.local_path(file_name)
-    return file_name
-
-
-def get_base_rom_bytes(file_name: str = "") -> bytes:
-    from worlds.alttp.Rom import read_rom
-    base_rom_bytes = getattr(get_base_rom_bytes, "base_rom_bytes", None)
-    if not base_rom_bytes:
-        file_name = get_base_rom_path(file_name)
-        base_rom_bytes = bytes(read_rom(open(file_name, "rb")))
-
-        basemd5 = hashlib.md5()
-        basemd5.update(base_rom_bytes)
-        if JAP10HASH != basemd5.hexdigest():
-            raise Exception('Supplied Base Rom does not match known MD5 for JAP(1.0) release. '
-                            'Get the correct game and version, then dump it')
-        get_base_rom_bytes.base_rom_bytes = base_rom_bytes
-    return base_rom_bytes
-
-
 def generate_yaml(patch: bytes, metadata: Optional[dict] = None) -> bytes:
+    from worlds.alttp.Rom import JAP10HASH
     patch = yaml.dump({"meta": metadata,
                        "patch": patch,
                        "game": "A Link to the Past",
@@ -52,6 +27,7 @@ def generate_yaml(patch: bytes, metadata: Optional[dict] = None) -> bytes:
 
 
 def generate_patch(rom: bytes, metadata: Optional[dict] = None) -> bytes:
+    from worlds.alttp.Rom import get_base_rom_bytes
     if metadata is None:
         metadata = {}
     patch = bsdiff4.diff(get_base_rom_bytes(), rom)
@@ -71,6 +47,7 @@ def create_patch_file(rom_file_to_patch: str, server: str = "", destination: str
 
 
 def create_rom_bytes(patch_file: str, ignore_version: bool = False) -> Tuple[dict, str, bytearray]:
+    from worlds.alttp.Rom import get_base_rom_bytes
     data = Utils.parse_yaml(lzma.decompress(load_bytes(patch_file)).decode("utf-8-sig"))
     if not ignore_version and data["compatible_version"] > current_patch_version:
         raise RuntimeError("Patch file is incompatible with this patcher, likely an update is required.")
@@ -184,3 +161,11 @@ if __name__ == "__main__":
 
                 traceback.print_exc()
                 input("Press enter to close.")
+
+
+def read_rom(stream, strip_header=True) -> bytearray:
+    """Reads rom into bytearray and optionally strips off any smc header"""
+    buffer = bytearray(stream.read())
+    if strip_header and len(buffer) % 0x400 == 0x200:
+        return buffer[0x200:]
+    return buffer

README.md

@@ -6,8 +6,13 @@ Currently, the following games are supported:
 * The Legend of Zelda: A Link to the Past
 * Factorio
 * Minecraft
+* Subnautica
+* Slay the Spire
+* Risk of Rain 2
+* The Legend of Zelda: Ocarina of Time
+* Timespinner
 
-For setup and instructions check out our [tutorials page](https://archipelago.gg/tutorial).
+For setup and instructions check out our [tutorials page](/tutorial).
 Downloads can be found at [Releases](https://github.com/ArchipelagoMW/Archipelago/releases), including compiled
 windows binaries.
 
@@ -34,8 +39,9 @@ If you are running Archipelago from a non-Windows system then the likely scenari
 ## Related Repositories
 This project makes use of multiple other projects. We wouldn't be here without these other repositories and the contributions of their developers, past and present.
 
-* [z3randomizer](https://github.com/CaitSith2/z3randomizer)
+* [z3randomizer](https://github.com/ArchipelagoMW/z3randomizer)
 * [Enemizer](https://github.com/Ijwu/Enemizer)
+* [Ocarina of Time Randomizer](https://github.com/TestRunnerSRL/OoT-Randomizer)
 
 ## Contributing
 Contributions are welcome. We have a few asks of any new contributors.

Utils.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import typing
 
 
-def tuplize_version(version: str) -> typing.Tuple[int, ...]:
+def tuplize_version(version: str) -> Version:
     return Version(*(int(piece, 10) for piece in version.split(".")))
 
 
@@ -13,7 +13,7 @@ class Version(typing.NamedTuple):
     build: int
 
 
-__version__ = "0.1.5"
+__version__ = "0.1.9"
 version_tuple = tuplize_version(__version__)
 
 import builtins
@@ -24,7 +24,7 @@ import pickle
 import functools
 import io
 import collections
-
+import importlib
 from yaml import load, dump, safe_load
 
 try:
@@ -51,24 +51,6 @@ def snes_to_pc(value):
     return ((value & 0x7F0000) >> 1) | (value & 0x7FFF)
 
 
-def parse_player_names(names, players, teams):
-    names = tuple(n for n in (n.strip() for n in names.split(",")) if n)
-    if len(names) != len(set(names)):
-        name_counter = collections.Counter(names)
-        raise ValueError(f"Duplicate Player names is not supported, "
-                         f'found multiple "{name_counter.most_common(1)[0][0]}".')
-    ret = []
-    while names or len(ret) < teams:
-        team = [n[:16] for n in names[:players]]
-        # 16 bytes in rom per player, which will map to more in unicode, but those characters later get filtered
-        while len(team) != players:
-            team.append(f"Player{len(team) + 1}")
-        ret.append(team)
-
-        names = names[players:]
-    return ret
-
-
 def cache_argsless(function):
     if function.__code__.co_argcount:
         raise Exception("Can only cache 0 argument functions with this cache.")
@@ -137,6 +119,7 @@ def open_file(filename):
 parse_yaml = safe_load
 unsafe_parse_yaml = functools.partial(load, Loader=Loader)
 
+
 @cache_argsless
 def get_public_ipv4() -> str:
     import socket
@@ -153,6 +136,7 @@ def get_public_ipv4() -> str:
             pass  # we could be offline, in a local game, so no point in erroring out
     return ip
 
+
 @cache_argsless
 def get_public_ipv6() -> str:
     import socket
@@ -166,6 +150,7 @@ def get_public_ipv6() -> str:
         pass  # we could be offline, in a local game, or ipv6 may not be available
     return ip
 
+
 @cache_argsless
 def get_default_options() -> dict:
     # Refer to host.yaml for comments as to what all these options mean.
@@ -211,20 +196,19 @@ def get_default_options() -> dict:
             "glitch_triforce_room": 1,
             "race": 0,
             "plando_options": "bosses",
+        },
+        "minecraft_options": {
+            "forge_directory": "Minecraft Forge server",
+            "max_heap_size": "2G"
+        },
+        "oot_options": {
+            "rom_file": "The Legend of Zelda - Ocarina of Time.z64",
         }
     }
 
     return options
 
 
-blacklisted_options = {"multi_mystery_options.cpu_threads",
-                       "multi_mystery_options.max_attempts",
-                       "multi_mystery_options.take_first_working",
-                       "multi_mystery_options.keep_all_seeds",
-                       "multi_mystery_options.log_output_path",
-                       "multi_mystery_options.log_level"}
-
-
 def update_options(src: dict, dest: dict, filename: str, keys: list) -> dict:
     import logging
     for key, value in src.items():
@@ -233,17 +217,18 @@ def update_options(src: dict, dest: dict, filename: str, keys: list) -> dict:
         option_name = '.'.join(new_keys)
         if key not in dest:
             dest[key] = value
-            if filename.endswith("options.yaml") and option_name not in blacklisted_options:
+            if filename.endswith("options.yaml"):
                 logging.info(f"Warning: {filename} is missing {option_name}")
         elif isinstance(value, dict):
             if not isinstance(dest.get(key, None), dict):
-                if filename.endswith("options.yaml") and option_name not in blacklisted_options:
+                if filename.endswith("options.yaml"):
                     logging.info(f"Warning: {filename} has {option_name}, but it is not a dictionary. overwriting.")
                 dest[key] = value
             else:
                 dest[key] = update_options(value, dest[key], filename, new_keys)
     return dest
 
+
 @cache_argsless
 def get_options() -> dict:
     if not hasattr(get_options, "options"):
@@ -300,7 +285,7 @@ def persistent_load() -> typing.Dict[dict]:
     return storage
 
 
-def get_adjuster_settings(romfile: str) -> typing.Tuple[str, bool]:
+def get_adjuster_settings(romfile: str, skip_questions: bool = False) -> typing.Tuple[str, bool]:
     if hasattr(get_adjuster_settings, "adjuster_settings"):
         adjuster_settings = getattr(get_adjuster_settings, "adjuster_settings")
     else:
@@ -308,11 +293,11 @@ def get_adjuster_settings(romfile: str) -> typing.Tuple[str, bool]:
 
     if adjuster_settings:
         import pprint
-        import Patch
+        from worlds.alttp.Rom import get_base_rom_path
         adjuster_settings.rom = romfile
-        adjuster_settings.baserom = Patch.get_base_rom_path()
+        adjuster_settings.baserom = get_base_rom_path()
         adjuster_settings.world = None
-        whitelist = {"disablemusic", "fastmenu", "heartbeep", "heartcolor", "ow_palettes", "quickswap",
+        whitelist = {"music", "menuspeed", "heartbeep", "heartcolor", "ow_palettes", "quickswap",
                      "uw_palettes", "sprite"}
         printed_options = {name: value for name, value in vars(adjuster_settings).items() if name in whitelist}
         if hasattr(adjuster_settings, "sprite_pool"):
@@ -330,6 +315,8 @@ def get_adjuster_settings(romfile: str) -> typing.Tuple[str, bool]:
             adjust_wanted = getattr(get_adjuster_settings, "adjust_wanted")
         elif persistent_load().get("adjuster", {}).get("never_adjust", False):  # never adjust, per user request
             return romfile, False
+        elif skip_questions:
+            return romfile, False
         else:
             adjust_wanted = input(f"Last used adjuster settings were found. Would you like to apply these? \n"
                                   f"{pprint.pformat(printed_options)}\n"
@@ -358,6 +345,7 @@ def get_adjuster_settings(romfile: str) -> typing.Tuple[str, bool]:
         return romfile, adjusted
     return romfile, False
 
+
 @cache_argsless
 def get_unique_identifier():
     uuid = persistent_load().get("client", {}).get("uuid", None)
@@ -377,16 +365,28 @@ safe_builtins = {
 
 
 class RestrictedUnpickler(pickle.Unpickler):
+    def __init__(self, *args, **kwargs):
+        super(RestrictedUnpickler, self).__init__(*args, **kwargs)
+        self.options_module = importlib.import_module("Options")
+        self.net_utils_module = importlib.import_module("NetUtils")
+        self.generic_properties_module = importlib.import_module("worlds.generic")
+
     def find_class(self, module, name):
         if module == "builtins" and name in safe_builtins:
             return getattr(builtins, name)
+        # used by MultiServer -> savegame/multidata
         if module == "NetUtils" and name in {"NetworkItem", "ClientStatus", "Hint"}:
-            import NetUtils
-            return getattr(NetUtils, name)
-        if module == "Options":
-            import Options
-            obj = getattr(Options, name)
-            if issubclass(obj, Options.Option):
+            return getattr(self.net_utils_module, name)
+        # Options and Plando are unpickled by WebHost -> Generate
+        if module == "worlds.generic" and name in {"PlandoItem", "PlandoConnection"}:
+            return getattr(self.generic_properties_module, name)
+        if module.endswith("Options"):
+            if module == "Options":
+                mod = self.options_module
+            else:
+                mod = importlib.import_module(module)
+            obj = getattr(mod, name)
+            if issubclass(obj, self.options_module.Option):
                 return obj
         # Forbid everything else.
         raise pickle.UnpicklingError("global '%s.%s' is forbidden" %

WebHost.py

@@ -36,7 +36,11 @@ if __name__ == "__main__":
     multiprocessing.freeze_support()
     multiprocessing.set_start_method('spawn')
     logging.basicConfig(format='[%(asctime)s] %(message)s', level=logging.INFO)
-    update_sprites_lttp()
+    try:
+        update_sprites_lttp()
+    except Exception as e:
+        logging.exception(e)
+        logging.warning("Could not update LttP sprites.")
     app = get_app()
     create_options_files()
     if app.config["SELFLAUNCH"]:

WebHostLib/__init__.py

@@ -8,6 +8,7 @@ from pony.flask import Pony
 from flask import Flask, request, redirect, url_for, render_template, Response, session, abort, send_from_directory
 from flask_caching import Cache
 from flask_compress import Compress
+from worlds.AutoWorld import AutoWorldRegister
 
 from .models import *
 
@@ -81,50 +82,32 @@ def page_not_found(err):
     return render_template('404.html'), 404
 
 
-games_list = {
-    "A Link to the Past": ("The Legend of Zelda: A Link to the Past",
-                           """
-                           The Legend of Zelda: A Link to the Past is an action/adventure game. Take on the role of
-                           Link, a boy who is destined to save the land of Hyrule. Delve through three palaces and nine
-                           dungeons on your quest to rescue the descendents of the seven wise men and defeat the evil
-                           Ganon!"""),
-    "Factorio": ("Factorio",
-                 """
-                 Factorio is a game about automation. You play as an engineer who has crash landed on the planet
-                 Nauvis, an inhospitable world filled with dangerous creatures called biters. Build a factory,
-                 research new technologies, and become more efficient in your quest to build a rocket and return home.
-                 """),
-    "Minecraft": ("Minecraft",
-                  """
-                  Minecraft is a game about creativity. In a world made entirely of cubes, you explore, discover, mine,
-                  craft, and try not to explode. Delve deep into the earth and discover abandoned mines, ancient
-                  structures, and materials to create a portal to another world. Defeat the Ender Dragon, and claim
-                  victory!""")
-}
+# Start Playing Page
+@app.route('/start-playing')
+def start_playing():
+    return render_template(f"startPlaying.html")
 
 
 # Player settings pages
 @app.route('/games/<string:game>/player-settings')
 def player_settings(game):
-    return render_template(f"player-settings.html")
+    return render_template(f"player-settings.html", game=game)
 
 
-# Game sub-pages
-@app.route('/games/<string:game>/<string:page>')
-def game_pages(game, page):
-    return render_template(f"/games/{game}/{page}.html")
-
-
-# Game landing pages
-@app.route('/games/<game>')
-def game_page(game):
-    return render_template(f"/games/{game}/{game}.html")
+# Game Info Pages
+@app.route('/games/<string:game>/info/<string:lang>')
+def game_info(game, lang):
+    return render_template('gameInfo.html', game=game, lang=lang)
 
 
 # List of supported games
 @app.route('/games')
 def games():
-    return render_template("games/games.html", games_list=games_list)
+    worlds = {}
+    for game, world in AutoWorldRegister.world_types.items():
+        if not world.hidden:
+            worlds[game] = world.__doc__ if world.__doc__ else "No description provided."
+    return render_template("supportedGames.html", worlds=worlds)
 
 
 @app.route('/tutorial/<string:game>/<string:file>/<string:lang>')
@@ -132,14 +115,14 @@ def tutorial(game, file, lang):
     return render_template("tutorial.html", game=game, file=file, lang=lang)
 
 
-@app.route('/tutorial')
+@app.route('/tutorial/')
 def tutorial_landing():
     return render_template("tutorialLanding.html")
 
 
-@app.route('/weighted-settings')
-def weighted_settings():
-    return render_template("weightedSettings.html")
+@app.route('/faq/<string:lang>/')
+def faq(lang):
+    return render_template("faq.html", lang=lang)
 
 
 @app.route('/seed/<suuid:seed>')
@@ -192,15 +175,20 @@ def hostRoom(room: UUID):
 
     return render_template("hostRoom.html", room=room)
 
+
 @app.route('/hosted/<suuid:room>', methods=['GET', 'POST'])
 def hostRoomRedirect(room: UUID):
     return redirect(url_for("hostRoom", room=room))
 
+
 @app.route('/favicon.ico')
 def favicon():
     return send_from_directory(os.path.join(app.root_path, 'static/static'),
                                'favicon.ico', mimetype='image/vnd.microsoft.icon')
 
+@app.route('/discord')
+def discord():
+    return redirect("https://discord.gg/archipelago")
 
 from WebHostLib.customserver import run_server_process
 from . import tracker, upload, landing, check, generate, downloads, api  # to trigger app routing picking up on it

WebHostLib/autolauncher.py

@@ -89,14 +89,14 @@ def launch_generator(pool: multiprocessing.pool.Pool, generation: Generation):
         options = restricted_loads(generation.options)
         logging.info(f"Generating {generation.id} for {len(options)} players")
         pool.apply_async(gen_game, (options,),
-                         {"race": meta["race"],
+                         {"meta": meta,
                           "sid": generation.id,
                           "owner": generation.owner},
                          handle_generation_success, handle_generation_failure)
-    except:
+    except Exception as e:
         generation.state = STATE_ERROR
         commit()
-        raise
+        logging.exception(e)
     else:
         generation.state = STATE_STARTED
 

WebHostLib/check.py

@@ -49,9 +49,7 @@ def get_yaml_data(file) -> Union[Dict[str, str], str]:
                 for file in infolist:
                     if file.filename.endswith(banned_zip_contents):
                         return "Uploaded data contained a rom file, which is likely to contain copyrighted material. Your file was deleted."
-                    elif file.filename.endswith(".yaml"):
-                        options[file.filename] = zfile.open(file, "r").read()
-                    elif file.filename.endswith(".txt"):
+                    elif file.filename.endswith((".yaml", ".json", ".yml", ".txt")):
                         options[file.filename] = zfile.open(file, "r").read()
         else:
             options = {file.filename: file.read()}
@@ -73,7 +71,8 @@ def roll_options(options: Dict[str, Union[dict, str]]) -> Tuple[Dict[str, Union[
             results[filename] = f"Failed to parse YAML data in {filename}: {e}"
         else:
             try:
-                rolled_results[filename] = roll_settings(yaml_data, plando_options={"bosses"})
+                rolled_results[filename] = roll_settings(yaml_data,
+                                                         plando_options={"bosses", "items", "connections", "texts"})
             except Exception as e:
                 results[filename] = f"Failed to generate mystery in {filename}: {e}"
             else:

WebHostLib/downloads.py

@@ -1,8 +1,8 @@
-from flask import send_file, Response
+from flask import send_file, Response, render_template
 from pony.orm import select
 
 from Patch import update_patch_data
-from WebHostLib import app, Slot, Room, Seed
+from WebHostLib import app, Slot, Room, Seed, cache
 import zipfile
 
 @app.route("/dl_patch/<suuid:room_id>/<int:patch_id>")
@@ -45,10 +45,10 @@ def download_raw_patch(seed_id, player_id: int):
         fname = f"P{patch.player_id}_{patch.player_name}_{app.jinja_env.filters['suuid'](seed_id)}.apbp"
         return send_file(patch_data, as_attachment=True, attachment_filename=fname)
 
-@app.route("/slot_file/<suuid:seed_id>/<int:player_id>")
-def download_slot_file(seed_id, player_id: int):
-    seed = Seed.get(id=seed_id)
-    slot_data: Slot = select(patch for patch in seed.slots if
+@app.route("/slot_file/<suuid:room_id>/<int:player_id>")
+def download_slot_file(room_id, player_id: int):
+    room = Room.get(id=room_id)
+    slot_data: Slot = select(patch for patch in room.seed.slots if
                    patch.player_id == player_id).first()
 
     if not slot_data:
@@ -57,12 +57,27 @@ def download_slot_file(seed_id, player_id: int):
         import io
 
         if slot_data.game == "Minecraft":
-            fname = f"AP_{app.jinja_env.filters['suuid'](seed_id)}_P{slot_data.player_id}_{slot_data.player_name}.apmc"
+            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['PATCH_TARGET'], port=room.last_port)
+            return send_file(io.BytesIO(data), as_attachment=True, attachment_filename=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"):
                         fname = name.rsplit("/", 1)[0]+".zip"
+        elif slot_data.game == "Ocarina of Time":
+            fname = f"AP_{app.jinja_env.filters['suuid'](room_id)}_P{slot_data.player_id}_{slot_data.player_name}.apz5"
         else:
             return "Game download not supported."
-        return send_file(io.BytesIO(slot_data.data), as_attachment=True, attachment_filename=fname)
+        return send_file(io.BytesIO(slot_data.data), as_attachment=True, attachment_filename=fname)
+
+@app.route("/templates")
+@cache.cached()
+def list_yaml_templates():
+    files = []
+    from worlds.AutoWorld import AutoWorldRegister
+    for world_name, world in AutoWorldRegister.world_types.items():
+        if not world.hidden:
+            files.append(world_name)
+    return render_template("templates.html", files=files)

WebHostLib/generate.py

@@ -2,19 +2,22 @@ import os
 import tempfile
 import random
 import json
+import zipfile
 from collections import Counter
+from typing import Dict, Optional as TypeOptional
 
 from flask import request, flash, redirect, url_for, session, render_template
 
 from worlds.alttp.EntranceRandomizer import parse_arguments
 from Main import main as ERmain
-from Main import get_seed, seeddigits
+from BaseClasses import seeddigits, get_seed
 from Generate import handle_name
 import pickle
 
 from .models import *
 from WebHostLib import app
 from .check import get_yaml_data, roll_options
+from .upload import upload_zip_to_db
 
 
 @app.route('/generate', methods=['GET', 'POST'])
@@ -31,6 +34,14 @@ def generate(race=False):
                 flash(options)
             else:
                 results, gen_options = roll_options(options)
+                # get form data -> server settings
+                hint_cost = int(request.form.get("hint_cost", 10))
+                forfeit_mode = request.form.get("forfeit_mode", "goal")
+                meta = {"race": race, "hint_cost": hint_cost, "forfeit_mode": forfeit_mode}
+                if race:
+                    meta["item_cheat"] = False
+                    meta["remaining"] = False
+
                 if any(type(result) == str for result in results.values()):
                     return render_template("checkResult.html", results=results)
                 elif len(gen_options) > app.config["MAX_ROLL"]:
@@ -40,7 +51,8 @@ def generate(race=False):
                     gen = Generation(
                         options=pickle.dumps({name: vars(options) for name, options in gen_options.items()}),
                         # convert to json compatible
-                        meta=json.dumps({"race": race}), state=STATE_QUEUED,
+                        meta=json.dumps(meta),
+                        state=STATE_QUEUED,
                         owner=session["_id"])
                     commit()
 
@@ -48,18 +60,24 @@ def generate(race=False):
                 else:
                     try:
                         seed_id = gen_game({name: vars(options) for name, options in gen_options.items()},
-                                           race=race, owner=session["_id"].int)
+                                           meta=meta, owner=session["_id"].int)
                     except BaseException as e:
                         from .autolauncher import handle_generation_failure
                         handle_generation_failure(e)
-                        return render_template("seedError.html", seed_error=(e.__class__.__name__ + ": "+ str(e)))
+                        return render_template("seedError.html", seed_error=(e.__class__.__name__ + ": " + str(e)))
 
                     return redirect(url_for("viewSeed", seed=seed_id))
 
     return render_template("generate.html", race=race)
 
 
-def gen_game(gen_options, race=False, owner=None, sid=None):
+def gen_game(gen_options, meta: TypeOptional[Dict[str, object]] = None, owner=None, sid=None):
+    if not meta:
+        meta: Dict[str, object] = {}
+
+    meta.setdefault("hint_cost", 10)
+    race = meta.get("race", False)
+    del (meta["race"])
     try:
         target = tempfile.TemporaryDirectory()
         playercount = len(gen_options)
@@ -69,14 +87,13 @@ def gen_game(gen_options, race=False, owner=None, sid=None):
         if race:
             random.seed()  # reset to time-based random source
 
-        seedname = "M" + (f"{random.randint(0, pow(10, seeddigits) - 1)}".zfill(seeddigits))
+        seedname = "W" + (f"{random.randint(0, pow(10, seeddigits) - 1)}".zfill(seeddigits))
 
         erargs = parse_arguments(['--multi', str(playercount)])
         erargs.seed = seed
         erargs.name = {x: "" for x in range(1, playercount + 1)}  # only so it can be overwrittin in mystery
-        erargs.create_spoiler = not race
+        erargs.spoiler = 0 if race else 2
         erargs.race = race
-        erargs.skip_playthrough = race
         erargs.outputname = seedname
         erargs.outputpath = target.name
         erargs.teams = 1
@@ -85,17 +102,18 @@ def gen_game(gen_options, race=False, owner=None, sid=None):
         for player, (playerfile, settings) in enumerate(gen_options.items(), 1):
             for k, v in settings.items():
                 if v is not None:
-                    getattr(erargs, k)[player] = v
+                    if hasattr(erargs, k):
+                        getattr(erargs, k)[player] = v
+                    else:
+                        setattr(erargs, k, {player: v})
 
             if not erargs.name[player]:
                 erargs.name[player] = os.path.splitext(os.path.split(playerfile)[-1])[0]
             erargs.name[player] = handle_name(erargs.name[player], player, name_counter)
 
-        erargs.names = ",".join(erargs.name[i] for i in range(1, playercount + 1))
-        del (erargs.name)
-        ERmain(erargs, seed)
+        ERmain(erargs, seed, baked_server_options=meta)
 
-        return upload_to_db(target.name, owner, sid, race)
+        return upload_to_db(target.name, sid, owner, race)
     except BaseException as e:
         if sid:
             with db_session:
@@ -103,7 +121,7 @@ def gen_game(gen_options, race=False, owner=None, sid=None):
                 if gen is not None:
                     gen.state = STATE_ERROR
                     meta = json.loads(gen.meta)
-                    meta["error"] = (e.__class__.__name__ + ": "+ str(e))
+                    meta["error"] = (e.__class__.__name__ + ": " + str(e))
                     gen.meta = json.dumps(meta)
 
                     commit()
@@ -125,37 +143,19 @@ def wait_seed(seed: UUID):
     return render_template("waitSeed.html", seed_id=seed_id)
 
 
-def upload_to_db(folder, owner, sid, race:bool):
-    slots = set()
-    spoiler = ""
-
-    multidata = None
+def upload_to_db(folder, sid, owner, race):
     for file in os.listdir(folder):
         file = os.path.join(folder, file)
-        if file.endswith(".apbp"):
-            player_text = file.split("_P", 1)[1]
-            player_name = player_text.split("_", 1)[1].split(".", 1)[0]
-            player_id = int(player_text.split(".", 1)[0].split("_", 1)[0])
-            slots.add(Slot(data=open(file, "rb").read(),
-                             player_id=player_id, player_name = player_name, game = "A Link to the Past"))
-        elif file.endswith(".txt"):
-            spoiler = open(file, "rt", encoding="utf-8-sig").read()
-        elif file.endswith(".archipelago"):
-            multidata = open(file, "rb").read()
-    if multidata:
-        with db_session:
-            if sid:
-                seed = Seed(multidata=multidata, spoiler=spoiler, slots=slots, owner=owner,
-                            id=sid, meta=json.dumps({"race": race, "tags": ["generated"]}))
-            else:
-                seed = Seed(multidata=multidata, spoiler=spoiler, slots=slots, owner=owner,
-                            meta=json.dumps({"race": race, "tags": ["generated"]}))
-            for patch in slots:
-                patch.seed = seed
-            if sid:
-                gen = Generation.get(id=sid)
-                if gen is not None:
-                    gen.delete()
-        return seed.id
-    else:
-        raise Exception("Multidata required (.archipelago), but not found.")
+        if file.endswith(".zip"):
+            with db_session:
+                with zipfile.ZipFile(file) as zfile:
+                    res = upload_zip_to_db(zfile, owner, {"race": race}, sid)
+                if type(res) == "str":
+                    raise Exception(res)
+                elif res:
+                    seed = res
+                    gen = Generation.get(id=seed.id)
+                    if gen is not None:
+                        gen.delete()
+                    return seed.id
+    raise Exception("Generation zipfile not found.")

WebHostLib/options.py

@@ -5,23 +5,44 @@ import yaml
 import json
 
 from worlds.AutoWorld import AutoWorldRegister
+import Options
 
 target_folder = os.path.join("WebHostLib", "static", "generated")
 
 
 def create():
+    def dictify_range(option):
+        data = {option.range_start: 0, option.range_end: 0, "random": 0, "random-low": 0, "random-high": 0,
+                option.default: 50}
+        notes = {
+            option.range_start: "minimum value",
+            option.range_end: "maximum value"
+        }
+        return data, notes
+
+    def default_converter(default_value):
+        if isinstance(default_value, (set, frozenset)):
+            return list(default_value)
+        return default_value
+
     for game_name, world in AutoWorldRegister.world_types.items():
         res = Template(open(os.path.join("WebHostLib", "templates", "options.yaml")).read()).render(
-            options=world.options, __version__=__version__, game=game_name, yaml_dump=yaml.dump
+            options={**world.options, **Options.per_game_common_options},
+            __version__=__version__, game=game_name, yaml_dump=yaml.dump,
+            dictify_range=dictify_range, default_converter=default_converter,
         )
 
-        with open(os.path.join(target_folder, game_name + ".yaml"), "w") as f:
+        if not os.path.isdir(os.path.join(target_folder, 'configs')):
+            os.mkdir(os.path.join(target_folder, 'configs'))
+
+        with open(os.path.join(target_folder, 'configs', game_name + ".yaml"), "w") as f:
             f.write(res)
 
         # Generate JSON files for player-settings pages
         player_settings = {
             "baseOptions": {
                 "description": "Generated by https://archipelago.gg/",
+                "game": game_name,
                 "name": "Player",
             },
         }
@@ -31,15 +52,15 @@ def create():
             if option.options:
                 this_option = {
                     "type": "select",
-                    "friendlyName": option.friendly_name if hasattr(option, "friendly_name") else option_name,
+                    "displayName": option.displayname if hasattr(option, "displayname") else option_name,
                     "description": option.__doc__ if option.__doc__ else "Please document me!",
                     "defaultValue": None,
                     "options": []
                 }
 
-                for sub_option_name, sub_option_id in option.options.items():
+                for sub_option_id, sub_option_name in option.name_lookup.items():
                     this_option["options"].append({
-                        "name": sub_option_name,
+                        "name": option.get_option_name(sub_option_id),
                         "value": sub_option_name,
                     })
 
@@ -48,7 +69,20 @@ def create():
 
                 game_options[option_name] = this_option
 
+            elif hasattr(option, "range_start") and hasattr(option, "range_end"):
+                game_options[option_name] = {
+                    "type": "range",
+                    "displayName": option.displayname if hasattr(option, "displayname") else option_name,
+                    "description": option.__doc__ if option.__doc__ else "Please document me!",
+                    "defaultValue": option.default if hasattr(option, "default") else option.range_start,
+                    "min": option.range_start,
+                    "max": option.range_end,
+                }
+
         player_settings["gameOptions"] = game_options
 
-        with open(os.path.join(target_folder, game_name + ".json"), "w") as f:
+        if not os.path.isdir(os.path.join(target_folder, 'player-settings')):
+            os.mkdir(os.path.join(target_folder, 'player-settings'))
+
+        with open(os.path.join(target_folder, 'player-settings', game_name + ".json"), "w") as f:
             f.write(json.dumps(player_settings, indent=2, separators=(',', ': ')))

WebHostLib/static/assets/faq.js

@@ -0,0 +1,53 @@
+window.addEventListener('load', () => {
+    const tutorialWrapper = document.getElementById('faq-wrapper');
+    new Promise((resolve, reject) => {
+        const ajax = new XMLHttpRequest();
+        ajax.onreadystatechange = () => {
+            if (ajax.readyState !== 4) { return; }
+            if (ajax.status === 404) {
+                reject("Sorry, the tutorial is not available in that language yet.");
+                return;
+            }
+            if (ajax.status !== 200) {
+                reject("Something went wrong while loading the tutorial.");
+                return;
+            }
+            resolve(ajax.responseText);
+        };
+        ajax.open('GET', `${window.location.origin}/static/assets/faq/` +
+          `faq_${tutorialWrapper.getAttribute('data-lang')}.md`, true);
+        ajax.send();
+    }).then((results) => {
+        // Populate page with HTML generated from markdown
+        showdown.setOption('tables', true);
+        showdown.setOption('strikethrough', true);
+        showdown.setOption('literalMidWordUnderscores', true);
+        tutorialWrapper.innerHTML += (new showdown.Converter()).makeHtml(results);
+        adjustHeaderWidth();
+
+        // Reset the id of all header divs to something nicer
+        const headers = Array.from(document.querySelectorAll('h1, h2, h3, h4, h5, h6'));
+        const scrollTargetIndex = window.location.href.search(/#[A-z0-9-_]*$/);
+        for (let i=0; i < headers.length; i++){
+            const headerId = headers[i].innerText.replace(/[ ]/g,'-').toLowerCase()
+            headers[i].setAttribute('id', headerId);
+            headers[i].addEventListener('click', () =>
+                window.location.href = window.location.href.substring(0, scrollTargetIndex) + `#${headerId}`);
+        }
+
+        // Manually scroll the user to the appropriate header if anchor navigation is used
+        if (scrollTargetIndex > -1) {
+            try{
+                const scrollTarget = window.location.href.substring(scrollTargetIndex + 1);
+                document.getElementById(scrollTarget).scrollIntoView({ behavior: "smooth" });
+            } catch(error) {
+                console.error(error);
+            }
+        }
+    }).catch((error) => {
+        console.error(error);
+        tutorialWrapper.innerHTML =
+            `<h2>This page is out of logic!</h2>
+            <h3>Click <a href="${window.location.origin}">here</a> to return to safety.</h3>`;
+    });
+});

WebHostLib/static/assets/faq/faq_en.md

@@ -0,0 +1,52 @@
+# Frequently Asked Questions
+
+## What is a randomizer?
+A randomizer is a modification of a video game which reorganizes the items required to progress through the game.
+A normal play-through of a game might require you to use item A to unlock item B, then C, and so forth. In a
+randomized game, you might first find item C, then A, then B.
+
+This transforms games from a linear experience into a puzzle, presenting players with a new challenge each time they
+play a randomized game. Putting items in non-standard locations can require the player to think about the game world
+and the items they encounter in new and interesting ways.
+
+## What happens if an item is placed somewhere it is impossible to get?
+The randomizer has many strict sets of rules it must follow when generating a game. One of the functions of these
+rules is to ensure items necessary to complete the game will be accessible to the player. Many games also have a
+subset of rules allowing certain items to be placed in normally unreachable locations, provided the player has
+indicated they are comfortable exploiting certain glitches in the game.
+
+## What is a multi-world?
+While a randomizer shuffles a game, a multi-world randomizer shuffles that game for multiple players. For example,
+in a two player multi-world, players A and B each get their own randomized version of a game, called seeds. In each
+player's game, they may find items which belong to the other player. If player A finds an item which belongs to
+player B, the item will be sent to player B's world over the internet.
+
+This creates a cooperative experience during multi-world games, requiring players to rely upon each other to complete
+their game. Currently, a maximum of 255 players can participate in a single multi-world.
+
+## What happens if a person has to leave early?
+If a player must leave early, they can use Archipelago's forfeit system. When a player forfeits their game, all
+the items in that game which belong to other players are sent out automatically, so other players can continue to
+play.
+
+## What does multi-game mean?
+While a multi-world game traditionally requires all players to be playing the same game, a multi-game multi-world
+allows players to randomize any of a number of supported games, and send items between them. This allows players of
+different games to interact with one another in a single multiplayer environment.
+
+## Can I generate a single-player game with Archipelago?
+Yes. All our supported games can be generated as single-player experiences, and so long as you download the software,
+the website is not required to generate them.
+
+## How do I get started?
+If you are ready to start randomizing games, or want to start playing your favorite randomizer with others,
+please join our [Discord server](https://discord.gg/8Z65BR2). There are always people ready to answer any questions
+you might have.
+
+## I want to add a game to the Archipelago randomizer. How do I do that?
+The best way to get started is to take a look at our [code on GitHub](https://github.com/ArchipelagoMW/Archipelago).
+There, you will find examples of games in the [worlds](https://github.com/ArchipelagoMW/Archipelago/tree/main/worlds)
+folder, as well as some [documentation](https://github.com/ArchipelagoMW/Archipelago/tree/main/docs) on our
+network interfaces.
+
+If you have more questions, feel free to ask in the **#archipelago-dev** channel on our Discord.

WebHostLib/static/assets/gameInfo.js

@@ -0,0 +1,53 @@
+window.addEventListener('load', () => {
+    const gameInfo = document.getElementById('game-info');
+    new Promise((resolve, reject) => {
+        const ajax = new XMLHttpRequest();
+        ajax.onreadystatechange = () => {
+            if (ajax.readyState !== 4) { return; }
+            if (ajax.status === 404) {
+                reject("Sorry, this game's info page is not available in that language yet.");
+                return;
+            }
+            if (ajax.status !== 200) {
+                reject("Something went wrong while loading the info page.");
+                return;
+            }
+            resolve(ajax.responseText);
+        };
+        ajax.open('GET', `${window.location.origin}/static/assets/gameInfo/` +
+          `${gameInfo.getAttribute('data-lang')}_${gameInfo.getAttribute('data-game')}.md`, true);
+        ajax.send();
+    }).then((results) => {
+        // Populate page with HTML generated from markdown
+        showdown.setOption('tables', true);
+        showdown.setOption('strikethrough', true);
+        showdown.setOption('literalMidWordUnderscores', true);
+        gameInfo.innerHTML += (new showdown.Converter()).makeHtml(results);
+        adjustHeaderWidth();
+
+        // Reset the id of all header divs to something nicer
+        const headers = Array.from(document.querySelectorAll('h1, h2, h3, h4, h5, h6'));
+        const scrollTargetIndex = window.location.href.search(/#[A-z0-9-_]*$/);
+        for (let i=0; i < headers.length; i++){
+            const headerId = headers[i].innerText.replace(/[ ]/g,'-').toLowerCase()
+            headers[i].setAttribute('id', headerId);
+            headers[i].addEventListener('click', () =>
+                window.location.href = window.location.href.substring(0, scrollTargetIndex) + `#${headerId}`);
+        }
+
+        // Manually scroll the user to the appropriate header if anchor navigation is used
+        if (scrollTargetIndex > -1) {
+            try{
+                const scrollTarget = window.location.href.substring(scrollTargetIndex + 1);
+                document.getElementById(scrollTarget).scrollIntoView({ behavior: "smooth" });
+            } catch(error) {
+                console.error(error);
+            }
+        }
+    }).catch((error) => {
+        console.error(error);
+        gameInfo.innerHTML =
+            `<h2>This page is out of logic!</h2>
+            <h3>Click <a href="${window.location.origin}">here</a> to return to safety.</h3>`;
+    });
+});

WebHostLib/static/assets/gameInfo/en_A Link to the Past.md

@@ -0,0 +1,26 @@
+# A Link to the Past
+
+## Where is the settings page?
+The player settings page for this game is located <a href="../player-settings">here</a>. It contains all the options
+you need to configure and export a config file.
+
+## What does randomization do to this game?
+Items which the player would normally acquire throughout the game have been moved around. Logic remains, so the game
+is always able to be completed, but because of the item shuffle the player may need to access certain areas before
+they would in the vanilla game.
+
+## What items and locations get shuffled?
+All main inventory items, collectables, and ammunition can be shuffled, and all locations in the game which could
+contain any of those items may have their contents changed.
+
+## Which items can be in another player's world?
+Any of the items which can be shuffled may also be placed into another player's world. It is possible to choose to
+limit certain items to your own world.
+
+## What does another world's item look like in LttP?
+Items belonging to other worlds are represented by a Power Star from Super Mario World.
+
+## When the player receives an item, what happens?
+When the player receives an item, Link will hold the item above his head and display it to the world. It's good for
+business!
+

WebHostLib/static/assets/gameInfo/en_Factorio.md

@@ -0,0 +1,29 @@
+# Factorio
+
+## Where is the settings page?
+The player settings page for this game is located <a href="../player-settings">here</a>. It contains all the options
+you need to configure and export a config file.
+
+## What does randomization do to this game?
+In Factorio, the research tree is shuffled, causing certain technologies to be obtained in a non-standard order.
+Recipe costs, technology requirements, and science pack requirements may also be shuffled at the player's discretion.
+
+## What Factorio items can appear in other players' worlds?
+Factorio's technologies are removed from its tech tree and placed into other players' worlds. When those technologies
+are found, they are sent back to Factorio along with, optionally, free samples of those technologies.
+
+## What is a free sample?
+A free sample is a single or stack of items in Factorio, granted by a technology received from another world. For
+example, receiving the technology  
+`Portable Solar Panel` may also grant the player a stack of portable solar panels,
+and place them directly into the player's inventory.
+
+## What does another world's item look like in Factorio?
+In Factorio, items which need to be sent to other worlds appear in the tech tree as new research items. They are
+represented by the Archipelago icon, and must be researched as if it were a normal technology. Upon successful
+completion of research, the item will be sent to its home world.
+
+## When the engineer receives an item, what happens?
+When the player receives a technology, it is instantly learned and able to be crafted. A message will appear in the
+chat log to notify the player, and if free samples are enabled the player may also receive some items directly to
+their inventory.

WebHostLib/static/assets/gameInfo/en_Ocarina of Time.md

@@ -0,0 +1,26 @@
+# Ocarina of Time
+
+## Where is the settings page?
+The player settings page for this game is located <a href="../player-settings">here</a>. It contains all the options
+you need to configure and export a config file.
+
+## What does randomization do to this game?
+Items which the player would normally acquire throughout the game have been moved around. Logic remains, so the game
+is always able to be completed, but because of the item shuffle the player may need to access certain areas before
+they would in the vanilla game.
+
+## What items and locations get shuffled?
+All main inventory items, collectables, and ammunition can be shuffled, and all locations in the game which could
+contain any of those items may have their contents changed. Gold Skultulla locations may also be included as necessary
+checks at the user's discretion.
+
+## Which items can be in another player's world?
+Any of the items which can be shuffled may also be placed into another player's world. It is possible to choose to
+limit certain items to your own world.
+
+## What does another world's item look like in OoT?
+Items belonging to other worlds are represented by an Ocarina of Time.
+
+## When the player receives an item, what happens?
+When the player receives an item, Link will hold the item above his head and display it to the world. It's good for
+business!

WebHostLib/static/assets/gameInfo/en_Subnautica.md

@@ -0,0 +1,27 @@
+# Subnautica
+
+## Where is the settings page?
+The player settings page for this game is located <a href="../player-settings">here</a>. It contains all the options
+you need to configure and export a config file.
+
+## What does randomization do to this game?
+The most noticeable change is the complete removal of freestanding technologies. The technology blueprints normally
+awarded from scanning those items have been shuffled into location checks throughout the AP item pool.
+
+## What is the goal of Subnautica when randomized?
+The goal remains unchanged. Cure the plague, build the Neptune Escape Rocket, and escape into space.
+
+## What items and locations get shuffled?
+Most of the technologies the player will need throughout the game will be shuffled. Location checks in Subnautica are
+data pads and technology lockers.
+
+## Which items can be in another player's world?
+Most technologies may be shuffled into another player's world.
+
+## What does another world's item look like in Subnautica?
+Location checks in Subnautica are data pads and technology lockers. Opening one of these will send an item to
+another player's world.
+
+## When the player receives a technology, what happens?
+When the player receives a technology, the chat log displays a notification the technology has been received.
+

WebHostLib/static/assets/gameInfo/en_Timespinner.md

@@ -0,0 +1,28 @@
+# Timespinner
+
+## Where is the settings page?
+The player settings page for this game is located <a href="../player-settings">here</a>. It contains all the options
+you need to configure and export a config file.
+
+## What does randomization do to this game?
+Items which the player would normally acquire throughout the game have been moved around. Logic remains, so the game
+is always able to be completed, but because of the item shuffle the player may need to access certain areas before
+they would in the vanilla game. All rings and spells are also randomized into those item locations, therefor you can no longer craft them at the alchemist
+
+## What is the goal of Timespinner when randomized?
+The goal remains unchanged. Kill the Sandman\Nightmare!
+
+## What items and locations get shuffled?
+All main inventory items, orbs, collectables, and familiers can be shuffled, and all locations in the game which could
+contain any of those items may have their contents changed.
+
+## Which items can be in another player's world?
+Any of the items which can be shuffled may also be placed into another player's world. It is possible to choose to
+limit certain items to your own world.
+
+## What does another world's item look like in Timespinner?
+Items belonging to other worlds are represented by the vanilla item [Elemental Beads](https://timespinnerwiki.com/Use_Items), Elemental Beads have no use in the randomizer
+
+## When the player receives an item, what happens?
+When the player receives an item, the same items popup will be displayed as when you would normally obtain the item
+

WebHostLib/static/assets/md5.min.js

@@ -0,0 +1,2 @@
+// Copyright © 2011 Sebastian Tschan, https://blueimp.net
+!function(n){"use strict";function d(n,t){var r=(65535&n)+(65535&t);return(n>>16)+(t>>16)+(r>>16)<<16|65535&r}function f(n,t,r,e,o,u){return d((c=d(d(t,n),d(e,u)))<<(f=o)|c>>>32-f,r);var c,f}function l(n,t,r,e,o,u,c){return f(t&r|~t&e,n,t,o,u,c)}function v(n,t,r,e,o,u,c){return f(t&e|r&~e,n,t,o,u,c)}function g(n,t,r,e,o,u,c){return f(t^r^e,n,t,o,u,c)}function m(n,t,r,e,o,u,c){return f(r^(t|~e),n,t,o,u,c)}function i(n,t){var r,e,o,u;n[t>>5]|=128<<t%32,n[14+(t+64>>>9<<4)]=t;for(var c=1732584193,f=-271733879,i=-1732584194,a=271733878,h=0;h<n.length;h+=16)c=l(r=c,e=f,o=i,u=a,n[h],7,-680876936),a=l(a,c,f,i,n[h+1],12,-389564586),i=l(i,a,c,f,n[h+2],17,606105819),f=l(f,i,a,c,n[h+3],22,-1044525330),c=l(c,f,i,a,n[h+4],7,-176418897),a=l(a,c,f,i,n[h+5],12,1200080426),i=l(i,a,c,f,n[h+6],17,-1473231341),f=l(f,i,a,c,n[h+7],22,-45705983),c=l(c,f,i,a,n[h+8],7,1770035416),a=l(a,c,f,i,n[h+9],12,-1958414417),i=l(i,a,c,f,n[h+10],17,-42063),f=l(f,i,a,c,n[h+11],22,-1990404162),c=l(c,f,i,a,n[h+12],7,1804603682),a=l(a,c,f,i,n[h+13],12,-40341101),i=l(i,a,c,f,n[h+14],17,-1502002290),c=v(c,f=l(f,i,a,c,n[h+15],22,1236535329),i,a,n[h+1],5,-165796510),a=v(a,c,f,i,n[h+6],9,-1069501632),i=v(i,a,c,f,n[h+11],14,643717713),f=v(f,i,a,c,n[h],20,-373897302),c=v(c,f,i,a,n[h+5],5,-701558691),a=v(a,c,f,i,n[h+10],9,38016083),i=v(i,a,c,f,n[h+15],14,-660478335),f=v(f,i,a,c,n[h+4],20,-405537848),c=v(c,f,i,a,n[h+9],5,568446438),a=v(a,c,f,i,n[h+14],9,-1019803690),i=v(i,a,c,f,n[h+3],14,-187363961),f=v(f,i,a,c,n[h+8],20,1163531501),c=v(c,f,i,a,n[h+13],5,-1444681467),a=v(a,c,f,i,n[h+2],9,-51403784),i=v(i,a,c,f,n[h+7],14,1735328473),c=g(c,f=v(f,i,a,c,n[h+12],20,-1926607734),i,a,n[h+5],4,-378558),a=g(a,c,f,i,n[h+8],11,-2022574463),i=g(i,a,c,f,n[h+11],16,1839030562),f=g(f,i,a,c,n[h+14],23,-35309556),c=g(c,f,i,a,n[h+1],4,-1530992060),a=g(a,c,f,i,n[h+4],11,1272893353),i=g(i,a,c,f,n[h+7],16,-155497632),f=g(f,i,a,c,n[h+10],23,-1094730640),c=g(c,f,i,a,n[h+13],4,681279174),a=g(a,c,f,i,n[h],11,-358537222),i=g(i,a,c,f,n[h+3],16,-722521979),f=g(f,i,a,c,n[h+6],23,76029189),c=g(c,f,i,a,n[h+9],4,-640364487),a=g(a,c,f,i,n[h+12],11,-421815835),i=g(i,a,c,f,n[h+15],16,530742520),c=m(c,f=g(f,i,a,c,n[h+2],23,-995338651),i,a,n[h],6,-198630844),a=m(a,c,f,i,n[h+7],10,1126891415),i=m(i,a,c,f,n[h+14],15,-1416354905),f=m(f,i,a,c,n[h+5],21,-57434055),c=m(c,f,i,a,n[h+12],6,1700485571),a=m(a,c,f,i,n[h+3],10,-1894986606),i=m(i,a,c,f,n[h+10],15,-1051523),f=m(f,i,a,c,n[h+1],21,-2054922799),c=m(c,f,i,a,n[h+8],6,1873313359),a=m(a,c,f,i,n[h+15],10,-30611744),i=m(i,a,c,f,n[h+6],15,-1560198380),f=m(f,i,a,c,n[h+13],21,1309151649),c=m(c,f,i,a,n[h+4],6,-145523070),a=m(a,c,f,i,n[h+11],10,-1120210379),i=m(i,a,c,f,n[h+2],15,718787259),f=m(f,i,a,c,n[h+9],21,-343485551),c=d(c,r),f=d(f,e),i=d(i,o),a=d(a,u);return[c,f,i,a]}function a(n){for(var t="",r=32*n.length,e=0;e<r;e+=8)t+=String.fromCharCode(n[e>>5]>>>e%32&255);return t}function h(n){var t=[];for(t[(n.length>>2)-1]=void 0,e=0;e<t.length;e+=1)t[e]=0;for(var r=8*n.length,e=0;e<r;e+=8)t[e>>5]|=(255&n.charCodeAt(e/8))<<e%32;return t}function e(n){for(var t,r="0123456789abcdef",e="",o=0;o<n.length;o+=1)t=n.charCodeAt(o),e+=r.charAt(t>>>4&15)+r.charAt(15&t);return e}function r(n){return unescape(encodeURIComponent(n))}function o(n){return a(i(h(t=r(n)),8*t.length));var t}function u(n,t){return function(n,t){var r,e,o=h(n),u=[],c=[];for(u[15]=c[15]=void 0,16<o.length&&(o=i(o,8*n.length)),r=0;r<16;r+=1)u[r]=909522486^o[r],c[r]=1549556828^o[r];return e=i(u.concat(h(t)),512+8*t.length),a(i(c.concat(e),640))}(r(n),r(t))}function t(n,t,r){return t?r?u(t,n):e(u(t,n)):r?o(n):e(o(n))}"function"==typeof define&&define.amd?define(function(){return t}):"object"==typeof module&&module.exports?module.exports=t:n.md5=t}(this);

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/assets/ootTracker.js

@@ -0,0 +1,52 @@
+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, small keys, and boss keys in the location-table
+      const types = ['counter', 'smallkeys', 'bosskeys'];
+      for (let j = 0; j < types.length; j++) {
+        let counters = document.getElementsByClassName(types[j]);
+        const fakeCounters = fakeDOM.getElementsByClassName(types[j]);
+        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/assets/player-settings.js

@@ -1,13 +1,28 @@
 let gameName = null;
 
 window.addEventListener('load', () => {
-  const urlMatches = window.location.href.match(/^.*\/(.*)\/player-settings/);
-  gameName = decodeURIComponent(urlMatches[1]);
+  gameName = document.getElementById('player-settings').getAttribute('data-game');
 
   // Update game name on page
   document.getElementById('game-name').innerHTML = gameName;
 
   Promise.all([fetchSettingData()]).then((results) => {
+    let settingHash = localStorage.getItem(`${gameName}-hash`);
+    if (!settingHash) {
+      // If no hash data has been set before, set it now
+      localStorage.setItem(`${gameName}-hash`, md5(results[0]));
+      localStorage.removeItem(gameName);
+      settingHash = md5(results[0]);
+    }
+
+    if (settingHash !== md5(results[0])) {
+      const userMessage = document.getElementById('user-message');
+      userMessage.innerText = "Your settings are out of date! Click here to update them! Be aware this will reset " +
+        "them all to default.";
+      userMessage.style.display = "block";
+      userMessage.addEventListener('click', resetSettings);
+    }
+
     // Page setup
     createDefaultSettings(results[0]);
     buildUI(results[0]);
@@ -15,7 +30,7 @@ window.addEventListener('load', () => {
 
     // Event listeners
     document.getElementById('export-settings').addEventListener('click', () => exportSettings());
-    document.getElementById('generate-race').addEventListener('click', () => generateGame(true))
+    document.getElementById('generate-race').addEventListener('click', () => generateGame(true));
     document.getElementById('generate-game').addEventListener('click', () => generateGame());
 
     // Name input field
@@ -29,6 +44,12 @@ window.addEventListener('load', () => {
   })
 });
 
+const resetSettings = () => {
+  localStorage.removeItem(gameName);
+  localStorage.removeItem(`${gameName}-hash`)
+  window.location.reload();
+};
+
 const fetchSettingData = () => new Promise((resolve, reject) => {
   const ajax = new XMLHttpRequest();
   ajax.onreadystatechange = () => {
@@ -40,7 +61,7 @@ const fetchSettingData = () => new Promise((resolve, reject) => {
     try{ resolve(JSON.parse(ajax.responseText)); }
     catch(error){ reject(error); }
   };
-  ajax.open('GET', `${window.location.origin}/static/generated/${gameName}.json`, true);
+  ajax.open('GET', `${window.location.origin}/static/generated/player-settings/${gameName}.json`, true);
   ajax.send();
 });
 
@@ -84,28 +105,68 @@ const buildOptionsTable = (settings, romOpts = false) => {
     const label = document.createElement('label');
     label.setAttribute('for', setting);
     label.setAttribute('data-tooltip', settings[setting].description);
-    label.innerText = `${settings[setting].friendlyName}:`;
+    label.innerText = `${settings[setting].displayName}:`;
     tdl.appendChild(label);
     tr.appendChild(tdl);
 
     // td Right
     const tdr = document.createElement('td');
-    const select = document.createElement('select');
-    select.setAttribute('id', setting);
-    select.setAttribute('data-key', setting);
-    if (romOpts) { select.setAttribute('data-romOpt', '1'); }
-    settings[setting].options.forEach((opt) => {
-      const option = document.createElement('option');
-      option.setAttribute('value', opt.value);
-      option.innerText = opt.name;
-      if ((isNaN(currentSettings[setting]) && (parseInt(opt.value, 10) === parseInt(currentSettings[setting]))) ||
-        (opt.value === currentSettings[setting])) {
-        option.selected = true;
-      }
-      select.appendChild(option);
-    });
-    select.addEventListener('change', (event) => updateGameSetting(event));
-    tdr.appendChild(select);
+    let element = null;
+
+    switch(settings[setting].type){
+      case 'select':
+        element = document.createElement('div');
+        element.classList.add('select-container');
+        let select = document.createElement('select');
+        select.setAttribute('id', setting);
+        select.setAttribute('data-key', setting);
+        if (romOpts) { select.setAttribute('data-romOpt', '1'); }
+        settings[setting].options.forEach((opt) => {
+          const option = document.createElement('option');
+          option.setAttribute('value', opt.value);
+          option.innerText = opt.name;
+          if ((isNaN(currentSettings[gameName][setting]) &&
+            (parseInt(opt.value, 10) === parseInt(currentSettings[gameName][setting]))) ||
+            (opt.value === currentSettings[gameName][setting]))
+          {
+            option.selected = true;
+          }
+          select.appendChild(option);
+        });
+        select.addEventListener('change', (event) => updateGameSetting(event));
+        element.appendChild(select);
+        break;
+
+      case 'range':
+        element = document.createElement('div');
+        element.classList.add('range-container');
+
+        let range = document.createElement('input');
+        range.setAttribute('type', 'range');
+        range.setAttribute('data-key', setting);
+        range.setAttribute('min', settings[setting].min);
+        range.setAttribute('max', settings[setting].max);
+        range.value = currentSettings[gameName][setting];
+        range.addEventListener('change', (event) => {
+          document.getElementById(`${setting}-value`).innerText = event.target.value;
+          updateGameSetting(event);
+        });
+        element.appendChild(range);
+
+        let rangeVal = document.createElement('span');
+        rangeVal.classList.add('range-value');
+        rangeVal.setAttribute('id', `${setting}-value`);
+        rangeVal.innerText = currentSettings[gameName][setting] ?? settings[setting].defaultValue;
+        element.appendChild(rangeVal);
+        break;
+
+      default:
+        console.error(`Unknown setting type: ${settings[setting].type}`);
+        console.error(setting);
+        return;
+    }
+
+    tdr.appendChild(element);
     tr.appendChild(tdr);
     tbody.appendChild(tr);
   });

WebHostLib/static/assets/tutorial.js

@@ -20,6 +20,9 @@ window.addEventListener('load', () => {
         ajax.send();
     }).then((results) => {
         // Populate page with HTML generated from markdown
+        showdown.setOption('tables', true);
+        showdown.setOption('strikethrough', true);
+        showdown.setOption('literalMidWordUnderscores', true);
         tutorialWrapper.innerHTML += (new showdown.Converter()).makeHtml(results);
         adjustHeaderWidth();
 

WebHostLib/static/assets/tutorial/archipelago/setup_en.md

@@ -0,0 +1,27 @@
+# Archipelago Setup Guide
+
+## Installing the Archipelago software
+The most recent public release of Archipelago can be found [here](https://github.com/ArchipelagoMW/Archipelago/releases).
+Run the exe file, and after accepting the license agreement you will be prompted on which components you would like to install. The generator allows you to generate multiworld games on your computer. The ROM setups are optional but are required if anyone in the game that you generate wants to play any of those games as they are needed to generate the relevant patch files. The server will allow you to host the multiworld on your machine but this also requires you to port forward. The default port for Archipelago is `38281` If you are unsure how to do this there are plenty of other guides on the internet that will be more suited to your hardware. The Clients are what you use to connect your game to the multiworld. If the game/games you plan to play are available here go ahead and install these as well. If the game you choose to play is supported by Archipelago but not listed check the relevant tutorial.
+
+## Generating a game
+### Gather all player YAMLS
+All players that wish to play in the generated multiworld must have a YAML file which contains all of the settings that they wish to play with.
+A YAML is a file which contains human readable markup. In other words, this is a settings file kind of like an INI file or a TOML file. 
+Each player can go to the game's player settings page in order to determine the settings how they want them and then download a YAML file containing these settings.
+After getting all of the YAML files these can all either be placed together in the `Archipelago\Players` folder or compressed into a ZIP folder to then be uploaded to the [website generator](/generate).
+If rolling locally ensure that the folder is clear of any files you do not wish to include in the game such as the included default player settings files.
+
+### Rolling the seed
+After gathering all of the YAML files together in the `Archipelago\Players` folder, run the program `ArchipelagoGenerate.exe` in the base `Archipelago` folder. This will then open a console window and either silently close itself or spit out an error. If you receive an error, it is likely due to an error in the YAML file. If the error is unhelpful in you figuring out the issue asking in the ***#tech-support*** channel of our Discord. The generator will put a zip folder into your `Archipelago\output` folder with the format `AP_XXXXXXXXX`.zip. This contains all of the patch files and relevant mods for the players as well as the serverdata for the host.
+
+### Changing host settings
+Sometimes there are various settings that you may want to change before rolling a seed such as enabling race mode, auto-forfeit, or set a password. All of these settings plus other options are able to be changed by modifying the `host.yaml` file in the base `Archipelago` folder. 
+
+## Hosting a multiworld
+### Uploading the seed to the website
+The easiest and most recommended method is to upload the zip file that you generated to the website [here](/uploads). This will give a page with the seed info and have a link to the spoiler if it exists. Click on Create New room and then share the link fo rhe room with the other players so that they can download their patches or mods. The room will also have a link to a Multiworld Tracker and tell you what the players need to connect to from their clients. 
+
+### Hosting a seed locally
+For this we'll assume you have already port forwarding `38281` and have generated a seed that is still in the `outputs` folder. Next, you'll want to run `ArchipelagoServer.exe`. A window will open in order to open the multiworld data for the game. You can either use the generated zip folder or extract the .archipelago file and use it. If everything worked correctly the console window should tell you it's now hosting a game with the IP, port, and password that clients will need in order to connect.
+Extract the patch and mod files then send those to your friends and you're done!

WebHostLib/static/assets/tutorial/factorio/setup_en.md

@@ -15,8 +15,8 @@ One Server Host exists per Factorio World in an Archipelago Multiworld, any numb
 ## Installation Procedures
 
 ### Dedicated Server Setup
-You need a dedicated isolated Factorio installation that the FactorioClient can take control over, if you intend to both emit a world and play, you need to follow both this setup and the player setup.
-This requires two Factorio installations. The easiest and cheapest way to do so is to either buy or register a Factorio on factorio.com, which allows you to download as many Factorio games as you want.
+You need a dedicated isolated Factorio installation that the FactorioClient can take control over. If you intend to both host a world and play on the same device, you will need two separate Factorio installations; one for the FactorioClient to hook into and control, and one for you to play on.
+The easiest and cheapest way to do so is to either buy or register a Factorio key on factorio.com, which allows you to download as many Factorio games as you want. If you own a steam copy already you can link your account on the website.
 1. Download the latest Factorio from https://factorio.com/download for your system, for Windows the recommendation is "win64-manual".
 
 2. Make sure the Factorio you play and the Factorio you use for hosting do not share paths. If you downloaded the "manual" version, this is already the case, otherwise, go into the hosting Factorio's folder and put the following text into its `config-path.cfg`:
@@ -24,26 +24,29 @@ This requires two Factorio installations. The easiest and cheapest way to do so
 config-path=__PATH__executable__/../../config
 use-system-read-write-data-directories=false
 ```
-3. Navigate to where you installed Archipelago and open the host.yaml file as text. Find the entry `executable` under `factorio_options` and set it to point to your Factorio. If you put Factorio into your Archipelago folder, this would already match.
-
-
+3. In this same folder if there are shortcuts named "mods" and "saves" delete these and replace with folders with the same names.
+4. Navigate to where you installed ArchipelagoFactorioClient and open the host.yaml file as text. Find the entry `executable` under `factorio_options` and set it to point to your hosting Factorio.exe. If you put Factorio into your Archipelago folder, this would already match.<br>
+ex.
+```yaml
+factorio_options:
+  executable:  C:\\Program Files\\factorio\\bin\\x64\\factorio"
+```
 ### Player Setup
-- Manually install the AP mod for the correct world you want to join, then use Factorio's built-in multiplayer.
+- Manually install the AP mod for the correct world you want to join, then use Factorio's built-in multiplayer. If you're connecting to a FactorioClient on the same system you will connect to localhost
 
     
 ## Joining a MultiWorld Game
 
-1. Install the generated Factorio AP Mod (would be in <Factorio Directory>/Mods after step 2 of Setup)
+1. Install the generated Factorio AP Mod (would be in /Mods after step 2 of Setup)
 
-2. Run FactorioClient, it should launch a Factorio server, which you can control with `/factorio <original factorio commands>`, 
-   
-    * It should start up, create a world and become ready for Factorio connections.
+2. Run FactorioClient, it should launch a Factorio server, which you can control with /factorio <original factorio commands>,
 
-3. In FactorioClient, do `/connect <Archipelago Server Address>` to join that multiworld. You can find further commands with `/help` as well as `!help` once connected.
+	* It should start up, create a world and become ready for Factorio connections.
+3. In FactorioClient, do /connect <Archipelago Server Address> to join that multiworld. You can find further commands with /help as well as !help once connected.
 
-    * / commands are run on your local client, ! commands are requests for the AP server
+	* / commands are run on your local client, ! commands are requests for the AP server
+
+	* Players should be able to connect to your Factorio Server and begin playing.
+
+4. You can join yourself by connecting to address localhost, other people will need to connect to your IP and you may need to port forward for the Factorio Server for those connections.
 
-    * Players should be able to connect to your Factorio Server and begin playing.
-   
-4. You can join yourself by connecting to address `localhost`, other people will need to connect to your IP 
-   and you may need to port forward for the Factorio Server for those connections.

WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md

@@ -1,54 +1,12 @@
 # Minecraft Randomizer Setup Guide
 
+#Automatic Hosting Install
+- download and install [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases) and choose the `Minecraft Client` module
+
 ## Required Software
 
-### Server Host
-- [Minecraft Forge](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.16.5.html)
-- [Minecraft Archipelago Randomizer Mod](https://github.com/KonoTyran/Minecraft_AP_Randomizer/releases)
-
-### Players
 - [Minecraft Java Edition](https://www.minecraft.net/en-us/store/minecraft-java-edition)
 
-## Installation Procedures
-
-### Dedicated Server Setup
-Only one person has to do this setup and host a dedicated server for everyone else playing to connect to.
-1. Download the 1.16.5 **Minecraft Forge** installer from the link above, making sure to download the most recent recommended version.
-
-2. Run the `forge-1.16.5-xx.x.x-installer.jar` file and choose **install server**.
-    - On this page you will also choose where to install the server to remember this directory it's important in the next step.
-
-3. Navigate to where you installed the server and open `forge-1.16.5-xx.x.x.jar`
-    - Upon first launch of the server it will close and ask you to accept Minecraft's EULA. There will be a new file called `eula.txt` that contains a link to Minecraft's EULA, and a line that you need to change to `eula=true` to accept Minecraft's EULA.
-    - This will create the appropriate directories for you to place the files in the following step.
-
-4. Place the `aprandomizer-x.x.x.jar` from the link above file into the `mods` folder of the above installation of your forge server.
-    - Once again run the server, it will load up and generate the required directory `APData` for when you are ready to play a game!
-
-### Basic Player Setup
-- Purchase and install Minecraft from the above link.
-
-  **You're Done**.
-  
-  Players only need to have a Vanilla unmodified version of Minecraft to play!
-
-### Advanced Player Setup
-***This is not required to play a randomized minecraft game.***
-however this recommended as it helps make the experience more enjoyable.
-
-#### Recomended Mods
-- [JourneyMap](https://www.curseforge.com/minecraft/mc-mods/journeymap) (Minimap)
-
-
-1. Install and run Minecraft from the link above at least once.
-2. Run the `forge-1.16.5-xx.x.x-installer.jar` file and choose **install client**.
-    - Start Minecraft forge at least once to create the directories needed for the next steps.
-3. Navigate to your minecraft install directory and place desired mods `.jar` file the in the `mods` directory.
-    - The default install directories are as follows.
-        - Windows `%APPDATA%\.minecraft\mods`
-        - macOS `~/Library/Application Support/minecraft/mods`
-        - Linux `~/.minecraft/mods`
-
 ## Configuring your YAML file
 
 ### What is a YAML file and why do I need one?
@@ -60,10 +18,10 @@ can all have different options.
 ### Where do I get a YAML file?
 A basic minecraft yaml will look like this.
 ```yaml
-description: Template Name
+description: Basic Minecraft Yaml
 # Your name in-game. Spaces will be replaced with underscores and
 # there is a 16 character limit
-name: YourName 
+name: YourName
 game: Minecraft
 
 # Shared Options supported by all games:
@@ -71,44 +29,61 @@ accessibility: locations
 progression_balancing: on
 # Minecraft Specific Options
 
-# Number of advancements required (out of 92 total) to spawn the
-# Ender Dragon and complete the game. 
-advancement_goal:
-  few: 0 #30
-  normal: 1 #50
-  many: 0 #70
+Minecraft:
+  # Number of advancements required (87 max) to spawn the Ender Dragon and complete the game.
+  advancement_goal: 50   
   
-# Modifies the level of items logically required for exploring
-# dangerous areas and fighting bosses. 
-combat_difficulty:
-  easy: 0
-  normal: 1
-  hard: 0
+  # Number of dragon egg shards to collect (30 max) before the Ender Dragon will spawn. 
+  egg_shards_required: 10 
   
-# Junk-fills certain RNG-reliant or tedious advancements with XP rewards. 
-include_hard_advancements:
-  on: 0
-  off: 1
+  # Number of egg shards available in the pool (30 max).
+  egg_shards_available: 15 
   
-# Junk-fills extremely difficult advancements;
-# this is only How Did We Get Here? and Adventuring Time.
-include_insane_advancements:
-  on: 0
-  off: 1
+  # Modifies the level of items logically required for
+  # exploring dangerous areas and fighting bosses.
+  combat_difficulty: 
+    easy: 0
+    normal: 1
+    hard: 0
+    
+  # Junk-fills certain RNG-reliant or tedious advancements.
+  include_hard_advancements: 
+    on: 0
+    off: 1
+    
+  # Junk-fills extremely difficult advancements;
+  # this is only How Did We Get Here? and Adventuring Time.
+  include_insane_advancements: 
+    on: 0
+    off: 1
   
-# Some advancements require defeating the Ender Dragon;
-# this will junk-fill them so you won't have to finish to send some items. 
-include_postgame_advancements:
-  on: 0
-  off: 1
+  # Some advancements require defeating the Ender Dragon;
+  # this will junk-fill them, so you won't have to finish them to send some items.  
+  include_postgame_advancements: 
+    on: 0
+    off: 1
+    
+  # Enables shuffling of villages, outposts, fortresses, bastions, and end cities. 
+  shuffle_structures: 
+    on: 0
+    off: 1
   
-#enables shuffling of villages, outposts, fortresses, bastions, and end cities. 
-shuffle_structures:
-  on: 1
-  off: 0
+  # Adds structure compasses to the item pool,
+  # which point to the nearest indicated structure.  
+  structure_compasses: 
+    on: 0
+    off: 1
+  
+  # Replaces a percentage of junk items with bee traps
+  # which spawn multiple angered bees around every player when received.   
+  bee_traps: 
+    0: 1
+    25: 0
+    50: 0
+    75: 0
+    100: 0
 ```
 
-
 ## Joining a MultiWorld Game
 
 ### Obtain your Minecraft data file
@@ -118,8 +93,7 @@ When you join a multiworld game, you will be asked to provide your YAML file to
 is done, the host will provide you with either a link to download your data file, or with a zip file containing
 everyone's data files. Your data file should have a `.apmc` extension.
 
-Put your data file in your forge servers `APData` folder. Make sure to remove any previous data file that was in there
-previously.
+double click on your `.apmc` file to have the minecraft client auto-launch the installed forge server.
 
 ### Connect to the MultiServer
 After having placed your data file in the `APData` folder, start the Forge server and make sure you have OP
@@ -134,3 +108,23 @@ When the console tells you that you have joined the room, you're ready to begin
 on successfully joining a multiworld game! At this point any additional minecraft players may connect to your
 forge server.
 
+
+## Manual Installation Procedures
+this is only required if you wish to set up a forge install yourself, its recommended to just use the Archipelago Installer.
+###Required Software
+- [Minecraft Forge](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.16.5.html)
+- [Minecraft Archipelago Randomizer Mod](https://github.com/KonoTyran/Minecraft_AP_Randomizer/releases)
+**DO NOT INSTALL THIS ON YOUR CLIENT**
+### Dedicated Server Setup
+Only one person has to do this setup and host a dedicated server for everyone else playing to connect to.
+1. Download the 1.16.5 **Minecraft Forge** installer from the link above, making sure to download the most recent recommended version.
+
+2. Run the `forge-1.16.5-xx.x.x-installer.jar` file and choose **install server**.
+    - On this page you will also choose where to install the server to remember this directory it's important in the next step.
+
+3. Navigate to where you installed the server and open `forge-1.16.5-xx.x.x.jar`
+    - Upon first launch of the server it will close and ask you to accept Minecraft's EULA. There will be a new file called `eula.txt` that contains a link to Minecraft's EULA, and a line that you need to change to `eula=true` to accept Minecraft's EULA.
+    - This will create the appropriate directories for you to place the files in the following step.
+
+4. Place the `aprandomizer-x.x.x.jar` from the link above file into the `mods` folder of the above installation of your forge server.
+    - Once again run the server, it will load up and generate the required directory `APData` for when you are ready to play a game!

WebHostLib/static/assets/tutorial/minecraft/minecraft_es.md

@@ -1,52 +1,12 @@
 # Guia instalación de Minecraft Randomizer
 
+#Instalacion automatica para el huesped de partida
+- descarga e instala [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases) and activa el modulo `Minecraft Client`
+
 ## Software Requerido
 
-### Servidor
-- [Minecraft Forge](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.16.5.html)
-- [Minecraft Archipelago Randomizer Mod](https://github.com/KonoTyran/Minecraft_AP_Randomizer/releases)
-
-### Jugadores
 - [Minecraft Java Edition](https://www.minecraft.net/en-us/store/minecraft-java-edition)
 
-## Procedimiento de instalación
-
-### Instalación de servidor dedicado
-Solo una persona ha de realizar este proceso y hospedar un servidor dedicado para que los demas jueguen conectandose a él.
-1. Descarga el instalador de **Minecraft Forge** 1.16.15 desde el enlace proporcionado, siempre asegurandose de bajar la version mas reciente.
-
-2. Ejecuta el fichero `forge-1.16.5-xx.x.x-installer.jar` y elije **install server**.
-    - En esta pagina elegiras ademas donde instalar el servidor, importante recordar esta localización en el siguiente paso.
-
-3. Navega al directorio donde hayas instalado el servidor y abre `forge-1.16.5-xx.x.x.jar`
-    - La primera vez que lances el servidor se cerrara (o no aparecerá nada en absoluto), debería haber un fichero nuevo en el directorio llamado `eula.txt`, el cual que contiene un enlace al EULA de minecraft, cambia la linea a `eula=true` para aceptar el EULA y poder utilizar el software de servidor.
-    - Esto creara la estructura de directorios apropiada para el siguiente paso
-
-4. Coloca el fichero `aprandomizer-x.x.x.jar` del segundo enlace en el directorio `mods`
-    - Cuando se ejecute el servidor de nuevo, generara el directorio `APData` que se necesitara para jugar
-
-### Instalación basica para jugadores
-- Compra e instala Minecraft a traves del tercer enlace.
-  **Y listo!**.
-  Los jugadores solo necesitan una version no modificada de Minecraft para jugar!
-
-### Instalación avanzada para jugadores
-***Esto no es requerido para jugar a minecraft randomizado.***
-Sin embargo lo recomendamos porque hace la experiencia mas llevadera.
-
-#### Recomended Mods
-- [JourneyMap](https://www.curseforge.com/minecraft/mc-mods/journeymap) (Minimap)
-
-
-1. Instala y ejecuta Minecraft al menos una vez.
-2. Ejecuta el fichero `forge-1.16.5-xx.x.x-installer.jar` y elige **install client**.
-    - Ejecuta Minecraft forge al menos una vez para generar los directorios necesarios para el siguiente paso.
-3. Navega a la carpeta de instalación de Minecraft y colocal los mods que quieras en el directorio `mods`
-    - Los directorios por defecto de instalación son:
-        - Windows `%APPDATA%\.minecraft\mods`
-        - macOS `~/Library/Application Support/minecraft/mods`
-        - Linux `~/.minecraft/mods`
-
 ## Configura tu fichero YAML
 
 ### Que es un fichero YAML y potque necesito uno?
@@ -58,42 +18,71 @@ pueden tener diferentes opciones
 ### Where do I get a YAML file?
 Un fichero basico yaml para minecraft tendra este aspecto.
 ```yaml
-# Usado para describir tu yaml. Util si tienes multiples ficheros
-description: Template Name 
-# Tu nombre en el juego. Los espacios son reemplazados por guiones bajos, limitado a 16 caracteres
-name: YourName 
+description: Basic Minecraft Yaml
+# Tu nombre en el juego. Espacios seran sustituidos por guinoes bajos y
+# hay un limite de 16 caracteres
+name: TuNombre
 game: Minecraft
-accessibility: locations
-# Recomendado no activar esto ya que el pool de objetos de Minecraft es bastante escueto, ademas hay muchas maneras alternativas de obtener los objetivos de Minecraft.
-progression_balancing: off 
-# Cuantos avances se necesitan para hacer aparecer el Ender Dragon y acabar el juego. few = 30, normal = 50 , many = 70
-advancement_goal: 
-  few: 0 
-  normal: 1 
-  many: 0 
-# Modifica el nivel de objetos lógicamente requeridos para explorar areas peligrosas y pelear contra jefes. 
-combat_difficulty: 
-  easy: 0
-  normal: 1
-  hard: 0
-# Avances que sean tediosos o basados en suerte tendran simplemente experiencia o cosas no necesarias
-include_hard_advancements: 
-  on: 0
-  off: 1
-# Los avances extremadamente difíciles no seran requeridos; esto afecta a How Did We Get Here? y Adventuring Time. 
-include_insane_advancements: 
-  on: 0
-  off: 1
-# Los avances posteriores a Ender Dragon no tendrán objetos necesarios para que otros jugadores en el caso de un MW acaben su partida.
-include_postgame_advancements:
-  on: 0
-  off: 1
-# Actualmente desactivado; permite la mezcla de pueblos, puestos, fortalezas, bastiones y cuidades. 
-shuffle_structures: 
-  on: 0
-  off: 1
-```
 
+# Opciones compartidas por todos los juegos:
+accessibility: locations
+progression_balancing: on
+# Opciones Especficicas para Minecraft
+
+Minecraft:
+  # Numero de logros requeridos (87 max) para que aparezca el Ender Dragon y completar el juego.
+  advancement_goal: 50   
+  
+  # Numero de trozos de huevo de dragon a obtener (30 max) antes de que el Ender Dragon aparezca. 
+  egg_shards_required: 10 
+  
+  # Numero de huevos disponibles en la partida (30 max).
+  egg_shards_available: 15 
+  
+  # Modifica el nivel de objetos logicamente requeridos para 
+  # explorar areas peligrosas y luchar contra jefes.
+  combat_difficulty: 
+    easy: 0
+    normal: 1
+    hard: 0
+    
+  # Si off, los logros que dependan de suerte o sean tediosos tendran objetos de apoyo, no necesarios para completar el juego.
+  include_hard_advancements: 
+    on: 0
+    off: 1
+    
+  # Si off, los logros muy dificiles tendran objetos de apoyo, no necesarios para completar el juego.
+  # Solo afecta a How Did We Get Here? and Adventuring Time.
+  include_insane_advancements: 
+    on: 0
+    off: 1
+  
+  # Algunos logros requieren derrotar al Ender Dragon;
+  # Si esto se queda en off, dichos logros no tendran objetos necesarios.
+  include_postgame_advancements: 
+    on: 0
+    off: 1
+    
+  # Permite el mezclado de villas, puesto, fortalezas, bastiones y ciudades de END. 
+  shuffle_structures: 
+    on: 0
+    off: 1
+  
+  # Añade brujulas de estructura al juego,
+  # apuntaran a la estructura correspondiente mas cercana.  
+  structure_compasses: 
+    on: 0
+    off: 1
+  
+  # Reemplaza un porcentaje de objetos innecesarios por trampas abeja
+  # las cuales crearan multiples abejas agresivas alrededor de los jugadores cuando se reciba.   
+  bee_traps: 
+    0: 1
+    25: 0
+    50: 0
+    75: 0
+    100: 0
+```
 
 ## Unirse a un juego MultiWorld
 
@@ -104,18 +93,39 @@ Cuando te unes a un juego multiworld, se te pedirá que entregues tu fichero YAM
 Una vez la generación acabe, el anfitrión te dará un enlace a tu fichero de datos o un zip con los ficheros de todos.
 Tu fichero de datos tiene una extensión `.apmc`.
 
-Pon tu fichero de datos en el directorio `APData` de tu forge server. Asegurate de eliminar los que hubiera anteriormente
-
+Haz doble click en tu fichero `.apmc` para que se arranque el cliente de minecraft y el servidor forge se ejecute.
 
 ### Conectar al multiserver
 Despues de poner tu fichero en el directorio `APData`, arranca el Forge server y asegurate que tienes el estado OP
 tecleando `/op TuUsuarioMinecraft` en la consola del servidor y entonces conectate con tu cliente Minecraft.
 
-Una vez en juego introduce `/connect <AP-Address> (<Password>)` donde `<AP-Address>` es la dirección del servidor
-Archipelago. `(<Password>)`
+Una vez en juego introduce `/connect <AP-Address> (Port) (<Password>)` donde `<AP-Address>` es la dirección del servidor. `(Port)` solo es requerido si el servidor Archipelago no esta usando el puerto por defecto 38281.
+`(<Password>)`
 solo se necesita si el servidor Archipleago tiene un password activo.
 
+
 ### Jugar al juego
 Cuando la consola te diga que te has unido a la sala, estas lista/o para empezar a jugar. Felicidades
 por unirte exitosamente a un juego multiworld! Llegados a este punto cualquier jugador adicional puede conectarse a tu servidor forge.
 
+## Procedimiento de instalación manual
+Solo es requerido si quieres usar una instalacion de forge por ti mismo, recomendamos usar el instalador de Archipelago
+###Software Requerido
+- [Minecraft Forge](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.16.5.html)
+- [Minecraft Archipelago Randomizer Mod](https://github.com/KonoTyran/Minecraft_AP_Randomizer/releases)
+**NO INSTALES ESTO EN TU CLIENTE MINECRAFT**
+
+
+### Instalación de servidor dedicado
+Solo una persona ha de realizar este proceso y hospedar un servidor dedicado para que los demas jueguen conectandose a él.
+1. Descarga el instalador de **Minecraft Forge** 1.16.5 desde el enlace proporcionado, siempre asegurandose de bajar la version mas reciente.
+
+2. Ejecuta el fichero `forge-1.16.5-xx.x.x-installer.jar` y elije **install server**.
+    - En esta pagina elegiras ademas donde instalar el servidor, importante recordar esta localización en el siguiente paso.
+
+3. Navega al directorio donde hayas instalado el servidor y abre `forge-1.16.5-xx.x.x.jar`
+    - La primera vez que lances el servidor se cerrara (o no aparecerá nada en absoluto), debería haber un fichero nuevo en el directorio llamado `eula.txt`, el cual que contiene un enlace al EULA de minecraft, cambia la linea a `eula=true` para aceptar el EULA y poder utilizar el software de servidor.
+    - Esto creara la estructura de directorios apropiada para el siguiente paso
+
+4. Coloca el fichero `aprandomizer-x.x.x.jar` del segundo enlace en el directorio `mods`
+    - Cuando se ejecute el servidor de nuevo, generara el directorio `APData` que se necesitara para jugar

WebHostLib/static/assets/tutorial/ror2/setup_en.md

@@ -0,0 +1,98 @@
+# Risk of Rain 2 Setup Guide
+
+## Install using r2modman
+### Install r2modman
+Head on over to the r2modman page on Thunderstore and follow the installation instructions.
+
+[https://thunderstore.io/package/ebkr/r2modman/](https://thunderstore.io/package/ebkr/r2modman/)
+
+### Install Archipelago Mod using r2modman
+You can install the Archipelago mod using r2modman in one of two ways.
+
+[https://thunderstore.io/package/ArchipelagoMW/Archipelago/](https://thunderstore.io/package/ArchipelagoMW/Archipelago/)
+
+One, you can use the Thunderstore website and click on the "Install with Mod Manager" link.
+
+You can also search for the "Archipelago" mod in the r2modman interface.
+The mod manager should automatically install all necessary dependencies as well.
+
+### Running the Modded Game
+Click on the "Start modded" button in the top left in r2modman to start the game with the
+Archipelago mod installed.
+
+## Joining an Archipelago Session
+There will be a menu button on the right side of the screen in the character select menu. 
+Click it in order to bring up the in lobby mod config. 
+From here you can expand the Archipelago sections and fill in the relevant info.
+Keep password blank if there is no password on the server.
+
+Simply check `Enable Archipelago?` and when you start the run it will automatically connect.
+
+## Gameplay
+The Risk of Rain 2 players send checks by causing items to spawn in-game. That means opening chests or killing bosses, generally. 
+An item check is only sent out after a certain number of items are picked up. This count is configurable in the player's YAML.
+
+## YAML Settings
+An example YAML would look like this:
+```yaml
+description: Ijwu-ror2
+name: Ijwu
+
+game:
+  Risk of Rain 2: 1
+
+Risk of Rain 2:
+  total_locations: 15
+  total_revivals: 4
+  start_with_revive: true
+  item_pickup_step: 1
+  enable_lunar: true
+  item_weights:
+    default: 50
+    new: 0
+    uncommon: 0
+    legendary: 0
+    lunartic: 0
+    chaos: 0
+    no_scraps: 0
+    even: 0
+    scraps_only: 0
+  item_pool_presets: true
+  # custom item weights
+  green_scrap: 16
+  red_scrap: 4
+  yellow_scrap: 1
+  white_scrap: 32
+  common_item: 64
+  uncommon_item: 32
+  legendary_item: 8
+  boss_item: 4
+  lunar_item: 16
+  equipment: 32
+```
+
+| Name | Description | Allowed values |
+| ---- | ----------- | -------------- |
+| total_locations | The total number of location checks that will be attributed to the Risk of Rain player. This option is ALSO the total number of items in the item pool for the Risk of Rain player. | 10 - 100 |
+| total_revivals | The total number of items in the Risk of Rain player's item pool (items other players pick up for them) replaced with `Dio's Best Friend`. | 0 - 5 |
+| start_with_revive | Starts the player off with a `Dio's Best Friend`. Functionally equivalent to putting a `Dio's Best Friend` in your `starting_inventory`. | true/false |
+| item_pickup_step | The number of item pickups which you are allowed to claim before they become an Archipelago location check. | 0 - 5 |
+| enable_lunar | Allows for lunar items to be shuffled into the item pool on behalf of the Risk of Rain player. | true/false |
+| item_weights | Each option here is a preset item weight that can be used to customize your generate item pool with certain settings. | default, new, uncommon, legendary, lunartic, chaos, no_scraps, even, scraps_only |
+| item_pool_presets | A simple toggle to determine whether the item_weight presets are used or the custom item pool as defined below | true/false |
+| custom item weights | Each defined item here is a single item in the pool that will have a weight against the other items when the item pool gets generated. These values can be modified to adjust how frequently certain items appear | 0-100|
+
+
+Using the example YAML above: the Risk of Rain 2 player will have 15 total items which they can pick up for other players. (total_locations = 15)
+
+They will have 15 items waiting for them in the item pool which will be distributed out to the multiworld. (total_locations = 15)
+
+They will complete a location check every second item. (item_pickup_step = 1)
+
+They will have 4 of the items which other players can grant them replaced with `Dio's Best Friend`. (total_revivals = 4)
+
+The player will also start with a `Dio's Best Friend`. (start_with_revive = true)
+
+The player will have lunar items shuffled into the item pool on their behalf. (enable_lunar = true)
+
+The player will have the default preset generated item pool with the custom item weights being ignored. (item_weights: default and item_pool_presets: true)

WebHostLib/static/assets/tutorial/timespinner/setup_en.md

@@ -0,0 +1,60 @@
+# Timespinner Randomizer Setup Guide
+
+## Required Software
+
+- [Timespinner (steam)](https://store.steampowered.com/app/368620/Timespinner/) or [Timespinner (drm free)](https://www.humblebundle.com/store/timespinner)
+- [Timespinner Randomizer](https://github.com/JarnoWesthof/TsRandomizer)
+
+## General Concept
+
+The timespinner Randomizer loads Timespinner.exe from the same folder, and alters its state in memory to allow for randomization of the items
+
+## Installation Procedures
+
+Download latest version of [Timespinner Randomizer](https://github.com/JarnoWesthof/TsRandomizer) you can find the .zip files on the releases page, download the zip for your current platform. Then extract the zip to the folder where your Timespinner game is installed. Then just run TsRandomizer.exe instead of Timespinner.exe to start the game in randomized mode, for more info see the [readme](https://github.com/JarnoWesthof/TsRandomizer)
+    
+## Joining a MultiWorld Game
+
+1. Run TsRandomizer.exe
+2. Select "New Game"
+3. Switch "<< Select Seed >>" to "<< Archiplago >>" by pressing left on the controller or keyboard 
+4. Select "<< Archiplago >>" to open a new menu where you can enter your Archipelago login credentails
+	* NOTE: the input fields support Ctrl + V pasting of values
+5. Select "Connect"
+6. If all went well you will be taken back the difficulty selection menu and the game will start as soon as you select a difficulty
+
+## YAML Settings
+An example YAML would look like this:
+```yaml
+description: Default Timespinner Template
+name: Lunais{number} # Your name in-game. Spaces will be replaced with underscores and there is a 16 character limit
+game:
+  Timespinner: 1
+requires:
+  version: 0.1.8
+Timespinner:
+  StartWithJewelryBox: # Start with Jewelry Box unlocked
+    false: 50
+    true: 0
+  DownloadableItems: # With the tablet you will be able to download items at terminals
+    false: 50
+    true: 50
+  FacebookMode: # Requires Oculus Rift(ng) to spot the weakspots in walls and floors
+    false: 50
+    true: 0
+  StartWithMeyef: # Start with Meyef, ideal for when you want to play multiplayer
+    false: 50
+    true: 50
+  QuickSeed: # Start with Talaria Attachment, Nyoom!
+    false: 50
+    true: 0
+  SpecificKeycards: # Keycards can only open corresponding doors
+    false: 0
+    true: 50
+  Inverted: # Start in the past
+    false: 50
+    true: 50
+```
+* All Options are either enabled or not, if values are specified for both true & false the generator will select one based on weight
+* The Timespinner Randomizer option "StinkyMaw" is currently always enabled for Archipelago generated seeds
+* The Timespinner Randomizer options "ProgressiveVerticalMovement" & "ProgressiveKeycards" are currently not supported on Archipelago generated seeds

WebHostLib/static/assets/tutorial/tutorials.json

@@ -1,4 +1,23 @@
 [
+  {
+    "gameTitle": "Archipelago",
+    "tutorials": [
+      {
+        "name": "Multiworld Setup Tutorial",
+        "description": "A Guide to setting up the Archipelago software to generate multiworld games on your computer.",
+        "files": [
+          {
+            "language": "English",
+            "filename": "archipelago/setup_en.md",
+            "link": "archipelago/setup/en",
+            "authors": [
+              "alwaysintreble"
+            ]
+          }
+        ]
+      }
+    ]
+  },
   {
     "gameTitle": "The Legend of Zelda: A Link to the Past",
     "tutorials": [
@@ -86,6 +105,33 @@
       }
     ]
   },
+  {
+    "gameTitle": "The Legend of Zelda: Ocarina of Time",
+    "tutorials": [
+      {
+        "name": "Multiworld Setup Tutorial",
+        "description": "A guide to setting up the Archipelago Ocarina of Time software on your computer.",
+        "files": [
+          {
+            "language": "English",
+            "filename": "zelda5/setup_en.md",
+            "link": "zelda5/setup/en",
+            "authors": [
+              "Edos"
+            ]
+          },
+          {
+            "language": "Spanish",
+            "filename": "zelda5/setup_es.md",
+            "link": "zelda5/setup/es",
+            "authors": [
+              "Edos"
+            ]
+          }
+        ]
+      }
+    ]
+  },
   {
     "gameTitle": "Factorio",
     "tutorials": [
@@ -139,5 +185,43 @@
         ]
       }
     ]
+  },
+  {
+    "gameTitle": "Risk of Rain 2",
+    "tutorials": [
+      {
+        "name": "Multiworld Setup Guide",
+        "description": "A guide to setting up the Risk of Rain 2 integration for Archipelago multiworld games.",
+        "files": [
+          {
+            "language": "English",
+            "filename": "ror2/setup_en.md",
+            "link": "ror2/setup/en",
+            "authors": [
+              "Ijwu"
+            ]
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "gameTitle": "Timespinner",
+    "tutorials": [
+      {
+        "name": "Multiworld Setup Guide",
+        "description": "A guide to setting up the Timespinner randomizer connected to an Archipelago Multiworld",
+        "files": [
+          {
+            "language": "English",
+            "filename": "timespinner/setup_en.md",
+            "link": "timespinner/setup/en",
+            "authors": [
+              "Jarno"
+            ]
+          }
+        ]
+      }
+    ]
   }
 ]

WebHostLib/static/assets/tutorial/zelda3/multiworld_de.md

@@ -2,9 +2,9 @@
 
 ## Benötigte Software
 - [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases)
-- [QUsb2Snes](https://github.com/Skarsnik/QUsb2snes/releases) (Included in the above Utilities)
-- Hardware oder Software zum Laden und Abspielen von SNES Rom-Dateien
-    - Ein Emulator, der lua-scripts abspielen kann
+- [SNI](https://github.com/alttpo/sni/releases) (Integriert in Archipelago)
+- Hardware oder Software zum Laden und Abspielen von SNES Rom-Dateien fähig zu einer Internetverbindung
+    - Ein Emulator, der mit SNI verbinden kann
       ([snes9x Multitroid](https://drive.google.com/drive/folders/1_ej-pwWtCAHYXIrvs5Hro16A1s9Hi3Jz),
       [BizHawk](http://tasvideos.org/BizHawk.html))
     - Ein SD2SNES, [FXPak Pro](https://krikzz.com/store/home/54-fxpak-pro.html), oder andere kompatible Hardware
@@ -42,7 +42,7 @@ jeder Spieler sein Spiel nach seinem eigenen Geschmack gestalten, während ander
 Einstellungen wählen können!
 
 ### Wo bekomme ich so eine YAML-Datei her?
-Die [Player Settings](/player-settings) Seite auf der Website ermöglicht das einfache Erstellen  und Herunterladen
+Die [Player Settings](/games/A Link to the Past/player-settings) Seite auf der Website ermöglicht das einfache Erstellen  und Herunterladen
 deiner eigenen `yaml` Datei. Drei verschiedene Voreinstellungen können dort gespeichert werden.
 
 ### Deine YAML-Datei ist gewichtet!
@@ -74,12 +74,12 @@ bei der [YAML Validator](/mysterycheck) Seite tun.
 ### Erhalte deine Patch-Datei und erstelle dein ROM
 Wenn du an einem MultiWorld-Spiel teilnehmen möchtest, wirst du in der Regel vom Host nach deiner YAML-Datei gefragt.
 Sobald du diese weitergegeben hast, wird der Host einen Link bereitstellen, wo du deinen Patch oder eine .zip-Datei
-mit allen Patches herunterladen kannst. Die Patch-Datei hat immer die Endung `.bmbp`.
+mit allen Patches herunterladen kannst. Die Patch-Datei hat immer die Endung `.apbp`.
 
 ### Mit dem Client verbinden
 
 #### Via Emulator
-Wenn der client den Emulator automatisch gestartet hat, wird QUsb2Snes ebenfalls im Hintergrund gestartet.
+Wenn der client den Emulator automatisch gestartet hat, wird SNI ebenfalls im Hintergrund gestartet.
 Wenn dies das erste Mal ist, wird möglicherweise ein Fenster angezeigt, wo man bestätigen muss, dass das Programm
 durch die Windows Firewall kommunizieren darf.
 
@@ -88,8 +88,9 @@ durch die Windows Firewall kommunizieren darf.
 2. Klicke auf den Reiter "File" oben im Menü und wähle **Lua Scripting**
 3. Klicke auf **New Lua Script Window...**
 4. Im sich neu öffnenden Fenster, klicke auf **Browse...**
-5. Navigiere zum Ort, wo du snes9x Multitroid installiert hast, öffne den `lua`-Ordner und öffne `multibridge.lua`
-6. Schaue im Lua-Fenster nach einem Namen, der dir zugeteilt wird und schaue im Client (WebUI im Browser), ob dort
+5. Navigiere zum Verzeichnis, wo du Archipelago installiert hast und dort in den Unterordner `SNI`.
+6. Wähle dort die `Connector.lua` und klicke auf Öffnen.
+7. Schaue im Lua-Fenster nach einem Namen, der dir zugeteilt wird und schaue im Client (WebUI im Browser), ob dort
    "Snes Device: Connected" mit demselben Namen dort steht (in der oberen linken Ecke).
 
 ##### BizHawk
@@ -99,9 +100,8 @@ durch die Windows Firewall kommunizieren darf.
 2. Lade die entsprechende ROM-Datei, wenn sie nicht schon automatisch geladen wurde.
 3. Klicke auf das Tools-Menü und klicke auf **Lua Console**
 4. Klicke auf den Button um ein neues Lua-Script zu öffnen.
-5. Navigiere zum Verzeichnis, wo du die Multiworld Utilities installiert hast und dort in folgende Ordner:
-   `QUsb2Snes/Qusb2Snes/LuaBridge`
-6. Wähle dort die `luabridge.lua` und klicke auf Öffnen.
+5. Navigiere zum Verzeichnis, wo du Archipelago installiert hast und dort in den Unterordner `SNI`.
+6. Wähle dort die `Connector.lua` und klicke auf Öffnen.
 7. Schaue im Lua-Fenster nach einem Namen, der dir zugeteilt wird und schaue im Client (WebUI im Browser), ob dort
    "Snes Device: Connected" mit demselben Namen dort steht (in der oberen linken Ecke)
 
@@ -111,15 +111,11 @@ das noch nicht getan hast, so tue dies am besten jetzt! SD2SNES und FXPak Pro Nu
 [hier](https://github.com/RedGuyyyy/sd2snes/releases). Nutzer ähnlicher Hardware finden Hilfestellung
 [auf dieser Seite](http://usb2snes.com/#supported-platforms).
 
-**UM MIT HARDWARE ZU VERBINDEN WIRD AKTUELL EINE ALTE VERSION VON QUSB2SNES BENÖTIGT
-([v0.7.16](https://github.com/Skarsnik/QUsb2snes/releases/tag/v0.7.16)).**  
-Neuere Versionen funktionieren möglicherweise nur eingeschränkt, fehlerhaft oder gar nicht!
 
 1. Schließe deinen Emulator, falls er automatisch gestartet haben sollte.
-2. Schließe QUsb2Snes, welches automatisch mit dem Client gestartet wurde (in der Taskleiste zu finden).
-3. Starte die richtige version von QUsb2Snes (v0.7.16).
-4. Starte deine (Original-)Konsole und lade die ROM-Datei.
-5. Schaue auf dein Clientfenster, welches nun "Snes Device: Connected" und den namen deiner Konsole
+2. Start SNI
+3. Starte deine (Original-)Konsole und lade die ROM-Datei.
+4. Schaue auf dein Clientfenster, welches nun "Snes Device: Connected" und den namen deiner Konsole
    zeigen sollte.
 
 ### Mit dem MultiServer verbinden
@@ -137,7 +133,7 @@ können du und deine Freunde loslegen! Glückwunsch zum erfolgreichen Beitritt z
 
 ## Ein Multiworld-Spiel hosten
 Die Empfohlene Art, ein Spiel zu hosten, ist, den Service auf
-[der website](https://berserkermulti.world/generate) zu nutzen. Das Ganze ist recht einfach:
+[der website](/generate) zu nutzen. Das Ganze ist recht einfach:
 
 1. Lasse dir von deinen Mitspielern die YAML-Datei zuschicken.
 2. Erstelle einen Zip-komprimierten Ordner´, in den du alle YAML-Dateien deiner Spieler einfügst.

WebHostLib/static/assets/tutorial/zelda3/multiworld_en.md

@@ -8,9 +8,9 @@
 
 ## Required Software
 - [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases)
-- [QUsb2Snes](https://github.com/Skarsnik/QUsb2snes/releases) (Included in the above Utilities)
+- [SNI](https://github.com/alttpo/sni/releases) (Included in Archipelago)
 - Hardware or software capable of loading and playing SNES ROM files
-    - An emulator capable of running Lua scripts
+    - An emulator capable of connecting to SNI
       ([snes9x Multitroid](https://drive.google.com/drive/folders/1_ej-pwWtCAHYXIrvs5Hro16A1s9Hi3Jz),
       [BizHawk](http://tasvideos.org/BizHawk.html))
     - An SD2SNES, [FXPak Pro](https://krikzz.com/store/home/54-fxpak-pro.html), or other compatible hardware
@@ -19,10 +19,9 @@
 ## Installation Procedures
 
 ### Windows Setup
-1. Download and install the MultiWorld Utilities from the link above, making sure to install the most recent version.
+1. Download and install Archipelago from the link above, making sure to install the most recent version.
 **The file is located in the assets section at the bottom of the version information**. If you intend to play normal
 multiworld games, you want `Setup.Archipelago.exe`
-    - If you intend to play the doors variant of multiworld, you will want to download the alternate doors file.
     - During the installation process, you will be asked to browse for your Japanese 1.0 ROM file. If you have
       installed this software before and are simply upgrading now, you will not be prompted to locate your
       ROM file a second time.
@@ -50,31 +49,15 @@ each player to enjoy an experience customized for their taste, and different pla
 can all have different options.
 
 ### Where do I get a YAML file?
-The [Generate Game](/player-settings) page on the website allows you to configure your personal settings and
+The [Generate Game](/games/A Link to the Past/player-settings) page on the website allows you to configure your personal settings and
 export a YAML file from them.
 
-### Advanced YAML configuration
-A more advanced version of the YAML file can be created using the [Weighted Settings](/weighted-settings) page,
-which allows you to configure up to three presets. The Weighted Settings page has many options which are
-primarily represented with sliders. This allows you to choose how likely certain options are to occur relative
-to other options within a category.
-
-For example, imagine the generator creates a bucket labeled "Map Shuffle", and places folded pieces of paper
-into the bucket for each sub-option. Also imagine your chosen value for "On" is 20, and your value for "Off" is 40.
-
-In this example, sixty pieces of paper are put into the bucket. Twenty for "On" and forty for "Off". When the
-generator is deciding whether or not to turn on map shuffle for your game, it reaches into this bucket and pulls
-out a piece of paper at random. In this example, you are much more likely to have map shuffle turned off.
-
-If you never want an option to be chosen, simply set its value to zero. Remember that each setting must have at
-lease one option set to a number greater than zero.
-
 ### Verifying your YAML file
 If you would like to validate your YAML file to make sure it works, you may do so on the
 [YAML Validator](/mysterycheck) page.
 
 ## Generating a Single-Player Game
-1. Navigate to the [Generate Game](/player-settings), configure your options, and click the "Generate Game" button.
+1. Navigate to the [Player Settings](/games/A%20Link%20to%20the%20Past/player-settings) page, configure your options, and click the "Generate Game" button.
 2. You will be presented with a "Seed Info" page, where you can download your patch file.
 3. Double-click on your patch file, and the emulator should launch with your game automatically. As the
    Client is unnecessary for single player games, you may close it and the WebUI.
@@ -84,7 +67,7 @@ If you would like to validate your YAML file to make sure it works, you may do s
 ### Obtain your patch file and create your ROM
 When you join a multiworld game, you will be asked to provide your YAML file to whoever is hosting. Once that
 is done, the host will provide you with either a link to download your patch file, or with a zip file containing
-everyone's patch files. Your patch file should have a `.bmbp` extension.
+everyone's patch files. Your patch file should have a `.apbp` extension.
 
 Put your patch file on your desktop or somewhere convenient, and double click it. This should automatically
 launch the client, and will also create your ROM file in the same place as your patch file.
@@ -92,7 +75,7 @@ launch the client, and will also create your ROM file in the same place as your
 ### Connect to the client
 
 #### With an emulator
-When the client launched automatically, QUsb2Snes should have also automatically launched in the background.
+When the client launched automatically, SNI should have also automatically launched in the background.
 If this is its first time launching, you may be prompted to allow it to communicate through the Windows
 Firewall.
 
@@ -114,8 +97,8 @@ Firewall.
 3. Click on the Tools menu and click on **Lua Console**
 4. Click the button to open a new Lua script.
 5. Browse to your MultiWorld Utilities installation directory, and into the following directories:  
-   `QUsb2Snes/Qusb2Snes/LuaBridge`
-6. Select `luabridge.lua` and click Open.
+   `SNI`
+6. Select `Connector.lua` and click Open.
 7. Observe a name has been assigned to you, and that the client shows "SNES Device: Connected", with that same
    name in the upper left corner. 
 

WebHostLib/static/assets/tutorial/zelda3/multiworld_es.md

@@ -43,7 +43,7 @@ Cada jugador en una partida de multiworld proveerá su propio fichero YAML. Esta
 que cada jugador disfrute de una experiencia personalizada a su gusto, y cada jugador dentro de la misma partida de multiworld puede tener diferentes opciones.
 
 ### Donde puedo obtener un fichero YAML?
-La página "[Generate Game](/player-settings)" en el sitio web te permite configurar tu configuración personal y
+La página "[Generate Game](/games/A%20Link%20to%20the%20Past/player-settings)" en el sitio web te permite configurar tu configuración personal y
 descargar un fichero "YAML". 
 
 ### Configuración YAML avanzada
@@ -67,7 +67,7 @@ Si quieres validar que tu fichero YAML para asegurarte que funciona correctament
 [YAML Validator](/mysterycheck).
 
 ## Generar una partida para un jugador
-1. Navega a [la pagina Generate game](/player-settings), configura tus opciones, haz click en el boton "Generate game".
+1. Navega a [la pagina Generate game](/games/A%20Link%20to%20the%20Past/player-settings), configura tus opciones, haz click en el boton "Generate game".
 2. Se te redigirá a una pagina "Seed Info", donde puedes descargar tu archivo de parche.
 3. Haz doble click en tu fichero de parche, y el emulador debería ejecutar tu juego automáticamente. Como el
    Cliente no es necesario para partidas de un jugador, puedes cerrarlo junto a la pagina web (que tiene como titulo "Multiworld WebUI") que se ha abierto automáticamente.

WebHostLib/static/assets/tutorial/zelda3/multiworld_fr.md

@@ -49,7 +49,7 @@ sur comment il devrait générer votre seed. Chaque joueur d'un multiwolrd devra
 joueur d'apprécier une expérience customisée selon ses goûts, et les différents joueurs d'un même multiworld peuvent avoir différentes options.
 
 ### Où est-ce que j'obtiens un fichier YAML ?
-La page [Génération de partie](/player-settings) vous permet de configurer vos paramètres personnels et de les exporter vers un fichier YAML.
+La page [Génération de partie](/games/A%20Link%20to%20the%20Past/player-settings) vous permet de configurer vos paramètres personnels et de les exporter vers un fichier YAML.
 
 ### Configuration avancée du fichier YAML
 Une version plus avancée du fichier YAML peut être créée en utilisant la page des [paramètres de pondération](/weighted-settings), qui vous permet
@@ -71,7 +71,7 @@ Si vous voulez valider votre fichier YAML pour être sûr qu'il fonctionne, vous
 [Validateur de YAML](/mysterycheck).
 
 ## Générer une partie pour un joueur
-1. Aller sur la page [Génération de partie](/player-settings), configurez vos options, et cliquez sur le bouton "Generate Game".
+1. Aller sur la page [Génération de partie](/games/A%20Link%20to%20the%20Past/player-settings), configurez vos options, et cliquez sur le bouton "Generate Game".
 2. Il vous sera alors présenté une page d'informations sur la seed, où vous pourrez télécharger votre patch.
 3. Double-cliquez sur le patch et l'émulateur devrait se lancer automatiquement avec la seed. Etant donné que le client
 n'est pas requis pour les parties à un joueur, vous pouvez le fermer ainsi que l'interface Web (WebUI).

WebHostLib/static/assets/tutorial/zelda5/setup_en.md

@@ -0,0 +1,387 @@
+# Setup Guide for Ocarina of time Archipelago
+
+## Important
+
+As we are using Z5Client and Bizhawk, this guide is only applicable to Windows.
+
+## Required Software
+
+- [bizhawk+script+Z5Client](https://github.com/ArchipelagoMW/Z5Client/releases) We recommend download Z5Client-setup as it makes some steps automatic.
+
+## Install Emulator and client
+
+Download getBizhawk.ps1 from previous link. Place it on the folder where you want your emulator to be installed, right click on it and select "Run with PowerShell". This will download all the needed dependencies used by the emulator. This can take a while.
+
+It is strongly recommended to associate N64 rom extension (\*.n64) to the Bizhawk we've just installed. To do so, we simple have to search any N64 rom we happened to own, right click and select "Open with...", we unfold the list that appears and select the bottom option "Look for another application", we browse to Bizhawk folder and select EmuHawk.exe
+
+Place the ootMulti.lua file from the previous link inside the "lua" folder from the just installed emulator.
+
+Install the Z5Client using its setup.
+
+## Configuring your YAML file
+
+### What is a YAML file and why do I need one?
+Your YAML file contains a set of configuration options which provide the generator with information about how
+it should generate your game. Each player of a multiworld will provide their own YAML file. This setup allows
+each player to enjoy an experience customized for their taste, and different players in the same multiworld
+can all have different options.
+
+### Where do I get a YAML file?
+
+A basic OOT yaml will look like this. (There are lots of cosmetic options that have been removed for the sake of this tutorial, if you want to see a complete list, download (Archipelago)[https://github.com/ArchipelagoMW/Archipelago/releases] and look for the sample file in the "Players" folder))
+```yaml
+description: Default Ocarina of Time Template # Used to describe your yaml. Useful if you have multiple files
+# Your name in-game. Spaces will be replaced with underscores and there is a 16 character limit
+name: YourName
+game:
+  Ocarina of Time: 1
+requires:
+  version: 0.1.7 # Version of Archipelago required for this yaml to work as expected.
+# Shared Options supported by all games:
+accessibility:
+  items: 0 # Guarantees you will be able to acquire all items, but you may not be able to access all locations
+  locations: 50 # Guarantees you will be able to access all locations, and therefore all items
+  none: 0 # Guarantees only that the game is beatable. You may not be able to access all locations or acquire all items
+progression_balancing:
+  on: 50 # A system to reduce BK, as in times during which you can't do anything by moving your items into an earlier access sphere to make it likely you have stuff to do
+  off: 0 # Turn this off if you don't mind a longer multiworld, or can glitch/sequence break around missing items.
+Ocarina of Time:
+  logic_rules: # Set the logic used for the generator.
+    glitchless: 50
+    glitched: 0
+    no_logic: 0
+  logic_no_night_tokens_without_suns_song: # Nighttime skulltulas will logically require Sun's Song.
+    false: 50
+    true: 0
+  open_forest: # Set the state of Kokiri Forest and the path to Deku Tree.
+    open: 50
+    closed_deku: 0
+    closed: 0
+  open_kakariko: # Set the state of the Kakariko Village gate.
+    open: 50
+    zelda: 0
+    closed: 0
+  open_door_of_time: # Open the Door of Time by default, without the Song of Time.
+    false: 0
+    true: 50
+  zora_fountain: # Set the state of King Zora, blocking the way to Zora's Fountain.
+    open: 0
+    adult: 0
+    closed: 50
+  gerudo_fortress: # Set the requirements for access to Gerudo Fortress.
+    normal: 0
+    fast: 50
+    open: 0
+  bridge: # Set the requirements for the Rainbow Bridge.
+    open: 0
+    vanilla: 0
+    stones: 0
+    medallions: 50
+    dungeons: 0
+    tokens: 0
+  trials: # Set the number of required trials in Ganon's Castle.
+    # you can add additional values between minimum and maximum
+    0: 50 # minimum value
+    6: 0 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  starting_age: # Choose which age Link will start as.
+    child: 50
+    adult: 0
+  triforce_hunt: # Gather pieces of the Triforce scattered around the world to complete the game.
+    false: 50
+    true: 0
+  triforce_goal: # Number of Triforce pieces required to complete the game. Total number placed determined by the Item Pool setting.
+    # you can add additional values between minimum and maximum
+    1: 0 # minimum value
+    50: 0 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+    20: 50
+  bombchus_in_logic: # Bombchus are properly considered in logic. The first found pack will have 20 chus; Kokiri Shop and Bazaar sell refills; bombchus open Bombchu Bowling.
+    false: 50
+    true: 0
+  bridge_stones: # Set the number of Spiritual Stones required for the rainbow bridge.
+    # you can add additional values between minimum and maximum
+    0: 0 # minimum value
+    3: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  bridge_medallions: # Set the number of medallions required for the rainbow bridge.
+    # you can add additional values between minimum and maximum
+    0: 0 # minimum value
+    6: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  bridge_rewards: # Set the number of dungeon rewards required for the rainbow bridge.
+    # you can add additional values between minimum and maximum
+    0: 0 # minimum value
+    9: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  bridge_tokens: # Set the number of Gold Skulltula Tokens required for the rainbow bridge.
+    # you can add additional values between minimum and maximum
+    0: 0 # minimum value
+    100: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  shuffle_mapcompass: # Control where to shuffle dungeon maps and compasses.
+    remove: 0
+    startwith: 50
+    vanilla: 0
+    dungeon: 0
+    overworld: 0
+    any_dungeon: 0
+    keysanity: 0
+  shuffle_smallkeys: # Control where to shuffle dungeon small keys.
+    remove: 0
+    vanilla: 0
+    dungeon: 50
+    overworld: 0
+    any_dungeon: 0
+    keysanity: 0
+  shuffle_fortresskeys: # Control where to shuffle the Gerudo Fortress small keys.
+    vanilla: 50
+    overworld: 0
+    any_dungeon: 0
+    keysanity: 0
+  shuffle_bosskeys: # Control where to shuffle boss keys, except the Ganon's Castle Boss Key.
+    remove: 0
+    vanilla: 0
+    dungeon: 50
+    overworld: 0
+    any_dungeon: 0
+    keysanity: 0
+  shuffle_ganon_bosskey: # Control where to shuffle the Ganon's Castle Boss Key.
+    remove: 50
+    vanilla: 0
+    dungeon: 0
+    overworld: 0
+    any_dungeon: 0
+    keysanity: 0
+    on_lacs: 0
+  enhance_map_compass: # Map tells if a dungeon is vanilla or MQ. Compass tells what the dungeon reward is.
+    false: 50
+    true: 0
+  lacs_condition: # Set the requirements for the Light Arrow Cutscene in the Temple of Time.
+    vanilla: 50
+    stones: 0
+    medallions: 0
+    dungeons: 0
+    tokens: 0
+  lacs_stones: # Set the number of Spiritual Stones required for LACS.
+    # you can add additional values between minimum and maximum
+    0: 0 # minimum value
+    3: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  lacs_medallions: # Set the number of medallions required for LACS.
+    # you can add additional values between minimum and maximum
+    0: 0 # minimum value
+    6: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  lacs_rewards: # Set the number of dungeon rewards required for LACS.
+    # you can add additional values between minimum and maximum
+    0: 0 # minimum value
+    9: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  lacs_tokens: # Set the number of Gold Skulltula Tokens required for LACS.
+    # you can add additional values between minimum and maximum
+    0: 0 # minimum value
+    100: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  shuffle_song_items: # Set where songs can appear.
+    song: 50
+    dungeon: 0
+    any: 0
+  shopsanity: # Randomizes shop contents. Set to "off" to not shuffle shops; "0" shuffles shops but does not allow multiworld items in shops.
+    0: 0
+    1: 0
+    2: 0
+    3: 0
+    4: 0
+    random_value: 0
+    off: 50
+  tokensanity: # Token rewards from Gold Skulltulas are shuffled into the pool.
+    off: 50
+    dungeons: 0
+    overworld: 0
+    all: 0
+  shuffle_scrubs: # Shuffle the items sold by Business Scrubs, and set the prices.
+    off: 50
+    low: 0
+    regular: 0
+    random_prices: 0
+  shuffle_cows: # Cows give items when Epona's Song is played.
+    false: 50
+    true: 0
+  shuffle_kokiri_sword: # Shuffle Kokiri Sword into the item pool.
+    false: 50
+    true: 0
+  shuffle_ocarinas: # Shuffle the Fairy Ocarina and Ocarina of Time into the item pool.
+    false: 50
+    true: 0
+  shuffle_weird_egg: # Shuffle the Weird Egg from Malon at Hyrule Castle.
+    false: 50
+    true: 0
+  shuffle_gerudo_card: # Shuffle the Gerudo Membership Card into the item pool.
+    false: 50
+    true: 0
+  shuffle_beans: # Adds a pack of 10 beans to the item pool and changes the bean salesman to sell one item for 60 rupees.
+    false: 50
+    true: 0
+  shuffle_medigoron_carpet_salesman: # Shuffle the items sold by Medigoron and the Haunted Wasteland Carpet Salesman.
+    false: 50
+    true: 0
+  skip_child_zelda: # Game starts with Zelda's Letter, the item at Zelda's Lullaby, and the relevant events already completed.
+    false: 50
+    true: 0
+  no_escape_sequence: # Skips the tower collapse sequence between the Ganondorf and Ganon fights.
+    false: 0
+    true: 50
+  no_guard_stealth: # The crawlspace into Hyrule Castle skips straight to Zelda.
+    false: 0
+    true: 50
+  no_epona_race: # Epona can always be summoned with Epona's Song.
+    false: 0
+    true: 50
+  skip_some_minigame_phases: # Dampe Race and Horseback Archery give both rewards if the second condition is met on the first attempt.
+    false: 0
+    true: 50
+  complete_mask_quest: # All masks are immediately available to borrow from the Happy Mask Shop.
+    false: 50
+    true: 0
+  useful_cutscenes: # Reenables the Poe cutscene in Forest Temple, Darunia in Fire Temple, and Twinrova introduction. Mostly useful for glitched.
+    false: 50
+    true: 0
+  fast_chests: # All chest animations are fast. If disabled, major items have a slow animation.
+    false: 0
+    true: 50
+  free_scarecrow: # Pulling out the ocarina near a scarecrow spot spawns Pierre without needing the song.
+    false: 50
+    true: 0
+  fast_bunny_hood: # Bunny Hood lets you move 1.5x faster like in Majora's Mask.
+    false: 50
+    true: 0
+  chicken_count: # Controls the number of Cuccos for Anju to give an item as child.
+    \# you can add additional values between minimum and maximum
+    0: 0 # minimum value
+    7: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  hints: # Gossip Stones can give hints about item locations.
+    none: 0
+    mask: 0
+    agony: 0
+    always: 50
+  hint_dist: # Choose the hint distribution to use. Affects the frequency of strong hints, which items are always hinted, etc.
+    balanced: 50
+    ddr: 0
+    league: 0
+    mw2: 0
+    scrubs: 0
+    strong: 0
+    tournament: 0
+    useless: 0
+    very_strong: 0
+  text_shuffle: # Randomizes text in the game for comedic effect.
+    none: 50
+    except_hints: 0
+    complete: 0
+  damage_multiplier: # Controls the amount of damage Link takes.
+    half: 0
+    normal: 50
+    double: 0
+    quadruple: 0
+    ohko: 0
+  no_collectible_hearts: # Hearts will not drop from enemies or objects.
+    false: 50
+    true: 0
+  starting_tod: # Change the starting time of day.
+    default: 50
+    sunrise: 0
+    morning: 0
+    noon: 0
+    afternoon: 0
+    sunset: 0
+    evening: 0
+    midnight: 0
+    witching_hour: 0
+  start_with_consumables: # Start the game with full Deku Sticks and Deku Nuts.
+    false: 50
+    true: 0
+  start_with_rupees: # Start with a full wallet. Wallet upgrades will also fill your wallet.
+    false: 50
+    true: 0
+  item_pool_value: # Changes the number of items available in the game.
+    plentiful: 0
+    balanced: 50
+    scarce: 0
+    minimal: 0
+  junk_ice_traps: # Adds ice traps to the item pool.
+    off: 0
+    normal: 50
+    on: 0
+    mayhem: 0
+    onslaught: 0
+  ice_trap_appearance: # Changes the appearance of ice traps as freestanding items.
+    major_only: 50
+    junk_only: 0
+    anything: 0
+  logic_earliest_adult_trade: # Earliest item that can appear in the adult trade sequence.
+    pocket_egg: 0
+    pocket_cucco: 0
+    cojiro: 0
+    odd_mushroom: 0
+    poachers_saw: 0
+    broken_sword: 0
+    prescription: 50
+    eyeball_frog: 0
+    eyedrops: 0
+    claim_check: 0
+  logic_latest_adult_trade: # Latest item that can appear in the adult trade sequence.
+    pocket_egg: 0
+    pocket_cucco: 0
+    cojiro: 0
+    odd_mushroom: 0
+    poachers_saw: 0
+    broken_sword: 0
+    prescription: 0
+    eyeball_frog: 0
+    eyedrops: 0
+    claim_check: 50
+
+```
+
+## Joining a MultiWorld Game
+
+### Obtain your OOT patch file
+
+When you join a multiworld game, you will be asked to provide your YAML file to whoever is hosting. Once that
+is done, the host will provide you with either a link to download your data file, or with a zip file containing
+everyone's data files. Your data file should have a `.z5ap` extension.
+
+Double click on your `.z5ap` file to start Z5Client and start the ROM patch process. Once the process is finished (this can take a while), the emulator will be started automatically (If we associated the extension to the emulator as recommended)
+
+### Connect to multiserver
+Once both the Z5Client and the emulator are started we must connect them. Within the emulator we click on the "Tools" menu and select "Lua console". In the new window click on the folder icon and look for the ootMulti.lua file. Once the file is loaded it will connect automatically to Z5Client.
+
+Note: We strongly advise you don't open any emulator menu while it and Z5client are connected, as the script will halt and disconnects can happen. If you get disconnected just double click on the script again.
+
+To connect the client to the multiserver simply put address:port on the textfield on top and press enter (if the server uses password, type on the bottom textfield /connect <address>:<port> [password], to connect) 
+
+Now you are ready to start your adventure in Hyrule.

WebHostLib/static/assets/tutorial/zelda5/setup_es.md

@@ -0,0 +1,372 @@
+# Guia instalación de Ocarina of time Archipelago
+
+## Nota importante
+
+Al usar el cliente y bizhawk, esta guia solo es aplicable en Windows.
+
+## Software Requerido
+
+- [bizhawk+script+Z5Client](https://github.com/ArchipelagoMW/Z5Client/releases) Recomendamos bajar el setup de Z5client ya que automatizara varios pasos mas adelante
+
+## Instala emulador y cliente
+
+Descarga el fichero getBizhawk.ps1 del enlace anterior. Colocalo en la carpeta donde desees instalar el emulador, haz click derecho en él y selecciona "Ejecutar con PowerShell". Esto descargará todas las dependencias necesarias para el emulador. Puede tardar un rato.
+
+Es recomendable asociar la extensión de las roms de N64 (\*.n64) al bizhawk que hemos instalado anteriormente. Para hacerlo simplemente debemos buscar alguna rom de n64 que tengamos, hacer click derecho, seleccionar "Abrir con...", desplegar la lista y buscar la opción "Buscar otra aplicación", navegar hasta el directorio de bizhawk y seleccionar EmuHawk.exe
+
+Situa el fichero ootMulti.lua del enlace anterior en la carpeta "lua" del emulador recien instalado.
+
+Instala el cliente Z5Client.
+
+## Configura tu fichero YAML
+
+### Que es un fichero YAML y por qué necesito uno?
+Tu fichero YAML contiene un numero de opciones que proveen al generador con información sobre como debe generar tu juego.
+Cada jugador de un multiworld entregara u propio fichero YAML.
+Esto permite que cada jugador disfrute de una experiencia personalizada a su gusto y diferentes jugadores dentro del mismo multiworld
+pueden tener diferentes opciones
+
+### Where do I get a YAML file?
+Un fichero basico yaml para OOT tendra este aspecto. (Hay muchas opciones cosméticas que se han ignorado para este tutorial, si quieres ver una lista completa, descarga (Archipelago)[https://github.com/ArchipelagoMW/Archipelago/releases] y buscar el fichero de ejemplo en el directorio "Players"))
+```yaml
+description: Default Ocarina of Time Template # Describe tu fichero yalm
+\# Tu nombre en el juego. Los espacio seran reemplazados por _ y hay un limite de 16 caracteres
+name: YourName{number}
+game:
+  Ocarina of Time: 1
+requires:
+  version: 0.1.7 # Version de archipelago minima.
+\# Opciones compartidas por todos los juegos:
+accessibility:
+  items: 0 # Garantiza que puedes obtener todos los objetos pero no todas las localizaciones
+  locations: 50 # Garantiza que puedes obtener todas las localizaciones
+  none: 0 # Solo garantiza que el juego pueda completarse.
+progression_balancing:
+  on: 50 # Un sistema para reducir tiempos de espera en una partida multiworld
+  off: 0
+Ocarina of Time:
+  logic_rules: # Logica usada por el randomizer.
+    glitchless: 50
+    glitched: 0
+    no_logic: 0
+  logic_no_night_tokens_without_suns_song: # Las skulltulas nocturnas requeriran la cancion del sol por logica
+    false: 50
+    true: 0
+  open_forest: # Indica el estado del bosque Kokiri y el camino al Arbol Deku.
+    open: 50
+    closed_deku: 0
+    closed: 0
+  open_kakariko: # Indica el estado de la puerta de Kakariko hacia la montaña de la muerte.
+    open: 50
+    zelda: 0
+    closed: 0
+  open_door_of_time: # Abre la puerta del tiempo sin la cancion del tiempo.
+    false: 0
+    true: 50
+  zora_fountain: # Indica el estado del rey zora bloqueando el camino a la fuente Zora.
+    open: 0
+    adult: 0
+    closed: 50
+  gerudo_fortress: # Indica los requerimientos para acceder a la fortaleza Gerudo.
+    normal: 0
+    fast: 50
+    open: 0
+  bridge: # Indica los requerimientos para el puente arco iris.
+    open: 0
+    vanilla: 0
+    stones: 0
+    medallions: 50
+    dungeons: 0
+    tokens: 0
+  trials: # Numero de pruebas dentro del castillo de Ganon.
+    0: 50 # minimum value
+    6: 0 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  starting_age: # Indica la edad con la que empieza link.
+    child: 50
+    adult: 0
+  triforce_hunt: # Reune piezas de trifuerza para completar el juego.
+    false: 50
+    true: 0
+  triforce_goal: # Numero de piezas de trifuerza requeridas. El numero de piezas disponibles es determinado por la opcion "Item pool".
+    1: 0 # minimum value
+    50: 0 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+    20: 50
+  bombchus_in_logic: # Los bombchus son considerados para la logica. El primer pack encontrado da 20 chus y las tiendas kokiri y el bazaar los venden. Bombchus abren la bolera.
+    false: 50
+    true: 0
+  bridge_stones: # Numero de piedras para abrir el puente arco iris.
+    0: 0 # minimum value
+    3: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  bridge_medallions: # Numero de medallones para abrir el puente arco iris.
+    0: 0 # minimum value
+    6: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  bridge_rewards: # Numero de mazmorras (cualquier combinacion de medallones y piedras) para abrir el puente arco iris.
+    0: 0 # minimum value
+    9: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  bridge_tokens: # Numero de skultullas de oro requeridas para el puente arco iris.
+    0: 0 # minimum value
+    100: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  shuffle_mapcompass: # Controla donde pueden aparecer los mapas y las brujulas.
+    remove: 0
+    startwith: 50
+    vanilla: 0
+    dungeon: 0
+    overworld: 0
+    any_dungeon: 0
+    keysanity: 0
+  shuffle_smallkeys: # Controla donde pueden aparecer las llaves pequeñas.
+    remove: 0
+    vanilla: 0
+    dungeon: 50
+    overworld: 0
+    any_dungeon: 0
+    keysanity: 0
+  shuffle_fortresskeys: # Controla donde pueden aparecer las llaves de la fortaleza Gerudo.
+    vanilla: 50
+    overworld: 0
+    any_dungeon: 0
+    keysanity: 0
+  shuffle_bosskeys: # Controla donde pueden aparecer las llaves de jefe (excepto la llave del castillo de ganon).
+    remove: 0
+    vanilla: 0
+    dungeon: 50
+    overworld: 0
+    any_dungeon: 0
+    keysanity: 0
+  shuffle_ganon_bosskey: # Controla donde puede aparecer la llave del jefe del castillo de Ganon.
+    remove: 50
+    vanilla: 0
+    dungeon: 0
+    overworld: 0
+    any_dungeon: 0
+    keysanity: 0
+    on_lacs: 0
+  enhance_map_compass: # El mapa indica si una dungeon es clasica o Master Quest. Las brujulas indican la recompensa de mazmorra.
+    false: 50
+    true: 0
+  lacs_condition: # Marca el requerimiento para la escena de las flechas de luz (LACS) en el templo del tiempo.
+    vanilla: 50
+    stones: 0
+    medallions: 0
+    dungeons: 0
+    tokens: 0
+  lacs_stones: # Marca el numero de piedras espirituales requeridas para LACS
+    0: 0 # minimum value
+    3: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  lacs_medallions: # Marca el numero de medallones requeridas para LACS.
+    0: 0 # minimum value
+    6: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  lacs_rewards: # Marca el numero de recompensas de mazmorra requeridas para LACS.
+    0: 0 # minimum value
+    9: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  lacs_tokens: # Marca el numero de Skulltulas de oro requeridas para LACS.
+    0: 0 # minimum value
+    100: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  shuffle_song_items: # Marca donde pueden aparecer las canciones.
+    song: 50
+    dungeon: 0
+    any: 0
+  shopsanity: # Aleatoriza el contenido de las tiendas. "off" para no mezclar las tiendas; "0" mezcla las tiendas pero no permite objetos unicos en ellas.
+    0: 0
+    1: 0
+    2: 0
+    3: 0
+    4: 0
+    random_value: 0
+    off: 50
+  tokensanity: # Indica si las Skulltulas de oro pueden tener objetos que no sean su ficha.
+    off: 50
+    dungeons: 0
+    overworld: 0
+    all: 0
+  shuffle_scrubs: # Aleatoriza los objetos de los Scrubs vendedores y marca su precio.
+    off: 50
+    low: 0
+    regular: 0
+    random_prices: 0
+  shuffle_cows: # Las vacas dan objetos cuando les tocas las cancion de Epona.
+    false: 50
+    true: 0
+  shuffle_kokiri_sword: # Aleatoriza la posicion de la espada Kokiri.
+    false: 50
+    true: 0
+  shuffle_ocarinas: # Aleatoriza la posicion de las ocarinas.
+    false: 50
+    true: 0
+  shuffle_weird_egg: # Aleatoriza la posicion del huevo extraño.
+    false: 50
+    true: 0
+  shuffle_gerudo_card: # Aleatoriza la posicion de la tarjeta de membresia Gerudo.
+    false: 50
+    true: 0
+  shuffle_beans: # Añade un pack de 10 judias magicas al juego y el vendedor vende un solo objeto por 60 rupias.
+    false: 50
+    true: 0
+  shuffle_medigoron_carpet_salesman: # Aleatoriza el objeto que vende Medigoron y el vendedor de la alfombra voladora del paramo maldito.
+    false: 50
+    true: 0
+  skip_child_zelda: # Empieza el juego con la carta de zelda, el objeto que daria impa al enseñar la nana de zelda. Y zelda se considera ya visitada (puedes ir directamente a ver a Saria al bosque y a Malon al rancho)
+    false: 50
+    true: 0
+  no_escape_sequence: # Elimina la huida de link y zelda despues de ganar a Ganondorf.
+    false: 0
+    true: 50
+  no_guard_stealth: # Elimina la escena de sigilo antes de ver a Zelda.
+    false: 0
+    true: 50
+  no_epona_race: # No necesitas hacer la carrera para invocar a Epona.
+    false: 0
+    true: 50
+  skip_some_minigame_phases: # La carrera de Dampe y el minijuego de arco a caballo dan ambras recompensas a la vez si se cumplen las condiciones.
+    false: 0
+    true: 50
+  complete_mask_quest: # Todas las mascaras estan disponibles.
+    false: 50
+    true: 0
+  useful_cutscenes: # Ciertas escenas se mantienen (como los Poes del templo del bosque, Darunia o Twinrova. Principalmente util para modos con Glitches.
+    false: 50
+    true: 0
+  fast_chests: # Los cofres siempre se cogen rapido. Si se desactiva, los objetos importantes tienen animacion lenta. (IMPORTANTE: TODOS LOS OBJETOS QUE VAYAN A OTROS MUNDOS SE CONSIDERAN IMPORTANTES)
+    false: 0
+    true: 50
+  free_scarecrow: # Sacara la ocraina cerca de un punto con espantapajaros invoca a Pierre sin necesidad de la cancion.
+    false: 50
+    true: 0
+  fast_bunny_hood: # La capucha conejo mejora tu velocidad como en Majora's Mask.
+    false: 50
+    true: 0
+  chicken_count: # Numero de Cuccos que Anju necesita en el corral para que te de el objeto.
+    0: 0 # minimum value
+    7: 50 # maximum value
+    random: 0
+    random-low: 0
+    random-high: 0
+  hints: # Marca el requerimiento para que las piedras chivatas den pistas.
+    none: 0
+    mask: 0
+    agony: 0
+    always: 50
+  hint_dist: # Elije la distribucion de pistas
+    balanced: 50
+    ddr: 0
+    league: 0
+    mw2: 0
+    scrubs: 0
+    strong: 0
+    tournament: 0
+    useless: 0
+    very_strong: 0
+  damage_multiplier: # Controla el daño que recibe Link.
+    half: 0
+    normal: 50
+    double: 0
+    quadruple: 0
+    ohko: 0
+  no_collectible_hearts: # No caen corazones de enemigos u objetos.
+    false: 50
+    true: 0
+  starting_tod: # Cambia el momento del dia al empezar el juego.
+    default: 50
+    sunrise: 0
+    morning: 0
+    noon: 0
+    afternoon: 0
+    sunset: 0
+    evening: 0
+    midnight: 0
+    witching_hour: 0
+  start_with_consumables: # Empieza el juego con el maximo de palos y nueves Deku que pueda llevar Link.
+    false: 50
+    true: 0
+  start_with_rupees: # Empieza el juego con la cartera llena. Las mejoras de cartera vienen llenas.
+    false: 50
+    true: 0
+  item_pool_value: # Cambia el numero de objetos disponibles en el juego.
+    plentiful: 0
+    balanced: 50
+    scarce: 0
+    minimal: 0
+  junk_ice_traps: # Añade trampas de hielo.
+    off: 0
+    normal: 50
+    on: 0
+    mayhem: 0
+    onslaught: 0
+  ice_trap_appearance: # Cambia la apariencia de las trampas de hielo cuando aparecen como objetos fuera de cofres.
+    major_only: 50
+    junk_only: 0
+    anything: 0
+  logic_earliest_adult_trade: # Objeto mas bajo que puede aparecer en la secuencia de cambios de Link Adulto.
+    pocket_egg: 0
+    pocket_cucco: 0
+    cojiro: 0
+    odd_mushroom: 0
+    poachers_saw: 0
+    broken_sword: 0
+    prescription: 50
+    eyeball_frog: 0
+    eyedrops: 0
+    claim_check: 0
+  logic_latest_adult_trade: # Objeto mas tardio que puede aparecer en la secuencia de cambios de Link Adulto.
+    pocket_egg: 0
+    pocket_cucco: 0
+    cojiro: 0
+    odd_mushroom: 0
+    poachers_saw: 0
+    broken_sword: 0
+    prescription: 0
+    eyeball_frog: 0
+    eyedrops: 0
+    claim_check: 50
+
+```
+
+## Unirse a un juego MultiWorld
+
+### Obten tu parche
+
+
+Cuando te unes a un juego multiworld, se te pedirá que entregues tu fichero YAML a quien sea que hospede el juego multiworld.
+Una vez la generación acabe, el anfitrión te dará un enlace a tu fichero de datos o un zip con los ficheros de todos.
+Tu fichero de datos tiene una extensión `.z5ap`.
+
+Haz doble click en tu fichero `.z5ap` para que se arranque el Z5Client y realize el parcheado de la ROM. Una vez acabe el parcheado de la rom (esto puede llevar un tiempo) se abrira automaticamente el emulador (Si se ha asociado la extensión al emulador tal como hemos recomendado)
+
+### Conectar al multiserver
+Una vez arrancado tanto el Z5Client como el emulador hay que conectarlo entre ellos, para ello simplemente accede al menú "Tools" y selecciona "Lua console". En la nueva ventana, dale al icono de la carpeta y busca el fichero ootMulti.lua. Al cargar dicho fichero se conectara automaticamente con el cliente.
+
+Nota: Es muy recomendable que no se abra ningún menú del emulador mientras esten emulador y Z5Client conectados, ya que el script de conexión se para en ese caso y pueden provocar desconexiones. Si se pierde la conexion, simplemente haz doble click en el script de nuevo.
+
+Para conectar el cliente con el servidor simplemente pon la direccion_IP:puerto en la caja de texto de arriba y presiona enter (si el servidor tiene contraseña, en la caja de texto de abajo escribir /connect direccion:puerto contraseña, para conectar) 
+
+Y ya estas listo, para emprender tu aventura por Hyrule.

WebHostLib/static/assets/weightedSettings.js

@@ -1,486 +0,0 @@
-let spriteData = null;
-
-window.addEventListener('load', () => {
-  const gameSettings = document.getElementById('weighted-settings');
-  Promise.all([fetchWeightedSettingsYaml(), fetchWeightedSettingsJson(), fetchSpriteData()]).then((results) => {
-    // Load YAML into object
-    const sourceData = jsyaml.safeLoad(results[0], { json: true });
-    const wsVersion = sourceData.ws_version;
-    delete sourceData.ws_version; // Do not include the settings version number in the export
-
-    // Check if settings exist in localStorage. If no settings are present, this is a first load (or reset to default)
-    // and the version number should be silently updated
-    if (!localStorage.getItem('weightedSettings1')) {
-      localStorage.setItem('wsVersion', wsVersion);
-    }
-
-    // Update localStorage with three settings objects. Preserve original objects if present.
-    for (let i=1; i<=3; i++) {
-      const localSettings = JSON.parse(localStorage.getItem(`weightedSettings${i}`));
-      const updatedObj = localSettings ? Object.assign(sourceData, localSettings) : sourceData;
-      localStorage.setItem(`weightedSettings${i}`, JSON.stringify(updatedObj));
-    }
-
-    // Build the entire UI
-    buildUI(JSON.parse(results[1]), JSON.parse(results[2]));
-
-    // Populate the UI and add event listeners
-    populateSettings();
-    document.getElementById('preset-number').addEventListener('change', populateSettings);
-    gameSettings.addEventListener('change', handleOptionChange);
-    gameSettings.addEventListener('keyup', handleOptionChange);
-
-    document.getElementById('export-button').addEventListener('click', exportSettings);
-    document.getElementById('reset-to-default').addEventListener('click', resetToDefaults);
-    adjustHeaderWidth();
-
-    if (localStorage.getItem('wsVersion') !== wsVersion) {
-      const userWarning = document.getElementById('user-warning');
-      const messageSpan = document.createElement('span');
-      messageSpan.innerHTML = "A new version of the weighted settings file is available. Click here to update!" +
-        "<br />Be aware this will also reset your presets, so you should export them now if you want to save them.";
-      userWarning.appendChild(messageSpan);
-      userWarning.style.display = 'block';
-      userWarning.addEventListener('click', resetToDefaults);
-    }
-  }).catch((error) => {
-    console.error(error);
-    gameSettings.innerHTML = `
-            <h2>Something went wrong while loading your game settings page.</h2>
-            <h2>${error}</h2>
-            <h2><a href="${window.location.origin}">Click here to return to safety!</a></h2>
-            `
-  });
-  document.getElementById('generate-game').addEventListener('click', () => generateGame());
-  document.getElementById('generate-race').addEventListener('click', () => generateGame(true));
-});
-
-const fetchWeightedSettingsYaml = () => new Promise((resolve, reject) => {
-  const ajax = new XMLHttpRequest();
-  ajax.onreadystatechange = () => {
-    if (ajax.readyState !== 4) { return; }
-    if (ajax.status !== 200) {
-      reject("Unable to fetch source yaml file.");
-      return;
-    }
-    resolve(ajax.responseText);
-  };
-  ajax.open('GET', `${window.location.origin}/static/static/weightedSettings.yaml` ,true);
-  ajax.send();
-});
-
-const fetchWeightedSettingsJson = () => new Promise((resolve, reject) => {
-  const ajax = new XMLHttpRequest();
-  ajax.onreadystatechange = () => {
-    if (ajax.readyState !== 4) { return; }
-    if (ajax.status !== 200) {
-      reject('Unable to fetch JSON schema file');
-      return;
-    }
-    resolve(ajax.responseText);
-  };
-  ajax.open('GET', `${window.location.origin}/static/static/weightedSettings.json`, true);
-  ajax.send();
-});
-
-const fetchSpriteData = () => new Promise((resolve, reject) => {
-  const ajax = new XMLHttpRequest();
-  ajax.onreadystatechange = () => {
-    if (ajax.readyState !== 4) { return; }
-    if (ajax.status !== 200) {
-      reject('Unable to fetch sprite data.');
-      return;
-    }
-    resolve(ajax.responseText);
-  };
-  ajax.open('GET', `${window.location.origin}/static/generated/spriteData.json`, true);
-  ajax.send();
-});
-
-const handleOptionChange = (event) => {
-  if(!event.target.matches('.setting')) { return; }
-  const presetNumber = document.getElementById('preset-number').value;
-  const settings = JSON.parse(localStorage.getItem(`weightedSettings${presetNumber}`))
-  const settingString = event.target.getAttribute('data-setting');
-  document.getElementById(settingString).innerText = event.target.value;
-  if(getSettingValue(settings, settingString) !== false){
-    const keys = settingString.split('.');
-    switch (keys.length) {
-      case 1:
-        settings[keys[0]] = isNaN(event.target.value) ?
-          event.target.value : parseInt(event.target.value, 10);
-        break;
-      case 2:
-        settings[keys[0]][keys[1]] = isNaN(event.target.value) ?
-          event.target.value : parseInt(event.target.value, 10);
-        break;
-      case 3:
-        settings[keys[0]][keys[1]][keys[2]] = isNaN(event.target.value) ?
-          event.target.value : parseInt(event.target.value, 10);
-        break;
-      default:
-        console.warn(`Unknown setting string received: ${settingString}`)
-        return;
-    }
-
-    // Save the updated settings object bask to localStorage
-    localStorage.setItem(`weightedSettings${presetNumber}`, JSON.stringify(settings));
-  }else{
-    console.warn(`Unknown setting string received: ${settingString}`)
-  }
-};
-
-const populateSettings = () => {
-  buildSpriteOptions();
-  const presetNumber = document.getElementById('preset-number').value;
-  const settings = JSON.parse(localStorage.getItem(`weightedSettings${presetNumber}`))
-  const settingsInputs = Array.from(document.querySelectorAll('.setting'));
-  settingsInputs.forEach((input) => {
-    const settingString = input.getAttribute('data-setting');
-    const settingValue = getSettingValue(settings, settingString);
-    if(settingValue !== false){
-      input.value = settingValue;
-      document.getElementById(settingString).innerText = settingValue;
-    }
-  });
-};
-
-/**
- * Returns the value of the settings object, or false if the settings object does not exist
- * @param settings
- * @param keyString
- * @returns {string} | bool
- */
-const getSettingValue = (settings, keyString) => {
-  const keys = keyString.split('.');
-  let currentVal = settings;
-  keys.forEach((key) => {
-    if(typeof(key) === 'string' && currentVal.hasOwnProperty(key)){
-      currentVal = currentVal[key];
-    }else{
-      currentVal = false;
-    }
-  });
-  return currentVal;
-};
-
-const exportSettings = () => {
-  const presetNumber = document.getElementById('preset-number').value;
-  const settings = JSON.parse(localStorage.getItem(`weightedSettings${presetNumber}`));
-  const yamlText = jsyaml.safeDump(settings, { noCompatMode: true }).replaceAll(/'(\d+)':/g, (x, y) => `${y}:`);
-  download(`${settings.description}.yaml`, yamlText);
-};
-
-const resetToDefaults = () => {
-  [1, 2, 3].forEach((presetNumber) => localStorage.removeItem(`weightedSettings${presetNumber}`));
-  location.reload();
-};
-
-/** Create an anchor and trigger a download of a text file. */
-const download = (filename, text) => {
-  const downloadLink = document.createElement('a');
-  downloadLink.setAttribute('href','data:text/yaml;charset=utf-8,'+ encodeURIComponent(text))
-  downloadLink.setAttribute('download', filename);
-  downloadLink.style.display = 'none';
-  document.body.appendChild(downloadLink);
-  downloadLink.click();
-  document.body.removeChild(downloadLink);
-};
-
-const buildUI = (settings, spriteData) => {
-  const settingsWrapper = document.getElementById('settings-wrapper');
-  const settingTypes = {
-    gameOptions: 'Game Options',
-    romOptions: 'ROM Options',
-  }
-
-  Object.keys(settingTypes).forEach((settingTypeKey) => {
-    const sectionHeader = document.createElement('h2');
-    sectionHeader.innerText = settingTypes[settingTypeKey];
-    settingsWrapper.appendChild(sectionHeader);
-
-    Object.values(settings[settingTypeKey]).forEach((setting) => {
-      if (typeof(setting.inputType) === 'undefined' || !setting.inputType){
-        console.error(setting);
-        throw new Error('Setting with no inputType specified.');
-      }
-
-      switch(setting.inputType){
-        case 'text':
-          // Currently, all text input is handled manually because there is very little of it
-          return;
-        case 'range':
-          buildRangeSettings(settingsWrapper, setting);
-          return;
-        default:
-          console.error(setting);
-          throw new Error('Unhandled inputType specified.');
-      }
-    });
-  });
-
-  // Build sprite options
-  const spriteOptionsHeader = document.createElement('h2');
-  spriteOptionsHeader.innerText = 'Sprite Options';
-  settingsWrapper.appendChild(spriteOptionsHeader);
-
-  const spriteOptionsWrapper = document.createElement('div');
-  spriteOptionsWrapper.setAttribute('id', 'sprite-options-wrapper');
-  spriteOptionsWrapper.className = 'setting-wrapper';
-  settingsWrapper.appendChild(spriteOptionsWrapper);
-
-  // Append sprite picker
-  settingsWrapper.appendChild(buildSpritePicker(spriteData));
-};
-
-const buildSpriteOptions = () => {
-  const spriteOptionsWrapper = document.getElementById('sprite-options-wrapper');
-
-  // Clear the contents of the wrapper div
-  while(spriteOptionsWrapper.firstChild){
-    spriteOptionsWrapper.removeChild(spriteOptionsWrapper.lastChild);
-  }
-
-  const spriteOptionsTitle = document.createElement('span');
-  spriteOptionsTitle.className = 'title-span';
-  spriteOptionsTitle.innerText = 'Alternate Sprites';
-  spriteOptionsWrapper.appendChild(spriteOptionsTitle);
-
-  const spriteOptionsDescription = document.createElement('span');
-  spriteOptionsDescription.className = 'description-span';
-  spriteOptionsDescription.innerHTML = 'Choose an alternate sprite to play the game with. Additional randomization ' +
-    'options are documented in the ' +
-    '<a href="https://github.com/Berserker66/MultiWorld-Utilities/blob/main/playerSettings.yaml#L374">settings file</a>.';
-  spriteOptionsWrapper.appendChild(spriteOptionsDescription);
-
-  const spriteOptionsTable = document.createElement('table');
-  spriteOptionsTable.setAttribute('id', 'sprite-options-table');
-  spriteOptionsTable.className = 'option-set';
-  const tbody = document.createElement('tbody');
-  tbody.setAttribute('id', 'sprites-tbody');
-
-  const currentPreset = document.getElementById('preset-number').value;
-  const playerSettings = JSON.parse(localStorage.getItem(`weightedSettings${currentPreset}`));
-
-  // Manually add a row for random sprites
-  addSpriteRow(tbody, playerSettings, 'random');
-
-  // Add a row for each sprite currently present in the player's settings
-  Object.keys(playerSettings.rom.sprite).forEach((spriteName) => {
-    if(['random'].indexOf(spriteName) > -1) return;
-    addSpriteRow(tbody, playerSettings, spriteName)
-  });
-
-  spriteOptionsTable.appendChild(tbody);
-  spriteOptionsWrapper.appendChild(spriteOptionsTable);
-};
-
-const buildRangeSettings = (parentElement, settings) => {
-  // Ensure we are operating on a range-specific setting
-  if(typeof(settings.inputType) === 'undefined' || settings.inputType !== 'range'){
-    throw new Error('Invalid input type provided to buildRangeSettings func.');
-  }
-
-  const settingWrapper = document.createElement('div');
-  settingWrapper.className = 'setting-wrapper';
-
-  if(typeof(settings.friendlyName) !== 'undefined' && settings.friendlyName){
-    const sectionTitle = document.createElement('span');
-    sectionTitle.className = 'title-span';
-    sectionTitle.innerText = settings.friendlyName;
-    settingWrapper.appendChild(sectionTitle);
-  }
-
-  if(settings.description){
-    const description = document.createElement('span');
-    description.className = 'description-span';
-    description.innerText = settings.description;
-    settingWrapper.appendChild(description);
-  }
-
-  // Create table
-  const optionSetTable = document.createElement('table');
-  optionSetTable.className = 'option-set';
-
-  // Create table body
-  const tbody = document.createElement('tbody');
-  Object.keys(settings.subOptions).forEach((setting) => {
-    // Overwrite setting key name with real object
-    setting = settings.subOptions[setting];
-    const settingId = (Math.random() * 1000000).toString();
-
-    // Create rows for each option
-    const optionRow = document.createElement('tr');
-
-    // Option name td
-    const optionName = document.createElement('td');
-    optionName.className = 'option-name';
-    const optionLabel = document.createElement('label');
-    optionLabel.setAttribute('for', settingId);
-    optionLabel.setAttribute('data-tooltip', setting.description);
-    optionLabel.innerText = setting.friendlyName;
-    optionName.appendChild(optionLabel);
-    optionRow.appendChild(optionName);
-
-    // Option value td
-    const optionValue = document.createElement('td');
-    optionValue.className = 'option-value';
-    const input = document.createElement('input');
-    input.className = 'setting';
-    input.setAttribute('id', settingId);
-    input.setAttribute('type', 'range');
-    input.setAttribute('min', '0');
-    input.setAttribute('max', '100');
-    input.setAttribute('data-setting', setting.keyString);
-    input.value = setting.defaultValue;
-    optionValue.appendChild(input);
-    const valueDisplay = document.createElement('span');
-    valueDisplay.setAttribute('id', setting.keyString);
-    valueDisplay.innerText = setting.defaultValue;
-    optionValue.appendChild(valueDisplay);
-    optionRow.appendChild(optionValue);
-    tbody.appendChild(optionRow);
-  });
-
-  optionSetTable.appendChild(tbody);
-  settingWrapper.appendChild(optionSetTable);
-  parentElement.appendChild(settingWrapper);
-};
-
-const addSpriteRow = (tbody, playerSettings, spriteName) => {
-  const rowId = (Math.random() * 1000000).toString();
-  const optionId = (Math.random() * 1000000).toString();
-  const tr = document.createElement('tr');
-  tr.setAttribute('id', rowId);
-
-  // Option Name
-  const optionName = document.createElement('td');
-  optionName.className = 'option-name';
-  const label = document.createElement('label');
-  label.htmlFor = optionId;
-  label.innerText = spriteName;
-  optionName.appendChild(label);
-
-  if(['random', 'random_sprite_on_event'].indexOf(spriteName) === -1) {
-    const deleteButton = document.createElement('span');
-    deleteButton.setAttribute('data-sprite', spriteName);
-    deleteButton.setAttribute('data-row-id', rowId);
-    deleteButton.innerText = ' (❌)';
-    deleteButton.className = 'delete-button';
-    optionName.appendChild(deleteButton);
-    deleteButton.addEventListener('click', removeSpriteOption);
-  }
-
-  tr.appendChild(optionName);
-
-  // Option Value
-  const optionValue = document.createElement('td');
-  optionValue.className = 'option-value';
-  const input = document.createElement('input');
-  input.className = 'setting';
-  input.setAttribute('id', optionId);
-  input.setAttribute('type', 'range');
-  input.setAttribute('min', '0');
-  input.setAttribute('max', '100');
-  input.setAttribute('data-setting', `rom.sprite.${spriteName}`);
-  input.value = "50";
-  optionValue.appendChild(input);
-
-  // Value display
-  const valueDisplay = document.createElement('span');
-  valueDisplay.setAttribute('id', `rom.sprite.${spriteName}`);
-  valueDisplay.innerText = playerSettings.rom.sprite.hasOwnProperty(spriteName) ?
-    playerSettings.rom.sprite[spriteName] : '0';
-  optionValue.appendChild(valueDisplay);
-
-  tr.appendChild(optionValue);
-  tbody.appendChild(tr);
-};
-
-const addSpriteOption = (event) => {
-  const presetNumber = document.getElementById('preset-number').value;
-  const playerSettings = JSON.parse(localStorage.getItem(`weightedSettings${presetNumber}`));
-  const spriteName = event.target.getAttribute('data-sprite');
-
-  if (Object.keys(playerSettings.rom.sprite).indexOf(spriteName) !== -1) {
-    // Do not add the same sprite twice
-    return;
-  }
-
-  // Add option to playerSettings object
-  playerSettings.rom.sprite[event.target.getAttribute('data-sprite')] = 50;
-  localStorage.setItem(`weightedSettings${presetNumber}`, JSON.stringify(playerSettings));
-
-  // Add <tr> to #sprite-options-table
-  const tbody = document.getElementById('sprites-tbody');
-  addSpriteRow(tbody, playerSettings, spriteName);
-};
-
-const removeSpriteOption = (event) => {
-  const presetNumber = document.getElementById('preset-number').value;
-  const playerSettings = JSON.parse(localStorage.getItem(`weightedSettings${presetNumber}`));
-  const spriteName = event.target.getAttribute('data-sprite');
-
-  // Remove option from playerSettings object
-  delete playerSettings.rom.sprite[spriteName];
-  localStorage.setItem(`weightedSettings${presetNumber}`, JSON.stringify(playerSettings));
-
-  // Remove <tr> from #sprite-options-table
-  const tr = document.getElementById(event.target.getAttribute('data-row-id'));
-  tr.parentNode.removeChild(tr);
-};
-
-const buildSpritePicker = (spriteData) => {
-  const spritePicker = document.createElement('div');
-  spritePicker.setAttribute('id', 'sprite-picker');
-
-  // Build description
-  const description = document.createElement('span');
-  description.innerText = 'To add a sprite to your playable list, click the one you want below.';
-  spritePicker.appendChild(description);
-
-  const sprites = document.createElement('div');
-  sprites.setAttribute('id', 'sprite-picker-sprites');
-  spriteData.sprites.forEach((sprite) => {
-    const spriteImg = document.createElement('img');
-    let spriteGifFile = sprite.file.split('.');
-    spriteGifFile.pop();
-    spriteGifFile = spriteGifFile.join('.') + '.gif';
-    spriteImg.setAttribute('src', `static/generated/sprites/${spriteGifFile}`);
-    spriteImg.setAttribute('data-sprite', sprite.file.split('.')[0]);
-    spriteImg.setAttribute('alt', sprite.name);
-
-    // Wrap the image in a span to allow for tooltip presence
-    const imgWrapper = document.createElement('span');
-    imgWrapper.className = 'sprite-img-wrapper';
-    imgWrapper.setAttribute('data-tooltip', `${sprite.name}${sprite.author ? `, by ${sprite.author}` : ''}`);
-    imgWrapper.appendChild(spriteImg);
-    imgWrapper.setAttribute('data-sprite', sprite.name);
-    sprites.appendChild(imgWrapper);
-    imgWrapper.addEventListener('click', addSpriteOption);
-  });
-
-  spritePicker.appendChild(sprites);
-  return spritePicker;
-};
-
-const generateGame = (raceMode = false) => {
-  const presetNumber = document.getElementById('preset-number').value;
-  axios.post('/api/generate', {
-    weights: { player: localStorage.getItem(`weightedSettings${presetNumber}`) },
-    presetData: { player: localStorage.getItem(`weightedSettings${presetNumber}`) },
-    playerCount: 1,
-    race: raceMode ? '1' : '0',
-  }).then((response) => {
-    window.location.href = response.data.url;
-  }).catch((error) => {
-    const userMessage = document.getElementById('user-message');
-    userMessage.innerText = 'Something went wrong and your game could not be generated.';
-    if (error.response.data.text) {
-      userMessage.innerText += ' ' + error.response.data.text;
-    }
-    userMessage.classList.add('visible');
-    window.scrollTo(0, 0);
-    console.error(error);
-  });
-};

WebHostLib/static/styles/generate.css

@@ -25,6 +25,21 @@
     margin-bottom: 1rem;
 }
 
-#generate-game-form{
+#generate-game-form-wrapper table td{
+    text-align: left;
+    padding-right: 0.5rem;
+}
+
+#generate-form-button-row{
+    display: flex;
+    flex-direction: row;
+    justify-content: center;
+}
+
+#file-input{
     display: none;
 }
+
+.interactive{
+    color: #ffef00;
+}

WebHostLib/static/styles/landing.css

@@ -60,7 +60,7 @@ html{
     width: 200px;
     height: calc(156px - 40px);
     padding-top: 40px;
-    cursor: default;
+    cursor: pointer;
 }
 
 #mid-left-button{

WebHostLib/static/styles/markdown.css

@@ -1,4 +1,4 @@
-#tutorial-wrapper{
+.markdown{
     display: flex;
     flex-direction: column;
     max-width: 70rem;
@@ -10,20 +10,20 @@
     color: #eeffeb;
 }
 
-#tutorial-wrapper img{
+.markdown img{
     max-width: 100%;
     border-radius: 6px;
 }
 
-#tutorial-wrapper p{
+.markdown p{
     margin-top: 0;
 }
 
-#tutorial-wrapper a{
+.markdown a{
     color: #ffef00;
 }
 
-#tutorial-wrapper h1{
+.markdown h1{
     font-size: 2.5rem;
     font-weight: normal;
     border-bottom: 1px solid #ffffff;
@@ -34,7 +34,7 @@
     text-shadow: 1px 1px 4px #000000;
 }
 
-#tutorial-wrapper h2{
+.markdown h2{
     font-size: 2rem;
     font-weight: normal;
     border-bottom: 1px solid #ffffff;
@@ -46,7 +46,7 @@
     text-shadow: 1px 1px 2px #000000;
 }
 
-#tutorial-wrapper h3{
+.markdown h3{
     font-size: 1.70rem;
     font-weight: normal;
     text-align: left;
@@ -55,44 +55,44 @@
     margin-bottom: 0.5rem;
 }
 
-#tutorial-wrapper h4{
+.markdown h4{
     font-size: 1.5rem;
     font-weight: normal;
     cursor: pointer;
     margin-bottom: 0.5rem;
 }
 
-#tutorial-wrapper h5{
+.markdown h5{
     font-size: 1.25rem;
     font-weight: normal;
     cursor: pointer;
 }
 
-#tutorial-wrapper h6{
+.markdown h6{
     font-size: 1.25rem;
     font-weight: normal;
     cursor: pointer;
     color: #434343;
 }
 
-#tutorial-wrapper h3, #tutorial-wrapper h4, #tutorial-wrapper h5,#tutorial-wrapper h6{
+.markdown h3, .markdown h4, .markdown h5,.markdown h6{
     color: #ffffff;
     text-shadow: 1px 1px 1px rgba(0, 0, 0, 0.5);
 }
 
-#tutorial-wrapper ul{
+.markdown ul{
 
 }
 
-#tutorial-wrapper ol{
+.markdown ol{
 
 }
 
-#tutorial-wrapper li{
+.markdown li{
 
 }
 
-#tutorial-wrapper pre{
+.markdown pre{
     margin-top: 0;
     padding: 0.5rem 0.25rem;
     background-color: #ffeeab;
@@ -101,7 +101,7 @@
     color: #000000;
 }
 
-#tutorial-wrapper code{
+.markdown code{
     background-color: #ffeeab;
     border-radius: 4px;
     padding-left: 0.25rem;
@@ -109,12 +109,30 @@
     color: #000000;
 }
 
-#tutorial-wrapper #tutorial-video-container{
+.markdown #tutorial-video-container{
     width: 100%;
     text-align: center;
 }
 
-#tutorial-wrapper #language-selector-wrapper{
+.markdown #language-selector-wrapper{
     width: 100%;
     text-align: right;
 }
+
+.markdown table{
+    border-collapse: collapse;
+    margin-bottom: 0.5rem;
+}
+
+.markdown table th{
+    text-align: left;
+    font-weight: bold;
+    border: 1px solid #eeffeb;
+    padding: 0.25rem;
+}
+
+.markdown table td{
+    text-align: left;
+    border: 1px solid #eeffeb;
+    padding: 0.25rem;
+}

WebHostLib/static/styles/minecraft/player-settings.css

@@ -1,129 +0,0 @@
-html{
-    background-image: url('../../static/backgrounds/grass/grass-0007-large.png');
-    background-repeat: repeat;
-    background-size: 650px 650px;
-}
-
-#player-settings{
-    max-width: 1000px;
-    margin-left: auto;
-    margin-right: auto;
-    background-color: rgba(0, 0, 0, 0.15);
-    border-radius: 8px;
-    padding: 1rem;
-    color: #eeffeb;
-}
-
-#player-settings #player-settings-button-row{
-    display: flex;
-    flex-direction: row;
-    justify-content: space-between;
-    margin-top: 15px;
-}
-
-#player-settings code{
-    background-color: #d9cd8e;
-    border-radius: 4px;
-    padding-left: 0.25rem;
-    padding-right: 0.25rem;
-    color: #000000;
-}
-
-#player-settings #user-message{
-    display: none;
-    width: calc(100% - 8px);
-    background-color: #ffe86b;
-    border-radius: 4px;
-    color: #000000;
-    padding: 4px;
-    text-align: center;
-}
-
-#player-settings #user-message.visible{
-    display: block;
-}
-
-#player-settings h1{
-    font-size: 2.5rem;
-    font-weight: normal;
-    border-bottom: 1px solid #ffffff;
-    width: 100%;
-    margin-bottom: 0.5rem;
-    color: #ffffff;
-    text-shadow: 1px 1px 4px #000000;
-}
-
-#player-settings h2{
-    font-size: 2rem;
-    font-weight: normal;
-    border-bottom: 1px solid #ffffff;
-    width: 100%;
-    margin-bottom: 0.5rem;
-    color: #ffe993;
-    text-transform: lowercase;
-    text-shadow: 1px 1px 2px #000000;
-}
-
-#player-settings h3, #player-settings h4, #player-settings h5, #player-settings h6{
-    color: #ffffff;
-    text-shadow: 1px 1px 1px rgba(0, 0, 0, 0.5);
-}
-
-#player-settings a{
-    color: #ffef00;
-}
-
-#player-settings input:not([type]){
-    border: 1px solid #000000;
-    padding: 3px;
-    border-radius: 3px;
-    min-width: 150px;
-}
-
-#player-settings input:not([type]):focus{
-    border: 1px solid #ffffff;
-}
-
-#player-settings select{
-    border: 1px solid #000000;
-    padding: 3px;
-    border-radius: 3px;
-    min-width: 150px;
-    background-color: #ffffff;
-}
-
-#player-settings #game-options, #player-settings #rom-options{
-    display: flex;
-    flex-direction: row;
-}
-
-#player-settings .left, #player-settings .right{
-    flex-grow: 1;
-}
-
-#player-settings table select{
-    width: 250px;
-}
-
-#player-settings table label{
-    display: block;
-    min-width: 200px;
-    margin-right: 4px;
-    cursor: default;
-}
-
-@media all and (max-width: 1000px), all and (orientation: portrait){
-    #player-settings #game-options, #player-settings #rom-options{
-        justify-content: flex-start;
-        flex-wrap: wrap;
-    }
-
-    #player-settings .left, #player-settings .right{
-        flex-grow: unset;
-    }
-
-    #game-options table label, #rom-options table label{
-        display: block;
-        min-width: 200px;
-    }
-}

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: 0px;
+    right: 0px;
+}
+
+#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/static/styles/ootTracker.css

@@ -0,0 +1,136 @@
+#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: 448px;
+    background-color: rgb(60, 114, 157);
+}
+
+#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: monospace;
+    font-weight: bold;
+    font-size: 1.1em;
+    bottom: 0px;
+    right: 8px;
+}
+
+#location-table{
+    width: 448px;
+    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: rgb(60, 114, 157);
+    padding: 0 3px 3px;
+    font-family: monospace;
+    font-size: 15px;
+    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: 15px;
+}
+
+#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: 13px;
+}
+
+#location-table td.location-name {
+    padding-left: 16px;
+}
+
+.hide {
+    display: none;
+}
+
+.right-align {
+    text-align: right;
+    font-weight: bold;
+}
+
+#location-table td:first-child {
+    width: 272px;
+}
+
+.location-category td:first-child {
+    padding-right: 16px;
+}
+
+#inventory-table img.acquired#lullaby{
+    filter: sepia(100%) hue-rotate(-60deg); /* css trick to hue-shift a static image */
+}
+
+#inventory-table img.acquired#epona{
+    filter: sepia(100%) hue-rotate(-20deg) saturate(250%);
+}
+
+#inventory-table img.acquired#saria{
+    filter: sepia(100%) hue-rotate(60deg) saturate(150%);
+}
+
+#inventory-table img.acquired#sun{
+    filter: sepia(100%) hue-rotate(15deg) saturate(200%) brightness(120%);
+}
+
+#inventory-table img.acquired#time{
+    filter: sepia(100%) hue-rotate(160deg) saturate(150%);
+}

WebHostLib/static/styles/player-settings.css

@@ -1,5 +1,5 @@
 html{
-    background-image: url('../../static/backgrounds/grass/grass-0007-large.png');
+    background-image: url('../static/backgrounds/grass/grass-0007-large.png');
     background-repeat: repeat;
     background-size: 650px 650px;
 }
@@ -101,8 +101,28 @@ html{
     flex-grow: 1;
 }
 
-#player-settings table select{
-    width: 250px;
+#player-settings table .select-container{
+    display: flex;
+    flex-direction: row;
+}
+
+#player-settings table .select-container select{
+    min-width: 200px;
+    flex-grow: 1;
+}
+
+#player-settings table .range-container{
+    display: flex;
+    flex-direction: row;
+}
+
+#player-settings table .range-container input[type=range]{
+    flex-grow: 1;
+}
+
+#player-settings table .range-value{
+    min-width: 20px;
+    margin-left: 0.25rem;
 }
 
 #player-settings table label{
@@ -113,7 +133,7 @@ html{
 }
 
 @media all and (max-width: 1000px), all and (orientation: portrait){
-    #player-settings #game-options, #player-settings #rom-options{
+    #player-settings #game-options{
         justify-content: flex-start;
         flex-wrap: wrap;
     }
@@ -122,7 +142,7 @@ html{
         flex-grow: unset;
     }
 
-    #game-options table label, #rom-options table label{
+    #game-options table label{
         display: block;
         min-width: 200px;
     }

WebHostLib/static/styles/startPlaying.css

@@ -0,0 +1,12 @@
+#start-playing-wrapper{
+    display: flex;
+    flex-direction: row;
+    justify-content: center;
+    flex-wrap: wrap;
+}
+
+#start-playing{
+    width: 700px;
+    min-height: 240px;
+    text-align: center;
+}

WebHostLib/static/styles/subnautica/subnautica.css

@@ -0,0 +1,3 @@
+#subnautica{
+    margin: 1rem;
+}

WebHostLib/static/styles/weightedSettings.css

@@ -1,162 +0,0 @@
-#weighted-settings{
-    width: 60rem;
-    margin-left: auto;
-    margin-right: auto;
-    background-color: rgba(0, 0, 0, 0.15);
-    border-radius: 8px;
-    padding: 1rem;
-    color: #eeffeb;
-}
-
-#user-warning, #weighted-settings #user-message{
-    display: none;
-    width: calc(100% - 8px);
-    background-color: #ffe86b;
-    border-radius: 4px;
-    color: #000000;
-    padding: 4px;
-    text-align: center;
-    cursor: pointer;
-}
-
-#weighted-settings #user-message.visible{
-    display: block;
-}
-
-#weighted-settings code{
-    background-color: #d9cd8e;
-    border-radius: 4px;
-    padding-left: 0.25rem;
-    padding-right: 0.25rem;
-    color: #000000;
-}
-
-#weighted-settings h1{
-    font-size: 2.5rem;
-    font-weight: normal;
-    border-bottom: 1px solid #ffffff;
-    width: 100%;
-    margin-bottom: 0.5rem;
-    color: #ffffff;
-    text-shadow: 1px 1px 4px #000000;
-}
-
-#weighted-settings h2{
-    font-size: 2rem;
-    font-weight: normal;
-    border-bottom: 1px solid #ffffff;
-    width: 100%;
-    margin-bottom: 0.5rem;
-    color: #ffe993;
-    text-transform: lowercase;
-    text-shadow: 1px 1px 2px #000000;
-}
-
-#weighted-settings h3, #weighted-settings h4, #weighted-settings h5, #weighted-settings h6{
-    color: #ffffff;
-    text-shadow: 1px 1px 1px rgba(0, 0, 0, 0.5);
-}
-
-#weighted-settings .instructions{
-    text-align: left;
-}
-
-#weighted-settings #settings-wrapper .setting-wrapper{
-    display: flex;
-    flex-direction: column;
-    justify-content: flex-start;
-    width: 100%;
-}
-
-#weighted-settings #settings-wrapper .setting-wrapper .title-span{
-    font-weight: 600;
-    font-size: 1.25rem;
-}
-
-#weighted-settings #settings-wrapper{
-    margin-top: 1.5rem;
-}
-
-#weighted-settings #settings-wrapper #sprite-picker{
-    margin-bottom: 2rem;
-}
-
-#weighted-settings #settings-wrapper #sprite-picker #sprite-picker-sprites{
-    display: flex;
-    flex-direction: row;
-    flex-wrap: wrap;
-    justify-content: flex-start;
-}
-
-#weighted-settings #settings-wrapper #sprite-picker .sprite-img-wrapper{
-    cursor: pointer;
-    margin: 10px;
-    image-rendering: pixelated;
-}
-
-/* Center tooltip text for sprite images */
-#weighted-settings #settings-wrapper #sprite-picker .sprite-img-wrapper::after{
-    text-align: center;
-}
-
-#weighted-settings #settings-wrapper #sprite-picker .sprite-img-wrapper img{
-    width: 32px;
-    height: 48px;
-}
-
-#weighted-settings table.option-set{
-    width: 100%;
-    margin-bottom: 1.5rem;
-}
-
-#weighted-settings table.option-set td.option-name{
-    width: 150px;
-    font-weight: 400;
-    font-size: 1rem;
-    line-height: 2rem;
-}
-
-#weighted-settings table.option-set td.option-name .delete-button{
-    cursor: pointer;
-}
-
-#weighted-settings table.option-set td.option-value{
-    line-height: 2rem;
-}
-
-#weighted-settings table.option-set td.option-value input[type=range]{
-    width: 90%;
-    min-width: 300px;
-    vertical-align: middle;
-}
-
-#weighted-settings #weighted-settings-button-row{
-    display: flex;
-    flex-direction: row;
-    justify-content: space-between;
-    width: 100%;
-}
-
-#weighted-settings a{
-    color: #ffef00;
-}
-
-#weighted-settings input:not([type]){
-    border: 1px solid #000000;
-    padding: 3px;
-    border-radius: 3px;
-    min-width: 150px;
-}
-
-#weighted-settings input:not([type]):focus{
-    border: 1px solid #ffffff;
-}
-
-#weighted-settings select{
-    border: 1px solid #000000;
-    padding: 3px;
-    border-radius: 3px;
-    min-width: 150px;
-    background-color: #ffffff;
-}
-

WebHostLib/static/styles/zelda3/player-settings.css

@@ -1,129 +0,0 @@
-html{
-    background-image: url('../../static/backgrounds/grass/grass-0007-large.png');
-    background-repeat: repeat;
-    background-size: 650px 650px;
-}
-
-#player-settings{
-    max-width: 1000px;
-    margin-left: auto;
-    margin-right: auto;
-    background-color: rgba(0, 0, 0, 0.15);
-    border-radius: 8px;
-    padding: 1rem;
-    color: #eeffeb;
-}
-
-#player-settings #player-settings-button-row{
-    display: flex;
-    flex-direction: row;
-    justify-content: space-between;
-    margin-top: 15px;
-}
-
-#player-settings code{
-    background-color: #d9cd8e;
-    border-radius: 4px;
-    padding-left: 0.25rem;
-    padding-right: 0.25rem;
-    color: #000000;
-}
-
-#player-settings #user-message{
-    display: none;
-    width: calc(100% - 8px);
-    background-color: #ffe86b;
-    border-radius: 4px;
-    color: #000000;
-    padding: 4px;
-    text-align: center;
-}
-
-#player-settings #user-message.visible{
-    display: block;
-}
-
-#player-settings h1{
-    font-size: 2.5rem;
-    font-weight: normal;
-    border-bottom: 1px solid #ffffff;
-    width: 100%;
-    margin-bottom: 0.5rem;
-    color: #ffffff;
-    text-shadow: 1px 1px 4px #000000;
-}
-
-#player-settings h2{
-    font-size: 2rem;
-    font-weight: normal;
-    border-bottom: 1px solid #ffffff;
-    width: 100%;
-    margin-bottom: 0.5rem;
-    color: #ffe993;
-    text-transform: lowercase;
-    text-shadow: 1px 1px 2px #000000;
-}
-
-#player-settings h3, #player-settings h4, #player-settings h5, #player-settings h6{
-    color: #ffffff;
-    text-shadow: 1px 1px 1px rgba(0, 0, 0, 0.5);
-}
-
-#player-settings a{
-    color: #ffef00;
-}
-
-#player-settings input:not([type]){
-    border: 1px solid #000000;
-    padding: 3px;
-    border-radius: 3px;
-    min-width: 150px;
-}
-
-#player-settings input:not([type]):focus{
-    border: 1px solid #ffffff;
-}
-
-#player-settings select{
-    border: 1px solid #000000;
-    padding: 3px;
-    border-radius: 3px;
-    min-width: 150px;
-    background-color: #ffffff;
-}
-
-#player-settings #game-options, #player-settings #rom-options{
-    display: flex;
-    flex-direction: row;
-}
-
-#player-settings .left, #player-settings .right{
-    flex-grow: 1;
-}
-
-#player-settings table select{
-    width: 250px;
-}
-
-#player-settings table label{
-    display: block;
-    min-width: 200px;
-    margin-right: 4px;
-    cursor: default;
-}
-
-@media all and (max-width: 1000px), all and (orientation: portrait){
-    #player-settings #game-options, #player-settings #rom-options{
-        justify-content: flex-start;
-        flex-wrap: wrap;
-    }
-
-    #player-settings .left, #player-settings .right{
-        flex-grow: unset;
-    }
-
-    #game-options table label, #rom-options table label{
-        display: block;
-        min-width: 200px;
-    }
-}

WebHostLib/templates/faq.html

@@ -0,0 +1,17 @@
+{% extends 'pageWrapper.html' %}
+
+{% block head %}
+    {% include 'header/grassHeader.html' %}
+    <title>Frequently Asked Questions</title>
+    <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/markdown.css") }}" />
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/showdown/1.9.1/showdown.min.js"
+            integrity="sha512-L03kznCrNOfVxOUovR6ESfCz9Gfny7gihUX/huVbQB9zjODtYpxaVtIaAkpetoiyV2eqWbvxMH9fiSv5enX7bw=="
+            crossorigin="anonymous"></script>
+    <script type="application/ecmascript" src="{{ url_for('static', filename="assets/faq.js") }}"></script>
+{% endblock %}
+
+{% block body %}
+    <div id="faq-wrapper" data-lang="{{ lang }}" class="markdown">
+        <!-- Content generated by JavaScript -->
+    </div>
+{%  endblock %}

WebHostLib/templates/gameInfo.html

@@ -0,0 +1,17 @@
+{% extends 'pageWrapper.html' %}
+
+{% block head %}
+    <title>{{ game }} Info</title>
+    <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/markdown.css") }}" />
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/showdown/1.9.1/showdown.min.js"
+            integrity="sha512-L03kznCrNOfVxOUovR6ESfCz9Gfny7gihUX/huVbQB9zjODtYpxaVtIaAkpetoiyV2eqWbvxMH9fiSv5enX7bw=="
+            crossorigin="anonymous"></script>
+    <script type="application/ecmascript" src="{{ url_for('static', filename="assets/gameInfo.js") }}"></script>
+{% endblock %}
+
+{% block body %}
+    {% include 'header/grassHeader.html' %}
+    <div id="game-info" class="markdown" data-lang="{{ lang }}" data-game="{{ game }}">
+        <!-- Populated my JS / MD -->
+    </div>
+{% endblock %}

WebHostLib/templates/games/A Link to the Past/A Link to the Past.html

@@ -1,15 +0,0 @@
-{% extends 'pageWrapper.html' %}
-
-{% block head %}
-    <title>A Link to the Past</title>
-    <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/zelda3/zelda3.css") }}" />
-    <script type="application/ecmascript" src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
-    <script type="application/ecmascript" src="{{ url_for('static', filename="assets/js-yaml.min.js") }}"></script>
-{% endblock %}
-
-{% block body %}
-    {% include 'header/grassHeader.html' %}
-    <div id="zelda3">
-        Coming Soon™
-    </div>
-{% endblock %}

WebHostLib/templates/games/Factorio/Factorio.html

@@ -1,15 +0,0 @@
-{% extends 'pageWrapper.html' %}
-
-{% block head %}
-    <title>Factorio</title>
-    <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/factorio/factorio.css") }}" />
-    <script type="application/ecmascript" src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
-    <script type="application/ecmascript" src="{{ url_for('static', filename="assets/js-yaml.min.js") }}"></script>
-{% endblock %}
-
-{% block body %}
-    {% include 'header/grassHeader.html' %}
-    <div id="factorio">
-        Coming Soon™
-    </div>
-{% endblock %}

WebHostLib/templates/games/Minecraft/Minecraft.html

@@ -1,15 +0,0 @@
-{% extends 'pageWrapper.html' %}
-
-{% block head %}
-    <title>Minecraft</title>
-    <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/minecraft/minecraft.css") }}" />
-    <script type="application/ecmascript" src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
-    <script type="application/ecmascript" src="{{ url_for('static', filename="assets/js-yaml.min.js") }}"></script>
-{% endblock %}
-
-{% block body %}
-    {% include 'header/grassHeader.html' %}
-    <div id="minecraft">
-        Coming Soon™
-    </div>
-{% endblock %}

WebHostLib/templates/generate.html

@@ -11,34 +11,67 @@
     {% include 'header/oceanHeader.html' %}
     <div id="generate-game-wrapper">
         <div id="generate-game" class="grass-island">
-            <h1>Upload Config{% if race %} (Race Mode){% endif %}</h1>
+            <h1>Generate Game{% if race %} (Race Mode){% endif %}</h1>
             <p>
-                This page allows you to generate a game by uploading a yaml file or a zip file containing yaml files.
-                If you do not have a config (yaml) file yet, you may create one on the
-                <a href="/player-settings">Player Settings</a> page. If you would like more advanced options,
-                the <a href="/weighted-settings">Weighted Settings</a> page might be what you're looking for.
+                This page allows you to generate a game by uploading a config file or a zip file containing config
+                files. If you do not have a config (.yaml) file yet, you may create one on the game's settings page,
+                which you can find via the <a href="{{ url_for("games") }}">supported games list</a>.
             </p>
             <p>
                 {% if race -%}
-                    This game will be generated in race mode, meaning the spoiler log will be unavailable,
-                    roms will be encrypted, and single-player games will have no multidata files.
+                    This game will be generated in race mode,
+                    meaning the spoiler log will be unavailable and game specific protections will be in place,
+                    like ROM encryption or cheat mode removal.
                 {%- else -%}
                     If you would like to generate a race game,
-                    <a href="{{ url_for("generate", race=True) }}">click here.</a> Race games are generated without
-                    a spoiler log, the ROMs are encrypted, and single-player games will not include a multidata file.
+                    <a href="{{ url_for("generate", race=True) }}">click here.</a><br />
+                    Race games are generated without a spoiler log and game specific protections will be in place,
+                    like ROM encryption or cheat mode removal.
                 {%- endif -%}
             </p>
-            <p>
-                After generation is complete, you will have the option to download a patch file.
-                This patch file can be opened with the
-                <a href="https://github.com/ArchipelagoMW/Archipelago/releases">client</a>, which can be
-                used to to create a rom file. In-browser patching is planned for the future.
-            </p>
             <div id="generate-game-form-wrapper">
                 <form id="generate-game-form" method="post" enctype="multipart/form-data">
-                    <input id="file-input" type="file" name="file">
+                    <table>
+                        <tbody>
+                            <tr>
+                                <td><label for="forfeit_mode">Forfeit Permission:</label></td>
+                                <td>
+                                    <select name="forfeit_mode" id="forfeit_mode">
+                                        <option value="auto">Automatic on goal completion</option>
+                                        <option value="goal">Allow !forfeit after goal completion</option>
+                                        <option value="auto-enabled">Automatic on goal completion and manual !forfeit</option>
+                                        <option value="enabled">Manual !forfeit</option>
+                                        <option value="disabled">Disabled</option>
+                                    </select>
+                                </td>
+                            </tr>
+
+                            <tr>
+                                <td>
+                                    <label for="hint_cost"> Hint Cost:</label>
+                                    <span
+                                        class="interactive"
+                                        data-tooltip="After gathering this many checks, players can !hint <itemname>
+                                            to get the location of that hint item.">(?)
+                                    </span>
+                                </td>
+                                <td>
+                                    <select name="hint_cost" id="hint_cost">
+                                        {% for n in range(0, 110, 5) %}
+                                            <option {% if n == 10 %}selected="selected" {% endif %} value="{{ n }}">
+                                                {% if n > 100 %}Off{% else %}{{ n }}%{% endif %}
+                                            </option>
+                                        {% endfor %}
+                                    </select>
+                                </td>
+                            </tr>
+                        </tbody>
+                    </table>
+                    <div id="generate-form-button-row">
+                        <input id="file-input" type="file" name="file">
+                    </div>
                 </form>
-                <button id="generate-game-button">Upload</button>
+                <button id="generate-game-button">Upload File</button>
             </div>
         </div>
     </div>

WebHostLib/templates/genericTracker.html

@@ -20,6 +20,7 @@
                         <tr>
                             <th>Item</th>
                             <th>Amount</th>
+                            <th>Order Received</th>
                         </tr>
                     </thead>
                     <tbody>
@@ -28,6 +29,7 @@
                     <tr>
                         <td>{{ name | item_name }}</td>
                         <td>{{ count }}</td>
+                        <td>{{received_items[name]}}</td>
                     </tr>
                     {%- endfor -%}
 

WebHostLib/templates/header/baseHeader.html

@@ -11,9 +11,11 @@
             <a href="/">archipelago</a>
         </div>
         <div id="base-header-right">
-            <a href="/games">games</a>
+            <a href="/games">supported games</a>
             <a href="/tutorial">setup guides</a>
-            <a href="https://discord.gg/8Z65BR2">discord</a>
+            <a href="/start-playing">start playing</a>
+            <a href="/faq/en">f.a.q.</a>
+            <a href="https://discord.gg/8Z65BR2" target="_blank">discord</a>
         </div>
     </header>
 {% endblock %}

WebHostLib/templates/hostGame.html

@@ -15,17 +15,17 @@
             <h1>Host Game</h1>
             <p>
                 This page allows you to host a game which was not generated by the website. For example, if you have
-                generated a doors game on your own computer, you may upload the zip file created by the generator to
-                host the game here. This will also provide the tracker, and the ability for your players to download
+                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.
                 <br /><br />
-                In addition to a zip file created by the generator, you may upload a multidata file here as well.
+                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">
                 <form id="host-game-form" method="post" enctype="multipart/form-data">
                     <input id="file-input" type="file" name="file">
                 </form>
-                <button id="host-game-button">Upload</button>
+                <button id="host-game-button">Upload File</button>
             </div>
         </div>
     </div>

WebHostLib/templates/landing.html

@@ -10,14 +10,14 @@
     <div id="landing-wrapper">
         <div id="landing-header">
             <h1>ARCHIPELAGO</h1>
-            <h4>multiworld randomizer ecosystem</h4>
+            <h4>multiworld multi-game randomizer</h4>
         </div>
         <div id="landing-links">
-            <a href="/games" id="mid-button">start<br />playing</a>
-            <a id="far-left-button"></a>
-            <a href="/tutorial" id="mid-left-button">setup guide</a>
-            <a href="/uploads" id="far-right-button">Host Game</a>
-            <a href="https://discord.gg/8Z65BR2" id="mid-right-button">discord</a>
+            <a href="/start-playing" id="mid-button">start<br />playing</a>
+            <a href="/games" id="far-left-button">supported<br />games</a>
+            <a href="/tutorial" id="mid-left-button">setup guides</a>
+            <a href="https://discord.gg/8Z65BR2" id="far-right-button" target="_blank">discord</a>
+            <a href="/faq/en/" id="mid-right-button">f.a.q.</a>
         </div>
         <div id="landing-clouds">
             <img id="cloud1" src="/static/static/backgrounds/clouds/cloud-0001.png"/>
@@ -50,7 +50,7 @@
                 </p>
                 <p>
                     <span class="variable">{{ seeds }}</span>
-                    games were created and
+                    games were generated and
                     <span class="variable">{{ rooms }}</span>
                     were hosted in the last 7 days.
                 </p>

WebHostLib/templates/macros.html

@@ -11,11 +11,14 @@
         <ul>
             {% for patch in room.seed.slots|list|sort(attribute="player_id") %}
                 {% if patch.game == "Minecraft" %}
-                <li><a href="{{ url_for("download_slot_file", seed_id=room.seed.id, player_id=patch.player_id) }}">
+                <li><a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}">
                     APMC for player {{ patch.player_id }} - {{ patch.player_name }}</a></li>
                 {% elif patch.game == "Factorio" %}
-                <li><a href="{{ url_for("download_slot_file", seed_id=room.seed.id, player_id=patch.player_id) }}">
+                <li><a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}">
                     Mod for player {{ patch.player_id }} - {{ patch.player_name }}</a></li>
+                {% elif patch.game == "Ocarina of Time" %}
+                <li><a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}">
+                    APZ5 for player {{ patch.player_id }} - {{ patch.player_name }}</a></li>
                 {% else %}
                 <li><a href="{{ url_for("download_patch", patch_id=patch.id, room_id=room.id) }}">
                     Patch for player {{ patch.player_id }} - {{ patch.player_name }}</a></li>

WebHostLib/templates/minecraftTracker.html

@@ -0,0 +1,66 @@
+<!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>
+    <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['Dragon Head'] }}" class="{{ 'acquired' if game_finished }}" title="Ender Dragon" /></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/templates/ootTracker.html

@@ -0,0 +1,180 @@
+<!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/ootTracker.css') }}"/>
+    <script type="application/ecmascript" src="{{ url_for('static', filename='assets/ootTracker.js') }}"></script>
+</head>
+
+<body>
+    <div id="player-tracker-wrapper" data-tracker="{{ room.tracker|suuid }}">
+        <table id="inventory-table">
+            <tr>
+                <td><img src="{{ ocarina_url }}" class="{{ 'acquired' if 'Ocarina' in acquired_items }}" title="Ocarina" /></td>
+                <td><img src="{{ icons['Bombs'] }}" class="{{ 'acquired' if 'Bomb Bag' in acquired_items }}" title="Bombs" /></td>
+                <td><img src="{{ icons['Bow'] }}" class="{{ 'acquired' if 'Bow' in acquired_items }}" title="Fairy Bow" /></td>
+                <td><img src="{{ icons['Fire Arrows'] }}" class="{{ 'acquired' if 'Fire Arrows' in acquired_items }}" title="Fire Arrows" /></td>
+                <td><img src="{{ icons['Kokiri Sword'] }}" class="{{ 'acquired' if 'Kokiri Sword' in acquired_items }}" title="Kokiri Sword" /></td>
+                <td><img src="{{ icons['Biggoron Sword'] }}" class="{{ 'acquired' if 'Biggoron Sword' in acquired_items }}" title="Biggoron's Sword" /></td>
+                <td><img src="{{ icons['Mirror Shield'] }}" class="{{ 'acquired' if 'Mirror Shield' in acquired_items }}" title="Mirror Shield" /></td>
+            </tr>
+            <tr>
+                <td><img src="{{ icons['Slingshot'] }}" class="{{ 'acquired' if 'Slingshot' in acquired_items }}" title="Slingshot" /></td>
+                <td><img src="{{ icons['Bombchus'] }}" class="{{ 'acquired' if has_bombchus }}" title="Bombchus" /></td>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ hookshot_url }}" class="{{ 'acquired' if 'Progressive Hookshot' in acquired_items }}" title="Progressive Hookshot" />
+                        <div class="item-count">{{ hookshot_length }}</div>
+                    </div>
+                </td>
+                <td><img src="{{ icons['Ice Arrows'] }}" class="{{ 'acquired' if 'Ice Arrows' in acquired_items }}" title="Ice Arrows" /></td>
+                <td><img src="{{ strength_upgrade_url }}" class="{{ 'acquired' if 'Progressive Strength Upgrade' in acquired_items }}" title="Progressive Strength Upgrade" /></td>
+                <td><img src="{{ icons['Goron Tunic'] }}" class="{{ 'acquired' if 'Goron Tunic' in acquired_items }}" title="Goron Tunic" /></td>
+                <td><img src="{{ icons['Zora Tunic'] }}" class="{{ 'acquired' if 'Zora Tunic' in acquired_items }}" title="Zora Tunic" /></td>
+            </tr>
+            <tr>
+                <td><img src="{{ icons['Boomerang'] }}" class="{{ 'acquired' if 'Boomerang' in acquired_items }}" title="Boomerang" /></td>
+                <td><img src="{{ icons['Lens of Truth'] }}" class="{{ 'acquired' if 'Lens of Truth' in acquired_items }}" title="Lens of Truth" /></td>
+                <td><img src="{{ icons['Megaton Hammer'] }}" class="{{ 'acquired' if 'Megaton Hammer' in acquired_items }}" title="Megaton Hammer" /></td>
+                <td><img src="{{ icons['Light Arrows'] }}" class="{{ 'acquired' if 'Light Arrows' in acquired_items }}" title="Light Arrows" /></td>
+                <td><img src="{{ scale_url }}" class="{{ 'acquired' if 'Progressive Scale' in acquired_items }}" title="Progressive Scale" /></td>
+                <td><img src="{{ icons['Iron Boots'] }}" class="{{ 'acquired' if 'Iron Boots' in acquired_items }}" title="Iron Boots" /></td>
+                <td><img src="{{ icons['Hover Boots'] }}" class="{{ 'acquired' if 'Hover Boots' in acquired_items }}" title="Hover Boots" /></td>
+            </tr>
+            <tr>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ bottle_url }}" class="{{ 'acquired' if bottle_count > 0 }}" title="Bottles" />
+                        <div class="item-count">{{ bottle_count if bottle_count > 0 else '' }}</div>
+                    </div>
+                </td>
+                <td><img src="{{ icons['Dins Fire'] }}" class="{{ 'acquired' if 'Dins Fire' in acquired_items }}" title="Din's Fire" /></td>
+                <td><img src="{{ icons['Farores Wind'] }}" class="{{ 'acquired' if 'Farores Wind' in acquired_items }}" title="Farore's Wind" /></td>
+                <td><img src="{{ icons['Nayrus Love'] }}" class="{{ 'acquired' if 'Nayrus Love' in acquired_items }}" title="Nayru's Love" /></td>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ wallet_url }}" class="{{ 'acquired' if 'Progressive Wallet' in acquired_items }}" title="Progressive Wallet" />
+                        <div class="item-count">{{ wallet_size }}</div>
+                    </div>
+                </td>
+                <td><img src="{{ magic_meter_url }}" class="{{ 'acquired' if 'Magic Meter' in acquired_items }}" title="Magic Meter" /></td>
+                <td><img src="{{ icons['Gerudo Membership Card'] }}" class="{{ 'acquired' if 'Gerudo Membership Card' in acquired_items }}" title="Gerudo Membership Card" /></td>
+            </tr>
+            <tr>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ icons['Zeldas Lullaby'] }}" class="{{ 'acquired' if 'Zeldas Lullaby' in acquired_items }}" title="Zelda's Lullaby" id="lullaby"/>
+                        <div class="item-count">Zelda</div>
+                    </div>
+                </td>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ icons['Eponas Song'] }}" class="{{ 'acquired' if 'Eponas Song' in acquired_items }}" title="Epona's Song" id="epona" />
+                        <div class="item-count">Epona</div>
+                    </div>
+                </td>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ icons['Sarias Song'] }}" class="{{ 'acquired' if 'Sarias Song' in acquired_items }}" title="Saria's Song" id="saria"/>
+                        <div class="item-count">Saria</div>
+                    </div>
+                </td>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ icons['Suns Song'] }}" class="{{ 'acquired' if 'Suns Song' in acquired_items }}" title="Sun's Song" id="sun"/>
+                        <div class="item-count">Sun</div>
+                    </div>
+                </td>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ icons['Song of Time'] }}" class="{{ 'acquired' if 'Song of Time' in acquired_items }}" title="Song of Time" id="time"/>
+                        <div class="item-count">Time</div>
+                    </div>
+                </td>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ icons['Song of Storms'] }}" class="{{ 'acquired' if 'Song of Storms' in acquired_items }}" title="Song of Storms" />
+                        <div class="item-count">Storms</div>
+                    </div>
+                </td>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ icons['Gold Skulltula Token'] }}" class="{{ 'acquired' if token_count > 0 }}" title="Gold Skulltula Tokens" />
+                        <div class="item-count">{{ token_count }}</div>
+                    </div>
+                </td>
+            </tr>
+            <tr>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ icons['Minuet of Forest'] }}" class="{{ 'acquired' if 'Minuet of Forest' in acquired_items }}" title="Minuet of Forest" />
+                        <div class="item-count">Min</div>
+                    </div>
+                </td>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ icons['Bolero of Fire'] }}" class="{{ 'acquired' if 'Bolero of Fire' in acquired_items }}" title="Bolero of Fire" />
+                        <div class="item-count">Bol</div>
+                    </div>
+                </td>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ icons['Serenade of Water'] }}" class="{{ 'acquired' if 'Serenade of Water' in acquired_items }}" title="Serenade of Water" />
+                        <div class="item-count">Ser</div>
+                    </div>
+                </td>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ icons['Requiem of Spirit'] }}" class="{{ 'acquired' if 'Requiem of Spirit' in acquired_items }}" title="Requiem of Spirit" />
+                        <div class="item-count">Req</div>
+                    </div>
+                </td>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ icons['Nocturne of Shadow'] }}" class="{{ 'acquired' if 'Nocturne of Shadow' in acquired_items }}" title="Nocturne of Shadow" />
+                        <div class="item-count">Noc</div>
+                    </div>
+                </td>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ icons['Prelude of Light'] }}" class="{{ 'acquired' if 'Prelude of Light' in acquired_items }}" title="Prelude of Light" />
+                        <div class="item-count">Pre</div>
+                    </div>
+                </td>
+                <td>
+                    <div class="counted-item">
+                        <img src="{{ icons['Triforce'] if game_finished else icons['Triforce Piece'] }}" class="{{ 'acquired' if game_finished or piece_count > 0 }}" title="{{ 'Triforce' if game_finished else 'Triforce Pieces' }}" id=triforce />
+                        <div class="item-count">{{ piece_count if piece_count > 0 else '' }}</div>
+                    </div>
+                </td>
+            </tr>
+        </table>
+        <table id="location-table">
+            <tr>
+                <td></td>
+                <td><img src="{{ icons['Small Key'] }}" title="Small Keys" /></td>
+                <td><img src="{{ icons['Boss Key'] }}" title="Boss Key" /></td>
+                <td class="right-align">Items</td>
+            </tr>
+            {% for area in checks_done %}
+            <tr class="location-category" id="{{area}}-header">
+                <td>{{ area }} {{'▼' if area != 'Total'}}</td>
+                <td class="smallkeys">{{ small_key_counts.get(area, '-') }}</td>
+                <td class="bosskeys">{{ boss_key_counts.get(area, '-') }}</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></td>
+                    <td></td>
+                    <td class="counter">{{ '✔' if location_info[area][location] else '' }}</td>
+                </tr>
+                {% endfor %}
+            </tbody>
+            {% endfor %}
+        </table>
+    </div>
+</body>
+</html>

WebHostLib/templates/options.yaml

@@ -18,7 +18,8 @@
 # http://www.yamllint.com/
 
 description: Default {{ game }} Template # Used to describe your yaml. Useful if you have multiple files
-name: YourName{number} # Your name in-game. Spaces will be replaced with underscores and there is a 16 character limit
+# Your name in-game. Spaces will be replaced with underscores and there is a 16 character limit
+name: YourName{number}
 #{player} will be replaced with the player's slot number.
 #{PLAYER} will be replaced with the player's slot number if that slot number is greater than 1.
 #{number} will be replaced with the counter value of the name.
@@ -35,37 +36,25 @@ accessibility:
 progression_balancing:
   on: 50 # A system to reduce BK, as in times during which you can't do anything by moving your items into an earlier access sphere to make it likely you have stuff to do
   off: 0 # Turn this off if you don't mind a longer multiworld, or can glitch/sequence break around missing items.
-  # The following 4 options can be uncommented and moved into a game's section they should affect
-  # start_inventory: # Begin the file with the listed items/upgrades
-  # Please only use items for the correct game, use triggers if need to be have seperated lists.
-  # Pegasus Boots: on
-  # Bomb Upgrade (+10): 4
-  # Arrow Upgrade (+10): 4
-# start_hints: # Begin the game with these items' locations revealed to you at the start of the game. Get the info via !hint in your client.
-#   - Moon Pearl
-# local_items: # Force certain items to appear in your world only, not across the multiworld. Recognizes some group names, like "Swords"
-#  - "Moon Pearl"
-#  - "Small Keys"
-#  - "Big Keys"
-# non_local_items: # Force certain items to appear outside your world only, unless in single-player. Recognizes some group names, like "Swords"
-#  - "Progressive Weapons"
-# exclude_locations: # Force certain locations to never contain progression items, and always be filled with junk.
-#  - "Master Sword Pedestal"
-{{ game }}:
-  {%- for option_name, option in options.items() %}
-  {{ option_name }}:{% if option.__doc__ %} # {{ option.__doc__ }}{% endif %}
-    {%- if option.range_start is defined  %}
+
+{%- macro range_option(option) %}
     # you can add additional values between minimum and maximum
-    {{ option.range_start }}: 0 # minimum value
-    {{ option.range_end }}: 0 # maximum value
-    random: 50
-    random-low: 0
-    random-high: 0
+    {%- set data, notes = dictify_range(option) %}
+    {%- for entry, default in data.items() %}
+    {{ entry }}: {{ default }}{% if notes[entry] %} # {{ notes[entry] }}{% endif %}
+    {%- endfor -%}
+{% endmacro %}
+{{ game }}:
+  {%- for option_key, option in options.items() %}
+  {{ option_key }}:{% if option.__doc__ %} # {{ option.__doc__ | replace('\n', '\n#') | indent(4, first=False) }}{% endif %}
+    {%- if option.range_start is defined and option.range_start is number %}
+    {{- range_option(option) -}}
     {%- elif option.options -%}
-    {%- for sub_option_name, suboption_option_id in option.options.items() %}
+    {%- for suboption_option_id, sub_option_name in option.name_lookup.items() %}
     {{ sub_option_name }}: {% if suboption_option_id == option.default %}50{% else %}0{% endif %}
     {%- endfor -%}
     {%- else %}
-    {{ yaml_dump(option.default) | indent(4, first=False) }}
+    {{ yaml_dump(default_converter(option.default)) | indent(4, first=False) }}
   {%- endif -%}
-  {%- endfor -%}
+  {%- endfor %}
+  {% if not options %}{}{% endif %}

WebHostLib/templates/player-settings.html

@@ -1,24 +1,28 @@
 {% extends 'pageWrapper.html' %}
 
 {% block head %}
-    <title>A Link to the Past Settings</title>
-    <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/zelda3/player-settings.css") }}" />
+    <title>{{ game }} Settings</title>
+    <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/player-settings.css") }}" />
     <script type="application/ecmascript" src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
+    <script type="application/ecmascript" src="{{ url_for('static', filename="assets/md5.min.js") }}"></script>
     <script type="application/ecmascript" src="{{ url_for('static', filename="assets/js-yaml.min.js") }}"></script>
     <script type="application/ecmascript" src="{{ url_for('static', filename="assets/player-settings.js") }}"></script>
 {% endblock %}
 
 {% block body %}
     {% include 'header/grassHeader.html' %}
-    <div id="player-settings">
+    <div id="player-settings" data-game="{{ game }}">
         <div id="user-message"></div>
         <h1><span id="game-name">Player</span> Settings</h1>
         <p>Choose the options you would like to play with! You may generate a single-player game from this page,
-            or download a settings file you can use to participate in a MultiWorld. If you would like to make
-            your settings extra random, check out the advanced <a href="/weighted-settings">weighted settings</a>
-            page.</p>
+            or download a settings file you can use to participate in a MultiWorld.</p>
 
-        <p>A list of all games you have generated can be found <a href="/user-content">here</a>.</p>
+        <p>
+            A list of all games you have generated can be found <a href="/user-content">here</a>.
+            <br />
+            Advanced users can download a template file for this game
+            <a href="/static/generated/configs/{{ game }}.yaml">here</a>.
+        </p>
 
         <p><label for="player-name">Please enter your player name. This will appear in-game as you send and receive
             items if you are playing in a MultiWorld.</label><br />

WebHostLib/templates/startPlaying.html

@@ -0,0 +1,32 @@
+{% extends 'pageWrapper.html' %}
+
+{% block head %}
+    {{ super() }}
+    <title>Start Playing</title>
+    <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/startPlaying.css") }}" />
+{% endblock %}
+
+{% block body %}
+    {% include 'header/oceanHeader.html' %}
+
+    <div id="start-playing-wrapper">
+        <div id="start-playing" class="grass-island {% if rooms %}wider{% endif %}">
+            <h1>Start Playing</h1>
+            <p>
+                If you're ready to start playing but don't know where to begin, check out the
+                <a href="/tutorial">tutorials</a> page. It has all the resources you need to create a config file
+                and get started. If you already have a config file, or a zip file containing them, read on.
+                <br /><br />
+
+                To start playing a game, you'll first need to <a href="/generate">generate a randomized game</a>.
+                You'll need to upload either a config file or a zip file containing one more more config files.
+                <br /><br />
+
+                If you have already generated a game and just need to host it, this site can<br />
+                <a href="uploads">host a pre-generated game</a> for you.
+            </p>
+        </div>
+    </div>
+
+    {% include 'islandFooter.html' %}
+{% endblock %}

WebHostLib/templates/supportedGames.html

@@ -9,9 +9,13 @@
     {% include 'header/grassHeader.html' %}
     <div id="games">
         <h1>Currently Supported Games</h1>
-        {% for game, (display_name, description) in games_list.items() %}
-        <h3><a href="{{ url_for("game_page", game=game) }}">{{ display_name}}</a></h3>
-        <p>{{ description}}</p>
+        {% for game, description in worlds.items() %}
+        <h3><a href="{{ url_for("game_info", game=game, lang="en") }}">{{ game }}</a></h3>
+        <p>
+            <a href="{{ url_for("player_settings", game=game) }}">Settings Page</a>
+            <br />
+            {{ description }}
+        </p>
         {% endfor %}
     </div>
 {% endblock %}

WebHostLib/templates/templates.html

@@ -0,0 +1,21 @@
+{% extends 'pageWrapper.html' %}
+
+{% block head %}
+    {% include 'header/grassHeader.html' %}
+    <title>Option Templates (YAML)</title>
+    <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/markdown.css") }}" />
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/showdown/1.9.1/showdown.min.js"
+            integrity="sha512-L03kznCrNOfVxOUovR6ESfCz9Gfny7gihUX/huVbQB9zjODtYpxaVtIaAkpetoiyV2eqWbvxMH9fiSv5enX7bw=="
+            crossorigin="anonymous"></script>
+{% endblock %}
+
+{% block body %}
+    <div class="markdown">
+    <h1>Option Templates (YAML)</h1>
+    <ul>
+        {% for file in files %}
+        <li><a href="{{ url_for('static', filename="generated/"+file+".yaml") }}">{{ file }}</a></li>
+        {% endfor %}
+    </ul>
+    </div>
+{%  endblock %}

WebHostLib/templates/tutorial.html

@@ -3,7 +3,7 @@
 {% block head %}
     {% include 'header/grassHeader.html' %}
     <title>Archipelago</title>
-    <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/tutorial.css") }}" />
+    <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/markdown.css") }}" />
     <script src="https://cdnjs.cloudflare.com/ajax/libs/showdown/1.9.1/showdown.min.js"
             integrity="sha512-L03kznCrNOfVxOUovR6ESfCz9Gfny7gihUX/huVbQB9zjODtYpxaVtIaAkpetoiyV2eqWbvxMH9fiSv5enX7bw=="
             crossorigin="anonymous"></script>
@@ -11,7 +11,7 @@
 {% endblock %}
 
 {% block body %}
-    <div id="tutorial-wrapper" data-game="{{ game }}" data-file="{{ file }}" data-lang="{{ lang }}">
+    <div id="tutorial-wrapper" class="markdown" data-game="{{ game }}" data-file="{{ file }}" data-lang="{{ lang }}">
         <!-- Content generated by JavaScript -->
     </div>
 {%  endblock %}

WebHostLib/templates/viewSeed.html

@@ -12,10 +12,6 @@
     <div id="view-seed-wrapper">
         <div id="view-seed" class="grass-island">
             <h1>Seed Info</h1>
-            {% if not seed.multidata and not seed.spoiler %}
-                <p>Single Player Race Rom: No spoiler or multidata exists, parts of the rom are encrypted and rooms
-                    cannot be created.</p>
-            {% endif %}
             <table>
                 <tbody>
                 <tr>
@@ -33,18 +29,6 @@
                     </tr>
                 {% endif %}
                 {% if seed.multidata %}
-                    <tr>
-                        <td>Players:&nbsp;</td>
-                        <td>
-                            <ul>
-                                {% for patch in seed.slots|sort(attribute='player_id') %}
-                                <li>
-                                    <a href="{{ url_for("download_raw_patch", seed_id=seed.id, player_id=patch.player_id) }}">{{ patch.player_name }}</a>
-                                </li>
-                                {% endfor %}
-                            </ul>
-                        </td>
-                    </tr>
                     <tr>
                         <td>Rooms:&nbsp;</td>
                     <td>

WebHostLib/templates/weightedSettings.html

@@ -1,77 +0,0 @@
-{% extends 'pageWrapper.html' %}
-
-{% block head %}
-    <title>Player Settings</title>
-    <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/weightedSettings.css") }}" />
-    <script type="application/ecmascript" src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
-    <script type="application/ecmascript" src="{{ url_for('static', filename="assets/js-yaml.min.js") }}"></script>
-    <script type="application/ecmascript" src="{{ url_for('static', filename="assets/weightedSettings.js") }}"></script>
-{% endblock %}
-
-{% block body %}
-    {% include 'header/grassHeader.html' %}
-    <div id="weighted-settings">
-        <header id="user-warning"></header>
-        <div id="user-message"></div>
-        <h1>Weighted Settings</h1>
-        <div id="instructions">
-            This page is used to configure your weighted settings. You have three presets you can control, which
-            you can access using the dropdown menu below. These settings will be usable when generating a
-            single player game, or you can export them to a <code>.yaml</code> file and use them in a multiworld.
-            If you already have a settings file you would like to validate, you may do so on the
-            <a href="/mysterycheck">verification page</a>.
-        </div>
-
-        <div id="settings-wrapper">
-            <div class="setting-wrapper">
-                Choose a preset and optionally assign it a nickname, which will be used as the file's description if
-                you download it.
-                <table class="option-set">
-                    <tbody>
-                        <tr>
-                            <td class="option-name">
-                                <label for="preset-number">Preset Number:</label>
-                            </td>
-                            <td class="option-value">
-                                <select id="preset-number">
-                                    <option value="1">Preset 1</option>
-                                    <option value="2">Preset 2</option>
-                                    <option value="3">Preset 3</option>
-                                </select>
-                            </td>
-                        </tr>
-                        <tr>
-                            <td class="option-name">
-                                <label for="description">Preset Name:</label>
-                            </td>
-                            <td class="option-value">
-                                <input id="description" class="setting" data-setting="description" />
-                            </td>
-                        </tr>
-                    </tbody>
-                </table>
-            </div>
-
-            Choose a name you want to represent you in-game. This will appear when you send items
-            to other people in multiworld games.
-            <table class="option-set">
-                <tbody>
-                    <tr>
-                        <td class="option-name">
-                            <label for="name">Player Name:</label>
-                        </td>
-                        <td class="option-value">
-                            <input id="name" maxlength="16" class="setting" data-setting="name" />
-                        </td>
-                    </tr>
-                </tbody>
-            </table>
-        </div>
-        <div id="weighted-settings-button-row">
-            <button id="reset-to-default">Reset to Defaults</button>
-            <button id="export-button">Export Settings</button>
-            <button id="generate-game">Generate Game</button>
-            <button id="generate-race">Generate Race</button>
-        </div>
-    </div>
-{%  endblock %}

WebHostLib/tracker.py

@@ -10,6 +10,7 @@ from WebHostLib import app, cache, Room
 from Utils import restricted_loads
 from worlds import lookup_any_item_id_to_name, lookup_any_location_id_to_name
 
+
 def get_alttp_id(item_name):
     return Items.item_table[item_name][2]
 
@@ -283,6 +284,7 @@ def render_timedelta(delta: datetime.timedelta):
 
 _multidata_cache = {}
 
+
 def get_location_table(checks_table: dict) -> dict:
     loc_to_area = {}
     for area, locations in checks_table.items():
@@ -292,6 +294,7 @@ def get_location_table(checks_table: dict) -> dict:
             loc_to_area[location] = area
     return loc_to_area
 
+
 def get_static_room_data(room: Room):
     result = _multidata_cache.get(room.seed.id, None)
     if result:
@@ -311,7 +314,7 @@ def get_static_room_data(room: Room):
         seed_checks_in_area["Total"] = 249
 
     player_checks_in_area = {playernumber: {areaname: len(multidata["checks_in_area"][playernumber][areaname])
-                                            if areaname != "Total" else multidata["checks_in_area"][playernumber]["Total"]
+    if areaname != "Total" else multidata["checks_in_area"][playernumber]["Total"]
                                             for areaname in ordered_areas}
                              for playernumber in range(1, len(names[0]) + 1)}
     player_location_to_area = {playernumber: get_location_table(multidata["checks_in_area"][playernumber])
@@ -373,9 +376,9 @@ def getPlayerTracker(tracker: UUID, tracked_team: int, tracked_player: int):
             for location in locations_checked:
                 if location in player_locations:
                     item, recipient = player_locations[location]
-                    if recipient == tracked_player: # a check done for the tracked player
+                    if recipient == tracked_player:  # a check done for the tracked player
                         attribute_item_solo(inventory, item)
-                    if ms_player == tracked_player: # a check done by the tracked player
+                    if ms_player == tracked_player:  # a check done by the tracked player
                         checks_done[location_to_area[location]] += 1
                         checks_done["Total"] += 1
     if games[tracked_player] == "A Link to the Past":
@@ -403,33 +406,316 @@ def getPlayerTracker(tracker: UUID, tracked_team: int, tracked_player: int):
         # Determine which icon to use
         display_data = {}
         for item_name, item_id in progressive_items.items():
-            level = min(inventory[item_id], len(progressive_names[item_name])-1)
+            level = min(inventory[item_id], len(progressive_names[item_name]) - 1)
             display_name = progressive_names[item_name][level]
             acquired = True
             if not display_name:
                 acquired = False
-                display_name = progressive_names[item_name][level+1]
+                display_name = progressive_names[item_name][level + 1]
             base_name = item_name.split(maxsplit=1)[1].lower()
-            display_data[base_name+"_acquired"] = acquired
-            display_data[base_name+"_url"] = icons[display_name]
-
+            display_data[base_name + "_acquired"] = acquired
+            display_data[base_name + "_url"] = icons[display_name]
 
         # The single player tracker doesn't care about overworld, underworld, and total checks. Maybe it should?
         sp_areas = ordered_areas[2:15]
 
         return render_template("lttpTracker.html", inventory=inventory,
                                player_name=player_name, room=room, icons=icons, checks_done=checks_done,
-                               checks_in_area=seed_checks_in_area[tracked_player], acquired_items={lookup_any_item_id_to_name[id] for id in inventory},
+                               checks_in_area=seed_checks_in_area[tracked_player],
+                               acquired_items={lookup_any_item_id_to_name[id] for id in inventory},
                                small_key_ids=small_key_ids, big_key_ids=big_key_ids, sp_areas=sp_areas,
                                key_locations=player_small_key_locations[tracked_player],
                                big_key_locations=player_big_key_locations[tracked_player],
                                **display_data)
+    elif games[tracked_player] == "Minecraft":
+        minecraft_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/f/fa/Brewing_Stand.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/d/dc/Red_Bed_JE4_BE3.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",
+            "Dragon Head": "https://static.wikia.nocookie.net/minecraft_gamepedia/images/b/b6/Dragon_Head.png",
+        }
+
+        minecraft_location_ids = {
+            "Story": [42073, 42080, 42081, 42023, 42082, 42027, 42039, 42085, 42002, 42009, 42010,
+                      42070, 42041, 42049, 42090, 42004, 42031, 42025, 42029, 42051, 42077, 42089],
+            "Nether": [42017, 42044, 42069, 42058, 42034, 42060, 42066, 42076, 42064, 42071, 42021,
+                       42062, 42008, 42061, 42033, 42011, 42006, 42019, 42000, 42040, 42001, 42015, 42014],
+            "The End": [42052, 42005, 42012, 42032, 42030, 42042, 42018, 42038, 42046],
+            "Adventure": [42047, 42086, 42087, 42050, 42059, 42055, 42072, 42003, 42035, 42016, 42020,
+                          42048, 42054, 42068, 42043, 42074, 42075, 42024, 42026, 42037, 42045, 42056, 42088],
+            "Husbandry": [42065, 42067, 42078, 42022, 42007, 42079, 42013, 42028,
+                          42036, 42057, 42063, 42053, 42083, 42084, 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"]
+        }
+        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"] = minecraft_icons[display_name]
+
+        # Multi-items
+        multi_items = {
+            "3 Ender Pearls": 45029,
+            "8 Netherite Scrap": 45015
+        }
+        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 = multisave.get("client_game_state", {}).get((tracked_team, tracked_player), 0)
+        display_data['game_finished'] = game_state == 30
+
+        # Turn location IDs into advancement tab counts
+        checked_locations = multisave.get("location_checks", {}).get((tracked_team, tracked_player), set())
+        lookup_name = lambda id: lookup_any_location_id_to_name[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())
+
+        return render_template("minecraftTracker.html",
+                               inventory=inventory, icons=minecraft_icons,
+                               acquired_items={lookup_any_item_id_to_name[id] for id in inventory if
+                                               id in lookup_any_item_id_to_name},
+                               player=tracked_player, team=tracked_team, room=room, player_name=player_name,
+                               checks_done=checks_done, checks_in_area=checks_in_area, location_info=location_info,
+                               **display_data)
+
+    elif games[tracked_player] == "Ocarina of Time":
+        oot_icons = {
+            "Fairy Ocarina":            "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/9/97/OoT_Fairy_Ocarina_Icon.png",
+            "Ocarina of Time":          "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/4/4e/OoT_Ocarina_of_Time_Icon.png",
+            "Slingshot":                "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/3/32/OoT_Fairy_Slingshot_Icon.png",
+            "Boomerang":                "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/d/d5/OoT_Boomerang_Icon.png",
+            "Bottle":                   "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/f/fc/OoT_Bottle_Icon.png",
+            "Rutos Letter":             "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/2/21/OoT_Letter_Icon.png",
+            "Bombs":                    "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/1/11/OoT_Bomb_Icon.png",
+            "Bombchus":                 "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/3/36/OoT_Bombchu_Icon.png",
+            "Lens of Truth":            "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/0/05/OoT_Lens_of_Truth_Icon.png",
+            "Bow":                      "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/9/9a/OoT_Fairy_Bow_Icon.png",
+            "Hookshot":                 "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/7/77/OoT_Hookshot_Icon.png",
+            "Longshot":                 "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/a/a4/OoT_Longshot_Icon.png",
+            "Megaton Hammer":           "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/9/93/OoT_Megaton_Hammer_Icon.png",
+            "Fire Arrows":              "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/1/1e/OoT_Fire_Arrow_Icon.png",
+            "Ice Arrows":               "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/3/3c/OoT_Ice_Arrow_Icon.png",
+            "Light Arrows":             "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/7/76/OoT_Light_Arrow_Icon.png",
+            "Dins Fire":                r"https://static.wikia.nocookie.net/zelda_gamepedia_en/images/d/da/OoT_Din%27s_Fire_Icon.png",
+            "Farores Wind":             r"https://static.wikia.nocookie.net/zelda_gamepedia_en/images/7/7a/OoT_Farore%27s_Wind_Icon.png",
+            "Nayrus Love":              r"https://static.wikia.nocookie.net/zelda_gamepedia_en/images/b/be/OoT_Nayru%27s_Love_Icon.png",
+            "Kokiri Sword":             "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/5/53/OoT_Kokiri_Sword_Icon.png",
+            "Biggoron Sword":           r"https://static.wikia.nocookie.net/zelda_gamepedia_en/images/2/2e/OoT_Giant%27s_Knife_Icon.png",
+            "Mirror Shield":            "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/b/b0/OoT_Mirror_Shield_Icon_2.png",
+            "Goron Bracelet":           r"https://static.wikia.nocookie.net/zelda_gamepedia_en/images/b/b7/OoT_Goron%27s_Bracelet_Icon.png",
+            "Silver Gauntlets":         "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/b/b9/OoT_Silver_Gauntlets_Icon.png",
+            "Golden Gauntlets":         "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/6/6a/OoT_Golden_Gauntlets_Icon.png",
+            "Goron Tunic":              "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/1/1c/OoT_Goron_Tunic_Icon.png",
+            "Zora Tunic":               "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/2/2c/OoT_Zora_Tunic_Icon.png",
+            "Silver Scale":             "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/4/4e/OoT_Silver_Scale_Icon.png",
+            "Gold Scale":               "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/9/95/OoT_Golden_Scale_Icon.png",
+            "Iron Boots":               "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/3/34/OoT_Iron_Boots_Icon.png",
+            "Hover Boots":              "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/2/22/OoT_Hover_Boots_Icon.png",
+            "Adults Wallet":            r"https://static.wikia.nocookie.net/zelda_gamepedia_en/images/f/f9/OoT_Adult%27s_Wallet_Icon.png",
+            "Giants Wallet":            r"https://static.wikia.nocookie.net/zelda_gamepedia_en/images/8/87/OoT_Giant%27s_Wallet_Icon.png",
+            "Small Magic":              "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/9/9f/OoT3D_Magic_Jar_Icon.png",
+            "Large Magic":              "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/3/3e/OoT3D_Large_Magic_Jar_Icon.png",
+            "Gerudo Membership Card":   "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/4/4e/OoT_Gerudo_Token_Icon.png",
+            "Gold Skulltula Token":     "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/4/47/OoT_Token_Icon.png",
+            "Triforce Piece":           "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/0/0b/SS_Triforce_Piece_Icon.png",
+            "Triforce":                 "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/6/68/ALttP_Triforce_Title_Sprite.png",
+            "Zeldas Lullaby":           "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/2/21/Grey_Note.png",
+            "Eponas Song":              "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/2/21/Grey_Note.png",
+            "Sarias Song":              "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/2/21/Grey_Note.png",
+            "Suns Song":                "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/2/21/Grey_Note.png",
+            "Song of Time":             "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/2/21/Grey_Note.png",
+            "Song of Storms":           "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/2/21/Grey_Note.png",
+            "Minuet of Forest":         "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/e/e4/Green_Note.png",
+            "Bolero of Fire":           "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/f/f0/Red_Note.png",
+            "Serenade of Water":        "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/0/0f/Blue_Note.png",
+            "Requiem of Spirit":        "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/a/a4/Orange_Note.png",
+            "Nocturne of Shadow":       "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/9/97/Purple_Note.png",
+            "Prelude of Light":         "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/9/90/Yellow_Note.png",
+            "Small Key":                "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/e/e5/OoT_Small_Key_Icon.png",
+            "Boss Key":                 "https://static.wikia.nocookie.net/zelda_gamepedia_en/images/4/40/OoT_Boss_Key_Icon.png",
+        }
+
+        display_data = {}
+
+        # Determine display for progressive items
+        progressive_items = {
+            "Progressive Hookshot": 66128,
+            "Progressive Strength Upgrade": 66129,
+            "Progressive Wallet": 66133,
+            "Progressive Scale": 66134,
+            "Magic Meter": 66138,
+            "Ocarina": 66139,
+        }
+        progressive_names = {
+            "Progressive Hookshot": ["Hookshot", "Hookshot", "Longshot"],
+            "Progressive Strength Upgrade": ["Goron Bracelet", "Goron Bracelet", "Silver Gauntlets", "Golden Gauntlets"],
+            "Progressive Wallet": ["Adults Wallet", "Adults Wallet", "Giants Wallet", "Giants Wallet"],
+            "Progressive Scale": ["Silver Scale", "Silver Scale", "Gold Scale"],
+            "Magic Meter": ["Small Magic", "Small Magic", "Large Magic"],
+            "Ocarina": ["Fairy Ocarina", "Fairy Ocarina", "Ocarina of Time"]
+        }
+        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]
+            if item_name.startswith("Progressive"):
+                base_name = item_name.split(maxsplit=1)[1].lower().replace(' ', '_')
+            else:
+                base_name = item_name.lower().replace(' ', '_')
+            display_data[base_name+"_url"] = oot_icons[display_name]
+
+            if base_name == "hookshot":
+                display_data['hookshot_length'] = {0: '', 1: 'H', 2: 'L'}.get(level)
+            if base_name == "wallet": 
+                display_data['wallet_size'] = {0: '99', 1: '200', 2: '500', 3: '999'}.get(level)
+
+        # Determine display for bottles. Show letter if it's obtained, determine bottle count
+        bottle_ids = [66015, 66020, 66021, 66140, 66141, 66142, 66143, 66144, 66145, 66146, 66147, 66148]
+        display_data['bottle_count'] = min(sum(map(lambda item_id: inventory[item_id], bottle_ids)), 4)
+        display_data['bottle_url'] = oot_icons['Rutos Letter'] if inventory[66021] > 0 else oot_icons['Bottle']
+
+        # Determine bombchu display
+        display_data['has_bombchus'] = any(map(lambda item_id: inventory[item_id] > 0, [66003, 66106, 66107, 66137]))
+
+        # Multi-items
+        multi_items = {
+            "Gold Skulltula Token": 66091,
+            "Triforce Piece": 66202,
+        }
+        for item_name, item_id in multi_items.items():
+            base_name = item_name.split()[-1].lower()
+            count = inventory[item_id]
+            display_data[base_name+"_count"] = inventory[item_id]
+
+        # Gather dungeon locations
+        area_id_ranges = {
+            "Overworld":                (67000, 67280),
+            "Deku Tree":                (67281, 67303),
+            "Dodongo's Cavern":         (67304, 67334),
+            "Jabu Jabu's Belly":        (67335, 67359),
+            "Bottom of the Well":       (67360, 67384),
+            "Forest Temple":            (67385, 67420),
+            "Fire Temple":              (67421, 67457),
+            "Water Temple":             (67458, 67484),
+            "Shadow Temple":            (67485, 67532),
+            "Spirit Temple":            (67533, 67582),
+            "Ice Cavern":               (67583, 67596),
+            "Gerudo Training Grounds":  (67597, 67635),
+            "Ganon's Castle":           (67636, 67673),
+        }
+        def lookup_and_trim(id, area):
+            full_name = lookup_any_location_id_to_name[id]
+            if id == 67673:
+                return full_name[13:] # Ganons Tower Boss Key Chest
+            if area != 'Overworld':
+                return full_name[len(area):] # trim dungeon name. leaves an extra space that doesn't display, or trims fully for DC/Jabu/GC
+            return full_name
+
+        checked_locations = multisave.get("location_checks", {}).get((tracked_team, tracked_player), set()).intersection(set(locations[tracked_player]))
+        location_info = {area: {lookup_and_trim(id, area): id in checked_locations for id in range(min_id, max_id+1) if id in locations[tracked_player]} 
+            for area, (min_id, max_id) in area_id_ranges.items()}
+        checks_done = {area: len(list(filter(lambda x: x, location_info[area].values()))) for area in area_id_ranges}
+        checks_in_area = {area: len([id for id in range(min_id, max_id+1) if id in locations[tracked_player]]) 
+            for area, (min_id, max_id) in area_id_ranges.items()}
+        checks_done['Total'] = sum(checks_done.values())
+        checks_in_area['Total'] = sum(checks_in_area.values())
+
+        # Give skulltulas on non-tracked locations
+        non_tracked_locations = multisave.get("location_checks", {}).get((tracked_team, tracked_player), set()).difference(set(locations[tracked_player]))
+        for id in non_tracked_locations:
+            if "GS" in lookup_and_trim(id, ''):
+                display_data["token_count"] += 1
+
+        # Gather small and boss key info
+        small_key_counts = {
+            "Forest Temple":            inventory[66175],
+            "Fire Temple":              inventory[66176],
+            "Water Temple":             inventory[66177],
+            "Spirit Temple":            inventory[66178],
+            "Shadow Temple":            inventory[66179],
+            "Bottom of the Well":       inventory[66180],
+            "Gerudo Training Grounds":  inventory[66181],
+            "Ganon's Castle":           inventory[66183],
+        }
+        boss_key_counts = {
+            "Forest Temple":            '✔' if inventory[66149] else '✕',
+            "Fire Temple":              '✔' if inventory[66150] else '✕',
+            "Water Temple":             '✔' if inventory[66151] else '✕',
+            "Spirit Temple":            '✔' if inventory[66152] else '✕',
+            "Shadow Temple":            '✔' if inventory[66153] else '✕',
+            "Ganon's Castle":           '✔' if inventory[66154] else '✕',
+        }
+
+        # Victory condition
+        game_state = multisave.get("client_game_state", {}).get((tracked_team, tracked_player), 0)
+        display_data['game_finished'] = game_state == 30
+
+        return render_template("ootTracker.html",
+                               inventory=inventory, player=tracked_player, team=tracked_team, room=room, player_name=player_name,
+                               icons=oot_icons, acquired_items={lookup_any_item_id_to_name[id] for id in inventory},
+                               checks_done=checks_done, checks_in_area=checks_in_area, location_info=location_info,
+                               small_key_counts=small_key_counts, boss_key_counts=boss_key_counts,
+                               **display_data)
+
     else:
         checked_locations = multisave.get("location_checks", {}).get((tracked_team, tracked_player), set())
+        player_received_items = {}
+        for order_index, networkItem in enumerate(
+                multisave.get('received_items', {}).get((tracked_team, tracked_player), []),
+                start=1
+        ):
+            player_received_items[networkItem.item] = order_index
         return render_template("genericTracker.html",
                                inventory=inventory,
                                player=tracked_player, team=tracked_team, room=room, player_name=player_name,
-                               checked_locations= checked_locations, not_checked_locations = set(locations[tracked_player])-checked_locations)
+                               checked_locations=checked_locations,
+                               not_checked_locations=set(locations[tracked_player]) - checked_locations,
+                               received_items=player_received_items)
 
 
 @app.route('/tracker/<suuid:tracker>')
@@ -507,4 +793,4 @@ def getTracker(tracker: UUID):
                            checks_in_area=seed_checks_in_area, activity_timers=activity_timers,
                            key_locations=group_key_locations, small_key_ids=small_key_ids, big_key_ids=big_key_ids,
                            video=video, big_key_locations=group_big_key_locations,
-                           hints=hints, long_player_names = long_player_names)
+                           hints=hints, long_player_names=long_player_names)

WebHostLib/upload.py

@@ -3,6 +3,7 @@ import lzma
 import json
 import base64
 import MultiServer
+import uuid
 
 from flask import request, flash, redirect, url_for, session, render_template
 from pony.orm import flush, select
@@ -17,6 +18,68 @@ accepted_zip_contents = {"patches": ".apbp",
 banned_zip_contents = (".sfc",)
 
 
+def upload_zip_to_db(zfile: zipfile.ZipFile, owner=None, meta={"race": False}, sid=None):
+    if not owner:
+        owner = session["_id"]
+    infolist = zfile.infolist()
+    slots = set()
+    spoiler = ""
+    multidata = None
+    for file in infolist:
+        if file.filename.endswith(banned_zip_contents):
+            return "Uploaded data contained a rom file, which is likely to contain copyrighted material. " \
+                   "Your file was deleted."
+        elif file.filename.endswith(".apbp"):
+            data = zfile.open(file, "r").read()
+            yaml_data = parse_yaml(lzma.decompress(data).decode("utf-8-sig"))
+            if yaml_data["version"] < 2:
+                return "Old format cannot be uploaded (outdated .apbp)", 500
+            metadata = yaml_data["meta"]
+            slots.add(Slot(data=data, player_name=metadata["player_name"],
+                           player_id=metadata["player_id"],
+                           game="A Link to the Past"))
+
+        elif file.filename.endswith(".apmc"):
+            data = zfile.open(file, "r").read()
+            metadata = json.loads(base64.b64decode(data).decode("utf-8"))
+            slots.add(Slot(data=data, player_name=metadata["player_name"],
+                           player_id=metadata["player_id"],
+                           game="Minecraft"))
+
+        elif file.filename.endswith(".zip"):
+            # Factorio mods need a specific name or they do not function
+            _, seed_name, slot_id, slot_name = file.filename.rsplit("_", 1)[0].split("-")
+            slots.add(Slot(data=zfile.open(file, "r").read(), player_name=slot_name,
+                           player_id=int(slot_id[1:]), game="Factorio"))
+
+        elif file.filename.endswith(".apz5"):
+            # .apz5 must be named specifically since they don't contain any metadata
+            _, seed_name, slot_id, slot_name = file.filename.split('.')[0].split('_', 3)
+            slots.add(Slot(data=zfile.open(file, "r").read(), player_name=slot_name,
+                           player_id=int(slot_id[1:]), game="Ocarina of Time"))
+
+        elif file.filename.endswith(".txt"):
+            spoiler = zfile.open(file, "r").read().decode("utf-8-sig")
+        elif file.filename.endswith(".archipelago"):
+            try:
+                multidata = zfile.open(file).read()
+                MultiServer.Context._decompress(multidata)
+            except:
+                flash("Could not load multidata. File may be corrupted or incompatible.")
+            else:
+                multidata = zfile.open(file).read()
+    if multidata:
+        flush()  # commit slots
+        seed = Seed(multidata=multidata, spoiler=spoiler, slots=slots, owner=owner, meta=json.dumps(meta),
+                    id=sid if sid else uuid.uuid4())
+        flush()  # create seed
+        for slot in slots:
+            slot.seed = seed
+        return seed
+    else:
+        flash("No multidata was found in the zip file, which is required.")
+
+
 @app.route('/uploads', methods=['GET', 'POST'])
 def uploads():
     if request.method == 'POST':
@@ -31,58 +94,12 @@ def uploads():
                 flash('No selected file')
             elif file and allowed_file(file.filename):
                 if file.filename.endswith(".zip"):
-                    slots = set()
-                    spoiler = ""
-                    multidata = None
                     with zipfile.ZipFile(file, 'r') as zfile:
-                        infolist = zfile.infolist()
-
-                        for file in infolist:
-                            if file.filename.endswith(banned_zip_contents):
-                                return "Uploaded data contained a rom file, which is likely to contain copyrighted material. Your file was deleted."
-                            elif file.filename.endswith(".apbp"):
-                                data = zfile.open(file, "r").read()
-                                yaml_data = parse_yaml(lzma.decompress(data).decode("utf-8-sig"))
-                                if yaml_data["version"] < 2:
-                                    return "Old format cannot be uploaded (outdated .apbp)", 500
-                                metadata = yaml_data["meta"]
-                                slots.add(Slot(data=data, player_name=metadata["player_name"],
-                                               player_id=metadata["player_id"],
-                                               game="A Link to the Past"))
-
-                            elif file.filename.endswith(".apmc"):
-                                data = zfile.open(file, "r").read()
-                                metadata = json.loads(base64.b64decode(data).decode("utf-8"))
-                                slots.add(Slot(data=data, player_name=metadata["player_name"],
-                                               player_id=metadata["player_id"],
-                                               game="Minecraft"))
-
-                            elif file.filename.endswith(".zip"):
-                                # Factorio mods needs a specific name or they do no function
-                                _, seed_name, slot_id, slot_name = file.filename.rsplit("_", 1)[0].split("-")
-                                slots.add(Slot(data=zfile.open(file, "r").read(), player_name=slot_name,
-                                              player_id=int(slot_id[1:]), game="Factorio"))
-
-                            elif file.filename.endswith(".txt"):
-                                spoiler = zfile.open(file, "r").read().decode("utf-8-sig")
-                            elif file.filename.endswith(".archipelago"):
-                                try:
-                                    multidata = zfile.open(file).read()
-                                    MultiServer.Context._decompress(multidata)
-                                except:
-                                    flash("Could not load multidata. File may be corrupted or incompatible.")
-                                else:
-                                    multidata = zfile.open(file).read()
-                        if multidata:
-                            flush()  # commit slots
-                            seed = Seed(multidata=multidata, spoiler=spoiler, slots=slots, owner=session["_id"])
-                            flush()  # create seed
-                            for slot in slots:
-                                slot.seed = seed
-
-                            return redirect(url_for("viewSeed", seed=seed.id))
-                        else:
-                            flash("No multidata was found in the zip file, which is required.")
+                        res = upload_zip_to_db(zfile)
+                        if type(res) == str:
+                            return res
+                        elif res:
+                            return redirect(url_for("viewSeed", seed=res.id))
                 else:
                     try:
                         multidata = file.read()

data/client.kv

@@ -11,6 +11,7 @@
     size_hint_y: None
     height: self.texture_size[1]
     font_size: dp(20)
+    markup: True
 <UILog>:
     viewclass: 'Row'
     scroll_y: 0

data/factorio/mod_template/control.lua

@@ -1,269 +0,0 @@
-{% from "macros.lua" import dict_to_lua %}
--- this file gets written automatically by the Archipelago Randomizer and is in its raw form a Jinja2 Template
-require "lib"
-require "util"
-
-FREE_SAMPLES = {{ free_samples }}
-SLOT_NAME = "{{ slot_name }}"
-SEED_NAME = "{{ seed_name }}"
-FREE_SAMPLE_BLACKLIST = {{ dict_to_lua(free_sample_blacklist) }}
-
-{% if not imported_blueprints -%}
-function set_permissions()
-    local group = game.permissions.get_group("Default")
-    group.set_allows_action(defines.input_action.open_blueprint_library_gui, false)
-    group.set_allows_action(defines.input_action.import_blueprint, false)
-    group.set_allows_action(defines.input_action.import_blueprint_string, false)
-    group.set_allows_action(defines.input_action.import_blueprints_filtered, false)
-end
-{%- endif %}
-
--- Initialize force data, either from it being created or already being part of the game when the mod was added.
-function on_force_created(event)
-    --event.force appears to be LuaForce.name, not LuaForce
-    game.forces[event.force].research_queue_enabled = true
-    local data = {}
-    data['earned_samples'] = {{ dict_to_lua(starting_items) }}
-    data["victory"] = 0
-    global.forcedata[event.force] = data
-end
-script.on_event(defines.events.on_force_created, on_force_created)
-
--- Destroy force data.  This doesn't appear to be currently possible with the Factorio API, but here for completeness.
-function on_force_destroyed(event)
-    global.forcedata[event.force.name] = nil
-end
-
--- Initialize player data, either from them joining the game or them already being part of the game when the mod was
--- added.`
-function on_player_created(event)
-    local player = game.players[event.player_index]
-    -- FIXME: This (probably) fires before any other mod has a chance to change the player's force
-    -- For now, they will (probably) always be on the 'player' force when this event fires.
-    local data = {}
-    data['pending_samples'] = table.deepcopy(global.forcedata[player.force.name]['earned_samples'])
-    global.playerdata[player.index] = data
-    update_player(player.index)  -- Attempt to send pending free samples, if relevant.
-end
-script.on_event(defines.events.on_player_created, on_player_created)
-
-function on_player_removed(event)
-    global.playerdata[event.player_index] = nil
-end
-script.on_event(defines.events.on_player_removed, on_player_removed)
-
-function on_rocket_launched(event)
-    global.forcedata[event.rocket.force.name]['victory'] = 1
-    dumpInfo(event.rocket.force)
-end
-script.on_event(defines.events.on_rocket_launched, on_rocket_launched)
-
--- Updates a player, attempting to send them any pending samples (if relevant)
-function update_player(index)
-    local player = game.players[index]
-    if not player or not player.valid then     -- Do nothing if we reference an invalid player somehow
-        return
-    end
-    local character = player.character or player.cutscene_character
-    if not character or not character.valid then
-        return
-    end
-    local data = global.playerdata[index]
-    local samples = data['pending_samples']
-    local sent
-    --player.print(serpent.block(data['pending_samples']))
-    local stack = {}
-
-    for name, count in pairs(samples) do
-        stack.name = name
-        stack.count = count
-        if character.can_insert(stack) then
-            sent = character.insert(stack)
-        else
-            sent = 0
-        end
-        if sent > 0 then
-            player.print("Received " .. sent .. "x [item=" .. name .. "]")
-            data.suppress_full_inventory_message = false
-        end
-        if sent ~= count then               -- Couldn't full send.
-            if not data.suppress_full_inventory_message then
-                player.print("Additional items will be sent when inventory space is available.", {r=1, g=1, b=0.25})
-            end
-            data.suppress_full_inventory_message = true -- Avoid spamming them with repeated full inventory messages.
-            samples[name] = count - sent    -- Buffer the remaining items
-            break                           -- Stop trying to send other things
-        else
-            samples[name] = nil             -- Remove from the list
-        end
-    end
-
-end
-
--- Update players upon them connecting, since updates while they're offline are suppressed.
-script.on_event(defines.events.on_player_joined_game, function(event) update_player(event.player_index) end)
-
-function update_player_event(event)
-    update_player(event.player_index)
-end
-
-script.on_event(defines.events.on_player_main_inventory_changed, update_player_event)
-
-function add_samples(force, name, count)
-    local function add_to_table(t)
-        t[name] = (t[name] or 0) + count
-    end
-    -- Add to global table of earned samples for future new players
-    add_to_table(global.forcedata[force.name]['earned_samples'])
-    -- Add to existing players
-    for _, player in pairs(force.players) do
-        add_to_table(global.playerdata[player.index]['pending_samples'])
-        update_player(player.index)
-    end
-end
-
-script.on_init(function()
-    {% if not imported_blueprints %}set_permissions(){% endif %}
-    global.forcedata = {}
-    global.playerdata = {}
-    -- Fire dummy events for all currently existing forces.
-    local e = {}
-    for name, _ in pairs(game.forces) do
-        e.force = name
-        on_force_created(e)
-    end
-    e.force = nil
-
-    -- Fire dummy events for all currently existing players.
-    for index, _ in pairs(game.players) do
-        e.player_index = index
-        on_player_created(e)
-    end
-end)
-
--- hook into researches done
-script.on_event(defines.events.on_research_finished, function(event)
-    local technology = event.research
-    if technology.researched and string.find(technology.name, "ap%-") == 1 then
-        dumpInfo(technology.force) --is sendable
-    else
-        if FREE_SAMPLES == 0 then
-            return  -- Nothing else to do
-        end
-        if not technology.effects then
-            return  -- No technology effects, so nothing to do.
-        end
-        for _, effect in pairs(technology.effects) do
-            if effect.type == "unlock-recipe" then
-                local recipe = game.recipe_prototypes[effect.recipe]
-                for _, result in pairs(recipe.products) do
-                    if result.type == "item" and result.amount then
-                        local name = result.name
-                        if FREE_SAMPLE_BLACKLIST[name] ~= 1 then
-                            local count
-                            if FREE_SAMPLES == 1 then
-                                count = result.amount
-                            else
-                                count = get_any_stack_size(result.name)
-                                if FREE_SAMPLES == 2 then
-                                    count = math.ceil(count / 2)
-                                end
-                            end
-                            add_samples(technology.force, name, count)
-                        end
-                    end
-                end
-            end
-        end
-    end
-end)
-
-
-function dumpInfo(force)
-    log("Archipelago Bridge Data available for game tick ".. game.tick .. ".") -- notifies client
-end
-
-
-function chain_lookup(table, ...)
-    for _, k in ipairs{...} do
-        table = table[k]
-        if not table then
-            return nil
-        end
-    end
-    return table
-end
-
-
--- add / commands
-commands.add_command("ap-sync", "Used by the Archipelago client to get progress information", function(call)
-    local force
-    if call.player_index == nil then
-        force = game.forces.player
-    else
-        force = game.players[call.player_index].force
-    end
-    local research_done = {}
-    local data_collection = {
-        ["research_done"] = research_done,
-        ["victory"] = chain_lookup(global, "forcedata", force.name, "victory"),
-        }
-
-    for tech_name, tech in pairs(force.technologies) do
-        if tech.researched and string.find(tech_name, "ap%-") == 1 then
-            research_done[tech_name] = tech.researched
-        end
-    end
-    rcon.print(game.table_to_json({["slot_name"] = SLOT_NAME, ["seed_name"] = SEED_NAME, ["info"] = data_collection}))
-end)
-
-
-commands.add_command("ap-get-technology", "Grant a technology, used by the Archipelago Client.", function(call)
-    if global.index_sync == nil then
-        global.index_sync = {}
-    end
-    local tech
-    local force = game.forces["player"]
-    chunks = split(call.parameter, "\t")
-    local tech_name = chunks[1]
-    local index = chunks[2]
-    local source = chunks[3] or "Archipelago"
-    if progressive_technologies[tech_name] ~= nil then
-        if global.index_sync[index] == nil then -- not yet received prog item
-            global.index_sync[index] = tech_name
-            local tech_stack = progressive_technologies[tech_name]
-            for _, tech_name in ipairs(tech_stack) do
-                tech = force.technologies[tech_name]
-                if tech.researched ~= true then
-                    game.print({"", "Received [technology=" .. tech.name .. "] from ", source})
-                    game.play_sound({path="utility/research_completed"})
-                    tech.researched = true
-                    return
-                end
-            end
-        end
-    elseif force.technologies[tech_name] ~= nil then
-        tech = force.technologies[tech_name]
-        if tech ~= nil then
-            if global.index_sync[index] ~= nil and global.index_sync[index] ~= tech then
-                game.print("Warning: Desync Detected. Duplicate/Missing items may occur.")
-            end
-            global.index_sync[index] = tech
-            if tech.researched ~= true then
-                game.print({"", "Received [technology=" .. tech.name .. "] from ", source})
-                game.play_sound({path="utility/research_completed"})
-                tech.researched = true
-            end
-        end
-    else
-        game.print("Unknown Technology " .. tech_name)
-    end
-end)
-
-
-commands.add_command("ap-rcon-info", "Used by the Archipelago client to get information", function(call)
-    rcon.print(game.table_to_json({["slot_name"] = SLOT_NAME, ["seed_name"] = SEED_NAME}))
-end)
-
--- data
-progressive_technologies = {{ dict_to_lua(progressive_technology_table) }}

docs/adding games.md

@@ -0,0 +1,342 @@
+
+
+# How do I add a game to Archipelago?  
+This guide is going to try and be a broad summary of how you can do just that.  
+There are two key steps to incorporating a game into Archipelago:  
+- Game Modification 
+- Archipelago Server Integration
+
+# Game Modification  
+One half of the work required to integrate a game into Archipelago is the development of the game client. This is 
+typically done through a modding API or other modification process, described further down.
+
+As an example, modifications to a game typically include (more on this later):
+- Hooking into when a 'location check' is completed.
+- Networking with the Archipelago server.
+- Optionally, UI or HUD updates to show status of the multiworld session or Archipelago server connection.
+
+In order to determine how to modify a game, refer to the following sections.
+  
+## Engine Identification  
+This is a good way to make the modding process much easier. Being able to identify what engine a game was made in is critical. The first step is to look at a game's files. Let's go over what some game files might look like. It’s important that you be able to see file extensions, so be sure to enable that feature in your file viewer of choice.  
+Examples are provided below.
+  
+### Creepy Castle
+![Creepy Castle Root Directory in Window's Explorer](./img/creepy-castle-directory.png)  
+  
+This is the delightful title Creepy Castle, which is a fantastic game that I highly recommend. It’s also your worst-case
+scenario as a modder. All that’s present here is an executable file and some meta-information that Steam uses. You have 
+basically nothing here to work with. If you want to change this game, the only option you have is to do some pretty nasty 
+disassembly and reverse engineering work, which is outside the scope of this tutorial. Let’s look at some other examples 
+of game releases.  
+
+### Heavy Bullets
+![Heavy Bullets Root Directory in Window's Explorer](./img/heavy-bullets-directory.png)  
+  
+Here’s the release files for another game, Heavy Bullets. We see a .exe file, like expected, and a few more files. 
+“hello.txt” is a text file, which we can quickly skim in any text editor. Many games have them in some form, usually 
+with a name like README.txt, and they may contain information about a game, such as a EULA, terms of service, licensing 
+information, credits, and general info about the game. You usually won’t find anything too helpful here, but it never 
+hurts to check. In this case, it contains some credits and a changelog for the game, so nothing too important. 
+“steam_api.dll” is a file you can safely ignore, it’s just some code used to interface with Steam. 
+The directory “HEAVY_BULLETS_Data”, however, has some good news.  
+  
+![Heavy Bullets Data Directory in Window's Explorer](./img/heavy-bullets-data-directory.png)  
+  
+Jackpot! It might not be obvious what you’re looking at here, but I can instantly tell from this folder’s contents that 
+what we have is a game made in the Unity Engine. If you look in the sub-folders, you’ll seem some .dll files which affirm 
+our suspicions. Telltale signs for this are directories titled “Managed” and “Mono”, as well as the numbered, extension-less 
+level files and the sharedassets files. We’ll tell you a bit about why seeing a Unity game is such good news later, 
+but for now, this is what one looks like. Also keep your eyes out for an executable with a name like UnityCrashHandler, 
+that’s another dead giveaway.  
+
+### Stardew Valley
+![Stardew Valley Root Directory in Window's Explorer](./img/stardew-valley-directory.png)  
+  
+This is the game contents of Stardew Valley. A lot more to look at here, but some key takeaways. 
+Notice the .dll files which include “CSharp” in their name. This tells us that the game was made in C#, which is good news. 
+More on that later.  
+
+### Gato Roboto
+![Gato Roboto Root Directory in Window's Explorer](./img/gato-roboto-directory.png)  
+  
+Our last example is the game Gato Roboto. This game is made in GameMaker, which is another green flag to look out for. 
+The giveaway is the file titled "data.win". This immediately tips us off that this game was made in GameMaker.  
+  
+This isn't all you'll ever see looking at game files, but it's a good place to start. 
+As a general rule, the more files a game has out in plain sight, the more you'll be able to change. 
+This especially applies in the case of code or script files - always keep a lookout for anything you can use to your 
+advantage!  
+  
+## Open or Leaked Source Games
+As a side note, many games have either been made open source, or have had source files leaked at some point. 
+This can be a boon to any would-be modder, for obvious reasons. 
+Always be sure to check - a quick internet search for "(Game) Source Code" might not give results often, but when it 
+does you're going to have a much better time.  
+  
+Be sure never to distribute source code for games that you decompile or find if you do not have express permission to do
+so, or to redistribute any materials obtained through similar methods, as this is illegal and unethical.
+  
+## Modifying Release Versions of Games  
+However, for now we'll assume you haven't been so lucky, and have to work with only what’s sitting in your install directory.
+Some developers are kind enough to deliberately leave you ways to alter their games, like modding tools, 
+but these are often not geared to the kind of work you'll be doing and may not help much. 
+
+As a general rule, any modding tool that lets you write actual code is something worth using.  
+  
+### Research
+The first step is to research your game. Even if you've been dealt the worst hand in terms of engine modification, 
+it's possible other motivated parties have concocted useful tools for your game already. 
+Always be sure to search the Internet for the efforts of other modders.  
+  
+### Analysis Tools
+Depending on the game’s underlying engine, there may be some tools you can use either in lieu of or in addition to existing game tools.  
+  
+#### [dnSpy](https://github.com/dnSpy/dnSpy/releases)  
+The first tool in your toolbox is dnSpy. 
+dnSpy is useful for opening and modifying code files, like .exe and .dll files, that were made in C#. 
+This won't work for executable files made by other means, and obfuscated code (code which was deliberately made 
+difficult to reverse engineer) will thwart it, but 9 times out of 10 this is exactly what you need. 
+You'll want to avoid opening common library files in dnSpy, as these are unlikely to contain the data you're looking to 
+modify. 
+
+For Unity games, the file you’ll want to open will be the file (Data Folder)/Managed/Assembly-CSharp.dll, as pictured below:  
+  
+![Heavy Bullets Managed Directory in Window's Explorer](./img/heavy-bullets-managed-directory.png)  
+  
+This file will contain the data of the actual game. 
+For other C# games, the file you want is usually just the executable itself.  
+  
+With dnSpy, you can view the game’s C# code, but the tool isn’t perfect. 
+Although the names of classes, methods, variables, and more will be preserved, code structures may not remain entirely intact. This is because compilers will often subtly rewrite code to be more optimal, so that it works the same as the original code but uses fewer resources. Compiled C# files also lose comments and other documentation.  
+  
+#### [UndertaleModTool](https://github.com/krzys-h/UndertaleModTool/releases)  
+This is currently the best tool for modifying games made in GameMaker, and supports games made in both GMS 1 and 2. 
+It allows you to modify code in GML, if the game wasn't made with the wrong compiler (usually something you don't have 
+to worry about). 
+
+You'll want to open the data.win file, as this is where all the goods are kept. 
+Like dnSpy, you won’t be able to see comments. 
+In addition, you will be able to see and modify many hidden fields on items that GameMaker itself will often hide from 
+creators. 
+
+Fonts in particular are notoriously complex, and to add new sprites you may need to modify existing sprite sheets.  
+  
+#### [CheatEngine](https://cheatengine.org/)  
+CheatEngine is a tool with a very long and storied history. 
+Be warned that because it performs live modifications to the memory of other processes, it will likely be flagged as 
+malware (because this behavior is most commonly found in malware and rarely used by other programs). 
+If you use CheatEngine, you need to have a deep understanding of how computers work at the nuts and bolts level, 
+including binary data formats, addressing, and assembly language programming. 
+
+The tool itself is highly complex and even I have not yet charted its expanses. 
+However, it can also be a very powerful tool in the right hands, allowing you to query and modify gamestate without ever
+modifying the actual game itself. 
+In theory it is compatible with any piece of software you can run on your computer, but there is no "easy way" to do 
+anything with it.  
+  
+### What Modifications You Should Make to the Game
+We talked about this briefly in [Game Modification](#game-modification) section.
+The next step is to know what you need to make the game do now that you can modify it. Here are your key goals:  
+- Modify the game so that checks are shuffled  
+- Know when the player has completed a check, and react accordingly  
+- Listen for messages from the Archipelago server  
+- Modify the game to display messages from the Archipelago server  
+- Add interface for connecting to the Archipelago server with passwords and sessions  
+- Add commands for manually rewarding, re-syncing, forfeiting, and other actions  
+  
+To elaborate, you need to be able to inform the server whenever you check locations, print out messages that you receive
+from the server in-game so players can read them, award items when the server tells you to, sync and re-sync when necessary,
+avoid double-awarding items while still maintaining game file integrity, and allow players to manually enter commands in
+case the client or server make mistakes. 
+
+Refer to the [Network Protocol documentation](./network%20protocol.md) for how to communicate with Archipelago's servers.  
+  
+## But my Game is a console game. Can I still add it?  
+That depends – what console?  
+  
+### My Game is a recent game for the PS4/Xbox-One/Nintendo Switch/etc  
+Most games for recent generations of console platforms are inaccessible to the typical modder. It is generally advised
+that you do not attempt to work with these games as they are difficult to modify and are protected by their copyright
+holders. Most modern AAA game studios will provide a modding interface or otherwise deny modifications for their console games.
+  
+### My Game isn’t that old, it’s for the Wii/PS2/360/etc  
+This is very complex, but doable. 
+If you don't have good knowledge of stuff like Assembly programming, this is not where you want to learn it. 
+There exist many disassembly and debugging tools, but more recent content may have lackluster support.
+  
+### My Game is a classic for the SNES/Sega Genesis/etc  
+That’s a lot more feasible. 
+There are many good tools available for understanding and modifying games on these older consoles, and the emulation 
+community will have figured out the bulk of the console’s secrets. 
+Look for debugging tools, but be ready to learn assembly. 
+Old consoles usually have their own unique dialects of ASM you’ll need to get used to. 
+
+Also make sure there’s a good way to interface with a running emulator, since that’s the only way you can connect these
+older consoles to the Internet.
+There are also hardware mods and flash carts, which can do the same things an emulator would when connected to a computer,
+but these will require the same sort of interface software to be written in order to work properly - from your perspective
+the two won't really look any different.  
+  
+### My Game is an exclusive for the Super Baby Magic Dream Boy. It’s this console from the Soviet Union that-  
+Unless you have a circuit schematic for the Super Baby Magic Dream Boy sitting on your desk, no. 
+Obscurity is your enemy – there will likely be little to no emulator or modding information, and you’d essentially be
+working from scratch.  
+  
+## How to Distribute Game Modifications
+**NEVER EVER distribute anyone else's copyrighted work UNLESS THEY EXPLICITLY GIVE YOU PERMISSION TO DO SO!!!**
+
+This is a good way to get any project you're working on sued out from under you.
+The right way to distribute modified versions of a game's binaries, assuming that the licensing terms do not allow you
+to copy them wholesale, is as patches. 
+
+There are many patch formats, which I'll cover in brief. The common theme is that you can’t distribute anything that wasn't
+made by you. Patches are files that describe how your modified file differs from the original one, thus avoiding the
+issue of distributing someone else’s original work.
+
+Users who have a copy of the game just need to apply the patch, and those who don’t are unable to play.  
+  
+### IPS Patches
+This is an extremely simple, early patch format, but is limited to games of about 16 Megabytes in size or less.
+You will often find IPS patches being used to distribute mods for old video game ROMs.
+IPS patches are a delta patch format, which means they act only as a simple list of alterations that need to be made to
+an original file in order to produce a new one.
+
+Archipelago may use pre-made IPS patches to apply specific changes to a game, but will not create IPS patches as a means
+of distributing game modifications. Although IPS patches can be applied quickly, creating them is quite slow, so using
+them for distributing randomized games is not current practice. 
+
+However, due to the format's simplicity, even patch files of this type can unintentionally include copyrighted data.
+This is because IPS patches don't have a good way to shift existing data in a file, and thus if data has to be moved
+forward x number of bytes, which might be necessary for data insertion, the patch will simply include a copy of the
+shifted bytes after the inserted ones. 
+Increasing and decreasing file size is also not a universally supported operation, due to the patch format's age.  
+  
+### BPS Patches
+BPS is the younger cousin of the IPS patch. 
+
+More flexible and theoretically future-proofed for any file size, BPS patches are based on the idea of linear patching.
+Unlike IPS patches, which use a system called delta patching, linear patches act as a series of steps for creating a
+modified file from scratch through a combination of original data and patch data, which is appended onto the end of the
+modified game file as the patch progresses.
+
+This means that some operations, like inserting data into the middle of a file instead of simply overwriting it,
+are much easier to do.
+However, like IPS, it isn't a format well suited to randomizers, due to the asymmetric costs of creating and applying
+BPS patches.  
+  
+### Xdelta Patches
+Xdelta is the true successor to IPS, featuring better optimization and verification, and manages to transcend many of
+the limitations of IPS. However, Xdelta patches are particularly expensive to create.  
+  
+### bsdiff  
+bsdiff is the current format adopted by Archipelago for creating and distributing patches.
+It is much faster to create patches of this variety, which is why it sees use in this application.
+  
+### Mod files
+Games which support modding will usually just let you drag and drop the mod’s files into a folder somewhere.
+Mod files come in many forms, but the rules about not distributing other people's content remain the same.  
+  
+## Archipelago Integration
+Integrating a randomizer into Archipelago involves a few steps.
+There are several things that may need to be done, but the most important is to create an implementation of the 
+`World` class specific to your game. This implementation should exist as a Python module within the `worlds` folder
+in the Archipelago file structure.
+
+This encompasses most of the data for your game – the items available, what checks you have, the logic for reaching those
+checks, what options to offer for the player’s yaml file, and the code to initialize all this data.
+
+Here’s an example of what your world module can look like:  
+  
+![Example world module directory open in Window's Explorer](./img/archipelago-world-directory-example.png)  
+  
+Let's give a quick breakdown of what the contents for these files look like.
+This is just one example of an Archipelago world - the way things are done below is not an immutable property of Archipelago.  
+  
+### Items.py  
+This file is used to define the items which exist in a given game.  
+  
+![Example Items.py file open in Notepad++](./img/example-items-py-file.png)  
+  
+Some important things to note here. The center of our Items.py file is the item_table, which individually lists every
+item in the game and associates them with an ItemData.
+
+This file is rather skeletal - most of the actual data has been stripped out for simplicity.
+Each ItemData gives a numeric ID to associate with the item and a boolean telling us whether the item might allow the
+player to do more than they would have been able to before.  
+  
+Next there's the item_frequencies. This simply tells Archipelago how many times each item appears in the pool.
+Items that appear exactly once need not be listed - Archipelago will interpret absence from this dictionary as meaning
+that the item appears once.
+  
+Lastly, note the `lookup_id_to_name` dictionary, which is typically imported and used in your Archipelago `World`
+implementation. This is how Archipelago is told about the items in your world. 
+
+### Locations.py
+This file lists all locations in the game.  
+  
+![Example Locations.py file open in Notepad++](./img/example-locations-py-file.png)  
+  
+First is the achievement_table. It lists each location, the region that it can be found in (more on regions later),
+and a numeric ID to associate with each location.
+
+The exclusion table is a series of dictionaries which are used to exclude certain checks from the pool of progression
+locations based on user settings, and the events table associates certain specific checks with specific items.
+
+`lookup_id_to_name` is also present for locations, though this is a separate dictionary, to be clear.  
+  
+### Options.py  
+This file details options to be searched for in a player's YAML settings file.  
+  
+![Example Options.py file open in Notepad++](./img/example-options-py-file.png)  
+  
+There are several types of option Archipelago has support for.
+In our case, we have three separate choices a player can toggle, either On or Off.
+You can also have players choose between a number of predefined values, or have them provide a numeric value within a
+specified range. 
+  
+### Regions.py  
+This file contains data which defines the world's topology.
+In other words, it details how different regions of the game connect to each other.  
+  
+![Example Regions.py file open in Notepad++](./img/example-regions-py-file.png)  
+  
+`terraria_regions` contains a list of tuples.
+The first element of the tuple is the name of the region, and the second is a list of connections that lead out of the region.
+
+`mandatory_connections` describe where the connection leads.
+
+Above this data is a function called `link_terraria_structures` which uses our defined regions and connections to create
+something more usable for Archipelago, but this has been left out for clarity.  
+  
+### Rules.py  
+This is the file that details rules for what players can and cannot logically be required to do, based on items and settings.  
+  
+![Example Rules.py file open in Notepad++](./img/example-rules-py-file.png)  
+  
+This is the most complicated part of the job, and is one part of Archipelago that is likely to see some changes in the future.
+The first class, called `TerrariaLogic`, is an extension of the `LogicMixin` class.
+This is where you would want to define methods for evaluating certain conditions, which would then return a boolean to
+indicate whether conditions have been met. Your rule definitions should start with some sort of identifier to delineate it
+from other games, as all rules are mixed together due to `LogicMixin`. In our case, `_terraria_rule` would be a better name.
+
+The method below, `set_rules()`, is where you would assign these functions as "rules", using lambdas to associate these
+functions or combinations of them (or any other code that evaluates to a boolean, in my case just the placeholder `True`)
+to certain tasks, like checking locations or using entrances.  
+  
+### \_\_init\_\_.py  
+This is the file that actually extends the `World` class, and is where you expose functionality and data to Archipelago.  
+  
+![Example \_\_init\_\_.py file open in Notepad++](./img/example-init-py-file.png)  
+  
+This is the most important file for the implementation, and technically the only one you need, but it's best to keep this
+file as short as possible and use other script files to do most of the heavy lifting.
+If you've done things well, this will just be where you assign everything you set up in the other files to their associated
+fields in the class being extended.
+
+This is also a good place to put game-specific quirky behavior that needs to be managed, as it tends to make things a bit
+cluttered if you put these things elsewhere.  
+  
+The various methods and attributes are documented in `/worlds/AutoWorld.py[World]`, 
+though it is also recommended to look at existing implementations to see how all this works first-hand. 
+Once you get all that, all that remains to do is test the game and publish your work.