Setup Guide for Kirby Air Ride Archipelago
Welcome to Kirby Air Ride Archipelago! This guide will help you set up the game to play solo or in a multiworld.
Requirements
You'll need the following components to be able to play Kirby Air Ride:
- Install Dolphin Emulator. We recommend using the latest release.
- Linux users can use the flatpak package available on Flathub.
- A Kirby Air Ride ISO (GKYE01) (North American version, NTSC-U), probably named "Kirby Air Ride (USA).iso"
- CRC32: f1a3e7a2
- MD5: bd936616ba7f998d8d0a1eb3f553b634
- SHA-1: b57132b1d0990264c271a1ad2168aa75b93b2f92
- The Archipelago launcher (latest version always recommended)
- https://github.com/ArchipelagoMW/Archipelago/releases/latest
- The Kirby Air Ride APWorld
- https://github.com/DeDeDeK/KARchipelago/releases/latest
- download the
kirby_air_ride.apworldfile from the "Assets" section - place the
kirby_air_ride.apworldfile into yourcustom_worldsfolder in your Archipelago installation folder- use
Browse Filesfrom the AP launcher as an easy way to get to this folder
- use
- The Kirby Air Ride game mod
- https://github.com/DeDeDeK/karchipelago-mod/releases/latest
- download the
Riivolution.zipfile from the "Assets" section - unzip the
Riivolution.zip - find your Dolphin user folder (in Dolphin,
File->Open User Folder) - copy the
KARchipelago.xmlfile into your Dolphin install directory atUser/Load/Riivolution/riivolution/KARchipelago.xml - copy the
KARchipelago/folder into your Dolphin install directory atUser/Load/Riivolution/KARchipelago/
Your final Dolphin Riivolution folder should have this structure (note the second riivolution/ folder!):
Riivolution/
├── KARchipelago/
└── riivolution/
├── config/ (optional, automatically generated by Dolphin)
└── KARchipelago.xml
Setting Up a YAML
All players playing Kirby Air Ride must provide the room host with a YAML file containing the settings for their world.
Use the built-in options creator in the archipelago launcher. Select "Options Creator" in the AP launcher, and then select Kirby Air Ride.
Choose your options and then click "Export".
Alternatively, you can manually edit the Kirby Air Ride.yaml template YAML. Run "Generate Template Options" from the Archipelago Launcher, and then edit the Kirby Air Ride yaml file in your Players/ directory. The yaml file will contain descriptions of each option and what they affect in the game.
Once you're happy with your settings, provide the room host with your YAML file and proceed to the next step.
Save files
Every new multiworld you join should be done with a fresh Kirby Air Ride save file! This is very important, as if you have a completed save file and connect to a multiworld with it, you will complete your game immediately.
Unfortunately, Kirby Air Ride only has one save slot in-game. But no worries if you want to keep your save - Dolphin can export save files that can be re-loaded later.
IMPORTANT: There are TWO save files to delete or preserve! For both options below, if you've played before, you will have TWO.
To make sure you have a fresh save file:
- In Dolphin, go to
Tools -> Memory Card Manager- If you have Kirby Air Ride data in this menu, click on it and click
Export asif you wish to keep the save file for later, orDeleteif you wish to wipe the save.- If you chose to export, make sure to then delete the original files as well
- If you do not see save data in here but have played before, you likely have your saves as
.gciinstead of a memory card.- Go to
File->Open User Folderin dolphin, and browse to theGCfolder. Under one ofUSA, JAP, or EUR, you can find the.gcifiles to manually delete. There should be 2 files that containGKYE.
- Go to
- If you have Kirby Air Ride data in this menu, click on it and click
Universal Tracker (optional)
Universal Tracker adds a tracker tab that lists every checklist box you can reach right now, so you always know what is actually open to you.
- download
tracker.apworldfrom the newestTracker_v...tag on the Universal Tracker releases page (that page hosts several apworlds, so check the tag) and put it in the samecustom_worldsfolder askirby_air_ride.apworld, then restart the launcher. - open
Kirby Air Ride Clientas usual. The tracker tab appears automatically.
You do not need your YAML in the Players/ folder for UT for Kirby Air Ride.
See the Universal Tracker repo for further usage instructions.
Connecting to a Room
- Open Dolphin and use it to run the Kirby Air Ride ISO with the mod enabled
- in Dolphin, right click on Kirby Air Ride in your games list and
Start with Riivolution Patches... - set KARchipelago to
Enabled - press
Start
- in Dolphin, right click on Kirby Air Ride in your games list and
- Start the Archipelago Launcher and choose
Kirby Air Ride Client, which will open the text client. It will begin attempting to connect to Dolphin.- Once the modded game is running in Dolphin, the client will print
KARchipelago mod detected. - If it is not connecting successfully, use
/dolphinto get the current status.
- Once the modded game is running in Dolphin, the client will print
- Connect to the room by entering the server name and port number in the client and pressing
Connect. For rooms hosted on the website, this will bearchipelago.gg:<port>.- You will be prompted to enter your slot name, which is the name you selected when creating your yaml. Type that in and press enter.
- Shortcut for rooms hosted on the website, in place of steps 2 and 3: click your slot name on the room page. Your browser hands the link to the Archipelago Launcher, which asks which client to open. Choose
Kirby Air Ride Client, and it opens already connected as that slot. Enter the password, if needed.
- Once you're connected to the room and have started a new save file in-game, the client finishes its handshake and prints
Handshake complete. Ready to play!. You are now connected and ready to play!
Troubleshooting
- Use the
/dolphincommand in the client to check the connection status. It shows what the client is waiting for (Dolphin, the game, the mod, the save, or the Archipelago server), or why it can't connect (a different game or a wrong-region disc). - Ensure you are running the latest version of the apworld.
- Ensure you are running the latest version of the mod.
- Ensure
kirby_air_ride.apworldis in your Archipelago installation'scustom_worldsfolder.- make sure you have restarted the launcher if you moved the .apworld into the
custom_worldsfolder
- make sure you have restarted the launcher if you moved the .apworld into the
- Ensure you are running the same version of Archipelago on which the multiworld was generated.
- Ensure that you do not have any other riivolution mods enabled.
- Ensure that you do not have any Dolphin cheats or codes enabled. Some cheats or codes can unexpectedly interfere with emulation and make troubleshooting errors difficult. Some gecko or action replay codes may work, but they may also break the game state that archipelago depends on to function.
- Ensure that you only have one instance of Dolphin running.
- Ensure that
Enable Emulated Memory Size Overridein Dolphin (underOptions>Configuration>Advanced) is disabled. - Ensure that RetroAchievements is disabled in Dolphin (under
Tools>Achievements, uncheckEnable RetroAchievements.org Integration). Leaving it enabled will stop the mod from loading. - Ensure the
Fallback Regionin Dolphin (underOptions>Configuration>General) is set toNTSC-U. - If you run with a custom GC boot menu, you'll need to skip it by going to
Options>Configuration>GameCubeand checkingSkip Main Menu. - Full restart of client and dolphin.