WebHost: Draft of commands documentation.

This commit is contained in:
Hussein Farran 2021-12-02 19:53:58 -05:00
parent 52d8da16f6
commit 385f41d461
2 changed files with 39 additions and 0 deletions

View File

@ -0,0 +1,24 @@
### Helpful Commands
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 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 are always submitted to the server prepended with an exclamation point: `!`.
#### Local Commands
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.
- `/connect <address:port>` 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).
- Just typing anything will broadcast a message to all players
#### Remote Commands
- `!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`
- `!forfeit` If you didn't turn on auto-forfeit or you allowed forfeiting prior to goal completion. Remember that "forfeiting" actually means sending out your remaining items in your world.
- `!collect` Grants you all of the remaining checks in your world. Can only be used after your goal is complete or you have forfeited.
#### Host only (on Archipelago.gg or in your server console)
- `/forfeit <Player Name>` Forfeits someone regardless of settings and game completion status

View File

@ -30,6 +30,21 @@
}
]
},
{
"name": "Archipelago Server and Client Commands",
"description": "A guide detailing the commands available to the user when participating in an Archipelago session.",
"files": [
{
"language": "English",
"filename": "archipelago/commands_en.md",
"link": "archipelago/commands/en",
"authors": [
"jat2980",
"Ijwu"
]
}
]
},
{
"name": "Advanced YAML Guide",
"description": "A guide to reading yaml files and editing them to fully customize your game.",