Archipelago Dev Setup Guide

Archipelago is a way to randomize several games together into one cohesive experience. The items from all games are placed into a pool and distributed out to all games in that session. This means you might find someone else's Grenade Eggs in a cage in DK64, and someone else might find the Bean in the Water Temple for your seed.

Requirements list

• One of the following supported emulators:
  • Project64 4.0
  • Project64 3.0
  • Rosalie's Mupen GUI
  • Parallel Launch
  • Retroarch
  • Bizhawk (DK64 Specific Version)
• Archipelago 0.6.3+

Note: Retroarch and Rosalie's Mupen GUI are also supported on Linux.

• AP World Files
  • Dev Release Track

Supported Trackers

Poptracker

Developers:  UmedMuzl | Download:  Link

Universal Tracker

Developers:  GreenBean | Download:  Link

Tutorials

Settings Tutorial by Keiper

Setup Guide

Installation Procedures

1. Download and install the Archipelago Multiworld Suite from the link above, making sure to install the most recent version.

2. Download and install one of the supported emulators from the requirements list above. Run the emulator at least once to make sure it is working.

3. Download the APWorld file. You can select one of two tracks:

   1. The master release track remains stable, but does not update actively during dev cycles. This is currently based on 4.0 of the standalone randomizer.
   2. The dev release track, which gets active updates, but may have stability issues sometimes. This is currently based on 5.0 of the standalone randomizer.

4. Using the AP launcher, hit "Install AP World" and point it to the dk64.apworld file you downloaded.

IMPORTANT: If you are running DK64 AP version <1.2.0, Project64 4.0 is needed to run the Archipelago

Create a Config (.yaml) File

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

Your config 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 config 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 config file?

Run the ArchipelagoLauncher.exe from your Archipelago install and click Generate Template Options This will produce a /Players/Templates folder in your Archipelago install, which contains default config files for every game in your custom_worlds folder. You can manually edit the config file using a text editor of your choice.

Generating a Seed and Setting up the Client

1. After modifying your yaml, place it into your Archipelago/Players folder
2. Open the Archipelago Launcher and click "Generate". This will create a zip file in Archipelago output
   • You will need to open this .zip to get your .lanky patch file
3. Navigate to the Archipelago website and go to the Host Game page
4. Click upload file and pass it the .zip created in your output folder
5. Click the "Create New Room" link.
6. Navigate to the correct site based on your apworld version. If you do not select the correct site, you WILL get errors, either during patching or in the game.
   1. Master release track: Go to the REGULAR DK64 Randomizer site.
   2. Dev release track: Go to the DEV DK64 Randomizer site.
7. Click on 'Generate from Patch File'. Load in your DK64 ROM and select your '.lanky' file. You can also select your cosmetics before clicking Generate Seed. Once you are ready, click on Generate Seed.
8. Start your supported emulator and load the generated ROM.
9. Open the DK64 Randomizer client in the AP window
   • The client will automatically detect and connect to your running emulator
10. Once you have loaded into the game, click the Connect button at the top of the DK64 Client. You are now connected and ready to play!

Joining a MultiWorld Game

Make sure the version of the DK64 APWorld is the same for both you and the host. You will run into issues if they don't match, especially if one of you is using a master release and one of you is using a dev release!

Obtain your patch file and create your ROM

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

Put your patch file on your desktop or somewhere convenient. Open the DK64 Randomizer site as mentioned above, and Generate your seed.

Connect to the client

1. Start your supported emulator and load the generated ROM.
2. Launch the DK64 Randomizer client from the AP launcher - it will automatically detect and connect to your running emulator.
3. In the server page, there will be a port number. Copy this port number into the top of your DK64 Client.
   • The field should read archipelago.gg:<port number>
4. Click the Connect button at the top of the DK64Client. Once you have loaded into the game, the client should log that your emulator has been connected. You are now connected and ready to play!

You will know everything is working when you see Archipelago Connected on the save file.