MultiServer: Correct tying of Context.groups

* Modify UT support to make a better pattern

* Handle keyerror for logic_rules option

* Missed self.passthrough value setting

* Less laziness for passthrough

* Remove extra newline

* Fix missing using_ut = True, also remove now unnecessary try except since 0.5.1 is out

* New UT thing, it goes in this PR because it's been open for 5 months for a very very tiny change

Fill.py

@@ -531,7 +531,8 @@ def distribute_items_restrictive(multiworld: MultiWorld,
         if progitempool:
             raise FillError(
                 f"Not enough locations for progression items. "
-                f"There are {len(progitempool)} more progression items than there are available locations.",
+                f"There are {len(progitempool)} more progression items than there are available locations.\n"
+                f"Unfilled locations:\n{multiworld.get_unfilled_locations()}.",
                 multiworld=multiworld,
             )
         accessibility_corrections(multiworld, multiworld.state, defaultlocations)

Generate.py

@@ -500,7 +500,8 @@ def roll_settings(weights: dict, plando_options: PlandoOptions = PlandoOptions.b
     for option_key in game_weights:
         if option_key in {"triggers", *valid_keys}:
             continue
-        logging.warning(f"{option_key} is not a valid option name for {ret.game} and is not present in triggers.")
+        logging.warning(f"{option_key} is not a valid option name for {ret.game} and is not present in triggers "
+                        f"for player {ret.name}.")
     if PlandoOptions.items in plando_options:
         ret.plando_items = copy.deepcopy(game_weights.get("plando_items", []))
     if ret.game == "A Link to the Past":

LICENSE

@@ -1,7 +1,7 @@
 MIT License
 
 Copyright (c) 2017 LLCoolDave
-Copyright (c) 2022 Berserker66
+Copyright (c) 2025 Berserker66
 Copyright (c) 2022 CaitSith2
 Copyright (c) 2021 LegendaryLinux
 

MultiServer.py

@@ -444,7 +444,7 @@ class Context:
 
         self.slot_info = decoded_obj["slot_info"]
         self.games = {slot: slot_info.game for slot, slot_info in self.slot_info.items()}
-        self.groups = {slot: slot_info.group_members for slot, slot_info in self.slot_info.items()
+        self.groups = {slot: set(slot_info.group_members) for slot, slot_info in self.slot_info.items()
                        if slot_info.type == SlotType.group}
 
         self.clients = {0: {}}

NetUtils.py

@@ -10,7 +10,7 @@ import websockets
 from Utils import ByValue, Version
 
 
-class HintStatus(enum.IntEnum):
+class HintStatus(ByValue, enum.IntEnum):
     HINT_FOUND = 0
     HINT_UNSPECIFIED = 1
     HINT_NO_PRIORITY = 10

SNIClient.py

@@ -243,6 +243,9 @@ class SNIContext(CommonContext):
                 # Once the games handled by SNIClient gets made to be remote items,
                 # this will no longer be needed.
                 async_start(self.send_msgs([{"cmd": "LocationScouts", "locations": list(new_locations)}]))
+                
+        if self.client_handler is not None:
+            self.client_handler.on_package(self, cmd, args)
 
     def run_gui(self) -> None:
         from kvui import GameManager

Utils.py

@@ -152,8 +152,15 @@ def home_path(*path: str) -> str:
     if hasattr(home_path, 'cached_path'):
         pass
     elif sys.platform.startswith('linux'):
-        home_path.cached_path = os.path.expanduser('~/Archipelago')
-        os.makedirs(home_path.cached_path, 0o700, exist_ok=True)
+        xdg_data_home = os.getenv('XDG_DATA_HOME', os.path.expanduser('~/.local/share'))
+        home_path.cached_path = xdg_data_home + '/Archipelago'
+        if not os.path.isdir(home_path.cached_path):
+            legacy_home_path = os.path.expanduser('~/Archipelago')
+            if os.path.isdir(legacy_home_path):
+                os.renames(legacy_home_path, home_path.cached_path)
+                os.symlink(home_path.cached_path, legacy_home_path)
+            else:
+                os.makedirs(home_path.cached_path, 0o700, exist_ok=True)
     else:
         # not implemented
         home_path.cached_path = local_path()  # this will generate the same exceptions we got previously

WebHostLib/templates/islandFooter.html

@@ -1,6 +1,6 @@
 {% block footer %}
     <footer id="island-footer">
-        <div id="copyright-notice">Copyright 2024 Archipelago</div>
+        <div id="copyright-notice">Copyright 2025 Archipelago</div>
         <div id="links">
             <a href="/sitemap">Site Map</a>
             -

data/client.kv

@@ -147,3 +147,8 @@
             rectangle: self.x-2, self.y-2, self.width+4, self.height+4
 <ServerToolTip>:
     pos_hint: {'center_y': 0.5, 'center_x': 0.5}
+<AutocompleteHintInput>
+    size_hint_y: None
+    height: dp(30)
+    multiline: False
+    write_tab: False

kvui.py

@@ -40,7 +40,7 @@ from kivy.core.image import ImageLoader, ImageLoaderBase, ImageData
 from kivy.base import ExceptionHandler, ExceptionManager
 from kivy.clock import Clock
 from kivy.factory import Factory
-from kivy.properties import BooleanProperty, ObjectProperty
+from kivy.properties import BooleanProperty, ObjectProperty, NumericProperty
 from kivy.metrics import dp
 from kivy.effects.scroll import ScrollEffect
 from kivy.uix.widget import Widget
@@ -64,6 +64,7 @@ from kivy.uix.recycleboxlayout import RecycleBoxLayout
 from kivy.uix.recycleview.layout import LayoutSelectionBehavior
 from kivy.animation import Animation
 from kivy.uix.popup import Popup
+from kivy.uix.dropdown import DropDown
 from kivy.uix.image import AsyncImage
 
 fade_in_animation = Animation(opacity=0, duration=0) + Animation(opacity=1, duration=0.25)
@@ -305,6 +306,50 @@ class SelectableLabel(RecycleDataViewBehavior, TooltipLabel):
         """ Respond to the selection of items in the view. """
         self.selected = is_selected
 
+        
+class AutocompleteHintInput(TextInput):
+    min_chars = NumericProperty(3)
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+        self.dropdown = DropDown()
+        self.dropdown.bind(on_select=lambda instance, x: setattr(self, 'text', x))
+        self.bind(on_text_validate=self.on_message)
+
+    def on_message(self, instance):
+        App.get_running_app().commandprocessor("!hint "+instance.text)
+
+    def on_text(self, instance, value):
+        if len(value) >= self.min_chars:
+            self.dropdown.clear_widgets()
+            ctx: context_type = App.get_running_app().ctx
+            if not ctx.game:
+                return
+            item_names = ctx.item_names._game_store[ctx.game].values()
+
+            def on_press(button: Button):
+                split_text = MarkupLabel(text=button.text).markup
+                return self.dropdown.select("".join(text_frag for text_frag in split_text
+                                                    if not text_frag.startswith("[")))
+            lowered = value.lower()
+            for item_name in item_names:
+                try:
+                    index = item_name.lower().index(lowered)
+                except ValueError:
+                    pass  # substring not found
+                else:
+                    text = escape_markup(item_name)
+                    text = text[:index] + "[b]" + text[index:index+len(value)]+"[/b]"+text[index+len(value):]
+                    btn = Button(text=text, size_hint_y=None, height=dp(30), markup=True)
+                    btn.bind(on_release=on_press)
+                    self.dropdown.add_widget(btn)
+            if not self.dropdown.attach_to:
+                self.dropdown.open(self)
+        else:
+            self.dropdown.dismiss()
+
+
 class HintLabel(RecycleDataViewBehavior, BoxLayout):
     selected = BooleanProperty(False)
     striped = BooleanProperty(False)
@@ -570,8 +615,10 @@ class GameManager(App):
                 # show Archipelago tab if other logging is present
                 self.tabs.add_widget(panel)
 
-        hint_panel = self.add_client_tab("Hints", HintLog(self.json_to_kivy_parser))
+        hint_panel = self.add_client_tab("Hints", HintLayout())
+        self.hint_log = HintLog(self.json_to_kivy_parser)
         self.log_panels["Hints"] = hint_panel.content
+        hint_panel.content.add_widget(self.hint_log)
 
         if len(self.logging_pairs) == 1:
             self.tabs.default_tab_text = "Archipelago"
@@ -698,7 +745,7 @@ class GameManager(App):
 
     def update_hints(self):
         hints = self.ctx.stored_data.get(f"_read_hints_{self.ctx.team}_{self.ctx.slot}", [])
-        self.log_panels["Hints"].refresh_hints(hints)
+        self.hint_log.refresh_hints(hints)
 
     # default F1 keybind, opens a settings menu, that seems to break the layout engine once closed
     def open_settings(self, *largs):
@@ -753,6 +800,17 @@ class UILog(RecycleView):
                 element.height = element.texture_size[1]
 
 
+class HintLayout(BoxLayout):
+    orientation = "vertical"
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        boxlayout = BoxLayout(orientation="horizontal", size_hint_y=None, height=dp(30))
+        boxlayout.add_widget(Label(text="New Hint:", size_hint_x=None, size_hint_y=None, height=dp(30)))
+        boxlayout.add_widget(AutocompleteHintInput())
+        self.add_widget(boxlayout)
+
+        
 status_names: typing.Dict[HintStatus, str] = {
     HintStatus.HINT_FOUND: "Found",
     HintStatus.HINT_UNSPECIFIED: "Unspecified",
@@ -769,6 +827,7 @@ status_colors: typing.Dict[HintStatus, str] = {
 }
 
 
+
 class HintLog(RecycleView):
     header = {
         "receiving": {"text": "[u]Receiving Player[/u]"},

requirements.txt

@@ -7,7 +7,7 @@ schema>=0.7.7
 kivy>=2.3.0
 bsdiff4>=1.2.4
 platformdirs>=4.2.2
-certifi>=2024.8.30
+certifi>=2024.12.14
 cython>=3.0.11
 cymem>=2.0.8
 orjson>=3.10.7

worlds/AutoSNIClient.py

@@ -86,3 +86,7 @@ class SNIClient(abc.ABC, metaclass=AutoSNIClientRegister):
     async def deathlink_kill_player(self, ctx: SNIContext) -> None:
         """ override this with implementation to kill player """
         pass
+
+    def on_package(self, ctx: SNIContext, cmd: str, args: Dict[str, Any]) -> None:
+        """ override this with code to handle packages from the server """
+        pass

worlds/LauncherComponents.py

@@ -18,16 +18,42 @@ class Type(Enum):
 
 
 class Component:
+    """
+    A Component represents a process launchable by Archipelago Launcher, either by a User action in the GUI,
+    by resolving an archipelago://user:pass@host:port link from the WebHost, by resolving a patch file's metadata,
+    or by using a component name arg while running the Launcher in CLI i.e. `ArchipelagoLauncher.exe "Text Client"`
+
+    Expected to be appended to LauncherComponents.component list to be used.
+    """
     display_name: str
+    """Used as the GUI button label and the component name in the CLI args"""
     type: Type
+    """
+    Enum "Type" classification of component intent, for filtering in the Launcher GUI
+    If not set in the constructor, it will be inferred by display_name
+    """
     script_name: Optional[str]
+    """Recommended to use func instead; Name of file to run when the component is called"""
     frozen_name: Optional[str]
+    """Recommended to use func instead; Name of the frozen executable file for this component"""
     icon: str  # just the name, no suffix
+    """Lookup ID for the icon path in LauncherComponents.icon_paths"""
     cli: bool
+    """Bool to control if the component gets launched in an appropriate Terminal for the OS"""
     func: Optional[Callable]
+    """
+    Function that gets called when the component gets launched
+    Any arg besides the component name arg is passed into the func as well, so handling *args is suggested
+    """
     file_identifier: Optional[Callable[[str], bool]]
+    """
+    Function that is run against patch file arg to identify which component is appropriate to launch
+    If the function is an Instance of SuffixIdentifier the suffixes will also be valid for the Open Patch component
+    """
     game_name: Optional[str]
+    """Game name to identify component when handling launch links from WebHost"""
     supports_uri: Optional[bool]
+    """Bool to identify if a component supports being launched by launch links from WebHost"""
 
     def __init__(self, display_name: str, script_name: Optional[str] = None, frozen_name: Optional[str] = None,
                  cli: bool = False, icon: str = 'icon', component_type: Optional[Type] = None,

worlds/alttp/Rules.py

@@ -592,9 +592,9 @@ def global_rules(multiworld: MultiWorld, player: int):
              lambda state: can_kill_most_things(state, player, 8) and has_fire_source(state, player) and state.multiworld.get_entrance('Ganons Tower Torch Rooms', player).parent_region.dungeon.bosses['middle'].can_defeat(state))
     set_rule(multiworld.get_location('Ganons Tower - Mini Helmasaur Key Drop', player), lambda state: can_kill_most_things(state, player, 1))
     set_rule(multiworld.get_location('Ganons Tower - Pre-Moldorm Chest', player),
-             lambda state: state._lttp_has_key('Small Key (Ganons Tower)', player, 7))
+             lambda state: state._lttp_has_key('Small Key (Ganons Tower)', player, 7) and can_use_bombs(state, player))
     set_rule(multiworld.get_entrance('Ganons Tower Moldorm Door', player),
-             lambda state: state._lttp_has_key('Small Key (Ganons Tower)', player, 8))
+             lambda state: state._lttp_has_key('Small Key (Ganons Tower)', player, 8) and can_use_bombs(state, player))
     set_rule(multiworld.get_entrance('Ganons Tower Moldorm Gap', player),
              lambda state: state.has('Hookshot', player) and state.multiworld.get_entrance('Ganons Tower Moldorm Gap', player).parent_region.dungeon.bosses['top'].can_defeat(state))
     set_defeat_dungeon_boss_rule(multiworld.get_location('Agahnim 2', player))

worlds/alttp/test/dungeons/TestGanonsTower.py

@@ -130,19 +130,21 @@ class TestGanonsTower(TestDungeon):
 
             ["Ganons Tower - Pre-Moldorm Chest", False, []],
             ["Ganons Tower - Pre-Moldorm Chest", False, [], ['Progressive Bow']],
+            ["Ganons Tower - Pre-Moldorm Chest", False, [], ['Bomb Upgrade (50)']],
             ["Ganons Tower - Pre-Moldorm Chest", False, [], ['Big Key (Ganons Tower)']],
             ["Ganons Tower - Pre-Moldorm Chest", False, [], ['Lamp', 'Fire Rod']],
-            ["Ganons Tower - Pre-Moldorm Chest", True, ['Progressive Bow', 'Big Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Lamp']],
-            ["Ganons Tower - Pre-Moldorm Chest", True, ['Progressive Bow', 'Big Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Fire Rod']],
+            ["Ganons Tower - Pre-Moldorm Chest", True, ['Bomb Upgrade (50)', 'Progressive Bow', 'Big Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Lamp']],
+            ["Ganons Tower - Pre-Moldorm Chest", True, ['Bomb Upgrade (50)', 'Progressive Bow', 'Big Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Fire Rod']],
 
             ["Ganons Tower - Validation Chest", False, []],
             ["Ganons Tower - Validation Chest", False, [], ['Hookshot']],
             ["Ganons Tower - Validation Chest", False, [], ['Progressive Bow']],
+            ["Ganons Tower - Validation Chest", False, [], ['Bomb Upgrade (50)']],
             ["Ganons Tower - Validation Chest", False, [], ['Big Key (Ganons Tower)']],
             ["Ganons Tower - Validation Chest", False, [], ['Lamp', 'Fire Rod']],
             ["Ganons Tower - Validation Chest", False, [], ['Progressive Sword', 'Hammer']],
-            ["Ganons Tower - Validation Chest", True, ['Progressive Bow', 'Big Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Lamp', 'Hookshot', 'Progressive Sword']],
-            ["Ganons Tower - Validation Chest", True, ['Progressive Bow', 'Big Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Fire Rod', 'Hookshot', 'Progressive Sword']],
-            ["Ganons Tower - Validation Chest", True, ['Progressive Bow', 'Big Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Lamp', 'Hookshot', 'Hammer']],
-            ["Ganons Tower - Validation Chest", True, ['Progressive Bow', 'Big Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Fire Rod', 'Hookshot', 'Hammer']],
+            ["Ganons Tower - Validation Chest", True, ['Bomb Upgrade (50)', 'Progressive Bow', 'Big Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Lamp', 'Hookshot', 'Progressive Sword']],
+            ["Ganons Tower - Validation Chest", True, ['Bomb Upgrade (50)', 'Progressive Bow', 'Big Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Fire Rod', 'Hookshot', 'Progressive Sword']],
+            ["Ganons Tower - Validation Chest", True, ['Bomb Upgrade (50)', 'Progressive Bow', 'Big Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Lamp', 'Hookshot', 'Hammer']],
+            ["Ganons Tower - Validation Chest", True, ['Bomb Upgrade (50)', 'Progressive Bow', 'Big Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Small Key (Ganons Tower)', 'Fire Rod', 'Hookshot', 'Hammer']],
         ])

worlds/blasphemous/Options.py

@@ -4,14 +4,17 @@ import random
 
 
 class ChoiceIsRandom(Choice):
-    randomized: bool = False
+    randomized: bool
+
+    def __init__(self, value: int, randomized: bool = False):
+        super().__init__(value)
+        self.randomized = randomized
 
     @classmethod
     def from_text(cls, text: str) -> Choice:
         text = text.lower()
         if text == "random":
-            cls.randomized = True
-            return cls(random.choice(list(cls.name_lookup)))
+            return cls(random.choice(list(cls.name_lookup)), True)
         for option_name, value in cls.options.items():
             if option_name == text:
                 return cls(value)

worlds/factorio/Mod.py

@@ -37,8 +37,8 @@ base_info = {
     "description": "Integration client for the Archipelago Randomizer",
     "factorio_version": "2.0",
     "dependencies": [
-        "base >= 2.0.15",
-        "? quality >= 2.0.15",
+        "base >= 2.0.28",
+        "? quality >= 2.0.28",
         "! space-age",
         "? science-not-invited",
         "? factory-levels"

worlds/factorio/Technologies.py

@@ -63,17 +63,19 @@ class FactorioElement:
 
 
 class Technology(FactorioElement):  # maybe make subclass of Location?
-    has_modifier: bool
     factorio_id: int
     progressive: Tuple[str]
     unlocks: Union[Set[str], bool]  # bool case is for progressive technologies
+    modifiers: list[str]
 
     def __init__(self, technology_name: str, factorio_id: int, progressive: Tuple[str] = (),
-                 has_modifier: bool = False, unlocks: Union[Set[str], bool] = None):
+                 modifiers: list[str] = None, unlocks: Union[Set[str], bool] = None):
         self.name = technology_name
         self.factorio_id = factorio_id
         self.progressive = progressive
-        self.has_modifier = has_modifier
+        if modifiers is None:
+            modifiers = []
+        self.modifiers =  modifiers
         if unlocks:
             self.unlocks = unlocks
         else:
@@ -82,6 +84,10 @@ class Technology(FactorioElement):  # maybe make subclass of Location?
     def __hash__(self):
         return self.factorio_id
 
+    @property
+    def has_modifier(self) -> bool:
+        return bool(self.modifiers)
+
     def get_custom(self, world, allowed_packs: Set[str], player: int) -> CustomTechnology:
         return CustomTechnology(self, world, allowed_packs, player)
 
@@ -191,13 +197,14 @@ class Machine(FactorioElement):
 
 
 recipe_sources: Dict[str, Set[str]] = {}  # recipe_name -> technology source
+mining_with_fluid_sources: set[str] = set()
 
 # recipes and technologies can share names in Factorio
 for technology_name, data in sorted(techs_future.result().items()):
     technology = Technology(
         technology_name,
         factorio_tech_id,
-        has_modifier=data["has_modifier"],
+        modifiers=data.get("modifiers", []),
         unlocks=set(data["unlocks"]) - start_unlocked_recipes,
     )
     factorio_tech_id += 1
@@ -205,7 +212,8 @@ for technology_name, data in sorted(techs_future.result().items()):
     technology_table[technology_name] = technology
     for recipe_name in technology.unlocks:
         recipe_sources.setdefault(recipe_name, set()).add(technology_name)
-
+    if "mining-with-fluid" in technology.modifiers:
+        mining_with_fluid_sources.add(technology_name)
 del techs_future
 
 recipes = {}
@@ -221,6 +229,8 @@ for resource_name, resource_data in resources_future.result().items():
         "energy": resource_data["mining_time"],
         "category": resource_data["category"]
     }
+    if "required_fluid" in resource_data:
+        recipe_sources.setdefault(f"mining-{resource_name}", set()).update(mining_with_fluid_sources)
 del resources_future
 
 for recipe_name, recipe_data in raw_recipes.items():
@@ -431,7 +441,9 @@ for root in sorted_rows:
     factorio_tech_id += 1
     progressive_technology = Technology(root, factorio_tech_id,
                                         tuple(progressive),
-                                        has_modifier=any(technology_table[tech].has_modifier for tech in progressive),
+                                        modifiers=sorted(set.union(
+                                            *(set(technology_table[tech].modifiers) for tech in progressive)
+                                        )),
                                         unlocks=any(technology_table[tech].unlocks for tech in progressive),)
     progressive_tech_table[root] = progressive_technology.factorio_id
     progressive_technology_table[root] = progressive_technology

worlds/factorio/data/mod_template/control.lua

@@ -445,6 +445,10 @@ end
 
 script.on_event(defines.events.on_player_main_inventory_changed, update_player_event)
 
+-- Update players when the cutscene is cancelled or finished.  (needed for skins_factored)
+script.on_event(defines.events.on_cutscene_cancelled, update_player_event)
+script.on_event(defines.events.on_cutscene_finished, update_player_event)
+
 function add_samples(force, name, count)
     local function add_to_table(t)
         if count <= 0 then

worlds/factorio/data/mod_template/data-final-fixes.lua

@@ -1,6 +1,7 @@
 {% from "macros.lua" import dict_to_recipe, variable_to_lua %}
 -- this file gets written automatically by the Archipelago Randomizer and is in its raw form a Jinja2 Template
 require('lib')
+data.raw["item"]["rocket-part"].hidden = false
 data.raw["rocket-silo"]["rocket-silo"].fluid_boxes = {
     {
         production_type = "input",
@@ -162,6 +163,7 @@ data.raw["ammo"]["artillery-shell"].stack_size = 10
 {# each randomized tech gets set to be invisible, with new nodes added that trigger those #}
 {%- for original_tech_name in base_tech_table -%}
 technologies["{{ original_tech_name }}"].hidden = true
+technologies["{{ original_tech_name }}"].hidden_in_factoriopedia = true
 {% endfor %}
 {%- for location, item in locations %}
 {#- the tech researched by the local player #}

worlds/ffmq/Items.py

@@ -260,7 +260,8 @@ def create_items(self) -> None:
         items.append(i)
 
     for item_group in ("Key Items", "Spells", "Armors", "Helms", "Shields", "Accessories", "Weapons"):
-        for item in self.item_name_groups[item_group]:
+        # Sort for deterministic order
+        for item in sorted(self.item_name_groups[item_group]):
             add_item(item)
 
     if self.options.brown_boxes == "include":

worlds/ffmq/docs/en_Final Fantasy Mystic Quest.md

@@ -1,7 +1,7 @@
 # Final Fantasy Mystic Quest
 
 ## Game page in other languages:
-* [Français](/games/Final%20Fantasy%20Mystic%20Quest/info/fr)
+* [Français](/games/Final%20Fantasy%20Mystic%20Quest/info/fr)
 
 ## Where is the options page?
 

worlds/generic/docs/commands_en.md

@@ -27,6 +27,7 @@ including the exclamation point.
 - `!countdown <number of seconds>` Starts a countdown using the given seconds value. Useful for synchronizing starts.
   Defaults to 10 seconds if no argument is provided.
 - `!alias <alias>` Sets your alias, which allows you to use commands with the alias rather than your provided name.
+  `!alias` on its own will reset the alias to the player's original name.
 - `!admin <command>` Executes a command as if you typed it into the server console. Remote administration must be
   enabled.
 
@@ -65,6 +66,7 @@ including the exclamation point.
   argument is provided.
 - `/option <option name> <option value>` Set a server option. For a list of options, use the `/options` command.
 - `/alias <player name> <alias name>` Assign a player an alias, allowing you to reference the player by the alias in commands.
+  `!alias <player name>` on its own will reset the alias to the player's original name.
 
 
 ### Collect/Release

worlds/hk/Options.py

@@ -132,7 +132,13 @@ splitter_pattern = re.compile(r'(?<!^)(?=[A-Z])')
 for option_name, option_data in pool_options.items():
     extra_data = {"__module__": __name__, "items": option_data[0], "locations": option_data[1]}
     if option_name in option_docstrings:
-        extra_data["__doc__"] = option_docstrings[option_name]
+        if option_name == "RandomizeFocus":
+            # pool options for focus are just lying
+            count = 1
+        else:
+            count = len([loc for loc in option_data[1] if loc != "Start"])
+        extra_data["__doc__"] = option_docstrings[option_name] + \
+            f"\n    This option adds approximately {count} location{'s' if count != 1 else ''}."
     if option_name in default_on:
         option = type(option_name, (DefaultOnToggle,), extra_data)
     else:
@@ -213,6 +219,7 @@ class MaximumEssencePrice(MinimumEssencePrice):
 class MinimumEggPrice(Range):
     """The minimum rancid egg price in the range of prices that an item should cost from Jiji.
     Only takes effect if the EggSlotShops option is greater than 0."""
+    rich_text_doc = False
     display_name = "Minimum Egg Price"
     range_start = 1
     range_end = 20
@@ -222,6 +229,7 @@ class MinimumEggPrice(Range):
 class MaximumEggPrice(MinimumEggPrice):
     """The maximum rancid egg price in the range of prices that an item should cost from Jiji.
     Only takes effect if the EggSlotShops option is greater than 0."""
+    rich_text_doc = False
     display_name = "Maximum Egg Price"
     default = 10
 
@@ -265,6 +273,7 @@ class RandomCharmCosts(NamedRange):
     Set to -1 or vanilla for vanilla costs.
     Set to -2 or shuffle to shuffle around the vanilla costs to different charms."""
 
+    rich_text_doc = False
     display_name = "Randomize Charm Notch Costs"
     range_start = 0
     range_end = 240
@@ -437,6 +446,7 @@ class Goal(Choice):
 class GrubHuntGoal(NamedRange):
     """The amount of grubs required to finish Grub Hunt.
     On 'All' any grubs from item links replacements etc. will be counted"""
+    rich_text_doc = False
     display_name = "Grub Hunt Goal"
     range_start = 1
     range_end = 46
@@ -446,7 +456,7 @@ class GrubHuntGoal(NamedRange):
 
 class WhitePalace(Choice):
     """
-    Whether or not to include White Palace or not.  Note: Even if excluded, the King Fragment check may still be
+    Whether or not to include White Palace or not. Note: Even if excluded, the King Fragment check may still be
     required if charms are vanilla.
     """
     display_name = "White Palace"
@@ -483,6 +493,7 @@ class DeathLinkShade(Choice):
     ** Self-death shade behavior is not changed; if a self-death normally creates a shade in vanilla, it will override
         your existing shade, if any.
     """
+    rich_text_doc = False
     option_vanilla = 0
     option_shadeless = 1
     option_shade = 2
@@ -497,6 +508,7 @@ class DeathLinkBreaksFragileCharms(Toggle):
     ** Self-death fragile charm behavior is not changed; if a self-death normally breaks fragile charms in vanilla, it
         will continue to do so.
     """
+    rich_text_doc = False
     display_name = "Deathlink Breaks Fragile Charms"
 
 
@@ -515,6 +527,7 @@ class CostSanity(Choice):
 
     These costs can be in Geo (except Grubfather, Seer and Eggshop), Grubs, Charms, Essence and/or Rancid Eggs
     """
+    rich_text_doc = False
     option_off = 0
     alias_no = 0
     option_on = 1

worlds/hk/__init__.py

@@ -134,7 +134,9 @@ shop_cost_types: typing.Dict[str, typing.Tuple[str, ...]] = {
 
 
 class HKWeb(WebWorld):
-    setup_en  = Tutorial(
+    rich_text_options_doc = True
+
+    setup_en = Tutorial(
         "Mod Setup and Use Guide",
         "A guide to playing Hollow Knight with Archipelago.",
         "English",
@@ -143,7 +145,7 @@ class HKWeb(WebWorld):
         ["Ijwu"]
     )
 
-    setup_pt_br  = Tutorial(
+    setup_pt_br = Tutorial(
         setup_en.tutorial_name,
         setup_en.description,
         "Português Brasileiro",

worlds/kh2/docs/setup_en.md

@@ -7,18 +7,21 @@
 
 <h2 style="text-transform:none";>Required Software:</h2>
 
-`Kingdom Hearts II Final Mix` from the [Epic Games Store](https://store.epicgames.com/en-US/discover/kingdom-hearts) or [Steam](https://store.steampowered.com/app/2552430/KINGDOM_HEARTS_HD_1525_ReMIX/)
+Kingdom Hearts II Final Mix from the [Epic Games Store](https://store.epicgames.com/en-US/discover/kingdom-hearts) or [Steam](https://store.steampowered.com/app/2552430/KINGDOM_HEARTS_HD_1525_ReMIX/)
 
 - Follow this Guide to set up these requirements [KH2Rando.com](https://tommadness.github.io/KH2Randomizer/setup/Panacea-ModLoader/)
-    1. `Version 3.3.0 or greater OpenKH Mod Manager with Panacea`
-    2. `Lua Backend from the OpenKH Mod Manager`
-    3. `Install the mod KH2FM-Mods-Num/GoA-ROM-Edition using OpenKH Mod Manager`
+    1. Version 3.4.0 or greater OpenKH Mod Manager with Panacea
+    2. Lua Backend from the OpenKH Mod Manager
+    3. Install the mod `KH2FM-Mods-Num/GoA-ROM-Edition` using OpenKH Mod Manager
 - Needed for Archipelago 
-    1. [`ArchipelagoKH2Client.exe`](https://github.com/ArchipelagoMW/Archipelago/releases)
-    2. `Install the Archipelago Companion mod from JaredWeakStrike/APCompanion using OpenKH Mod Manager`
-    3. `Install the Archipelago Quality Of Life mod from JaredWeakStrike/AP_QOL using OpenKH Mod Manager`
-    4. `Install the mod from KH2FM-Mods-equations19/auto-save using OpenKH Mod Manager`
-    5. `AP Randomizer Seed`
+    1. [ArchipelagoKH2Client.exe](https://github.com/ArchipelagoMW/Archipelago/releases)
+    2. Install the Archipelago Companion mod from `JaredWeakStrike/APCompanion` using OpenKH Mod Manager
+    3. Install the mod from `KH2FM-Mods-equations19/auto-save` using OpenKH Mod Manager
+    4. Install the mod from `KH2FM-Mods-equations19/KH2-Lua-Library` using OpenKH Mod Manager
+    5. AP Randomizer Seed
+- Optional Quality of Life Mods for Archipelago
+    1. Optionally Install the Archipelago Quality Of Life mod from `JaredWeakStrike/AP_QOL` using OpenKH Mod Manager
+    2. Optionally Install the Quality Of Life mod from `shananas/BearSkip` using OpenKH Mod Manager
 
 <h3 style="text-transform:none";>Required: Archipelago Companion Mod</h3>
 
@@ -26,15 +29,21 @@ Load this mod just like the <b>GoA ROM</b> you did during the KH2 Rando setup. `
 Have this mod second-highest priority below the .zip seed.<br>
 This mod is based upon Num's Garden of Assemblege Mod and requires it to work. Without Num this could not be possible. 
 
-<h3 style="text-transform:none";>Required: Auto Save Mod</h3>
+<h3 style="text-transform:none";>Required: Auto Save Mod and KH2 Lua Library</h3>
 
-Load this mod just like the GoA ROM you did during the KH2 Rando setup. `KH2FM-Mods-equations19/auto-save` Location doesn't matter, required in case of crashes. See [Best Practices](en#best-practices) on how to load the auto save
+Load these mods just like you loaded the GoA ROM mod during the KH2 Rando setup. `KH2FM-Mods-equations19/auto-save` and `KH2FM-Mods-equations19/KH2-Lua-Library` Location doesn't matter, required in case of crashes. See [Best Practices](en#best-practices) on how to load the auto save
+
+<h3 style="text-transform:none";>Optional QoL Mods: AP QoL and Bear Skip</h3>
+
+`JaredWeakStrike/AP_QOL` Makes the urns minigames much faster, makes Cavern of Remembrance orbs drop significantly more drive orbs for refilling drive/leveling master form, skips the animation when using the bulky vendor RC, skips carpet escape auto scroller in Agrabah 2, and prevents the wardrobe in the Beasts Castle wardrobe push minigame from waking up while being pushed.
+
+`shananas/BearSkip` Skips all minigames in 100 Acre Woods except the Spooky Cave minigame since there are chests in Spooky Cave you can only get during the minigame. For Spooky Cave, Pooh is moved to the other side of the invisible wall that prevents you from using his RC to finish the minigame.
 
 <h3 style="text-transform:none";>Installing A Seed</h3>
 
-When you generate a game you will see a download link for a KH2 .zip seed on the room page. Download the seed then open OpenKH Mod Manager and click the green plus and `Select and install Mod Archive`.<br>
+When you generate a game you will see a download link for a KH2 .zip seed on the room page. Download the seed then open OpenKH Mod Manager and click the green plus and "Select and install Mod Archive".<br>
 Make sure the seed is on the top of the list (Highest Priority)<br>
-After Installing the seed click `Mod Loader -> Build/Build and Run`. Every slot is a unique mod to install and will be needed be repatched for different slots/rooms.
+After Installing the seed click "Mod Loader -> Build/Build and Run". Every slot is a unique mod to install and will be needed be repatched for different slots/rooms.
 
 <h2 style="text-transform:none";>Optional Software:</h2>
 
@@ -48,18 +57,21 @@ After Installing the seed click `Mod Loader -> Build/Build and Run`. Every slot
 
 <h2 style="text-transform:none";>Using the KH2 Client</h2>
 
-Once you have started the game through OpenKH Mod Manager and are on the title screen run the [ArchipelagoKH2Client.exe](https://github.com/ArchipelagoMW/Archipelago/releases).<br>
+Start the game through OpenKH Mod Manager. If starting a new run, enter the Garden of Assemblage from a new save. If returning to a run, load the save and enter the Garden of Assemblage. Then run the [ArchipelagoKH2Client.exe](https://github.com/ArchipelagoMW/Archipelago/releases).<br>
 When you successfully connect to the server the client will automatically hook into the game to send/receive checks. <br>
 If the client ever loses connection to the game, it will also disconnect from the server and you will need to reconnect.<br> 
-`Make sure the game is open whenever you try to connect the client to the server otherwise it will immediately disconnect you.`<br>
+
+Make sure the game is open whenever you try to connect the client to the server otherwise it will immediately disconnect you.<br>
+
 Most checks will be sent to you anywhere outside a load or cutscene.<br>
-`If you obtain magic, you will need to pause your game to have it show up in your inventory, then enter a new room for it to become properly usable.`
+
+If you obtain magic, you will need to pause your game to have it show up in your inventory, then enter a new room for it to become properly usable.
 
 <h2 style="text-transform:none";>KH2 Client should look like this: </h2>
 
 ![image](https://i.imgur.com/qP6CmV8.png)
 
-Enter `The room's port number` into the top box <b> where the x's are</b> and press "Connect". Follow the prompts there and you should be connected
+Enter The room's port number into the top box <b> where the x's are</b> and press "Connect". Follow the prompts there and you should be connected
 
 <h2 style="text-transform:none";>Common Pitfalls</h2>
 
@@ -102,7 +114,7 @@ This pack will handle logic, received items, checked locations and autotabbing f
 - Why is my Client giving me a "Cannot Open Process: " error?
     - Due to how the client reads kingdom hearts 2 memory some people's computer flags it as a virus. Run the client as admin.
 - Why is my HP/MP continuously increasing without stopping?
-    - You do not have `JaredWeakStrike/APCompanion` set up correctly. Make sure it is above the `GoA ROM Mod` in the mod manager.
+    - You do not have `JaredWeakStrike/APCompanion` set up correctly. Make sure it is above the GoA ROM Edition Mod in the mod manager.
 - Why is my HP/MP continuously increasing without stopping when I have the APCompanion Mod?
     - You have a leftover GOA lua script in your `Documents\KINGDOM HEARTS HD 1.5+2.5 ReMIX\scripts\KH2`.
 - Why am I missing worlds/portals in the GoA?
@@ -110,9 +122,9 @@ This pack will handle logic, received items, checked locations and autotabbing f
 - Why did I not load into the correct visit?
     - You need to trigger a cutscene or visit The World That Never Was for it to register that you have received the item.
 - What versions of Kingdom Hearts 2 are supported?
-    - Currently the `only` supported versions are `Epic Games Version 1.0.0.9_WW` and `Steam Build Version 14716933`.
+    - Currently the only supported versions are Epic Games Version 1.0.0.10_WW and Steam Build Version 15194255.
 - Why am I getting wallpapered while going into a world for the first time?
-    - Your `Lua Backend` was not configured correctly. Look over the step in the [KH2Rando.com](https://tommadness.github.io/KH2Randomizer/setup/Panacea-ModLoader/) guide.
+    - Your Lua Backend was not configured correctly. Look over the step in the [KH2Rando.com](https://tommadness.github.io/KH2Randomizer/setup/Panacea-ModLoader/) guide.
 - Why am I not getting magic?
     - If you obtain magic, you will need to pause your game to have it show up in your inventory, then enter a new room for it to become properly usable.
 - Why did I crash after picking my dream weapon?
@@ -124,7 +136,7 @@ This pack will handle logic, received items, checked locations and autotabbing f
     - You will need to get the `JaredWeakStrike/APCompanion` (you can find how to get this if you scroll up)
 - Why am I not sending or receiving items?
     - Make sure you are connected to the KH2 client and the correct room (for more information scroll up)
-- Why should I install the auto save mod at `KH2FM-Mods-equations19/auto-save`?
-    - Because Kingdom Hearts 2 is prone to crashes and will keep you from losing your progress.
+- Why should I install the auto save mod at `KH2FM-Mods-equations19/auto-save` and `KH2FM-Mods-equations19/KH2-Lua-Library`?
+    - Because Kingdom Hearts 2 is prone to crashes and will keep you from losing your progress. Both mods are needed for auto save to work.
 - How do I load an auto save?
     - To load an auto-save, hold down the Select or your equivalent on your prefered controller while choosing a file. Make sure to hold the button down the whole time.

worlds/messenger/__init__.py

@@ -381,7 +381,7 @@ class MessengerWorld(World):
             return
         # the messenger client calls into AP with specific args, so check the out path matches what the client sends
         out_path = output_path(multiworld.get_out_file_name_base(1) + ".aptm")
-        if "The Messenger\\Archipelago\\output" not in out_path:
+        if "Messenger\\Archipelago\\output" not in out_path:
             return
         import orjson
         data = {

worlds/pokemon_rb/locations.py

@@ -749,8 +749,8 @@ location_data = [
     LocationData("Cinnabar Gym", "Super Nerd 2", None, rom_addresses["Trainersanity_EVENT_BEAT_CINNABAR_GYM_TRAINER_2_ITEM"], EventFlag(372), inclusion=trainersanity),
     LocationData("Cinnabar Gym", "Burglar 2", None, rom_addresses["Trainersanity_EVENT_BEAT_CINNABAR_GYM_TRAINER_3_ITEM"], EventFlag(371), inclusion=trainersanity),
     LocationData("Cinnabar Gym", "Super Nerd 3", None, rom_addresses["Trainersanity_EVENT_BEAT_CINNABAR_GYM_TRAINER_4_ITEM"], EventFlag(370), inclusion=trainersanity),
-    LocationData("Cinnabar Gym", "Super Nerd 4", None, rom_addresses["Trainersanity_EVENT_BEAT_CINNABAR_GYM_TRAINER_5_ITEM"], EventFlag(369), inclusion=trainersanity),
-    LocationData("Cinnabar Gym", "Super Nerd 5", None, rom_addresses["Trainersanity_EVENT_BEAT_CINNABAR_GYM_TRAINER_6_ITEM"], EventFlag(368), inclusion=trainersanity),
+    LocationData("Cinnabar Gym", "Burglar 3", None, rom_addresses["Trainersanity_EVENT_BEAT_CINNABAR_GYM_TRAINER_5_ITEM"], EventFlag(369), inclusion=trainersanity),
+    LocationData("Cinnabar Gym", "Super Nerd 4", None, rom_addresses["Trainersanity_EVENT_BEAT_CINNABAR_GYM_TRAINER_6_ITEM"], EventFlag(368), inclusion=trainersanity),
 
     LocationData("Celadon Prize Corner", "Item Prize 1", "TM23 Dragon Rage", rom_addresses["Prize_Item_A"], EventFlag(0x69a), inclusion=prizesanity),
     LocationData("Celadon Prize Corner", "Item Prize 2", "TM15 Hyper Beam", rom_addresses["Prize_Item_B"], EventFlag(0x69B), inclusion=prizesanity),

worlds/pokemon_rb/regions.py

@@ -1718,7 +1718,7 @@ def create_regions(world):
     connect(multiworld, player, "Vermilion City", "Vermilion City-Dock", lambda state: state.has("S.S. Ticket", player))
     connect(multiworld, player, "Vermilion City", "Route 11")
     connect(multiworld, player, "Route 12-N", "Route 12-S", lambda state: logic.can_surf(state, world, player))
-    connect(multiworld, player, "Route 12-W", "Route 11-E", lambda state: state.has("Poke Flute", player))
+    connect(multiworld, player, "Route 12-W", "Route 11-E")
     connect(multiworld, player, "Route 12-W", "Route 12-N", lambda state: state.has("Poke Flute", player))
     connect(multiworld, player, "Route 12-W", "Route 12-S", lambda state: state.has("Poke Flute", player))
     connect(multiworld, player, "Route 12-S", "Route 12-Grass", lambda state: logic.can_cut(state, world, player), one_way=True)

worlds/shivers/Items.py

@@ -13,7 +13,7 @@ class ItemType(enum.Enum):
     POT = "pot"
     POT_COMPLETE = "pot-complete"
     POT_DUPLICATE = "pot-duplicate"
-    POT_COMPELTE_DUPLICATE = "pot-complete-duplicate"
+    POT_COMPLETE_DUPLICATE = "pot-complete-duplicate"
     KEY = "key"
     KEY_OPTIONAL = "key-optional"
     ABILITY = "ability"
@@ -117,16 +117,16 @@ item_table = {
     "Lightning Pot Top DUPE": ItemData(None, ItemType.POT_DUPLICATE),
     "Sand Pot Top DUPE": ItemData(None, ItemType.POT_DUPLICATE),
     "Metal Pot Top DUPE": ItemData(None, ItemType.POT_DUPLICATE),
-    "Water Pot Complete DUPE": ItemData(None, ItemType.POT_COMPELTE_DUPLICATE),
-    "Wax Pot Complete DUPE": ItemData(None, ItemType.POT_COMPELTE_DUPLICATE),
-    "Ash Pot Complete DUPE": ItemData(None, ItemType.POT_COMPELTE_DUPLICATE),
-    "Oil Pot Complete DUPE": ItemData(None, ItemType.POT_COMPELTE_DUPLICATE),
-    "Cloth Pot Complete DUPE": ItemData(None, ItemType.POT_COMPELTE_DUPLICATE),
-    "Wood Pot Complete DUPE": ItemData(None, ItemType.POT_COMPELTE_DUPLICATE),
-    "Crystal Pot Complete DUPE": ItemData(None, ItemType.POT_COMPELTE_DUPLICATE),
-    "Lightning Pot Complete DUPE": ItemData(None, ItemType.POT_COMPELTE_DUPLICATE),
-    "Sand Pot Complete DUPE": ItemData(None, ItemType.POT_COMPELTE_DUPLICATE),
-    "Metal Pot Complete DUPE": ItemData(None, ItemType.POT_COMPELTE_DUPLICATE),
+    "Water Pot Complete DUPE": ItemData(None, ItemType.POT_COMPLETE_DUPLICATE),
+    "Wax Pot Complete DUPE": ItemData(None, ItemType.POT_COMPLETE_DUPLICATE),
+    "Ash Pot Complete DUPE": ItemData(None, ItemType.POT_COMPLETE_DUPLICATE),
+    "Oil Pot Complete DUPE": ItemData(None, ItemType.POT_COMPLETE_DUPLICATE),
+    "Cloth Pot Complete DUPE": ItemData(None, ItemType.POT_COMPLETE_DUPLICATE),
+    "Wood Pot Complete DUPE": ItemData(None, ItemType.POT_COMPLETE_DUPLICATE),
+    "Crystal Pot Complete DUPE": ItemData(None, ItemType.POT_COMPLETE_DUPLICATE),
+    "Lightning Pot Complete DUPE": ItemData(None, ItemType.POT_COMPLETE_DUPLICATE),
+    "Sand Pot Complete DUPE": ItemData(None, ItemType.POT_COMPLETE_DUPLICATE),
+    "Metal Pot Complete DUPE": ItemData(None, ItemType.POT_COMPLETE_DUPLICATE),
 
     # Filler
     "Empty": ItemData(None, ItemType.FILLER, ItemClassification.filler),

worlds/shivers/Options.py

@@ -1,7 +1,8 @@
 from dataclasses import dataclass
 
 from Options import (
-    Choice, DefaultOnToggle, ItemDict, ItemSet, LocationSet, OptionGroup, PerGameCommonOptions, Range, Toggle,
+    Choice, DefaultOnToggle, ExcludeLocations, LocalItems, NonLocalItems, OptionGroup, PerGameCommonOptions,
+    PriorityLocations, Range, StartHints, StartInventory, StartLocationHints, Toggle,
 )
 from . import ItemType, item_table
 from .Constants import location_info
@@ -109,6 +110,13 @@ class FullPots(Choice):
     option_mixed = 2
 
 
+class IxupiCapturesPriority(DefaultOnToggle):
+    """
+    Ixupi captures are set to priority locations. This forces a progression item into these locations if possible.
+    """
+    display_name = "Ixupi Captures are Priority"
+
+
 class PuzzleCollectBehavior(Choice):
     """
     Defines what happens to puzzles on collect.
@@ -129,53 +137,38 @@ valid_item_keys = [name for name, data in item_table.items() if data.type != Ite
 valid_location_keys = [name for name in location_info["all_locations"] if name != "Mystery Solved"]
 
 
-class LocalItems(ItemSet):
-    """Forces these items to be in their native world."""
-    display_name = "Local Items"
-    rich_text_doc = True
+class ShiversLocalItems(LocalItems):
+    __doc__ = LocalItems.__doc__
     valid_keys = valid_item_keys
 
 
-class NonLocalItems(ItemSet):
-    """Forces these items to be outside their native world."""
-    display_name = "Non-local Items"
-    rich_text_doc = True
+class ShiversNonLocalItems(NonLocalItems):
+    __doc__ = NonLocalItems.__doc__
     valid_keys = valid_item_keys
 
 
-class StartInventory(ItemDict):
-    """Start with these items."""
-    verify_item_name = True
-    display_name = "Start Inventory"
-    rich_text_doc = True
+class ShiversStartInventory(StartInventory):
+    __doc__ = StartInventory.__doc__
     valid_keys = valid_item_keys
 
 
-class StartHints(ItemSet):
-    """Start with these item's locations prefilled into the ``!hint`` command."""
-    display_name = "Start Hints"
-    rich_text_doc = True
+class ShiversStartHints(StartHints):
+    __doc__ = StartHints.__doc__
     valid_keys = valid_item_keys
 
 
-class StartLocationHints(LocationSet):
-    """Start with these locations and their item prefilled into the ``!hint`` command."""
-    display_name = "Start Location Hints"
-    rich_text_doc = True
+class ShiversStartLocationHints(StartLocationHints):
+    __doc__ = StartLocationHints.__doc__
     valid_keys = valid_location_keys
 
 
-class ExcludeLocations(LocationSet):
-    """Prevent these locations from having an important item."""
-    display_name = "Excluded Locations"
-    rich_text_doc = True
+class ShiversExcludeLocations(ExcludeLocations):
+    __doc__ = ExcludeLocations.__doc__
     valid_keys = valid_location_keys
 
 
-class PriorityLocations(LocationSet):
-    """Prevent these locations from having an unimportant item."""
-    display_name = "Priority Locations"
-    rich_text_doc = True
+class ShiversPriorityLocations(PriorityLocations):
+    __doc__ = PriorityLocations.__doc__
     valid_keys = valid_location_keys
 
 
@@ -191,24 +184,27 @@ class ShiversOptions(PerGameCommonOptions):
     early_lightning: EarlyLightning
     location_pot_pieces: LocationPotPieces
     full_pots: FullPots
+    ixupi_captures_priority: IxupiCapturesPriority
     puzzle_collect_behavior: PuzzleCollectBehavior
-    local_items: LocalItems
-    non_local_items: NonLocalItems
-    start_inventory: StartInventory
-    start_hints: StartHints
-    start_location_hints: StartLocationHints
-    exclude_locations: ExcludeLocations
-    priority_locations: PriorityLocations
+    local_items: ShiversLocalItems
+    non_local_items: ShiversNonLocalItems
+    start_inventory: ShiversStartInventory
+    start_hints: ShiversStartHints
+    start_location_hints: ShiversStartLocationHints
+    exclude_locations: ShiversExcludeLocations
+    priority_locations: ShiversPriorityLocations
 
 
 shivers_option_groups = [
-    OptionGroup("Item & Location Options", [
-        LocalItems,
-        NonLocalItems,
-        StartInventory,
-        StartHints,
-        StartLocationHints,
-        ExcludeLocations,
-        PriorityLocations
-    ], True),
+    OptionGroup(
+        "Item & Location Options", [
+            ShiversLocalItems,
+            ShiversNonLocalItems,
+            ShiversStartInventory,
+            ShiversStartHints,
+            ShiversStartLocationHints,
+            ShiversExcludeLocations,
+            ShiversPriorityLocations
+        ], True,
+    ),
 ]

worlds/shivers/__init__.py

@@ -16,7 +16,7 @@ class ShiversWeb(WebWorld):
         "English",
         "setup_en.md",
         "setup/en",
-        ["GodlFire", "Mathx2"]
+        ["GodlFire", "Cynbel_Terreus"]
     )]
     option_groups = shivers_option_groups
 
@@ -41,6 +41,20 @@ class ShiversWorld(World):
     def generate_early(self):
         self.pot_completed_list = []
 
+        # Pot piece shuffle location:
+        if self.options.location_pot_pieces == "own_world":
+            self.options.local_items.value |= {name for name, data in item_table.items() if
+                                               data.type in [ItemType.POT, ItemType.POT_COMPLETE]}
+        elif self.options.location_pot_pieces == "different_world":
+            self.options.non_local_items.value |= {name for name, data in item_table.items() if
+                                                   data.type in [ItemType.POT, ItemType.POT_COMPLETE]}
+
+        # Ixupi captures priority locations:
+        if self.options.ixupi_captures_priority:
+            self.options.priority_locations.value |= (
+                {name for name in self.location_names if name.startswith('Ixupi Captured')}
+            )
+
     def create_item(self, name: str) -> Item:
         data = item_table[name]
         return ShiversItem(name, data.classification, data.code, self.player)
@@ -194,14 +208,6 @@ class ShiversWorld(World):
             ["Heal", "Easier Lyre"], weights=[95, 5], k=filler_needed
         ))
 
-        # Pot piece shuffle location:
-        if self.options.location_pot_pieces == "own_world":
-            self.options.local_items.value |= {name for name, data in item_table.items() if
-                                               data.type in [ItemType.POT, ItemType.POT_COMPLETE]}
-        elif self.options.location_pot_pieces == "different_world":
-            self.options.non_local_items.value |= {name for name, data in item_table.items() if
-                                                   data.type in [ItemType.POT, ItemType.POT_COMPLETE]}
-
         self.multiworld.itempool += item_pool
 
     def pre_fill(self) -> None:
@@ -220,13 +226,13 @@ class ShiversWorld(World):
                               data.type == ItemType.POT_DUPLICATE]
         elif self.options.full_pots == "complete":
             storage_items += [self.create_item(name) for name, data in item_table.items() if
-                              data.type == ItemType.POT_COMPELTE_DUPLICATE]
+                              data.type == ItemType.POT_COMPLETE_DUPLICATE]
             storage_items += [self.create_item("Empty") for _ in range(10)]
         else:
             pieces = [self.create_item(name) for name, data in item_table.items() if
                       data.type == ItemType.POT_DUPLICATE]
             complete = [self.create_item(name) for name, data in item_table.items() if
-                        data.type == ItemType.POT_COMPELTE_DUPLICATE]
+                        data.type == ItemType.POT_COMPLETE_DUPLICATE]
             for i in range(10):
                 # Pieces
                 if self.pot_completed_list[i] == 0:

worlds/shivers/docs/setup_en.md

@@ -7,6 +7,11 @@
 - [ScummVM](https://www.scummvm.org/downloads/) version 2.7.0 or later
 - [Shivers Randomizer](https://github.com/GodlFire/Shivers-Randomizer-CSharp/releases/latest) Latest release version
 
+## Optional Software
+
+- [PopTracker](https://github.com/black-sliver/PopTracker/releases/)
+  - [Jax's Shivers PopTracker pack](https://github.com/blazik-barth/Shivers-Tracker/releases/)
+
 ## Setup ScummVM for Shivers
 
 ### GOG version of Shivers
@@ -57,4 +62,4 @@ validator page: [YAML Validation page](/mysterycheck)
 - Every puzzle
 - Every puzzle hint/solution
 - Every document that is considered a Flashback
-- Optionally information plaques.
+- Optionally information plaques

worlds/sm/Rom.py

@@ -4,18 +4,59 @@ import os
 import json
 import Utils
 from Utils import read_snes_rom
-from worlds.Files import APDeltaPatch
+from worlds.Files import APPatchExtension, APProcedurePatch, APTokenMixin, APTokenTypes
 from .variaRandomizer.utils.utils import openFile
 
 SMJUHASH = '21f3e98df4780ee1c667b84e57d88675'
 SM_ROM_MAX_PLAYERID = 65535
 SM_ROM_PLAYERDATA_COUNT = 202
 
-class SMDeltaPatch(APDeltaPatch):
+class SMPatchExtensions(APPatchExtension):
+    game = "Super Metroid"
+
+    @staticmethod
+    def write_crc(caller: APProcedurePatch, rom: bytes) -> bytes:
+        def checksum_mirror_sum(start, length, mask = 0x800000):
+            while not(length & mask) and mask:
+                mask >>= 1
+
+            part1 = sum(start[:mask]) & 0xFFFF
+            part2 = 0
+
+            next_length = length - mask
+            if next_length:
+                part2 = checksum_mirror_sum(start[mask:], next_length, mask >> 1)
+
+                while (next_length < mask):
+                    next_length += next_length
+                    part2 += part2
+
+            return (part1 + part2) & 0xFFFF
+
+        def write_bytes(buffer, startaddress: int, values):
+            buffer[startaddress:startaddress + len(values)] = values
+
+        buffer = bytearray(rom)
+        crc = checksum_mirror_sum(buffer, len(buffer))
+        inv = crc ^ 0xFFFF
+        write_bytes(buffer, 0x7FDC, [inv & 0xFF, (inv >> 8) & 0xFF, crc & 0xFF, (crc >> 8) & 0xFF])
+        return bytes(buffer)
+
+class SMProcedurePatch(APProcedurePatch, APTokenMixin):
     hash = SMJUHASH
     game = "Super Metroid"
     patch_file_ending = ".apsm"
 
+    procedure = [
+        ("apply_tokens", ["token_data.bin"]),
+        ("write_crc", [])
+    ]
+
+    def write_tokens(self, patches):
+        for addr, data in patches.items():
+            self.write_token(APTokenTypes.WRITE, addr, bytes(data))
+        self.write_file("token_data.bin", self.get_token_binary())
+
     @classmethod
     def get_source_data(cls) -> bytes:
         return get_base_rom_bytes()

worlds/sm/__init__.py

@@ -17,7 +17,7 @@ logger = logging.getLogger("Super Metroid")
 
 from .Options import SMOptions
 from .Client import SMSNIClient
-from .Rom import get_base_rom_path, SM_ROM_MAX_PLAYERID, SM_ROM_PLAYERDATA_COUNT, SMDeltaPatch, get_sm_symbols
+from .Rom import SM_ROM_MAX_PLAYERID, SM_ROM_PLAYERDATA_COUNT, SMProcedurePatch, get_sm_symbols
 import Utils
 
 from .variaRandomizer.logic.smboolmanager import SMBoolManager
@@ -40,7 +40,7 @@ class SMSettings(settings.Group):
         """File name of the v1.0 J rom"""
         description = "Super Metroid (JU) ROM"
         copy_to = "Super Metroid (JU).sfc"
-        md5s = [SMDeltaPatch.hash]
+        md5s = [SMProcedurePatch.hash]
 
     rom_file: RomFile = RomFile(RomFile.copy_to)
 
@@ -120,12 +120,6 @@ class SMWorld(World):
         self.locations = {}
         super().__init__(world, player)
 
-    @classmethod
-    def stage_assert_generate(cls, multiworld: MultiWorld):
-        rom_file = get_base_rom_path()
-        if not os.path.exists(rom_file):
-            raise FileNotFoundError(rom_file)
-
     def generate_early(self):
         Logic.factory('vanilla')
 
@@ -802,23 +796,19 @@ class SMWorld(World):
         romPatcher.end()
 
     def generate_output(self, output_directory: str):
-        self.variaRando.args.rom = get_base_rom_path()
-        outfilebase = self.multiworld.get_out_file_name_base(self.player)
-        outputFilename = os.path.join(output_directory, f"{outfilebase}.sfc")
-
         try:
-            self.variaRando.PatchRom(outputFilename, self.APPrePatchRom, self.APPostPatchRom)
-            self.write_crc(outputFilename)
+            patcher = self.variaRando.PatchRom(self.APPrePatchRom, self.APPostPatchRom)
             self.rom_name = self.romName
+
+            patch = SMProcedurePatch(player=self.player, player_name=self.multiworld.player_name[self.player])
+            patch.write_tokens(patcher.romFile.getPatchDict())
+            rom_path = os.path.join(output_directory, f"{self.multiworld.get_out_file_name_base(self.player)}"
+                                                      f"{patch.patch_file_ending}")
+            patch.write(rom_path)
+            
         except:
             raise
-        else:
-            patch = SMDeltaPatch(os.path.splitext(outputFilename)[0] + SMDeltaPatch.patch_file_ending, player=self.player,
-                                 player_name=self.multiworld.player_name[self.player], patched_path=outputFilename)
-            patch.write()
         finally:
-            if os.path.exists(outputFilename):
-                os.unlink(outputFilename)
             self.rom_name_available_event.set()  # make sure threading continues and errors are collected
 
     def checksum_mirror_sum(self, start, length, mask = 0x800000):

worlds/sm/variaRandomizer/randomizer.py

@@ -680,7 +680,7 @@ class VariaRandomizer:
             #dumpErrorMsg(args.output, self.randoExec.errorMsg)
             raise Exception("Can't generate " + self.fileName + " with the given parameters: {}".format(self.randoExec.errorMsg))
 
-    def PatchRom(self, outputFilename, customPrePatchApply = None, customPostPatchApply = None):
+    def PatchRom(self, customPrePatchApply = None, customPostPatchApply = None) -> RomPatcher:
         args = self.args
         optErrMsgs = self.optErrMsgs
 
@@ -758,9 +758,9 @@ class VariaRandomizer:
             # args.output is not None: generate local json named args.output
             if args.rom is not None:
                 # patch local rom
-                romFileName = args.rom
-                shutil.copyfile(romFileName, outputFilename)
-                romPatcher = RomPatcher(settings=patcherSettings, romFileName=outputFilename, magic=args.raceMagic, player=self.player)
+                # romFileName = args.rom
+                # shutil.copyfile(romFileName, outputFilename)
+                romPatcher = RomPatcher(settings=patcherSettings, magic=args.raceMagic, player=self.player)
             else:
                 romPatcher = RomPatcher(settings=patcherSettings, magic=args.raceMagic)
 
@@ -779,24 +779,12 @@ class VariaRandomizer:
                 #msg = randoExec.errorMsg
                 msg = ''
 
-            if args.rom is None: # web mode
-                data = romPatcher.romFile.data
-                self.fileName = '{}.sfc'.format(self.fileName)
-                data["fileName"] = self.fileName
-                # error msg in json to be displayed by the web site
-                data["errorMsg"] = msg
-                # replaced parameters to update stats in database
-                if len(self.forcedArgs) > 0:
-                    data["forcedArgs"] = self.forcedArgs
-                with open(outputFilename, 'w') as jsonFile:
-                    json.dump(data, jsonFile)
-            else: # CLI mode
-                if msg != "":
-                    print(msg)
+            return romPatcher
+
         except Exception as e:
             import traceback
             traceback.print_exc(file=sys.stdout)
-            raise Exception("Error patching {}: ({}: {})".format(outputFilename, type(e).__name__, e))
+            raise Exception("Error patching: ({}: {})".format(type(e).__name__, e))
             #dumpErrorMsg(args.output, msg)
 
 #        if stuck == True:

worlds/sm/variaRandomizer/rom/ips.py

@@ -21,10 +21,23 @@ class IPS_Patch(object):
     def toDict(self):
         ret = {}
         for record in self.records:
-            if 'rle_count' in record:
-                ret[record['address']] = [int.from_bytes(record['data'],'little')]*record['rle_count']
+            if record['address'] in ret.keys():
+                if 'rle_count' in record:
+                    if len(ret[record['address']]) > record['rle_count']:
+                        ret[record['address']][:record['rle_count']] = [int.from_bytes(record['data'],'little')]*record['rle_count']
+                    else:
+                        ret[record['address']] = [int.from_bytes(record['data'],'little')]*record['rle_count']
+                else:
+                    size = len(record['data'])
+                    if len(ret[record['address']]) > size:
+                        ret[record['address']][:size] = [int(b) for b in record['data']]  
+                    else:
+                        ret[record['address']] = [int(b) for b in record['data']]            
             else:
-                ret[record['address']] = [int(b) for b in record['data']]
+                if 'rle_count' in record:
+                    ret[record['address']] = [int.from_bytes(record['data'],'little')]*record['rle_count']
+                else:
+                    ret[record['address']] = [int(b) for b in record['data']]
         return ret
 
     @staticmethod

worlds/sm/variaRandomizer/rom/rom.py

@@ -86,7 +86,67 @@ class ROM(object):
             self.seek(self.maxAddress + BANK_SIZE - off - 1)
             self.writeByte(0xff)
         assert (self.maxAddress % BANK_SIZE) == 0
-        
+
+class FakeROM(ROM):
+    # to have the same code for real ROM and the webservice
+    def __init__(self, data={}):
+        super(FakeROM, self).__init__()
+        self.data = data
+        self.ipsPatches = []
+
+    def write(self, bytes):
+        for byte in bytes:
+            self.data[self.address] = byte
+            self.inc()
+
+    def read(self, byteCount):
+        bytes = []
+        for i in range(byteCount):
+            bytes.append(self.data[self.address])
+            self.inc()
+
+        return bytes
+
+    def ipsPatch(self, ipsPatches):
+        self.ipsPatches += ipsPatches
+
+    # generate ips from self data
+    def ips(self):
+        groupedData = {}
+        startAddress = -1
+        prevAddress = -1
+        curData = []
+        for address in sorted(self.data):
+            if address == prevAddress + 1:
+                curData.append(self.data[address])
+                prevAddress = address
+            else:
+                if len(curData) > 0:
+                    groupedData[startAddress] = curData
+                startAddress = address
+                prevAddress = address
+                curData = [self.data[startAddress]]
+        if startAddress != -1:
+            groupedData[startAddress] = curData
+
+        return IPS_Patch(groupedData)
+
+    # generate final IPS for web patching with first the IPS patches, then written data
+    def close(self):
+        self.mergedIPS = IPS_Patch()
+        for ips in self.ipsPatches:
+            self.mergedIPS.append(ips)
+        self.mergedIPS.append(self.ips())
+        #patchData = mergedIPS.encode()
+        #self.data = {}
+        #self.data["ips"] = base64.b64encode(patchData).decode()
+        #if mergedIPS.truncate_length is not None:
+        #    self.data["truncate_length"] = mergedIPS.truncate_length
+        #self.data["max_size"] = mergedIPS.max_size
+
+    def getPatchDict(self):
+        return self.mergedIPS.toDict()
+                
 class RealROM(ROM):
     def __init__(self, name):
         super(RealROM, self).__init__()

worlds/sm/variaRandomizer/rom/rompatcher.py

@@ -7,7 +7,7 @@ from ..utils.doorsmanager import DoorsManager, IndicatorFlag
 from ..utils.objectives import Objectives
 from ..graph.graph_utils import GraphUtils, getAccessPoint, locIdsByAreaAddresses, graphAreas
 from ..logic.logic import Logic
-from ..rom.rom import RealROM, snes_to_pc, pc_to_snes
+from ..rom.rom import FakeROM, snes_to_pc, pc_to_snes
 from ..rom.addresses import Addresses
 from ..rom.rom_patches import RomPatches
 from ..patches.patchaccess import PatchAccess
@@ -52,10 +52,10 @@ class RomPatcher:
     def __init__(self, settings=None, romFileName=None, magic=None, player=0):
         self.log = log.get('RomPatcher')
         self.settings = settings
-        self.romFileName = romFileName
+        #self.romFileName = romFileName
         self.patchAccess = PatchAccess()
         self.race = None
-        self.romFile = RealROM(romFileName)
+        self.romFile = FakeROM()
         #if magic is not None:
         #    from rom.race_mode import RaceModePatcher
         #    self.race = RaceModePatcher(self, magic)
@@ -312,7 +312,7 @@ class RomPatcher:
             self.applyStartAP(self.settings["startLocation"], plms, doors)
             self.applyPLMs(plms)
         except Exception as e:
-            raise Exception("Error patching {}. ({})".format(self.romFileName, e))
+            raise Exception("Error patching. ({})".format(e))
 
     def applyIPSPatch(self, patchName, patchDict=None, ipsDir=None):
         if patchDict is None:
@@ -493,6 +493,7 @@ class RomPatcher:
 
     def commitIPS(self):
         self.romFile.ipsPatch(self.ipsPatches)
+        self.ipsPatches = []
 
     def writeSeed(self, seed):
         random.seed(seed)

worlds/stardew_valley/options/options.py

@@ -772,6 +772,7 @@ if 'unittest' in sys.modules.keys() or 'pytest' in sys.modules.keys():
 
 class Mods(OptionSet):
     """List of mods that will be included in the shuffling."""
+    visibility = Visibility.all & ~Visibility.simple_ui
     internal_name = "mods"
     display_name = "Mods"
     valid_keys = {ModNames.deepwoods, ModNames.tractor, ModNames.big_backpack,

worlds/subnautica/__init__.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import logging
 import itertools
 from typing import List, Dict, Any, cast
 
@@ -10,13 +9,11 @@ from . import items
 from . import locations
 from . import creatures
 from . import options
-from .items import item_table, group_items, items_by_type, ItemType
+from .items import item_table, group_items
 from .rules import set_rules
 
-logger = logging.getLogger("Subnautica")
 
-
-class SubnaticaWeb(WebWorld):
+class SubnauticaWeb(WebWorld):
     tutorials = [Tutorial(
         "Multiworld Setup Guide",
         "A guide to setting up the Subnautica randomizer connected to an Archipelago Multiworld",
@@ -38,7 +35,7 @@ class SubnauticaWorld(World):
     You must find a cure for yourself, build an escape rocket, and leave the planet.
     """
     game = "Subnautica"
-    web = SubnaticaWeb()
+    web = SubnauticaWeb()
 
     item_name_to_id = {data.name: item_id for item_id, data in items.item_table.items()}
     location_name_to_id = all_locations

worlds/tunic/__init__.py

@@ -90,6 +90,10 @@ class TunicWorld(World):
     item_link_locations: Dict[int, Dict[str, List[Tuple[int, str]]]] = {}
     player_item_link_locations: Dict[str, List[Location]]
 
+    using_ut: bool  # so we can check if we're using UT only once
+    passthrough: Dict[str, Any]
+    ut_can_gen_without_yaml = True  # class var that tells it to ignore the player yaml
+
     def generate_early(self) -> None:
         if self.options.logic_rules >= LogicRules.option_no_major_glitches:
             self.options.laurels_zips.value = LaurelsZips.option_true
@@ -113,23 +117,28 @@ class TunicWorld(World):
         # Universal tracker stuff, shouldn't do anything in standard gen
         if hasattr(self.multiworld, "re_gen_passthrough"):
             if "TUNIC" in self.multiworld.re_gen_passthrough:
-                passthrough = self.multiworld.re_gen_passthrough["TUNIC"]
-                self.options.start_with_sword.value = passthrough["start_with_sword"]
-                self.options.keys_behind_bosses.value = passthrough["keys_behind_bosses"]
-                self.options.sword_progression.value = passthrough["sword_progression"]
-                self.options.ability_shuffling.value = passthrough["ability_shuffling"]
-                self.options.laurels_zips.value = passthrough["laurels_zips"]
-                self.options.ice_grappling.value = passthrough["ice_grappling"]
-                self.options.ladder_storage.value = passthrough["ladder_storage"]
-                self.options.ladder_storage_without_items = passthrough["ladder_storage_without_items"]
-                self.options.lanternless.value = passthrough["lanternless"]
-                self.options.maskless.value = passthrough["maskless"]
-                self.options.hexagon_quest.value = passthrough["hexagon_quest"]
-                self.options.entrance_rando.value = passthrough["entrance_rando"]
-                self.options.shuffle_ladders.value = passthrough["shuffle_ladders"]
+                self.using_ut = True
+                self.passthrough = self.multiworld.re_gen_passthrough["TUNIC"]
+                self.options.start_with_sword.value = self.passthrough["start_with_sword"]
+                self.options.keys_behind_bosses.value = self.passthrough["keys_behind_bosses"]
+                self.options.sword_progression.value = self.passthrough["sword_progression"]
+                self.options.ability_shuffling.value = self.passthrough["ability_shuffling"]
+                self.options.laurels_zips.value = self.passthrough["laurels_zips"]
+                self.options.ice_grappling.value = self.passthrough["ice_grappling"]
+                self.options.ladder_storage.value = self.passthrough["ladder_storage"]
+                self.options.ladder_storage_without_items = self.passthrough["ladder_storage_without_items"]
+                self.options.lanternless.value = self.passthrough["lanternless"]
+                self.options.maskless.value = self.passthrough["maskless"]
+                self.options.hexagon_quest.value = self.passthrough["hexagon_quest"]
+                self.options.entrance_rando.value = self.passthrough["entrance_rando"]
+                self.options.shuffle_ladders.value = self.passthrough["shuffle_ladders"]
                 self.options.fixed_shop.value = self.options.fixed_shop.option_false
                 self.options.laurels_location.value = self.options.laurels_location.option_anywhere
-                self.options.combat_logic.value = passthrough["combat_logic"]
+                self.options.combat_logic.value = self.passthrough["combat_logic"]
+            else:
+                self.using_ut = False
+        else:
+            self.using_ut = False
 
     @classmethod
     def stage_generate_early(cls, multiworld: MultiWorld) -> None:
@@ -284,12 +293,14 @@ class TunicWorld(World):
 
             remove_filler(items_to_create[gold_hexagon])
 
-            for hero_relic in item_name_groups["Hero Relics"]:
+            # Sort for deterministic order
+            for hero_relic in sorted(item_name_groups["Hero Relics"]):
                 tunic_items.append(self.create_item(hero_relic, ItemClassification.useful))
                 items_to_create[hero_relic] = 0
 
         if not self.options.ability_shuffling:
-            for page in item_name_groups["Abilities"]:
+            # Sort for deterministic order
+            for page in sorted(item_name_groups["Abilities"]):
                 if items_to_create[page] > 0:
                     tunic_items.append(self.create_item(page, ItemClassification.useful))
                     items_to_create[page] = 0
@@ -329,12 +340,10 @@ class TunicWorld(World):
         self.ability_unlocks = randomize_ability_unlocks(self.random, self.options)
 
         # stuff for universal tracker support, can be ignored for standard gen
-        if hasattr(self.multiworld, "re_gen_passthrough"):
-            if "TUNIC" in self.multiworld.re_gen_passthrough:
-                passthrough = self.multiworld.re_gen_passthrough["TUNIC"]
-                self.ability_unlocks["Pages 24-25 (Prayer)"] = passthrough["Hexagon Quest Prayer"]
-                self.ability_unlocks["Pages 42-43 (Holy Cross)"] = passthrough["Hexagon Quest Holy Cross"]
-                self.ability_unlocks["Pages 52-53 (Icebolt)"] = passthrough["Hexagon Quest Icebolt"]
+        if self.using_ut:
+            self.ability_unlocks["Pages 24-25 (Prayer)"] = self.passthrough["Hexagon Quest Prayer"]
+            self.ability_unlocks["Pages 42-43 (Holy Cross)"] = self.passthrough["Hexagon Quest Holy Cross"]
+            self.ability_unlocks["Pages 52-53 (Icebolt)"] = self.passthrough["Hexagon Quest Icebolt"]
 
         # Ladders and Combat Logic uses ER rules with vanilla connections for easier maintenance
         if self.options.entrance_rando or self.options.shuffle_ladders or self.options.combat_logic:

worlds/tunic/er_rules.py

@@ -1675,7 +1675,7 @@ def set_er_location_rules(world: "TunicWorld") -> None:
 
     # Beneath the Vault
     set_rule(world.get_location("Beneath the Fortress - Bridge"),
-             lambda state: has_melee(state, player) or state.has_any({laurels, fire_wand}, player))
+             lambda state: has_melee(state, player) or state.has_any((laurels, fire_wand, ice_dagger, gun), player))
 
     # Quarry
     set_rule(world.get_location("Quarry - [Central] Above Ladder Dash Chest"),

worlds/tunic/er_scripts.py

@@ -177,7 +177,7 @@ def pair_portals(world: "TunicWorld", regions: Dict[str, Region]) -> Dict[Portal
     logic_tricks: Tuple[bool, int, int] = (laurels_zips, ice_grappling, ladder_storage)
 
     # marking that you don't immediately have laurels
-    if laurels_location == "10_fairies" and not hasattr(world.multiworld, "re_gen_passthrough"):
+    if laurels_location == "10_fairies" and not world.using_ut:
         has_laurels = False
 
     shop_count = 6
@@ -191,9 +191,8 @@ def pair_portals(world: "TunicWorld", regions: Dict[str, Region]) -> Dict[Portal
                 break
 
     # If using Universal Tracker, restore portal_map. Could be cleaner, but it does not matter for UT even a little bit
-    if hasattr(world.multiworld, "re_gen_passthrough"):
-        if "TUNIC" in world.multiworld.re_gen_passthrough:
-            portal_map = portal_mapping.copy()
+    if world.using_ut:
+        portal_map = portal_mapping.copy()
 
     # create separate lists for dead ends and non-dead ends
     for portal in portal_map:
@@ -232,25 +231,24 @@ def pair_portals(world: "TunicWorld", regions: Dict[str, Region]) -> Dict[Portal
         plando_connections = world.seed_groups[world.options.entrance_rando.value]["plando"]
 
     # universal tracker support stuff, don't need to care about region dependency
-    if hasattr(world.multiworld, "re_gen_passthrough"):
-        if "TUNIC" in world.multiworld.re_gen_passthrough:
-            plando_connections.clear()
-            # universal tracker stuff, won't do anything in normal gen
-            for portal1, portal2 in world.multiworld.re_gen_passthrough["TUNIC"]["Entrance Rando"].items():
-                portal_name1 = ""
-                portal_name2 = ""
+    if world.using_ut:
+        plando_connections.clear()
+        # universal tracker stuff, won't do anything in normal gen
+        for portal1, portal2 in world.passthrough["Entrance Rando"].items():
+            portal_name1 = ""
+            portal_name2 = ""
 
-                for portal in portal_mapping:
-                    if portal.scene_destination() == portal1:
-                        portal_name1 = portal.name
-                        # connected_regions.update(add_dependent_regions(portal.region, logic_rules))
-                    if portal.scene_destination() == portal2:
-                        portal_name2 = portal.name
-                        # connected_regions.update(add_dependent_regions(portal.region, logic_rules))
-                # shops have special handling
-                if not portal_name2 and portal2 == "Shop, Previous Region_":
-                    portal_name2 = "Shop Portal"
-                plando_connections.append(PlandoConnection(portal_name1, portal_name2, "both"))
+            for portal in portal_mapping:
+                if portal.scene_destination() == portal1:
+                    portal_name1 = portal.name
+                    # connected_regions.update(add_dependent_regions(portal.region, logic_rules))
+                if portal.scene_destination() == portal2:
+                    portal_name2 = portal.name
+                    # connected_regions.update(add_dependent_regions(portal.region, logic_rules))
+            # shops have special handling
+            if not portal_name2 and portal2 == "Shop, Previous Region_":
+                portal_name2 = "Shop Portal"
+            plando_connections.append(PlandoConnection(portal_name1, portal_name2, "both"))
 
     non_dead_end_regions = set()
     for region_name, region_info in world.er_regions.items():
@@ -362,7 +360,7 @@ def pair_portals(world: "TunicWorld", regions: Dict[str, Region]) -> Dict[Portal
         # if we have plando connections, our connected regions may change somewhat
         connected_regions = update_reachable_regions(connected_regions, traversal_reqs, has_laurels, logic_tricks)
 
-    if fixed_shop and not hasattr(world.multiworld, "re_gen_passthrough"):
+    if fixed_shop and not world.using_ut:
         portal1 = None
         for portal in two_plus:
             if portal.scene_destination() == "Overworld Redux, Windmill_":
@@ -392,7 +390,7 @@ def pair_portals(world: "TunicWorld", regions: Dict[str, Region]) -> Dict[Portal
     fail_count = 0
     while len(connected_regions) < len(non_dead_end_regions):
         # if this is universal tracker, just break immediately and move on
-        if hasattr(world.multiworld, "re_gen_passthrough"):
+        if world.using_ut:
             break
         # if the connected regions length stays unchanged for too long, it's stuck in a loop
         # should, hopefully, only ever occur if someone plandos connections poorly
@@ -445,9 +443,8 @@ def pair_portals(world: "TunicWorld", regions: Dict[str, Region]) -> Dict[Portal
             random_object.shuffle(two_plus)
 
     # for universal tracker, we want to skip shop gen
-    if hasattr(world.multiworld, "re_gen_passthrough"):
-        if "TUNIC" in world.multiworld.re_gen_passthrough:
-            shop_count = 0
+    if world.using_ut:
+        shop_count = 0
     
     for i in range(shop_count):
         portal1 = two_plus.pop()
@@ -462,7 +459,7 @@ def pair_portals(world: "TunicWorld", regions: Dict[str, Region]) -> Dict[Portal
     # connect dead ends to random non-dead ends
     # none of the key events are in dead ends, so we don't need to do gate_before_switch
     while len(dead_ends) > 0:
-        if hasattr(world.multiworld, "re_gen_passthrough"):
+        if world.using_ut:
             break
         portal1 = two_plus.pop()
         portal2 = dead_ends.pop()
@@ -470,7 +467,7 @@ def pair_portals(world: "TunicWorld", regions: Dict[str, Region]) -> Dict[Portal
     # then randomly connect the remaining portals to each other
     # every region is accessible, so gate_before_switch is not necessary
     while len(two_plus) > 1:
-        if hasattr(world.multiworld, "re_gen_passthrough"):
+        if world.using_ut:
             break
         portal1 = two_plus.pop()
         portal2 = two_plus.pop()

worlds/tunic/rules.py

@@ -323,7 +323,7 @@ def set_location_rules(world: "TunicWorld") -> None:
 
     # Beneath the Vault
     set_rule(world.get_location("Beneath the Fortress - Bridge"),
-             lambda state: has_melee(state, player) or state.has_any({laurels, fire_wand}, player))
+             lambda state: has_melee(state, player) or state.has_any((laurels, fire_wand, ice_dagger, gun), player))
     set_rule(world.get_location("Beneath the Fortress - Obscured Behind Waterfall"),
              lambda state: has_melee(state, player) and has_lantern(state, world))
 

worlds/witness/data/static_logic.py

@@ -106,6 +106,7 @@ class StaticWitnessLogicObj:
                     "entityType": location_id,
                     "locationType": None,
                     "area": current_area,
+                    "order": len(self.ENTITIES_BY_HEX),
                 }
 
                 self.ENTITIES_BY_NAME[self.ENTITIES_BY_HEX[entity_hex]["checkName"]] = self.ENTITIES_BY_HEX[entity_hex]
@@ -186,6 +187,7 @@ class StaticWitnessLogicObj:
                 "entityType": entity_type,
                 "locationType": location_type,
                 "area": current_area,
+                "order": len(self.ENTITIES_BY_HEX),
             }
 
             self.ENTITY_ID_TO_NAME[entity_hex] = full_entity_name

worlds/witness/regions.py

@@ -114,7 +114,7 @@ class WitnessPlayerRegions:
             if k not in player_logic.UNREACHABLE_REGIONS
         }
 
-        event_locations_per_region = defaultdict(list)
+        event_locations_per_region = defaultdict(dict)
 
         for event_location, event_item_and_entity in player_logic.EVENT_ITEM_PAIRS.items():
             region = static_witness_logic.ENTITIES_BY_HEX[event_item_and_entity[1]]["region"]
@@ -122,20 +122,33 @@ class WitnessPlayerRegions:
                 region_name = "Entry"
             else:
                 region_name = region["name"]
-            event_locations_per_region[region_name].append(event_location)
+            order = self.reference_logic.ENTITIES_BY_HEX[event_item_and_entity[1]]["order"]
+            event_locations_per_region[region_name][event_location] = order
 
         for region_name, region in regions_to_create.items():
-            locations_for_this_region = [
-                self.reference_logic.ENTITIES_BY_HEX[panel]["checkName"] for panel in region["entities"]
-                if self.reference_logic.ENTITIES_BY_HEX[panel]["checkName"]
-                in self.player_locations.CHECK_LOCATION_TABLE
+            location_entities_for_this_region = [
+                self.reference_logic.ENTITIES_BY_HEX[entity] for entity in region["entities"]
             ]
+            locations_for_this_region = {
+                entity["checkName"]: entity["order"] for entity in location_entities_for_this_region
+                if entity["checkName"] in self.player_locations.CHECK_LOCATION_TABLE
+            }
 
-            locations_for_this_region += event_locations_per_region[region_name]
+            events = event_locations_per_region[region_name]
+            locations_for_this_region.update(events)
+
+            # First, sort by keys.
+            locations_for_this_region = dict(sorted(locations_for_this_region.items()))
+
+            # Then, sort by game order (values)
+            locations_for_this_region = dict(sorted(
+                locations_for_this_region.items(),
+                key=lambda location_name_and_order: location_name_and_order[1]
+            ))
 
             all_locations = all_locations | set(locations_for_this_region)
 
-            new_region = create_region(world, region_name, self.player_locations, locations_for_this_region)
+            new_region = create_region(world, region_name, self.player_locations, list(locations_for_this_region))
 
             regions_by_name[region_name] = new_region
 

worlds/zork_grand_inquisitor/world.py

@@ -176,7 +176,7 @@ class ZorkGrandInquisitorWorld(World):
 
         if start_with_hotspot_items:
             item: ZorkGrandInquisitorItems
-            for item in items_with_tag(ZorkGrandInquisitorTags.HOTSPOT):
+            for item in sorted(items_with_tag(ZorkGrandInquisitorTags.HOTSPOT), key=lambda item: item.name):
                 self.multiworld.push_precollected(self.create_item(item.value))
 
     def create_item(self, name: str) -> ZorkGrandInquisitorItem: