Cleanup, v0.1.0

Author: jamesbrq

worlds/sneak_king/Items.py

@@ -18,15 +18,15 @@ class SneakKingItem(Item):
 items: list[ItemData] = []
 index = 0
 for level in ["Sawmill", "Cul-De-Sac", "Construction", "Downtown"]:
-    items += [ItemData(f"{level} Mission {i} Unlock", i + index, ItemClassification.progression) for i in range(2, 21)]  # start at 2
+    items += [ItemData(f"{level} Mission {i} Unlock", i + index, ItemClassification.progression) for i in range(2, 21)]
     index += 20
 items += [
     ItemData("Sawmill Unlock", 81, ItemClassification.progression),
     ItemData("Cul-De-Sac Unlock", 82, ItemClassification.progression),
     ItemData("Construction Unlock", 83, ItemClassification.progression),
     ItemData("Downtown Unlock", 84, ItemClassification.progression),
-    ItemData("Progressive Flourish", 85, ItemClassification.progression, 3),
-    ItemData("Progressive Chain", 86, ItemClassification.progression, 3),
+    ItemData("Progressive Flourish", 85, ItemClassification.progression, 0),
+    ItemData("Progressive Chain", 86, ItemClassification.progression, 0),
     ItemData("Nothing", 87, ItemClassification.filler, 0),
 ]
 

worlds/sneak_king/Locations.py

@@ -9,13 +9,11 @@ def __init__(self, name: str, id: int, tags: list[str]):
 all_locations: list[LocationData] = []
 index = 0
 
-# Mission rank locations
 for level in ["Sawmill", "Cul-De-Sac", "Construction", "Downtown"]:
     for rank in ["C", "B", "A"]:
         all_locations += [LocationData(f"{level}: Mission {i} Rank {rank}", index + i, [level, rank, "mission"]) for i in range(1, 21)]
         index += 20
 
-# Interactable object locations
 interactable_objects: dict[str, list[tuple[str, str]]] = {
     "Sawmill": [
         ("1A_Int_Door01", "Door 1"),
@@ -122,8 +120,8 @@ def __init__(self, name: str, id: int, tags: list[str]):
         ("3A_Crate07", "Crate 7"),
         ("3A_DiggerScoop", "Raised Truck Scoop"),
         ("3A_Door01", "Door 1"),
-        ("3A_Door02_knocker", "Knock on Door 1"),
-        ("3A_Door03_knocker", "Knock on Door 2"),
+        ("3A_Door02_knocker", "Knock on Door 2"),
+        ("3A_Door03_knocker", "Knock on Door 3"),
         ("3A_Door_Portaloo", "Porta-Potty"),
         ("3A_LadderBase", "Ladder"),
         ("3A_Manhole1", "Manhole 1"),
@@ -166,8 +164,6 @@ def __init__(self, name: str, id: int, tags: list[str]):
     ],
 }
 
-# Mission IDs used: index+1 through index+20 per batch, so max mission ID = index
-# Interactable IDs start after
 index += 1
 
 for level, objects in interactable_objects.items():

worlds/sneak_king/Options.py

@@ -4,20 +4,25 @@
 
 
 class Goal(Choice):
+    """The win condition for the game.
+    Complete X Missions: complete the required number of missions at any rank.
+    Complete X A-Ranks: earn A-rank on the required number of missions."""
     display_name = "Goal"
     option_complete_x_missions = 0
     option_complete_x_a_ranks = 1
     default = 0
 
 
 class GoalRange(Range):
+    """The number of missions or A-ranks required to complete the goal."""
     display_name = "Goal Range"
     range_start = 10
     range_end = 80
-    default = 20
+    default = 40
 
 
 class StartingLevel(Choice):
+    """The level you start with access to. All other levels must be unlocked."""
     display_name = "Starting Level"
     option_sawmill = 0
     option_cul_de_sac = 1
@@ -27,44 +32,56 @@ class StartingLevel(Choice):
 
 
 class EnabledRanks(OptionSet):
+    """Which rank tiers count as locations. Disabling a rank removes those checks from the pool."""
     display_name = "Enabled Ranks"
     valid_keys = ["C", "B", "A"]
     default = ["C", "B", "A"]
 
 
 class LevelUnlockMethod(Choice):
+    """How non-starting levels are unlocked.
+    Unlock Item: each level requires a specific unlock item from the item pool.
+    X Missions: each level unlocks after completing a set number of missions in the previous level."""
     display_name = "Level Unlock Method"
     option_x_missions = 0
     option_unlock_item = 1
     default = 1
 
 
 class LevelUnlockRange(Range):
+    """When using the X Missions unlock method, the number of missions that must be completed
+    in a level before the next level in the chain becomes accessible."""
     display_Name = "Level Unlock Mission Count"
     range_start = 5
     range_end = 20
-    default = 20
+    default = 10
 
 
 class LevelShuffle(DefaultOnToggle):
+    """Randomize the order in which levels appear in the unlock chain.
+    When disabled, the unlock order is Sawmill -> Cul-De-Sac -> Construction -> Downtown.
+    Only has an effect if the Level Unlock Method is set to X Missions."""
     display_name = "Level Shuffle"
 
 
 class KingSpeedMultiplier(Range):
+    """Multiplier applied to the King's movement speed."""
     display_name = "King Speed Multiplier"
     range_start = 1
     range_end = 2
     default = 1
 
 
 class CivilianSpeedMultiplier(Range):
+    """Multiplier applied to civilian movement speed."""
     display_name = "Civilian Speed Multiplier"
     range_start = 1
     range_end = 2
     default = 1
 
 
 class TrapPercentage(Range):
+    """Percentage of filler items replaced with traps."""
     display_name = "Trap Percentage"
     range_start = 0
     range_end = 100

worlds/sneak_king/Regions.py

@@ -11,11 +11,9 @@
 region_names = ["Sawmill", "Cul-De-Sac", "Construction", "Downtown"]
 
 def create_regions(world: "SneakKingWorld"):
-    # Create menu region (always included)
     menu_region = Region("Menu", world.player, world.multiworld)
     world.multiworld.regions.append(menu_region)
 
-    # Create other regions from dictionary, excluding any in disabled_regions
     regions_dict = get_regions_dict()
     for name, locations in regions_dict.items():
         if name not in world.disabled_regions:
@@ -35,13 +33,10 @@ def connect_regions(world: "SneakKingWorld"):
     connections_dict = get_region_connections_dict(world)
     names: typing.Dict[str, int] = {}
 
-    # Connect regions based on the connections dictionary, excluding any with excluded regions
     for (source, target), rule in connections_dict.items():
-        # Skip connections where either the source or target is in excluded_regions
         if source in world.disabled_regions or target in world.disabled_regions:
             continue
 
-        # Verify that both regions exist before trying to connect them
         try:
             world.multiworld.get_region(source, world.player)
             world.multiworld.get_region(target, world.player)
@@ -74,16 +69,13 @@ def get_level_order(world: "SneakKingWorld") -> list[str]:
 def get_region_connections_dict(world: "SneakKingWorld"):
     level_order = world.level_order
     connections = {
-        ("Menu", level_order[0]): None,  # Starting region is always accessible
+        ("Menu", level_order[0]): None,
     }
 
     if world.options.level_unlock_method == LevelUnlockMethod.option_unlock_item:
-        # All non-starting regions connect from Menu with their unlock item
         for region in level_order[1:]:
             connections[("Menu", region)] = Has(f"{region} Unlock")
     else:
-        # x_missions: linear chain where completing X missions in region N unlocks region N+1
-        # Mission 1 is always available (no unlock needed), so we need X-1 unlock items
         required_unlocks = world.options.level_unlock_range.value - 1
         for i in range(1, len(level_order)):
             prev_region = level_order[i - 1]

worlds/sneak_king/Rules.py

@@ -22,32 +22,24 @@
         mission_rules[location.name] = Has(item_name)
 
 def set_rules(world: "SneakKingWorld"):
-    # Set mission unlock rules
     for location_name, rule in mission_rules.items():
         if location_name not in world.disabled_locations:
             world.set_rule(world.get_location(location_name), rule)
 
     starting_region = region_names[world.options.starting_level.value]
 
     if world.options.level_unlock_method == LevelUnlockMethod.option_unlock_item:
-        # Prevent region unlock items from being placed in their own region
         for region_name in region_names:
             if region_name == starting_region:
-                continue  # Starting region unlock doesn't exist in item pool
+                continue
 
             region_unlock_item = f"{region_name} Unlock"
             region = world.multiworld.get_region(region_name, world.player)
             for location in region.locations:
                 forbid_item(location, region_unlock_item, world.player)
     else:
-        # x_missions chain mode: Region[0] -> Region[1] -> Region[2] -> Region[3]
-        # Completing X missions in Region[i] unlocks Region[i+1].
-        # Forbid Region[i]'s mission unlocks from regions that come AFTER Region[i+1]
-        # in the chain, since those regions can't be reached without first completing
-        # Region[i]'s missions. This helps the fill algorithm avoid dead ends.
         level_order = world.level_order
         for i, source_region in enumerate(level_order):
-            # Regions after the one this source unlocks
             forbidden_regions = level_order[i + 2:] if i + 2 < len(level_order) else []
             if not forbidden_regions:
                 continue