The Messenger: implement new game

README.md

@@ -38,6 +38,7 @@ Currently, the following games are supported:
 * Wargroove
 * Stardew Valley
 * The Legend of Zelda
+* The Messenger
 
 For setup and instructions check out our [tutorials page](https://archipelago.gg/tutorial/).
 Downloads can be found at [Releases](https://github.com/ArchipelagoMW/Archipelago/releases), including compiled

setup.py

@@ -54,6 +54,7 @@
     "Stardew Valley",
     "Timespinner",
     "Minecraft",
+    "The Messenger",
 }
 
 

worlds/messenger/Constants.py

@@ -0,0 +1,153 @@
+# items
+# listing individual groups first for easy lookup
+NOTES = [
+    "Key of Hope",
+    "Key of Chaos",
+    "Key of Courage",
+    "Key of Love",
+    "Key of Strength",
+    "Key of Symbiosis"
+]
+
+PROG_ITEMS = [
+    "Wingsuit",
+    "Rope Dart",
+    "Ninja Tabi",
+    "Power Thistle",
+    "Demon King Crown",
+    "Ruxxtin's Amulet",
+    "Fairy Bottle",
+    "Sun Crest",
+    "Moon Crest",
+    # "Astral Seed",
+    # "Astral Tea Leaves"
+]
+
+PHOBEKINS = [
+    "Necro",
+    "Pyro",
+    "Claustro",
+    "Acro"
+]
+
+USEFUL_ITEMS = [
+    "Windmill Shuriken"
+]
+
+# item_name_to_id needs to be deterministic and match upstream
+ALL_ITEMS = [
+    *NOTES,
+    "Windmill Shuriken",
+    "Wingsuit",
+    "Rope Dart",
+    "Ninja Tabi",
+    # "Astral Seed",
+    # "Astral Tea Leaves",
+    "Candle",
+    "Seashell",
+    "Power Thistle",
+    "Demon King Crown",
+    "Ruxxtin's Amulet",
+    "Fairy Bottle",
+    "Sun Crest",
+    "Moon Crest",
+    *PHOBEKINS,
+    "Power Seal",
+    "Time Shard"  # there's 45 separate instances of this in the client lookup, but hopefully we don't care?
+]
+
+# locations
+# the names of these don't actually matter, but using the upstream's names for now
+# order must be exactly the same as upstream
+ALWAYS_LOCATIONS = [
+    # notes
+    "Key of Love",
+    "Key of Courage",
+    "Key of Chaos",
+    "Key of Symbiosis",
+    "Key of Strength",
+    "Key of Hope",
+    # upgrades
+    "Wingsuit",
+    "Rope Dart",
+    "Ninja Tabi",
+    "Climbing Claws",
+    # quest items
+    "Astral Seed",
+    "Astral Tea Leaves",
+    "Candle",
+    "Seashell",
+    "Power Thistle",
+    "Demon King Crown",
+    "Ruxxtin's Amulet",
+    "Fairy Bottle",
+    "Sun Crest",
+    "Moon Crest",
+    # phobekins
+    "Necro",
+    "Pyro",
+    "Claustro",
+    "Acro"
+]
+
+SEALS = [
+    "Ninja Village Seal - Tree House",
+
+    "Autumn Hills Seal - Trip Saws",
+    "Autumn Hills Seal - Double Swing Saws",
+    "Autumn Hills Seal - Spike Ball Swing",
+    "Autumn Hills Seal - Spike Ball Darts",
+
+    "Catacombs Seal - Triple Spike Crushers",
+    "Catacombs Seal - Crusher Gauntlet",
+    "Catacombs Seal - Dirty Pond",
+
+    "Bamboo Creek Seal - Spike Crushers and Doors",
+    "Bamboo Creek Seal - Spike Ball Pits",
+    "Bamboo Creek Seal - Spike Crushers and Doors v2",
+
+    "Howling Grotto Seal - Windy Saws and Balls",
+    "Howling Grotto Seal - Crushing Pits",
+    "Howling Grotto Seal - Breezy Crushers",
+
+    "Quillshroom Marsh Seal - Spikey Window",
+    "Quillshroom Marsh Seal - Sand Trap",
+    "Quillshroom Marsh Seal - Do the Spike Wave",
+
+    "Searing Crags Seal - Triple Ball Spinner",
+    "Searing Crags Seal - Raining Rocks",
+    "Searing Crags Seal - Rhythm Rocks",
+
+    "Glacial Peak Seal - Ice Climbers",
+    "Glacial Peak Seal - Projectile Spike Pit",
+    "Glacial Peak Seal - Glacial Air Swag",
+
+    "Tower of Time Seal - Time Waster Seal",
+    "Tower of Time Seal - Lantern Climb",
+    "Tower of Time Seal - Arcane Orbs",
+
+    "Cloud Ruins Seal - Ghost Pit",
+    "Cloud Ruins Seal - Toothbrush Alley",
+    "Cloud Ruins Seal - Saw Pit",
+    "Cloud Ruins Seal - Money Farm Room",
+
+    "Underworld Seal - Sharp and Windy Climb",
+    "Underworld Seal - Spike Wall",
+    "Underworld Seal - Fireball Wave",
+    "Underworld Seal - Rising Fanta",
+
+    "Forlorn Temple Seal - Rocket Maze",
+    "Forlorn Temple Seal - Rocket Sunset",
+
+    "Sunken Shrine Seal - Ultra Lifeguard",
+    "Sunken Shrine Seal - Waterfall Paradise",
+    "Sunken Shrine Seal - Tabi Gauntlet",
+
+    "Riviere Turquoise Seal - Bounces and Balls",
+    "Riviere Turquoise Seal - Launch of Faith",
+    "Riviere Turquoise Seal - Flower Power",
+
+    "Elemental Skylands Seal - Air",
+    "Elemental Skylands Seal - Water",
+    "Elemental Skylands Seal - Fire"
+]

worlds/messenger/Options.py

@@ -0,0 +1,66 @@
+from Options import DefaultOnToggle, DeathLink, Range, Accessibility, Choice
+
+
+class MessengerAccessibility(Accessibility):
+    default = Accessibility.option_locations
+    # defaulting to locations accessibility since items makes certain items self-locking
+    __doc__ = Accessibility.__doc__.replace(f"default {Accessibility.default}", f"default {default}")
+
+
+class Logic(DefaultOnToggle):
+    """Whether the seed should be guaranteed completable."""
+    display_name = "Use Logic"
+
+
+class PowerSeals(DefaultOnToggle):
+    """Whether power seal locations should be randomized."""
+    display_name = "Shuffle Seals"
+
+
+class Goal(Choice):
+    """Requirement to finish the game. Power Seal Hunt will force power seal locations to be shuffled."""
+    display_name = "Goal"
+    option_open_music_box = 0
+    option_power_seal_hunt = 1
+
+
+class MusicBox(DefaultOnToggle):
+    """Whether the music box gauntlet needs to be done."""
+    display_name = "Music Box Gauntlet"
+
+
+class NotesNeeded(Range):
+    """How many notes are needed to access the Music Box."""
+    display_name = "Notes Needed"
+    range_start = 1
+    range_end = 6
+    default = range_end
+
+
+class AmountSeals(Range):
+    """Number of power seals that exist in the item pool when power seal hunt is the goal."""
+    display_name = "Total Power Seals"
+    range_start = 1
+    range_end = 45
+    default = range_end
+
+
+class RequiredSeals(Range):
+    """Percentage of total seals required to open the shop chest."""
+    display_name = "Percent Seals Required"
+    range_start = 10
+    range_end = 100
+    default = range_end
+
+
+messenger_options = {
+    "accessibility": MessengerAccessibility,
+    "enable_logic": Logic,
+    "shuffle_seals": PowerSeals,
+    "goal": Goal,
+    "music_box": MusicBox,
+    "notes_needed": NotesNeeded,
+    "total_seals": AmountSeals,
+    "percent_seals_required": RequiredSeals,
+    "death_link": DeathLink,
+}

worlds/messenger/Regions.py

@@ -0,0 +1,52 @@
+from typing import Dict, Set, List
+
+REGIONS: Dict[str, List[str]] = {
+    "Menu": [],
+    "Tower HQ": [],
+    "The Shop": [],
+    "Tower of Time": [],
+    "Ninja Village": ["Candle", "Astral Seed"],
+    "Autumn Hills": ["Climbing Claws", "Key of Hope"],
+    "Forlorn Temple": ["Demon King Crown"],
+    "Catacombs": ["Necro", "Ruxxtin's Amulet"],
+    "Bamboo Creek": ["Claustro"],
+    "Howling Grotto": ["Wingsuit"],
+    "Quillshroom Marsh": ["Seashell"],
+    "Searing Crags": ["Rope Dart"],
+    "Searing Crags Upper": ["Power Thistle", "Key of Strength", "Astral Tea Leaves"],
+    "Glacial Peak": [],
+    "Cloud Ruins": ["Acro"],
+    "Underworld": ["Pyro", "Key of Chaos"],
+    "Dark Cave": [],
+    "Riviere Turquoise": ["Fairy Bottle"],
+    "Sunken Shrine": ["Ninja Tabi", "Sun Crest", "Moon Crest", "Key of Love"],
+    "Elemental Skylands": ["Key of Symbiosis"],
+    "Corrupted Future": ["Key of Courage"],
+    "Music Box": ["Rescue Phantom"]
+}
+"""seal locations have the region in their name and may not need to be created so skip them here"""
+
+
+REGION_CONNECTIONS: Dict[str, Set[str]] = {
+    "Menu": {"Tower HQ"},
+    "Tower HQ": {"Autumn Hills", "Howling Grotto", "Searing Crags", "Glacial Peak", "Tower of Time", "Riviere Turquoise",
+                 "Sunken Shrine", "Corrupted Future", "The Shop", "Music Box"},
+    "Tower of Time": set(),
+    "Ninja Village": set(),
+    "Autumn Hills": {"Ninja Village", "Forlorn Temple", "Catacombs"},
+    "Forlorn Temple": {"Catacombs", "Bamboo Creek"},
+    "Catacombs": {"Autumn Hills", "Bamboo Creek", "Dark Cave"},
+    "Bamboo Creek": {"Catacombs", "Howling Grotto"},
+    "Howling Grotto": {"Bamboo Creek", "Quillshroom Marsh", "Sunken Shrine"},
+    "Quillshroom Marsh": {"Howling Grotto", "Searing Crags"},
+    "Searing Crags": {"Searing Crags Upper", "Quillshroom Marsh", "Underworld"},
+    "Searing Crags Upper": {"Searing Crags", "Glacial Peak"},
+    "Glacial Peak": {"Searing Crags Upper", "Tower HQ", "Cloud Ruins", "Elemental Skylands"},
+    "Cloud Ruins": {"Underworld"},
+    "Underworld": set(),
+    "Dark Cave": {"Catacombs", "Riviere Turquoise"},
+    "Riviere Turquoise": set(),
+    "Sunken Shrine": {"Howling Grotto"},
+    "Elemental Skylands": set()
+}
+"""Vanilla layout mapping with all Tower HQ portals open. from -> to"""