Merge branch 'main' into docs_consolidation

# Conflicts:
#	WebHostLib/static/assets/tutorial/archipelago/plando_en.md
#	WebHostLib/static/assets/tutorial/zelda3/multiworld_en.md

BaseClasses.py

@@ -1210,8 +1210,6 @@ class Spoiler():
                 if self.world.players > 1:
                     outfile.write('\nPlayer %d: %s\n' % (player, self.world.get_player_name(player)))
                 outfile.write('Game:                            %s\n' % self.world.game[player])
-                for f_option, option in Options.common_options.items():
-                    write_option(f_option, option)
                 for f_option, option in Options.per_game_common_options.items():
                     write_option(f_option, option)
                 options = self.world.worlds[player].options

Fill.py

@@ -2,8 +2,10 @@ import logging
 import typing
 import collections
 import itertools
+from collections import Counter, deque
 
-from BaseClasses import CollectionState, Location, MultiWorld
+
+from BaseClasses import CollectionState, Location, MultiWorld, Item
 from worlds.generic import PlandoItem
 from worlds.AutoWorld import call_all
 
@@ -12,30 +14,35 @@ class FillError(RuntimeError):
     pass
 
 
-def fill_restrictive(world: MultiWorld, base_state: CollectionState, locations, itempool, single_player_placement=False,
-                     lock=False):
-    def sweep_from_pool():
-        new_state = base_state.copy()
-        for item in itempool:
-            new_state.collect(item, True)
-        new_state.sweep_for_events()
-        return new_state
+def sweep_from_pool(base_state: CollectionState, itempool):
+    new_state = base_state.copy()
+    for item in itempool:
+        new_state.collect(item, True)
+    new_state.sweep_for_events()
+    return new_state
 
+
+def fill_restrictive(world: MultiWorld, base_state: CollectionState, locations, itempool: typing.List[Item],
+                     single_player_placement=False, lock=False):
     unplaced_items = []
     placements = []
 
-    reachable_items = {}
+    swapped_items = Counter()
+    reachable_items: dict[str, deque] = {}
     for item in itempool:
-        reachable_items.setdefault(item.player, []).append(item)
+        reachable_items.setdefault(item.player, deque()).append(item)
 
     while any(reachable_items.values()) and locations:
-        items_to_place = [items.pop() for items in reachable_items.values() if items]  # grab one item per player
+        # grab one item per player
+        items_to_place = [items.pop()
+                          for items in reachable_items.values() if items]
         for item in items_to_place:
             itempool.remove(item)
-        maximum_exploration_state = sweep_from_pool()
+        maximum_exploration_state = sweep_from_pool(base_state, itempool)
         has_beaten_game = world.has_beaten_game(maximum_exploration_state)
 
         for item_to_place in items_to_place:
+            spot_to_fill: Location = 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
@@ -45,19 +52,48 @@ def fill_restrictive(world: MultiWorld, base_state: CollectionState, locations,
             for i, location in enumerate(locations):
                 if (not single_player_placement or location.player == item_to_place.player) \
                         and location.can_fill(maximum_exploration_state, item_to_place, perform_access_check):
-                    spot_to_fill = locations.pop(i) # poping by index is faster than removing by content,
+                    # poping by index is faster than removing by content,
+                    spot_to_fill = locations.pop(i)
                     # skipping a scan for the element
                     break
 
             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] != 'minimal' and world.can_beat_game():
-                    logging.warning(
-                        f'Not all items placed. Game beatable anyway. (Could not place {item_to_place})')
-                    continue
-                raise FillError(f'No more spots to place {item_to_place}, locations {locations} are invalid. '
-                                f'Already placed {len(placements)}: {", ".join(str(place) for place in placements)}')
+                # we filled all reachable spots.
+                # try swaping this item with previously placed items
+                for(i, location) in enumerate(placements):
+                    placed_item = location.item
+                    # Unplaceable items can sometimes be swapped infinitely. Limit the
+                    # number of times we will swap an individual item to prevent this
+                    if swapped_items[placed_item.player, placed_item.name] > 0:
+                        continue
+                    location.item = None
+                    placed_item.location = None
+                    swap_state = sweep_from_pool(base_state, itempool)
+                    if (not single_player_placement or location.player == item_to_place.player) \
+                            and location.can_fill(swap_state, item_to_place, perform_access_check):
+                        # Add this item to the exisiting placement, and
+                        # add the old item to the back of the queue
+                        spot_to_fill = placements.pop(i)
+                        swapped_items[placed_item.player,
+                                      placed_item.name] += 1
+                        reachable_items[placed_item.player].appendleft(
+                            placed_item)
+                        itempool.append(placed_item)
+                        break
+                    else:
+                        # Item can't be placed here, restore original item
+                        location.item = placed_item
+                        placed_item.location = location
+
+                if spot_to_fill == None:
+                    # Maybe the game can be beaten anyway?
+                    unplaced_items.append(item_to_place)
+                    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
+                    raise FillError(f'No more spots to place {item_to_place}, locations {locations} are invalid. '
+                                    f'Already placed {len(placements)}: {", ".join(str(place) for place in placements)}')
 
             world.push_item(spot_to_fill, item_to_place, False)
             spot_to_fill.locked = lock

Generate.py

@@ -469,7 +469,7 @@ def roll_settings(weights: dict, plando_options: typing.Set[str] = frozenset(("b
 
     ret = argparse.Namespace()
     for option_key in Options.per_game_common_options:
-        if option_key in weights:
+        if option_key in weights and option_key not in Options.common_options:
             raise Exception(f"Option {option_key} has to be in a game's section, not on its own.")
 
     ret.game = get_choice("game", weights)

Options.py

@@ -334,7 +334,7 @@ class Accessibility(Choice):
     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."""
-
+    displayname = "Accessibility"
     option_locations = 0
     option_items = 1
     option_minimal = 2
@@ -344,6 +344,7 @@ class Accessibility(Choice):
 
 class ProgressionBalancing(DefaultOnToggle):
     """A system that moves progression earlier, to try and prevent the player from getting stuck and bored early."""
+    displayname = "Progression Balancing"
 
 
 common_options = {
@@ -395,6 +396,7 @@ class DeathLink(Toggle):
 
 
 per_game_common_options = {
+    **common_options,  # can be overwritten per-game
     "local_items": LocalItems,
     "non_local_items": NonLocalItems,
     "start_inventory": StartInventory,

SNIClient.py

@@ -532,9 +532,9 @@ def launch_sni(ctx: Context):
         snes_logger.info(f"Attempting to start {sni_path}")
         import sys
         if not sys.stdout:  # if it spawns a visible console, may as well populate it
-            subprocess.Popen(sni_path, cwd=os.path.dirname(sni_path))
+            subprocess.Popen(os.path.abspath(sni_path), cwd=os.path.dirname(sni_path))
         else:
-            subprocess.Popen(sni_path, cwd=os.path.dirname(sni_path), stdout=subprocess.DEVNULL,
+            subprocess.Popen(os.path.abspath(sni_path), cwd=os.path.dirname(sni_path), stdout=subprocess.DEVNULL,
                              stderr=subprocess.DEVNULL)
     else:
         snes_logger.info(

Utils.py

@@ -23,7 +23,7 @@ class Version(typing.NamedTuple):
     build: int
 
 
-__version__ = "0.2.1"
+__version__ = "0.2.2"
 version_tuple = tuplize_version(__version__)
 
 from yaml import load, dump, safe_load

WebHostLib/options.py

@@ -11,6 +11,8 @@ target_folder = os.path.join("WebHostLib", "static", "generated")
 
 
 def create():
+    os.makedirs(os.path.join(target_folder, 'configs'), exist_ok=True)
+
     def dictify_range(option):
         data = {option.range_start: 0, option.range_end: 0, "random": 0, "random-low": 0, "random-high": 0,
                 option.default: 50}
@@ -25,15 +27,26 @@ def create():
             return list(default_value)
         return default_value
 
+    weighted_settings = {
+        "baseOptions": {
+            "description": "Generated by https://archipelago.gg/",
+            "name": "Player",
+            "game": {},
+        },
+        "games": {},
+    }
+
     for game_name, world in AutoWorldRegister.world_types.items():
+        if (world.hidden):
+            continue
+
+        all_options = {**world.options, **Options.per_game_common_options}
         res = Template(open(os.path.join("WebHostLib", "templates", "options.yaml")).read()).render(
-            options={**world.options, **Options.per_game_common_options},
+            options=all_options,
             __version__=__version__, game=game_name, yaml_dump=yaml.dump,
             dictify_range=dictify_range, default_converter=default_converter,
         )
 
-        os.makedirs(os.path.join(target_folder, 'configs'), exist_ok=True)
-
         with open(os.path.join(target_folder, 'configs', game_name + ".yaml"), "w") as f:
             f.write(res)
 
@@ -47,7 +60,7 @@ def create():
         }
 
         game_options = {}
-        for option_name, option in world.options.items():
+        for option_name, option in all_options.items():
             if option.options:
                 game_options[option_name] = this_option = {
                     "type": "select",
@@ -87,3 +100,11 @@ def create():
 
         with open(os.path.join(target_folder, 'player-settings', game_name + ".json"), "w") as f:
             f.write(json.dumps(player_settings, indent=2, separators=(',', ': ')))
+
+        weighted_settings["baseOptions"]["game"][game_name] = 0
+        weighted_settings["games"][game_name] = {}
+        weighted_settings["games"][game_name]["gameOptions"] = game_options
+        weighted_settings["games"][game_name]["gameItems"] = tuple(world.item_name_to_id.keys())
+
+    with open(os.path.join(target_folder, 'weighted-settings.json'), "w") as f:
+        f.write(json.dumps(weighted_settings, indent=2, separators=(',', ': ')))

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

@@ -1,109 +1,76 @@
 # Archipelago Plando Guide
 
-This guide details the use of the plando modules available with Archipelago. This guide is intended for a more advanced
-user who has more in-depth knowledge of the randomizer they're playing as well as experience editing YAML files. This
-guide should take about 10 minutes to read.
-
 ## What is Plando?
-
-The purposes of randomizers is to randomize the items in a game to give a new experience. Plando takes this concept and
-changes it up by allowing you to plan out certain aspects of the game by placing certain items in certain locations,
-certain bosses in certain rooms, edit text for certain NPCs/signs, or even force certain region connections. Each of
-these options are going to be detailed separately as `item plando`, `boss plando`, `text plando`,
-and `connection plando`. Every game in archipelago supports item plando but the other plando options are only supported
-by certain games. Currently, Minecraft and LTTP both support connection plando, but only LTTP supports text and boss
-plando.
+The purposes of randomizers is to randomize the items in a game to give a new experience.
+Plando takes this concept and changes it up by allowing you to plan out certain aspects of the game by placing certain 
+items in certain locations, certain bosses in certain rooms, edit text for certain NPCs/signs, or even force certain region
+connections. Each of these options are going to be detailed separately as `item plando`, `boss plando`, `text plando`, 
+and `connection plando`. Every game in archipelago supports item plando but the other plando options are only supported 
+by certain games. Currently, Minecraft and LTTP both support connection plando, but only LTTP supports text and boss plando.
 
 ### Enabling Plando
-
-On the website plando will already be enabled. If you will be generating the game locally plando features must be
-enabled manually (opt-in). To opt-in go to the archipelago installation directory (
-default: `C:\ProgramData\Archipelago`), open the host.yaml with a text editor and find the `plando_options` key. The
-available plando modules can be enabled by adding them after this such
-as `plando_options: bosses, items, texts, connections`.
+On the website plando will already be enabled. If you will be generating the game locally plando features must be enabled (opt-in).
+* To opt-in go to the archipelago installation (default: `C:\ProgramData\Archipelago`), open the host.yaml with a text
+editor and find the `plando_options` key. The available plando modules can be enabled by adding them after this such as
+`plando_options: bosses, items, texts, connections`.
 
 ## Item Plando
-
-Item plando allows a player to place an item in a specific location or specific locations, place multiple items into a
-list of specific locations both in their own game or in another player's game. **Note that there's a very good chance
-that cross-game plando could very well be broken i.e. placing on of your items in someone else's world playing a
-different game.**
-
-* The options for item plando are `from_pool`, `world`, `percentage`, `force`, and either item and location, or items
-  and locations.
-    * `from_pool` determines if the item should be taken *from* the item pool or *added* to it. This can be true or
-      false and defaults to true if omitted.
-    * `world` is the target world to place the item in.
-        * It gets ignored if only one world is generated.
-        * Can be a number, name, true, false, or null. False is the default.
-            * If a number is used it targets that slot or player number in the multiworld.
-            * If a name is used it will target the world with that player name.
-            * If set to true it will be any player's world besides your own.
-            * If set to false it will target your own world.
-            * If set to null it will target a random world in the multiworld.
-    * `force` determines whether the generator will fail if the item can't be placed in the location can be true, false,
-      or silent. Silent is the default.
-        * If set to true the item must be placed and the generator will throw an error if it is unable to do so.
-        * If set to false the generator will log a warning if the placement can't be done but will still generate.
-        * If set to silent and the placement fails it will be ignored entirely.
-    * `percentage` is the percentage chance for the relevant block to trigger. This can be any value from 0 to 100 and
-      if omitted will default to 100.
-    * Single Placement is when you use a plando block to place a single item at a single location.
-        * `item` is the item you would like to place and `location` is the location to place it.
-    * Multi Placement uses a plando block to place multiple items in multiple locations until either list is exhausted.
-        * `items` defines the items to use and a number letting you place multiple of it.
-        * `locations` is a list of possible locations those items can be placed in.
-        * Using the multi placement method, placements are picked randomly.
+Item plando allows a player to place an item in a specific location or specific locations, place multiple items into
+a list of specific locations both in their own game or in another player's game. **Note that there's a very good chance that
+cross-game plando could very well be broken i.e. placing on of your items in someone else's world playing a different game.**
+* The options for item plando are `from_pool`, `world`, `percentage`, `force`, and either item and location, or items and locations.
+  * `from_pool` determines if the item should be taken *from* the item pool or *added* to it. This can be true or false
+and defaults to true if omitted.
+  * `world` is the target world to place the item in.
+    * It gets ignored if only one world is generated.
+    * Can be a number, name, true, false, or null. False is the default.
+      * If a number is used it targets that slot or player number in the multiworld.
+      * If a name is used it will target the world with that player name.
+      * If set to true it will be any player's world besides your own.
+      * If set to false it will target your own world.
+      * If set to null it will target a random world in the multiworld.
+  * `force` determines whether the generator will fail if the item can't be placed in the location can be true, false, 
+or silent. Silent is the default.
+    * If set to true the item must be placed and the generator will throw an error if it is unable to do so.
+    * If set to false the generator will log a warning if the placement can't be done but will still generate.
+    * If set to silent and the placement fails it will be ignored entirely.
+  * `percentage` is the percentage chance for the relevant block to trigger. This can be any value from 0 to 100 and if 
+omitted will default to 100.
+  * Single Placement is when you use a plando block to place a single item at a single location.
+    * `item` is the item you would like to place and `location` is the location to place it.
+  * Multi Placement uses a plando block to place multiple items in multiple locations until either list is exhausted.
+    * `items` defines the items to use and a number letting you place multiple of it.
+    * `locations` is a list of possible locations those items can be placed in.
+    * Using the multi placement method, placements are picked randomly.
 
 ### Available Items
-
-* A Link to the
-  Past: [Link to the Past Item List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Items.py#L52)
-* Factorio Non-Progressive: [Factorio Technologies Wiki List](https://wiki.factorio.com/Technologies)
-    * Note that these use the *internal names*. For example, `advanced-electronics`
-* Factorio
-  Progressive: [Factorio Progressive Technologies List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/factorio/Technologies.py#L374)
-*
-Minecraft: [Minecraft Items List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Items.py#L14)
-* Ocarina of
-  Time: [Ocarina of Time Items List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/Items.py#L61)
-* Risk of Rain
-  2: [Risk of Rain 2 Items List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Items.py#L8)
-* Slay the
-  Spire: [Slay the Spire Items List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/spire/Items.py#L13)
-*
-Subnautica: [Subnautica Items List JSON File](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/subnautica/items.json)
-*
-Timespinner: [Timespinner Items List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Items.py#L11)
+* [A Link to the Past](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Items.py#L52)
+* [Factorio Non-Progressive](https://wiki.factorio.com/Technologies) Note that these use the *internal names*. For example, `advanced-electronics`
+* [Factorio Progressive](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/factorio/Technologies.py#L374)
+* [Minecraft](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Items.py#L14)
+* [Ocarina of Time](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/Items.py#L61)
+* [Risk of Rain 2](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Items.py#L8)
+* [Slay the Spire](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/spire/Items.py#L13)
+* [Subnautica](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/subnautica/items.json)
+* [Timespinner](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Items.py#L11)
 
 ### Available Locations
+* [A Link to the Past](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Regions.py#L429)
+* [Factorio](https://wiki.factorio.com/Technologies) Same as items
+* [Minecraft](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Locations.py#L18)
+* [Ocarina of Time](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/LocationList.py#L38)
+* [Risk of Rain 2](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Locations.py#L17) This is a special
+case. The locations are "ItemPickup[number]" up to the maximum set in the yaml.
+* [Slay the Spire](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/spire/Locations.py)
+* [Subnautica](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/subnautica/locations.json)
+* [Timespinner](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Locations.py#L13)
 
-* A Link to the
-  Past: [Link to the Past Locations List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Regions.py#L429)
-* Factorio: [Factorio Technologies List Wiki](https://wiki.factorio.com/Technologies)
-    * In Factorio the location names are the same as the item names.
-*
-Minecraft: [Minecraft Locations List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Locations.py#L18)
-* Ocarina of
-  Time: [Ocarina of Time Locations List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/LocationList.py#L38)
-* Risk of Rain
-  2: [Risk of Rain 2 Locations List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Locations.py#L17)
-    * This is a special case. The locations are "ItemPickup[number]" up to the maximum set in the yaml.
-* Slay the
-  Spire: [Slay the Spire Locations List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/spire/Locations.py)
-*
-Subnautica: [Subnautica Locations List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/subnautica/locations.json)
-*
-Timespinner: [Timespinner Locations List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Locations.py#L13)
-
-A list of all available items and locations can also be found in the server's datapackage. Data package
-JSON: [DataPackage JSON](/api/datapackage).
 
+A list of all available items and locations can also be found in the [server's datapackage](/api/datapackage).
 ### Examples
-
 ```yaml
 plando_items:
-  # example block 1 - Timespinner
+# example block 1 - Timespinner
   - item:
       Empire Orb: 1
       Radiant Orb: 1
@@ -111,8 +78,8 @@ plando_items:
     from_pool: true
     world: true
     percentage: 50
-
-  # example block 2 - Ocarina of Time
+    
+# example block 2 - Ocarina of Time
   - items:
       Kokiri Sword: 1
       Biggoron Sword: 1
@@ -131,8 +98,8 @@ plando_items:
       - Shadow Temple Hover Boots Chest
       - Spirit Temple Silver Gauntlets Chest
     world: false
-
-  # example block 3 - Slay the Spire
+    
+# example block 3 - Slay the Spire
   - items:
       Boss Relic: 3
     locations:
@@ -140,7 +107,7 @@ plando_items:
       Boss Relic 2
       Boss Relic 3
 
-  # example block 4 - Factorio
+# example block 4 - Factorio
   - items:
       progressive-electric-energy-distribution: 2
       electric-energy-accumulators: 1
@@ -153,49 +120,39 @@ plando_items:
     percentage: 80
     force: true
 ```
-
-1. This block has a 50% chance to occur, and if it does will place either the Empire Orb or Radiant Orb on another
-   player's Starter Chest 1 and removes the chosen item from the item pool.
+1. This block has a 50% chance to occur, and if it does will place either the Empire Orb or Radiant Orb on another player's
+Starter Chest 1 and removes the chosen item from the item pool.
 2. This block will always trigger and will place the player's swords, bow, magic meter, strength upgrades, and hookshots
-   in their own dungeon major item chests.
+in their own dungeon major item chests.
 3. This block will always trigger and will lock boss relics on the bosses.
 4. This block has an 80% chance of occuring and when it does will place all but 1 of the items randomly among the four
-   locations chosen here.
+locations chosen here.
 
 ## Boss Plando
-
-As this is currently only supported by A Link to the Past instead of explaining here please refer to the Z3 plando
-guide. Z3 plando guide: [LttP Plando Guide](/tutorial/zelda3/plando/en)
+As this is currently only supported by A Link to the Past instead of explaining here please refer to the 
+[relevant guide](/tutorial/zelda3/plando/en)
 
 ## Text Plando
-
-As this is currently only supported by A Link to the Past instead of explaining here please refer to the Z3 plando
-guide. Z3 plando guide: [LttP Plando Guide](/tutorial/zelda3/plando/en)
+As this is currently only supported by A Link to the Past instead of explaining here please refer to the
+[relevant guide](/tutorial/zelda3/plando/en)
 
 ## Connections Plando
-
-This is currently only supported by Minecraft and A Link to the Past. As the way that these games interact with their
-connections is different I will only explain the basics here while more specifics for Link to the Past connection plando
-can be found in its plando guide.
-
-* The options for connections are `percentage`, `entrance`, `exit`, and `direction`. Each of these options support
-  subweights.
+This is currently only supported by Minecraft and A Link to the Past. As the way that these games interact with
+their connections is different I will only explain the basics here while more specifics for Link to the Past connection
+plando can be found in its plando guide.
+* The options for connections are `percentage`, `entrance`, `exit`, and `direction`. Each of these options support subweights.
 * `percentage` is the percentage chance for this connection from 0 to 100 and defaults to 100.
-* Every connection has an `entrance` and an `exit`. These can be unlinked like in A Link to the Past insanity entrance
-  shuffle.
+* Every connection has an `entrance` and an `exit`. These can be unlinked like in A Link to the Past insanity entrance shuffle.
 * `direction` can be `both`, `entrance`, or `exit` and determines in which direction this connection will operate.
 
-Link to the Past
-connections: [Link to the Past Connections List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/EntranceShuffle.py#L3852)
+[Link to the Past connections](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/EntranceShuffle.py#L3852)
 
-Minecraft
-connections: [Minecraft Connections List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Regions.py#L62)
+[Minecraft connections](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Regions.py#L62)
 
 ### Examples
-
 ```yaml
 plando_connections:
-  # example block 1 - Link to the Past
+# example block 1 - Link to the Past
   - entrance: Cave Shop (Lake Hylia)
     exit: Cave 45
     direction: entrance
@@ -205,8 +162,8 @@ plando_connections:
   - entrance: Agahnims Tower
     exit: Old Man Cave Exit (West)
     direction: exit
-
-  # example block 2 - Minecraft
+    
+# example block 2 - Minecraft
   - entrance: Overworld Structure 1
     exit: Nether Fortress
     direction: both

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

@@ -1,136 +1,130 @@
 # A Link to the Past Randomizer Setup Guide
 
 ## Required Software
-
-- A client, one of:
-    - Z3Client: [Z3Client Releases Page](https://github.com/ArchipelagoMW/Z3Client/releases)
-    - SNIClient included with Archipelago:
-      [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases)
-        - If installing Archipelago, make sure to check the box for SNIClient -> A Link to the Past Patch Setup during
-          install, or SNI will not be included
-- Super Nintendo Interface (SNI): [SNI Releases Page](https://github.com/alttpo/sni/releases)
-    - (Included in both Z3Client and SNIClient)
+- [SNIClient](https://github.com/ArchipelagoMW/Archipelago/releases) included with the main Archipelago install
+or [SuperNintendoClient](https://github.com/ArchipelagoMW/SuperNintendoClient/releases)
+    - If installing Archipelago, make sure to check the box for `SNI Client - A Link to the Past Patch Setup`
+- [SNI](https://github.com/alttpo/sni/releases) (Included in both clients from the first step)
 - Hardware or software capable of loading and playing SNES ROM files
-    - An emulator capable of connecting to SNI, one of:
-        -
-        snes9x_Multitroid: [snes9x Multitroid Download in Google Drive](https://drive.google.com/drive/folders/1_ej-pwWtCAHYXIrvs5Hro16A1s9Hi3Jz)
-        - BizHawk: [BizHawk Official Website](http://tasvideos.org/BizHawk.html)
-    - An SD2SNES, FXPak Pro ([FXPak Pro Store page](https://krikzz.com/store/home/54-fxpak-pro.html)), or other
-      compatible hardware
+    - 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
 - Your Japanese v1.0 ROM file, probably named `Zelda no Densetsu - Kamigami no Triforce (Japan).sfc`
 
 ## Installation Procedures
-
 1. Download and install your preferred client from the link above, making sure to install the most recent version.
-   **The installer file is located in the assets section at the bottom of the version information**.
+**The installer file is located in the assets section at the bottom of the version information**.
     - During setup, you will be asked to locate your base ROM file. This is your Japanese Link to the Past ROM file.
 
-2. If you are using an emulator, you should assign your Lua capable emulator as your default program for launching ROM
-   files.
-    1. Extract your emulator's folder to your Desktop, or somewhere you will remember.
+2. If you are using an emulator, you should assign your Lua capable emulator as your default program
+for launching ROM files.
+    1. Extract your emulator's folder to your Desktop, or somewhere you will remember. 
     2. Right-click on a ROM file and select **Open with...**
     3. Check the box next to **Always use this app to open .sfc files**
     4. Scroll to the bottom of the list and click the grey text **Look for another App on this PC**
-    5. Browse for your emulator's `.exe` file and click **Open**. This file should be located inside the folder you
-       extracted in step one.
+    5. Browse for your emulator's `.exe` file and click **Open**. This file should be located inside
+       the folder you extracted in step one.
 
 ## Create a Config (.yaml) File
 
 ### What is a config file and why do I need one?
-
-Your config 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 config 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.
+Your config 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 config 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 config file?
-
-The Player Settings page on the website allows you to configure your personal settings and export a config file from
-them. ([Player Settings Page for A Link to the Past](/games/A%20Link%20to%20the%20Past/player-settings))
+The [Player Settings](/games/A%20Link%20to%20the%20Past/player-settings) page on the website allows you to configure
+your personal settings and export a config file from them.
 
 ### Verifying your config file
-
-If you would like to validate your config file to make sure it works, you may do so on the YAML Validation
-page. ([YAML Validation Page](/mysterycheck))
+If you would like to validate your config 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 Player Settings page, configure your options, and click the "Generate Game"
-   button. ([Player Settings for A Link to the Past](/games/A%20Link%20to%20the%20Past/player-settings))
+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.
 3. Click the "Create New Room" link.
 4. You will be presented with a server page, from which you can download your patch file.
-5. Double-click on your patch file, and the Z3Client will launch automatically, create your ROM from the patch file, and
-   open your emulator for you.
+5. Double-click on your patch file, and the Z3Client will launch automatically, create your ROM from
+   the patch file, and open your emulator for you.
 6. Since this is a single-player game, you will no longer need the client, so feel free to close it.
 
 ## Joining a MultiWorld Game
 
 ### Obtain your patch file and create your ROM
+When you join a multiworld game, you will be asked to provide your config 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 `.apbp` extension.
 
-When you join a multiworld game, you will be asked to provide your config 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 `.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 in the same place as your patch file.
+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 in the same place as your patch file.
 
 ### Connect to the client
 
 #### With an emulator
-
-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.
+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.
 
 ##### snes9x Multitroid
-
 1. Load your ROM file if it hasn't already been loaded.
 2. Click on the File menu and hover on **Lua Scripting**
 3. Click on **New Lua Script Window...**
 4. In the new window, click **Browse...**
 5. Select the connector lua file included with your client
-    - Z3Client users should download `sniConnector.lua` from the client download page
-    - SNIClient users should look in their Archipelago folder for `/sni/lua`
+     - SuperNintendoClient users should download `sniConnector.lua` from the client download page
+     - SNIClient users should look in their Archipelago folder for `/SNI/lua/x64` or `/SNI/lua/x86` depending on if
+the emulator is 64-bit or 32-bit.
 
 ##### BizHawk
-
-1. Ensure you have the BSNES core loaded. You may do this by clicking on the Tools menu in BizHawk and following these
-   menu options:  
+1. Ensure you have the BSNES core loaded. You may do this by clicking on the Tools menu in BizHawk and following
+   these menu options:  
    `Config --> Cores --> SNES --> BSNES`  
    Once you have changed the loaded core, you must restart BizHawk.
 2. Load your ROM file if it hasn't already been loaded.
 3. Click on the Tools menu and click on **Lua Console**
 4. Click Script -> Open Script...
 5. Select the `Connector.lua` file you downloaded above
-    - Z3Client users should download `sniConnector.lua` from the client download page
-    - SNIClient users should look in their Archipelago folder for `/sni/lua`
-6. Run the script by double-clicking it in the listing
+     - SuperNintendoClient users should download `sniConnector.lua` from the client download page
+     - SNIClient users should look in their Archipelago folder for `/SNI/lua/x64` or `/SNI/lua/x86` depending on if 
+the emulator is 64-bit or 32-bit.
 
 #### With hardware
-
-This guide assumes you have downloaded the correct firmware for your device. If you have not done so already, please do
-this now. SD2SNES and FXPak Pro users may download the appropriate
-firmware [from the sd2snes releases page](https://github.com/RedGuyyyy/sd2snes/releases). Other hardware may find
-helpful information [on the usb2snes supported platforms page](http://usb2snes.com/#supported-platforms).
+This guide assumes you have downloaded the correct firmware for your device. If you have not
+done so already, please do this now. SD2SNES and FXPak Pro users may download the appropriate firmware
+[here](https://github.com/RedGuyyyy/sd2snes/releases). Other hardware may find helpful information
+[on this page](http://usb2snes.com/#supported-platforms).
 
 1. Close your emulator, which may have auto-launched.
 2. Power on your device and load the ROM.
 
 ### Connect to the Archipelago Server
+The patch file which launched your client should have automatically connected you to the AP Server.
+There are a few reasons this may not happen however, including if the game is hosted on the website but
+was generated elsewhere. If the client window shows "Server Status: Not Connected", simply ask the host
+for the address of the server, and copy/paste it into the "Server" input field then press enter.
 
-The patch file which launched your client should have automatically connected you to the AP Server. There are a few
-reasons this may not happen however, including if the game is hosted on the website but was generated elsewhere. If the
-client window shows "Server Status: Not Connected", simply ask the host for the address of the server, and copy/paste it
-into the "Server" input field then press enter.
-
-The client will attempt to reconnect to the new server address, and should momentarily show "Server Status: Connected".
+The client will attempt to reconnect to the new server address, and should momentarily show "Server
+Status: Connected".
 
 ### Play the game
-
-When the client shows both SNES Device and Server as connected, you're ready to begin playing. Congratulations on
-successfully joining a multiworld game!
+When the client shows both SNES Device and Server as connected, you're ready to begin playing. Congratulations
+on successfully joining a multiworld game! You can execute various commands in your client. For more information
+regarding these commands you can use `/help` for local client commands and `!help` for server commands.
 
 ## Hosting a MultiWorld game
+The recommended way to host a game is to use our [hosting service](/generate). The process is relatively simple:
 
-The recommended way to host a game is to use our hosting service on the [seed generation page](/generate). Or check out
-the Archipelago website guide for more information: [Archipelago Website Guide](/tutorial/archipelago/using_website/en)
+1. Collect config files from your players.
+2. Create a zip file containing your players' config files.
+3. Upload that zip file to the website linked above.
+4. Wait a moment while the seed is generated.
+5. When the seed is generated, you will be redirected to a "Seed Info" page.
+6. Click "Create New Room". This will take you to the server page. Provide the link to this page to your players,
+   so they may download their patch files from there.
+7. Note that a link to a MultiWorld Tracker is at the top of the room page. The tracker shows the progress of all
+   players in the game. Any observers may also be given the link to this page.
+8. Once all players have joined, you may begin playing.

WebHostLib/static/styles/hostRoom.css

@@ -18,3 +18,34 @@
     border-radius: 3px;
     width: 500px;
 }
+
+#host-room table {
+    border-spacing: 0px;
+}
+
+#host-room table tbody{
+    background-color: #dce2bd;
+}
+
+#host-room table tbody tr:hover{
+    background-color: #e2eabb;
+}
+
+#host-room table tbody td{
+    padding: 4px 6px;
+    color: black;
+}
+
+#host-room table tbody a{
+    color: #234ae4;
+}
+
+#host-room table thead td{
+    background-color: #b0a77d;
+    color: black;
+    top: 0;
+}
+
+#host-room table tbody td{
+    border: 1px solid #bba967;
+}

WebHostLib/templates/macros.html

@@ -8,22 +8,43 @@
 {%- endmacro %}
 {% macro list_patches_room(room) %}
     {% if room.seed.slots %}
-        <ul>
+        <table>
+            <thead>
+                <tr>
+                    <td>Id</td>
+                    <td>Name</td>
+                    <td>Game</td>
+                    <td>Download Link</td>
+                    <td>Tracker Page</td>
+                </tr>
+            </thead>
+            <tbody>
             {% for patch in room.seed.slots|list|sort(attribute="player_id") %}
-                {% if patch.game == "Minecraft" %}
-                <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", 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>
-                {% endif %}
+                <tr>
+                    <td>{{ patch.player_id }}</td>
+                    <td>{{ patch.player_name }}</td>
+                    <td>{{ patch.game }}</td>
+                    <td>
+                        {% if patch.game == "Minecraft" %}
+                        <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
+                            Download APMC File...</a>
+                        {% elif patch.game == "Factorio" %}
+                        <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
+                            Download Factorio Mod...</a>
+                        {% elif patch.game == "Ocarina of Time" %}
+                        <a href="{{ url_for("download_slot_file", room_id=room.id, player_id=patch.player_id) }}" download>
+                            Download APZ5 File...</a>
+                        {% elif patch.game in ["A Link to the Past", "Secret of Evermore", "Super Metroid"] %}
+                        <a href="{{ url_for("download_patch", patch_id=patch.id, room_id=room.id) }}" download>
+                            Download Patch File...</a>
+                        {% else %}
+                            No file to download for this game.
+                        {% endif %}
+                    </td>
+                    <td><a href="{{ url_for("getPlayerTracker", tracker=room.tracker, tracked_team=0, tracked_player=patch.player_id) }}">Tracker</a></td>
+                </tr>
             {% endfor %}
-        </ul>
+            </tbody>
+        </table>
     {% endif %}
 {%- endmacro -%}

WebHostLib/templates/options.yaml

@@ -29,13 +29,6 @@ game:
 requires:
   version: {{ __version__ }} # 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.
 
 {%- macro range_option(option) %}
     # you can add additional values between minimum and maximum

WebHostLib/templates/userContent.html

@@ -2,7 +2,7 @@
 
 {% block head %}
     {{ super() }}
-    <title>Generate Game</title>
+    <title>User Content</title>
     <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename="styles/userContent.css") }}" />
     <script type="application/ecmascript" src="{{ url_for('static', filename="assets/userContent.js") }}"></script>
 {% endblock %}

WebHostLib/upload.py

@@ -62,12 +62,20 @@ def upload_zip_to_db(zfile: zipfile.ZipFile, owner=None, meta={"race": False}, s
         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.")
                 multidata = None
 
     if multidata:
+        decompressed_multidata = MultiServer.Context._decompress(multidata)
+        player_names = {slot.player_name for slot in slots}
+        leftover_names = [(name, index) for index, name in
+                          enumerate((name for name in decompressed_multidata["names"][0]), start=1)]
+        newslots = [(Slot(data=None, player_name=name, player_id=slot, game=decompressed_multidata["games"][slot]))
+                    for name, slot in leftover_names if name not in player_names]
+        for slot in newslots:
+            slots.add(slot)
+
         flush()  # commit slots
         seed = Seed(multidata=multidata, spoiler=spoiler, slots=slots, owner=owner, meta=json.dumps(meta),
                     id=sid if sid else uuid.uuid4())

docs/network protocol.md

@@ -13,6 +13,10 @@ These steps should be followed in order to establish a gameplay connection with
 
 In the case that the client does not authenticate properly and receives a [ConnectionRefused](#ConnectionRefused) then the server will maintain the connection and allow for follow-up [Connect](#Connect) packet.
 
+There are libraries available that implement the this network protocol in [Python](https://github.com/ArchipelagoMW/Archipelago/blob/main/CommonClient.py), [Java](https://github.com/ArchipelagoMW/Archipelago.MultiClient.Java) and [.Net](https://github.com/ArchipelagoMW/Archipelago.MultiClient.Net)
+
+For Super Nintendo games there are clients available in either [Node](https://github.com/ArchipelagoMW/SuperNintendoClient) or [Python](https://github.com/ArchipelagoMW/Archipelago/blob/main/SNIClient.py), There are also game specific clients available for [The Legend of Zelda: Ocarina of Time](https://github.com/ArchipelagoMW/Z5Client) or [Final Fantasy 1](https://github.com/ArchipelagoMW/Archipelago/blob/main/FF1Client.py)
+
 ## Synchronizing Items
 When the client receives a [ReceivedItems](#ReceivedItems) packet, if the `index` argument does not match the next index that the client expects then it is expected that the client will re-sync items with the server. This can be accomplished by sending the server a [Sync](#Sync) packet and then a [LocationChecks](#LocationChecks) packet.
 
@@ -140,8 +144,8 @@ The arguments for RoomUpdate are identical to [RoomInfo](#RoomInfo) barring:
 | ---- | ---- | ----- |
 | hint_points | int | New argument. The client's current hint points. |
 | players | list\[NetworkPlayer\] | Changed argument. Always sends all players, whether connected or not. |
-| checked_locations | May be a partial update, containing new locations that were checked, especially from a coop partner in the same slot. |
-| missing_locations | Should never be sent as an update, if needed is the inverse of checked_locations. |
+| checked_locations | list\[int\] | May be a partial update, containing new locations that were checked, especially from a coop partner in the same slot. |
+| missing_locations | list\[int\] | Should never be sent as an update, if needed is the inverse of checked_locations. |
 
 All arguments for this packet are optional, only changes are sent.
 

requirements.txt

@@ -2,6 +2,6 @@ colorama>=0.4.4
 websockets>=10.1
 PyYAML>=6.0
 fuzzywuzzy>=0.18.0
-appdirs>=1.4.4
 jinja2>=3.0.3
 schema>=0.7.4
+kivy>=2.0.0

test/base/TestFill.py

@@ -0,0 +1,275 @@
+from typing import NamedTuple
+import unittest
+from worlds.AutoWorld import World
+from Fill import FillError, fill_restrictive
+from BaseClasses import MultiWorld, Region, RegionType, Item, Location
+from worlds.generic.Rules import set_rule
+
+
+def generate_multi_world(players: int = 1) -> MultiWorld:
+    multi_world = MultiWorld(players)
+    multi_world.player_name = {}
+    for i in range(players):
+        player_id = i+1
+        world = World(multi_world, player_id)
+        multi_world.game[player_id] = world
+        multi_world.worlds[player_id] = world
+        multi_world.player_name[player_id] = "Test Player " + str(player_id)
+        region = Region("Menu", RegionType.Generic,
+                        "Menu Region Hint", player_id, multi_world)
+        multi_world.regions.append(region)
+
+    multi_world.set_seed()
+    multi_world.set_default_common_options()
+
+    return multi_world
+
+
+class PlayerDefinition(NamedTuple):
+    id: int
+    menu: Region
+    locations: list[Location]
+    prog_items: list[Item]
+
+
+def generate_player_data(multi_world: MultiWorld, player_id: int, location_count: int, prog_item_count: int) -> PlayerDefinition:
+    menu = multi_world.get_region("Menu", player_id)
+    locations = generate_locations(location_count, player_id, None, menu)
+    prog_items = generate_items(prog_item_count, player_id, True)
+
+    return PlayerDefinition(player_id, menu, locations, prog_items)
+
+
+def generate_locations(count: int, player_id: int, address: int = None, region: Region = None) -> list[Location]:
+    locations = []
+    for i in range(count):
+        name = "player" + str(player_id) + "_location" + str(i)
+        location = Location(player_id, name, address, region)
+        locations.append(location)
+        region.locations.append(location)
+    return locations
+
+
+def generate_items(count: int, player_id: int, advancement: bool = False, code: int = None) -> list[Location]:
+    items = []
+    for i in range(count):
+        name = "player" + str(player_id) + "_item" + str(i)
+        items.append(Item(name, advancement, code, player_id))
+    return items
+
+
+class TestBase(unittest.TestCase):
+    def test_basic_fill_restrictive(self):
+        multi_world = generate_multi_world()
+        player1 = generate_player_data(multi_world, 1, 2, 2)
+
+        item0 = player1.prog_items[0]
+        item1 = player1.prog_items[1]
+        loc0 = player1.locations[0]
+        loc1 = player1.locations[1]
+
+        fill_restrictive(multi_world, multi_world.state,
+                         player1.locations, player1.prog_items)
+
+        self.assertEqual(loc0.item, item1)
+        self.assertEqual(loc1.item, item0)
+        self.assertEqual([], player1.locations)
+        self.assertEqual([], player1.prog_items)
+
+    def test_ordered_fill_restrictive(self):
+        multi_world = generate_multi_world()
+        player1 = generate_player_data(multi_world, 1, 2, 2)
+        items = player1.prog_items
+        locations = player1.locations
+
+        multi_world.completion_condition[player1.id] = lambda state: state.has(
+            items[0].name, player1.id) and state.has(items[1].name, player1.id)
+        set_rule(locations[1], lambda state: state.has(
+            items[0].name, player1.id))
+        fill_restrictive(multi_world, multi_world.state,
+                         player1.locations.copy(), player1.prog_items.copy())
+
+        self.assertEqual(locations[0].item, items[0])
+        self.assertEqual(locations[1].item, items[1])
+
+    def test_fill_restrictive_remaining_locations(self):
+        multi_world = generate_multi_world()
+        player1 = generate_player_data(multi_world, 1, 3, 2)
+
+        item0 = player1.prog_items[0]
+        item1 = player1.prog_items[1]
+        loc0 = player1.locations[0]
+        loc1 = player1.locations[1]
+        loc2 = player1.locations[2]
+
+        multi_world.completion_condition[player1.id] = lambda state: state.has(
+            item0.name, player1.id) and state.has(item1.name, player1.id)
+        set_rule(loc1, lambda state: state.has(
+            item0.name, player1.id))
+        #forces a swap
+        set_rule(loc2, lambda state: state.has(
+            item0.name, player1.id))
+        fill_restrictive(multi_world, multi_world.state,
+                         player1.locations, player1.prog_items)
+
+        self.assertEqual(loc0.item, item0)
+        self.assertEqual(loc1.item, item1)
+        self.assertEqual(1, len(player1.locations))
+        self.assertEqual(player1.locations[0], loc2)
+
+    def test_minimal_fill_restrictive(self):
+        multi_world = generate_multi_world()
+        player1 = generate_player_data(multi_world, 1, 2, 2)
+
+        items = player1.prog_items
+        locations = player1.locations
+
+        multi_world.accessibility[player1.id] = 'minimal'
+        multi_world.completion_condition[player1.id] = lambda state: state.has(
+            items[1].name, player1.id)
+        set_rule(locations[1], lambda state: state.has(
+            items[0].name, player1.id))
+
+        fill_restrictive(multi_world, multi_world.state,
+                         player1.locations.copy(), player1.prog_items.copy())
+
+        self.assertEqual(locations[0].item, items[1])
+        # Unnecessary unreachable Item
+        self.assertEqual(locations[1].item, items[0])
+
+    def test_reversed_fill_restrictive(self):
+        multi_world = generate_multi_world()
+        player1 = generate_player_data(multi_world, 1, 2, 2)
+
+        item0 = player1.prog_items[0]
+        item1 = player1.prog_items[1]
+        loc0 = player1.locations[0]
+        loc1 = player1.locations[1]
+
+        multi_world.completion_condition[player1.id] = lambda state: state.has(
+            item0.name, player1.id) and state.has(item1.name, player1.id)
+        set_rule(loc1, lambda state: state.has(item1.name, player1.id))
+        fill_restrictive(multi_world, multi_world.state,
+                         player1.locations, player1.prog_items)
+
+        self.assertEqual(loc0.item, item1)
+        self.assertEqual(loc1.item, item0)
+
+    def test_multi_step_fill_restrictive(self):
+        multi_world = generate_multi_world()
+        player1 = generate_player_data(multi_world, 1, 4, 4)
+
+        items = player1.prog_items
+        locations = player1.locations
+
+        multi_world.completion_condition[player1.id] = lambda state: state.has(
+            items[2].name, player1.id) and state.has(items[3].name, player1.id)
+        set_rule(locations[1], lambda state: state.has(
+            items[0].name, player1.id))
+        set_rule(locations[2], lambda state: state.has(
+            items[1].name, player1.id))
+        set_rule(locations[3], lambda state: state.has(
+            items[1].name, player1.id))
+
+        fill_restrictive(multi_world, multi_world.state,
+                         player1.locations.copy(), player1.prog_items.copy())
+
+        self.assertEqual(locations[0].item, items[1])
+        self.assertEqual(locations[1].item, items[2])
+        self.assertEqual(locations[2].item, items[0])
+        self.assertEqual(locations[3].item, items[3])
+
+    def test_impossible_fill_restrictive(self):
+        multi_world = generate_multi_world()
+        player1 = generate_player_data(multi_world, 1, 2, 2)
+        items = player1.prog_items
+        locations = player1.locations
+
+        multi_world.completion_condition[player1.id] = lambda state: state.has(
+            items[0].name, player1.id) and state.has(items[1].name, player1.id)
+        set_rule(locations[1], lambda state: state.has(
+            items[1].name, player1.id))
+        set_rule(locations[0], lambda state: state.has(
+            items[0].name, player1.id))
+
+        self.assertRaises(FillError, fill_restrictive, multi_world, multi_world.state,
+                          player1.locations.copy(), player1.prog_items.copy())
+
+    def test_circular_fill_restrictive(self):
+        multi_world = generate_multi_world()
+        player1 = generate_player_data(multi_world, 1, 3, 3)
+
+        item0 = player1.prog_items[0]
+        item1 = player1.prog_items[1]
+        item2 = player1.prog_items[2]
+        loc0 = player1.locations[0]
+        loc1 = player1.locations[1]
+        loc2 = player1.locations[2]
+
+        multi_world.completion_condition[player1.id] = lambda state: state.has(
+            item0.name, player1.id) and state.has(item1.name, player1.id) and state.has(item2.name, player1.id)
+        set_rule(loc1, lambda state: state.has(item0.name, player1.id))
+        set_rule(loc2, lambda state: state.has(item1.name, player1.id))
+        set_rule(loc0, lambda state: state.has(item2.name, player1.id))
+
+        self.assertRaises(FillError, fill_restrictive, multi_world, multi_world.state,
+                          player1.locations.copy(), player1.prog_items.copy())
+
+    def test_competing_fill_restrictive(self):
+        multi_world = generate_multi_world()
+        player1 = generate_player_data(multi_world, 1, 2, 2)
+
+        item0 = player1.prog_items[0]
+        item1 = player1.prog_items[1]
+        loc1 = player1.locations[1]
+
+        multi_world.completion_condition[player1.id] = lambda state: state.has(
+            item0.name, player1.id) and state.has(item0.name, player1.id) and state.has(item1.name, player1.id)
+        set_rule(loc1, lambda state: state.has(item0.name, player1.id)
+                 and state.has(item1.name, player1.id))
+
+        self.assertRaises(FillError, fill_restrictive, multi_world, multi_world.state,
+                          player1.locations.copy(), player1.prog_items.copy())
+
+    def test_multiplayer_fill_restrictive(self):
+        multi_world = generate_multi_world(2)
+        player1 = generate_player_data(multi_world, 1, 2, 2)
+        player2 = generate_player_data(multi_world, 2, 2, 2)
+
+        multi_world.completion_condition[player1.id] = lambda state: state.has(
+            player1.prog_items[0].name, player1.id) and state.has(
+            player1.prog_items[1].name, player1.id)
+        multi_world.completion_condition[player2.id] = lambda state: state.has(
+            player2.prog_items[0].name, player2.id) and state.has(
+            player2.prog_items[1].name, player2.id)
+
+        fill_restrictive(multi_world, multi_world.state, player1.locations +
+                         player2.locations, player1.prog_items + player2.prog_items)
+
+        self.assertEqual(player1.locations[0].item, player1.prog_items[1])
+        self.assertEqual(player1.locations[1].item, player2.prog_items[1])
+        self.assertEqual(player2.locations[0].item, player1.prog_items[0])
+        self.assertEqual(player2.locations[1].item, player2.prog_items[0])
+
+    def test_multiplayer_rules_fill_restrictive(self):
+        multi_world = generate_multi_world(2)
+        player1 = generate_player_data(multi_world, 1, 2, 2)
+        player2 = generate_player_data(multi_world, 2, 2, 2)
+
+        multi_world.completion_condition[player1.id] = lambda state: state.has(
+            player1.prog_items[0].name, player1.id) and state.has(
+            player1.prog_items[1].name, player1.id)
+        multi_world.completion_condition[player2.id] = lambda state: state.has(
+            player2.prog_items[0].name, player2.id) and state.has(
+            player2.prog_items[1].name, player2.id)
+
+        set_rule(player2.locations[1], lambda state: state.has(
+            player2.prog_items[0].name, player2.id))
+
+        fill_restrictive(multi_world, multi_world.state, player1.locations +
+                         player2.locations, player1.prog_items + player2.prog_items)
+
+        self.assertEqual(player1.locations[0].item, player2.prog_items[0])
+        self.assertEqual(player1.locations[1].item, player2.prog_items[1])
+        self.assertEqual(player2.locations[0].item, player1.prog_items[0])
+        self.assertEqual(player2.locations[1].item, player1.prog_items[1])

worlds/alttp/EntranceShuffle.py

@@ -2549,7 +2549,7 @@ DW_Single_Cave_Doors = ['Bonk Fairy (Dark)',
                         'Big Bomb Shop',
                         'Dark Death Mountain Fairy',
                         'Dark Lake Hylia Shop',
-                        'Dark World Shop',
+                        'Village of Outcasts Shop',
                         'Red Shield Shop',
                         'Mire Shed',
                         'East Dark World Hint',
@@ -2626,7 +2626,7 @@ Bomb_Shop_Single_Cave_Doors = ['Waterfall of Wishing',
                                'Red Shield Shop',
                                'Dark Sanctuary Hint',
                                'Fortune Teller (Dark)',
-                               'Dark World Shop',
+                               'Village of Outcasts Shop',
                                'Dark World Lumberjack Shop',
                                'Dark World Potion Shop',
                                'Archery Game',
@@ -2837,7 +2837,7 @@ Inverted_DW_Single_Cave_Doors = ['Bonk Fairy (Dark)',
                                  'C-Shaped House',
                                  'Bumper Cave (Top)',
                                  'Dark Lake Hylia Shop',
-                                 'Dark World Shop',
+                                 'Village of Outcasts Shop',
                                  'Red Shield Shop',
                                  'Mire Shed',
                                  'East Dark World Hint',
@@ -2883,7 +2883,7 @@ Inverted_Bomb_Shop_Single_Cave_Doors = ['Waterfall of Wishing',
                                         'Red Shield Shop',
                                         'Inverted Dark Sanctuary',
                                         'Fortune Teller (Dark)',
-                                        'Dark World Shop',
+                                        'Village of Outcasts Shop',
                                         'Dark World Lumberjack Shop',
                                         'Dark World Potion Shop',
                                         'Archery Game',
@@ -3543,7 +3543,7 @@ default_connections = [('Waterfall of Wishing', 'Waterfall of Wishing'),
                        ('Red Shield Shop', 'Red Shield Shop'),
                        ('Dark Sanctuary Hint', 'Dark Sanctuary Hint'),
                        ('Fortune Teller (Dark)', 'Fortune Teller (Dark)'),
-                       ('Dark World Shop', 'Village of Outcasts Shop'),
+                       ('Village of Outcasts Shop', 'Village of Outcasts Shop'),
                        ('Dark World Lumberjack Shop', 'Dark World Lumberjack Shop'),
                        ('Dark World Potion Shop', 'Dark World Potion Shop'),
                        ('Archery Game', 'Archery Game'),
@@ -3679,7 +3679,7 @@ inverted_default_connections =  [('Waterfall of Wishing', 'Waterfall of Wishing'
                                  ('Dark World Hammer Peg Cave', 'Dark World Hammer Peg Cave'),
                                  ('Red Shield Shop', 'Red Shield Shop'),
                                  ('Fortune Teller (Dark)', 'Fortune Teller (Dark)'),
-                                 ('Dark World Shop', 'Village of Outcasts Shop'),
+                                 ('Village of Outcasts Shop', 'Village of Outcasts Shop'),
                                  ('Dark World Lumberjack Shop', 'Dark World Lumberjack Shop'),
                                  ('Dark World Potion Shop', 'Dark World Potion Shop'),
                                  ('Archery Game', 'Archery Game'),
@@ -3981,7 +3981,7 @@ door_addresses = {'Links House': (0x00, (0x0104, 0x2c, 0x0506, 0x0a9a, 0x0832, 0
                   'Dark Sanctuary Hint': (0x59, (0x0112, 0x53, 0x001e, 0x0400, 0x06e2, 0x0446, 0x0758, 0x046d, 0x075f, 0x00, 0x00, 0x0000, 0x0000)),
                   'Inverted Dark Sanctuary': (0x59, (0x0112, 0x53, 0x001e, 0x0400, 0x06e2, 0x0446, 0x0758, 0x046d, 0x075f, 0x00, 0x00, 0x0000, 0x0000)),
                   'Fortune Teller (Dark)': (0x65, (0x0122, 0x51, 0x0610, 0x04b4, 0x027e, 0x0507, 0x02f8, 0x0523, 0x0303, 0x0a, 0xf6, 0x091E, 0x0000)),
-                  'Dark World Shop': (0x5F, (0x010f, 0x58, 0x1058, 0x0814, 0x02be, 0x0868, 0x0338, 0x0883, 0x0343, 0x0a, 0xf6, 0x0000, 0x0000)),
+                  'Village of Outcasts Shop': (0x5F, (0x010f, 0x58, 0x1058, 0x0814, 0x02be, 0x0868, 0x0338, 0x0883, 0x0343, 0x0a, 0xf6, 0x0000, 0x0000)),
                   'Dark World Lumberjack Shop': (0x56, (0x010f, 0x42, 0x041c, 0x0074, 0x04e2, 0x00c7, 0x0558, 0x00e3, 0x055f, 0x0a, 0xf6, 0x0000, 0x0000)),
                   'Dark World Potion Shop': (0x6E, (0x010f, 0x56, 0x080e, 0x04f4, 0x0c66, 0x0548, 0x0cd8, 0x0563, 0x0ce3, 0x0a, 0xf6, 0x0000, 0x0000)),
                   'Archery Game': (0x58, (0x0111, 0x69, 0x069e, 0x0ac4, 0x02ea, 0x0b18, 0x0368, 0x0b33, 0x036f, 0x0a, 0xf6, 0x09AC, 0x0000)),

worlds/alttp/InvertedRegions.py

@@ -184,7 +184,7 @@ def create_inverted_regions(world, player):
         create_dw_region(player, 'West Dark World', ['Frog', 'Flute Activation Spot'], ['Village of Outcasts Drop', 'East Dark World River Pier', 'Brewery', 'C-Shaped House', 'Chest Game', 'Thieves Town', 'Bumper Cave Entrance Rock',
                                                        'Skull Woods Forest', 'Village of Outcasts Pegs', 'Village of Outcasts Eastern Rocks', 'Red Shield Shop', 'Inverted Dark Sanctuary', 'Fortune Teller (Dark)', 'Dark World Lumberjack Shop',
                                                        'West Dark World Teleporter', 'WDW Flute']),
-        create_dw_region(player, 'Dark Grassy Lawn', None, ['Grassy Lawn Pegs', 'Dark World Shop', 'Dark Grassy Lawn Flute']),
+        create_dw_region(player, 'Dark Grassy Lawn', None, ['Grassy Lawn Pegs', 'Village of Outcasts Shop', 'Dark Grassy Lawn Flute']),
         create_dw_region(player, 'Hammer Peg Area', ['Dark Blacksmith Ruins'], ['Dark World Hammer Peg Cave', 'Peg Area Rocks', 'Hammer Peg Area Flute']),
         create_dw_region(player, 'Bumper Cave Entrance', None, ['Bumper Cave (Bottom)', 'Bumper Cave Entrance Drop']),
         create_cave_region(player, 'Fortune Teller (Dark)', 'a fortune teller'),

worlds/alttp/ItemPool.py

@@ -9,7 +9,7 @@ from worlds.alttp.Dungeons import get_dungeon_item_pool_player
 from worlds.alttp.EntranceShuffle import connect_entrance
 from Fill import FillError
 from worlds.alttp.Items import ItemFactory, GetBeemizerItem
-from worlds.alttp.Options import smallkey_shuffle
+from worlds.alttp.Options import smallkey_shuffle, compass_shuffle, bigkey_shuffle, map_shuffle
 
 # This file sets the item pools for various modes. Timed modes and triforce hunt are enforced first, and then extra items are specified per mode to fill in the remaining space.
 # Some basic items that various modes require are placed here, including pendants and crystals. Medallion requirements for the two relevant entrances are also decided.
@@ -226,6 +226,7 @@ for diff in {'easy', 'normal', 'hard', 'expert'}:
 def generate_itempool(world):
     player = world.player
     world = world.world
+
     if world.difficulty[player] not in difficulties:
         raise NotImplementedError(f"Diffulty {world.difficulty[player]}")
     if world.goal[player] not in {'ganon', 'pedestal', 'bosses', 'triforcehunt', 'localtriforcehunt', 'icerodhunt',
@@ -371,14 +372,27 @@ def generate_itempool(world):
 
     dungeon_items = [item for item in get_dungeon_item_pool_player(world, player)
                      if item.name not in world.worlds[player].dungeon_local_item_names]
-
+    dungeon_item_replacements = difficulties[world.difficulty[player]].extras[0]\
+                                + difficulties[world.difficulty[player]].extras[1]\
+                                + difficulties[world.difficulty[player]].extras[2]\
+                                + difficulties[world.difficulty[player]].extras[3]\
+                                + difficulties[world.difficulty[player]].extras[4]
+    world.random.shuffle(dungeon_item_replacements)
     if world.goal[player] == 'icerodhunt':
         for item in dungeon_items:
             world.itempool.append(ItemFactory(GetBeemizerItem(world, player, 'Nothing'), player))
             world.push_precollected(item)
     else:
+        for x in range(len(dungeon_items)-1, -1, -1):
+            item = dungeon_items[x]
+            if ((world.smallkey_shuffle[player] == smallkey_shuffle.option_start_with and item.type == 'SmallKey')
+                    or (world.bigkey_shuffle[player] == bigkey_shuffle.option_start_with and item.type == 'BigKey')
+                    or (world.compass_shuffle[player] == compass_shuffle.option_start_with and item.type == 'Compass')
+                    or (world.map_shuffle[player] == map_shuffle.option_start_with and item.type == 'Map')):
+                dungeon_items.remove(item)
+                world.push_precollected(item)
+                world.itempool.append(ItemFactory(dungeon_item_replacements.pop(), player))
         world.itempool.extend([item for item in dungeon_items])
-
     # logic has some branches where having 4 hearts is one possible requirement (of several alternatives)
     # rather than making all hearts/heart pieces progression items (which slows down generation considerably)
     # We mark one random heart container as an advancement item (or 4 heart pieces in expert mode)
@@ -651,6 +665,7 @@ def get_pool_core(world, player: int):
             place_item(key_location, item_to_place)
         else:
             pool.extend([item_to_place])
+
     return (pool, placed_items, precollected_items, clock_mode, treasure_hunt_count, treasure_hunt_icon,
             additional_pieces_to_place)
 

worlds/alttp/Options.py

@@ -34,6 +34,7 @@ class DungeonItem(Choice):
     option_own_world = 2
     option_any_world = 3
     option_different_world = 4
+    option_start_with = 6
     alias_true = 3
     alias_false = 0
 

worlds/alttp/Regions.py

@@ -176,7 +176,7 @@ def create_regions(world, player):
                                                                    'Hype Cave - Bottom', 'Hype Cave - Generous Guy']),
         create_dw_region(player, 'West Dark World', ['Frog'], ['Village of Outcasts Drop', 'East Dark World River Pier', 'Brewery', 'C-Shaped House', 'Chest Game', 'Thieves Town', 'Graveyard Ledge Mirror Spot', 'Kings Grave Mirror Spot', 'Bumper Cave Entrance Rock',
                                                        'Skull Woods Forest', 'Village of Outcasts Pegs', 'Village of Outcasts Eastern Rocks', 'Red Shield Shop', 'Dark Sanctuary Hint', 'Fortune Teller (Dark)', 'Dark World Lumberjack Shop']),
-        create_dw_region(player, 'Dark Grassy Lawn', None, ['Grassy Lawn Pegs', 'Dark World Shop']),
+        create_dw_region(player, 'Dark Grassy Lawn', None, ['Grassy Lawn Pegs', 'Village of Outcasts Shop']),
         create_dw_region(player, 'Hammer Peg Area', ['Dark Blacksmith Ruins'], ['Bat Cave Drop Ledge Mirror Spot', 'Dark World Hammer Peg Cave', 'Peg Area Rocks']),
         create_dw_region(player, 'Bumper Cave Entrance', None, ['Bumper Cave (Bottom)', 'Bumper Cave Entrance Mirror Spot', 'Bumper Cave Entrance Drop']),
         create_cave_region(player, 'Fortune Teller (Dark)', 'a fortune teller'),

worlds/alttp/Rom.py

@@ -2800,7 +2800,7 @@ OtherEntrances = {'Blinds Hideout': 'Blind\'s old house',
                   'C-Shaped House': 'The NE house in Village of Outcasts',
                   'Dark Death Mountain Fairy': 'The SW cave on dark DM',
                   'Dark Lake Hylia Shop': 'The building NW dark Lake Hylia',
-                  'Dark World Shop': 'The hammer sealed building',
+                  'Village of Outcasts Shop': 'The hammer sealed building',
                   'Red Shield Shop': 'The fenced in building',
                   'Mire Shed': 'The western hut in the mire',
                   'East Dark World Hint': 'The dark cave near the eastmost portal',

worlds/alttp/Rules.py

@@ -1007,7 +1007,7 @@ def set_big_bomb_rules(world, player):
                              'Red Shield Shop',
                              'Dark Sanctuary Hint',
                              'Fortune Teller (Dark)',
-                             'Dark World Shop',
+                             'Village of Outcasts Shop',
                              'Dark World Lumberjack Shop',
                              'Thieves Town',
                              'Skull Woods First Section Door',
@@ -1331,7 +1331,7 @@ def set_inverted_big_bomb_rules(world, player):
     elif bombshop_entrance.name in LW_bush_entrances:
         # These entrances are behind bushes in LW so you need either Pearl or the tools to solve NDW bomb shop locations.
         add_rule(world.get_entrance('Pyramid Fairy', player), lambda state: state.has('Magic Mirror', player) and (state.has('Activated Flute', player) or state.has('Moon Pearl', player) or (state.can_lift_heavy_rocks(player) and state.has('Hammer', player))))
-    elif bombshop_entrance.name == 'Dark World Shop':
+    elif bombshop_entrance.name == 'Village of Outcasts Shop':
         # This is mostly the same as NDW but the Mirror path requires the Pearl, or using the Hammer
         add_rule(world.get_entrance('Pyramid Fairy', player), lambda state: state.has('Activated Flute', player) or (state.can_lift_heavy_rocks(player) and state.has('Hammer', player)) or (state.has('Magic Mirror', player) and state.can_reach('Light World', 'Region', player) and (state.has('Moon Pearl', player) or state.has('Hammer', player))))
     elif bombshop_entrance.name == 'Bumper Cave (Bottom)':

worlds/factorio/Options.py

@@ -131,6 +131,8 @@ class RecipeTime(Choice):
 
 
 class Progressive(Choice):
+    """Merges together Technologies like "automation-1" to "automation-3" into 3 copies of "Progressive Automation",
+    which awards them in order."""
     displayname = "Progressive Technologies"
     option_off = 0
     option_grouped_random = 1
@@ -151,17 +153,19 @@ class RecipeIngredients(Choice):
 
 
 class FactorioStartItems(ItemDict):
+    """Mapping of Factorio internal item-name to amount granted on start."""
     displayname = "Starting Items"
     verify_item_name = False
     default = {"burner-mining-drill": 19, "stone-furnace": 19}
 
 
 class FactorioFreeSampleBlacklist(OptionSet):
+    """Set of items that should never be granted from Free Samples"""
     displayname = "Free Sample Blacklist"
 
 
 class FactorioFreeSampleWhitelist(OptionSet):
-    """overrides any free sample blacklist present. This may ruin the balance of the mod, be forewarned."""
+    """Overrides any free sample blacklist present. This may ruin the balance of the mod, be warned."""
     displayname = "Free Sample Whitelist"
 
 
@@ -180,6 +184,7 @@ class EvolutionTrapCount(TrapCount):
 
 
 class EvolutionTrapIncrease(Range):
+    """How much an Evolution Trap increases the enemy evolution"""
     displayname = "Evolution Trap % Effect"
     range_start = 1
     default = 10
@@ -187,6 +192,8 @@ class EvolutionTrapIncrease(Range):
 
 
 class FactorioWorldGen(OptionDict):
+    """World Generation settings. Overview of options at https://wiki.factorio.com/Map_generator,
+    with in-depth documentation at https://lua-api.factorio.com/latest/Concepts.html#MapGenSettings"""
     displayname = "World Generation"
     # FIXME: do we want default be a rando-optimized default or in-game DS?
     value: typing.Dict[str, typing.Dict[str, typing.Any]]
@@ -320,6 +327,7 @@ class FactorioWorldGen(OptionDict):
 
 
 class ImportedBlueprint(DefaultOnToggle):
+    """Allow or Disallow Blueprints from outside the current savegame."""
     displayname = "Blueprints"
 
 

worlds/factorio/requirements.txt

@@ -1,3 +1,2 @@
-kivy>=2.0.0
 factorio-rcon-py>=1.2.1
 schema>=0.7.4

worlds/timespinner/Locations.py

@@ -11,6 +11,9 @@ class LocationData(NamedTuple):
     rule: Callable = lambda state: True
 
 def get_locations(world: Optional[MultiWorld], player: Optional[int]) -> Tuple[LocationData, ...]:
+    # 1337000 - 1337155 Generic locations
+    # 1337171 - 1337175 New Pickup checks
+    # 1337246 - 1337249 Ancient Pyramid
     location_table: List[LocationData] = [
         # PresentItemLocations
         LocationData('Tutorial', 'Yo Momma 1',  1337000),
@@ -73,12 +76,12 @@ def get_locations(world: Optional[MultiWorld], player: Optional[int]) -> Tuple[L
         LocationData('Sealed Caves (Sirens)', 'Upper sealed cave after sirens chest 1',  1337057),
         LocationData('Military Fortress', 'Military bomber chest',  1337058, lambda state: state.has('Timespinner Wheel', player) and state._timespinner_has_doublejump_of_npc(world, player)),
         LocationData('Military Fortress', 'Close combat room',  1337059),
-        LocationData('Military Fortress', 'Military soldiers bridge',  1337060),
-        LocationData('Military Fortress', 'Military giantess room',  1337061),
-        LocationData('Military Fortress', 'Military giantess bridge',  1337062),
-        LocationData('Military Fortress', 'Military B door chest 2',  1337063, lambda state: state._timespinner_has_doublejump(world, player) and state._timespinner_has_keycard_B(world, player)),
-        LocationData('Military Fortress', 'Military B door chest 1',  1337064, lambda state: state._timespinner_has_doublejump(world, player) and state._timespinner_has_keycard_B(world, player)),
-        LocationData('Military Fortress', 'Military pedestal',  1337065, lambda state: state._timespinner_has_doublejump(world, player) and (state._timespinner_has_doublejump_of_npc(world, player) or state._timespinner_has_forwarddash_doublejump(world, player))),
+        LocationData('Military Fortress (hangar)', 'Military soldiers bridge',  1337060),
+        LocationData('Military Fortress (hangar)', 'Military giantess room',  1337061),
+        LocationData('Military Fortress (hangar)', 'Military giantess bridge',  1337062),
+        LocationData('Military Fortress (hangar)', 'Military B door chest 2',  1337063, lambda state: state._timespinner_has_doublejump(world, player) and state._timespinner_has_keycard_B(world, player)),
+        LocationData('Military Fortress (hangar)', 'Military B door chest 1',  1337064, lambda state: state._timespinner_has_doublejump(world, player) and state._timespinner_has_keycard_B(world, player)),
+        LocationData('Military Fortress (hangar)', 'Military pedestal',  1337065, lambda state: state._timespinner_has_doublejump_of_npc(world, player) or state._timespinner_has_forwarddash_doublejump(world, player)),
         LocationData('The lab', 'Coffee break',  1337066),
         LocationData('The lab', 'Lower trash right',  1337067, lambda state: state._timespinner_has_doublejump(world, player)),
         LocationData('The lab', 'Lower trash left',  1337068, lambda state: state._timespinner_has_upwarddash(world, player)),
@@ -180,19 +183,7 @@ def get_locations(world: Optional[MultiWorld], player: Optional[int]) -> Tuple[L
         LocationData('Royal towers (upper)', 'Aelana\'s pedestal',  1337154),
         LocationData('Royal towers (upper)', 'Aelana\'s chest',  1337155),
 
-        # 1337176 - 1337176 Cantoran
-
-        # 1337177 - 1337236 Reserved
-
-        # 1337237 - 1337238 GyreArchives
-
-        # PyramidItemLocations
-        LocationData('Ancient Pyramid (right)', 'Transition chest 1',  1337239),
-        LocationData('Ancient Pyramid (right)', 'Transition chest 2',  1337240),
-        LocationData('Ancient Pyramid (right)', 'Transition chest 3',  1337241),
-
-        # 1337242 - 1337245 GyreArchives
-
+        #AncientPyramidLocations
         LocationData('Ancient Pyramid (left)', 'Why not it\'s right there',  1337246),
         LocationData('Ancient Pyramid (left)', 'Conviction guarded room',  1337247),
         LocationData('Ancient Pyramid (right)', 'Pit secret room',  1337248, lambda state: state._timespinner_can_break_walls(world, player)),
@@ -200,48 +191,48 @@ def get_locations(world: Optional[MultiWorld], player: Optional[int]) -> Tuple[L
         LocationData('Ancient Pyramid (right)', 'Killed Nightmare',  EventId)
     ]
 
-    downloadable_locations: Tuple[LocationData, ...] = (
-        # DownloadTerminals
-        LocationData('Library', 'Library terminal 1',  1337157, lambda state: state.has('Tablet', player)),
-        LocationData('Library', 'Library terminal 2',  1337156, lambda state: state.has('Tablet', player)),
-        # 1337158 Is Lost in time
-        LocationData('Library', 'Library terminal 3',  1337159, lambda state: state.has('Tablet', player)),
-        LocationData('Library', 'V terminal 1',  1337160, lambda state: state.has_all({'Tablet', 'Library Keycard V'}, player)),
-        LocationData('Library', 'V terminal 2',  1337161, lambda state: state.has_all({'Tablet', 'Library Keycard V'}, player)),
-        LocationData('Library', 'V terminal 3',  1337162, lambda state: state.has_all({'Tablet', 'Library Keycard V'}, player)),
-        LocationData('Library top', 'Backer room terminal',  1337163, lambda state: state.has('Tablet', player)),
-        LocationData('Varndagroth tower right (elevator)', 'Medbay',  1337164, lambda state: state.has('Tablet', player) and state._timespinner_has_keycard_B(world, player)),
-        LocationData('The lab (upper)', 'Chest and download terminal',  1337165, lambda state: state.has('Tablet', player)),
-        LocationData('The lab (power off)', 'Lab terminal middle',  1337166, lambda state: state.has('Tablet', player)),
-        LocationData('The lab (power off)', 'Sentry platform terminal',  1337167, lambda state: state.has('Tablet', player)),
-        LocationData('The lab', 'Experiment 13 terminal',  1337168, lambda state: state.has('Tablet', player)),
-        LocationData('The lab', 'Lab terminal left',  1337169, lambda state: state.has('Tablet', player)),
-        LocationData('The lab (power off)', 'Lab terminal right',  1337170, lambda state: state.has('Tablet', player))
-    )
+    # 1337156 - 1337170 Downloads
+    if not world or is_option_enabled(world, player, "DownloadableItems"):
+        location_table += ( 
+            LocationData('Library', 'Library terminal 2',  1337156, lambda state: state.has('Tablet', player)),
+            LocationData('Library', 'Library terminal 1',  1337157, lambda state: state.has('Tablet', player)),
+            # 1337158 Is Lost in time
+            LocationData('Library', 'Library terminal 3',  1337159, lambda state: state.has('Tablet', player)),
+            LocationData('Library', 'V terminal 1',  1337160, lambda state: state.has_all({'Tablet', 'Library Keycard V'}, player)),
+            LocationData('Library', 'V terminal 2',  1337161, lambda state: state.has_all({'Tablet', 'Library Keycard V'}, player)),
+            LocationData('Library', 'V terminal 3',  1337162, lambda state: state.has_all({'Tablet', 'Library Keycard V'}, player)),
+            LocationData('Library top', 'Backer room terminal',  1337163, lambda state: state.has('Tablet', player)),
+            LocationData('Varndagroth tower right (elevator)', 'Medbay',  1337164, lambda state: state.has('Tablet', player) and state._timespinner_has_keycard_B(world, player)),
+            LocationData('The lab (upper)', 'Chest and download terminal',  1337165, lambda state: state.has('Tablet', player)),
+            LocationData('The lab (power off)', 'Lab terminal middle',  1337166, lambda state: state.has('Tablet', player)),
+            LocationData('The lab (power off)', 'Sentry platform terminal',  1337167, lambda state: state.has('Tablet', player)),
+            LocationData('The lab', 'Experiment 13 terminal',  1337168, lambda state: state.has('Tablet', player)),
+            LocationData('The lab', 'Lab terminal left',  1337169, lambda state: state.has('Tablet', player)),
+            LocationData('The lab (power off)', 'Lab terminal right',  1337170, lambda state: state.has('Tablet', player))
+        )
 
-    gyre_archives_locations: Tuple[LocationData, ...] = (
-        LocationData('The lab (upper)', 'Ravenlord post fight (pedestal)',  1337237, lambda state: state.has('Merchant Crow', player)),
-        LocationData('Library top', 'Ifrit post fight (pedestal)',  1337238, lambda state: state.has('Kobo', player)),
-        LocationData('The lab (upper)', 'Ravenlord pre fight',  1337242, lambda state: state.has('Merchant Crow', player)),
-        LocationData('The lab (upper)', 'Ravenlord post fight (chest)',  1337243, lambda state: state.has('Merchant Crow', player)),
-        LocationData('Library top', 'Ifrit pre fight',  1337244, lambda state: state.has('Kobo', player)),
-        LocationData('Library top', 'Ifrit post fight (chest)',  1337245, lambda state: state.has('Kobo', player)),
-    )
+    # 1337176 - 1337176 Cantoran
+    if not world or is_option_enabled(world, player, "Cantoran"):
+        location_table += (
+            LocationData('Left Side forest Caves', 'Cantoran',  1337176),
+        )
 
-    cantoran_locations: Tuple[LocationData, ...] = (
-        LocationData('Left Side forest Caves', 'Cantoran',  1337176),
-    )
-
-    if not world:
-        return ( *location_table, *downloadable_locations, *gyre_archives_locations, *cantoran_locations )
-
-    if is_option_enabled(world, player, "DownloadableItems"):
-        location_table.extend(downloadable_locations)
-    if is_option_enabled(world, player, "GyreArchives"):
-        location_table.extend(gyre_archives_locations)
-    if is_option_enabled(world, player, "Cantoran"):
-        location_table.extend(cantoran_locations)
+    # 1337177 - 1337236 Reserved for future use
 
+    # 1337237 - 1337245 GyreArchives
+    if not world or is_option_enabled(world, player, "GyreArchives"):
+        location_table += (
+            LocationData('Ravenlord\'s Lair', 'Ravenlord post fight (pedestal)',  1337237),
+            LocationData('Ifrit\'s Lair', 'Ifrit post fight (pedestal)',  1337238),
+            LocationData('Temporal Gyre', 'Gyre chest 1',  1337239),
+            LocationData('Temporal Gyre', 'Gyre chest 2',  1337240),
+            LocationData('Temporal Gyre', 'Gyre chest 3',  1337241),
+            LocationData('Ravenlord\'s Lair', 'Ravenlord pre fight',  1337242),
+            LocationData('Ravenlord\'s Lair', 'Ravenlord post fight (chest)',  1337243),
+            LocationData('Ifrit\'s Lair', 'Ifrit pre fight',  1337244),
+            LocationData('Ifrit\'s Lair', 'Ifrit post fight (chest)', 1337245),
+        )
+ 
     return tuple(location_table)
         
 

worlds/timespinner/Options.py

@@ -50,6 +50,10 @@ class Cantoran(Toggle):
     "Cantoran's fight and check are available upon revisiting his room"
     display_name = "Cantoran"
 
+class DamageRando(Toggle):
+    "Each orb has a high chance of having lower base damage and a low chance of having much higher base damage."
+    display_name = "Damage Rando"
+
 # Some options that are available in the timespinner randomizer arent currently implemented
 timespinner_options: Dict[str, Toggle] = {
     "StartWithJewelryBox": StartWithJewelryBox,
@@ -64,6 +68,7 @@ timespinner_options: Dict[str, Toggle] = {
     #"StinkyMaw": StinkyMaw,
     "GyreArchives": GyreArchives,
     "Cantoran": Cantoran,
+    "DamageRando": DamageRando,
     "DeathLink": DeathLink,
 }
 

worlds/timespinner/Regions.py

@@ -14,15 +14,18 @@ def create_regions(world: MultiWorld, player: int, locations: Tuple[LocationData
         create_region(world, player, locations_per_region, location_cache, 'Lower lake desolation'),
         create_region(world, player, locations_per_region, location_cache, 'Library'),
         create_region(world, player, locations_per_region, location_cache, 'Library top'),
+        create_region(world, player, locations_per_region, location_cache, 'Ifrit\'s Lair'),
         create_region(world, player, locations_per_region, location_cache, 'Varndagroth tower left'),
         create_region(world, player, locations_per_region, location_cache, 'Varndagroth tower right (upper)'),
         create_region(world, player, locations_per_region, location_cache, 'Varndagroth tower right (lower)'),
         create_region(world, player, locations_per_region, location_cache, 'Varndagroth tower right (elevator)'),
         create_region(world, player, locations_per_region, location_cache, 'Sealed Caves (Sirens)'),
         create_region(world, player, locations_per_region, location_cache, 'Military Fortress'),
+        create_region(world, player, locations_per_region, location_cache, 'Military Fortress (hangar)'),
         create_region(world, player, locations_per_region, location_cache, 'The lab'),
         create_region(world, player, locations_per_region, location_cache, 'The lab (power off)'),
         create_region(world, player, locations_per_region, location_cache, 'The lab (upper)'),
+        create_region(world, player, locations_per_region, location_cache, 'Ravenlord\'s Lair'),
         create_region(world, player, locations_per_region, location_cache, 'Emperors tower'),
         create_region(world, player, locations_per_region, location_cache, 'Skeleton Shaft'),
         create_region(world, player, locations_per_region, location_cache, 'Sealed Caves (upper)'),
@@ -40,6 +43,7 @@ def create_regions(world: MultiWorld, player: int, locations: Tuple[LocationData
         create_region(world, player, locations_per_region, location_cache, 'Royal towers (lower)'),
         create_region(world, player, locations_per_region, location_cache, 'Royal towers'),
         create_region(world, player, locations_per_region, location_cache, 'Royal towers (upper)'),
+        create_region(world, player, locations_per_region, location_cache, 'Temporal Gyre'),
         create_region(world, player, locations_per_region, location_cache, 'Ancient Pyramid (left)'),
         create_region(world, player, locations_per_region, location_cache, 'Ancient Pyramid (right)'),
         create_region(world, player, locations_per_region, location_cache, 'Space time continuum')
@@ -68,6 +72,8 @@ def create_regions(world: MultiWorld, player: int, locations: Tuple[LocationData
     connect(world, player, names, 'Library', 'Varndagroth tower left', lambda state: state._timespinner_has_keycard_D(world, player))
     connect(world, player, names, 'Library', 'Space time continuum', lambda state: state.has('Twin Pyramid Key', player))
     connect(world, player, names, 'Library top', 'Library')
+    connect(world, player, names, 'Library top', 'Ifrit\'s Lair', lambda state: state.has('Kobo', player) and state.can_reach('Refugee Camp', 'Region', player))
+    connect(world, player, names, 'Ifrit\'s Lair', 'Library top')
     connect(world, player, names, 'Varndagroth tower left', 'Library')
     connect(world, player, names, 'Varndagroth tower left', 'Varndagroth tower right (upper)', lambda state: state._timespinner_has_keycard_C(world, player))
     connect(world, player, names, 'Varndagroth tower left', 'Varndagroth tower right (lower)', lambda state: state._timespinner_has_keycard_B(world, player))
@@ -86,14 +92,20 @@ def create_regions(world: MultiWorld, player: int, locations: Tuple[LocationData
     connect(world, player, names, 'Sealed Caves (Sirens)', 'Varndagroth tower right (lower)', lambda state: state.has('Elevator Keycard', player))
     connect(world, player, names, 'Sealed Caves (Sirens)', 'Space time continuum', lambda state: state.has('Twin Pyramid Key', player))
     connect(world, player, names, 'Military Fortress', 'Varndagroth tower right (lower)', lambda state: state._timespinner_can_kill_all_3_bosses(world, player))
-    connect(world, player, names, 'Military Fortress', 'The lab', lambda state: state._timespinner_has_keycard_B(world, player) and state._timespinner_has_doublejump(world, player))
+    connect(world, player, names, 'Military Fortress', 'Temporal Gyre', lambda state: state.has('Timespinner Wheel', player))
+    connect(world, player, names, 'Military Fortress', 'Military Fortress (hangar)', lambda state: state._timespinner_has_doublejump(world, player))
+    connect(world, player, names, 'Military Fortress (hangar)', 'Military Fortress')
+    connect(world, player, names, 'Military Fortress (hangar)', 'The lab', lambda state: state._timespinner_has_keycard_B(world, player) and state._timespinner_has_doublejump(world, player))
+    connect(world, player, names, 'Temporal Gyre', 'Military Fortress')
     connect(world, player, names, 'The lab', 'Military Fortress')
     connect(world, player, names, 'The lab', 'The lab (power off)', lambda state: state._timespinner_has_doublejump_of_npc(world, player))
     connect(world, player, names, 'The lab (power off)', 'The lab')
     connect(world, player, names, 'The lab (power off)', 'The lab (upper)', lambda state: state._timespinner_has_forwarddash_doublejump(world, player))
     connect(world, player, names, 'The lab (upper)', 'The lab (power off)')
+    connect(world, player, names, 'The lab (upper)', 'Ravenlord\'s Lair', lambda state: state.has('Merchant Crow', player))
     connect(world, player, names, 'The lab (upper)', 'Emperors tower', lambda state: state._timespinner_has_forwarddash_doublejump(world, player))
     connect(world, player, names, 'The lab (upper)', 'Ancient Pyramid (left)', lambda state: state.has_all({'Timespinner Wheel', 'Timespinner Spindle', 'Timespinner Gear 1', 'Timespinner Gear 2', 'Timespinner Gear 3'}, player))
+    connect(world, player, names, 'Ravenlord\'s Lair', 'The lab (upper)')
     connect(world, player, names, 'Emperors tower', 'The lab (upper)')
     connect(world, player, names, 'Skeleton Shaft', 'Lake desolation')
     connect(world, player, names, 'Skeleton Shaft', 'Sealed Caves (upper)', lambda state: state._timespinner_has_keycard_A(world, player))

worlds/timespinner/__init__.py

@@ -18,7 +18,7 @@ class TimespinnerWorld(World):
     game = "Timespinner"
     topology_present = True
     remote_items = False
-    data_version = 4
+    data_version = 5
 
     item_name_to_id = {name: data.code for name, data in item_table.items()}
     location_name_to_id = {location.name: location.code for location in get_locations(None, None)}