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: Make URLs explicit in FAQ and Archipelago category tutorials.

Browse Source 
Remove unnecessary newlines and other tweaks.
This commit is contained in:
Hussein Farran
2021-11-30 19:34:39 -05:00
parent 56ef918a10
commit fc210c2d18
6 changed files with 58 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,12 +1,22 @@
# Archipelago Triggers Guide
This guide details the use of the Archipelago YAML trigger system. This guide is intended for a more advanced user with more in-depth knowledge of Archipelago YAML options as well as experience editing YAML files. This guide should take about 5 minutes to read.
## What are triggers?
Triggers allow you to customize your game settings by allowing you to define certain options or even a variety of settings to occur or "trigger" under certain 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](https://github.com/alwaysintreble/Archipelago-yaml-dump/blob/main/Snippets/Mercenary%20Mode%20Snippet.yaml) that was created using entirely triggers and plando. For more information on plando you can reference [this guide](/tutorial/archipelago/plando/en) or [this guide](/tutorial/zelda3/plando/en).
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)
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)
Link to the Past plando guide: [click here](/tutorial/zelda3/plando/en)
## Trigger use
Triggers have to be defined in the root of the yaml file meaning it must be outside of a game section.
Triggers have to be defined in the root of the yaml file meaning it must be outside a game section.
The best place to do this is the bottom of the yaml.
- Triggers comprise of the trigger section and then each trigger must have an `option_category`, `option_name`, and `option_result` from which it will react to and then an `options` section where the definition of what will happen.
- Triggers comprise the trigger section and then each trigger must have an `option_category`, `option_name`, and `option_result` from which it will react to and then an `options` section where the definition of what will happen.
- `option_category` is the defining section from which the option is defined in.
- Example: `A Link to the Past`
- This is the root category the option is located in. If the option you're triggering off of is in root then you
@@ -57,4 +67,4 @@ For example:
Timespinner:
Inverted: true
```
In this example if your world happens to roll SpecificKeycards then your game will also start in inverted.
In this example if your world happens to roll `SpecificKeycards` then your game will also start in inverted.