14 files changed, 610 insertions, 37 deletions

@@ -41,6 +41,7 @@ signal connect_status
 signal client_connected(slot_data)
 signal item_received(item_id, index, player, flags, amount)
 signal message_received(message)
+signal location_scout_received(item_id, location_id, player, flags)
 
 
 func _init():
@@ -257,6 +258,16 @@ func _process(_delta):
                                         elif cmd == "PrintJSON":
                                                 emit_signal("message_received", message)
 
+                                        elif cmd == "LocationInfo":
+                                                for loc in message["locations"]:
+                                                        emit_signal(
+                                                                "location_scout_received",
+                                                                int(loc["item"]),
+                                                                int(loc["location"]),
+                                                                int(loc["player"]),
+                                                                int(loc["flags"])
+                                                        )
+
                 elif state == WebSocketPeer.STATE_CLOSED:
                         if _has_connected:
                                 _closed()
@@ -392,6 +403,10 @@ func completedGoal():
         sendMessage([{"cmd": "StatusUpdate", "status": 30}])  # CLIENT_GOAL
 
 
+func scoutLocations(loc_ids):
+        sendMessage([{"cmd": "LocationScouts", "locations": loc_ids}])
+
+
 func hasItem(item_id):
         return _received_items.has(item_id)
 
@@ -0,0 +1,16 @@
+extends "res://scripts/nodes/collectable.gd"
+
+
+func pickedUp():
+        if unlock_type == "key":
+                var ap = global.get_node("Archipelago")
+                if ap.get_letter_behavior(unlock_key, level == 2) == ap.kLETTER_BEHAVIOR_VANILLA:
+                        ap.keyboard.collect_local_letter(unlock_key, level)
+                else:
+                        ap.keyboard.update_unlocks()
+
+        super.pickedUp()
+
+
+func setScoutedText(text):
+        get_node("MeshInstance3D").mesh.text = text.replace(" ", "\n")
@@ -8,6 +8,7 @@ var painting_id_by_map_node_path = {}
 var door_id_by_ap_id = {}
 var map_id_by_name = {}
 var progressive_id_by_ap_id = {}
+var letter_id_by_ap_id = {}
 
 
 func _init(proto_script):
@@ -54,6 +55,9 @@ func load(data_bytes):
         for progressive in objects.get_progressives():
                 progressive_id_by_ap_id[progressive.get_ap_id()] = progressive.get_id()
 
+        for letter in objects.get_letters():
+                letter_id_by_ap_id[letter.get_ap_id()] = letter.get_id()
+
 
 func get_door_for_map_node_path(map_name, node_path):
         if not door_id_by_map_node_path.has(map_name):
@@ -0,0 +1,38 @@
+extends "res://scripts/nodes/keyHolder.gd"
+
+
+func setFromAp(key, level):
+        if level > 0:
+                has_key = true
+                is_complete = "%s%d" % [key, level]
+                held_key = key
+                held_level = level
+                get_node("Hinge/Letter").mesh.text = held_key
+                get_node("Hinge/Letter2").mesh.text = held_key
+                setMaterial()
+                emit_signal("trigger")
+        else:
+                has_key = false
+                held_key = ""
+                held_level = 0
+                setMaterial()
+                get_node("Hinge/Letter").mesh.text = "-"
+                get_node("Hinge/Letter2").mesh.text = "-"
+                is_complete = ""
+                emit_signal("untrigger")
+
+
+func addKey(key):
+        var node_path = String(
+                get_tree().get_root().get_node("scene").get_path_to(self).get_concatenated_names()
+        )
+        var ap = global.get_node("Archipelago")
+        ap.keyboard.put_in_keyholder(key, global.map, node_path)
+
+
+func removeKey():
+        var node_path = String(
+                get_tree().get_root().get_node("scene").get_path_to(self).get_concatenated_names()
+        )
+        var ap = global.get_node("Archipelago")
+        ap.keyboard.remove_from_keyholder(held_key, global.map, node_path)
@@ -0,0 +1,24 @@
+extends "res://scripts/nodes/listeners/keyHolderChecker.gd"
+
+
+func check():
+        var ap = global.get_node("Archipelago")
+        var matches = []
+        for map in ap.keyboard.keyholder_state.keys():
+                var nodes = ap.keyboard.keyholder_state[map]
+                for node in nodes.keys():
+                        matches.append([nodes[node], 1, map, "/root/scene/%s" % node])
+
+        var count = 0
+        for key_match in matches:
+                var active = (
+                        key_match[2] + String(key_match[3]).replace("/root/scene/Components/KeyHolders/", ".")
+                )
+                if map[active] == key_match[0]:
+                        emit_signal("trigger_letter", key_match[0], true)
+                        count += 1
+                else:
+                        emit_signal("trigger_letter", key_match[0], false)
+
+        if count > 25:
+                emit_signal("trigger")
@@ -0,0 +1,8 @@
+extends "res://scripts/nodes/listeners/keyHolderResetterListener.gd"
+
+
+func reset():
+        var ap = global.get_node("Archipelago")
+        var was_removed = ap.keyboard.reset_keyholders()
+        if was_removed:
+                sfxPlayer.sfx_play("pickup")
@@ -0,0 +1,178 @@
+extends Node
+
+const kALL_LETTERS = "abcdefghjiklmnopqrstuvwxyz"
+
+var letters_saved = {}
+var letters_in_keyholders = []
+var letters_dynamic = {}
+var keyholder_state = {}
+
+var filename = ""
+
+
+func _init():
+        reset()
+
+
+func reset():
+        letters_saved.clear()
+        letters_in_keyholders.clear()
+        letters_dynamic.clear()
+        keyholder_state.clear()
+
+
+func load_seed():
+        var ap = global.get_node("Archipelago")
+
+        reset()
+
+        filename = "user://archipelago_keys/%s_%d" % [ap.client._seed, ap.client._slot]
+
+        if FileAccess.file_exists(filename):
+                var ap_file = FileAccess.open(filename, FileAccess.READ)
+                var localdata = []
+                if ap_file != null:
+                        localdata = ap_file.get_var(true)
+                        ap_file.close()
+
+                if typeof(localdata) != TYPE_ARRAY:
+                        print("AP keyboard file is corrupted")
+                        localdata = []
+
+                if localdata.size() > 0:
+                        letters_saved = localdata[0]
+                if localdata.size() > 1:
+                        letters_in_keyholders = localdata[1]
+                if localdata.size() > 2:
+                        keyholder_state = localdata[2]
+
+        for k in kALL_LETTERS:
+                var level = 0
+
+                if ap.get_letter_behavior(k, false) == ap.kLETTER_BEHAVIOR_UNLOCKED:
+                        level += 1
+                if ap.get_letter_behavior(k, true) == ap.kLETTER_BEHAVIOR_UNLOCKED:
+                        level += 1
+
+                letters_dynamic[k] = level
+
+        update_unlocks()
+
+
+func save():
+        var dir = DirAccess.open("user://")
+        var folder = "archipelago_keys"
+        if not dir.dir_exists(folder):
+                dir.make_dir(folder)
+
+        var file = FileAccess.open(filename, FileAccess.WRITE)
+
+        var data = [
+                letters_saved,
+                letters_in_keyholders,
+                keyholder_state,
+        ]
+        file.store_var(data, true)
+        file.close()
+
+
+func update_unlocks():
+        unlocks.resetKeys()
+
+        var has_doubles = false
+
+        for k in kALL_LETTERS:
+                var level = 0
+
+                if not letters_in_keyholders.has(k):
+                        level = letters_saved.get(k, 0) + letters_dynamic.get(k, 0)
+
+                if level >= 2:
+                        level = 2
+                        has_doubles = true
+
+                unlocks.unlockKey(k, level)
+
+        if has_doubles and unlocks.data["double_letters"] != "unlocked":
+                var ap = global.get_node("Archipelago")
+                if ap.cyan_door_behavior == ap.kCYAN_DOOR_BEHAVIOR_DOUBLE_LETTER:
+                        unlocks.setData("double_letters", "unlocked")
+
+
+func collect_local_letter(key, level):
+        if level < 0 or level > 2 or level < letters_saved.get(key, 0):
+                return
+
+        letters_saved[key] = level
+
+        update_unlocks()
+        save()
+
+
+func collect_remote_letter(key, level):
+        if level < 0 or level > 2 or level < letters_dynamic.get(key, 0):
+                return
+
+        letters_dynamic[key] = level
+
+        update_unlocks()
+        save()
+
+
+func put_in_keyholder(key, map, kh_path):
+        if not keyholder_state.has(map):
+                keyholder_state[map] = {}
+
+        keyholder_state[map][kh_path] = key
+        letters_in_keyholders.append(key)
+
+        get_tree().get_root().get_node("scene").get_node(kh_path).setFromAp(
+                key, min(letters_saved.get(key, 0) + letters_dynamic.get(key, 0), 2)
+        )
+
+        update_unlocks()
+        save()
+
+
+func remove_from_keyholder(key, map, kh_path):
+        if not keyholder_state.has(map):
+                # This... shouldn't happen.
+                keyholder_state[map] = {}
+
+        keyholder_state[map].erase(kh_path)
+        letters_in_keyholders.erase(key)
+
+        get_tree().get_root().get_node("scene").get_node(kh_path).setFromAp(key, 0)
+
+        update_unlocks()
+        save()
+
+
+func load_keyholders(map):
+        if keyholder_state.has(map):
+                var khs = keyholder_state[map]
+
+                for path in khs.keys():
+                        var key = khs[path]
+                        get_tree().get_root().get_node("scene").get_node(path).setFromAp(
+                                key, min(letters_saved.get(key, 0) + letters_dynamic.get(key, 0), 2)
+                        )
+
+
+func reset_keyholders():
+        if letters_in_keyholders.is_empty():
+                return false
+
+        if keyholder_state.has(global.map):
+                for path in keyholder_state[global.map]:
+                        get_tree().get_root().get_node("scene").get_node(path).setFromAp(
+                                keyholder_state[global.map][path], 0
+                        )
+
+        keyholder_state.clear()
+        letters_in_keyholders.clear()
+
+        update_unlocks()
+        save()
+
+        return true
@@ -3,6 +3,7 @@ extends Node
 const my_version = "0.1.0"
 
 var SCRIPT_client
+var SCRIPT_keyboard
 var SCRIPT_locationListener
 var SCRIPT_uuid
 var SCRIPT_victoryListener
@@ -13,16 +14,39 @@ var ap_pass = ""
 var connection_history = []
 
 var client
+var keyboard
 
 var _localdata_file = ""
 var _last_new_item = -1
 var _batch_locations = false
 var _held_locations = []
+var _held_location_scouts = []
+var _location_scouts = {}
 var _item_locks = {}
+var _inverse_item_locks = {}
+var _held_letters = {}
+var _letters_setup = false
 
+const kSHUFFLE_LETTERS_VANILLA = 0
+const kSHUFFLE_LETTERS_UNLOCKED = 1
+const kSHUFFLE_LETTERS_PROGRESSIVE = 2
+const kSHUFFLE_LETTERS_VANILLA_CYAN = 3
+const kSHUFFLE_LETTERS_ITEM_CYAN = 4
+
+const kLETTER_BEHAVIOR_VANILLA = 0
+const kLETTER_BEHAVIOR_ITEM = 1
+const kLETTER_BEHAVIOR_UNLOCKED = 2
+
+const kCYAN_DOOR_BEHAVIOR_H2 = 0
+const kCYAN_DOOR_BEHAVIOR_DOUBLE_LETTER = 1
+const kCYAN_DOOR_BEHAVIOR_ITEM = 2
+
+var cyan_door_behavior = kCYAN_DOOR_BEHAVIOR_H2
 var daedalus_roof_access = false
 var keyholder_sanity = false
+var shuffle_control_center_colors = false
 var shuffle_doors = false
+var shuffle_letters = kSHUFFLE_LETTERS_VANILLA
 var victory_condition = -1
 
 signal could_not_connect
@@ -60,12 +84,16 @@ func _ready():
 
         client.connect("item_received", _process_item)
         client.connect("message_received", _process_message)
+        client.connect("location_scout_received", _process_location_scout)
         client.connect("could_not_connect", _client_could_not_connect)
         client.connect("connect_status", _client_connect_status)
         client.connect("client_connected", _client_connected)
 
         add_child(client)
 
+        keyboard = SCRIPT_keyboard.new()
+        add_child(keyboard)
+
 
 func saveSettings():
         # Save the AP settings to disk.
@@ -100,6 +128,12 @@ func saveLocaldata():
 
 func connectToServer():
         _last_new_item = -1
+        _batch_locations = false
+        _held_locations = []
+        _held_location_scouts = []
+        _location_scouts = {}
+        _letters_setup = false
+        _held_letters = {}
 
         client.connectToServer(ap_server, ap_user, ap_pass)
 
@@ -122,29 +156,32 @@ func _process_item(item, index, from, flags, amount):
                 item_name = client._item_id_to_name["Lingo 2"][item]
 
         var gamedata = global.get_node("Gamedata")
-        var door_id = gamedata.door_id_by_ap_id.get(item, null)
-        var prog_id = null
 
-        if door_id == null:
-                prog_id = gamedata.progressive_id_by_ap_id.get(item, null)
-                if prog_id != null:
-                        var progressive = gamedata.objects.get_progressives()[prog_id]
-                        if progressive.get_doors().size() >= amount:
-                                door_id = progressive.get_doors()[amount - 1]
-
-        if door_id != null and gamedata.get_door_map_name(door_id) == global.map:
-                var receivers = gamedata.get_door_receivers(door_id)
-                var scene = get_tree().get_root().get_node_or_null("scene")
-                if scene != null:
-                        for receiver in receivers:
-                                var rnode = scene.get_node_or_null(receiver)
-                                if rnode != null:
-                                        rnode.handleTriggered()
-                        #for painting_id in gamedata.objects.get_doors()[door_id].get_move_paintings():
-                        #       var painting = gamedata.objects.get_paintings()[painting_id]
-                        #       var pnode = scene.get_node_or_null(painting.get_path() + "/teleportListener")
-                        #       if pnode != null:
-                        #               pnode.handleTriggered()
+        var prog_id = null
+        if _inverse_item_locks.has(item):
+                for lock in _inverse_item_locks.get(item):
+                        if lock[1] != amount:
+                                continue
+
+                        if gamedata.progressive_id_by_ap_id.has(item):
+                                prog_id = lock[0]
+
+                        if gamedata.get_door_map_name(lock[0]) != global.map:
+                                continue
+
+                        var receivers = gamedata.get_door_receivers(lock[0])
+                        var scene = get_tree().get_root().get_node_or_null("scene")
+                        if scene != null:
+                                for receiver in receivers:
+                                        var rnode = scene.get_node_or_null(receiver)
+                                        if rnode != null:
+                                                rnode.handleTriggered()
+
+        var letter_id = gamedata.letter_id_by_ap_id.get(item, null)
+        if letter_id != null:
+                var letter = gamedata.objects.get_letters()[letter_id]
+                if not letter.has_level2() or not letter.get_level2():
+                        _process_key_item(letter.get_key(), amount)
 
         # Show a message about the item if it's new.
         if index != null and index > _last_new_item:
@@ -158,8 +195,8 @@ func _process_item(item, index, from, flags, amount):
                 var item_color = colorForItemType(flags)
 
                 var full_item_name = item_name
-                if prog_id != null and door_id != null:
-                        var door = gamedata.objects.get_doors()[door_id]
+                if prog_id != null:
+                        var door = gamedata.objects.get_doors()[prog_id]
                         full_item_name = "%s (%s)" % [item_name, door.get_name()]
 
                 var message
@@ -261,6 +298,29 @@ func parse_printjson_for_textclient(message):
                 textclient_node.parse_printjson("".join(parts))
 
 
+func _process_location_scout(item_id, location_id, player, flags):
+        _location_scouts[location_id] = {"item": item_id, "player": player, "flags": flags}
+
+        var gamedata = global.get_node("Gamedata")
+        var map_id = gamedata.map_id_by_name.get(global.map)
+
+        var item_name = "Unknown"
+        var item_player_game = client._game_by_player[float(player)]
+        if client._item_id_to_name[item_player_game].has(item_id):
+                item_name = client._item_id_to_name[item_player_game][item_id]
+
+        var letter_id = gamedata.letter_id_by_ap_id.get(location_id, null)
+        if letter_id != null:
+                var letter = gamedata.objects.get_letters()[letter_id]
+                var room = gamedata.objects.get_rooms()[letter.get_room_id()]
+                if room.get_map_id() == map_id:
+                        var collectable = get_tree().get_root().get_node("scene").get_node_or_null(
+                                letter.get_path()
+                        )
+                        if collectable != null:
+                                collectable.setScoutedText(item_name)
+
+
 func _client_could_not_connect():
         emit_signal("could_not_connect")
 
@@ -290,9 +350,12 @@ func _client_connected(slot_data):
                         _last_new_item = localdata[0]
 
         # Read slot data.
+        cyan_door_behavior = int(slot_data.get("cyan_door_behavior", 0))
         daedalus_roof_access = bool(slot_data.get("daedalus_roof_access", false))
         keyholder_sanity = bool(slot_data.get("keyholder_sanity", false))
+        shuffle_control_center_colors = bool(slot_data.get("shuffle_control_center_colors", false))
         shuffle_doors = bool(slot_data.get("shuffle_doors", false))
+        shuffle_letters = int(slot_data.get("shuffle_letters", 0))
         victory_condition = int(slot_data.get("victory_condition", 0))
 
         # Set up item locks.
@@ -311,6 +374,42 @@ func _client_connected(slot_data):
                                 var door = gamedata.objects.get_doors()[progressive.get_doors()[i]]
                                 _item_locks[door.get_id()] = [progressive.get_ap_id(), i + 1]
 
+                for door_group in gamedata.objects.get_door_groups():
+                        if (
+                                door_group.get_type() == gamedata.SCRIPT_proto.DoorGroupType.CONNECTOR
+                                or door_group.get_type() == gamedata.SCRIPT_proto.DoorGroupType.SHUFFLE_GROUP
+                        ):
+                                for door in door_group.get_doors():
+                                        _item_locks[door] = [door_group.get_ap_id(), 1]
+
+        if shuffle_control_center_colors:
+                for door in gamedata.objects.get_doors():
+                        if door.get_type() == gamedata.SCRIPT_proto.DoorType.CONTROL_CENTER_COLOR:
+                                _item_locks[door.get_id()] = [door.get_ap_id(), 1]
+
+                for door_group in gamedata.objects.get_door_groups():
+                        if door_group.get_type() == gamedata.SCRIPT_proto.DoorGroupType.COLOR_CONNECTOR:
+                                for door in door_group.get_doors():
+                                        _item_locks[door] = [door_group.get_ap_id(), 1]
+
+        if cyan_door_behavior == kCYAN_DOOR_BEHAVIOR_ITEM:
+                for door_group in gamedata.objects.get_door_groups():
+                        if door_group.get_type() == gamedata.SCRIPT_proto.DoorGroupType.CYAN_DOORS:
+                                for door in door_group.get_doors():
+                                        if not _item_locks.has(door):
+                                                _item_locks[door] = [door_group.get_ap_id(), 1]
+
+        # Create a reverse item locks map for processing items.
+        _inverse_item_locks = {}
+
+        for door_id in _item_locks.keys():
+                var lock = _item_locks.get(door_id)
+
+                if not _inverse_item_locks.has(lock[0]):
+                        _inverse_item_locks[lock[0]] = []
+
+                _inverse_item_locks[lock[0]].append([door_id, lock[1]])
+
         emit_signal("ap_connected")
 
 
@@ -325,10 +424,28 @@ func send_location(loc_id):
                 client.sendLocation(loc_id)
 
 
+func scout_location(loc_id):
+        if _location_scouts.has(loc_id):
+                return _location_scouts.get(loc_id)
+
+        if _batch_locations:
+                _held_location_scouts.append(loc_id)
+        else:
+                client.scoutLocation(loc_id)
+
+        return null
+
+
 func stop_batching_locations():
         _batch_locations = false
-        client.sendLocations(_held_locations)
-        _held_locations.clear()
+
+        if not _held_locations.is_empty():
+                client.sendLocations(_held_locations)
+                _held_locations.clear()
+
+        if not _held_location_scouts.is_empty():
+                client.scoutLocations(_held_location_scouts)
+                _held_location_scouts.clear()
 
 
 func colorForItemType(flags):
@@ -344,3 +461,47 @@ func colorForItemType(flags):
                 return "#d63a22"
         else:  # filler
                 return "#14de9e"
+
+
+func get_letter_behavior(key, level2):
+        if shuffle_letters == kSHUFFLE_LETTERS_UNLOCKED:
+                return kLETTER_BEHAVIOR_UNLOCKED
+
+        if [kSHUFFLE_LETTERS_VANILLA_CYAN, kSHUFFLE_LETTERS_ITEM_CYAN].has(shuffle_letters):
+                if level2:
+                        if shuffle_letters == kSHUFFLE_LETTERS_VANILLA_CYAN:
+                                return kLETTER_BEHAVIOR_VANILLA
+                        else:
+                                return kLETTER_BEHAVIOR_ITEM
+                else:
+                        return kLETTER_BEHAVIOR_UNLOCKED
+
+        if not level2 and ["h", "i", "n", "t"].has(key):
+                # This differs from the equivalent function in the apworld. Logically it is
+                # the same as UNLOCKED since they are in the starting room, but VANILLA
+                # means the player still has to actually pick up the letters.
+                return kLETTER_BEHAVIOR_VANILLA
+
+        if shuffle_letters == kSHUFFLE_LETTERS_PROGRESSIVE:
+                return kLETTER_BEHAVIOR_ITEM
+
+        return kLETTER_BEHAVIOR_VANILLA
+
+
+func setup_keys():
+        keyboard.load_seed()
+
+        _letters_setup = true
+
+        for k in _held_letters.keys():
+                _process_key_item(k, _held_letters[k])
+
+        _held_letters.clear()
+
+
+func _process_key_item(key, level):
+        if not _letters_setup:
+                _held_letters[key] = max(_held_letters.get(key, 0), level)
+                return
+
+        keyboard.collect_remote_letter(key, level)
@@ -4,3 +4,9 @@ extends "res://scripts/ui/pauseMenu.gd"
 func _pause_game():
         global.get_node("Textclient").dismiss()
         super._pause_game()
+
+
+func _main_menu():
+        global.loaded = false
+        global.get_node("Archipelago").disconnect_from_ap()
+        super._main_menu()
@@ -81,6 +81,23 @@ func _ready():
 
                 get_parent().add_child.call_deferred(locationListener)
 
+                if (
+                        ap.get_letter_behavior(letter.get_key(), letter.has_level2() and letter.get_level2())
+                        != ap.kLETTER_BEHAVIOR_VANILLA
+                ):
+                        var scout = ap.scout_location(letter.get_ap_id())
+                        if scout != null:
+                                var item_name = "Unknown"
+                                var item_player_game = ap.client._game_by_player[float(scout["player"])]
+                                if ap.client._item_id_to_name[item_player_game].has(scout["item"]):
+                                        item_name = ap.client._item_id_to_name[item_player_game][scout["item"]]
+
+                                        var collectable = get_tree().get_root().get_node("scene").get_node_or_null(
+                                                letter.get_path()
+                                        )
+                                        if collectable != null:
+                                                collectable.setScoutedText.call_deferred(item_name)
+
         # Set up mastery locations.
         for mastery in gamedata.objects.get_masteries():
                 var room = gamedata.objects.get_rooms()[mastery.get_room_id()]
@@ -2,4 +2,8 @@ extends "res://scripts/nodes/saver.gd"
 
 
 func levelLoaded():
-        reload.call_deferred()
+        if type == "keyholders":
+                var ap = global.get_node("Archipelago")
+                ap.keyboard.load_keyholders.call_deferred(global.map)
+        else:
+                reload.call_deferred()
@@ -22,14 +22,8 @@ func _ready():
                 var ap_instance = ap_script.new()
                 ap_instance.name = "Archipelago"
 
-                #apclient_instance.SCRIPT_doorControl = load("user://maps/Archipelago/doorControl.gd")
-                #apclient_instance.SCRIPT_effects = load("user://maps/Archipelago/effects.gd")
-                #apclient_instance.SCRIPT_location = load("user://maps/Archipelago/location.gd")
-                #apclient_instance.SCRIPT_mypainting = load("user://maps/Archipelago/mypainting.gd")
-                #apclient_instance.SCRIPT_panel = load("user://maps/Archipelago/panel.gd")
-                #apclient_instance.SCRIPT_textclient = load("user://maps/Archipelago/textclient.gd")
-
                 ap_instance.SCRIPT_client = load("user://maps/Archipelago/client.gd")
+                ap_instance.SCRIPT_keyboard = load("user://maps/Archipelago/keyboard.gd")
                 ap_instance.SCRIPT_locationListener = load("user://maps/Archipelago/locationListener.gd")
                 ap_instance.SCRIPT_uuid = load("user://maps/Archipelago/vendor/uuid.gd")
                 ap_instance.SCRIPT_victoryListener = load("user://maps/Archipelago/victoryListener.gd")
@@ -38,7 +32,13 @@ func _ready():
 
                 # Let's also inject any scripts we need to inject now.
                 installScriptExtension(ResourceLoader.load("user://maps/Archipelago/animationListener.gd"))
+                installScriptExtension(ResourceLoader.load("user://maps/Archipelago/collectable.gd"))
                 installScriptExtension(ResourceLoader.load("user://maps/Archipelago/door.gd"))
+                installScriptExtension(ResourceLoader.load("user://maps/Archipelago/keyHolder.gd"))
+                installScriptExtension(ResourceLoader.load("user://maps/Archipelago/keyHolderChecker.gd"))
+                installScriptExtension(
+                        ResourceLoader.load("user://maps/Archipelago/keyHolderResetterListener.gd")
+                )
                 installScriptExtension(ResourceLoader.load("user://maps/Archipelago/painting.gd"))
                 installScriptExtension(ResourceLoader.load("user://maps/Archipelago/pauseMenu.gd"))
                 installScriptExtension(ResourceLoader.load("user://maps/Archipelago/player.gd"))
@@ -141,17 +141,22 @@ func connectionSuccessful():
         global.universe = "lingo"
         global.map = "the_entry"
 
-        unlocks.resetKeys()
         unlocks.resetCollectables()
         unlocks.resetData()
-        unlocks.loadKeys()
+
+        ap.setup_keys()
+
         unlocks.loadCollectables()
         unlocks.loadData()
         unlocks.unlockKey("capslock", 1)
 
         clearResourceCache("res://objects/meshes/gridDoor.tscn")
+        clearResourceCache("res://objects/nodes/collectable.tscn")
         clearResourceCache("res://objects/nodes/door.tscn")
+        clearResourceCache("res://objects/nodes/keyHolder.tscn")
         clearResourceCache("res://objects/nodes/listeners/animationListener.tscn")
+        clearResourceCache("res://objects/nodes/listeners/keyHolderChecker.tscn")
+        clearResourceCache("res://objects/nodes/listeners/keyHolderResetterListener.tscn")
         clearResourceCache("res://objects/nodes/listeners/teleportListener.tscn")
         clearResourceCache("res://objects/nodes/listeners/worldportListener.tscn")
         clearResourceCache("res://objects/nodes/player.tscn")
@@ -50,7 +50,7 @@ func _ready():
 
 
 func _input(event):
-        if event is InputEventKey and event.pressed:
+        if global.loaded and event is InputEventKey and event.pressed:
                 if event.keycode == KEY_TAB and !Input.is_key_pressed(KEY_SHIFT):
                         if !get_tree().paused:
                                 is_open = true
@@ -0,0 +1,97 @@
+# Lingo 2 Archipelago Client
+
+The Lingo 2 Archipelago Client is a mod for Lingo 2 that allows you to connect
+to an Archipelago Multiworld and randomize your game.
+
+## Installation
+
+1. Download the Lingo 2 Archipelago Randomizer from
+   [the releases page](https://code.fourisland.com/lingo2-archipelago/about/client/CHANGELOG.md).
+2. Open up Lingo 2, go to settings, and click View Game Data. This should open
+   up a folder in Windows Explorer.
+3. Unzip the randomizer into the "maps" folder. Ensure that archipelago.tscn and
+   the Archipelago folder are both within the maps folder.
+
+**NOTE**: It is important that the major version number of your client matches
+the major version number of the apworld you generated with.
+
+## Joining a Multiworld game
+
+1. Launch Lingo 2.
+2. Click on Level Selection, and choose Archipelago from the list.
+3. The selected player is generally ignored by the mod, and you don't even need
+   to ensure you use the same player between connections. However, if your
+   player name has a gift map associated with it, Lingo 2 will prioritize the
+   gift map over loading the mod, so in that case you should choose another
+   player.
+4. Press Play.
+5. Enter the Archipelago address, slot name, and password into the fields.
+6. Press Connect.
+7. Enjoy!
+
+To continue an earlier game, you can perform the exact same steps as above. You
+will probably have to re-select Archipelago from the Level Selection screen, as
+the game does not remember which level you were playing.
+
+**Note**: Running the randomizer modifies the game's memory. If you want to play
+the base game after playing the randomizer, you need to restart Lingo 2 first.
+
+## Running from source
+
+The mod is mostly written in GDScript, which is parsed and executed by Lingo 2
+itself, and thus does not need to be compiled. However, there are two files that
+need to be generated before the client can be run.
+
+The first file is `data.binpb`, the datafile containing the randomizer logic.
+You can read about how to generate it on
+[its own README page](https://code.fourisland.com/lingo2-archipelago/about/data/README.md).
+Once you have it, put it in a subfolder of `client` called `generated`.
+
+The second generated file is `proto.gd`. This file allows Lingo 2 to read the
+datafile. We use a Godot script to generate it, which means
+[the Godot Editor](https://godotengine.org/download/) is required. From the root
+of the repository:
+
+```shell
+cd vendor\godobuf
+godot --headless -s addons\protobuf\protobuf_cmdln.gd --input=..\..\proto\data.proto ^
+  --output=..\..\client\Archipelago\generated\proto.gd
+```
+
+If you are not on Windows, replace the forward slashes with backslashes as
+appropriate (and the caret with a forward slash). You will also probably need to
+replace "godot" at the start of the second line with a path to a Godot Editor
+executable.
+
+After generating those two files, the contents of the `client` folder (minus
+this README) can be pasted into the Lingo 2 maps directory as described above.
+
+## Frequently Asked Questions
+
+### Is my progress saved locally?
+
+Lingo 2 autosaves your progress every time you solve a puzzle, get a
+collectable, or interact with a keyholder. The randomizer generates a savefile
+name based on your Multiworld seed and slot number, so you should be able to
+seamlessly switch between multiworlds and even slots within a multiworld.
+
+The exception to this is different rooms created from the same multiworld seed.
+The client is unable to tell rooms in a seed apart (this is a limitation of the
+Archipelago API), so the client will use the same save file for the same slot in
+different rooms on the same seed. You can work around this by manually moving or
+removing the save file from the level1 save file directory.
+
+If you play the base game again, you will see one or more save files with a long
+name that begins with "zzAP\_". These are the saves for your multiworlds. They
+can be safely deleted after you have completed the associated multiworld. It is
+not recommended to load these save files outside of the randomizer.
+
+A connection to Archipelago is required to resume playing a multiworld. This is
+because the set of items you have received is not stored locally.
+
+### What about wall snipes?
+
+"Wall sniping" refers to the fact that you are able to solve puzzles on the
+other side of opaque walls. The player is never expected to or required to do
+this in normal gameplay. This randomizer does not change how wall snipes work,
+but it will likewise never require the use of them.