Skip to content

Commit

Permalink
Docs: replacing "setting" to "option" in world docs (ArchipelagoMW#2622)
Browse files Browse the repository at this point in the history
* 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 <[email protected]>

* 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 <[email protected]>

* 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 <[email protected]>
Co-authored-by: black-sliver <[email protected]>
  • Loading branch information
3 people authored and EmilyV99 committed Apr 15, 2024
1 parent 94b57fe commit f5f232e
Show file tree
Hide file tree
Showing 92 changed files with 290 additions and 255 deletions.
10 changes: 5 additions & 5 deletions worlds/adventure/docs/en_Adventure.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Adventure

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

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

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

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

## What are recommended settings to tweak for beginners to the rando?
## What are recommended options to tweak for beginners to the rando?
Setting difficulty_switch_a and lowering the dragons' speeds makes the dragons easier to avoid. Adding Chalice to
local_items guarantees you'll visit at least one of the interesting castles, as it can only be placed in a castle or
the credits room.
Expand Down
2 changes: 1 addition & 1 deletion worlds/adventure/docs/setup_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ an experience customized for their taste, and different players in the same mult

### Where do I get a YAML file?

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

### What are recommended settings to tweak for beginners to the rando?
Setting difficulty_switch_a and lowering the dragons' speeds makes the dragons easier to avoid. Adding Chalice to
Expand Down
4 changes: 2 additions & 2 deletions worlds/alttp/docs/en_A Link to the Past.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# A Link to the Past

## Where is the settings page?
## Where is the options page?

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

## What does randomization do to this game?
Expand Down
4 changes: 2 additions & 2 deletions worlds/archipidle/docs/en_ArchipIDLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ ArchipIDLE was originally the 2022 Archipelago April Fools' Day joke. It is an i
on regular intervals. Updated annually with more items, gimmicks, and features, the game is visible
only during the month of April.

## Where is the settings page?
## Where is the options page?

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

2 changes: 1 addition & 1 deletion worlds/archipidle/docs/guide_en.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# ArchipIdle Setup Guide

## Joining a MultiWorld Game
1. Generate a `.yaml` file from the [ArchipIDLE Player Settings Page](/games/ArchipIDLE/player-settings)
1. Generate a `.yaml` file from the [ArchipIDLE Player Options Page](/games/ArchipIDLE/player-options)
2. Open the ArchipIDLE Client in your web browser by either:
- Navigate to the [ArchipIDLE Client](http://idle.multiworld.link)
- Download the client and run it locally from the
Expand Down
4 changes: 2 additions & 2 deletions worlds/bk_sudoku/docs/en_Sudoku.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ BK Sudoku is not a typical Archipelago game; instead, it is a generic Sudoku cli

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

## Where is the settings page?
## Where is the options page?

There is no settings page; this game cannot be used in your .yamls. Instead, the client can connect to any slot in a multiworld.
There is no options page; this game cannot be used in your .yamls. Instead, the client can connect to any slot in a multiworld.
4 changes: 2 additions & 2 deletions worlds/blasphemous/docs/en_Blasphemous.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Blasphemous

## Where is the settings page?
## Where is the options page?

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

## What does randomization do to this game?

Expand Down
4 changes: 2 additions & 2 deletions worlds/bumpstik/docs/en_Bumper Stickers.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Bumper Stickers

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

## What does randomization do to this game?
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.
Expand Down
4 changes: 2 additions & 2 deletions worlds/checksfinder/docs/en_ChecksFinder.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# ChecksFinder

## Where is the settings page?
## Where is the options page?

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

## What is considered a location check in ChecksFinder?
Expand Down
2 changes: 1 addition & 1 deletion worlds/checksfinder/docs/setup_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ guide: [Basic Multiworld Setup Guide](/tutorial/Archipelago/setup/en)

### Where do I get a YAML file?

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

### Generating a ChecksFinder game

Expand Down
4 changes: 2 additions & 2 deletions worlds/clique/docs/en_Clique.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ wait for someone else in the multiworld to "activate" their button before they c

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

## Where is the settings page?
## Where is the options page?

The [player settings page for this game](../player-settings) contains all the options you need to configure
The [player options page for this game](../player-options) contains all the options you need to configure
and export a config file.
6 changes: 3 additions & 3 deletions worlds/dark_souls_3/docs/en_Dark Souls III.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Dark Souls III

## Where is the settings page?
## Where is the options page?

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

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

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

The goal is to find the four "Cinders of a Lord" items randomized into the multiworld and defeat the Soul of Cinder.
Expand Down
4 changes: 2 additions & 2 deletions worlds/dark_souls_3/docs/setup_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,5 @@ add it at the root folder of your game (e.g. "SteamLibrary\steamapps\common\DARK

## Where do I get a config file?

The [Player Settings](/games/Dark%20Souls%20III/player-settings) page on the website allows you to
configure your personal settings and export them into a config file.
The [Player Options](/games/Dark%20Souls%20III/player-options) page on the website allows you to
configure your personal options and export them into a config file.
4 changes: 2 additions & 2 deletions worlds/dkc3/docs/en_Donkey Kong Country 3.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Donkey Kong Country 3

## Where is the settings page?
## Where is the options page?

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

## What does randomization do to this game?

Expand Down
8 changes: 4 additions & 4 deletions worlds/dkc3/docs/setup_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ guide: [Basic Multiworld Setup Guide](/tutorial/Archipelago/setup/en)

### Where do I get a config file?

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

### Verifying your config file

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

## Generating a Single-Player Game

1. Navigate to the Player Settings page, configure your options, and click the "Generate Game" button.
- Player Settings page: [Donkey Kong Country 3 Player Settings Page](/games/Donkey%20Kong%20Country%203/player-settings)
1. Navigate to the Player Options page, configure your options, and click the "Generate Game" button.
- Player Options page: [Donkey Kong Country 3 Player Options Page](/games/Donkey%20Kong%20Country%203/player-options)
2. You will be presented with a "Seed Info" page.
3. Click the "Create New Room" link.
4. You will be presented with a server page, from which you can download your patch file.
Expand Down
4 changes: 2 additions & 2 deletions worlds/dlcquest/docs/en_DLCQuest.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# DLC Quest

## Where is the settings page?
## Where is the options page?

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

## What does randomization do to this game?
Expand Down
2 changes: 1 addition & 1 deletion worlds/dlcquest/docs/setup_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ guide: [Basic Multiworld Setup Guide](/tutorial/Archipelago/setup/en)

### Where do I get a YAML file?

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

## Joining a MultiWorld Game

Expand Down
4 changes: 2 additions & 2 deletions worlds/doom_1993/docs/en_DOOM 1993.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# DOOM 1993

## Where is the settings page?
## Where is the options page?

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

## What does randomization do to this game?

Expand Down
4 changes: 2 additions & 2 deletions worlds/doom_ii/docs/en_DOOM II.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# DOOM II

## Where is the settings page?
## Where is the options page?

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

## What does randomization do to this game?

Expand Down
6 changes: 3 additions & 3 deletions worlds/factorio/docs/en_Factorio.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Factorio

## Where is the settings page?
## Where is the options page?

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

## What does randomization do to this game?
Expand Down Expand Up @@ -36,7 +36,7 @@ inventory.
## What is EnergyLink?

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

Each placed EnergyLink Bridge provides 10 MW of throughput. The shared storage has unlimited capacity, but 25% of energy
Expand Down
14 changes: 7 additions & 7 deletions worlds/factorio/docs/setup_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ options.

### Where do I get a config file?

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

### Verifying your config file

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

## Allowing Other People to Join Your Game

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

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

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

## Other Settings
## Other Options

### filter_item_sends

Expand Down
6 changes: 3 additions & 3 deletions worlds/ff1/docs/en_Final Fantasy.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Final Fantasy 1 (NES)

## Where is the settings page?
## Where is the options page?

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

## What does randomization do to this game?
Expand Down
4 changes: 2 additions & 2 deletions worlds/ffmq/docs/en_Final Fantasy Mystic Quest.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Final Fantasy Mystic Quest

## Where is the settings page?
## Where is the options page?

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

## What does randomization do to this game?
Expand Down
8 changes: 4 additions & 4 deletions worlds/ffmq/docs/setup_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ guide: [Basic Multiworld Setup Guide](/tutorial/Archipelago/setup/en)

### Where do I get a config file?

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

### Verifying your config file

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

## Generating a Single-Player Game

1. Navigate to the Player Settings page, configure your options, and click the "Generate Game" button.
- Player Settings page: [Final Fantasy Mystic Quest Player Settings Page](/games/Final%20Fantasy%20Mystic%20Quest/player-settings)
1. Navigate to the Player Options page, configure your options, and click the "Generate Game" button.
- Player Options page: [Final Fantasy Mystic Quest Player Options Page](/games/Final%20Fantasy%20Mystic%20Quest/player-options)
2. You will be presented with a "Seed Info" page.
3. Click the "Create New Room" link.
4. You will be presented with a server page, from which you can download your `.apmq` patch file.
Expand Down
4 changes: 2 additions & 2 deletions worlds/heretic/docs/en_Heretic.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Heretic

## Where is the settings page?
## Where is the options page?

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

## What does randomization do to this game?

Expand Down
6 changes: 3 additions & 3 deletions worlds/hk/docs/en_Hollow Knight.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Hollow Knight

## Where is the settings page?
## Where is the options page?

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

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

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion worlds/hk/docs/setup_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ You can see the [basic multiworld setup guide](/tutorial/Archipelago/setup/en) h
about why Archipelago uses YAML files and what they're for.

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

### Joining an Archipelago Game in Hollow Knight
Expand Down
Loading

0 comments on commit f5f232e

Please sign in to comment.