Added keyholder sanity

33 files changed, 183 insertions, 8 deletions

@@ -65,7 +65,9 @@ class Lingo2World(World):
 
     def fill_slot_data(self):
         slot_options = [
-            "victory_condition", "shuffle_doors",
+            "keyholder_sanity",
+            "shuffle_doors",
+            "victory_condition",
         ]
 
         slot_data = {
@@ -8,6 +8,15 @@ class ShuffleDoors(Toggle):
     display_name = "Shuffle Doors"
 
 
+class KeyholderSanity(Toggle):
+    """
+    If enabled, 26 locations will be created for placing each key into its respective Green Ending keyholder.
+
+    NOTE: This does not apply to the two disappearing keyholders in The Congruent, as they are not part of Green Ending.
+    """
+    display_name = "Keyholder Sanity"
+
+
 class VictoryCondition(Choice):
     """Victory condition."""
     display_name = "Victory Condition"
@@ -29,4 +38,5 @@ class VictoryCondition(Choice):
 @dataclass
 class Lingo2Options(PerGameCommonOptions):
     shuffle_doors: ShuffleDoors
+    keyholder_sanity: KeyholderSanity
     victory_condition: VictoryCondition
@@ -166,6 +166,15 @@ class Lingo2PlayerLogic:
 
             self.event_loc_item_by_room.setdefault(ending.room_id, {})[event_name] = item_name
 
+        if self.world.options.keyholder_sanity:
+            for keyholder in world.static_logic.objects.keyholders:
+                if keyholder.HasField("key"):
+                    reqs = AccessRequirements()
+                    reqs.letters[keyholder.key.upper()] = 1
+
+                    self.locations_by_room.setdefault(keyholder.room_id, []).append(PlayerLocation(keyholder.ap_id,
+                                                                                                   reqs))
+
     def get_panel_reqs(self, panel_id: int, answer: str | None) -> AccessRequirements:
         if answer is None:
             if panel_id not in self.panel_reqs:
@@ -44,6 +44,11 @@ class Lingo2StaticLogic:
         for progressive in self.objects.progressives:
             self.item_id_to_name[progressive.ap_id] = progressive.name
 
+        for keyholder in self.objects.keyholders:
+            if keyholder.HasField("key"):
+                location_name = f"{self.get_room_object_location_prefix(keyholder)} - {keyholder.key.upper()} Keyholder"
+                self.location_id_to_name[keyholder.ap_id] = location_name
+
         self.item_id_to_name[self.objects.special_ids["Nothing"]] = "Nothing"
 
         self.item_name_to_id = {name: ap_id for ap_id, name in self.item_id_to_name.items()}
@@ -57,13 +62,7 @@ class Lingo2StaticLogic:
         return self.get_door_item_name(door_id)
 
     def get_door_location_name(self, door: data_pb2.Door) -> str:
-        game_map = self.objects.maps[door.map_id]
-        room = self.objects.rooms[door.room_id]
-
-        if room.HasField("panel_display_name"):
-            map_part = f"{game_map.display_name} ({room.panel_display_name})"
-        else:
-            map_part = game_map.display_name
+        map_part = self.get_room_object_location_prefix(door)
 
         if door.HasField("location_name"):
             return f"{map_part} - {door.location_name}"
@@ -129,3 +128,12 @@ class Lingo2StaticLogic:
 
     def get_room_object_map_name(self, obj) -> str:
         return self.get_map_object_map_name(self.objects.rooms[obj.room_id])
+
+    def get_room_object_location_prefix(self, obj) -> str:
+        room = self.objects.rooms[obj.room_id]
+        game_map = self.objects.maps[room.map_id]
+
+        if room.HasField("panel_display_name"):
+            return f"{game_map.display_name} ({room.panel_display_name})"
+        else:
+            return game_map.display_name
@@ -20,6 +20,11 @@ maps:
         panels:
           COLOR: 2726
           Letters: 2727
+        keyholders:
+          1: 2760
+          2: 2761
+          3: 2762
+          4: 2763
       Partial Entrance:
         panels:
           PARTIAL: 2729
@@ -155,6 +160,9 @@ maps:
       Brown Smiley:
         panels:
           OTHERS: 1667
+      C Keyholder:
+        keyholders:
+          C: 2755
       Castle:
         panels:
           FIVE (Blue): 1673
@@ -265,6 +273,9 @@ maps:
           SUMMER: 1754
           WORD: 1753
           WORDWORD: 1761
+      D Keyholder:
+        keyholders:
+          D: 2759
       Dark Light Exit:
         panels:
           GASKET: 1763
@@ -287,6 +298,9 @@ maps:
       Eye Painting:
         panels:
           REVILED: 1777
+      F Keyholder:
+        keyholders:
+          F: 2756
       F2 Room:
         panels:
           CAST: 1782
@@ -480,6 +494,8 @@ maps:
         panels:
           GOING: 1934
           TURN: 1935
+        keyholders:
+          G: 2757
       Nursery:
         panels:
           "?": 1937
@@ -547,6 +563,8 @@ maps:
           WALLS: 1986
           WHISPER: 1978
           WING: 1979
+        keyholders:
+          H: 2758
       Outside Magic Room:
         panels:
           WIZARD: 1988
@@ -1160,6 +1178,9 @@ maps:
           SWAY: 24
           TERROR: 20
           TURN: 22
+      Keyholder Room:
+        keyholders:
+          A: 2773
       Synonyms Room:
         panels:
           ADORE: 26
@@ -1452,6 +1473,9 @@ maps:
         panels:
           CIVIL: 216
           CRABS: 217
+      T Keyholder:
+        keyholders:
+          T: 2754
     doors:
       C Keyholder Blocker: 176
       C2 Door: 177
@@ -1760,6 +1784,8 @@ maps:
       X Plus:
         panels:
           ROSE: 405
+        keyholders:
+          M: 2766
       X Plus Middle Leg:
         panels:
           COLONY: 403
@@ -1789,6 +1815,9 @@ maps:
       Daedalus Extension:
         panels:
           WHERE: 433
+      Main Area:
+        keyholders:
+          P: 2765
     doors:
       Ancient Painting: 428
       Between Painting: 414
@@ -1973,6 +2002,8 @@ maps:
           LAUGH FINISHED: 573
           PLANTS: 570
           WEATHER: 568
+        keyholders:
+          X: 2770
       Outside Jail:
         panels:
           GUT: 575
@@ -2120,6 +2151,8 @@ maps:
           WAS: 631
           WINGS: 662
           YELL: 636
+        keyholders:
+          B: 2769
       Mastery Room:
         masteries:
           MASTERY: 666
@@ -2186,6 +2219,8 @@ maps:
           FLASHBACK: 705
           PUSH: 703
           PUSHBACK: 702
+        keyholders:
+          J: 2772
     doors:
       Side Door: 687
   the_keen:
@@ -2297,6 +2332,8 @@ maps:
           NAY: 774
           NIGH: 781
           TORE: 787
+        keyholders:
+          S: 2767
     doors:
       Left Room Puzzles: 763
       Main Room Door: 2750
@@ -2404,6 +2441,9 @@ maps:
           CLEOPATRA: 859
           NAPOLEON: 860
           XERXES: 857
+      U Keyholder:
+        keyholders:
+          U: 2777
     doors:
       K2 Door: 852
   the_partial:
@@ -2427,6 +2467,8 @@ maps:
           TON: 878
           TURN: 875
           UP: 870
+        keyholders:
+          L: 2771
       Reverse Side:
         panels:
           BRO: 884
@@ -2545,6 +2587,9 @@ maps:
       Turtle Entrance: 891
   the_quiet:
     rooms:
+      Keyholder Room:
+        keyholders:
+          Q: 2778
       Main Area:
         panels:
           BEE: 979
@@ -2791,6 +2836,8 @@ maps:
           STIM: 1148
           STONE: 1142
           TADPOLES: 1159
+        keyholders:
+          N: 2779
     doors:
       Books Puzzles: 1136
       Games Puzzles: 1137
@@ -3145,6 +3192,8 @@ maps:
           SWINE (Brown): 2446
           WIFE (Black): 2440
           WIFE (Brown): 2447
+        keyholders:
+          Y: 2764
     doors:
       Black Side Panels: 2427
       Brown Side Panels: 2428
@@ -3157,6 +3206,9 @@ maps:
       Control Center Entrance:
         panels:
           ZERO: 2455
+      Main Area:
+        keyholders:
+          K: 2768
       Mastery:
         masteries:
           MASTERY: 2456
@@ -3361,6 +3413,8 @@ maps:
           WAYS: 2621
           WHILE: 2613
           ZOO: 2615
+        keyholders:
+          I: 2775
       Middle Room:
         panels:
           FELLOW: 2624
@@ -3408,6 +3462,12 @@ maps:
           UNINTERESTED: 2650
           UNIRONIC: 2656
           UNLUCKY: 2654
+      V Keyholder:
+        keyholders:
+          V: 2776
+      W Keyholder:
+        keyholders:
+          W: 2774
     doors:
       Cog Rhino Hug Rug: 2586
       Control Center Orange Door: 2582
@@ -30,18 +30,22 @@ panels {
 keyholders {
   name: "1"
   path: "Components/KeyHolders/keyHolder"
+  key: "z"
 }
 keyholders {
   name: "2"
   path: "Components/KeyHolders/keyHolder2"
+  key: "e"
 }
 keyholders {
   name: "3"
   path: "Components/KeyHolders/keyHolder3"
+  key: "r"
 }
 keyholders {
   name: "4"
   path: "Components/KeyHolders/keyHolder4"
+  key: "o"
 }
 ports {
   name: "RIGHT"
@@ -3,4 +3,5 @@ panel_display_name: "North Area"
 keyholders {
   name: "C"
   path: "Components/KeyHolders/keyHolderC"
+  key: "c"
 }
@@ -3,4 +3,5 @@ panel_display_name: "Plum Room"
 keyholders {
   name: "D"
   path: "Components/KeyHolders/keyHolderD"
+  key: "d"
 }
@@ -3,4 +3,5 @@ panel_display_name: "West Area"
 keyholders {
   name: "F"
   path: "Components/KeyHolders/keyHolderF"
+  key: "f"
 }
@@ -17,6 +17,7 @@ panels {
 keyholders {
   name: "G"
   path: "Components/KeyHolders/keyHolderG"
+  key: "g"
 }
 paintings {
   name: "WON"
@@ -75,6 +75,7 @@ panels {
 keyholders {
   name: "H"
   path: "Components/KeyHolders/keyHolderH"
+  key: "h"
 }
 paintings {
   name: "CASTLE2"
@@ -2,4 +2,5 @@ name: "Keyholder Room"
 keyholders {
   name: "A"
   path: "Components/KeyHolders/keyHolderA"
+  key: "a"
 }
@@ -2,4 +2,5 @@ name: "T Keyholder"
 keyholders {
   name: "T"
   path: "Components/KeyHolders/keyHolderT"
+  key: "t"
 }
@@ -23,4 +23,5 @@ paintings {
 keyholders {
   name: "M"
   path: "Components/KeyHolders/keyHolderM"
+  key: "m"
 }
@@ -2,6 +2,7 @@ name: "Main Area"
 keyholders {
   name: "P"
   path: "Components/KeyHolders/keyHolderP"
+  key: "p"
 }
 paintings {
   name: "OWL"
@@ -52,6 +52,7 @@ panels {
 keyholders {
   name: "X"
   path: "Components/KeyHolders/keyHolderX"
+  key: "x"
 }
 ports {
   name: "INVISIBLE"
@@ -268,6 +268,7 @@ panels {
 keyholders {
   name: "B"
   path: "Components/KeyHolders/keyHolderB"
+  key: "b"
 }
 ports {
   name: "DAED1"
@@ -38,4 +38,5 @@ panels {
 keyholders {
   name: "J"
   path: "Components/KeyHolders/keyHolderJ"
+  key: "j"
 }
@@ -112,4 +112,5 @@ ports {
 keyholders {
   name: "S"
   path: "Components/KeyHolders/keyHolderS"
+  key: "s"
 }
@@ -2,4 +2,5 @@ name: "U Keyholder"
 keyholders {
   name: "U"
   path: "Components/KeyHolders/keyHolderU"
+  key: "u"
 }
@@ -106,6 +106,7 @@ keyholders {
   # This is one of the ones that's misnamed within the game.
   name: "L"
   path: "Components/KeyHolders/keyHolderI"
+  key: "l"
 }
 paintings {
   name: "F"
@@ -2,4 +2,5 @@ name: "Keyholder Room"
 keyholders {
   name: "Q"
   path: "Components/KeyHolders/keyHolderQ"
+  key: "q"
 }
@@ -160,4 +160,5 @@ ports {
 keyholders {
   name: "N"
   path: "Components/KeyHolders/keyHolderN"
+  key: "n"
 }
@@ -107,6 +107,7 @@ panels {
 keyholders {
   name: "Y"
   path: "Components/KeyHolders/keyHolderY"
+  key: "y"
 }
 ports {
   name: "GREAT"
@@ -2,4 +2,5 @@ name: "Main Area"
 keyholders {
   name: "K"
   path: "Components/KeyHolders/keyHolderK"
+  key: "k"
 }
@@ -212,6 +212,7 @@ panels {
 keyholders {
   name: "I"
   path: "Components/KeyHolders/keyHolderL"
+  key: "i"
 }
 ports {
   name: "GREAT"
@@ -2,4 +2,5 @@ name: "V Keyholder"
 keyholders {
   name: "V"
   path: "Components/KeyHolders/keyHolderV"
+  key: "v"
 }
@@ -2,4 +2,5 @@ name: "W Keyholder"
 keyholders {
   name: "W"
   path: "Components/KeyHolders/keyHolderW"
+  key: "w"
 }
@@ -162,10 +162,12 @@ message Port {
 
 message KeyholderData {
   optional uint64 id = 1;
+  optional uint64 ap_id = 6;
   optional uint64 room_id = 2;
 
   optional string name = 3;
   optional string path = 4;
+  optional string key = 5;
 }
 
 message Letter {
@@ -142,6 +142,13 @@ message HumanPort {
 message HumanKeyholder {
   optional string name = 1;
   optional string path = 2;
+
+  // If this is set, the keyholder will become a location when keyholder shuffle
+  // is enabled. This value specifies the key that is required to clear the
+  // location. It should be the same as the key needed for Green Ending. The
+  // only cases when this shouldn't be set is the two disappearing keyholders in
+  // The Congruent.
+  optional string key = 3;
 }
 
 message HumanLetter {
@@ -196,6 +203,7 @@ message IdMappings {
   message RoomIds {
     map<string, uint64> panels = 1;
     map<string, uint64> masteries = 2;
+    map<string, uint64> keyholders = 3;
   }
 
   message MapIds {
@@ -183,6 +183,29 @@ class AssignIds {
         endings[h_ending.name()] = next_id_++;
       }
     }
+
+    for (const HumanKeyholder& h_keyholder : h_room.keyholders()) {
+      if (!h_keyholder.has_key()) {
+        continue;
+      }
+
+      if (!id_mappings_.maps().contains(current_map_name) ||
+          !id_mappings_.maps()
+               .at(current_map_name)
+               .rooms()
+               .contains(h_room.name()) ||
+          !id_mappings_.maps()
+               .at(current_map_name)
+               .rooms()
+               .at(h_room.name())
+               .keyholders()
+               .contains(h_keyholder.name())) {
+        auto& maps = *id_mappings_.mutable_maps();
+        auto& rooms = *maps[current_map_name].mutable_rooms();
+        auto& keyholders = *rooms[h_room.name()].mutable_keyholders();
+        keyholders[h_keyholder.name()] = next_id_++;
+      }
+    }
   }
 
   void ProcessProgressivesFile(std::filesystem::path path) {
@@ -293,6 +293,10 @@ class DataPacker {
 
     keyholder.set_path(h_keyholder.path());
 
+    if (h_keyholder.has_key()) {
+      keyholder.set_key(h_keyholder.key());
+    }
+
     return keyholder_id;
   }
 
@@ -592,6 +596,14 @@ class DataPacker {
               .mutable_masteries(mastery_id)
               ->set_ap_id(ap_id);
         }
+
+        for (const auto& [keyholder_name, ap_id] : room.keyholders()) {
+          uint64_t keyholder_id = container_.FindOrAddKeyholder(
+              map_name, room_name, keyholder_name, std::nullopt, std::nullopt);
+          container_.all_objects()
+              .mutable_keyholders(keyholder_id)
+              ->set_ap_id(ap_id);
+        }
       }
     }
 
@@ -56,6 +56,14 @@ IdMappings ReadIdsFromYaml(const std::string& filename) {
                   mastery_it.second.as<uint64_t>();
             }
           }
+
+          if (room_it.second["keyholders"]) {
+            for (const auto& keyholder_it : room_it.second["keyholders"]) {
+              (*room_ids.mutable_keyholders())[keyholder_it.first
+                                                   .as<std::string>()] =
+                  keyholder_it.second.as<uint64_t>();
+            }
+          }
         }
       }
 
@@ -124,6 +132,13 @@ void WriteIdsAsYaml(const IdMappings& ids, const std::string& filename) {
                                    mastery_id;
                              });
 
+          OperateOnSortedMap(room_ids.keyholders(),
+                             [&room_node](const std::string& keyholder_name,
+                                          uint64_t keyholder_id) {
+                               room_node["keyholders"][keyholder_name] =
+                                   keyholder_id;
+                             });
+
           map_node["rooms"][room_name] = std::move(room_node);
         });