Lingo: The Pilgrim Update (#2884)

* An option was added to enable or disable the pilgrimage, and it defaults to disabled. When disabled, the client will prevent you from performing a pilgrimage (i.e. the yellow border will not appear when you enter the 1 sunwarp). The sun painting is added to the item pool when pilgrimage is disabled, as otherwise there is no way into the Pilgrim Antechamber. Inversely, the sun painting is no longer in the item pool when pilgrimage is enabled (even if door shuffle is on), requiring you to perform a pilgrimage to get to that room.
* The canonical pilgrimage has been deprecated. Instead, there is logic for determining whether a pilgrimage is possible.
* Two options were added that allow the player to decide whether paintings and/or Crossroads - Roof Access are permitted during the pilgrimage. Both default to disabled. These options apply both to logical expectations in the generator, and are also enforced by the game client.
* An option was added to control how sunwarps are accessed. The default is for them to always be accessible, like in the base game. It is also possible to disable them entirely (which is not possible when pilgrimage is enabled), or lock them behind items similar to door shuffle. It can either be one item that unlocks all sunwarps at the same time, six progressive items that unlock the sunwarps from 1 to 6, or six individual items that unlock the sunwarps in any order. This option is independent from door shuffle.
* An option was added that shuffles sunwarps. This acts similarly to painting shuffle. The 12 sunwarps are re-ordered and re-paired. Sunwarps that were previously entrances or exits do not need to stay entrances or exits. Performing a pilgrimage requires proceeding through the sunwarps in the new order, rather than the original one.
* Pilgrimage was added as a win condition. It requires you to solve the blue PILGRIM panel in the Pilgrim Antechamber.

3 files changed, 347 insertions, 0 deletions

@@ -29,3 +29,23 @@ class TestAllPanelHunt(LingoTestBase):
         "level_2_requirement": "800",
         "early_color_hallways": "true"
     }
+
+
+class TestShuffleSunwarps(LingoTestBase):
+    options = {
+        "shuffle_doors": "none",
+        "shuffle_colors": "false",
+        "victory_condition": "pilgrimage",
+        "shuffle_sunwarps": "true",
+        "sunwarp_access": "normal"
+    }
+
+
+class TestShuffleSunwarpsAccess(LingoTestBase):
+    options = {
+        "shuffle_doors": "none",
+        "shuffle_colors": "false",
+        "victory_condition": "pilgrimage",
+        "shuffle_sunwarps": "true",
+        "sunwarp_access": "individual"
+    }
\ No newline at end of file
@@ -0,0 +1,114 @@
+from . import LingoTestBase
+
+
+class TestDisabledPilgrimage(LingoTestBase):
+    options = {
+        "enable_pilgrimage": "false",
+        "shuffle_colors": "false"
+    }
+
+    def test_access(self):
+        self.assertFalse(self.can_reach_location("Pilgrim Antechamber - PILGRIM"))
+        
+        self.collect_by_name("Pilgrim Room - Sun Painting")
+        self.assertTrue(self.can_reach_location("Pilgrim Antechamber - PILGRIM"))
+
+
+class TestPilgrimageWithRoofAndPaintings(LingoTestBase):
+    options = {
+        "enable_pilgrimage": "true",
+        "shuffle_colors": "false",
+        "shuffle_doors": "complex",
+        "pilgrimage_allows_roof_access": "true",
+        "pilgrimage_allows_paintings": "true",
+        "early_color_hallways": "false"
+    }
+
+    def test_access(self):
+        doors = ["Second Room - Exit Door", "Crossroads - Roof Access", "Hub Room - Crossroads Entrance",
+                 "Outside The Undeterred - Green Painting"]
+
+        for door in doors:
+            print(door)
+            self.assertFalse(self.can_reach_location("Pilgrim Antechamber - PILGRIM"))
+            self.collect_by_name(door)
+        
+        self.assertTrue(self.can_reach_location("Pilgrim Antechamber - PILGRIM"))
+
+
+class TestPilgrimageNoRoofYesPaintings(LingoTestBase):
+    options = {
+        "enable_pilgrimage": "true",
+        "shuffle_colors": "false",
+        "shuffle_doors": "complex",
+        "pilgrimage_allows_roof_access": "false",
+        "pilgrimage_allows_paintings": "true",
+        "early_color_hallways": "false"
+    }
+
+    def test_access(self):
+        doors = ["Second Room - Exit Door", "Crossroads - Roof Access", "Hub Room - Crossroads Entrance",
+                 "Outside The Undeterred - Green Painting", "Crossroads - Tower Entrance",
+                 "Orange Tower Fourth Floor - Hot Crusts Door", "Orange Tower First Floor - Shortcut to Hub Room",
+                 "Starting Room - Street Painting"]
+
+        for door in doors:
+            print(door)
+            self.assertFalse(self.can_reach_location("Pilgrim Antechamber - PILGRIM"))
+            self.collect_by_name(door)
+        
+        self.assertTrue(self.can_reach_location("Pilgrim Antechamber - PILGRIM"))
+
+
+class TestPilgrimageNoRoofNoPaintings(LingoTestBase):
+    options = {
+        "enable_pilgrimage": "true",
+        "shuffle_colors": "false",
+        "shuffle_doors": "complex",
+        "pilgrimage_allows_roof_access": "false",
+        "pilgrimage_allows_paintings": "false",
+        "early_color_hallways": "false"
+    }
+
+    def test_access(self):
+        doors = ["Second Room - Exit Door", "Crossroads - Roof Access", "Hub Room - Crossroads Entrance",
+                 "Outside The Undeterred - Green Painting", "Orange Tower First Floor - Shortcut to Hub Room",
+                 "Starting Room - Street Painting", "Outside The Initiated - Shortcut to Hub Room",
+                 "Directional Gallery - Shortcut to The Undeterred", "Orange Tower First Floor - Salt Pepper Door",
+                 "Color Hunt - Shortcut to The Steady", "The Bearer - Entrance",
+                 "Orange Tower Fifth Floor - Quadruple Intersection", "The Tenacious - Shortcut to Hub Room",
+                 "Outside The Agreeable - Tenacious Entrance", "Crossroads - Tower Entrance",
+                 "Orange Tower Fourth Floor - Hot Crusts Door"]
+
+        for door in doors:
+            print(door)
+            self.assertFalse(self.can_reach_location("Pilgrim Antechamber - PILGRIM"))
+            self.collect_by_name(door)
+        
+        self.assertTrue(self.can_reach_location("Pilgrim Antechamber - PILGRIM"))
+
+
+class TestPilgrimageYesRoofNoPaintings(LingoTestBase):
+    options = {
+        "enable_pilgrimage": "true",
+        "shuffle_colors": "false",
+        "shuffle_doors": "complex",
+        "pilgrimage_allows_roof_access": "true",
+        "pilgrimage_allows_paintings": "false",
+        "early_color_hallways": "false"
+    }
+
+    def test_access(self):
+        doors = ["Second Room - Exit Door", "Crossroads - Roof Access", "Hub Room - Crossroads Entrance",
+                 "Outside The Undeterred - Green Painting", "Orange Tower First Floor - Shortcut to Hub Room",
+                 "Starting Room - Street Painting", "Outside The Initiated - Shortcut to Hub Room",
+                 "Directional Gallery - Shortcut to The Undeterred", "Orange Tower First Floor - Salt Pepper Door",
+                 "Color Hunt - Shortcut to The Steady", "The Bearer - Entrance",
+                 "Orange Tower Fifth Floor - Quadruple Intersection"]
+
+        for door in doors:
+            print(door)
+            self.assertFalse(self.can_reach_location("Pilgrim Antechamber - PILGRIM"))
+            self.collect_by_name(door)
+        
+        self.assertTrue(self.can_reach_location("Pilgrim Antechamber - PILGRIM"))
@@ -0,0 +1,213 @@
+from . import LingoTestBase
+
+
+class TestVanillaDoorsNormalSunwarps(LingoTestBase):
+    options = {
+        "shuffle_doors": "none",
+        "shuffle_colors": "true",
+        "sunwarp_access": "normal"
+    }
+
+    def test_access(self):
+        self.assertTrue(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+        self.assertFalse(self.multiworld.state.can_reach("Orange Tower Third Floor", "Region", self.player))
+
+        self.collect_by_name("Yellow")
+        self.assertTrue(self.multiworld.state.can_reach("Orange Tower Third Floor", "Region", self.player))
+        self.assertTrue(self.multiworld.state.can_reach("Outside The Initiated", "Region", self.player))
+
+
+class TestSimpleDoorsNormalSunwarps(LingoTestBase):
+    options = {
+        "shuffle_doors": "simple",
+        "sunwarp_access": "normal"
+    }
+
+    def test_access(self):
+        self.assertFalse(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+
+        self.collect_by_name("Second Room - Exit Door")
+        self.assertTrue(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+        self.assertFalse(self.multiworld.state.can_reach("Orange Tower Third Floor", "Region", self.player))
+
+        self.collect_by_name(["Crossroads - Tower Entrances", "Orange Tower Fourth Floor - Hot Crusts Door"])
+        self.assertTrue(self.multiworld.state.can_reach("Orange Tower Third Floor", "Region", self.player))
+        self.assertTrue(self.multiworld.state.can_reach("Outside The Initiated", "Region", self.player))
+
+
+class TestSimpleDoorsDisabledSunwarps(LingoTestBase):
+    options = {
+        "shuffle_doors": "simple",
+        "sunwarp_access": "disabled"
+    }
+
+    def test_access(self):
+        self.assertFalse(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+
+        self.collect_by_name("Second Room - Exit Door")
+        self.assertFalse(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+        self.assertFalse(self.multiworld.state.can_reach("Orange Tower Third Floor", "Region", self.player))
+
+        self.collect_by_name(["Hub Room - Crossroads Entrance", "Crossroads - Tower Entrancse",
+                              "Orange Tower Fourth Floor - Hot Crusts Door"])
+        self.assertFalse(self.multiworld.state.can_reach("Orange Tower Third Floor", "Region", self.player))
+        self.assertFalse(self.multiworld.state.can_reach("Outside The Initiated", "Region", self.player))
+
+
+class TestSimpleDoorsUnlockSunwarps(LingoTestBase):
+    options = {
+        "shuffle_doors": "simple",
+        "sunwarp_access": "unlock"
+    }
+
+    def test_access(self):
+        self.assertFalse(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+
+        self.collect_by_name("Second Room - Exit Door")
+        self.assertFalse(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+
+        self.collect_by_name(["Crossroads - Tower Entrances", "Orange Tower Fourth Floor - Hot Crusts Door"])
+        self.assertFalse(self.multiworld.state.can_reach("Orange Tower Third Floor", "Region", self.player))
+        self.assertFalse(self.multiworld.state.can_reach("Outside The Initiated", "Region", self.player))
+
+        self.collect_by_name("Sunwarps")
+        self.assertTrue(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+        self.assertTrue(self.multiworld.state.can_reach("Orange Tower Third Floor", "Region", self.player))
+        self.assertTrue(self.multiworld.state.can_reach("Outside The Initiated", "Region", self.player))
+
+
+class TestComplexDoorsNormalSunwarps(LingoTestBase):
+    options = {
+        "shuffle_doors": "complex",
+        "sunwarp_access": "normal"
+    }
+
+    def test_access(self):
+        self.assertFalse(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+
+        self.collect_by_name("Second Room - Exit Door")
+        self.assertTrue(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+        self.assertFalse(self.multiworld.state.can_reach("Orange Tower Third Floor", "Region", self.player))
+
+        self.collect_by_name(["Crossroads - Tower Entrance", "Orange Tower Fourth Floor - Hot Crusts Door"])
+        self.assertTrue(self.multiworld.state.can_reach("Orange Tower Third Floor", "Region", self.player))
+        self.assertTrue(self.multiworld.state.can_reach("Outside The Initiated", "Region", self.player))
+
+
+class TestComplexDoorsDisabledSunwarps(LingoTestBase):
+    options = {
+        "shuffle_doors": "complex",
+        "sunwarp_access": "disabled"
+    }
+
+    def test_access(self):
+        self.assertFalse(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+
+        self.collect_by_name("Second Room - Exit Door")
+        self.assertFalse(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+        self.assertFalse(self.multiworld.state.can_reach("Orange Tower Third Floor", "Region", self.player))
+
+        self.collect_by_name(["Hub Room - Crossroads Entrance", "Crossroads - Tower Entrance",
+                              "Orange Tower Fourth Floor - Hot Crusts Door"])
+        self.assertFalse(self.multiworld.state.can_reach("Orange Tower Third Floor", "Region", self.player))
+        self.assertFalse(self.multiworld.state.can_reach("Outside The Initiated", "Region", self.player))
+
+
+class TestComplexDoorsIndividualSunwarps(LingoTestBase):
+    options = {
+        "shuffle_doors": "complex",
+        "sunwarp_access": "individual"
+    }
+
+    def test_access(self):
+        self.assertFalse(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+
+        self.collect_by_name("Second Room - Exit Door")
+        self.assertFalse(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+
+        self.collect_by_name("1 Sunwarp")
+        self.assertTrue(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+
+        self.collect_by_name(["Crossroads - Tower Entrance", "Orange Tower Fourth Floor - Hot Crusts Door"])
+        self.assertFalse(self.multiworld.state.can_reach("Orange Tower Third Floor", "Region", self.player))
+        self.assertFalse(self.multiworld.state.can_reach("Outside The Initiated", "Region", self.player))
+
+        self.collect_by_name("2 Sunwarp")
+        self.assertTrue(self.multiworld.state.can_reach("Orange Tower Third Floor", "Region", self.player))
+        self.assertFalse(self.multiworld.state.can_reach("Outside The Initiated", "Region", self.player))
+
+        self.collect_by_name("3 Sunwarp")
+        self.assertTrue(self.multiworld.state.can_reach("Outside The Initiated", "Region", self.player))
+
+
+class TestComplexDoorsProgressiveSunwarps(LingoTestBase):
+    options = {
+        "shuffle_doors": "complex",
+        "sunwarp_access": "progressive"
+    }
+
+    def test_access(self):
+        self.assertFalse(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+
+        self.collect_by_name("Second Room - Exit Door")
+        self.assertFalse(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+
+        progressive_pilgrimage = self.get_items_by_name("Progressive Pilgrimage")
+        self.collect(progressive_pilgrimage[0])
+        self.assertTrue(self.multiworld.state.can_reach("Crossroads", "Region", self.player))
+
+        self.collect_by_name(["Crossroads - Tower Entrance", "Orange Tower Fourth Floor - Hot Crusts Door"])
+        self.assertFalse(self.multiworld.state.can_reach("Orange Tower Third Floor", "Region", self.player))
+        self.assertFalse(self.multiworld.state.can_reach("Outside The Initiated", "Region", self.player))
+
+        self.collect(progressive_pilgrimage[1])
+        self.assertTrue(self.multiworld.state.can_reach("Orange Tower Third Floor", "Region", self.player))
+        self.assertFalse(self.multiworld.state.can_reach("Outside The Initiated", "Region", self.player))
+
+        self.collect(progressive_pilgrimage[2])
+        self.assertTrue(self.multiworld.state.can_reach("Outside The Initiated", "Region", self.player))
+
+
+class TestUnlockSunwarpPilgrimage(LingoTestBase):
+    options = {
+        "sunwarp_access": "unlock",
+        "shuffle_colors": "false",
+        "enable_pilgrimage": "true"
+    }
+
+    def test_access(self):
+        self.assertFalse(self.can_reach_location("Pilgrim Antechamber - PILGRIM"))
+
+        self.collect_by_name("Sunwarps")
+
+        self.assertTrue(self.can_reach_location("Pilgrim Antechamber - PILGRIM"))
+
+
+class TestIndividualSunwarpPilgrimage(LingoTestBase):
+    options = {
+        "sunwarp_access": "individual",
+        "shuffle_colors": "false",
+        "enable_pilgrimage": "true"
+    }
+
+    def test_access(self):
+        for i in range(1, 7):
+            self.assertFalse(self.can_reach_location("Pilgrim Antechamber - PILGRIM"))
+            self.collect_by_name(f"{i} Sunwarp")
+
+        self.assertTrue(self.can_reach_location("Pilgrim Antechamber - PILGRIM"))
+
+
+class TestProgressiveSunwarpPilgrimage(LingoTestBase):
+    options = {
+        "sunwarp_access": "progressive",
+        "shuffle_colors": "false",
+        "enable_pilgrimage": "true"
+    }
+
+    def test_access(self):
+        for item in self.get_items_by_name("Progressive Pilgrimage"):
+            self.assertFalse(self.can_reach_location("Pilgrim Antechamber - PILGRIM"))
+            self.collect(item)
+
+        self.assertTrue(self.can_reach_location("Pilgrim Antechamber - PILGRIM"))