morgan/Grinch-AP
1
0
Fork 0
mirror of https://github.com/MarioSpore/Grinch-AP.git synced 2025-10-21 20:21:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

WebHost: Fix hyperlink accessibility in general AP guides.

Browse Source
This commit is contained in:
Hussein Farran
2021-12-02 21:00:06 -05:00
parent 0968730382
commit a8694cfb79
5 changed files with 37 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
WebHostLib/static/assets/tutorial/archipelago/setup_en.md
View File

@@ -2,7 +2,7 @@
This guide is intended to provide an overview of how to install, set up, and run the Archipelago multiworld software. This guide should take about 5 minutes to read.
## Installing the Archipelago software
The most recent public release of Archipelago can be found on the GitHub Releases page. GitHub Releases page: [https://github.com/ArchipelagoMW/Archipelago/releases](https://github.com/ArchipelagoMW/Archipelago/releases).
The most recent public release of Archipelago can be found on the GitHub Releases page. GitHub Releases page: [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases).
Run the exe file, and after accepting the license agreement you will be prompted on which components you would like to install.
@@ -18,10 +18,10 @@ game/games you plan to play are available here go ahead and install these as wel
### What is a YAML?
YAML is the file format which Archipelago uses in order to configure a player's world. It allows you to dictate which game you will be playing as well as the settings you would like for that game.
YAML is a format very similar to JSON however it is made to be more human-readable. If you are ever unsure of the validity of your YAML file you may check the file by uploading it to the check page on the Archipelago website. Check page: [https://archipelago.gg/mysterycheck](https://archipelago.gg/mysterycheck)
YAML is a format very similar to JSON however it is made to be more human-readable. If you are ever unsure of the validity of your YAML file you may check the file by uploading it to the check page on the Archipelago website. Check page: [YAML Validation Page](/mysterycheck)
### Creating a YAML
YAML files may be generated on the Archipelago website by visiting the games page and clicking the "Settings Page" link under any game. Clicking "Export Settings" in a game's settings page will download the YAML to your system. Games page: [https://archipelago.gg/games](https://archipelago.gg/games)
YAML files may be generated on the Archipelago website by visiting the games page and clicking the "Settings Page" link under any game. Clicking "Export Settings" in a game's settings page will download the YAML to your system. Games page: [Archipelago Games List](/games)
In a multiworld there must be one YAML per world. Any number of players can play on each world using either the game's native coop system or using Archipelago's coop support. Each world will hold one slot in the multiworld and will have a slot name and, if the relevant game requires it, files to associate it with that multiworld.
@@ -30,7 +30,7 @@ If multiple people plan to play in one world cooperatively then they will only n
### Gather All Player YAMLs
All players that wish to play in the generated multiworld must have a YAML file which contains the settings that they wish to play with.
Typically, a single participant of the multiworld will gather the YAML files from all other players. After getting the YAML files of each participant for your multiworld game they can be compressed into a ZIP folder to then be uploaded to the multiworld generator page. Multiworld generator page: [https://archipelago.gg/generate](https://archipelago.gg/generate)
Typically, a single participant of the multiworld will gather the YAML files from all other players. After getting the YAML files of each participant for your multiworld game they can be compressed into a ZIP folder to then be uploaded to the multiworld generator page. Multiworld generator page: [Archipelago Seed Generator Page](https://archipelago.gg/generate)
#### Rolling a YAML Locally
@@ -44,6 +44,6 @@ Sometimes there are various settings that you may want to change before rolling
All of these settings plus other options are able to be changed by modifying the `host.yaml` file in the Archipelago installation folder. The settings chosen here are baked into the `.archipelago` file that gets output with the other files after generation so if rolling locally ensure this file is edited to your liking *before* rolling the seed.
## Hosting an Archipelago Server
The output of rolling a YAML will be a `.archipelago` file which can be subsequently uploaded to the Archipelago host game page. Archipelago host game page: [https://archipelago.gg/uploads](https://archipelago.gg/uploads)
The output of rolling a YAML will be a `.archipelago` file which can be subsequently uploaded to the Archipelago host game page. Archipelago host game page: [Archipelago Seed Upload Page](https://archipelago.gg/uploads)
The `.archipelago` file may be run locally in order to host the multiworld on the local machine. This is done by running `ArchipelagoServer.exe` and pointing the resulting file selection prompt to the `.archipelago` file that was generated.