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

Docs: Update trigger guide and advanced yaml guide (#3385) 

* I guess these don't exist anymore

* Update worlds/generic/docs/advanced_settings_en.md

Co-authored-by: Scipio Wright <scipiowright@gmail.com>

---------

Co-authored-by: Scipio Wright <scipiowright@gmail.com>
This commit is contained in:
Exempt-Medic 2024-05-23 20:36:45 -04:00 committed by GitHub
parent 8b992cbf00
commit 2a47f03e72
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 7 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
worlds/generic/docs/advanced_settings_en.md
View File

@ -79,7 +79,7 @@ are `description`, `name`, `game`, `requires`, and the name of the games you wan
different weights. different weights.
* `requires` details different requirements from the generator for the YAML to work as you expect it to. Generally this * `requires` details different requirements from the generator for the YAML to work as you expect it to. Generally this
is good for detailing the version of Archipelago this YAML was prepared for as, if it is rolled on an older version, is good for detailing the version of Archipelago this YAML was prepared for. If it is rolled on an older version,
options may be missing and as such it will not work as expected. If any plando is used in the file then requiring it options may be missing and as such it will not work as expected. If any plando is used in the file then requiring it
here to ensure it will be used is good practice. here to ensure it will be used is good practice.
@ -137,7 +137,7 @@ guide: [Archipelago Plando Guide](/tutorial/Archipelago/plando/en)
locations. locations.
* `item_links` allows players to link their items into a group with the same item link name and game. The items declared * `item_links` allows players to link their items into a group with the same item link name and game. The items declared
in `item_pool` get combined and when an item is found for the group, all players in the group receive it. Item links in `item_pool` get combined and when an item is found for the group, all players in the group receive it. Item links
can also have local and non local items, forcing the items to either be placed within the worlds of the group or in can also have local and non-local items, forcing the items to either be placed within the worlds of the group or in
worlds outside the group. If players have a varying amount of a specific item in the link, the lowest amount from the worlds outside the group. If players have a varying amount of a specific item in the link, the lowest amount from the
players will be the amount put into the group. players will be the amount put into the group.
@ -277,7 +277,7 @@ one file, removing the need to manage separate files if one chooses to do so.
As a precautionary measure, before submitting a multi-game yaml like this one in a synchronous/sync multiworld, please As a precautionary measure, before submitting a multi-game yaml like this one in a synchronous/sync multiworld, please
confirm that the other players in the multi are OK with what you are submitting, and please be fairly reasonable about confirm that the other players in the multi are OK with what you are submitting, and please be fairly reasonable about
the submission. (ie. Multiple long games (SMZ3, OoT, HK, etc.) for a game intended to be <2 hrs is not likely considered the submission. (i.e. Multiple long games (SMZ3, OoT, HK, etc.) for a game intended to be <2 hrs is not likely considered
reasonable, but submitting a ChecksFinder alongside another game OR submitting multiple Slay the Spire runs is likely reasonable, but submitting a ChecksFinder alongside another game OR submitting multiple Slay the Spire runs is likely
OK) OK)
@ -295,7 +295,7 @@ requires:
version: 0.3.2 version: 0.3.2
Super Mario 64: Super Mario 64:
progression_balancing: 50 progression_balancing: 50
accessibilty: items accessibility: items
EnableCoinStars: false EnableCoinStars: false
StrictCapRequirements: true StrictCapRequirements: true
StrictCannonRequirements: true StrictCannonRequirements: true
@ -315,7 +315,7 @@ name: Minecraft
game: Minecraft game: Minecraft
Minecraft: Minecraft:
progression_balancing: 50 progression_balancing: 50
accessibilty: items accessibility: items
advancement_goal: 40 advancement_goal: 40
combat_difficulty: hard combat_difficulty: hard
include_hard_advancements: false include_hard_advancements: false
@ -341,7 +341,7 @@ game: ChecksFinder
ChecksFinder: ChecksFinder:
progression_balancing: 50 progression_balancing: 50
accessibilty: items accessibility: items
``` ```
The above example will generate 3 worlds - one Super Mario 64, one Minecraft, and one ChecksFinder. The above example will generate 3 worlds - one Super Mario 64, one Minecraft, and one ChecksFinder.

5
worlds/generic/docs/triggers_en.md
View File

@ -129,7 +129,7 @@ List, set, and dict options can additionally have values added to or removed fro
option value by prefixing the option name in the trigger block with `+` (add) or `-` (remove). The exact behavior for option value by prefixing the option name in the trigger block with `+` (add) or `-` (remove). The exact behavior for
each will depend on the option type. each will depend on the option type.
- For sets, `+` will add the value(s) to the set and `-` will remove any value(s) of the set. Sets do not allow - For sets, `+` will add the value(s) to the set and `-` will remove the value(s) from the set. Sets do not allow
duplicates. duplicates.
- For lists, `+` will add new values(s) to the list and `-` will remove the first matching values(s) it comes across. - For lists, `+` will add new values(s) to the list and `-` will remove the first matching values(s) it comes across.
Lists allow duplicate values. Lists allow duplicate values.
@ -160,6 +160,3 @@ Super Metroid:
In this example, if the `start_location` option rolls `landing_site`, only a starting hint for Morph Ball will be In this example, if the `start_location` option rolls `landing_site`, only a starting hint for Morph Ball will be
created. If `aqueduct` is rolled, a starting hint for Gravity Suit will also be created alongside the hint for Morph created. If `aqueduct` is rolled, a starting hint for Gravity Suit will also be created alongside the hint for Morph
Ball. Ball.
Note that for lists, items can only be added, not removed or replaced. For dicts, defining a value for a present key
will replace that value within the dict.