diff --git a/WebHostLib/static/assets/tutorial/archipelago/commands_en.md b/WebHostLib/static/assets/tutorial/archipelago/commands_en.md index 627e4ba5..84122400 100644 --- a/WebHostLib/static/assets/tutorial/archipelago/commands_en.md +++ b/WebHostLib/static/assets/tutorial/archipelago/commands_en.md @@ -12,15 +12,41 @@ are always submitted to the server prepended with an exclamation point: `!`. The following list is a list of client commands which may be available to you through your Archipelago client. You execute these commands in your client window. +The following commands are available in these clients: SNIClient, FactorioClient, FF1Client. + - `/connect ` Connect to the multiworld server. - `/disconnect` Disconnects you from your current session. -- `/nes` Shows the current status of the NES connection, when applicable. -- `/snes` Shows the current status of the SNES connection, when applicable. - `/received` Displays all the items you have found or been sent. - `/missing` Displays all the locations along with their current status (checked/missing). +- `/items` Lists all the item names for the current game. +- `/locations` Lists all the location names for the current game. +- `/ready` Sends ready status to the server. +- `/help` Returns a list of available commands. +- `/license` Returns the software licensing information. - Just typing anything will broadcast a message to all players +##### FF1Client Only +The following command is only available when using the FF1Client for the Final Fantasy Randomizer. + +- `/nes` Shows the current status of the NES connection. + +##### SNIClient Only +The following command is only available when using the SNIClient for SNES based games. + +- `/snes` Attempts to connect to your SNES device via SNI. +- `/snes_close` Closes the current SNES connection. +- `/slow_mode` Toggles on or off slow mode, which limits the rate in which you receive items. + +##### FactorioClient Only +The following command is only available when using the FactorioClient to play Factorio with Archipelago. + +- `/factorio ` Sends the command argument to the Factorio server as a command. + #### Remote Commands +Remote commands may be executed by any client which allows for sending text chat to the Archipelago server. If your +client does not allow for sending chat then you may connect to your game slot with the TextClient which comes with the +Archipelago installation. In order to execute the command you need to merely send a text message with the command, +including the exclamation point. - `!hint ` Tells you at which location in whose game your Item is. Note you need to have checked some locations to earn a hint. You can check how many you have by just running `!hint` @@ -31,4 +57,19 @@ execute these commands in your client window. #### Host only (on Archipelago.gg or in your server console) -- `/forfeit ` Forfeits someone regardless of settings and game completion status +- `/help` Returns a list of commands available in the console. +- `/license` Returns the software licensing information. +- `/countdown ` Starts a countdown which is sent to all players via text chat. Defaults to 10 seconds if no + argument is provided. +- `/options` Lists the server's current options, including password in plaintext. +- `/save` Saves the state of the current multiworld. Note that the server autosaves on a minute basis. +- `/players` List currently connected players. +- `/exit` Shutdown the server +- `/alias ` Assign a player an alias. +- `/collect ` Send out any items remaining in the multiworld belonging to the given player. +- `/forfeit ` Forfeits someone regardless of settings and game completion status +- `/allow_forfeit ` Allows the given player to use the `!forfeit` command. +- `/forbid_forfeit ` Bars the given player from using the `!forfeit` command. +- `/send ` Grants the given player the specified item. +- `/hint ` Sned out a hint for the given item or location for the specified player. +- `/option