From 3f1d216d2888b84b9a987d332bbd1af267eb7fa9 Mon Sep 17 00:00:00 2001 From: alwaysintreble Date: Sun, 26 Jun 2022 20:52:24 -0500 Subject: [PATCH] docs: add reference to text client and commands to a few setup guides (#694) --- worlds/factorio/docs/setup_en.md | 19 ++++++++++++++----- worlds/hk/docs/setup_en.md | 9 ++++++++- worlds/meritous/docs/setup_en.md | 7 +++++++ 3 files changed, 29 insertions(+), 6 deletions(-) diff --git a/worlds/factorio/docs/setup_en.md b/worlds/factorio/docs/setup_en.md index fc83c190..7ee91fb4 100644 --- a/worlds/factorio/docs/setup_en.md +++ b/worlds/factorio/docs/setup_en.md @@ -88,8 +88,9 @@ Factorio product code. This will allow you to download the game directly from th It is recommended to download the standalone version of Factorio for use as a dedicated server. Doing so prevents any potential conflicts with your currently-installed version of Factorio. Download the file by clicking on the button -appropriate to your operating system, and extract the folder to a convenient location (we recommend `C:\Factorio` or -similar). +appropriate to your operating system, and extract the folder to a convenient location. The best place to do this for +Archipelago is to place the extracted game folder into the `Archipelago` directory and rename it to just be "Factorio". + ![Factorio Download Options](/static/generated/docs/Factorio/factorio-download.png) @@ -99,12 +100,13 @@ have logged in, you may close the game. #### Configure your Archipelago Installation -You must modify your `host.yaml` file inside your Archipelago installation directory so that it points to your -standalone Factorio executable. Here is an example of the appropriate setup, note the double `\\` are required: +If you did not place the Factorio standalone in your Archipelago installation, you must modify your `host.yaml` file +inside your Archipelago installation directory so that it points to your standalone Factorio executable. Here is an +example of the appropriate setup, note the double `\\` are required: ```yaml factorio_options: - executable: C:\\factorio\\bin\\x64\\factorio" + executable: C:\\path\\to\\factorio\\bin\\x64\\factorio" ``` This allows you to host your own Factorio game. @@ -145,6 +147,13 @@ In case any problems should occur, the Archipelago Client will create a file `Fa contents of this file may help you troubleshoot an issue on your own and is vital for requesting help from other people in Archipelago. +## Commands in game + +Once you have connected to the server successfully using the Archipelago Factorio Client you should see a message +stating you can get help using Archipelago commands by typing `!help`. Commands cannot currently be sent from within +the Factorio session, but you can send them from the Archipelago Factorio Client. For more information about the commands +you can use see the [commands guide](/tutorial/Archipelago/commands/en). + ## Additional Resources - Alternate Tutorial by diff --git a/worlds/hk/docs/setup_en.md b/worlds/hk/docs/setup_en.md index bc2e4da7..0584af0f 100644 --- a/worlds/hk/docs/setup_en.md +++ b/worlds/hk/docs/setup_en.md @@ -27,4 +27,11 @@ website to generate a YAML using a graphical interface. 5. Hit **Start** to begin the game. The game will stall for a few seconds while it does all item placements. 6. The game will immediately drop you into the randomized game. * If you are waiting for a countdown then wait for it to lapse before hitting Start. - * Or hit Start then pause the game once you're in it. \ No newline at end of file + * Or hit Start then pause the game once you're in it. + +## Commands +While playing the multiworld you can interact with the server using various commands listed in the +[commands guide](/tutorial/Archipelago/commands/en). As this game does not have an in-game text client at the moment, +You can optionally connect to the multiworld using the text client, which can be found in the +[main Archipelago installation](https://github.com/ArchipelagoMW/Archipelago/releases) as Archipelago Text Client to +enter these commands. diff --git a/worlds/meritous/docs/setup_en.md b/worlds/meritous/docs/setup_en.md index c829765e..bf6af5f6 100644 --- a/worlds/meritous/docs/setup_en.md +++ b/worlds/meritous/docs/setup_en.md @@ -52,6 +52,13 @@ Once the goal has been completed, you may press F to send a forfeit, sending out More in-depth information about the game can be found in the game's help file, accessed by pressing H while playing. +## Commands +While playing the multiworld you can interact with the server using various commands listed in the +[commands guide](/tutorial/Archipelago/commands/en). As this game does not have an in-game text client at the moment, +You can optionally connect to the multiworld using the text client, which can be found in the +[main Archipelago installation](https://github.com/ArchipelagoMW/Archipelago/releases) as Archipelago Text Client to +enter these commands. + ## Game Troubleshooting ### An error message shows up at the bottom-left