about summary refs log tree commit diff stats
path: root/apworld/client/manager.gd
diff options
context:
space:
mode:
Diffstat (limited to 'apworld/client/manager.gd')
-rw-r--r--apworld/client/manager.gd717
1 files changed, 717 insertions, 0 deletions
diff --git a/apworld/client/manager.gd b/apworld/client/manager.gd new file mode 100644 index 0000000..8c981f9 --- /dev/null +++ b/apworld/client/manager.gd
@@ -0,0 +1,717 @@
1extends Node
2
3var SCRIPT_client
4var SCRIPT_keyboard
5var SCRIPT_locationListener
6var SCRIPT_minimap
7var SCRIPT_victoryListener
8var SCRIPT_websocketserver
9
10var ap_server = ""
11var ap_user = ""
12var ap_pass = ""
13var connection_history = []
14var show_compass = false
15var show_locations = false
16var show_minimap = false
17
18var client
19var keyboard
20
21var _localdata_file = ""
22var _last_new_item = -1
23var _batch_locations = false
24var _held_locations = []
25var _held_location_scouts = []
26var _location_scouts = {}
27var _item_locks = {}
28var _inverse_item_locks = {}
29var _held_letters = {}
30var _letters_setup = false
31var _already_connected = false
32var _ignored_locations = []
33var _map_scripts = {}
34
35const kSHUFFLE_LETTERS_VANILLA = 0
36const kSHUFFLE_LETTERS_UNLOCKED = 1
37const kSHUFFLE_LETTERS_PROGRESSIVE = 2
38const kSHUFFLE_LETTERS_VANILLA_CYAN = 3
39const kSHUFFLE_LETTERS_ITEM_CYAN = 4
40
41const kLETTER_BEHAVIOR_VANILLA = 0
42const kLETTER_BEHAVIOR_ITEM = 1
43const kLETTER_BEHAVIOR_UNLOCKED = 2
44
45const kCYAN_DOOR_BEHAVIOR_H2 = 0
46const kCYAN_DOOR_BEHAVIOR_DOUBLE_LETTER = 1
47const kCYAN_DOOR_BEHAVIOR_ITEM = 2
48
49const kEndingNameByVictoryValue = {
50 0: "GRAY",
51 1: "PURPLE",
52 2: "MINT",
53 3: "BLACK",
54 4: "BLUE",
55 5: "CYAN",
56 6: "RED",
57 7: "PLUM",
58 8: "ORANGE",
59 9: "GOLD",
60 10: "YELLOW",
61 11: "GREEN",
62 12: "WHITE",
63}
64
65var apworld_version = [0, 0, 0]
66var cyan_door_behavior = kCYAN_DOOR_BEHAVIOR_H2
67var daedalus_roof_access = false
68var enable_gift_maps = []
69var enable_icarus = false
70var endings_requirement = 0
71var keyholder_sanity = false
72var masteries_requirement = 0
73var port_pairings = {}
74var shuffle_control_center_colors = false
75var shuffle_doors = false
76var shuffle_gallery_paintings = false
77var shuffle_letters = kSHUFFLE_LETTERS_VANILLA
78var shuffle_symbols = false
79var shuffle_worldports = false
80var strict_cyan_ending = false
81var strict_purple_ending = false
82var victory_condition = -1
83
84var color_by_material_path = {}
85
86signal could_not_connect
87signal connect_status
88signal ap_connected
89
90
91func _init():
92 # Read AP settings from file, if there are any
93 if FileAccess.file_exists("user://ap_settings"):
94 var file = FileAccess.open("user://ap_settings", FileAccess.READ)
95 var data = file.get_var(true)
96 file.close()
97
98 if typeof(data) != TYPE_ARRAY:
99 global._print("AP settings file is corrupted")
100 data = []
101
102 if data.size() > 0:
103 ap_server = data[0]
104
105 if data.size() > 1:
106 ap_user = data[1]
107
108 if data.size() > 2:
109 ap_pass = data[2]
110
111 if data.size() > 3:
112 connection_history = data[3]
113
114 if data.size() > 4:
115 show_compass = data[4]
116
117 if data.size() > 5:
118 show_locations = data[5]
119
120 if data.size() > 6:
121 show_minimap = data[6]
122
123 # We need to create a mapping from material paths to the original colors of
124 # those materials. We force reload the materials, overwriting any custom
125 # textures, and create the mapping. We then reload the textures in case the
126 # player had a custom one enabled.
127 var directory = DirAccess.open("res://assets/materials")
128 for material_name in directory.get_files():
129 var material = ResourceLoader.load(
130 "res://assets/materials/" + material_name, "", ResourceLoader.CACHE_MODE_REPLACE
131 )
132
133 color_by_material_path[material.resource_path] = Color(material.albedo_color)
134
135 settings.load_user_textures()
136
137
138func _ready():
139 client = SCRIPT_client.new()
140 client.SCRIPT_websocketserver = SCRIPT_websocketserver
141
142 client.item_received.connect(_process_item)
143 client.location_scout_received.connect(_process_location_scout)
144 client.text_message_received.connect(_process_text_message)
145 client.item_sent_notification.connect(_process_item_sent_notification)
146 client.hint_received.connect(_process_hint_received)
147 client.accessible_locations_updated.connect(_on_accessible_locations_updated)
148 client.checked_locations_updated.connect(_on_checked_locations_updated)
149 client.ignored_locations_updated.connect(_on_ignored_locations_updated)
150 client.hinted_locations_updated.connect(_on_hinted_locations_updated)
151 client.checked_worldports_updated.connect(_on_checked_worldports_updated)
152 client.door_latched.connect(_on_door_latched)
153
154 client.could_not_connect.connect(_client_could_not_connect)
155 client.connect_status.connect(_client_connect_status)
156 client.client_connected.connect(_client_connected)
157
158 add_child(client)
159
160 keyboard = SCRIPT_keyboard.new()
161 add_child(keyboard)
162 client.keyboard_update_received.connect(keyboard.remote_keyboard_updated)
163
164
165func saveSettings():
166 # Save the AP settings to disk.
167 var path = "user://ap_settings"
168 var file = FileAccess.open(path, FileAccess.WRITE)
169
170 var data = [
171 ap_server,
172 ap_user,
173 ap_pass,
174 connection_history,
175 show_compass,
176 show_locations,
177 show_minimap,
178 ]
179 file.store_var(data, true)
180 file.close()
181
182
183func saveLocaldata():
184 # Save the MW/slot specific settings to disk.
185 var dir = DirAccess.open("user://")
186 var folder = "archipelago_data"
187 if not dir.dir_exists(folder):
188 dir.make_dir(folder)
189
190 var file = FileAccess.open(_localdata_file, FileAccess.WRITE)
191
192 var data = [
193 _last_new_item,
194 ]
195 file.store_var(data, true)
196 file.close()
197
198
199func connectToServer():
200 _last_new_item = -1
201 _batch_locations = false
202 _held_locations = []
203 _held_location_scouts = []
204 _location_scouts = {}
205 _letters_setup = false
206 _held_letters = {}
207 _already_connected = false
208
209 client.connectToServer(ap_server, ap_user, ap_pass)
210
211
212func getSaveFileName():
213 return "zzAP_%s_%d" % [client._seed, client._slot]
214
215
216func disconnect_from_ap():
217 _already_connected = false
218
219 var effects = global.get_node("Effects")
220 effects.set_connection_lost(false)
221
222 client.disconnect_from_ap()
223
224
225func get_item_id_for_door(door_id):
226 return _item_locks.get(door_id, null)
227
228
229func _process_item(item, amount):
230 var gamedata = global.get_node("Gamedata")
231
232 var item_id = int(item["id"])
233 var prog_id = null
234 if _inverse_item_locks.has(item_id):
235 for lock in _inverse_item_locks.get(item_id):
236 if lock[1] != amount:
237 continue
238
239 if gamedata.progressive_id_by_ap_id.has(item_id):
240 prog_id = lock[0]
241
242 if gamedata.get_door_map_name(lock[0]) != global.map:
243 continue
244
245 # TODO: fix doors opening from door groups
246 var receivers = gamedata.get_door_receivers(lock[0])
247 var scene = get_tree().get_root().get_node_or_null("scene")
248 if scene != null:
249 for receiver in receivers:
250 var rnode = scene.get_node_or_null(receiver)
251 if rnode != null:
252 rnode.handleTriggered()
253
254 var letter_id = gamedata.letter_id_by_ap_id.get(item_id, null)
255 if letter_id != null:
256 var letter = gamedata.objects.get_letters()[letter_id]
257 if not letter.has_level2() or not letter.get_level2():
258 _process_key_item(letter.get_key(), amount)
259
260 if gamedata.symbol_item_ids.has(item_id):
261 var player = get_tree().get_root().get_node_or_null("scene/player")
262 if player != null:
263 player.evaluate_solvability.emit()
264
265 if item_id == gamedata.objects.get_special_ids()["A Job Well Done"]:
266 update_job_well_done_sign()
267
268 if item_id == gamedata.objects.get_special_ids()["Numbers"] and global.map == "the_fuzzy":
269 global.allow_numbers = true
270
271 # Show a message about the item if it's new.
272 if int(item["index"]) > _last_new_item:
273 _last_new_item = int(item["index"])
274 saveLocaldata()
275
276 var full_item_name = item["text"]
277 if prog_id != null:
278 var door = gamedata.objects.get_doors()[prog_id]
279 full_item_name = "%s (%s)" % [full_item_name, door.get_name()]
280
281 var message
282 if "sender" in item:
283 message = (
284 "Received %s from %s"
285 % [wrapInItemColorTags(full_item_name, item["flags"]), item["sender"]]
286 )
287 else:
288 message = "Found %s" % wrapInItemColorTags(full_item_name, item["flags"])
289
290 if gamedata.anti_trap_ids.has(item):
291 keyboard.block_letter(gamedata.anti_trap_ids[item])
292
293 global._print(message)
294
295 global.get_node("Messages").showMessage(message)
296
297
298func _process_item_sent_notification(message):
299 var sentMsg = (
300 "Sent %s to %s"
301 % [
302 wrapInItemColorTags(message["item_name"], message["item_flags"]),
303 message["receiver_name"]
304 ]
305 )
306 #if _hinted_locations.has(message["item"]["location"]):
307 # sentMsg += " ([color=#fafad2]Hinted![/color])"
308 global.get_node("Messages").showMessage(sentMsg)
309
310
311func _process_hint_received(message):
312 var is_for = ""
313 if message["self"] == 0:
314 is_for = " for %s" % message["receiver_name"]
315
316 global.get_node("Messages").showMessage(
317 (
318 "Hint: %s%s is on %s"
319 % [
320 wrapInItemColorTags(message["item_name"], message["item_flags"]),
321 is_for,
322 message["location_name"]
323 ]
324 )
325 )
326
327
328func _process_text_message(message):
329 var parts = []
330 for message_part in message:
331 if message_part["type"] == "text":
332 parts.append(message_part["text"])
333 elif message_part["type"] == "player":
334 if message_part["self"] == 1:
335 parts.append("[color=#ee00ee]%s[/color]" % message_part["text"])
336 else:
337 parts.append("[color=#fafad2]%s[/color]" % message_part["text"])
338 elif message_part["type"] == "item":
339 parts.append(wrapInItemColorTags(message_part["text"], int(message_part["flags"])))
340 elif message_part["type"] == "location":
341 parts.append("[color=#00ff7f]%s[/color]" % message_part["text"])
342
343 var textclient_node = global.get_node("Textclient")
344 if textclient_node != null:
345 textclient_node.parse_printjson("".join(parts))
346
347
348func _process_location_scout(location_id, item_name, player_name, flags, for_self):
349 _location_scouts[location_id] = {
350 "item": item_name, "player": player_name, "flags": flags, "for_self": for_self
351 }
352
353 if for_self and flags & 4 != 0:
354 # This is a trap for us, so let's not display it.
355 return
356
357 var gamedata = global.get_node("Gamedata")
358 var map_id = gamedata.map_id_by_name.get(global.map)
359
360 var letter_id = gamedata.letter_id_by_ap_id.get(location_id, null)
361 if letter_id != null:
362 var letter = gamedata.objects.get_letters()[letter_id]
363 var room = gamedata.objects.get_rooms()[letter.get_room_id()]
364 if room.get_map_id() == map_id:
365 var collectable = get_tree().get_root().get_node("scene").get_node_or_null(
366 letter.get_path()
367 )
368 if collectable != null:
369 collectable.setScoutedText(item_name)
370
371
372func _on_accessible_locations_updated():
373 var textclient_node = global.get_node("Textclient")
374 if textclient_node != null:
375 textclient_node.update_locations()
376
377
378func _on_checked_locations_updated():
379 var textclient_node = global.get_node("Textclient")
380 if textclient_node != null:
381 textclient_node.update_locations(false)
382
383
384func _on_checked_worldports_updated():
385 var textclient_node = global.get_node("Textclient")
386 if textclient_node != null:
387 textclient_node.update_locations()
388 textclient_node.update_worldports()
389
390
391func _on_ignored_locations_updated(locations):
392 _ignored_locations = locations
393
394 var textclient_node = global.get_node("Textclient")
395 if textclient_node != null:
396 textclient_node.update_locations()
397
398
399func _on_hinted_locations_updated():
400 var textclient_node = global.get_node("Textclient")
401 if textclient_node != null:
402 textclient_node.update_locations()
403
404
405func _on_door_latched(door_id):
406 var gamedata = global.get_node("Gamedata")
407 if gamedata.get_door_map_name(door_id) != global.map:
408 return
409
410 var receivers = gamedata.get_door_receivers(door_id)
411 var scene = get_tree().get_root().get_node_or_null("scene")
412 if scene != null:
413 for receiver in receivers:
414 var rnode = scene.get_node_or_null(receiver)
415 if rnode != null:
416 rnode.handleTriggered()
417
418
419func _client_could_not_connect(message):
420 could_not_connect.emit(message)
421
422 if global.loaded:
423 var effects = global.get_node("Effects")
424 effects.set_connection_lost(true)
425
426 var messages = global.get_node("Messages")
427 messages.showMessage("Connection to multiworld lost.")
428
429
430func _client_connect_status(message):
431 connect_status.emit(message)
432
433
434func _client_connected(slot_data):
435 var effects = global.get_node("Effects")
436 effects.set_connection_lost(false)
437
438 if _already_connected:
439 var messages = global.get_node("Messages")
440 messages.showMessage("Reconnected to multiworld!")
441 return
442
443 _already_connected = true
444
445 var gamedata = global.get_node("Gamedata")
446
447 _localdata_file = "user://archipelago_data/%s_%d" % [client._seed, client._slot]
448 _last_new_item = -1
449
450 if FileAccess.file_exists(_localdata_file):
451 var ap_file = FileAccess.open(_localdata_file, FileAccess.READ)
452 var localdata = []
453 if ap_file != null:
454 localdata = ap_file.get_var(true)
455 ap_file.close()
456
457 if typeof(localdata) != TYPE_ARRAY:
458 print("AP localdata file is corrupted")
459 localdata = []
460
461 if localdata.size() > 0:
462 _last_new_item = localdata[0]
463
464 # Read slot data.
465 cyan_door_behavior = int(slot_data.get("cyan_door_behavior", 0))
466 daedalus_roof_access = bool(slot_data.get("daedalus_roof_access", false))
467 enable_gift_maps = slot_data.get("enable_gift_maps", [])
468 enable_icarus = bool(slot_data.get("enable_icarus", false))
469 endings_requirement = int(slot_data.get("endings_requirement", 0))
470 keyholder_sanity = bool(slot_data.get("keyholder_sanity", false))
471 masteries_requirement = int(slot_data.get("masteries_requirement", 0))
472 shuffle_control_center_colors = bool(slot_data.get("shuffle_control_center_colors", false))
473 shuffle_doors = bool(slot_data.get("shuffle_doors", false))
474 shuffle_gallery_paintings = bool(slot_data.get("shuffle_gallery_paintings", false))
475 shuffle_letters = int(slot_data.get("shuffle_letters", 0))
476 shuffle_symbols = bool(slot_data.get("shuffle_symbols", false))
477 shuffle_worldports = bool(slot_data.get("shuffle_worldports", false))
478 strict_cyan_ending = bool(slot_data.get("strict_cyan_ending", false))
479 strict_purple_ending = bool(slot_data.get("strict_purple_ending", false))
480 victory_condition = int(slot_data.get("victory_condition", 0))
481
482 if slot_data.has("version"):
483 var version_msg = slot_data["version"]
484 apworld_version = [int(version_msg[0]), int(version_msg[1]), 0]
485 if version_msg.size() > 2:
486 apworld_version[2] = int(version_msg[2])
487
488 port_pairings.clear()
489 if slot_data.has("port_pairings"):
490 var raw_pp = slot_data.get("port_pairings")
491
492 for p1 in raw_pp.keys():
493 port_pairings[gamedata.port_id_by_ap_id[int(p1)]] = gamedata.port_id_by_ap_id[int(
494 raw_pp[p1]
495 )]
496
497 # Set up item locks.
498 _item_locks = {}
499
500 if shuffle_doors:
501 for door in gamedata.objects.get_doors():
502 if (
503 door.get_type() == gamedata.SCRIPT_proto.DoorType.STANDARD
504 or door.get_type() == gamedata.SCRIPT_proto.DoorType.ITEM_ONLY
505 ):
506 _item_locks[door.get_id()] = [door.get_ap_id(), 1]
507
508 for progressive in gamedata.objects.get_progressives():
509 for i in range(0, progressive.get_doors().size()):
510 var door = gamedata.objects.get_doors()[progressive.get_doors()[i]]
511 _item_locks[door.get_id()] = [progressive.get_ap_id(), i + 1]
512
513 for door_group in gamedata.objects.get_door_groups():
514 if door_group.get_type() == gamedata.SCRIPT_proto.DoorGroupType.CONNECTOR:
515 if shuffle_worldports:
516 continue
517 elif door_group.get_type() != gamedata.SCRIPT_proto.DoorGroupType.SHUFFLE_GROUP:
518 continue
519
520 for door in door_group.get_doors():
521 _item_locks[door] = [door_group.get_ap_id(), 1]
522
523 if shuffle_control_center_colors:
524 for door in gamedata.objects.get_doors():
525 if door.get_type() == gamedata.SCRIPT_proto.DoorType.CONTROL_CENTER_COLOR:
526 _item_locks[door.get_id()] = [door.get_ap_id(), 1]
527
528 for door_group in gamedata.objects.get_door_groups():
529 if (
530 door_group.get_type() == gamedata.SCRIPT_proto.DoorGroupType.COLOR_CONNECTOR
531 and not shuffle_worldports
532 ):
533 for door in door_group.get_doors():
534 _item_locks[door] = [door_group.get_ap_id(), 1]
535
536 if shuffle_gallery_paintings:
537 for door in gamedata.objects.get_doors():
538 if door.get_type() == gamedata.SCRIPT_proto.DoorType.GALLERY_PAINTING:
539 _item_locks[door.get_id()] = [door.get_ap_id(), 1]
540
541 if cyan_door_behavior == kCYAN_DOOR_BEHAVIOR_ITEM:
542 for door_group in gamedata.objects.get_door_groups():
543 if door_group.get_type() == gamedata.SCRIPT_proto.DoorGroupType.CYAN_DOORS:
544 for door in door_group.get_doors():
545 if not _item_locks.has(door):
546 _item_locks[door] = [door_group.get_ap_id(), 1]
547
548 # Create a reverse item locks map for processing items.
549 _inverse_item_locks = {}
550
551 for door_id in _item_locks.keys():
552 var lock = _item_locks.get(door_id)
553
554 if not _inverse_item_locks.has(lock[0]):
555 _inverse_item_locks[lock[0]] = []
556
557 _inverse_item_locks[lock[0]].append([door_id, lock[1]])
558
559 if shuffle_worldports:
560 var textclient = global.get_node("Textclient")
561 textclient.setup_worldports()
562
563 ap_connected.emit()
564
565
566func start_batching_locations():
567 _batch_locations = true
568
569
570func send_location(loc_id):
571 if client._checked_locations.has(loc_id):
572 return
573
574 if _batch_locations:
575 _held_locations.append(loc_id)
576 else:
577 client.sendLocation(loc_id)
578
579
580func scout_location(loc_id):
581 if _location_scouts.has(loc_id):
582 return _location_scouts.get(loc_id)
583
584 if _batch_locations:
585 _held_location_scouts.append(loc_id)
586 else:
587 client.scoutLocation(loc_id)
588
589 return null
590
591
592func stop_batching_locations():
593 _batch_locations = false
594
595 if not _held_locations.is_empty():
596 client.sendLocations(_held_locations)
597 _held_locations.clear()
598
599 if not _held_location_scouts.is_empty():
600 client.scoutLocations(_held_location_scouts)
601 _held_location_scouts.clear()
602
603
604func colorForItemType(flags):
605 var int_flags = int(flags)
606 if int_flags & 1: # progression
607 if int_flags & 2: # proguseful
608 return "#f0d200"
609 else:
610 return "#bc51e0"
611 elif int_flags & 2: # useful
612 return "#2b67ff"
613 elif int_flags & 4: # trap
614 return "#d63a22"
615 else: # filler
616 return "#14de9e"
617
618
619func wrapInItemColorTags(text, flags):
620 var int_flags = int(flags)
621 if int_flags & 1 and int_flags & 2: # proguseful
622 return "[rainbow]%s[/rainbow]" % text
623 else:
624 return "[color=%s]%s[/color]" % [colorForItemType(flags), text]
625
626
627func get_letter_behavior(key, level2):
628 if shuffle_letters == kSHUFFLE_LETTERS_UNLOCKED:
629 return kLETTER_BEHAVIOR_UNLOCKED
630
631 if [kSHUFFLE_LETTERS_VANILLA_CYAN, kSHUFFLE_LETTERS_ITEM_CYAN].has(shuffle_letters):
632 if level2:
633 if shuffle_letters == kSHUFFLE_LETTERS_VANILLA_CYAN:
634 return kLETTER_BEHAVIOR_VANILLA
635 else:
636 return kLETTER_BEHAVIOR_ITEM
637 else:
638 return kLETTER_BEHAVIOR_UNLOCKED
639
640 if not level2 and ["h", "i", "n", "t"].has(key):
641 # This differs from the equivalent function in the apworld. Logically it is
642 # the same as UNLOCKED since they are in the starting room, but VANILLA
643 # means the player still has to actually pick up the letters.
644 return kLETTER_BEHAVIOR_VANILLA
645
646 if shuffle_letters == kSHUFFLE_LETTERS_PROGRESSIVE:
647 return kLETTER_BEHAVIOR_ITEM
648
649 return kLETTER_BEHAVIOR_VANILLA
650
651
652func setup_keys():
653 keyboard.load_seed()
654
655 _letters_setup = true
656
657 for k in _held_letters.keys():
658 _process_key_item(k, _held_letters[k])
659
660 _held_letters.clear()
661
662
663func _process_key_item(key, level):
664 if not _letters_setup:
665 _held_letters[key] = max(_held_letters.get(key, 0), level)
666 return
667
668 if shuffle_letters == kSHUFFLE_LETTERS_ITEM_CYAN:
669 level += 1
670
671 keyboard.collect_remote_letter(key, level)
672
673
674func update_job_well_done_sign():
675 if global.map != "daedalus":
676 return
677
678 var gamedata = global.get_node("Gamedata")
679 var job_item = gamedata.objects.get_special_ids()["A Job Well Done"]
680 var jobs_done = client.getItemAmount(job_item)
681
682 var sign2 = get_tree().get_root().get_node_or_null("scene/Meshes/Miscellaneous/sign2")
683 var sign3 = get_tree().get_root().get_node_or_null("scene/Meshes/Miscellaneous/sign3")
684
685 if sign2 != null and sign3 != null:
686 if jobs_done == 0:
687 sign2.text = "what are you doing"
688 sign3.text = "?"
689 elif jobs_done == 1:
690 sign2.text = "a job well done"
691 sign3.text = "is its own reward"
692 else:
693 sign2.text = "%d jobs well done" % jobs_done
694 sign3.text = "are their own reward"
695
696 sign2.get_node("MeshInstance3D").mesh.text = sign2.text
697 sign3.get_node("MeshInstance3D").mesh.text = sign3.text
698
699
700func toggle_ignored_location(loc_id):
701 if loc_id in _ignored_locations:
702 client.removeIgnoredLocation(loc_id)
703 else:
704 client.addIgnoredLocation(loc_id)
705
706
707func get_map_script(map_name):
708 if !_map_scripts.has(map_name):
709 var runtime = global.get_node("Runtime")
710 var script_path = "maps/%s.gd" % map_name
711 if runtime.path_exists(script_path):
712 var script = runtime.load_script(script_path)
713 _map_scripts[map_name] = script.new()
714 else:
715 _map_scripts[map_name] = null
716
717 return _map_scripts[map_name]