monorail
/
Archipelago
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

WebHost: Fix hyperlink accessibility in general AP guides.

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
WebHostLib/static/assets/tutorial/archipelago/advanced_settings_en.md
View File

@ -3,7 +3,7 @@ This guide covers more the more advanced options available in YAML files. This g
If you would like to generate a basic, fully playable, YAML without editing a file then visit the settings page for the game you intend to play.
The settings page can be found on the supported games page, just click the "Settings Page" link under the name of the game you would like. Supported games page: [https://archipelago.gg/games](https://archipelago.gg/games)
The settings page can be found on the supported games page, just click the "Settings Page" link under the name of the game you would like. Supported games page: [Archipelago Games List](https://archipelago.gg/games)
Clicking on the "Export Settings" button at the bottom-left will provide you with a pre-filled YAML with your options. The player settings page also has an option to download a fully filled out yaml containing every option with every available setting for the available options.
@ -13,7 +13,7 @@ The Archipelago system generates games using player configuration files as input
## YAML Formatting
YAML files are a format of human-readable config files. The basic syntax of a yaml file will have a `root` node and then different levels of `nested` nodes that the generator reads in order to determine your settings.
To nest text, the correct syntax is to indent **two spaces over** from its root option. A YAML file can be edited with whatever text editor you choose to use though I personally recommend that you use Sublime Text. Sublime text website: [https://www.sublimetext.com](https://www.sublimetext.com)
To nest text, the correct syntax is to indent **two spaces over** from its root option. A YAML file can be edited with whatever text editor you choose to use though I personally recommend that you use Sublime Text. Sublime text website: [SublimeText Website](https://www.sublimetext.com)
This program out of the box supports the correct formatting for the YAML file, so you will be able to use the tab key and get proper highlighting for any potential errors made while editing the file. If using any other text editor you should ensure your indentation is done correctly with two spaces.
@ -55,7 +55,7 @@ in a dungeon in ALTTP making it impossible to get and finish the dungeon.
* `progression_balancing` is a system the Archipelago generator uses to try and reduce "BK mode" as much as possible. This primarily involves moving necessary progression items into earlier logic spheres to make the games more accessible so that players almost always have something to do. This can be turned `on` or `off` and is `on` by default.
* `triggers` is one of the more advanced options that allows you to create conditional adjustments. You can read more triggers in the triggers guide. Triggers guide: [https://archipelago.gg/tutorial/archipelago/triggers/en](https://archipelago.gg/tutorial/archipelago/triggers/en)
* `triggers` is one of the more advanced options that allows you to create conditional adjustments. You can read more triggers in the triggers guide. Triggers guide: [Archipelago Triggers Guide](https://archipelago.gg/tutorial/archipelago/triggers/en)
### Game Options
@ -67,7 +67,7 @@ Some options in Archipelago can be used by every game but must still be placed w
Currently, these options are `start_inventory`, `start_hints`, `local_items`, `non_local_items`, `start_location_hints`, `exclude_locations`, and various plando options.
See the plando guide for more info on plando options. Plando guide: [https://archipelago.gg/tutorial/archipelago/plando/en](https://archipelago.gg/tutorial/archipelago/plando/en)
See the plando guide for more info on plando options. Plando guide: [Archipelago Plando Guide](https://archipelago.gg/tutorial/archipelago/plando/en)
* `start_inventory` will give any items defined here to you at the beginning of your game. The format for this must be the name as it appears in the game files and the amount you would like to start with. For example `Rupees(5): 6` which will give you the item `Rupees(5)` six times, totalling 30 rupees.

45
WebHostLib/static/assets/tutorial/archipelago/plando_en.md
View File

@ -34,30 +34,31 @@ cross-game plando could very well be broken i.e. placing on of your items in som
* Using the multi placement method, placements are picked randomly.
### Available Items
* A Link to the Past: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Items.py#L52](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Items.py#L52)
* Factorio Non-Progressive: [https://wiki.factorio.com/Technologies](https://wiki.factorio.com/Technologies)
* A Link to the Past: [Link to the Past Item List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Items.py#L52)
* Factorio Non-Progressive: [Factorio Technologies Wiki List](https://wiki.factorio.com/Technologies)
* Note that these use the *internal names*. For example, `advanced-electronics`
* Factorio Progressive: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/factorio/Technologies.py#L374](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/factorio/Technologies.py#L374)
* Minecraft: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Items.py#L14](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Items.py#L14)
* Ocarina of Time: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/Items.py#L61](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/Items.py#L61)
* Risk of Rain 2: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Items.py#L8](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Items.py#L8)
* Slay the Spire: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/spire/Items.py#L13](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/spire/Items.py#L13)
* Subnautica: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/subnautica/items.json](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/subnautica/items.json)
* Timespinner: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Items.py#L11](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Items.py#L11)
* Factorio Progressive: [Factorio Progressive Technologies List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/factorio/Technologies.py#L374)
* Minecraft: [Minecraft Items List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Items.py#L14)
* Ocarina of Time: [Ocarina of Time Items List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/Items.py#L61)
* Risk of Rain 2: [Risk of Rain 2 Items List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Items.py#L8)
* Slay the Spire: [Slay the Spire Items List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/spire/Items.py#L13)
* Subnautica: [Subnautica Items List JSON File](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/subnautica/items.json)
* Timespinner: [Timespinner Items List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Items.py#L11)
### Available Locations
* A Link to the Past: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Regions.py#L429](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Regions.py#L429)
* Factorio: [https://wiki.factorio.com/Technologies](https://wiki.factorio.com/Technologies)
* Minecraft: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Locations.py#L18](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Locations.py#L18)
* Ocarina of Time: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/LocationList.py#L38](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/LocationList.py#L38)
* Risk of Rain 2: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Locations.py#L17](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Locations.py#L17)
* A Link to the Past: [Link to the Past Locations List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/Regions.py#L429)
* Factorio: [Factorio Technologies List Wiki](https://wiki.factorio.com/Technologies)
* In Factorio the location names are the same as the item names.
* Minecraft: [Minecraft Locations List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Locations.py#L18)
* Ocarina of Time: [Ocarina of Time Locations List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/oot/LocationList.py#L38)
* Risk of Rain 2: [Risk of Rain 2 Locations List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/ror2/Locations.py#L17)
* This is a special case. The locations are "ItemPickup[number]" up to the maximum set in the yaml.
* Slay the Spire: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/spire/Locations.py](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/spire/Locations.py)
* Subnautica: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/subnautica/locations.json](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/subnautica/locations.json)
* Timespinner: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Locations.py#L13](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Locations.py#L13)
* Slay the Spire: [Slay the Spire Locations List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/spire/Locations.py)
* Subnautica: [Subnautica Locations List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/subnautica/locations.json)
* Timespinner: [Timespinner Locations List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/timespinner/Locations.py#L13)
A list of all available items and locations can also be found in the server's datapackage. Data package JSON: [click here](/api/datapackage).
A list of all available items and locations can also be found in the server's datapackage. Data package JSON: [DataPackage JSON](/api/datapackage).
### Examples
```yaml
plando_items:
@ -117,10 +118,10 @@ plando_items:
4. This block has an 80% chance of occuring and when it does will place all but 1 of the items randomly among the four locations chosen here.
## Boss Plando
As this is currently only supported by A Link to the Past instead of explaining here please refer to the Z3 plando guide. Z3 plando guide: [click here](/tutorial/zelda3/plando/en)
As this is currently only supported by A Link to the Past instead of explaining here please refer to the Z3 plando guide. Z3 plando guide: [LttP Plando Guide](/tutorial/zelda3/plando/en)
## Text Plando
As this is currently only supported by A Link to the Past instead of explaining here please refer to the Z3 plando guide. Z3 plando guide: [click here](/tutorial/zelda3/plando/en)
As this is currently only supported by A Link to the Past instead of explaining here please refer to the Z3 plando guide. Z3 plando guide: [LttP Plando Guide](/tutorial/zelda3/plando/en)
## Connections Plando
This is currently only supported by Minecraft and A Link to the Past. As the way that these games interact with their connections is different I will only explain the basics here while more specifics for Link to the Past connection plando can be found in its plando guide.
@ -129,9 +130,9 @@ This is currently only supported by Minecraft and A Link to the Past. As the way
* Every connection has an `entrance` and an `exit`. These can be unlinked like in A Link to the Past insanity entrance shuffle.
* `direction` can be `both`, `entrance`, or `exit` and determines in which direction this connection will operate.
Link to the Past connections: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/EntranceShuffle.py#L3852](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/EntranceShuffle.py#L3852)
Link to the Past connections: [Link to the Past Connections List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/alttp/EntranceShuffle.py#L3852)
Minecraft connections: [https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Regions.py#L62](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Regions.py#L62)
Minecraft connections: [Minecraft Connections List in the Code](https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/minecraft/Regions.py#L62)
### Examples
```yaml

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.

6
WebHostLib/static/assets/tutorial/archipelago/triggers_en.md
View File

@ -5,13 +5,13 @@ This guide details the use of the Archipelago YAML trigger system. This guide is
Triggers allow you to customize your game settings by allowing you to define one or many options which only occur under specific conditions. These are essentially "if, then" statements for options in your game.
A good example of what you can do with triggers is the custom mercenary mode YAML that was created using entirely triggers and plando.
Mercenary mode YAML: [https://github.com/alwaysintreble/Archipelago-yaml-dump/blob/main/Snippets/Mercenary%20Mode%20Snippet.yaml](https://github.com/alwaysintreble/Archipelago-yaml-dump/blob/main/Snippets/Mercenary%20Mode%20Snippet.yaml)
Mercenary mode YAML: [Mercenary Mode YAML on GitHub](https://github.com/alwaysintreble/Archipelago-yaml-dump/blob/main/Snippets/Mercenary%20Mode%20Snippet.yaml)
For more information on plando you can reference the general plando guide or the Link to the Past plando guide.
General plando guide: [click here](/tutorial/archipelago/plando/en)
General plando guide: [Archipelago Plando Guide](/tutorial/archipelago/plando/en)
Link to the Past plando guide: [click here](/tutorial/zelda3/plando/en)
Link to the Past plando guide: [LttP Plando Guide](/tutorial/zelda3/plando/en)
## Trigger use
Triggers have to be defined in the root of the yaml file meaning it must be outside a game section.

4
WebHostLib/static/assets/tutorial/archipelago/using_website_en.md
View File

@ -3,7 +3,7 @@ This guide encompasses the use cases for rolling and hosting multiworld games on
## Rolling the Seed On the Website
1. After gathering the YAML files together in one location, select all the files and compress them into a `.ZIP` file.
2. Next go to the "Generate Game" page. Generate game page: [https://archipelago.gg/generate](https://archipelago.gg/generate). Here, you can adjust some server settings such as forfeit rules and the cost for a player to use a hint before generation.
2. Next go to the "Generate Game" page. Generate game page: [Archipelago Seed Generation Page](https://archipelago.gg/generate). Here, you can adjust some server settings such as forfeit rules and the cost for a player to use a hint before generation.
3. After adjusting the host settings to your liking click on the Upload File button and using the explorer window that opens,
navigate to the location where you zipped the player files and upload this zip. The page will generate your game and refresh
multiple times to check on completion status.
@ -18,7 +18,7 @@ The easiest and most recommended method is to generate the game on the website w
room with all the necessary files you can share, as well as hosting the game and supporting item trackers for various games.
If for some reason the seed was rolled on a machine, then either the resulting zip file or the resulting `AP_XXXXX.archipelago`
inside the zip file can be uploaded to the host game page. Host game page: [https://archipelago.gg/uploads](https://archipelago.gg/uploads)
inside the zip file can be uploaded to the host game page. Host game page: [Archipelago Seed Upload Page](https://archipelago.gg/uploads)
This will give a page with the seed info and a
link to the spoiler log, if it exists. Click on "Create New Room" and then share the link to the resulting page the other players