Files
dockipelago/worlds/pmd_eos/docs/setup_en.md
Jonathan Tinney 7971961166
Some checks failed
Analyze modified files / flake8 (push) Failing after 2m28s
Build / build-win (push) Has been cancelled
Build / build-ubuntu2204 (push) Has been cancelled
ctest / Test C++ ubuntu-latest (push) Has been cancelled
ctest / Test C++ windows-latest (push) Has been cancelled
Analyze modified files / mypy (push) Has been cancelled
Build and Publish Docker Images / Push Docker image to Docker Hub (push) Successful in 5m4s
Native Code Static Analysis / scan-build (push) Failing after 5m2s
type check / pyright (push) Successful in 1m7s
unittests / Test Python 3.11.2 ubuntu-latest (push) Failing after 16m23s
unittests / Test Python 3.12 ubuntu-latest (push) Failing after 28m19s
unittests / Test Python 3.13 ubuntu-latest (push) Failing after 14m49s
unittests / Test hosting with 3.13 on ubuntu-latest (push) Successful in 5m0s
unittests / Test Python 3.13 macos-latest (push) Has been cancelled
unittests / Test Python 3.11 windows-latest (push) Has been cancelled
unittests / Test Python 3.13 windows-latest (push) Has been cancelled
add schedule I, sonic 1/frontiers/heroes, spirit island
2026-04-02 23:46:36 -07:00

3.1 KiB

Setup Guide for Pokémon Mystery Dungeon: Explorers of Sky

Important

As we are using BizHawk, this guide is only applicable to Windows and Linux systems. The EoS APWorld is still in development, so expect bugs! If you find a bug that hasn't already been reported, please open an issue on the GitHub issues page!

Required Software

  • BizHawk: Bizhawk Releases from TASVideos
    • Version 2.10 is recommended.
    • Detailed installation instructions for BizHawk can be found at the above link.
    • Windows users must run the prerequisite installer first, which can also be found at the above link.
  • The built-in BizHawk Client, which can be installed here
  • A .nds file for the EU version of Pokémon Mystery Dungeon: Explorers of Sky

Configuring your YAML file

What is a YAML file and why do I need one?

Your YAML file contains a set of configuration options which provide the generator with information about how it should generate your game. Each player of a multiworld will provide their own YAML file. This setup allows each player to enjoy an experience customized for their taste, and different players in the same multiworld can all have different options.

Where do I get a YAML file?

Install the download .apworld file with the Archipelago Launcher. In the launcher, click "Generate Template Options" to generate a template YAML for EoS. You can make a copy of this template, and edit it to configure your settings.

Joining a MultiWorld Game

Obtain your NDS patch file

When you join a multiworld game, you will be asked to provide your YAML file to whoever is hosting. Once that is done, the host will provide you with either a link to download your data file, or with a zip file containing everyone's data files. Your data file should have a .apeos extension.

Double-click on your .apeos file to start your client and start the ROM patch process. Once the process is finished, the client and the emulator will be started automatically, if you associated the extension to the client as recommended. If the extension isn't associated', select the BizHawk Client or the Archipelago Launcher as the program to open the .apeos file with.

Connect client to emulator

Once both the client and the emulator are started, you must connect them, if this is not done automatically. Within the emulator click on the "Tools" menu and select "Lua Console". Click the folder button or press Ctrl+O to open a Lua script.

Navigate to your Archipelago install folder and open data/lua/connector_bizhawk_generic.lua.

Connect to the Multiserver

To connect the client to the multiserver simply put <address>:<port> on the textfield on top and press enter (if the server uses password, type in the bottom textfield /connect <address>:<port> [password])

Saving the game

For unknown reasons, BizHawk seems to have issues with saving the game properly. To ensure that your save file is updated properly, make sure to navigate to File > Save RAM > Flush Save Ram (bound to Ctrl+S by default) after saving in-game.