Getting Started
Instructions
Follow these steps to create a game, submit YAML files, and launch your Archipelago session.
1) Initial setup
- Have the bot added to your Discord.
- Install the client to your machine from Archipelago releases.
- Generate an Options file for the game you want to play (YAML file). This can be generated from the client or from this website. The website has more games supported than the client.
2) Discord commands
- Tell the bot to monitor a specific channel with
!setapchannel. - Run
!newapto start a new game. You can attach the first file directly to this command or send it in the thread the bot creates. - The first file chooses the room type: use a YAML to let the site generate the game, or upload one pregenerated ZIP or
.archipelagofile to host it as-is. - For a YAML room, each player adds their YAML and then the host runs
!startgame. Pregenerated games are queued automatically and do not need that command.
3) What happens next
The bot will DM you with the room/tracker and patch if your game needs one (check your game's page to know how to set it up).
4) Launching your game
Generally, you can open the patch file and it will auto-launch the game and tracker. Your specific game instructions page may differ.
The first time you open a game, it will ask for your emulator directory and the ROM you want to use.
4a) Custom game associations
A few custom games do not have custom Archipelago association files available yet (Metroid Fusion, Pokemon Crystal), so you'll need to find the repos for those. Supported soon.