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

Docs: Update advanced yaml guide wording for priority locations (#3298) 

* Update advanced yaml guide wording

* Update options api as well

* Update exclude locations description slightly to use more current verbiage

* Update priority locations in options api.md to note what happens if it runs out

* Remove auto-added bullet points

* Slightly mess with wording to make it more succinct
This commit is contained in:
Scipio Wright 2024-05-14 14:28:15 -04:00 committed by GitHub
parent 9a82edc931
commit b78781ab3e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/options api.md
View File

@ -155,10 +155,12 @@ Gives the player starting hints for where the items defined here are.
Gives the player starting hints for the items on locations defined here.
### ExcludeLocations
Marks locations given here as `LocationProgressType.Excluded` so that progression items can't be placed on them.
Marks locations given here as `LocationProgressType.Excluded` so that neither progression nor useful items can be
placed on them.
### PriorityLocations
Marks locations given here as `LocationProgressType.Priority` forcing progression items on them.
Marks locations given here as `LocationProgressType.Priority` forcing progression items on them if any are available in
the pool.
### ItemLinks
Allows users to share their item pool with other players. Currently item links are per game. A link of one game between

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

@ -132,9 +132,10 @@ guide: [Archipelago Plando Guide](/tutorial/Archipelago/plando/en)
the location without using any hint points.
* `start_location_hints` is the same as `start_hints` but for locations, allowing you to hint for the item contained
there without using any hint points.
* `exclude_locations` lets you define any locations that you don't want to do and during generation will force a "junk"
item which isn't necessary for progression to go in these locations.
* `priority_locations` is the inverse of `exclude_locations`, forcing a progression item in the defined locations.
* `exclude_locations` lets you define any locations that you don't want to do and forces a filler or trap item which
isn't necessary for progression into these locations.
* `priority_locations` lets you define any locations that you want to do and forces a progression item into these
locations.
* `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
can also have local and non local items, forcing the items to either be placed within the worlds of the group or in