about summary refs log tree commit diff stats
path: root/proto
diff options
context:
space:
mode:
Diffstat (limited to 'proto')
-rw-r--r--proto/data.proto88
-rw-r--r--proto/human.proto99
2 files changed, 181 insertions, 6 deletions
diff --git a/proto/data.proto b/proto/data.proto index 93f2227..e9cc7d7 100644 --- a/proto/data.proto +++ b/proto/data.proto
@@ -27,6 +27,36 @@ enum DoorType {
27 27
28 // This door is an item if gravestone shuffle is enabled, and is a location as long as panelsanity is not on. 28 // This door is an item if gravestone shuffle is enabled, and is a location as long as panelsanity is not on.
29 GRAVESTONE = 6; 29 GRAVESTONE = 6;
30
31 // This door is never a location, and is an item as long as gallery painting shuffle is on.
32 GALLERY_PAINTING = 7;
33}
34
35enum DoorGroupType {
36 DOOR_GROUP_TYPE_UNKNOWN = 0;
37
38 // These doors border a worldport. They should be grouped when connections are
39 // not shuffled.
40 CONNECTOR = 1;
41
42 // Similar to CONNECTOR, but these doors are also ordinarily opened by solving
43 // the COLOR panel in the Control Center. These should be grouped when
44 // connections are not shuffled, but are not items at all when control center
45 // colors are not shuffled.
46 COLOR_CONNECTOR = 2;
47
48 // Groups with this type become an item if cyan door behavior is set to item.
49 CYAN_DOORS = 3;
50
51 // Groups with this type always become an item if door shuffle is on.
52 SHUFFLE_GROUP = 4;
53}
54
55enum MapType {
56 NORMAL_MAP = 0;
57 ICARUS = 1;
58 GIFT_MAP = 2;
59 DEMO = 3;
30} 60}
31 61
32enum AxisDirection { 62enum AxisDirection {
@@ -64,6 +94,18 @@ enum PuzzleSymbol {
64 QUESTION = 19; 94 QUESTION = 19;
65} 95}
66 96
97message Vec3d {
98 optional double x = 1;
99 optional double y = 2;
100 optional double z = 3;
101}
102
103message VersionNumber {
104 optional uint64 major = 1;
105 optional uint64 minor = 2;
106 optional uint64 patch = 3;
107}
108
67message ProxyIdentifier { 109message ProxyIdentifier {
68 optional uint64 panel = 1; 110 optional uint64 panel = 1;
69 optional string answer = 2; 111 optional string answer = 2;
@@ -84,6 +126,11 @@ message Connection {
84 uint64 painting = 5; 126 uint64 painting = 5;
85 ProxyIdentifier panel = 6; 127 ProxyIdentifier panel = 6;
86 } 128 }
129
130 optional bool roof_access = 7;
131 optional bool purple_ending = 8;
132 optional bool cyan_ending = 9;
133 optional bool vanilla_only = 10;
87} 134}
88 135
89message Door { 136message Door {
@@ -100,13 +147,18 @@ message Door {
100 optional uint64 complete_at = 12; 147 optional uint64 complete_at = 12;
101 148
102 optional string control_center_color = 6; 149 optional string control_center_color = 6;
103 repeated string switches = 7;
104 repeated KeyholderAnswer keyholders = 13; 150 repeated KeyholderAnswer keyholders = 13;
105 repeated uint64 rooms = 14; 151 repeated uint64 rooms = 14;
106 repeated uint64 doors = 15; 152 repeated uint64 doors = 15;
107 repeated uint64 endings = 16; 153 optional bool white_ending = 16;
154 optional bool double_letters = 18;
155 repeated string senders = 19;
108 156
109 optional DoorType type = 8; 157 optional DoorType type = 8;
158 optional bool latch = 20;
159 optional bool legacy_location = 21;
160
161 optional string location_name = 17;
110} 162}
111 163
112message PanelData { 164message PanelData {
@@ -124,6 +176,8 @@ message PanelData {
124 176
125 optional uint64 required_door = 9; 177 optional uint64 required_door = 9;
126 optional uint64 required_room = 11; 178 optional uint64 required_room = 11;
179
180 optional string display_name = 12;
127} 181}
128 182
129message PaintingData { 183message PaintingData {
@@ -145,22 +199,28 @@ message PaintingData {
145 199
146message Port { 200message Port {
147 optional uint64 id = 1; 201 optional uint64 id = 1;
202 optional uint64 ap_id = 11;
148 optional uint64 room_id = 2; 203 optional uint64 room_id = 2;
149 optional string name = 3; 204 optional string name = 3;
150 205
206 optional string display_name = 10;
151 optional string path = 4; 207 optional string path = 4;
152 optional string orientation = 5; 208 optional Vec3d destination = 5;
209 optional double rotation = 8;
153 optional AxisDirection gravity = 7; 210 optional AxisDirection gravity = 7;
211 optional bool no_shuffle = 9;
154 212
155 optional uint64 required_door = 6; 213 optional uint64 required_door = 6;
156} 214}
157 215
158message KeyholderData { 216message KeyholderData {
159 optional uint64 id = 1; 217 optional uint64 id = 1;
218 optional uint64 ap_id = 6;
160 optional uint64 room_id = 2; 219 optional uint64 room_id = 2;
161 220
162 optional string name = 3; 221 optional string name = 3;
163 optional string path = 4; 222 optional string path = 4;
223 optional string key = 5;
164} 224}
165 225
166message Letter { 226message Letter {
@@ -198,6 +258,7 @@ message Room {
198 optional uint64 map_id = 8; 258 optional uint64 map_id = 8;
199 optional string name = 2; 259 optional string name = 2;
200 optional string display_name = 3; 260 optional string display_name = 3;
261 optional string panel_display_name = 13;
201 262
202 repeated uint64 panels = 4; 263 repeated uint64 panels = 4;
203 repeated uint64 paintings = 5; 264 repeated uint64 paintings = 5;
@@ -213,9 +274,28 @@ message Map {
213 optional uint64 id = 1; 274 optional uint64 id = 1;
214 optional string name = 2; 275 optional string name = 2;
215 optional string display_name = 3; 276 optional string display_name = 3;
277 optional uint64 worldport_entrance = 4;
278 optional MapType type = 5;
279}
280
281message Progressive {
282 optional uint64 id = 1;
283 optional string name = 2;
284 optional uint64 ap_id = 3;
285 repeated uint64 doors = 4;
286}
287
288message DoorGroup {
289 optional uint64 id = 1;
290 optional string name = 2;
291 optional uint64 ap_id = 3;
292 optional DoorGroupType type = 4;
293 repeated uint64 doors = 5;
216} 294}
217 295
218message AllObjects { 296message AllObjects {
297 optional VersionNumber version = 15;
298
219 repeated Map maps = 7; 299 repeated Map maps = 7;
220 repeated Room rooms = 1; 300 repeated Room rooms = 1;
221 repeated Door doors = 2; 301 repeated Door doors = 2;
@@ -227,5 +307,7 @@ message AllObjects {
227 repeated Mastery masteries = 10; 307 repeated Mastery masteries = 10;
228 repeated Ending endings = 12; 308 repeated Ending endings = 12;
229 repeated Connection connections = 6; 309 repeated Connection connections = 6;
310 repeated Progressive progressives = 13;
311 repeated DoorGroup door_groups = 14;
230 map<string, uint64> special_ids = 8; 312 map<string, uint64> special_ids = 8;
231} 313}
diff --git a/proto/human.proto b/proto/human.proto index 1a15c59..c586599 100644 --- a/proto/human.proto +++ b/proto/human.proto
@@ -62,6 +62,25 @@ message HumanConnection {
62 62
63 optional bool oneway = 3; 63 optional bool oneway = 3;
64 optional DoorIdentifier door = 4; 64 optional DoorIdentifier door = 4;
65
66 // If true, this connection will only be logically allowed if the Daedalus
67 // Roof Access option is enabled.
68 optional bool roof_access = 7;
69
70 // This means that the connection intentionally skips the target object's
71 // required door.
72 optional bool bypass_target_door = 8;
73
74 // This means that the connection should additionally require all purple
75 // letters when the Strict Purple Ending option is on.
76 optional bool purple_ending = 9;
77
78 // This means that the connection should additionally require all cyan letters
79 // when the Strict Cyan Ending option is on.
80 optional bool cyan_ending = 10;
81
82 // This means that the connection only exists when doors are not shuffled.
83 optional bool vanilla_only = 11;
65} 84}
66 85
67message HumanConnections { 86message HumanConnections {
@@ -82,14 +101,29 @@ message HumanDoor {
82 optional uint64 complete_at = 9; 101 optional uint64 complete_at = 9;
83 102
84 optional string control_center_color = 6; 103 optional string control_center_color = 6;
85 repeated string switches = 7;
86 repeated KeyholderIdentifier keyholders = 10; 104 repeated KeyholderIdentifier keyholders = 10;
87 repeated RoomIdentifier rooms = 11; 105 repeated RoomIdentifier rooms = 11;
88 repeated DoorIdentifier doors = 12; 106 repeated DoorIdentifier doors = 12;
89 repeated string endings = 13; 107 optional bool white_ending = 13;
108 optional bool double_letters = 15;
109
110 // Sender nodes to be added to the list of requirements for triggering the
111 // location. Only for senders that have no logic requirements.
112 repeated string senders = 16;
90 113
91 optional DoorType type = 4; 114 optional DoorType type = 4;
92 optional string location_room = 5; 115 optional string location_room = 5;
116 optional string location_name = 14;
117
118 // Non-item doors that are latched will stay open once opened, even if the
119 // opening trigger is deactivated. This applies to EVENT/LOCATION_ONLY doors,
120 // as well as item-locked doors when not shuffling doors.
121 optional bool latch = 17;
122
123 // If true, the client will treat this door like a location, even though no
124 // location is created for it in the generator. This helps provide backwards
125 // compatability with older worlds.
126 optional bool legacy_location = 18;
93} 127}
94 128
95message HumanDoors { 129message HumanDoors {
@@ -108,6 +142,8 @@ message HumanPanel {
108 142
109 optional DoorIdentifier required_door = 7; 143 optional DoorIdentifier required_door = 7;
110 optional RoomIdentifier required_room = 8; 144 optional RoomIdentifier required_room = 8;
145
146 optional string display_name = 9;
111} 147}
112 148
113message HumanPainting { 149message HumanPainting {
@@ -127,9 +163,16 @@ message HumanPainting {
127 163
128message HumanPort { 164message HumanPort {
129 optional string name = 1; 165 optional string name = 1;
166 optional string display_name = 8;
130 optional string path = 2; 167 optional string path = 2;
131 168
132 optional string orientation = 3; 169 optional bool no_shuffle = 7;
170
171 // These specify how the player should be placed when a randomized entrance
172 // sends them to this port. "rotation" is in degrees and is counter-clockwise
173 // from the positive X axis.
174 optional Vec3d destination = 3;
175 optional double rotation = 6;
133 optional AxisDirection gravity = 5 [default = Y_MINUS]; 176 optional AxisDirection gravity = 5 [default = Y_MINUS];
134 177
135 optional DoorIdentifier required_door = 4; 178 optional DoorIdentifier required_door = 4;
@@ -138,6 +181,13 @@ message HumanPort {
138message HumanKeyholder { 181message HumanKeyholder {
139 optional string name = 1; 182 optional string name = 1;
140 optional string path = 2; 183 optional string path = 2;
184
185 // If this is set, the keyholder will become a location when keyholder shuffle
186 // is enabled. This value specifies the key that is required to clear the
187 // location. It should be the same as the key needed for Green Ending. The
188 // only cases when this shouldn't be set is the two disappearing keyholders in
189 // The Congruent.
190 optional string key = 3;
141} 191}
142 192
143message HumanLetter { 193message HumanLetter {
@@ -161,6 +211,10 @@ message HumanRoom {
161 optional string name = 1; 211 optional string name = 1;
162 optional string display_name = 2; 212 optional string display_name = 2;
163 213
214 // This is used in panelsanity location names and location names for STANDARD
215 // doors generated from panels in the same area.
216 optional string panel_display_name = 10;
217
164 repeated HumanPanel panels = 3; 218 repeated HumanPanel panels = 3;
165 repeated HumanPainting paintings = 4; 219 repeated HumanPainting paintings = 4;
166 repeated HumanLetter letters = 5; 220 repeated HumanLetter letters = 5;
@@ -172,13 +226,50 @@ message HumanRoom {
172 226
173message HumanMap { 227message HumanMap {
174 optional string display_name = 1; 228 optional string display_name = 1;
229 optional MapType type = 4;
230
231 optional PortIdentifier worldport_entrance = 3;
232
233 // These two fields are used by the validator and nothing else. excluded_nodes
234 // are objects in the tscn that are intentionally not mentioned in the txtpb.
235 // custom_nodes are the reverse of that; objects that are mentioned in the
236 // txtpb but not present in the tscn. These are generally created dynamically
237 // by the game mod, but may also be used for places where the validator is
238 // just wrong about the contents of the map file.
175 repeated string excluded_nodes = 2; 239 repeated string excluded_nodes = 2;
240 repeated string custom_nodes = 5;
241}
242
243message HumanProgressive {
244 optional string name = 1;
245 repeated DoorIdentifier doors = 2;
246}
247
248message HumanProgressives {
249 repeated HumanProgressive progressives = 1;
250}
251
252message HumanDoorGroup {
253 optional string name = 1;
254 optional DoorGroupType type = 2;
255 repeated DoorIdentifier doors = 3;
256}
257
258message HumanDoorGroups {
259 repeated HumanDoorGroup door_groups = 1;
260}
261
262message HumanGlobalMetadata {
263 repeated string special_names = 1;
264 optional VersionNumber version = 2;
176} 265}
177 266
178message IdMappings { 267message IdMappings {
179 message RoomIds { 268 message RoomIds {
180 map<string, uint64> panels = 1; 269 map<string, uint64> panels = 1;
181 map<string, uint64> masteries = 2; 270 map<string, uint64> masteries = 2;
271 map<string, uint64> keyholders = 3;
272 map<string, uint64> ports = 4;
182 } 273 }
183 274
184 message MapIds { 275 message MapIds {
@@ -190,4 +281,6 @@ message IdMappings {
190 map<string, uint64> special = 2; 281 map<string, uint64> special = 2;
191 map<string, uint64> letters = 3; 282 map<string, uint64> letters = 3;
192 map<string, uint64> endings = 4; 283 map<string, uint64> endings = 4;
284 map<string, uint64> progressives = 5;
285 map<string, uint64> door_groups = 6;
193} 286}