13 files changed, 368 insertions, 83 deletions

@@ -7,6 +7,7 @@ var SCRIPT_multiplayer
 var SCRIPT_mypainting
 var SCRIPT_notifier
 var SCRIPT_panel
+var SCRIPT_pilgrimage_terminator
 var SCRIPT_uuid
 
 var ap_server = ""
@@ -17,59 +18,28 @@ var enable_multiplayer = false
 var track_player = false
 var connection_history = []
 
-const my_version = "2.2.0"
-const ap_version = {"major": 0, "minor": 4, "build": 5, "class": "Version"}
+const my_version = "3.0.1"
+const ap_version = {"major": 0, "minor": 4, "build": 6, "class": "Version"}
 const color_items = [
         "White", "Black", "Red", "Blue", "Green", "Brown", "Gray", "Orange", "Purple", "Yellow"
 ]
 const progressive_items = {
         "Progressive Orange Tower":
-        [
-                {"item": "Orange Tower - Second Floor", "display": "Second Floor"},
-                {"item": "Orange Tower - Third Floor", "display": "Third Floor"},
-                {"item": "Orange Tower - Fourth Floor", "display": "Fourth Floor"},
-                {"item": "Orange Tower - Fifth Floor", "display": "Fifth Floor"},
-                {"item": "Orange Tower - Sixth Floor", "display": "Sixth Floor"},
-                {"item": "Orange Tower - Seventh Floor", "display": "Seventh Floor"},
-        ],
+        ["Second Floor", "Third Floor", "Fourth Floor", "Fifth Floor", "Sixth Floor", "Seventh Floor"],
         "Progressive Art Gallery":
-        [
-                {"item": "Art Gallery - Second Floor", "display": "Second Floor"},
-                {"item": "Art Gallery - Third Floor", "display": "Third Floor"},
-                {"item": "Art Gallery - Fourth Floor", "display": "Fourth Floor"},
-                {"item": "Art Gallery - Fifth Floor", "display": "Fifth Floor"},
-                {"item": "Art Gallery - Exit", "display": "Exit"},
-        ],
-        "Progressive Hallway Room":
-        [
-                {"item": "Outside The Agreeable - Hallway Door", "display": "First Door"},
-                {"item": "Hallway Room (2) - Exit", "display": "Second Door"},
-                {"item": "Hallway Room (3) - Exit", "display": "Third Door"},
-                {"item": "Hallway Room (4) - Exit", "display": "Fourth Door"},
-        ],
-        "Progressive Fearless":
-        [
-                {"item": "The Fearless (First Floor) - Second Floor", "display": "Second Floor"},
-                {"item": "The Fearless (Second Floor) - Third Floor", "display": "Third Floor"},
-        ],
+        ["Second Floor", "Third Floor", "Fourth Floor", "Fifth Floor", "Exit"],
+        "Progressive Hallway Room": ["First Door", "Second Door", "Third Door", "Fourth Door"],
+        "Progressive Fearless": ["Second Floor", "Third Floor"],
         "Progressive Colorful":
-        [
-                {"item": "The Colorful - White Door", "display": "White"},
-                {"item": "The Colorful - Black Door", "display": "Black"},
-                {"item": "The Colorful - Red Door", "display": "Red"},
-                {"item": "The Colorful - Yellow Door", "display": "Yellow"},
-                {"item": "The Colorful - Blue Door", "display": "Blue"},
-                {"item": "The Colorful - Purple Door", "display": "Purple"},
-                {"item": "The Colorful - Orange Door", "display": "Orange"},
-                {"item": "The Colorful - Green Door", "display": "Green"},
-                {"item": "The Colorful - Brown Door", "display": "Brown"},
-                {"item": "The Colorful - Gray Door", "display": "Gray"},
-        ]
+        ["White", "Black", "Red", "Yellow", "Blue", "Purple", "Orange", "Green", "Brown", "Gray"],
+        "Progressive Pilgrimage":
+        ["1 Sunwarp", "2 Sunwarp", "3 Sunwarp", "4 Sunwarp", "5 Sunwarp", "6 Sunwarp"]
 }
 
 const kTHE_END = 0
 const kTHE_MASTER = 1
 const kLEVEL_2 = 2
+const kPILGRIMAGE = 3
 
 const kNO_PANEL_SHUFFLE = 0
 const kREARRANGE_PANELS = 1
@@ -83,6 +53,12 @@ const kCLASSIFICATION_REMOTE_NORMAL = 0
 const kCLASSIFICATION_REMOTE_REDUCED = 1
 const kCLASSIFICATION_REMOTE_INSANITY = 2
 
+const kSUNWARP_ACCESS_NORMAL = 0
+const kSUNWARP_ACCESS_DISABLED = 1
+const kSUNWARP_ACCESS_UNLOCK = 2
+const kSUNWARP_ACCESS_INDIVIDUAL = 3
+const kSUNWARP_ACCESS_PROGRESSIVE = 4
+
 var _client = WebSocketClient.new()
 var _should_process = false
 var _initiated_disconnect = false
@@ -115,10 +91,17 @@ var _door_shuffle = false
 var _color_shuffle = false
 var _panel_shuffle = 0  # none, rearrange
 var _painting_shuffle = false
+var _sunwarp_access = 0  # normal, disabled, unlock, progressive
 var _mastery_achievements = 21
 var _level_2_requirement = 223
 var _location_classification_bit = 0
 var _early_color_hallways = false
+var _pilgrimage_compatibility = false  # set to true for pre-0.4.6
+var _pilgrimage_enabled = false
+var _pilgrimage_allows_roof_access = false
+var _pilgrimage_allows_paintings = false
+var _sunwarp_shuffle = false
+var _sunwarp_mapping = []
 var _slot_seed = 0
 
 var _map_loaded = false
@@ -293,6 +276,10 @@ func _on_data():
                                 _painting_shuffle = _slot_data["shuffle_paintings"]
                         if _slot_data.has("shuffle_panels"):
                                 _panel_shuffle = _slot_data["shuffle_panels"]
+                        if _slot_data.has("sunwarp_access"):
+                                _sunwarp_access = _slot_data["sunwarp_access"]
+                        else:
+                                _sunwarp_access = kSUNWARP_ACCESS_NORMAL
                         if _slot_data.has("seed"):
                                 _slot_seed = _slot_data["seed"]
                         if _slot_data.has("painting_entrance_to_exit"):
@@ -316,6 +303,25 @@ func _on_data():
                                 _early_color_hallways = _slot_data["early_color_hallways"]
                         else:
                                 _early_color_hallways = false
+                        if _slot_data.has("enable_pilgrimage"):
+                                _pilgrimage_enabled = _slot_data["enable_pilgrimage"]
+                        else:
+                                _pilgrimage_compatibility = true
+                                _pilgrimage_enabled = true
+                        if _slot_data.has("pilgrimage_allows_roof_access"):
+                                _pilgrimage_allows_roof_access = _slot_data["pilgrimage_allows_roof_access"]
+                        else:
+                                _pilgrimage_allows_roof_access = true
+                        if _slot_data.has("pilgrimage_allows_paintings"):
+                                _pilgrimage_allows_paintings = _slot_data["pilgrimage_allows_paintings"]
+                        else:
+                                _pilgrimage_allows_paintings = true
+                        if _slot_data.has("shuffle_sunwarps"):
+                                _sunwarp_shuffle = _slot_data["shuffle_sunwarps"]
+                        else:
+                                _sunwarp_shuffle = false
+                        if _slot_data.has("sunwarp_permutation"):
+                                _sunwarp_mapping = _slot_data["sunwarp_permutation"]
 
                         if _door_shuffle and not _early_color_hallways:
                                 _location_classification_bit += kCLASSIFICATION_LOCAL_SMALL_SPHERE_ONE
@@ -702,16 +708,22 @@ func processItem(item, index, from, flags):
                                 if painting_node != null:
                                         painting_node.get_node("Script").movePainting()
 
+        if gamedata.warp_ids_by_item_id.has(int(item)):
+                var warpsNode = get_tree().get_root().get_node("Spatial/Warps")
+                for warp_id in gamedata.warp_ids_by_item_id[int(item)]:
+                        warpsNode.get_node(warp_id).unlock_warp()
+
         # Handle progressive items.
-        if item_name in progressive_items.keys():
-                if not item_name in _progressive_progress:
-                        _progressive_progress[item_name] = 0
+        if int(item) in gamedata.items_by_progressive_id.keys():
+                if not int(item) in _progressive_progress:
+                        _progressive_progress[int(item)] = 0
 
-                if _progressive_progress[item_name] < progressive_items[item_name].size():
-                        var subitem_name = progressive_items[item_name][_progressive_progress[item_name]]["item"]
-                        global._print(subitem_name)
-                        processItem(_item_name_to_id[subitem_name], null, null, null)
-                        _progressive_progress[item_name] += 1
+                if _progressive_progress[int(item)] < gamedata.items_by_progressive_id[int(item)].size():
+                        var subitems = gamedata.items_by_progressive_id[int(item)]
+                        var subitem_id = subitems[_progressive_progress[int(item)]]
+                        global._print("Subitem: %d" % subitem_id)
+                        processItem(subitem_id, null, null, null)
+                        _progressive_progress[int(item)] += 1
 
         if _color_shuffle and color_items.has(_item_id_to_name[item]):
                 var lcol = _item_id_to_name[item].to_lower()
@@ -725,8 +737,8 @@ func processItem(item, index, from, flags):
                 saveLocaldata()
 
                 if item_name in progressive_items:
-                        var subitem = progressive_items[item_name][_progressive_progress[item_name] - 1]
-                        item_name += " (%s)" % subitem["display"]
+                        var subitem = progressive_items[item_name][_progressive_progress[int(item)] - 1]
+                        item_name += " (%s)" % subitem
 
                 var player_name = "Unknown"
                 if _player_name_by_slot.has(from):
@@ -762,6 +774,10 @@ func paintingIsVanilla(painting):
         return !$Gamedata.mentioned_paintings.has(painting)
 
 
+func warpIsVanilla(warp):
+        return !$Gamedata.mentioned_warps.has(warp)
+
+
 func evaluateSolvability():
         emit_signal("evaluate_solvability")
 
@@ -354,6 +354,8 @@ func _load():
                 victory_condition = "the master"
         elif apclient._victory_condition == apclient.kLEVEL_2:
                 victory_condition = "level 2"
+        elif apclient._victory_condition == apclient.kPILGRIMAGE:
+                victory_condition = "pilgrimage"
 
         set_static_panel("Entry Room/Panel_this_this", victory_condition)
         set_static_panel("Entry Room/Panel_hidden_hidden", "hewwo")
@@ -583,11 +585,84 @@ func _load():
                 level_2.get_node("Viewport/GUI/Panel/TextEdit").connect(
                         "answer_correct", apclient, "completedGoal"
                 )
+        elif apclient._victory_condition == apclient.kPILGRIMAGE:
+                var pilgrim_panel = self.get_node("Panels/Lingo Room/Panel_pilgrim")
+                pilgrim_panel.get_node("Viewport/GUI/Panel/TextEdit").connect(
+                        "answer_correct", apclient, "completedGoal"
+                )
         else:
                 var the_end = self.get_node("Decorations/EndPanel/Panel_end_end")
                 the_end.get_node("Viewport/GUI/Panel/TextEdit").connect(
                         "answer_correct", apclient, "completedGoal"
                 )
+        
+        # If pilgrimage does not allow roof access, add a node on the Crossroads
+        # Roof Access stairs that disables it.
+        if !apclient._pilgrimage_allows_roof_access:
+                var terminator = apclient.SCRIPT_pilgrimage_terminator.new()
+                terminator.name = "RoofAccessPilgrimageTerminator"
+                terminator.translation.x = -36
+                terminator.translation.y = 3
+                terminator.translation.z = -35
+
+                var terminator_shape = CollisionShape.new()
+                terminator_shape.shape = BoxShape.new()
+                terminator_shape.shape.extents.x = 0.1
+
+                terminator.add_child(terminator_shape)
+                get_node("Decorations").add_child(terminator)
+        
+        if apclient._sunwarp_shuffle:
+                # Sunwarps 1 and 6 are rotated differently from the rest, so we have to fix that.
+                get_node("Decorations/Teleporter Windows/localmap").rotation_degrees.y = 0
+                get_node("Decorations/Teleporter Windows/localmap2").rotation_degrees.y = 0
+                get_node("Decorations/Teleporter Windows/localmap11").rotation_degrees.y = 0
+                get_node("Decorations/Teleporter Windows/localmap12").rotation_degrees.y = 0
+                get_node("Decorations/Teleporter Windows/localmap13").rotation_degrees.y = -90
+
+                get_node("Warps/Teleporter Warps/Sunwarp_enter_1").translation.x = 19.5
+                get_node("Warps/Teleporter Warps/Sunwarp_exit_1").translation.x = -15.5
+                get_node("Warps/Teleporter Warps/Sunwarp_enter_6").translation.x = 4.5
+                get_node("Warps/Teleporter Warps/Sunwarp_exit_6").translation.x = -37.5
+                get_node("Warps/Teleporter Warps/Sunwarp_exit_7").translation.z = 23.5
+
+                # Change the sunwarps in accordance with the mapping.
+                var sw_orig_translations = []
+                var sw_text_translations = []
+                var sw_text_rotations = []
+                for i in range(1,7):
+                        sw_orig_translations.append(get_node("Warps/Teleporter Warps/Sunwarp_enter_%d" % i).translation)
+                        sw_text_translations.append(get_node("Decorations/Signs/Sunwarp Numbers/enter_%d" % i).translation)
+                        sw_text_rotations.append(get_node("Decorations/Signs/Sunwarp Numbers/enter_%d" % i).rotation_degrees)
+                for i in range(1,7):
+                        sw_orig_translations.append(get_node("Warps/Teleporter Warps/Sunwarp_exit_%d" % i).translation)
+                        sw_text_translations.append(get_node("Decorations/Signs/Sunwarp Numbers/exit_%d" % i).translation)
+                        sw_text_rotations.append(get_node("Decorations/Signs/Sunwarp Numbers/exit_%d" % i).rotation_degrees)
+
+                var sw_enter_indicators = [4, 5, 6, 12, 7, 10]
+                for i in range(1,7):
+                        get_node("Warps/Teleporter Warps/Sunwarp_enter_%d" % i).translation = sw_orig_translations[apclient._sunwarp_mapping[i-1]]
+                        get_node("Warps/Teleporter Warps/Sunwarp_exit_%d" % i).translation = sw_orig_translations[apclient._sunwarp_mapping[i+5]]
+
+                        get_node("Decorations/Signs/Sunwarp Numbers/enter_%d" % i).translation = sw_text_translations[apclient._sunwarp_mapping[i-1]]
+                        get_node("Decorations/Signs/Sunwarp Numbers/enter_%d" % i).rotation_degrees = sw_text_rotations[apclient._sunwarp_mapping[i-1]]
+
+                        get_node("Decorations/Signs/Sunwarp Numbers/exit_%d" % i).translation = sw_text_translations[apclient._sunwarp_mapping[i+5]]
+                        get_node("Decorations/Signs/Sunwarp Numbers/exit_%d" % i).rotation_degrees = sw_text_rotations[apclient._sunwarp_mapping[i+5]]
+
+                        var enter_rot = _dir_to_int(gamedata.sunwarps[apclient._sunwarp_mapping[i-1]]["orientation"]) * 90
+                        var exit_rot = _dir_to_int(gamedata.sunwarps[apclient._sunwarp_mapping[i+5]]["orientation"]) * 90
+                        var final_rot = enter_rot - exit_rot
+                        if final_rot < 0:
+                                final_rot += 360
+                        get_node("Warps/Teleporter Warps/Sunwarp_enter_%d" % i).rotate = str(final_rot)
+
+                        var sw_enter_indicator_pos = gamedata.sunwarps[apclient._sunwarp_mapping[i-1]]["entrance_indicator_pos"]
+                        var sw_enter_indicator = get_node("Decorations/Signs/Welcome Back Signs/Sign%d" % sw_enter_indicators[i-1])
+                        sw_enter_indicator.translation.x = sw_enter_indicator_pos[0]
+                        sw_enter_indicator.translation.y = sw_enter_indicator_pos[1]
+                        sw_enter_indicator.translation.z = sw_enter_indicator_pos[2]
+                        sw_enter_indicator.rotation_degrees.y = (enter_rot * -1) + 180
 
         # Create the effects node.
         var effects_script = apclient.SCRIPT_effects
@@ -718,3 +793,15 @@ func set_small_gridmap_tile(x, y, z, tile):
 
 func archipelago_disconnected(reason):
         messages.showMessage(reason)
+
+
+func _dir_to_int(dir):
+        if dir == "north":
+                return 0
+        elif dir == "west":
+                return 1
+        elif dir == "south":
+                return 2
+        elif dir == "east":
+                return 3
+        return 4
@@ -86,6 +86,11 @@ func _looked_at(body, painting):
                         body.rotate_y(3 * PI / 2)
                         body.velocity = body.velocity.rotated(Vector3(0, 1, 0), 3 * PI / 2)
 
+                var apclient = global.get_node("Archipelago")
+                if !apclient._pilgrimage_allows_paintings:
+                        global.sunwarp = 1
+                        body.get_node("pivot/camera/sunwarp_background").visible = false
+
 
 func _dir_to_int(dir):
         if dir == "north":
@@ -0,0 +1,10 @@
+extends "res://scripts/painting.gd"
+
+func _looked_at(var body, var painting):
+    ._looked_at(body, painting)
+    
+    if body.is_in_group("player") && (painting.get_name() == self.get_name()):
+        var apclient = global.get_node("Archipelago")
+        if !apclient._pilgrimage_allows_paintings:
+            global.sunwarp = 1
+            body.get_node("pivot/camera/sunwarp_background").visible = false
@@ -3,9 +3,23 @@ extends "res://scripts/painting_eye.gd"
 
 func _answer_correct():
         var apclient = global.get_node("Archipelago")
-        if not apclient._door_shuffle or apclient.paintingIsVanilla(self.name):
+        if !apclient._pilgrimage_compatibility and get_name() == "pilgrim_painting2":
+                # When pilgrimage is enabled, the HOT CRUST panel should actually move the sun painting.
+                if apclient._pilgrimage_enabled:
+                        movePainting()
+        elif not apclient._door_shuffle or apclient.paintingIsVanilla(self.name):
                 ._answer_correct()
 
 
 func movePainting():
         ._answer_correct()
+
+
+func _looked_at(var body, var painting):
+        ._looked_at(body, painting)
+
+        if body.is_in_group("player") && (painting.get_name() == self.get_name()):
+                var apclient = global.get_node("Archipelago")
+                if !apclient._pilgrimage_allows_paintings:
+                        global.sunwarp = 1
+                        body.get_node("pivot/camera/sunwarp_background").visible = false
@@ -9,3 +9,13 @@ func _answer_correct():
 
 func movePainting():
         ._answer_correct()
+
+
+func _looked_at(var body, var painting):
+        ._looked_at(body, painting)
+
+        if body.is_in_group("player") && (painting.get_name() == self.get_name()):
+                var apclient = global.get_node("Archipelago")
+                if !apclient._pilgrimage_allows_paintings:
+                        global.sunwarp = 1
+                        body.get_node("pivot/camera/sunwarp_background").visible = false
@@ -22,7 +22,7 @@ func _ready():
                 else:
                         atbash_text += old_char
 
-        self.get_parent().get_node("Viewport/GUI/Panel/TextEdit").connect(
+        var _ignore = self.get_parent().get_node("Viewport/GUI/Panel/TextEdit").connect(
                 "answer_correct", self, "answer_correct"
         )
 
@@ -0,0 +1,11 @@
+extends Area
+
+
+func _ready():
+        var _connected = self.connect("body_entered", self, "_body_entered")
+
+
+func _body_entered(body):
+        if body.is_in_group("player"):
+                global.sunwarp = 1
+                body.get_node("pivot/camera/sunwarp_background").visible = false
@@ -30,6 +30,8 @@ func _ready():
                 apclient_instance.SCRIPT_mypainting = load("user://maps/Archipelago/mypainting.gd")
                 apclient_instance.SCRIPT_notifier = load("user://maps/Archipelago/notifier.gd")
                 apclient_instance.SCRIPT_panel = load("user://maps/Archipelago/panel.gd")
+                var pilg_term = load("user://maps/Archipelago/pilgrimage_terminator.gd")
+                apclient_instance.SCRIPT_pilgrimage_terminator = pilg_term
                 apclient_instance.SCRIPT_uuid = load("user://maps/Archipelago/vendor/uuid.gd")
 
                 var apdata = ResourceLoader.load("user://maps/Archipelago/gamedata.gd")
@@ -45,6 +47,7 @@ func _ready():
                 # Let's also inject any scripts we need to inject now.
                 installScriptExtension(apclient_instance.SCRIPT_doorControl)
                 installScriptExtension(ResourceLoader.load("user://maps/Archipelago/load.gd"))
+                installScriptExtension(ResourceLoader.load("user://maps/Archipelago/painting.gd"))
                 installScriptExtension(ResourceLoader.load("user://maps/Archipelago/painting_eye.gd"))
                 installScriptExtension(ResourceLoader.load("user://maps/Archipelago/painting_scenery.gd"))
                 installScriptExtension(ResourceLoader.load("user://maps/Archipelago/panelLevelSwitch.gd"))
@@ -52,6 +55,7 @@ func _ready():
                 installScriptExtension(ResourceLoader.load("user://maps/Archipelago/panelInput.gd"))
                 installScriptExtension(ResourceLoader.load("user://maps/Archipelago/pause_menu.gd"))
                 installScriptExtension(ResourceLoader.load("user://maps/Archipelago/player.gd"))
+                installScriptExtension(ResourceLoader.load("user://maps/Archipelago/teleport.gd"))
                 installScriptExtension(ResourceLoader.load("user://maps/Archipelago/worldTransporter.gd"))
 
         var apclient = global.get_node("Archipelago")
@@ -0,0 +1,27 @@
+extends "res://scripts/teleport.gd"
+
+var _unlocked = true
+
+
+func _ready():
+        var apclient = global.get_node("Archipelago")
+        if self.get_parent().name == "Teleporter Warps":
+                if apclient._sunwarp_access != apclient.kSUNWARP_ACCESS_NORMAL:
+                        _unlocked = false
+        elif apclient._door_shuffle and !apclient.warpIsVanilla(self.get_parent().name + "/" + self.name):
+                _unlocked = false
+
+
+func _body_entered(body):
+        if _unlocked:
+                ._body_entered(body)
+
+                if body.is_in_group("player"):
+                        var apclient = global.get_node("Archipelago")
+                        if !apclient._pilgrimage_enabled:
+                                global.sunwarp = 1
+                                body.get_node("pivot/camera/sunwarp_background").visible = false
+
+
+func unlock_warp():
+        _unlocked = true
@@ -1,5 +1,35 @@
 # lingo-archipelago Releases
 
+## v3.0.1 - 2024-04-22
+
+- Fixed issue where Progressive Hallway Room did not work properly on worlds
+  generated on Archipelago 0.4.5 or earlier.
+
+Download:
+[lingo-archipelago-v3.0.1.zip](https://files.fourisland.com/releases/lingo-archipelago/lingo-archipelago-v3.0.1.zip)<br/>
+Source: [v3.0.1](https://code.fourisland.com/lingo-archipelago/tag/?h=v3.0.1)
+
+## v3.0.0 - 2024-04-22
+
+- [Archipelago 0.4.6](https://github.com/ArchipelagoMW/Archipelago/releases/tag/0.4.6)
+  has been released! This includes a major update for Lingo: The Pilgrim Update!
+  - The pilgrimage can now be disabled entirely.
+  - When enabled, the pilgrimage uses real logic to determine whether it is
+    possible, rather than a specific route.
+  - You can now specify whether paintings and/or roof access are allowed for the
+    pilgrimage.
+  - You can lock access to sunwarps behind item keys, like door shuffle.
+  - Sunwarps can be shuffled, similar to painting shuffle.
+  - Pilgrimage has been added as a win condition.
+- This update should retain backwards compatibility with Archipelago 0.4.5
+  worlds. World generated in Archipelago 0.4.4 will likely continue to have
+  minor problems, and it is best to downpatch to v1.2.1 if you need to play an
+  older world.
+
+Download:
+[lingo-archipelago-v3.0.0.zip](https://files.fourisland.com/releases/lingo-archipelago/lingo-archipelago-v3.0.0.zip)<br/>
+Source: [v3.0.0](https://code.fourisland.com/lingo-archipelago/tag/?h=v3.0.0)
+
 ## v2.2.0 - 2024-04-17
 
 - The last ten connections are now saved in a list so that you can easily switch
@@ -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.
@@ -12,15 +12,20 @@ CLASSIFICATION_SMALL_SPHERE_ONE = 8
 
 panel_to_id = {}
 door_groups = {}
+warp_groups = {}
 
 panel_output = []
 door_ids_by_item_id = {}
 painting_ids_by_item_id = {}
+warp_ids_by_item_id = {}
 panel_ids_by_location_id = {}
 classification_by_location_id = {}
+sunwarps = Array.new(12) {Hash.new}
 mentioned_doors = Set[]
 mentioned_paintings = Set[]
+mentioned_warps = Set[]
 painting_output = {}
+items_by_progressive_id = {}
 
 ids_config = YAML.load_file(idspath)
 
@@ -93,6 +98,30 @@ config.each do |room_name, room_data|
       painting_output[painting["id"]] = painting
     end
   end
+
+  if room_data.include? "sunwarps"
+    room_data["sunwarps"].each do |sunwarp|
+      index = sunwarp["dots"] - 1
+      if sunwarp["direction"] == "exit" then
+        index += 6
+      end
+      sunwarps[index] = sunwarp
+    end
+  end
+
+  if room_data.include? "progression"
+    room_data["progression"].each do |progressive_item_name, progression|
+      progressive_id = ids_config["progression"][progressive_item_name]
+      items_by_progressive_id[progressive_id] = []
+
+      progression.each do |item|
+        item_room_name = (item.kind_of? Hash) ? item["room"] : room_name
+        item_item_name = (item.kind_of? Hash) ? item["door"] : item
+
+        items_by_progressive_id[progressive_id] << ids_config["doors"][item_room_name][item_item_name]["item"]
+      end
+    end
+  end
 end
 
 config.each do |room_name, room_data|
@@ -157,6 +186,23 @@ config.each do |room_name, room_data|
           painting_ids_by_item_id[item_id] = internal_painting_ids
           mentioned_paintings.merge(internal_painting_ids)
         end
+
+        if door.include? "warp_id"
+          internal_warp_ids = []
+          if door["warp_id"].kind_of? String
+            internal_warp_ids = [door["warp_id"]]
+          else
+            internal_warp_ids = door["warp_id"]
+          end
+
+          if door.include? "door_group"
+            warp_groups[door["door_group"]] ||= Set[]
+            warp_groups[door["door_group"]].merge(internal_warp_ids)
+          end
+
+          warp_ids_by_item_id[item_id] = internal_warp_ids
+          mentioned_warps.merge(internal_warp_ids)
+        end
       end
     end
   end
@@ -167,6 +213,11 @@ door_groups.each do |group_name, door_ids|
   door_ids_by_item_id[item_id] = door_ids.to_a
 end
 
+warp_groups.each do |group_name, warp_ids|
+  item_id = ids_config["door_groups"][group_name]
+  warp_ids_by_item_id[item_id] = warp_ids.to_a
+end
+
 File.open(outputpath, "w") do |f|
   f.write "extends Node\n\nvar panels = ["
   f.write(panel_output.map do |panel|
@@ -186,6 +237,12 @@ File.open(outputpath, "w") do |f|
       "\"#{painting_id}\""
     end.join(",") + "]"
   end.join(","))
+  f.write "}\nvar warp_ids_by_item_id = {"
+  f.write(warp_ids_by_item_id.map do |item_id, warp_ids|
+    "#{item_id}:[" + warp_ids.map do |warp_id|
+      "\"#{warp_id}\""
+    end.join(",") + "]"
+  end.join(","))
   f.write "}\nvar panel_ids_by_location_id = {"
   f.write(panel_ids_by_location_id.map do |location_id, panel_ids|
     "#{location_id}:[" + panel_ids.map do |panel_id|
@@ -200,6 +257,10 @@ File.open(outputpath, "w") do |f|
   f.write(mentioned_paintings.map do |painting_id|
     "\"#{painting_id}\""
   end.join(","))
+  f.write "]\nvar mentioned_warps = ["
+  f.write(mentioned_warps.map do |warp_id|
+    "\"#{warp_id}\""
+  end.join(","))
   f.write "]\nvar paintings = {"
   f.write(painting_output.map do |painting_id, painting|
     "\"#{painting_id}\":{\"orientation\":\"#{painting["orientation"]}\",\"move\":#{painting.include? "move" and painting["move"]}}"
@@ -208,5 +269,13 @@ File.open(outputpath, "w") do |f|
   f.write(classification_by_location_id.map do |location_id, classification|
     "#{location_id}:#{classification}"
   end.join(","))
+  f.write "}\nvar sunwarps = ["
+  f.write(sunwarps.map do |sunwarp|
+    "{\"orientation\":\"#{sunwarp["orientation"]}\",\"entrance_indicator_pos\":#{sunwarp["entrance_indicator_pos"].to_s}}"
+  end.join(","))
+  f.write "]\nvar items_by_progressive_id = {"
+  f.write(items_by_progressive_id.map do |item_id, progression_ids|
+    "#{item_id}:[" + progression_ids.map(&:to_s).join(",") + "]"
+  end.join(","))
   f.write "}"
 end