Installation

This document teaches you how to install Keymaster's Keep (KMK) and its many game implementations.

It is assumed you have already installed the Archipelago Launcher. If not, follow the setup guides in the Archipelago section from this linked webpage.

Installing Keymaster's Keep

1. Download the .apworld of the latest Keymaster's Keep release from silasary's Archipelago fork on GitHub.
2. Either place the .apworld file into the Archipelago Launcher's worlds/ folder, or run the Archipelago Launcher and open Install APWorld, selecting the downloaded file.
- If you do the latter, you must then close the Archipelago Launcher.

Install APWorld menu item in Archipelago Launcher

3. Run the Archipelago Launcher. KMK is installed successfully if a keymasters_keep/ folder is automatically created.
4. In the Archipelago Launcher, open Generate Template Options. This will create the template player file Players/Templates/Keymaster's Keep.yaml, which contains the customisable settings for KMK.

Generate Template Options menu item in Archipelago Launcher

KMK comes with the Custom (META) and Game Backlog (META) implementations pre-installed, but isn't the same without additional game implementations tailored to you. Refer to the below section for more information.

Installing KMK Game Implementations

1. Browse this codex for a game you wish to add to your KMK.
2. Click the Download link at the top of the page. This will take you to the implementation creator's GitHub repository of implementations.
3. Click through the README at the bottom of the page, or navigate through the file tree directly, until you reach the contents of the .py file for the game you wish to add.
4. Click the download icon next to the Raw button and copy icon at the top-right of the page. Save the file into the keymasters_keep/ folder of your Archipelago Launcher installation.

GitHub file topbar of KMK implementation

5. Restart the Archipelago Launcher and open Generate Template Options. The Players/Templates/Keymaster's Keep.yaml template player file will now additionally contain the customisable options for all of the game implementations you have installed.

Creating KMK Player Files

Once you've added all of the implementations you wish to use, it's time to go deep into player file customisation. Refer to the Creating KMK Player Files guide for more information.

Guide written by Jack5