Skip to content

Commit 17748a4

Browse files
Launcher, Docs: Update UI and Set-Up Guide to Reference Options (ArchipelagoMW#2950)
1 parent 9182fe5 commit 17748a4

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

Launcher.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ def update_settings():
100100
# Functions
101101
Component("Open host.yaml", func=open_host_yaml),
102102
Component("Open Patch", func=open_patch),
103-
Component("Generate Template Settings", func=generate_yamls),
103+
Component("Generate Template Options", func=generate_yamls),
104104
Component("Discord Server", icon="discord", func=lambda: webbrowser.open("https://discord.gg/8Z65BR2")),
105105
Component("18+ Discord Server", icon="discord", func=lambda: webbrowser.open("https://discord.gg/fqvNCCRsu4")),
106106
Component("Browse Files", func=browse_files),

worlds/generic/docs/setup_en.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ to your Archipelago installation.
3939
### What is a YAML?
4040

4141
YAML is the file format which Archipelago uses in order to configure a player's world. It allows you to dictate which
42-
game you will be playing as well as the settings you would like for that game.
42+
game you will be playing as well as the options you would like for that game.
4343

4444
YAML is a format very similar to JSON however it is made to be more human-readable. If you are ever unsure of the
4545
validity of your YAML file you may check the file by uploading it to the check page on the Archipelago website:
@@ -48,10 +48,10 @@ validity of your YAML file you may check the file by uploading it to the check p
4848
### Creating a YAML
4949

5050
YAML files may be generated on the Archipelago website by visiting the [games page](/games) and clicking the
51-
"Settings Page" link under the relevant game. Clicking "Export Settings" in a game's settings page will download the
51+
"Options Page" link under the relevant game. Clicking "Export Options" in a game's options page will download the
5252
YAML to your system.
5353

54-
Alternatively, you can run `ArchipelagoLauncher.exe` and click on `Generate Template Settings` to create a set of template
54+
Alternatively, you can run `ArchipelagoLauncher.exe` and click on `Generate Template Options` to create a set of template
5555
YAMLs for each game in your Archipelago install (including for APWorlds). These will be placed in your `Players/Templates` folder.
5656

5757
In a multiworld there must be one YAML per world. Any number of players can play on each world using either the game's
@@ -66,17 +66,17 @@ each player is planning on playing their own game then they will each need a YAM
6666
#### On the website
6767

6868
The easiest way to get started playing an Archipelago generated game, after following the base setup from the game's
69-
setup guide, is to find the game on the [Archipelago Games List](/games), click on `Settings Page`, set the settings for
69+
setup guide, is to find the game on the [Archipelago Games List](/games), click on `Options Page`, set the options for
7070
how you want to play, and click `Generate Game` at the bottom of the page. This will create a page for the seed, from
7171
which you can create a room, and then [connect](#connecting-to-an-archipelago-server).
7272

73-
If you have downloaded the settings, or have created a settings file manually, this file can be uploaded on the
73+
If you have downloaded the options, or have created an options file manually, this file can be uploaded on the
7474
[Generation Page](/generate) where you can also set any specific hosting settings.
7575

7676
#### On your local installation
7777

7878
To generate a game on your local machine, make sure to install the Archipelago software. Navigate to your Archipelago
79-
installation (usually C:\ProgramData\Archipelago), and place the settings file you have either created or downloaded
79+
installation (usually C:\ProgramData\Archipelago), and place the options file you have either created or downloaded
8080
from the website in the `Players` folder.
8181

8282
Run `ArchipelagoGenerate.exe`, or click on `Generate` in the launcher, and it will inform you whether the generation
@@ -97,7 +97,7 @@ resources, and host the resulting multiworld on the website.
9797

9898
#### Gather All Player YAMLs
9999

100-
All players that wish to play in the generated multiworld must have a YAML file which contains the settings that they
100+
All players that wish to play in the generated multiworld must have a YAML file which contains the options that they
101101
wish to play with. One person should gather all files from all participants in the generated multiworld. It is possible
102102
for a single player to have multiple games, or even multiple slots of a single game, but each YAML must have a unique
103103
player name.
@@ -129,7 +129,7 @@ need the corresponding ROM files.
129129
Sometimes there are various settings that you may want to change before rolling a seed such as enabling race mode,
130130
auto-release, plando support, or setting a password.
131131

132-
All of these settings, plus other options, may be changed by modifying the `host.yaml` file in the Archipelago
132+
All of these settings, plus more, can be changed by modifying the `host.yaml` file in the Archipelago
133133
installation folder. You can quickly access this file by clicking on `Open host.yaml` in the launcher. The settings
134134
chosen here are baked into the `.archipelago` file that gets output with the other files after generation, so if you
135135
are rolling locally, ensure this file is edited to your liking **before** rolling the seed. This file is overwritten
@@ -207,4 +207,4 @@ when creating your [YAML file](#creating-a-yaml). If the game is hosted on the w
207207
room page. The name is case-sensitive.
208208
* `Password` is the password set by the host in order to join the multiworld. By default, this will be empty and is almost
209209
never required, but one can be set when generating the game. Generally, leave this field blank when it exists,
210-
unless you know that a password was set, and what that password is.
210+
unless you know that a password was set, and what that password is.

0 commit comments

Comments
 (0)