Add Hollow Knight setup guide, game info, and to README

This commit is contained in:
Hussein Farran 2022-04-03 16:30:44 -04:00
parent 8c2c6877b6
commit 356384ab05
4 changed files with 73 additions and 0 deletions

View File

@ -21,6 +21,8 @@ Currently, the following games are supported:
* Meritous
* Super Metroid/Link to the Past combo randomizer (SMZ3)
* ChecksFinder
* ArchipIDLE
* Hollow Knight
For setup and instructions check out our [tutorials page](https://archipelago.gg/tutorial/).
Downloads can be found at [Releases](https://github.com/ArchipelagoMW/Archipelago/releases), including compiled

View File

@ -0,0 +1,22 @@
# Hollow Knight
## Where is the settings page?
The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
config file.
## What does randomization do to this game?
Randomization swaps around the locations of items. The items being swapped around are chosen within your YAML.
Shop costs are presently always randomized.
## What Hollow Knight items can appear in other players' worlds?
This is dependent entirely upon your YAML settings. Some examples include: charms, grubs, lifeblood cocoons, geo, etc.
## What does another world's item look like in Hollow Knight?
When the Hollow Knight player picks up an item from a location and it is an item for another game it will appear in that
player's recent items display as an item being sent to another player. If the item is for another Hollow Knight player
then the sprite will be that of the item's original sprite. If the item belongs to a player that is not playing Hollow
Knight then the sprite will be the Archipelago logo.

View File

@ -0,0 +1,30 @@
# Hollow Knight for Archipelago Setup Guide
## Required Software
* Download and unzip the Scarab Mod Manager from the [Scarab GitHub Releases page](https://github.com/fifty-six/Scarab/releases).
* A legal copy of Hollow Knight, not purchased or played through XBox Game Pass.
* Unfortunately, the Game Pass version is not currently compatible with mods.
## Installing the Archipelago Mod using Scarab
1. Launch Scarab and ensure it locates your Hollow Knight installation directory.
2. Click the "Install" checkbox near the "Archipelago" mod entry.
3. Launch the game, you're all set!
## Configuring your YAML File
### What is a YAML and why do I need one?
You can see the [basic multiworld setup guide](/tutorial/Archipelago/setup/en) here on the Archipelago website to learn
about why Archipelago uses YAML files and what they're for.
### Where do I get a YAML?
You can use the [game settings page for Hollow Knight](/games/Hollow%20Knight/player-settings) here on the Archipelago
website to generate a YAML using a graphical interface.
### Joining an Archipelago Game in Hollow Knight
1. Start the game after installing all necessary mods.
2. Create a **new save game.**
3. Select the **Archipelago** game mode from the mode selection screen.
4. Enter the correct settings for your Archipelago server.
5. Hit **Start** to begin the game. The game will stall for a few seconds while it does all item placements.
6. The game will immediately drop you into the randomized game.
* If you are waiting for a countdown then wait for it to lapse before hitting Start.
* Or hit Start then pause the game once you're in it.

View File

@ -555,5 +555,24 @@
]
}
]
},
{
"gameTitle": "Hollow Knight",
"tutorials": [
{
"name": "Mod Setup and Use Guide",
"description": "A guide to playing Hollow Knight with Archipelago.",
"files": [
{
"language": "English",
"filename": "Hollow Knight/setup_en.md",
"link": "Hollow Knight/setup/en",
"authors": [
"ijwu"
]
}
]
}
]
}
]