WIP: Started adding docs and Hexagon Quest logic

Author: silent-destroyer

worlds/tunic/Items.py

@@ -1,9 +1,10 @@
 from pathlib import Path
-from typing import Dict, Set, NamedTuple, List
-from BaseClasses import Item, ItemClassification
+from typing import Dict, List
+from BaseClasses import ItemClassification, MultiWorld
 import csv
 
 
+
 class TunicItemData:
     name: str
     classification: ItemClassification
@@ -12,6 +13,7 @@ class TunicItemData:
 
 
 class TunicItems:
+
     items: List[TunicItemData] = []
     items_lookup: Dict[str, TunicItemData] = {}
 
@@ -24,6 +26,10 @@ def populate_items(self):
                 item = TunicItemData()
                 item.name = line[0]
                 item.classification = getattr(ItemClassification, line[1])
+                if item.classification == ItemClassification.filler:
+                    filler_items.append(item.name)
                 item.quantity_in_item_pool = int(line[4])
                 self.items.append(item)
                 self.items_lookup[item.name] = item
+
+filler_items = []

worlds/tunic/Locations.py

@@ -6,7 +6,6 @@
 class TunicLocationData:
     region: str
     name: str
-    code: int
 
 
 class TunicLocations:
@@ -15,14 +14,12 @@ class TunicLocations:
 
     def populate_locations(self):
         locations_file_path = (Path(__file__).parent / "data/Locations.csv").resolve()
-        location_id = 3000
         with open(locations_file_path) as location_file:
             csv_file = csv.reader(location_file)
             csv_file.__next__()
             for line in csv_file:
                 location: TunicLocationData = TunicLocationData()
                 location.region = line[0]
                 location.name = line[1]
-                location.code = len(self.locations) + location_id
                 self.locations.append(location)
                 self.locations_lookup[line[1]] = location

worlds/tunic/Options.py

@@ -1,6 +1,7 @@
 import typing
 
-from Options import Option, DefaultOnToggle, Toggle
+from Options import Option, DefaultOnToggle, Toggle, StartInventoryPool, Choice
+
 
 class SwordProgression(DefaultOnToggle):
     """Option to play with sword progression. Sword Progression adds four possible upgrades to find that will
@@ -19,7 +20,21 @@ class AbilityShuffling(Toggle):
         *Certain Holy Cross usages are still allowed, such as free bombs, the seeking spell and other player-facing codes.
     """
     display_name = "Ability Shuffling"
+'''
+class BonusUpgrades(Toggle):
+    """Makes the Hero Relics and Golden Trophy Collectibles award bonus stat upgrades when found. (Can also be turned
+    on or off from in-game.)"""
+    display_name = "Bonus Upgrades"
 
+class FoolTraps(Choice):
+    """Replaces lower-value money rewards with various traps that damage the player. Increasing the setting increases
+    the threshold of money drops that get turned into traps. (Can be adjusted or turned off once in-game as well.)"""
+    display_name = "Fool Traps"
+    option_none = 0
+    option_normal = 1
+    option_double = 2
+    option_onslaught = 3
+'''
 class HexagonQuest(Toggle):
     """Choose whether to play the Hexagon Quest game mode. This mode shuffles 30 Golden Hexagons into the item pool and
     allows the game to be ended after collecting 20 of them."""
@@ -30,5 +45,6 @@ class HexagonQuest(Toggle):
     "start_with_sword": StartWithSword,
     "keys_behind_bosses": KeysBehindBosses,
     "ability_shuffling": AbilityShuffling,
-    "hexagon_quest": HexagonQuest
-}
+    "hexagon_quest": HexagonQuest,
+    "start_inventory_from_pool": StartInventoryPool
+}

worlds/tunic/Regions.py

@@ -1,20 +1,9 @@
 from typing import Dict, Set
-from BaseClasses import MultiWorld
-
-
-class TunicEntrance:
-    name: str
-    rule: bool
-
-    def __init__(self, name, rule):
-        self.name = name
-        self.rule = rule
-
 
 tunic_regions: Dict[str, Set[str]] = {
     "Menu": {"Overworld"},
     "Overworld": {"Menu", "Overworld Holy Cross", "East Forest", "Dark Tomb", "Bottom of the Well", "West Garden",
-                  "Ruined Atoll", "Eastern Vault Fortress", "Beneath the Vault", "Quarry", "Swamp", "Boss Arena"},
+                  "Ruined Atoll", "Eastern Vault Fortress", "Beneath the Vault", "Quarry", "Swamp", "Spirit Arena"},
     "Overworld Holy Cross": {"Overworld"},
     "East Forest": {"Overworld", "Eastern Vault Fortress"},
     "Dark Tomb": {"Overworld", "West Garden"},
@@ -30,46 +19,5 @@ def __init__(self, name, rule):
     "Rooted Ziggurat": {"Lower Quarry"},
     "Swamp": {"Overworld", "Cathedral"},
     "Cathedral": {"Swamp"},
-    "Boss Arena": {"Overworld"}
-}
-
-
-
-def set_region_rules(multiworld: MultiWorld, player: int):
-    laurels = "Hero's Laurels"
-    grapple = "Magic Orb"
-    lantern = "Lantern"
-    mask = "Scavenger Mask"
-    prayer = "Pages 24-25 (Prayer)"
-    holy_cross = "Pages 42-43 (Holy Cross)"
-    red_hexagon = "Red Hexagon"
-    green_hexagon = "Green Hexagon"
-    blue_hexagon = "Blue Hexagon"
-
-    ability_shuffle = multiworld.ability_shuffling[player].value
-
-    if ability_shuffle:
-        multiworld.get_entrance("Overworld -> Overworld Holy Cross", player).access_rule = lambda state: state.has(holy_cross, player)
-        multiworld.get_entrance("Library -> Ruined Atoll", player).access_rule = lambda state: state.has(prayer, player)
-        multiworld.get_entrance("Overworld -> Beneath the Vault", player).access_rule = lambda state: state.has(lantern, player) and state.has(prayer, player)
-        multiworld.get_entrance("Lower Quarry -> Rooted Ziggurat", player).access_rule = lambda state: state.has(grapple, player) and state.has(prayer, player)
-        multiworld.get_entrance("Swamp -> Cathedral", player).access_rule = lambda state: state.has(laurels, player) and state.has(prayer, player)
-        multiworld.get_entrance("Ruined Atoll -> Library", player).access_rule = lambda state: (state.has(grapple, player) or state.has(laurels, player)) and state.has(prayer, player)
-        multiworld.get_entrance("Overworld -> Boss Arena", player).access_rule = lambda state: state.has(prayer, player) and state.has(red_hexagon, player) and state.has(green_hexagon, player) and state.has(blue_hexagon, player)
-    else:
-        multiworld.get_entrance("Overworld -> Beneath the Vault", player).access_rule = lambda state: state.has(lantern, player)
-        multiworld.get_entrance("Lower Quarry -> Rooted Ziggurat", player).access_rule = lambda state: state.has(grapple, player)
-        multiworld.get_entrance("Swamp -> Cathedral", player).access_rule = lambda state: state.has(laurels, player)
-        multiworld.get_entrance("Ruined Atoll -> Library", player).access_rule = lambda state: state.has(grapple, player) or state.has(laurels, player)
-        multiworld.get_entrance("Overworld -> Boss Arena", player).access_rule = lambda state: state.has(red_hexagon, player) and state.has(green_hexagon, player) and state.has(blue_hexagon, player)
-
-    multiworld.get_entrance("Overworld -> Dark Tomb", player).access_rule = lambda state: state.has(lantern, player)
-    multiworld.get_entrance("Overworld -> West Garden", player).access_rule = lambda state: state.has(laurels, player)
-    multiworld.get_entrance("Overworld -> Eastern Vault Fortress", player).access_rule = lambda state: state.has(laurels, player)
-    multiworld.get_entrance("East Forest -> Eastern Vault Fortress", player).access_rule = lambda state: state.has(laurels, player)
-    multiworld.get_entrance("Bottom of the Well -> Dark Tomb", player).access_rule = lambda state: state.has(lantern, player)
-    multiworld.get_entrance("West Garden -> Dark Tomb", player).access_rule = lambda state: state.has(lantern, player)
-    multiworld.get_entrance("Eastern Vault Fortress -> Beneath the Vault", player).access_rule = lambda state: state.has(lantern, player)
-    multiworld.get_entrance("Quarry -> Lower Quarry", player).access_rule = lambda state: state.has(mask, player)
-
-
+    "Spirit Arena": {"Overworld"}
+}