forked from mirror/Archipelago
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
53 lines
3.0 KiB
Markdown
53 lines
3.0 KiB
Markdown
# Kirby 64 - The Crystal Shards Setup Guide
|
|
|
|
## Required Software
|
|
|
|
- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases)
|
|
- An English Kirby 64 - The Crystal Shards ROM.
|
|
- [BizHawk](https://tasvideos.org/BizHawk/ReleaseHistory) 2.7 or later (2.10 is recommended)
|
|
|
|
### Configuring Bizhawk
|
|
|
|
Once you have installed BizHawk, open `EmuHawk.exe` and change the following settings:
|
|
|
|
- If you're using BizHawk 2.8 or earlier, go to `Config > Customize`. On the Advanced tab, switch the Lua Core from
|
|
`NLua+KopiLua` to `Lua+LuaInterface`, then restart EmuHawk. (If you're using BizHawk 2.9+, you can skip this step.)
|
|
- Under `Config > Customize`, check the "Run in background" option to prevent disconnecting from the client while you're
|
|
tabbed out of EmuHawk.
|
|
- Open a `.z64` file in EmuHawk and go to `Config > Controllers…` to configure your inputs. If you can't click
|
|
`Controllers…`, load any `.z64` ROM first.
|
|
- Consider clearing keybinds in `Config > Hotkeys…` if you don't intend to use them. Select the keybind and press Esc to
|
|
clear it.
|
|
|
|
## Generating and Patching a Game
|
|
|
|
1. Create your options file (YAML). You can make one on the
|
|
[Kirby 64 - The Crystal Shards options page](../../../games/Kirby%2064%20-%20The%20Crystal%20Shards/player-options).
|
|
2. Follow the general Archipelago instructions for [generating a game](../../Archipelago/setup/en#generating-a-game).
|
|
This will generate an output file for you. Your patch file will have the `.apk64cs` file extension.
|
|
3. Open `ArchipelagoLauncher.exe`
|
|
4. Select "Open Patch" on the left side and select your patch file.
|
|
5. If this is your first time patching, you will be prompted to locate your vanilla ROM..
|
|
6. A patched `.z64` file will be created in the same place as the patch file.
|
|
7. On your first time opening a patch with BizHawk Client, you will also be asked to locate `EmuHawk.exe` in your
|
|
BizHawk install.
|
|
|
|
## Connecting to a Server
|
|
|
|
By default, opening a patch file will do steps 1-5 below for you automatically. Even so, keep them in your memory just
|
|
in case you have to close and reopen a window mid-game for some reason.
|
|
|
|
1. Kirby 64 - The Crystal Shards uses Archipelago's BizHawk Client. If the client isn't still open from when you patched your game,
|
|
you can re-open it from the launcher.
|
|
2. Ensure EmuHawk is running the patched ROM.
|
|
3. In EmuHawk, go to `Tools > Lua Console`. This window must stay open while playing.
|
|
4. In the Lua Console window, go to `Script > Open Script…`.
|
|
5. Navigate to your Archipelago install folder and open `data/lua/connector_bizhawk_generic.lua`.
|
|
6. The emulator and client will eventually connect to each other. The BizHawk Client window should indicate that it
|
|
connected and recognized Kirby 64 - The Crystal Shards.
|
|
7. To connect the client to the server, enter your room's address and port (e.g. `archipelago.gg:38281`) into the
|
|
top text field of the client and click Connect.
|
|
|
|
You should now be able to receive and send items. You'll need to do these steps every time you want to reconnect. It is
|
|
perfectly safe to make progress offline; everything will re-sync when you reconnect.
|