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

Launcher, Docs: Update UI and Set-Up Guide to Reference Options (#2950)

This commit is contained in:
Nicholas Saylor 2024-03-28 10:00:10 -04:00 committed by GitHub
parent 9182fe563f
commit 17748a4bf1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Launcher.py
View File

@ -100,7 +100,7 @@ components.extend([
# Functions # Functions
Component("Open host.yaml", func=open_host_yaml), Component("Open host.yaml", func=open_host_yaml),
Component("Open Patch", func=open_patch), Component("Open Patch", func=open_patch),
Component("Generate Template Settings", func=generate_yamls), Component("Generate Template Options", func=generate_yamls),
Component("Discord Server", icon="discord", func=lambda: webbrowser.open("https://discord.gg/8Z65BR2")), Component("Discord Server", icon="discord", func=lambda: webbrowser.open("https://discord.gg/8Z65BR2")),
Component("18+ Discord Server", icon="discord", func=lambda: webbrowser.open("https://discord.gg/fqvNCCRsu4")), Component("18+ Discord Server", icon="discord", func=lambda: webbrowser.open("https://discord.gg/fqvNCCRsu4")),
Component("Browse Files", func=browse_files), Component("Browse Files", func=browse_files),

18
worlds/generic/docs/setup_en.md
View File

@ -39,7 +39,7 @@ to your Archipelago installation.
### What is a YAML? ### What is a YAML?
YAML is the file format which Archipelago uses in order to configure a player's world. It allows you to dictate which YAML is the file format which Archipelago uses in order to configure a player's world. It allows you to dictate which
game you will be playing as well as the settings you would like for that game. game you will be playing as well as the options you would like for that game.
YAML is a format very similar to JSON however it is made to be more human-readable. If you are ever unsure of the YAML is a format very similar to JSON however it is made to be more human-readable. If you are ever unsure of the
validity of your YAML file you may check the file by uploading it to the check page on the Archipelago website: 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
### Creating a YAML ### Creating a YAML
YAML files may be generated on the Archipelago website by visiting the [games page](/games) and clicking the YAML files may be generated on the Archipelago website by visiting the [games page](/games) and clicking the
"Settings Page" link under the relevant game. Clicking "Export Settings" in a game's settings page will download the "Options Page" link under the relevant game. Clicking "Export Options" in a game's options page will download the
YAML to your system. YAML to your system.
Alternatively, you can run `ArchipelagoLauncher.exe` and click on `Generate Template Settings` to create a set of template Alternatively, you can run `ArchipelagoLauncher.exe` and click on `Generate Template Options` to create a set of template
YAMLs for each game in your Archipelago install (including for APWorlds). These will be placed in your `Players/Templates` folder. YAMLs for each game in your Archipelago install (including for APWorlds). These will be placed in your `Players/Templates` folder.
In a multiworld there must be one YAML per world. Any number of players can play on each world using either the game's 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
#### On the website #### On the website
The easiest way to get started playing an Archipelago generated game, after following the base setup from the game's The easiest way to get started playing an Archipelago generated game, after following the base setup from the game's
setup guide, is to find the game on the [Archipelago Games List](/games), click on `Settings Page`, set the settings for setup guide, is to find the game on the [Archipelago Games List](/games), click on `Options Page`, set the options for
how you want to play, and click `Generate Game` at the bottom of the page. This will create a page for the seed, from how you want to play, and click `Generate Game` at the bottom of the page. This will create a page for the seed, from
which you can create a room, and then [connect](#connecting-to-an-archipelago-server). which you can create a room, and then [connect](#connecting-to-an-archipelago-server).
If you have downloaded the settings, or have created a settings file manually, this file can be uploaded on the If you have downloaded the options, or have created an options file manually, this file can be uploaded on the
[Generation Page](/generate) where you can also set any specific hosting settings. [Generation Page](/generate) where you can also set any specific hosting settings.
#### On your local installation #### On your local installation
To generate a game on your local machine, make sure to install the Archipelago software. Navigate to your Archipelago To generate a game on your local machine, make sure to install the Archipelago software. Navigate to your Archipelago
installation (usually C:\ProgramData\Archipelago), and place the settings file you have either created or downloaded installation (usually C:\ProgramData\Archipelago), and place the options file you have either created or downloaded
from the website in the `Players` folder. from the website in the `Players` folder.
Run `ArchipelagoGenerate.exe`, or click on `Generate` in the launcher, and it will inform you whether the generation 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.
#### Gather All Player YAMLs #### Gather All Player YAMLs
All players that wish to play in the generated multiworld must have a YAML file which contains the settings that they All players that wish to play in the generated multiworld must have a YAML file which contains the options that they
wish to play with. One person should gather all files from all participants in the generated multiworld. It is possible wish to play with. One person should gather all files from all participants in the generated multiworld. It is possible
for a single player to have multiple games, or even multiple slots of a single game, but each YAML must have a unique for a single player to have multiple games, or even multiple slots of a single game, but each YAML must have a unique
player name. player name.
@ -129,7 +129,7 @@ need the corresponding ROM files.
Sometimes there are various settings that you may want to change before rolling a seed such as enabling race mode, Sometimes there are various settings that you may want to change before rolling a seed such as enabling race mode,
auto-release, plando support, or setting a password. auto-release, plando support, or setting a password.
All of these settings, plus other options, may be changed by modifying the `host.yaml` file in the Archipelago All of these settings, plus more, can be changed by modifying the `host.yaml` file in the Archipelago
installation folder. You can quickly access this file by clicking on `Open host.yaml` in the launcher. The settings installation folder. You can quickly access this file by clicking on `Open host.yaml` in the launcher. The settings
chosen here are baked into the `.archipelago` file that gets output with the other files after generation, so if you chosen here are baked into the `.archipelago` file that gets output with the other files after generation, so if you
are rolling locally, ensure this file is edited to your liking **before** rolling the seed. This file is overwritten 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
room page. The name is case-sensitive. room page. The name is case-sensitive.
* `Password` is the password set by the host in order to join the multiworld. By default, this will be empty and is almost * `Password` is the password set by the host in order to join the multiworld. By default, this will be empty and is almost
never required, but one can be set when generating the game. Generally, leave this field blank when it exists, never required, but one can be set when generating the game. Generally, leave this field blank when it exists,
unless you know that a password was set, and what that password is. unless you know that a password was set, and what that password is.