Skip to content

Commit 11b32f1

Browse files
ReverMScipioWrightblack-sliver
authored
Docs: replacing "setting" to "option" in world docs (ArchipelagoMW#2622)
* Update contributing.md * Update contributing.md * Update contributing.md * Update contributing.md * Update contributing.md * Update contributing.md Added non-AP World specific information * Update contributing.md Fixed broken link * Some minor touchups * Update Contributing.md Draft for version with picture * Update contributing.md Small word change * Minor updates for conciseness, mostly * Changed all instances of settings to options in info and setup guides I combed through all world docs and swapped "setting" to "option" when this was refering to yaml options. I also changed a leftover "setting" in option.py * Update contributing.md * Update contributing.md * Update setup_en.md Woops I forgot one * Update Options.py Reverted changes regarding options.py * Update worlds/noita/docs/en_Noita.md Co-authored-by: Scipio Wright <scipiowright@gmail.com> * Update worlds/sc2wol/docs/en_Starcraft 2 Wings of Liberty.md revert change waiting for that page to be updated * Update worlds/witness/docs/setup_en.md * Update worlds/witness/docs/en_The Witness.md * Update worlds/soe/docs/multiworld_en.md Fixed Typo Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com> * Update worlds/witness/docs/en_The Witness.md * Update worlds/adventure/docs/en_Adventure.md * Update worlds/witness/docs/setup_en.md * Updated Stardew valley to hopefully get rid of the merge conflicts * Didn't work :dismay: * Delete worlds/sc2wol/docs/setup_en.md I think this will fix the merge issue * Now it should work * Woops --------- Co-authored-by: Scipio Wright <scipiowright@gmail.com> Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>
1 parent 218cd45 commit 11b32f1

File tree

92 files changed

+290
-255
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+290
-255
lines changed

‎worlds/adventure/docs/en_Adventure.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Adventure
22

3-
## Where is the settings page?
4-
The [player settings page for Adventure](../player-settings) contains all the options you need to configure and export a config file.
3+
## Where is the options page?
4+
The [player options page for Adventure](../player-options) contains all the options you need to configure and export a config file.
55

66
## What does randomization do to this game?
77
Adventure items may be distributed into additional locations not possible in the vanilla Adventure randomizer. All
8-
Adventure items are added to the multiworld item pool. Depending on the settings, dragon locations may be randomized,
8+
Adventure items are added to the multiworld item pool. Depending on the `dragon_rando_type` value, dragon locations may be randomized,
99
slaying dragons may award items, difficulty switches may require items to unlock, and limited use 'freeincarnates'
1010
can allow reincarnation without resurrecting dragons. Dragon speeds may also be randomized, and items may exist
1111
to reduce their speeds.
@@ -15,7 +15,7 @@ Same as vanilla; Find the Enchanted Chalice and return it to the Yellow Castle
1515

1616
## Which items can be in another player's world?
1717
All three keys, the chalice, the sword, the magnet, and the bridge can be found in another player's world. Depending on
18-
settings, dragon slowdowns, difficulty switch unlocks, and freeincarnates may also be found.
18+
options, dragon slowdowns, difficulty switch unlocks, and freeincarnates may also be found.
1919

2020
## What is considered a location check in Adventure?
2121
Most areas in Adventure have one or more locations which can contain an Adventure item or an Archipelago item.
@@ -41,7 +41,7 @@ A message is shown in the client log. While empty handed, the player can press
4141
order they were received. Once an item is retrieved this way, it cannot be retrieved again until pressing select to
4242
return to the 'GO' screen or doing a hard reset, either one of which will reset all items to their original positions.
4343

44-
## What are recommended settings to tweak for beginners to the rando?
44+
## What are recommended options to tweak for beginners to the rando?
4545
Setting difficulty_switch_a and lowering the dragons' speeds makes the dragons easier to avoid. Adding Chalice to
4646
local_items guarantees you'll visit at least one of the interesting castles, as it can only be placed in a castle or
4747
the credits room.

‎worlds/adventure/docs/setup_en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ an experience customized for their taste, and different players in the same mult
4141

4242
### Where do I get a YAML file?
4343

44-
You can generate a yaml or download a template by visiting the [Adventure Settings Page](/games/Adventure/player-settings)
44+
You can generate a yaml or download a template by visiting the [Adventure Options Page](/games/Adventure/player-options)
4545

4646
### What are recommended settings to tweak for beginners to the rando?
4747
Setting difficulty_switch_a and lowering the dragons' speeds makes the dragons easier to avoid. Adding Chalice to

‎worlds/alttp/docs/en_A Link to the Past.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# A Link to the Past
22

3-
## Where is the settings page?
3+
## Where is the options page?
44

5-
The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
5+
The [player options page for this game](../player-options) contains all the options you need to configure and export a
66
config file.
77

88
## What does randomization do to this game?

‎worlds/archipidle/docs/en_ArchipIDLE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ ArchipIDLE was originally the 2022 Archipelago April Fools' Day joke. It is an i
66
on regular intervals. Updated annually with more items, gimmicks, and features, the game is visible
77
only during the month of April.
88

9-
## Where is the settings page?
9+
## Where is the options page?
1010

11-
The [player settings page for this game](../player-settings) contains all the options you need to configure
11+
The [player options page for this game](../player-options) contains all the options you need to configure
1212
and export a config file.
1313

‎worlds/archipidle/docs/guide_en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ArchipIdle Setup Guide
22

33
## Joining a MultiWorld Game
4-
1. Generate a `.yaml` file from the [ArchipIDLE Player Settings Page](/games/ArchipIDLE/player-settings)
4+
1. Generate a `.yaml` file from the [ArchipIDLE Player Options Page](/games/ArchipIDLE/player-options)
55
2. Open the ArchipIDLE Client in your web browser by either:
66
- Navigate to the [ArchipIDLE Client](http://idle.multiworld.link)
77
- Download the client and run it locally from the

‎worlds/bk_sudoku/docs/en_Sudoku.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ BK Sudoku is not a typical Archipelago game; instead, it is a generic Sudoku cli
88

99
After completing a Sudoku puzzle, the game will unlock 1 random hint for an unchecked location in the slot you are connected to.
1010

11-
## Where is the settings page?
11+
## Where is the options page?
1212

13-
There is no settings page; this game cannot be used in your .yamls. Instead, the client can connect to any slot in a multiworld.
13+
There is no options page; this game cannot be used in your .yamls. Instead, the client can connect to any slot in a multiworld.

‎worlds/blasphemous/docs/en_Blasphemous.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Blasphemous
22

3-
## Where is the settings page?
3+
## Where is the options page?
44

5-
The [player settings page for this game](../player-settings) contains all the options you need to configure and export a config file.
5+
The [player options page for this game](../player-options) contains all the options you need to configure and export a config file.
66

77
## What does randomization do to this game?
88

‎worlds/bumpstik/docs/en_Bumper Stickers.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Bumper Stickers
22

3-
## Where is the settings page?
4-
The [player settings page for Bumper Stickers](../player-settings) contains all the options you need to configure and export a config file.
3+
## Where is the options page?
4+
The [player options page for Bumper Stickers](../player-options) contains all the options you need to configure and export a config file.
55

66
## What does randomization do to this game?
77
Playing this in Archipelago is a very different experience from Classic mode. You start with a very small board and a set of tasks. Completing those tasks will give you a larger board and more, harder tasks. In addition, special types of bumpers exist that must be cleared in order to progress.

‎worlds/checksfinder/docs/en_ChecksFinder.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# ChecksFinder
22

3-
## Where is the settings page?
3+
## Where is the options page?
44

5-
The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
5+
The [player options page for this game](../player-options) contains all the options you need to configure and export a
66
config file.
77

88
## What is considered a location check in ChecksFinder?

‎worlds/checksfinder/docs/setup_en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ guide: [Basic Multiworld Setup Guide](/tutorial/Archipelago/setup/en)
1515

1616
### Where do I get a YAML file?
1717

18-
You can customize your settings by visiting the [ChecksFinder Player Settings Page](/games/ChecksFinder/player-settings)
18+
You can customize your options by visiting the [ChecksFinder Player Options Page](/games/ChecksFinder/player-options)
1919

2020
### Generating a ChecksFinder game
2121

‎worlds/clique/docs/en_Clique.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ wait for someone else in the multiworld to "activate" their button before they c
1010

1111
Clique can be played on most modern HTML5-capable browsers.
1212

13-
## Where is the settings page?
13+
## Where is the options page?
1414

15-
The [player settings page for this game](../player-settings) contains all the options you need to configure
15+
The [player options page for this game](../player-options) contains all the options you need to configure
1616
and export a config file.

‎worlds/dark_souls_3/docs/en_Dark Souls III.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Dark Souls III
22

3-
## Where is the settings page?
3+
## Where is the options page?
44

5-
The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
5+
The [player options page for this game](../player-options) contains all the options you need to configure and export a
66
config file.
77

88
## What does randomization do to this game?
@@ -13,7 +13,7 @@ location "Titanite Shard #5" is the fifth titanite shard you pick up, no matter
1313
happens when you randomize Estus Shards and Undead Bone Shards.
1414

1515
It's also possible to randomize the upgrade level of weapons and shields as well as their infusions (if they can have
16-
one). Additionally, there are settings that can make the randomized experience more convenient or more interesting, such as
16+
one). Additionally, there are options that can make the randomized experience more convenient or more interesting, such as
1717
removing weapon requirements or auto-equipping whatever equipment you most recently received.
1818

1919
The goal is to find the four "Cinders of a Lord" items randomized into the multiworld and defeat the Soul of Cinder.

‎worlds/dark_souls_3/docs/setup_en.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,5 +51,5 @@ add it at the root folder of your game (e.g. "SteamLibrary\steamapps\common\DARK
5151

5252
## Where do I get a config file?
5353

54-
The [Player Settings](/games/Dark%20Souls%20III/player-settings) page on the website allows you to
55-
configure your personal settings and export them into a config file.
54+
The [Player Options](/games/Dark%20Souls%20III/player-options) page on the website allows you to
55+
configure your personal options and export them into a config file.

‎worlds/dkc3/docs/en_Donkey Kong Country 3.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Donkey Kong Country 3
22

3-
## Where is the settings page?
3+
## Where is the options page?
44

5-
The [player settings page for this game](../player-settings) contains all the options you need to configure and export a config file.
5+
The [player options page for this game](../player-options) contains all the options you need to configure and export a config file.
66

77
## What does randomization do to this game?
88

‎worlds/dkc3/docs/setup_en.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ guide: [Basic Multiworld Setup Guide](/tutorial/Archipelago/setup/en)
4545

4646
### Where do I get a config file?
4747

48-
The Player Settings page on the website allows you to configure your personal settings and export a config file from
49-
them. Player settings page: [Donkey Kong Country 3 Player Settings Page](/games/Donkey%20Kong%20Country%203/player-settings)
48+
The Player Options page on the website allows you to configure your personal options and export a config file from
49+
them. Player options page: [Donkey Kong Country 3 Player Options Page](/games/Donkey%20Kong%20Country%203/player-options)
5050

5151
### Verifying your config file
5252

@@ -55,8 +55,8 @@ validator page: [YAML Validation page](/check)
5555

5656
## Generating a Single-Player Game
5757

58-
1. Navigate to the Player Settings page, configure your options, and click the "Generate Game" button.
59-
- Player Settings page: [Donkey Kong Country 3 Player Settings Page](/games/Donkey%20Kong%20Country%203/player-settings)
58+
1. Navigate to the Player Options page, configure your options, and click the "Generate Game" button.
59+
- Player Options page: [Donkey Kong Country 3 Player Options Page](/games/Donkey%20Kong%20Country%203/player-options)
6060
2. You will be presented with a "Seed Info" page.
6161
3. Click the "Create New Room" link.
6262
4. You will be presented with a server page, from which you can download your patch file.

‎worlds/dlcquest/docs/en_DLCQuest.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# DLC Quest
22

3-
## Where is the settings page?
3+
## Where is the options page?
44

5-
The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
5+
The [player options page for this game](../player-options) contains all the options you need to configure and export a
66
config file.
77

88
## What does randomization do to this game?

‎worlds/dlcquest/docs/setup_en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ guide: [Basic Multiworld Setup Guide](/tutorial/Archipelago/setup/en)
1919

2020
### Where do I get a YAML file?
2121

22-
You can customize your settings by visiting the [DLC Quest Player Settings Page](/games/DLCQuest/player-settings)
22+
You can customize your options by visiting the [DLC Quest Player Options Page](/games/DLCQuest/player-options)
2323

2424
## Joining a MultiWorld Game
2525

‎worlds/doom_1993/docs/en_DOOM 1993.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# DOOM 1993
22

3-
## Where is the settings page?
3+
## Where is the options page?
44

5-
The [player settings page](../player-settings) contains the options needed to configure your game session.
5+
The [player options page](../player-options) contains the options needed to configure your game session.
66

77
## What does randomization do to this game?
88

‎worlds/doom_ii/docs/en_DOOM II.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# DOOM II
22

3-
## Where is the settings page?
3+
## Where is the options page?
44

5-
The [player settings page](../player-settings) contains the options needed to configure your game session.
5+
The [player options page](../player-options) contains the options needed to configure your game session.
66

77
## What does randomization do to this game?
88

‎worlds/factorio/docs/en_Factorio.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Factorio
22

3-
## Where is the settings page?
3+
## Where is the options page?
44

5-
The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
5+
The [player options page for this game](../player-options) contains all the options you need to configure and export a
66
config file.
77

88
## What does randomization do to this game?
@@ -36,7 +36,7 @@ inventory.
3636
## What is EnergyLink?
3737

3838
EnergyLink is an energy storage supported by certain games that is shared across all worlds in a multiworld.
39-
In Factorio, if enabled in the player settings, EnergyLink Bridge buildings can be crafted and placed, which allow
39+
In Factorio, if enabled in the player options, EnergyLink Bridge buildings can be crafted and placed, which allow
4040
depositing excess energy and supplementing energy deficits, much like Accumulators.
4141

4242
Each placed EnergyLink Bridge provides 10 MW of throughput. The shared storage has unlimited capacity, but 25% of energy

‎worlds/factorio/docs/setup_en.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ options.
2525

2626
### Where do I get a config file?
2727

28-
The Player Settings page on the website allows you to configure your personal settings and export a config file from
29-
them. Factorio player settings page: [Factorio Settings Page](/games/Factorio/player-settings)
28+
The Player Options page on the website allows you to configure your personal options and export a config file from
29+
them. Factorio player options page: [Factorio Options Page](/games/Factorio/player-options)
3030

3131
### Verifying your config file
3232

@@ -133,7 +133,7 @@ This allows you to host your own Factorio game.
133133
For additional client features, issue the `/help` command in the Archipelago Client. Once connected to the AP server,
134134
you can also issue the `!help` command to learn about additional commands like `!hint`.
135135
For more information about the commands you can use, see the [Commands Guide](/tutorial/Archipelago/commands/en) and
136-
[Other Settings](#other-settings).
136+
[Other Options](#other-options).
137137

138138
## Allowing Other People to Join Your Game
139139

@@ -148,11 +148,11 @@ For more information about the commands you can use, see the [Commands Guide](/t
148148
By default, peaceful mode is disabled. There are two methods to enable peaceful mode:
149149

150150
### By config file
151-
You can specify Factorio game settings such as peaceful mode and terrain and resource generation parameters in your
152-
config .yaml file by including the `world_gen` setting. This setting is currently not supported by the web UI, so you'll
151+
You can specify Factorio game options such as peaceful mode and terrain and resource generation parameters in your
152+
config .yaml file by including the `world_gen` option. This option is currently not supported by the web UI, so you'll
153153
have to manually create or edit your config file with a text editor of your choice.
154154
The [template file](/static/generated/configs/Factorio.yaml) is a good starting point and contains the default value of
155-
the `world_gen` setting. If you already have a config file you may also just copy that setting over from the template.
155+
the `world_gen` option. If you already have a config file you may also just copy that option over from the template.
156156
To enable peaceful mode, simply replace `peaceful_mode: false` with `peaceful_mode: true`. Finally, use the
157157
[.yaml checker](/check) to ensure your file is valid.
158158

@@ -165,7 +165,7 @@ enable peaceful mode by entering the following commands into your Archipelago Fa
165165
```
166166
(If this warns you that these commands may disable achievements, you may need to repeat them for them to take effect.)
167167

168-
## Other Settings
168+
## Other Options
169169

170170
### filter_item_sends
171171

‎worlds/ff1/docs/en_Final Fantasy.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Final Fantasy 1 (NES)
22

3-
## Where is the settings page?
3+
## Where is the options page?
44

5-
Unlike most games on Archipelago.gg, Final Fantasy 1's settings are controlled entirely by the original randomzier. You
6-
can find an exhaustive list of documented settings on the FFR
5+
Unlike most games on Archipelago.gg, Final Fantasy 1's options are controlled entirely by the original randomzier. You
6+
can find an exhaustive list of documented options on the FFR
77
website: [FF1R Website](https://finalfantasyrandomizer.com/)
88

99
## What does randomization do to this game?

‎worlds/ffmq/docs/en_Final Fantasy Mystic Quest.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Final Fantasy Mystic Quest
22

3-
## Where is the settings page?
3+
## Where is the options page?
44

5-
The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
5+
The [player options page for this game](../player-options) contains all the options you need to configure and export a
66
config file.
77

88
## What does randomization do to this game?

‎worlds/ffmq/docs/setup_en.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ guide: [Basic Multiworld Setup Guide](/tutorial/Archipelago/setup/en)
3939

4040
### Where do I get a config file?
4141

42-
The Player Settings page on the website allows you to configure your personal settings and export a config file from
43-
them. Player settings page: [Final Fantasy Mystic Quest Player Settings Page](/games/Final%20Fantasy%20Mystic%20Quest/player-settings)
42+
The Player Options page on the website allows you to configure your personal options and export a config file from
43+
them. Player options page: [Final Fantasy Mystic Quest Player Options Page](/games/Final%20Fantasy%20Mystic%20Quest/player-options)
4444

4545
### Verifying your config file
4646

@@ -49,8 +49,8 @@ validator page: [YAML Validation page](/mysterycheck)
4949

5050
## Generating a Single-Player Game
5151

52-
1. Navigate to the Player Settings page, configure your options, and click the "Generate Game" button.
53-
- Player Settings page: [Final Fantasy Mystic Quest Player Settings Page](/games/Final%20Fantasy%20Mystic%20Quest/player-settings)
52+
1. Navigate to the Player Options page, configure your options, and click the "Generate Game" button.
53+
- Player Options page: [Final Fantasy Mystic Quest Player Options Page](/games/Final%20Fantasy%20Mystic%20Quest/player-options)
5454
2. You will be presented with a "Seed Info" page.
5555
3. Click the "Create New Room" link.
5656
4. You will be presented with a server page, from which you can download your `.apmq` patch file.

‎worlds/heretic/docs/en_Heretic.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Heretic
22

3-
## Where is the settings page?
3+
## Where is the options page?
44

5-
The [player settings page](../player-settings) contains the options needed to configure your game session.
5+
The [player options page](../player-options) contains the options needed to configure your game session.
66

77
## What does randomization do to this game?
88

‎worlds/hk/docs/en_Hollow Knight.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Hollow Knight
22

3-
## Where is the settings page?
3+
## Where is the options page?
44

5-
The [player settings page for this game](../player-settings) contains all the options you need to configure and export a
5+
The [player options page for this game](../player-options) contains all the options you need to configure and export a
66
config file.
77

88
## What does randomization do to this game?
@@ -12,7 +12,7 @@ Shop costs are presently always randomized.
1212

1313
## What Hollow Knight items can appear in other players' worlds?
1414

15-
This is dependent entirely upon your YAML settings. Some examples include: charms, grubs, lifeblood cocoons, geo, etc.
15+
This is dependent entirely upon your YAML options. Some examples include: charms, grubs, lifeblood cocoons, geo, etc.
1616

1717
## What does another world's item look like in Hollow Knight?
1818

‎worlds/hk/docs/setup_en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ You can see the [basic multiworld setup guide](/tutorial/Archipelago/setup/en) h
3131
about why Archipelago uses YAML files and what they're for.
3232

3333
### Where do I get a YAML?
34-
You can use the [game settings page for Hollow Knight](/games/Hollow%20Knight/player-settings) here on the Archipelago
34+
You can use the [game options page for Hollow Knight](/games/Hollow%20Knight/player-options) here on the Archipelago
3535
website to generate a YAML using a graphical interface.
3636

3737
### Joining an Archipelago Game in Hollow Knight

0 commit comments

Comments
 (0)