Merge remote-tracking branch 'upstream/main' into instruction_patch_kdl3

worlds/AutoWorld.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import hashlib
 import logging
 import pathlib
-import random
+from random import Random
 import re
 import sys
 import time
@@ -11,11 +11,13 @@ from dataclasses import make_dataclass
 from typing import (Any, Callable, ClassVar, Dict, FrozenSet, List, Mapping,
                     Optional, Set, TextIO, Tuple, TYPE_CHECKING, Type, Union)
 
-from Options import PerGameCommonOptions
-from BaseClasses import CollectionState
+from Options import ExcludeLocations, ItemLinks, LocalItems, NonLocalItems, PerGameCommonOptions, \
+    PriorityLocations, \
+    StartHints, \
+    StartInventory, StartInventoryPool, StartLocationHints
+from BaseClasses import CollectionState, OptionGroup
 
 if TYPE_CHECKING:
-    import random
     from BaseClasses import MultiWorld, Item, Location, Tutorial, Region, Entrance
     from . import GamesPackage
     from settings import Group
@@ -118,6 +120,33 @@ class AutoLogicRegister(type):
         return new_class
 
 
+class WebWorldRegister(type):
+    def __new__(mcs, name: str, bases: Tuple[type, ...], dct: Dict[str, Any]) -> WebWorldRegister:
+        # don't allow an option to appear in multiple groups, allow "Item & Location Options" to appear anywhere by the
+        # dev, putting it at the end if they don't define options in it
+        option_groups: List[OptionGroup] = dct.get("option_groups", [])
+        item_and_loc_options = [LocalItems, NonLocalItems, StartInventory, StartInventoryPool, StartHints,
+                                StartLocationHints, ExcludeLocations, PriorityLocations, ItemLinks]
+        seen_options = []
+        item_group_in_list = False
+        for group in option_groups:
+            assert group.name != "Game Options", "Game Options is a pre-determined group and can not be defined."
+            if group.name == "Item & Location Options":
+                group.options.extend(item_and_loc_options)
+                item_group_in_list = True
+            else:
+                for option in group.options:
+                    assert option not in item_and_loc_options, \
+                           f"{option} cannot be moved out of the \"Item & Location Options\" Group"
+            assert len(group.options) == len(set(group.options)), f"Duplicate options in option group {group.name}"
+            for option in group.options:
+                assert option not in seen_options, f"{option} found in two option groups"
+                seen_options.append(option)
+        if not item_group_in_list:
+            option_groups.append(OptionGroup("Item & Location Options", item_and_loc_options))
+        return super().__new__(mcs, name, bases, dct)
+
+
 def _timed_call(method: Callable[..., Any], *args: Any,
                 multiworld: Optional["MultiWorld"] = None, player: Optional[int] = None) -> Any:
     start = time.perf_counter()
@@ -172,7 +201,7 @@ def call_stage(multiworld: "MultiWorld", method_name: str, *args: Any) -> None:
             _timed_call(stage_callable, multiworld, *args)
 
 
-class WebWorld:
+class WebWorld(metaclass=WebWorldRegister):
     """Webhost integration"""
 
     options_page: Union[bool, str] = True
@@ -194,6 +223,9 @@ class WebWorld:
     options_presets: Dict[str, Dict[str, Any]] = {}
     """A dictionary containing a collection of developer-defined game option presets."""
 
+    option_groups: ClassVar[List[OptionGroup]] = []
+    """Ordered list of option groupings. Any options not set in a group will be placed in a pre-built "Game Options"."""
+
 
 class World(metaclass=AutoWorldRegister):
     """A World object encompasses a game's Items, Locations, Rules and additional data or functionality required.
@@ -283,7 +315,7 @@ class World(metaclass=AutoWorldRegister):
     location_names: ClassVar[Set[str]]
     """set of all potential location names"""
 
-    random: random.Random
+    random: Random
     """This world's random object. Should be used for any randomization needed in world for this player slot."""
 
     settings_key: ClassVar[str]
@@ -300,7 +332,7 @@ class World(metaclass=AutoWorldRegister):
         assert multiworld is not None
         self.multiworld = multiworld
         self.player = player
-        self.random = random.Random(multiworld.random.getrandbits(64))
+        self.random = Random(multiworld.random.getrandbits(64))
         multiworld.per_slot_randoms[player] = self.random
 
     def __getattr__(self, item: str) -> Any:

worlds/adventure/Options.py

@@ -241,4 +241,4 @@ adventure_option_definitions: Dict[str, type(Option)] = {
     "difficulty_switch_b": DifficultySwitchB,
     "start_castle": StartCastle,
 
-}
+}

worlds/alttp/docs/multiworld_es.md

@@ -64,7 +64,8 @@ configuración personal y descargar un fichero "YAML".
 
 ### Configuración YAML avanzada
 
-Una version mas avanzada del fichero Yaml puede ser creada usando la pagina ["Weighted settings"](/weighted-settings),
+Una version mas avanzada del fichero Yaml puede ser creada usando la pagina
+["Weighted settings"](/games/A Link to the Past/weighted-options),
 la cual te permite tener almacenadas hasta 3 preajustes. La pagina "Weighted Settings" tiene muchas opciones
 representadas con controles deslizantes. Esto permite elegir cuan probable los valores de una categoría pueden ser
 elegidos sobre otros de la misma.

worlds/alttp/docs/multiworld_fr.md

@@ -66,9 +66,10 @@ paramètres personnels et de les exporter vers un fichier YAML.
 ### Configuration avancée du fichier YAML
 
 Une version plus avancée du fichier YAML peut être créée en utilisant la page
-des [paramètres de pondération](/weighted-settings), qui vous permet de configurer jusqu'à trois préréglages. Cette page
-a de nombreuses options qui sont essentiellement représentées avec des curseurs glissants. Cela vous permet de choisir
-quelles sont les chances qu'une certaine option apparaisse par rapport aux autres disponibles dans une même catégorie.
+des [paramètres de pondération](/games/A Link to the Past/weighted-options), qui vous permet de configurer jusqu'à
+trois préréglages. Cette page a de nombreuses options qui sont essentiellement représentées avec des curseurs
+glissants. Cela vous permet de choisir quelles sont les chances qu'une certaine option apparaisse par rapport aux
+autres disponibles dans une même catégorie.
 
 Par exemple, imaginez que le générateur crée un seau étiqueté "Mélange des cartes", et qu'il place un morceau de papier
 pour chaque sous-option. Imaginez également que la valeur pour "On" est 20 et la valeur pour "Off" est 40.

worlds/generic/docs/advanced_settings_en.md

@@ -3,13 +3,12 @@ This guide covers more the more advanced options available in YAML files. This g
 to edit their YAML file manually. This guide should take about 10 minutes to read.
 
 If you would like to generate a basic, fully playable YAML without editing a file, then visit the options page for the
-game you intend to play. The weighted settings page can also handle most of the advanced settings discussed here.
+game you intend to play.
 
 The options page can be found on the supported games page, just click the "Options Page" link under the name of the
 game you would like.
 
 * Supported games page: [Archipelago Games List](/games)
-* Weighted settings page: [Archipelago Weighted Settings](/weighted-settings)
 
 Clicking on the "Export Options" button at the bottom-left will provide you with a pre-filled YAML with your options.
 The player options page also has a link to download a full template file for that game which will have every option

worlds/overcooked2/docs/setup_en.md

@@ -51,8 +51,6 @@ To completely remove *OC2-Modding*, navigate to your game's installation folder
 
 1. Visit the [Player Options](../../../../games/Overcooked!%202/player-options) page and configure the game-specific options to taste
 
-*By default, these options will only use levels from the base game and the "Seasonal" free DLC updates. If you own any of the paid DLC, you may select individual DLC packs to include/exclude on the [Weighted Options](../../../../weighted-options) page*
-
 2. Export your yaml file and use it to generate a new randomized game
 
 *For instructions on how to generate an Archipelago game, refer to the [Archipelago Setup Guide](../../../../tutorial/Archipelago/setup/en)*

worlds/sc2/docs/setup_en.md

@@ -29,8 +29,6 @@ There are three basic ways to get a yaml:
 
 Remember the name you enter in the options page or in the yaml file, you'll need it to connect later!
 
-Note that the basic Player Options page doesn't allow you to change all advanced options, such as excluding particular units or upgrades. Go through the [Weighted Options](https://archipelago.gg/weighted-options) page for that.
-
 Check out [Creating a YAML](https://archipelago.gg/tutorial/Archipelago/setup/en#creating-a-yaml) for more game-agnostic information.
 
 ### Common yaml questions