Lingo: The Pilgrim Update

[hatkirby]

What is this fixing or adding?

A number of features related to sunwarps and the pilgrimage have been added.

• 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.

How was this tested?

pytest and test runs. A beta test sync was conducted successfully.

Prerelease versions of the client and tracker are available for testing too:

Apworld: lingo.zip (Rename this to lingo.apworld)
Client: archipelago-sunwarps-beta4.zip
Tracker: lingo-ap-tracker-sunwarps-beta3-win64.zip

[ScipioWright]

Reviewed the code (not the logic files), nothing looked weird. Did many test generations with some settings set to random, no failures. Asserts on invalid settings combos.
Did not test it with client.

[NewSoupVi]

Did not look at Ruby code. if entrance_name in self.world.multiworld.regions.entrance_cache[self.player] is pretty ugly, but it might also be the best option right now, which is upsetting, so I made this PR #3052 lol