Shivers: Implement New Game

README.md

@@ -54,6 +54,7 @@ Currently, the following games are supported:
 * Lingo
 * Pokémon Emerald
 * DOOM II
+* Shivers
 
 
 For setup and instructions check out our [tutorials page](https://archipelago.gg/tutorial/).

docs/CODEOWNERS

@@ -110,6 +110,9 @@
 # Risk of Rain 2
 /worlds/ror2/ @kindasneaki
 
+# Shivers
+/worlds/shivers/ @GodlFire
+
 # Sonic Adventure 2 Battle
 /worlds/sa2b/ @PoryGone @RaspberrySpace
 

worlds/shivers/Constants.py

@@ -0,0 +1,17 @@
+import os
+import json
+import pkgutil
+
+def load_data_file(*args) -> dict:
+    fname = os.path.join("data", *args)
+    return json.loads(pkgutil.get_data(__name__, fname).decode())
+
+location_id_offset: int = 27000
+
+location_info = load_data_file("locations.json")
+location_name_to_id = {name: location_id_offset + index \
+	for index, name in enumerate(location_info["all_locations"])}
+
+exclusion_info = load_data_file("excluded_locations.json")
+
+region_info = load_data_file("regions.json")

worlds/shivers/Items.py

@@ -0,0 +1,112 @@
+from BaseClasses import Item, ItemClassification
+import typing
+
+class ShiversItem(Item):
+    game: str = "Shivers"
+
+class ItemData(typing.NamedTuple):
+    code: int
+    type: str
+    classification: ItemClassification = ItemClassification.progression
+
+SHIVERS_ITEM_ID_OFFSET = 27000
+
+item_table = {
+    #Pot Pieces
+    "Water Pot Bottom": ItemData(SHIVERS_ITEM_ID_OFFSET + 0, "pot"),
+    "Wax Pot Bottom": ItemData(SHIVERS_ITEM_ID_OFFSET + 1, "pot"),
+    "Ash Pot Bottom": ItemData(SHIVERS_ITEM_ID_OFFSET + 2, "pot"),
+    "Oil Pot Bottom": ItemData(SHIVERS_ITEM_ID_OFFSET + 3, "pot"),
+    "Cloth Pot Bottom": ItemData(SHIVERS_ITEM_ID_OFFSET + 4, "pot"),
+    "Wood Pot Bottom": ItemData(SHIVERS_ITEM_ID_OFFSET + 5, "pot"),
+    "Crystal Pot Bottom": ItemData(SHIVERS_ITEM_ID_OFFSET + 6, "pot"),
+    "Lightning Pot Bottom": ItemData(SHIVERS_ITEM_ID_OFFSET + 7, "pot"),
+    "Sand Pot Bottom": ItemData(SHIVERS_ITEM_ID_OFFSET + 8, "pot"),
+    "Metal Pot Bottom": ItemData(SHIVERS_ITEM_ID_OFFSET + 9, "pot"),
+    "Water Pot Top": ItemData(SHIVERS_ITEM_ID_OFFSET + 10, "pot"),
+    "Wax Pot Top": ItemData(SHIVERS_ITEM_ID_OFFSET + 11, "pot"),
+    "Ash Pot Top": ItemData(SHIVERS_ITEM_ID_OFFSET + 12, "pot"),
+    "Oil Pot Top": ItemData(SHIVERS_ITEM_ID_OFFSET + 13, "pot"),
+    "Cloth Pot Top": ItemData(SHIVERS_ITEM_ID_OFFSET + 14, "pot"),
+    "Wood Pot Top": ItemData(SHIVERS_ITEM_ID_OFFSET + 15, "pot"),
+    "Crystal Pot Top": ItemData(SHIVERS_ITEM_ID_OFFSET + 16, "pot"),
+    "Lightning Pot Top": ItemData(SHIVERS_ITEM_ID_OFFSET + 17, "pot"),
+    "Sand Pot Top": ItemData(SHIVERS_ITEM_ID_OFFSET + 18, "pot"),
+    "Metal Pot Top": ItemData(SHIVERS_ITEM_ID_OFFSET + 19, "pot"),
+
+    #Keys
+    "Key for Office Elevator": ItemData(SHIVERS_ITEM_ID_OFFSET + 20, "key"),
+    "Key for Bedroom Elevator": ItemData(SHIVERS_ITEM_ID_OFFSET + 21, "key"),
+    "Key for Three Floor Elevator": ItemData(SHIVERS_ITEM_ID_OFFSET + 22, "key"),
+    "Key for Workshop": ItemData(SHIVERS_ITEM_ID_OFFSET + 23, "key"),
+    "Key for Office": ItemData(SHIVERS_ITEM_ID_OFFSET + 24, "key"),
+    "Key for Prehistoric Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 25, "key"),
+    "Key for Greenhouse Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 26, "key"),
+    "Key for Ocean Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 27, "key"),
+    "Key for Projector Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 28, "key"),
+    "Key for Generator Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 29, "key"),
+    "Key for Egypt Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 30, "key"),
+    "Key for Library Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 31, "key"),
+    "Key for Tiki Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 32, "key"),
+    "Key for UFO Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 33, "key"),
+    "Key for Torture Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 34, "key"),
+    "Key for Puzzle Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 35, "key"),
+    "Key for Bedroom": ItemData(SHIVERS_ITEM_ID_OFFSET + 36, "key"),
+    "Key for Underground Lake Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 37, "key"),
+    "Key for Janitor Closet": ItemData(SHIVERS_ITEM_ID_OFFSET + 38, "key"),
+    "Key for Front Door": ItemData(SHIVERS_ITEM_ID_OFFSET + 39, "key-optional"),
+
+    #Abilities
+    "Crawling": ItemData(SHIVERS_ITEM_ID_OFFSET + 50, "ability"),
+
+    #Event Items
+    "Victory": ItemData(SHIVERS_ITEM_ID_OFFSET + 60, "victory"),
+
+    #Duplicate pot pieces for fill_Restrictive
+    "Water Pot Bottom DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 70, "potduplicate"),
+    "Wax Pot Bottom DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 71, "potduplicate"),
+    "Ash Pot Bottom DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 72, "potduplicate"),
+    "Oil Pot Bottom DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 73, "potduplicate"),
+    "Cloth Pot Bottom DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 74, "potduplicate"),
+    "Wood Pot Bottom DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 75, "potduplicate"),
+    "Crystal Pot Bottom DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 76, "potduplicate"),
+    "Lightning Pot Bottom DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 77, "potduplicate"),
+    "Sand Pot Bottom DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 78, "potduplicate"),
+    "Metal Pot Bottom DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 79, "potduplicate"),
+    "Water Pot Top DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 80, "potduplicate"),
+    "Wax Pot Top DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 81, "potduplicate"),
+    "Ash Pot Top DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 82, "potduplicate"),
+    "Oil Pot Top DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 83, "potduplicate"),
+    "Cloth Pot Top DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 84, "potduplicate"),
+    "Wood Pot Top DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 85, "potduplicate"),
+    "Crystal Pot Top DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 86, "potduplicate"),
+    "Lightning Pot Top DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 87, "potduplicate"),
+    "Sand Pot Top DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 88, "potduplicate"),
+    "Metal Pot Top DUPE": ItemData(SHIVERS_ITEM_ID_OFFSET + 89, "potduplicate"),
+
+    #Filler
+    "Empty": ItemData(SHIVERS_ITEM_ID_OFFSET + 90, "filler"),
+    "Easier Lyre": ItemData(SHIVERS_ITEM_ID_OFFSET + 91, "filler", ItemClassification.filler),
+    "Water Always Available in Lobby": ItemData(SHIVERS_ITEM_ID_OFFSET + 92, "filler2", ItemClassification.filler),
+    "Wax Always Available in Library": ItemData(SHIVERS_ITEM_ID_OFFSET + 93, "filler2", ItemClassification.filler),
+    "Wax Always Available in Anansi Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 94, "filler2", ItemClassification.filler),
+    "Wax Always Available in Tiki Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 95, "filler2", ItemClassification.filler),
+    "Ash Always Available in Office": ItemData(SHIVERS_ITEM_ID_OFFSET + 96, "filler2", ItemClassification.filler),
+    "Ash Always Available in Burial Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 97, "filler2", ItemClassification.filler),
+    "Oil Always Available in Prehistoric Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 98, "filler2", ItemClassification.filler),
+    "Cloth Always Available in Egypt": ItemData(SHIVERS_ITEM_ID_OFFSET + 99, "filler2", ItemClassification.filler),
+    "Cloth Always Available in Burial Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 100, "filler2", ItemClassification.filler),
+    "Wood Always Available in Workshop": ItemData(SHIVERS_ITEM_ID_OFFSET + 101, "filler2", ItemClassification.filler),
+    "Wood Always Available in Blue Maze": ItemData(SHIVERS_ITEM_ID_OFFSET + 102, "filler2", ItemClassification.filler),
+    "Wood Always Available in Pegasus Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 103, "filler2", ItemClassification.filler),
+    "Wood Always Available in Gods Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 104, "filler2", ItemClassification.filler),
+    "Crystal Always Available in Lobby": ItemData(SHIVERS_ITEM_ID_OFFSET + 105, "filler2", ItemClassification.filler),
+    "Crystal Always Available in Ocean": ItemData(SHIVERS_ITEM_ID_OFFSET + 106, "filler2", ItemClassification.filler),
+    "Sand Always Available in Greenhouse Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 107, "filler2", ItemClassification.filler),
+    "Sand Always Available in Ocean": ItemData(SHIVERS_ITEM_ID_OFFSET + 108, "filler2", ItemClassification.filler),
+    "Metal Always Available in Projector Room": ItemData(SHIVERS_ITEM_ID_OFFSET + 109, "filler2", ItemClassification.filler),
+    "Metal Always Available in Bedroom": ItemData(SHIVERS_ITEM_ID_OFFSET + 110, "filler2", ItemClassification.filler),
+    "Metal Always Available in Prehistoric": ItemData(SHIVERS_ITEM_ID_OFFSET + 111, "filler2", ItemClassification.filler),
+    "Heal": ItemData(SHIVERS_ITEM_ID_OFFSET + 112, "filler3", ItemClassification.filler)
+
+}

worlds/shivers/Options.py

@@ -0,0 +1,50 @@
+from Options import Choice, DefaultOnToggle, Toggle, PerGameCommonOptions
+from dataclasses import dataclass
+
+
+class LobbyAccess(Choice):
+    """Chooses how keys needed to reach the lobby are placed.
+    - Normal: Keys are placed anywhere
+    - Early: Keys are placed early 
+    - Local: Keys are placed locally"""
+    display_name = "Lobby Access"
+    option_normal = 0
+    option_early = 1
+    option_local = 2
+
+class PuzzleHintsRequired(DefaultOnToggle):
+    """If turned on puzzle hints will be available before the corresponding puzzle is required. For example: The Tiki
+    Drums puzzle will be placed after access to the security cameras which give you the solution. Turning this off
+    allows for greater randomization."""
+    display_name = "Puzzle Hints Required"
+
+class InformationPlaques(Toggle):
+    """Adds Information Plaques as checks."""
+    display_name = "Include Information Plaques"
+
+class FrontDoorUsable(Toggle):
+    """Adds a key to unlock the front door of the museum."""
+    display_name = "Front Door Usable"
+
+class ElevatorsStaySolved(DefaultOnToggle):
+    """Adds elevators as checks and will remain open upon solving them."""
+    display_name = "Elevators Stay Solved"
+
+class EarlyBeth(DefaultOnToggle):
+    """Beth's body is open at the start of the game. This allows any pot piece to be placed in the slide and early checks on the second half of the final riddle."""
+    display_name = "Early Beth"
+
+class EarlyLightning(Toggle):
+    """Allows lightning to be captured at any point in the game. You will still need to capture all ten Ixupi for victory."""
+    display_name = "Early Lightning"
+
+
+@dataclass
+class ShiversOptions(PerGameCommonOptions):
+    lobby_access: LobbyAccess
+    puzzle_hints_required: PuzzleHintsRequired
+    include_information_plaques: InformationPlaques
+    front_door_usable: FrontDoorUsable
+    elevators_stay_solved: ElevatorsStaySolved
+    early_beth: EarlyBeth
+    early_lightning: EarlyLightning