Docs: Categorize Commands in Guide (#2213)
* Update commands_en.md Commands re-ordered and put into categories Some commands were better documented / explained more clearly Other formatting changes * Status command moved to General category and elaboration on getitem command * "Multi-world" -> "Multiworld" * Moved game-specific local commands to game pages
This commit is contained in:
parent
f6e92a18de
commit
6c4a3959c3
|
@ -42,3 +42,9 @@ depositing excess energy and supplementing energy deficits, much like Accumulato
|
||||||
Each placed EnergyLink Bridge provides 10 MW of throughput. The shared storage has unlimited capacity, but 25% of energy
|
Each placed EnergyLink Bridge provides 10 MW of throughput. The shared storage has unlimited capacity, but 25% of energy
|
||||||
is lost during depositing. The amount of energy currently in the shared storage is displayed in the Archipelago client.
|
is lost during depositing. The amount of energy currently in the shared storage is displayed in the Archipelago client.
|
||||||
It can also be queried by typing `/energy-link` in-game.
|
It can also be queried by typing `/energy-link` in-game.
|
||||||
|
|
||||||
|
## Unique Local Commands
|
||||||
|
The following commands are only available when using the FactorioClient to play Factorio with Archipelago.
|
||||||
|
|
||||||
|
- `/factorio <command text>` Sends the command argument to the Factorio server as a command.
|
||||||
|
- `/energy-link` Displays the amount of energy currently in shared storage for EnergyLink
|
||||||
|
|
|
@ -24,3 +24,8 @@ All items can appear in other players worlds, including consumables, shards, wea
|
||||||
|
|
||||||
All local and remote items appear the same. Final Fantasy will say that you received an item, then BOTH the client log and the
|
All local and remote items appear the same. Final Fantasy will say that you received an item, then BOTH the client log and the
|
||||||
emulator will display what was found external to the in-game text box.
|
emulator will display what was found external to the in-game text box.
|
||||||
|
|
||||||
|
## Unique Local Commands
|
||||||
|
The following command is only available when using the FF1Client for the Final Fantasy Randomizer.
|
||||||
|
|
||||||
|
- `/nes` Shows the current status of the NES connection.
|
||||||
|
|
|
@ -1,96 +1,108 @@
|
||||||
### Helpful Commands
|
# Helpful Commands
|
||||||
|
|
||||||
Commands are split into two types: client commands and server commands. Client commands are commands which are executed
|
Commands are split into two types: client commands and server commands. Client commands are commands which are executed
|
||||||
by the client and do not affect the Archipelago remote session. Server commands are commands which are executed by the
|
by the client and do not affect the Archipelago remote session. Server commands are commands which are executed by the
|
||||||
Archipelago server and affect the Archipelago session or otherwise provide feedback from the server.
|
Archipelago server and affect the Archipelago session or otherwise provide feedback from the server.
|
||||||
|
|
||||||
In clients which have their own commands the commands are typically prepended by a forward slash:`/`. Remote commands
|
In clients which have their own commands the commands are typically prepended by a forward slash: `/`.
|
||||||
are always submitted to the server prepended with an exclamation point: `!`.
|
|
||||||
|
|
||||||
#### Local Commands
|
Server commands are always submitted to the server prepended with an exclamation point: `!`. <br/>
|
||||||
|
|
||||||
The following list is a list of client commands which may be available to you through your Archipelago client. You
|
# Server Commands
|
||||||
|
|
||||||
|
Server 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.
|
||||||
|
|
||||||
|
### General
|
||||||
|
- `!help` Returns a listing of available commands.
|
||||||
|
- `!license` Returns the software licensing information.
|
||||||
|
- `!options` Returns the current server options, including password in plaintext.
|
||||||
|
- `!players` Returns info about the currently connected and non-connected players.
|
||||||
|
- `!status` Returns information about the connection status and check completion numbers for all players in the current room. <br /> (Optionally mention a Tag name and get information on who has that Tag. For example: !status DeathLink)
|
||||||
|
|
||||||
|
|
||||||
|
### Utilities
|
||||||
|
- `!countdown <number of seconds>` Starts a countdown using the given seconds value. Useful for synchronizing starts.
|
||||||
|
Defaults to 10 seconds if no argument is provided.
|
||||||
|
- `!alias <alias>` Sets your alias, which allows you to use commands with the alias rather than your provided name.
|
||||||
|
- `!admin <command>` Executes a command as if you typed it into the server console. Remote administration must be
|
||||||
|
enabled.
|
||||||
|
|
||||||
|
### Information
|
||||||
|
- `!remaining` Lists the items remaining in your game, but not where they are or who they go to.
|
||||||
|
- `!missing` Lists the location checks you are missing from the server's perspective.
|
||||||
|
- `!checked` Lists all the location checks you've done from the server's perspective.
|
||||||
|
|
||||||
|
### Hints
|
||||||
|
- `!hint` Lists all hints relevant to your world, the number of points you have for hints, and how much a hint costs.
|
||||||
|
- `!hint <item name>` Tells you the game world and location your item is in, uses points earned from completing locations.
|
||||||
|
- `!hint_location <location>` Tells you what item is in a specific location, uses points earned from completing locations.
|
||||||
|
|
||||||
|
### Collect/Release
|
||||||
|
- `!collect` Grants you all the remaining items for your world by collecting them from all games. Typically used after
|
||||||
|
goal completion.
|
||||||
|
- `!release` Releases all items contained in your world to other worlds. Typically, done automatically by the sever, but
|
||||||
|
can be configured to allow/require manual usage of this command.
|
||||||
|
|
||||||
|
### Cheats
|
||||||
|
- `!getitem <item>` Cheats an item to the currently connected slot, if it is enabled in the server.
|
||||||
|
|
||||||
|
|
||||||
|
## Host only (on Archipelago.gg or in your server console)
|
||||||
|
|
||||||
|
### General
|
||||||
|
- `/help` Returns a list of commands available in the console.
|
||||||
|
- `/license` Returns the software licensing information.
|
||||||
|
- `/options` Lists the server's current options, including password in plaintext.
|
||||||
|
- `/players` List currently connected players.
|
||||||
|
- `/save` Saves the state of the current multiworld. Note that the server auto-saves on a minute basis.
|
||||||
|
- `/exit` Shutdown the server
|
||||||
|
|
||||||
|
### Utilities
|
||||||
|
- `/countdown <number of seconds>` Starts a countdown sent to all players via text chat. Defaults to 10 seconds if no
|
||||||
|
argument is provided.
|
||||||
|
- `/option <option name> <option value>` Set a server option. For a list of options, use the `/options` command.
|
||||||
|
- `/alias <player name> <alias name>` Assign a player an alias, allowing you to reference the player by the alias in commands.
|
||||||
|
|
||||||
|
|
||||||
|
### Collect/Release
|
||||||
|
- `/collect <player name>` Send out any items remaining in the multiworld belonging to the given player.
|
||||||
|
- `/release <player name>` Sends out all remaining items in this world regardless of settings and game completion status.
|
||||||
|
- `/allow_release <player name>` Allows the given player to use the `!release` command.
|
||||||
|
- `/forbid_release <player name>` Prevents the given player from using the `!release` command.
|
||||||
|
|
||||||
|
### Cheats
|
||||||
|
- `/send <player name> <item name>` Grants the given player the specified item.
|
||||||
|
- `/send_multiple <amount> <player name> <item name>` Grants the given player the stated amount of the specified item.
|
||||||
|
- `/send_location <player name> <location name>` Send out the given location for the specified player as if the player checked it
|
||||||
|
- `/hint <player name> <item or location name>` Send out a hint for the given item or location for the specified player.
|
||||||
|
|
||||||
|
<br/> <br/>
|
||||||
|
|
||||||
|
# Local Commands
|
||||||
|
|
||||||
|
This a list of client commands which may be available to you through your Archipelago client. You can
|
||||||
execute these commands in your client window.
|
execute these commands in your client window.
|
||||||
|
|
||||||
The following commands are available in these clients: SNIClient, FactorioClient, FF1Client.
|
The following commands are available in the clients that use the CommonClient, for example: TextClient, SNIClient, etc.
|
||||||
|
|
||||||
- `/connect <address:port>` Connect to the multiworld server.
|
- `/connect <address:port>` Connect to the multiworld server at the given address.
|
||||||
- `/disconnect` Disconnects you from your current session.
|
- `/disconnect` Disconnects you from your current session.
|
||||||
- `/received` Displays all the items you have found or been sent.
|
- `/help` Returns a list of available commands.
|
||||||
|
- `/license` Returns the software licensing information.
|
||||||
|
- `/received` Displays all the items you have received from all players, including yourself.
|
||||||
- `/missing` Displays all the locations along with their current status (checked/missing).
|
- `/missing` Displays all the locations along with their current status (checked/missing).
|
||||||
- `/items` Lists all the item names for the current game.
|
- `/items` Lists all the item names for the current game.
|
||||||
- `/locations` Lists all the location names for the current game.
|
- `/locations` Lists all the location names for the current game.
|
||||||
- `/ready` Sends ready status to the server.
|
- `/ready` Sends ready status to the server.
|
||||||
- `/help` Returns a list of available commands.
|
- Typing anything that doesn't start with `/` will broadcast a message to all players.
|
||||||
- `/license` Returns the software licensing information.
|
|
||||||
- Just typing anything will broadcast a message to all players
|
|
||||||
|
|
||||||
##### FF1Client Only
|
## SNIClient 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.
|
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` Attempts to connect to your SNES device via SNI.
|
||||||
- `/snes_close` Closes the current SNES connection.
|
- `/snes_close` Closes the current SNES connection.
|
||||||
- `/slow_mode` Toggles on or off slow mode, which limits the rate in which you receive items.
|
- `/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 <command text>` 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.
|
|
||||||
|
|
||||||
- `!help` Returns a listing of available remote commands.
|
|
||||||
- `!license` Returns the software licensing information.
|
|
||||||
- `!countdown <countdown in seconds>` Starts a countdown using the given seconds value. Useful for synchronizing starts.
|
|
||||||
Defaults to 10 seconds if no argument is provided.
|
|
||||||
- `!options` Returns the current server options, including password in plaintext.
|
|
||||||
- `!admin <command>` Executes a command as if you typed it into the server console. Remote administration must be
|
|
||||||
enabled.
|
|
||||||
- `!players` Returns info about the currently connected and non-connected players.
|
|
||||||
- `!status` Returns information about your team. (Currently all players as teams are unimplemented.)
|
|
||||||
- `!remaining` Lists the items remaining in your game, but not where they are or who they go to.
|
|
||||||
- `!missing` Lists the location checks you are missing from the server's perspective.
|
|
||||||
- `!checked` Lists all the location checks you've done from the server's perspective.
|
|
||||||
- `!alias <alias>` Sets your alias.
|
|
||||||
- `!getitem <item>` Cheats an item, if it is enabled in the server.
|
|
||||||
- `!hint_location <location>` Hints for a location specifically. Useful in games where item names may match location
|
|
||||||
names such as Factorio.
|
|
||||||
- `!hint <item name>` 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`
|
|
||||||
- `!release` If you didn't turn on auto-release or if you allowed releasing prior to goal completion. Remember that "
|
|
||||||
releasing" actually means sending out your remaining items in your world.
|
|
||||||
- `!collect` Grants you all the remaining checks in your world. Typically used after goal completion.
|
|
||||||
|
|
||||||
#### Host only (on Archipelago.gg or in your server console)
|
|
||||||
|
|
||||||
- `/help` Returns a list of commands available in the console.
|
|
||||||
- `/license` Returns the software licensing information.
|
|
||||||
- `/countdown <seconds>` 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 <player name> <alias name>` Assign a player an alias.
|
|
||||||
- `/collect <player name>` Send out any items remaining in the multiworld belonging to the given player.
|
|
||||||
- `/release <player name>` Releases someone regardless of settings and game completion status
|
|
||||||
- `/allow_release <player name>` Allows the given player to use the `!release` command.
|
|
||||||
- `/forbid_release <player name>` Bars the given player from using the `!release` command.
|
|
||||||
- `/send <player name> <item name>` Grants the given player the specified item.
|
|
||||||
- `/send_multiple <amount> <player name> <item name>` Grants the given player the stated amount of the specified item.
|
|
||||||
- `/send_location <player name> <location name>` Send out the given location for the specified player as if the player checked it
|
|
||||||
- `/hint <player name> <item or location name>` Send out a hint for the given item or location for the specified player.
|
|
||||||
- `/option <option name> <option value>` Set a server option. For a list of options, use the `/options` command.
|
|
||||||
|
|
Loading…
Reference in New Issue