add ability to exclude the "always quests"

Author: CodeTriangle

worlds/crosscode/codegen/lists.py

@@ -193,6 +193,8 @@ def __add_location(self, name: str, raw_loc: dict[str, typing.Any], category: Lo
         item_rewards = rewards.get("items", [])
         num_rewards = max(1, len(item_rewards))
 
+        properties = raw_loc.get("properties", {})
+
         found = False
 
         if name in self.reward_amounts:
@@ -244,6 +246,9 @@ def __add_location(self, name: str, raw_loc: dict[str, typing.Any], category: Lo
                 except KeyError:
                     print(f"Cannot add location '{name}' in area '{area}'")
 
+            if properties.get("alwaysQuest", False):
+                self.location_groups["Always Quests"].append(loc)
+
             if locked:
                 self.locked_locations.append(locid)
 

worlds/crosscode/locations.py

@@ -2929,6 +2929,13 @@
         locations_dict['Talatu Introductions'],
         locations_dict['Schneider Guild Pass'],
     },
+    "Always Quests": {
+        locations_dict['Talatu Introductions'],
+        locations_dict['Bergen Mine Detector'],
+        locations_dict["Ba'kii Shade Statue"],
+        locations_dict['Chase the Hologram Frobbit'],
+        locations_dict['Mushroom Kingdom'],
+    },
     "Bergen Village Cutscenes": {
         locations_dict['Bergen Mine Guard'],
         locations_dict['Bergen Mine Detector'],

worlds/crosscode/options.py

@@ -384,6 +384,15 @@ class GoldChestLockWeight(Range):
     range_end = 100
     default = 10
 
+class ExcludeAlwaysQuests(DefaultOnToggle):
+    """
+    Certain quests are always in the location pool because they hold progression items when playing vanilla CrossCode.
+    If selected, this option will ensure that none of those locations are populated with progression or useful items. It
+    will also prohibit items from being placed on NPC interactions that give progression items but require working
+    through part of a questline to get to.
+    """
+    display_name = "Exclude Always Quests"
+
 class ForceFillerLocal(Toggle):
     """
     If selected, forces all filler items to be placed in your own world.
@@ -491,6 +500,8 @@ class CrossCodeOptions(PerGameCommonOptions):
     silver_chest_lock_weight: SilverChestLockWeight
     gold_chest_lock_weight: GoldChestLockWeight
 
+    exclude_always_quests: ExcludeAlwaysQuests
+
     force_filler_local: ForceFillerLocal
     common_pool_weight: CommonPoolWeight
     rare_pool_weight: RarePoolWeight
@@ -549,6 +560,12 @@ class CrossCodeOptions(PerGameCommonOptions):
             GoldChestLockWeight,
         ]
     ),
+    OptionGroup(
+        name="Locations",
+        options=[
+            ExcludeAlwaysQuests
+        ]
+    ),
     OptionGroup(
         name="Pools",
         options=[

worlds/crosscode/world.py

@@ -333,6 +333,9 @@ def generate_early(self):
                 self.options.gold_chest_lock_weight.value,
             ]))
 
+        if self.options.exclude_always_quests.value:
+            self.options.exclude_locations.value.update(self.location_name_groups["Always Quests"])
+
         if self.options.force_filler_local.value:
             for name in self._filler_pool_names:
                 self.options.local_items.value.update(self.item_name_groups[name])