Merge branch 'main' into color-hallways

1 files changed, 32 insertions, 30 deletions

@@ -87,6 +87,10 @@ pick and choose which ones you would like to use.
 - **Painting shuffle**: This randomizes the appearance of the paintings in the
   game, as well as which of them are warps, and the locations that they warp you
   to. It is the equivalent of an entrance randomizer in another game.
+- **Sunwarp shuffle**: This randomizes the six pairs of sunwarps. The pairing of
+  the warps can change, whether a warp is an entrance or an exit can change, and
+  the numbering can change. You can also specify whether access to the sunwarps
+  should be locked behind receiving certain items.
 
 ## Frequently Asked Questions
 
@@ -155,33 +159,31 @@ to WELCOME BACK.
 
 ### What about the pilgrimage?
 
-The intended method of reaching the Pilgrim Room in the base game is known as
-"doing a pilgrimage". It involves entering each sunwarp in order without using
-any non-painting warps in between. This is difficult to map out properly in AP
-logic, so we only consider one specific path through the map to be the canonical
-pilgrimage route. Accessing the Pilgrim Room by pilgrimage is only in logic if
-this specific route is available to you:
-
-- From the Starting Room, proceed through the Second Room and into the Hub Room.
-  Enter the first sunwarp.
-- From the Crossroads, use the front tower entrance (the one nearest The
-  Discerning; not the one next to Sword/Words). Go through the Hot Crusts Door
-  and enter the second sunwarp.
-- Enter the third sunwarp immediately after.
-- Proceed past The Initiated and through the shortcut door back to the Hub Room.
-  Go through the shortcut door to the tower's first floor and enter the fourth
-  sunwarp.
-- Use the shortcut to the Directional Gallery (the one outside The Undeterred;
-  not the one further down the hallway where the Number Hunt is), pass through
-  the Salt Pepper Door, and return to the Hub Room. Use the nearby entrance to
-  the Crossroads and proceed to the fifth sunwarp.
-- Use the door that takes you to The Steady, and then the one that takes you to
-  The Bearer, and then the one that takes you to The Initiated. Return to the
-  Hub Room once more, and enter The Tenacious via the shortcut that opens upon
-  solving the palindromes. Use the top-right door to access the area Outside the
-  Agreeable, and enter the final sunwarp.
-
-This route can be seen
-[starting at 2:47 in this video](https://youtu.be/8GfuDRRswdA?t=167). Note that
-this will almost never be required if door shuffle is enabled, as one of the
-other entrances to the room will usually be available sooner.
+You can enable or disable the pilgrimage in the world options. It defaults to
+disabled. When disabled, it is impossible to perform a pilgrimage (although the
+sunwarps will still work, as long as you haven't disabled them too). The Sun
+Painting will be added to the item pool, even if you do not have door shuffle
+on, so that you can still access the Pilgrim Antechamber.
+
+When the pilgrimage is enabled, you are required to perform a pilgrimage in
+order to access the Pilgrim Antechamber (although the Pilgrim Room itself may
+still be accessible through The Seeker if you have door shuffle on). The Sun
+Painting will not be added to the pool, and will behave as it does in vanilla
+(in that it only moves when you solve HOT CRUST inside the Pilgrim Antechamber).
+It is non-trivial to determine whether you are able to perform a pilgrimage at
+any given state, but logic will expect you to be able to figure this out. There
+are options that let you determine whether or not paintings and/or the roof
+access stairs in Crossroads will disable a pilgrimage. When sunwarps are
+shuffled, your pilgrimage must take the new numbering of the warps into
+consideration. The tracker is able to tell you whether or not the Pilgrim
+Antechamber is accessible (as long as there is an otherwise accessible check
+inside it), but it can't tell you what your pilgrimage path should be. If you
+are lost, you can check your world's spoiler log for direction on the pilgrimage
+path to take.
+
+In previous versions of the randomizer, there was a "canonical pilgrimage" that
+involved following a specific path in order to reach the Pilgrim Antechamber.
+This is no longer relevant, because all possible pilgrimage paths are now in
+logic, but you can still see the old route
+[starting at 2:47 in this video](https://youtu.be/8GfuDRRswdA?t=167) for
+reference.