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.

worlds/lingo/options.py

@@ -61,15 +61,55 @@ class ShufflePaintings(Toggle):
     display_name = "Shuffle Paintings"
 
 
+class EnablePilgrimage(Toggle):
+    """If on, you are required to complete a pilgrimage in order to access the Pilgrim Antechamber.
+    If off, the pilgrimage will be deactivated, and the sun painting will be added to the pool, even if door shuffle is off."""
+    display_name = "Enable Pilgrimage"
+
+
+class PilgrimageAllowsRoofAccess(DefaultOnToggle):
+    """If on, you may use the Crossroads roof access during a pilgrimage (and you may be expected to do so).
+    Otherwise, pilgrimage will be deactivated when going up the stairs."""
+    display_name = "Allow Roof Access for Pilgrimage"
+
+
+class PilgrimageAllowsPaintings(DefaultOnToggle):
+    """If on, you may use paintings during a pilgrimage (and you may be expected to do so).
+    Otherwise, pilgrimage will be deactivated when going through a painting."""
+    display_name = "Allow Paintings for Pilgrimage"
+
+
+class SunwarpAccess(Choice):
+    """Determines how access to sunwarps works.
+    On "normal", all sunwarps are enabled from the start.
+    On "disabled", all sunwarps are disabled. Pilgrimage must be disabled when this is used.
+    On "unlock", sunwarps start off disabled, and all six activate once you receive an item.
+    On "individual", sunwarps start off disabled, and each has a corresponding item that unlocks it.
+    On "progressive", sunwarps start off disabled, and they unlock in order using a progressive item."""
+    display_name = "Sunwarp Access"
+    option_normal = 0
+    option_disabled = 1
+    option_unlock = 2
+    option_individual = 3
+    option_progressive = 4
+
+
+class ShuffleSunwarps(Toggle):
+    """If on, the pairing and ordering of the sunwarps in the game will be randomized."""
+    display_name = "Shuffle Sunwarps"
+
+
 class VictoryCondition(Choice):
     """Change the victory condition.
     On "the_end", the goal is to solve THE END at the top of the tower.
     On "the_master", the goal is to solve THE MASTER at the top of the tower, after getting the number of achievements specified in the Mastery Achievements option.
-    On "level_2", the goal is to solve LEVEL 2 in the second room, after solving the number of panels specified in the Level 2 Requirement option."""
+    On "level_2", the goal is to solve LEVEL 2 in the second room, after solving the number of panels specified in the Level 2 Requirement option.
+    On "pilgrimage", the goal is to solve PILGRIM in the Pilgrim Antechamber, typically after performing a Pilgrimage."""
     display_name = "Victory Condition"
     option_the_end = 0
     option_the_master = 1
     option_level_2 = 2
+    option_pilgrimage = 3
 
 
 class MasteryAchievements(Range):
@@ -140,6 +180,11 @@ class LingoOptions(PerGameCommonOptions):
     shuffle_colors: ShuffleColors
     shuffle_panels: ShufflePanels
     shuffle_paintings: ShufflePaintings
+    enable_pilgrimage: EnablePilgrimage
+    pilgrimage_allows_roof_access: PilgrimageAllowsRoofAccess
+    pilgrimage_allows_paintings: PilgrimageAllowsPaintings
+    sunwarp_access: SunwarpAccess
+    shuffle_sunwarps: ShuffleSunwarps
     victory_condition: VictoryCondition
     mastery_achievements: MasteryAchievements
     level_2_requirement: Level2Requirement