- Kirby Air Ride APWorld
- What is this?
- Where do I get the apworld and yaml file?
- How do I set this up?
- What is the goal of Kirby Air Ride in Archipelago?
- What does randomization do to this game? Which locations get shuffled?
- What does another world's item look like in Kirby Air Ride?
- What happens when the player receives an item?
- I need help! What do I do?
- Known issues
- Planned Features
- Contributing
This is an APWorld for the Archipelago multi-world, multi-game randomizer: archipelago.gg
You can get the apworld file and an example player configuration yaml in the releases page.
Follow the setup guide.
Besides having fun being a part of a multiworld with friends, there are also a few pre-selected archipelago goals for the game that will result in a "game complete":
- Fill in over 100 Checklist Boxes!
- in the base game, this allows you to unlock viewing the game's ending
- Fill in N Checklist Boxes!
- fill in as many checklist boxes as you want, you can configure the number from 1-120.
- In one match, complete both Dragoon and Hydra!
- this is the standard checkbox from the base game
- Stadium: VS. KING DEDEDE KO King Dedede in less than a minute!
- You can also specify the name of any checklist box to set that as your specific goal for City Trial.
- None
- this disables City Trial from being a part of your world. No locations for City Trial will exist to be checked.
- Fill in over 100 Checklist Boxes!
- in the base game, this allows you to unlock viewing the game's ending
- Fill in N Checklist Boxes!
- fill in as many checklist boxes as you want, you can configure the number from 1-120.
- You can also specify the name of any checklist box to set that as your specific goal for Air Ride.
- None
- this disables Air Ride from being a part of your world. No locations for Air Ride will exist to be checked.
- Fill in over 100 Checklist Boxes!
- in the base game, this allows you to unlock viewing the game's ending
- Fill in N Checklist Boxes!
- fill in as many checklist boxes as you want, you can configure the number from 1-120.
- You can also specify the name of any checklist box to set that as your specific goal for Top Ride.
- None
- this disables Top Ride from being a part of your world. No locations for Top Ride will exist to be checked.
You can mix and match goals between all game modes. If there is a goal for multiple game modes, you can only complete your game by completing all goals.
Randomization affects which AP items you receive or send for unlocking a checkbox. It will also affect which stadiums you have available if you have progressive stadiums enabled.
No locations are currently shuffled, so every checkbox in the game unlocks what it usually unlocks (with the exception of stadiums, which are ignored in favor of the AP item unlocks if they are enabled).
There is no change in the graphical appearance of other's items. Completing checkboxes will earn whatever item is attached to that checkbox.
Current items players are able to receive are:
- Patches (Top Speed Up, Boost Up, etc.)
- Trap Patches ("Top Speed Down, Boost Down, etc.)
- Permanent +1 Patch Increases
- "Effect" items
- 1 HP Trap
- Full Heal
- Checkbox filler items for each checklist
- Patch Cap Increase items
- Stadium unlock items
Receiving a checkbox filler item for a given checklist will apply it immediately. Look to the side of the checklist for the purple boxes. The game limits the number of these you can see at once to 5, but rest assured if you unlocked more than that, you have access to that amount and can keep using them as normal until they run out.
Receiving a patch cap increase item will increase the maximum cap on the number of patches you can have in City Trial. For instance, if you specified a starting cap of 5 in your yaml, this will increase it by one, to 6 for the rest of your entire AP run. This is for each patch type separately. So for instance, if you have a patch cap of 6 and collect 7 Top Speeds, you will lose one of those Top Speeds and be back to 6.
If you have progressive stadiums enabled, receiving a stadium unlock item will unlock that stadium in-game. You will always start with one random stadium unlock item in your starting inventory. If your goal is to beat King DeDeDe, you will not be able to start with that stadium unlocked.
Any items will be applied immediately if the player is in City Trial when they are received, or they are applied at the beginning of the next City Trial run if they are not. Permanent patch increases are applied at the start of every City Trial run (after a few seconds have elapsed).
NOTE: you must collect any patch in the city after receiving patch items for the stat increases/decreases to take effect.
NOTE: There are currently no items that apply to Air Ride or Top Ride mode (other than checkbox fillers), but you can earn items for City Trial by completing Air Ride or Top Ride checkboxes.
If you have EnergyLink enabled in your yaml or if you enabled it in the client with /energylink, gathering patches (if you are below the max stat limit for that patch) in the City will add to the collective energy pool of the multiworld, as well as destroying objects (rocks, trees, coral, star pole, houses, etc.). You can spend this gathered energy to receive any (archipelago) item immediately! Use /energylink_spend "Item Name" item_amount in the Kirby Air Ride Client.
Each patch collected gives 1 energy, and each object destroyed gives .1 energy. Items by default cost 10 energy, and other items have costs of:
- All patches: 90,
- Checkbox fillers: 1500
- Patch Cap Increases: 1500
- Permanent Patch Increases: 200
For example, to buy 5 Top Speed Up patches (assuming you have 50 energy to spend):
/energylink_spend "Top Speed Up" 5
Spending energy on Permanent Patch increases and Patch Cap increases will also be persistent for the rest of your game.
Try the troubleshooting steps in the setup guide. If you are still stuck, please ask in the "Kirby Air Ride" discussion thread in the "future-game-design" channel in the Archipelago Discord server! Link.
- DeathLink
- receiving Deathlink only works some of the time/on certain vehicles
- receiving Deathlink just takes health down to ~0 (likely due to floating point stuff) (have not confirmed this is still a bug)
- EnergyLink
- gives energy from patches received from /energylink_spend
- gives energy for permanent patches when transitioning into City Trial
- Items
- Players cannot receive items on the following stages due to stage ID conflicts:
- Stadium: DESTRUCTION DERBY 4
- Stadium: DESTRUCTION DERBY 5
- Stadium: SINGLE RACE 1
- FANTASY MEADOWS
- Top Ride currently does not support items until a memory address is found that reflects whether we're in game in top ride or not
- Restarting the client results in all permanent patches being received again if in City Trial
- Patch items for City Trial are not guaranteed to work depending on what vehicle you are on. They always work on compact star.
- because of this, Energylink stops adding energy after a certain point for picking up patches (even below the max patch limit)
- Players cannot receive items on the following stages due to stage ID conflicts:
Feel free to report any other issues or suggest improvements in the "Kirby Air Ride" discussion thread in the "future-game-design" channel in the Archipelago Discord server (Link) or in the issues here.
Much of the planned features are gated by progress on modding the game itself or finding proper memory addresses to read/write to. Contributions are very welcome! Eventually, we will see a hard cap on what we can do with Archipelago and will need to work on creating Gecko codes and modifying the iso to make new features work.
- permanent increase/decrease item spawn rates as useful/filler/trap items
- food items as filler/useful
- kirby abilities as useful/filler/trap items
- kirby effects (such as "run amok") as useful/filler/trap items
- city trial events as useful/filler/trap items
- spawning boxes as filler/useful items
- drop patches trap item
- physics-based trap items (altitude increase/decrease, teleport forward/backward/random location, gravity changes, etc.)
- generic trap or other items that work for any mode (e.g. "stun trap", which will apply sleep, freeze, etc. based on mode)
- randomization of checklist box rewards
- randomization of starting air ride machine
- progressive patch caps for each patch individually
- progressive item spawn rate increases
- progressive box color/type unlocks
- progressive kirby color unlocks
- progressive kirby ability unlocks
- progressive air ride machine unlocks
- progressive city trial event unlock items
- progressive hot dogs/food items
- other progressive rng-related items
- Top Ride items
- Air Ride items
- air ride speed increase item (permanent speed increases?)
- All players receiving items in all modes
- more fine-grained options for which traps or patches are enabled
- option to reveal (but not unlock) the whole checklist at game start by writing 10 to every checkbox?
- option to fully unlock every checkbox on game complete?
- does this make sense to have? how does this work with games that don't have collect on?
- option to sync the local checklist state with the server checked locations upon connection.
- for people who don't care about saves being edited/wiped and want the convenience of not having to juggle save files for each lobby
- this may have a conflict if players can get checks "offline"? But the client currently requires that they be connected? need to avoid this removing checks players do when not connected to the server?
- options presets that set goals for different "game modes" (killing enemies focused checkboxes, collecting items focused, etc.)
- enable lists of locations as goals. get every checkbox on the list to complete your game. Allows for making custom games, essentially
- energylink for air ride: laps completed, enemies killed
- energylink for top ride: laps completed, environment destroyed/interacted with
- ItemLink with other Kirby Air Ride worlds
- performance pass on location checking
- use checked_locations, missing_locaitons, server_locations as caches
- possible variable deathlink cooldown?
- colored logging for things like goals
Feel free to raise an issue or submit a PR!