4 files changed, 400 insertions, 174 deletions

@@ -5,7 +5,7 @@ add_library(protos)
 protobuf_generate(
   LANGUAGE cpp
   TARGET protos
-  PROTOS human.proto data.proto common.proto
+  PROTOS human.proto data.proto
 )
 
 target_link_libraries(protos PUBLIC protobuf::libprotobuf)
@@ -1,38 +0,0 @@
-edition = "2023";
-
-package com.fourisland.lingo2_archipelago;
-
-message Proxy {
-  string answer = 1;
-  string path = 2;
-}
-
-enum DoorType {
-  DOOR_TYPE_UNKNOWN = 0;
-
-  // This door is a location unless panelsanity is on, and it is an item as long as door shuffle is on.
-  STANDARD = 1;
-
-  // This door is never an item or a location.
-  EVENT = 2;
-
-  // This door is never a location, and is an item as long as door shuffle is on.
-  ITEM_ONLY = 3;
-
-  // This door is never a location, and is an item as long as control center color shuffle is on.
-  CONTROL_CENTER_COLOR = 4;
-
-  // This door is never an item, and is a location as long as panelsanity is not on.
-  LOCATION_ONLY = 5;
-}
-
-enum AxisDirection {
-  AXIS_DIRECTION_UNKNOWN = 0;
-
-  X_PLUS = 1;
-  X_MINUS = 2;
-  Y_PLUS = 3;
-  Y_MINUS = 4;
-  Z_PLUS = 5;
-  Z_MINUS = 6;
-}
@@ -1,131 +1,264 @@
-edition = "2023";
-
-import "common.proto";
+syntax = "proto2";
 
 package com.fourisland.lingo2_archipelago;
 
+message Proxy {
+  optional string answer = 1;
+  optional string path = 2;
+}
+
+enum DoorType {
+  DOOR_TYPE_UNKNOWN = 0;
+
+  // This door is a location unless panelsanity is on, and it is an item as long as door shuffle is on.
+  STANDARD = 1;
+
+  // This door is never an item or a location.
+  EVENT = 2;
+
+  // This door is never a location, and is an item as long as door shuffle is on.
+  ITEM_ONLY = 3;
+
+  // This door is never a location, and is an item as long as control center color shuffle is on.
+  CONTROL_CENTER_COLOR = 4;
+
+  // This door is never an item, and is a location as long as panelsanity is not on.
+  LOCATION_ONLY = 5;
+
+  // This door is an item if gravestone shuffle is enabled, and is a location as long as panelsanity is not on.
+  GRAVESTONE = 6;
+
+  // This door is never a location, and is an item as long as gallery painting shuffle is on.
+  GALLERY_PAINTING = 7;
+}
+
+enum DoorGroupType {
+  DOOR_GROUP_TYPE_UNKNOWN = 0;
+
+  // These doors border a worldport. They should be grouped when connections are
+  // not shuffled.
+  CONNECTOR = 1;
+
+  // Similar to CONNECTOR, but these doors are also ordinarily opened by solving
+  // the COLOR panel in the Control Center. These should be grouped when
+  // connections are not shuffled, but are not items at all when control center
+  // colors are not shuffled.
+  COLOR_CONNECTOR = 2;
+
+  // Groups with this type become an item if cyan door behavior is set to item.
+  CYAN_DOORS = 3;
+
+  // Groups with this type always become an item if door shuffle is on.
+  SHUFFLE_GROUP = 4;
+}
+
+enum MapType {
+  NORMAL_MAP = 0;
+  ICARUS = 1;
+  GIFT_MAP = 2;
+  DEMO = 3;
+}
+
+enum AxisDirection {
+  AXIS_DIRECTION_UNKNOWN = 0;
+
+  X_PLUS = 1;
+  X_MINUS = 2;
+  Y_PLUS = 3;
+  Y_MINUS = 4;
+  Z_PLUS = 5;
+  Z_MINUS = 6;
+}
+
+enum PuzzleSymbol {
+  PUZZLE_SYMBOL_UNKNOWN = 0;
+
+  SUN = 1;
+  SPARKLES = 2;
+  ZERO = 3;
+  EXAMPLE = 4;
+  BOXES = 5;
+  PLANET = 6;
+  PYRAMID = 7;
+  CROSS = 8;
+  SWEET = 9;
+  GENDER = 10;
+  AGE = 11;
+  SOUND = 12;
+  ANAGRAM = 13;
+  JOB = 14;
+  STARS = 15;
+  NULL = 16;
+  EVAL = 17;
+  LINGO = 18;
+  QUESTION = 19;
+}
+
+message Vec3d {
+  optional double x = 1;
+  optional double y = 2;
+  optional double z = 3;
+}
+
+message VersionNumber {
+  optional uint64 major = 1;
+  optional uint64 minor = 2;
+  optional uint64 patch = 3;
+}
+
 message ProxyIdentifier {
-  uint64 panel = 1;
-  string answer = 2;
+  optional uint64 panel = 1;
+  optional string answer = 2;
 }
 
 message KeyholderAnswer {
-  uint64 keyholder = 1;
-  string key = 2;
+  optional uint64 keyholder = 1;
+  optional string key = 2;
 }
 
 message Connection {
-  uint64 from_room = 1;
-  uint64 to_room = 2;
-  uint64 required_door = 3;
+  optional uint64 from_room = 1;
+  optional uint64 to_room = 2;
+  optional uint64 required_door = 3;
 
   oneof trigger {
     uint64 port = 4;
     uint64 painting = 5;
     ProxyIdentifier panel = 6;
   }
+
+  optional bool roof_access = 7;
+  optional bool purple_ending = 8;
+  optional bool cyan_ending = 9;
+  optional bool vanilla_only = 10;
 }
 
 message Door {
-  uint64 id = 1;
-  uint64 ap_id = 11;
-  uint64 map_id = 9;
-  uint64 room_id = 10;
-  string name = 2;
+  optional uint64 id = 1;
+  optional uint64 ap_id = 11;
+  optional uint64 map_id = 9;
+  optional uint64 room_id = 10;
+  optional string name = 2;
 
   repeated string receivers = 3;
   repeated uint64 move_paintings = 4;
 
   repeated ProxyIdentifier panels = 5;
-  uint64 complete_at = 12;
+  optional uint64 complete_at = 12;
 
-  string control_center_color = 6;
-  repeated string switches = 7;
+  optional string control_center_color = 6;
   repeated KeyholderAnswer keyholders = 13;
   repeated uint64 rooms = 14;
+  repeated uint64 doors = 15;
+  optional bool white_ending = 16;
+  optional bool double_letters = 18;
+  repeated string senders = 19;
+
+  optional DoorType type = 8;
+  optional bool latch = 20;
+  optional bool legacy_location = 21;
 
-  DoorType type = 8;
+  optional string location_name = 17;
 }
 
-message Panel {
-  uint64 id = 1;
-  uint64 ap_id = 10;
-  uint64 room_id = 2;
-  string name = 3;
+message PanelData {
+  optional uint64 id = 1;
+  optional uint64 ap_id = 10;
+  optional uint64 room_id = 2;
+  optional string name = 3;
 
-  string path = 4;
-  string clue = 5;
-  string answer = 6;
-  repeated string symbols = 7;
+  optional string path = 4;
+  optional string clue = 5;
+  optional string answer = 6;
+  repeated PuzzleSymbol symbols = 7;
 
   repeated Proxy proxies = 8;
 
-  uint64 required_door = 9;
-  uint64 required_room = 11;
+  optional uint64 required_door = 9;
+  optional uint64 required_room = 11;
+
+  optional string display_name = 12;
 }
 
-message Painting {
-  uint64 id = 1;
-  uint64 room_id = 2;
-  string name = 9;
+message PaintingData {
+  optional uint64 id = 1;
+  optional uint64 room_id = 2;
+  optional string name = 9;
 
-  string path = 10;
-  string display_name = 4;
+  optional string path = 10;
+  optional string display_name = 4;
 
-  string orientation = 3;
-  bool move = 6;
-  bool enter_only = 7;
-  AxisDirection gravity = 8 [default = Y_MINUS];
-  bool exit_only = 11;
+  optional string orientation = 3;
+  optional bool move = 6;
+  optional bool enter_only = 7;
+  optional AxisDirection gravity = 8;
+  optional bool exit_only = 11;
   
-  uint64 required_door = 5;
+  optional uint64 required_door = 5;
 }
 
 message Port {
-  uint64 id = 1;
-  uint64 room_id = 2;
-  string name = 3;
-
-  string path = 4;
-  string orientation = 5;
-  AxisDirection gravity = 7 [default = Y_MINUS];
-
-  uint64 required_door = 6;
+  optional uint64 id = 1;
+  optional uint64 ap_id = 11;
+  optional uint64 room_id = 2;
+  optional string name = 3;
+
+  optional string display_name = 10;
+  optional string path = 4;
+  optional Vec3d destination = 5;
+  optional double rotation = 8;
+  optional AxisDirection gravity = 7;
+  optional bool no_shuffle = 9;
+
+  optional uint64 required_door = 6;
 }
 
-message Keyholder {
-  uint64 id = 1;
-  uint64 room_id = 2;
+message KeyholderData {
+  optional uint64 id = 1;
+  optional uint64 ap_id = 6;
+  optional uint64 room_id = 2;
 
-  string name = 3;
-  string path = 4;
+  optional string name = 3;
+  optional string path = 4;
+  optional string key = 5;
 }
 
 message Letter {
-  uint64 id = 3;
-  uint64 ap_id = 5;
-  uint64 room_id = 4;
+  optional uint64 id = 3;
+  optional uint64 ap_id = 5;
+  optional uint64 room_id = 4;
 
-  string key = 1;
-  bool double = 2;
+  optional string key = 1;
+  optional bool level2 = 2;
 
-  string path = 6;
+  optional string path = 6;
 }
 
 message Mastery {
-  uint64 id = 1;
-  uint64 ap_id = 2;
-  uint64 room_id = 3;
+  optional uint64 id = 1;
+  optional uint64 ap_id = 2;
+  optional uint64 room_id = 3;
+
+  optional string name = 4;
+  optional string path = 5;
+}
+
+message Ending {
+  optional uint64 id = 1;
+  optional uint64 ap_id = 2;
+  optional uint64 room_id = 3;
+
+  optional string name = 4;
 
-  string name = 4;
-  string path = 5;
+  optional string path = 5;
 }
 
 message Room {
-  uint64 id = 1;
-  uint64 map_id = 8;
-  string name = 2;
-  string display_name = 3;
+  optional uint64 id = 1;
+  optional uint64 map_id = 8;
+  optional string name = 2;
+  optional string display_name = 3;
+  optional string panel_display_name = 13;
 
   repeated uint64 panels = 4;
   repeated uint64 paintings = 5;
@@ -134,23 +267,47 @@ message Room {
   repeated uint64 doors = 9;
   repeated uint64 masteries = 10;
   repeated uint64 keyholders = 11;
+  repeated uint64 endings = 12;
 }
 
 message Map {
-  uint64 id = 1;
-  string name = 2;
+  optional uint64 id = 1;
+  optional string name = 2;
+  optional string display_name = 3;
+  optional uint64 worldport_entrance = 4;
+  optional MapType type = 5;
+}
+
+message Progressive {
+  optional uint64 id = 1;
+  optional string name = 2;
+  optional uint64 ap_id = 3;
+  repeated uint64 doors = 4;
+}
+
+message DoorGroup {
+  optional uint64 id = 1;
+  optional string name = 2;
+  optional uint64 ap_id = 3;
+  optional DoorGroupType type = 4;
+  repeated uint64 doors = 5;
 }
 
 message AllObjects {
+  optional VersionNumber version = 15;
+
   repeated Map maps = 7;
   repeated Room rooms = 1;
   repeated Door doors = 2;
-  repeated Panel panels = 3;
-  repeated Painting paintings = 4;
+  repeated PanelData panels = 3;
+  repeated PaintingData paintings = 4;
   repeated Port ports = 5;
-  repeated Keyholder keyholders = 11;
+  repeated KeyholderData keyholders = 11;
   repeated Letter letters = 9;
   repeated Mastery masteries = 10;
+  repeated Ending endings = 12;
   repeated Connection connections = 6;
+  repeated Progressive progressives = 13;
+  repeated DoorGroup door_groups = 14;
   map<string, uint64> special_ids = 8;
 }
@@ -1,43 +1,43 @@
-edition = "2023";
+syntax = "proto2";
 
-import "common.proto";
+import "data.proto";
 
 package com.fourisland.lingo2_archipelago;
 
 message RoomIdentifier {
-  string map = 1;
-  string name = 2;
+  optional string map = 1;
+  optional string name = 2;
 }
 
 message DoorIdentifier {
-  string map = 1;
-  string name = 2;
+  optional string map = 1;
+  optional string name = 2;
 }
 
 message PortIdentifier {
-  string map = 1;
-  string room = 2;
-  string name = 3;
+  optional string map = 1;
+  optional string room = 2;
+  optional string name = 3;
 }
 
 message PaintingIdentifier {
-  string map = 1;
-  string room = 2;
-  string name = 3;
+  optional string map = 1;
+  optional string room = 2;
+  optional string name = 3;
 }
 
 message PanelIdentifier {
-  string map = 1;
-  string room = 2;
-  string name = 3;
-  string answer = 4;
+  optional string map = 1;
+  optional string room = 2;
+  optional string name = 3;
+  optional string answer = 4;
 }
 
 message KeyholderIdentifier {
-  string map = 1;
-  string room = 2;
-  string name = 3;
-  string key = 4;
+  optional string map = 1;
+  optional string room = 2;
+  optional string name = 3;
+  optional string key = 4;
 }
 
 message HumanConnection {
@@ -60,8 +60,27 @@ message HumanConnection {
     string to_room = 6;
   }
 
-  bool oneway = 3;
-  DoorIdentifier door = 4;
+  optional bool oneway = 3;
+  optional DoorIdentifier door = 4;
+
+  // If true, this connection will only be logically allowed if the Daedalus
+  // Roof Access option is enabled.
+  optional bool roof_access = 7;
+
+  // This means that the connection intentionally skips the target object's
+  // required door.
+  optional bool bypass_target_door = 8;
+
+  // This means that the connection should additionally require all purple
+  // letters when the Strict Purple Ending option is on.
+  optional bool purple_ending = 9;
+
+  // This means that the connection should additionally require all cyan letters
+  // when the Strict Cyan Ending option is on.
+  optional bool cyan_ending = 10;
+
+  // This means that the connection only exists when doors are not shuffled.
+  optional bool vanilla_only = 11;
 }
 
 message HumanConnections {
@@ -69,7 +88,7 @@ message HumanConnections {
 }
 
 message HumanDoor {
-  string name = 1;
+  optional string name = 1;
 
   repeated string receivers = 2;
   repeated PaintingIdentifier move_paintings = 8;
@@ -79,15 +98,32 @@ message HumanDoor {
 
   // If set, the number of panels from the above set that need to be solved.
   // Warning: this is a messy kind of OR logic! Consider if there's another way.
-  uint64 complete_at = 9;
+  optional uint64 complete_at = 9;
 
-  string control_center_color = 6;
-  repeated string switches = 7;
+  optional string control_center_color = 6;
   repeated KeyholderIdentifier keyholders = 10;
   repeated RoomIdentifier rooms = 11;
-
-  DoorType type = 4;
-  string location_room = 5;
+  repeated DoorIdentifier doors = 12;
+  optional bool white_ending = 13;
+  optional bool double_letters = 15;
+
+  // Sender nodes to be added to the list of requirements for triggering the
+  // location. Only for senders that have no logic requirements.
+  repeated string senders = 16;
+
+  optional DoorType type = 4;
+  optional string location_room = 5;
+  optional string location_name = 14;
+
+  // Non-item doors that are latched will stay open once opened, even if the
+  // opening trigger is deactivated. This applies to EVENT/LOCATION_ONLY doors,
+  // as well as item-locked doors when not shuffling doors.
+  optional bool latch = 17;
+
+  // If true, the client will treat this door like a location, even though no
+  // location is created for it in the generator. This helps provide backwards
+  // compatability with older worlds.
+  optional bool legacy_location = 18;
 }
 
 message HumanDoors {
@@ -95,64 +131,89 @@ message HumanDoors {
 }
 
 message HumanPanel {
-  string name = 1;
-  string path = 5;
+  optional string name = 1;
+  optional string path = 5;
   
-  string clue = 2;
-  string answer = 3;
-  repeated string symbols = 4;
+  optional string clue = 2;
+  optional string answer = 3;
+  repeated PuzzleSymbol symbols = 4;
 
   repeated Proxy proxies = 6;
 
-  DoorIdentifier required_door = 7;
-  RoomIdentifier required_room = 8;
+  optional DoorIdentifier required_door = 7;
+  optional RoomIdentifier required_room = 8;
+
+  optional string display_name = 9;
 }
 
 message HumanPainting {
-  string name = 1;
-  string path = 2;
+  optional string name = 1;
+  optional string path = 2;
 
-  string display_name = 4;
+  optional string display_name = 4;
 
-  string orientation = 3;
-  bool move = 6;
-  bool enter_only = 7;
-  AxisDirection gravity = 8 [default = Y_MINUS];
-  bool exit_only = 9;
+  optional string orientation = 3;
+  optional bool move = 6;
+  optional bool enter_only = 7;
+  optional AxisDirection gravity = 8 [default = Y_MINUS];
+  optional bool exit_only = 9;
   
-  DoorIdentifier required_door = 5;
+  optional DoorIdentifier required_door = 5;
 }
 
 message HumanPort {
-  string name = 1;
-  string path = 2;
+  optional string name = 1;
+  optional string display_name = 8;
+  optional string path = 2;
 
-  string orientation = 3;
-  AxisDirection gravity = 5 [default = Y_MINUS];
+  optional bool no_shuffle = 7;
 
-  DoorIdentifier required_door = 4;
+  // These specify how the player should be placed when a randomized entrance
+  // sends them to this port. "rotation" is in degrees and is counter-clockwise 
+  // from the positive X axis.
+  optional Vec3d destination = 3;
+  optional double rotation = 6;
+  optional AxisDirection gravity = 5 [default = Y_MINUS];
+
+  optional DoorIdentifier required_door = 4;
 }
 
 message HumanKeyholder {
-  string name = 1;
-  string path = 2;
+  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 {
-  string key = 1;
-  bool double = 2;
+  optional string key = 1;
+  optional bool level2 = 2;
 
-  string path = 3;
+  optional string path = 3;
 }
 
 message HumanMastery {
-  string name = 1;
-  string path = 2;
+  optional string name = 1;
+  optional string path = 2;
+}
+
+message HumanEnding {
+  optional string name = 1;
+  optional string path = 2;
 }
 
 message HumanRoom {
-  string name = 1;
-  string display_name = 2;
+  optional string name = 1;
+  optional string display_name = 2;
+
+  // This is used in panelsanity location names and location names for STANDARD
+  // doors generated from panels in the same area.
+  optional string panel_display_name = 10;
 
   repeated HumanPanel panels = 3;
   repeated HumanPainting paintings = 4;
@@ -160,12 +221,55 @@ message HumanRoom {
   repeated HumanPort ports = 6;
   repeated HumanKeyholder keyholders = 7;
   repeated HumanMastery masteries = 8;
+  repeated HumanEnding endings = 9;
+}
+
+message HumanMap {
+  optional string display_name = 1;
+  optional MapType type = 4;
+
+  optional PortIdentifier worldport_entrance = 3;
+
+  // These two fields are used by the validator and nothing else. excluded_nodes
+  // are objects in the tscn that are intentionally not mentioned in the txtpb.
+  // custom_nodes are the reverse of that; objects that are mentioned in the
+  // txtpb but not present in the tscn. These are generally created dynamically
+  // by the game mod, but may also be used for places where the validator is
+  // just wrong about the contents of the map file.
+  repeated string excluded_nodes = 2;
+  repeated string custom_nodes = 5;
+}
+
+message HumanProgressive {
+  optional string name = 1;
+  repeated DoorIdentifier doors = 2;
+}
+
+message HumanProgressives {
+  repeated HumanProgressive progressives = 1;
+}
+
+message HumanDoorGroup {
+  optional string name = 1;
+  optional DoorGroupType type = 2;
+  repeated DoorIdentifier doors = 3;
+}
+
+message HumanDoorGroups {
+  repeated HumanDoorGroup door_groups = 1;
+}
+
+message HumanGlobalMetadata {
+  repeated string special_names = 1;
+  optional VersionNumber version = 2;
 }
 
 message IdMappings {
   message RoomIds {
     map<string, uint64> panels = 1;
     map<string, uint64> masteries = 2;
+    map<string, uint64> keyholders = 3;
+    map<string, uint64> ports = 4;
   }
 
   message MapIds {
@@ -176,4 +280,7 @@ message IdMappings {
   map<string, MapIds> maps = 1;
   map<string, uint64> special = 2;
   map<string, uint64> letters = 3;
+  map<string, uint64> endings = 4;
+  map<string, uint64> progressives = 5;
+  map<string, uint64> door_groups = 6;
 }