1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
|
extends Node
var ap_server = ""
var ap_user = ""
var ap_pass = ""
const my_version = "0.2.3"
const ap_version = {"major": 0, "minor": 4, "build": 0, "class": "Version"}
const orange_tower = ["Second", "Third", "Fourth", "Fifth", "Sixth", "Seventh"]
const color_items = [
"White", "Black", "Red", "Blue", "Green", "Brown", "Gray", "Orange", "Purple", "Yellow"
]
const kTHE_END = 0
const kTHE_MASTER = 1
const kNO_PANEL_SHUFFLE = 0
const kREARRANGE_PANELS = 1
var _client = WebSocketClient.new()
var _should_process = false
var _initiated_disconnect = false
var _datapackages = {}
var _pending_packages = []
var _item_id_to_name = {} # All games
var _location_id_to_name = {} # All games
var _item_name_to_id = {} # LINGO only
var _location_name_to_id = {} # LINGO only
var _remote_version = {"major": 0, "minor": 0, "build": 0}
const uuid_util = preload("user://maps/Archipelago/vendor/uuid.gd")
# TODO: caching per MW/slot, reset between connections
var _authenticated = false
var _seed = ""
var _team = 0
var _slot = 0
var _players = []
var _player_name_by_slot = {}
var _checked_locations = []
var _slot_data = {}
var _door_ids_by_item = {}
var _mentioned_doors = []
var _painting_ids_by_item = {}
var _mentioned_paintings = []
var _panel_ids_by_location = {}
var _paintings = {}
var _paintings_mapping = {}
var _localdata_file = ""
var _death_link = false
var _victory_condition = 0 # THE END, THE MASTER
var _door_shuffle = false
var _color_shuffle = false
var _panel_shuffle = 0 # none, rearrange
var _painting_shuffle = false
var _slot_seed = 0
var _map_loaded = false
var _held_items = []
var _held_locations = []
var _last_new_item = -1
var _tower_floors = 0
var _has_colors = ["white"]
signal could_not_connect
signal client_connected
signal evaluate_solvability
func _init():
global._print("Instantiated APClient")
# Read AP settings from file, if there are any
var file = File.new()
if file.file_exists("user://settings/archipelago"):
file.open("user://settings/archipelago", File.READ)
var data = file.get_var(true)
file.close()
if data.size() > 0:
ap_server = data[0]
if data.size() > 1:
ap_user = data[1]
if data.size() > 2:
ap_pass = data[2]
if data.size() > 3:
_datapackages = data[3]
processDatapackages()
func _ready():
_client.connect("connection_closed", self, "_closed")
_client.connect("connection_failed", self, "_closed")
_client.connect("server_disconnected", self, "_closed")
_client.connect("connection_error", self, "_errored")
_client.connect("connection_established", self, "_connected")
_client.connect("data_received", self, "_on_data")
func _reset_state():
_should_process = false
_authenticated = false
_map_loaded = false
func _errored():
global._print("AP connection failed")
_reset_state()
emit_signal(
"could_not_connect",
"Could not connect to Archipelago. Check that your server and port are correct. See the error log for more information."
)
func _closed(_was_clean = true):
global._print("Connection closed")
_reset_state()
if not _initiated_disconnect:
emit_signal("could_not_connect", "Disconnected from Archipelago")
_initiated_disconnect = false
func _connected(_proto = ""):
global._print("Connected!")
func disconnect_from_ap():
_initiated_disconnect = true
_client.disconnect_from_host()
func _on_data():
var packet = _client.get_peer(1).get_packet()
global._print("Got data from server: " + packet.get_string_from_utf8())
var data = JSON.parse(packet.get_string_from_utf8())
if data.error != OK:
global._print("Error parsing packet from AP: " + data.error_string)
return
for message in data.result:
var cmd = message["cmd"]
global._print("Received command: " + cmd)
if cmd == "RoomInfo":
_seed = message["seed_name"]
_remote_version = message["version"]
var needed_games = []
for game in message["datapackage_checksums"].keys():
if (
!_datapackages.has(game)
or _datapackages[game]["checksum"] != message["datapackage_checksums"][game]
):
needed_games.append(game)
if !needed_games.empty():
_pending_packages = needed_games
var cur_needed = _pending_packages.pop_front()
requestDatapackages([cur_needed])
else:
connectToRoom()
elif cmd == "DataPackage":
for game in message["data"]["games"].keys():
_datapackages[game] = message["data"]["games"][game]
saveSettings()
if !_pending_packages.empty():
var cur_needed = _pending_packages.pop_front()
requestDatapackages([cur_needed])
else:
processDatapackages()
connectToRoom()
elif cmd == "Connected":
_authenticated = true
_team = message["team"]
_slot = message["slot"]
_players = message["players"]
_checked_locations = message["checked_locations"]
_slot_data = message["slot_data"]
for player in _players:
_player_name_by_slot[player["slot"]] = player["alias"]
if _slot_data.has("door_ids_by_item_id"):
_door_ids_by_item = _slot_data["door_ids_by_item_id"]
_mentioned_doors = []
for item in _door_ids_by_item.values():
for door in item:
_mentioned_doors.append(door)
if _slot_data.has("painting_ids_by_item_id"):
_painting_ids_by_item = _slot_data["painting_ids_by_item_id"]
_mentioned_paintings = []
for item in _painting_ids_by_item.values():
for painting in item:
_mentioned_paintings.append(painting)
if _slot_data.has("panel_ids_by_location_id"):
_panel_ids_by_location = _slot_data["panel_ids_by_location_id"]
if _slot_data.has("paintings"):
_paintings = _slot_data["paintings"]
_death_link = _slot_data.has("death_link") and _slot_data["death_link"]
if _death_link:
sendConnectUpdate(["DeathLink"])
if _slot_data.has("victory_condition"):
_victory_condition = _slot_data["victory_condition"]
if _slot_data.has("shuffle_colors"):
_color_shuffle = _slot_data["shuffle_colors"]
if _slot_data.has("shuffle_doors"):
_door_shuffle = (_slot_data["shuffle_doors"] > 0)
if _slot_data.has("shuffle_paintings"):
_painting_shuffle = (_slot_data["shuffle_paintings"] > 0)
if _slot_data.has("shuffle_panels"):
_panel_shuffle = _slot_data["shuffle_panels"]
if _slot_data.has("seed"):
_slot_seed = _slot_data["seed"]
if _slot_data.has("painting_entrance_to_exit"):
_paintings_mapping = _slot_data["painting_entrance_to_exit"]
_localdata_file = "user://archipelago_data/%s_%d" % [_seed, _slot]
var ap_file = File.new()
if ap_file.file_exists(_localdata_file):
ap_file.open(_localdata_file, File.READ)
var localdata = ap_file.get_var(true)
ap_file.close()
if localdata.size() > 0:
_last_new_item = localdata[0]
else:
_last_new_item = -1
requestSync()
emit_signal("client_connected")
elif cmd == "ConnectionRefused":
var error_message = ""
for error in message["errors"]:
var submsg = ""
if error == "InvalidSlot":
submsg = "Invalid player name."
elif error == "InvalidGame":
submsg = "The specified player is not playing Lingo."
elif error == "IncompatibleVersion":
submsg = (
"The Archipelago server is not the correct version for this client. Expected v%d.%d.%d. Found v%d.%d.%d."
% [
ap_version["major"],
ap_version["minor"],
ap_version["build"],
_remote_version["major"],
_remote_version["minor"],
_remote_version["build"]
]
)
elif error == "InvalidPassword":
submsg = "Incorrect password."
elif error == "InvalidItemsHandling":
submsg = "Invalid item handling flag. This is a bug with the client. Please report it to the lingo-archipelago GitHub."
if submsg != "":
if error_message != "":
error_message += " "
error_message += submsg
if error_message == "":
error_message = "Unknown error."
_initiated_disconnect = true
_client.disconnect_from_host()
emit_signal("could_not_connect", error_message)
global._print("Connection to AP refused")
global._print(message)
elif cmd == "ReceivedItems":
if message["index"] == 0:
# We are being sent all of our items, so lets reset any progress
# on progressive items.
_tower_floors = 0
_held_items = []
var i = 0
for item in message["items"]:
if _map_loaded:
processItem(item["item"], message["index"] + i, item["player"], item["flags"])
else:
_held_items.append(
{
"item": item["item"],
"index": message["index"] + i,
"from": item["player"],
"flags": item["flags"]
}
)
i += 1
elif cmd == "PrintJSON":
if (
!message.has("receiving")
or !message.has("item")
or message["item"]["player"] != _slot
):
continue
var item_name = "Unknown"
if _item_id_to_name.has(message["item"]["item"]):
item_name = _item_id_to_name[message["item"]["item"]]
var location_name = "Unknown"
if _location_id_to_name.has(message["item"]["location"]):
location_name = _location_id_to_name[message["item"]["location"]]
var player_name = "Unknown"
if _player_name_by_slot.has(message["receiving"]):
player_name = _player_name_by_slot[message["receiving"]]
var item_color = colorForItemType(message["item"]["flags"])
var messages_node = get_tree().get_root().get_node("Spatial/AP_Messages")
if message["type"] == "Hint":
var is_for = ""
if message["receiving"] != _slot:
is_for = " for %s" % player_name
if !message.has("found") || !message["found"]:
messages_node.showMessage(
(
"Hint: [color=%s]%s[/color]%s is on %s"
% [item_color, item_name, is_for, location_name]
)
)
else:
if message["receiving"] != _slot:
messages_node.showMessage(
"Sent [color=%s]%s[/color] to %s" % [item_color, item_name, player_name]
)
elif cmd == "Bounced":
if (
_death_link
and message.has("tags")
and message.has("data")
and message["tags"].has("DeathLink")
):
var messages_node = get_tree().get_root().get_node("Spatial/AP_Messages")
var first_sentence = "Received Death"
var second_sentence = ""
if message["data"].has("source"):
first_sentence = "Received Death from %s" % message["data"]["source"]
if message["data"].has("cause"):
second_sentence = ". Reason: %s" % message["data"]["cause"]
messages_node.showMessage(first_sentence + second_sentence)
# Return the player home.
get_tree().get_root().get_node("Spatial/player/pause_menu")._reload()
func _process(_delta):
if _should_process:
_client.poll()
func saveSettings():
# Save the AP settings to disk.
var dir = Directory.new()
var path = "user://settings"
if dir.dir_exists(path):
pass
else:
dir.make_dir(path)
var file = File.new()
file.open("user://settings/archipelago", File.WRITE)
var data = [ap_server, ap_user, ap_pass, _datapackages]
file.store_var(data, true)
file.close()
func saveLocaldata():
# Save the MW/slot specific settings to disk.
var dir = Directory.new()
var path = "user://archipelago_data"
if dir.dir_exists(path):
pass
else:
dir.make_dir(path)
var file = File.new()
file.open(_localdata_file, File.WRITE)
var data = [_last_new_item]
file.store_var(data, true)
file.close()
func getSaveFileName():
return "zzAP_%s_%d" % [_seed, _slot]
func connectToServer():
_initiated_disconnect = false
var url = "ws://" + ap_server
var err = _client.connect_to_url(url)
if err != OK:
emit_signal(
"could_not_connect",
(
"Could not connect to Archipelago. Check that your server and port are correct. See the error log for more information. Error code: %d."
% err
)
)
global._print("Could not connect to AP: " + err)
return
_should_process = true
func sendMessage(msg):
var payload = JSON.print(msg)
_client.get_peer(1).set_write_mode(WebSocketPeer.WRITE_MODE_TEXT)
_client.get_peer(1).put_packet(payload.to_utf8())
func requestDatapackages(games):
sendMessage([{"cmd": "GetDataPackage", "games": games}])
func processDatapackages():
_item_id_to_name = {}
_location_id_to_name = {}
for package in _datapackages.values():
for name in package["item_name_to_id"].keys():
_item_id_to_name[package["item_name_to_id"][name]] = name
for name in package["location_name_to_id"].keys():
_location_id_to_name[package["location_name_to_id"][name]] = name
if _datapackages.has("Lingo"):
_item_name_to_id = _datapackages["Lingo"]["item_name_to_id"]
_location_name_to_id = _datapackages["Lingo"]["location_name_to_id"]
func connectToRoom():
sendMessage(
[
{
"cmd": "Connect",
"password": ap_pass,
"game": "Lingo",
"name": ap_user,
"uuid": uuid_util.v4(),
"version": ap_version,
"items_handling": 0b111, # always receive our items
"tags": [],
"slot_data": true
}
]
)
func sendConnectUpdate(tags):
sendMessage([{"cmd": "ConnectUpdate", "tags": tags}])
func requestSync():
sendMessage([{"cmd": "Sync"}])
func sendLocation(loc_id):
if _map_loaded:
sendMessage([{"cmd": "LocationChecks", "locations": [loc_id]}])
else:
_held_locations.append(loc_id)
func completedGoal():
sendMessage([{"cmd": "StatusUpdate", "status": 30}]) # CLIENT_GOAL
func mapFinishedLoading():
if !_map_loaded:
_has_colors = ["white"]
emit_signal("evaluate_solvability")
for item in _held_items:
processItem(item["item"], item["index"], item["from"], item["flags"])
sendMessage([{"cmd": "LocationChecks", "locations": _held_locations}])
_map_loaded = true
_held_items = []
_held_locations = []
func processItem(item, index, from, flags):
global._print(item)
var stringified = String(item)
if _door_ids_by_item.has(stringified):
var doorsNode = get_tree().get_root().get_node("Spatial/Doors")
for door_id in _door_ids_by_item[stringified]:
doorsNode.get_node(door_id).openDoor()
if _painting_ids_by_item.has(stringified):
var real_parent_node = get_tree().get_root().get_node("Spatial/Decorations/Paintings")
var fake_parent_node = get_tree().get_root().get_node("Spatial/AP_Paintings")
for painting_id in _painting_ids_by_item[stringified]:
var painting_node = real_parent_node.get_node_or_null(painting_id)
if painting_node != null:
painting_node.movePainting()
if _painting_shuffle:
painting_node = fake_parent_node.get_node_or_null(painting_id)
if painting_node != null:
painting_node.get_node("Script").movePainting()
# Handle progressively opening up the tower.
if _item_name_to_id["Progressive Orange Tower"] == item and _tower_floors < orange_tower.size():
var subitem_name = "Orange Tower - %s Floor" % orange_tower[_tower_floors]
global._print(subitem_name)
processItem(_item_name_to_id[subitem_name], null, null, null)
_tower_floors += 1
if _color_shuffle and color_items.has(_item_id_to_name[item]):
var lcol = _item_id_to_name[item].to_lower()
if not _has_colors.has(lcol):
_has_colors.append(lcol)
emit_signal("evaluate_solvability")
# Show a message about the item if it's new. Also apply effects here.
if index != null and index > _last_new_item:
_last_new_item = index
saveLocaldata()
var item_name = "Unknown"
if _item_id_to_name.has(item):
item_name = _item_id_to_name[item]
if item_name == "Progressive Orange Tower":
item_name = "Progressive Orange Tower (%s Floor)" % orange_tower[_tower_floors - 1]
var player_name = "Unknown"
if _player_name_by_slot.has(from):
player_name = _player_name_by_slot[from]
var item_color = colorForItemType(flags)
var messages_node = get_tree().get_root().get_node("Spatial/AP_Messages")
if from == _slot:
messages_node.showMessage("Found [color=%s]%s[/color]" % [item_color, item_name])
else:
messages_node.showMessage(
"Received [color=%s]%s[/color] from %s" % [item_color, item_name, player_name]
)
var effects_node = get_tree().get_root().get_node("Spatial/AP_Effects")
if item_name == "Slowness Trap":
effects_node.trigger_slowness_trap()
if item_name == "Iceland Trap":
effects_node.trigger_iceland_trap()
func doorIsVanilla(door):
return !_mentioned_doors.has(door)
func paintingIsVanilla(painting):
return !_mentioned_paintings.has(painting)
func colorForItemType(flags):
var int_flags = int(flags)
if int_flags & 1: # progression
return "#bc51e0"
elif int_flags & 2: # useful
return "#2b67ff"
elif int_flags & 4: # trap
return "#d63a22"
else: # filler
return "#14de9e"
|
