skywalker3200/MobArena
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Commands documentation (#413)

Browse Source 
* Update Commands documentation (see full commit)

This commit updates the Commands documentation.

* Follows RST document style guide
* Uses active voice / minor edits
* Reorganize structure, use tables

* Address feedback by @garbagemule in #413
This commit is contained in:
Justin W. Flory
2019-01-01 15:03:31 +01:00
committed by garbagemule
parent e40ab31437
commit eb67ec77b9
1 changed files with 102 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/commands.rst
+102 -74
View File
@@ -2,90 +2,118 @@
Commands Commands
######## ########
Note: All MobArena commands start with ``/ma``, and most of them can be This page documents the commands available in MobArena, both for players and
disabled using [[Permissions]]. administrators.
If you are looking for ways to disable non-MobArena commands, look in *Note*: Parentheses (``()``) around an parameter means it's optional (i.e. not
the ``global-settings``-section of the [[config-file setup page\|setting required to work).
up the config-file]].
***************
Player commands Player commands
~~~~~~~~~~~~~~~ ***************
These commands can be issued by all players. They include joining, Any player on the server can use these commands by default.
leaving, spectating and listing arenas as well as listing players.
- ``/ma join (<arena>)`` or ``/ma j (<arena>)`` - Join the arena with +---------------------------+----------------------------+---------------------+
the given name. | Command | Description | Alias |
- ``/ma leave`` or ``/ma l`` - Leave the current arena, or the +===========================+============================+=====================+
spectator area. | ``/ma join (<arena>)`` | Join arena with given name | ``/ma j (<arena>)`` |
- ``/ma notready`` - Get a list of all players who aren't ready. +---------------------------+----------------------------+---------------------+
- ``/ma spec (<arena>)`` or ``/ma s (<arena>)`` - Spectate the arena | ``/ma leave`` | Leave current arena or | ``/ma l`` |
with the given name. | | spectator area | |
- ``/ma arenas`` - Get a list of all arenas. Green names are enabled, +---------------------------+----------------------------+---------------------+
gray names are disabled. | ``/ma notready`` | List players who are not | |
- ``/ma players`` - Get a list of all arena players. | | ready in arena lobby | |
- ``/ma players <arena>`` - Get a list of arena players in the +---------------------------+----------------------------+---------------------+
specified arena. | ``/ma spec (<arena>)`` | Enter an arena's spectator | ``/ma s (<arena>)`` |
- ``/ma class <class>`` - While in the lobby, manually pick the given | | arena | |
class instead of punching signs. +---------------------------+----------------------------+---------------------+
| ``/ma arenas`` | List all arenas. Green | |
| | names are enabled, gray | |
| | names are disabled | |
+---------------------------+----------------------------+---------------------+
| ``/ma players (<arena>)`` | List all players in an | |
| | area | |
+---------------------------+----------------------------+---------------------+
| ``/ma class <class>`` | Manually choose a class in | |
| | an arena lobby (instead of | |
| | punching sign) | |
+---------------------------+----------------------------+---------------------+
**************
Admin commands Admin commands
~~~~~~~~~~~~~~ **************
Only ops and the console can issue these commands. They include Players with OP privileges or assigned permissions can use these commands.
forcefully starting or ending arenas, enabling/disabling individual
arenas or MobArena entirely.
- ``/ma enable`` - Enable MobArena. +-----------------------------+------------------------------------------------+
- ``/ma disable`` - Disable MobArena. | Command | Description |
- ``/ma enable <arena>`` - Enable the arena with the specified name. +=============================+================================================+
- ``/ma disable <arena>`` - Disable the arena with the specified name. | ``/ma enable (<arena>)`` | Enable MobArena (optionally a specific arena) |
- ``/ma force end`` - Forcefully end all arenas. +-----------------------------+------------------------------------------------+
- ``/ma force end <arena>`` - Forcefully end the arena with the | ``/ma disable`` | Disable MobArena (optionally a specific arena) |
specified name; forces all players to leave. +-----------------------------+------------------------------------------------+
- ``/ma force start <arena>`` - Forcefully start the arena with the | ``/ma force end (<arena>)`` | Forcefully end all arenas or a specific arena |
specified name; forces all players who aren't ready to leave. +-----------------------------+------------------------------------------------+
- ``/ma notready <arena>`` - Get a list of all players in the given | ``/ma force start <arena>`` | Forcefully start an arena (players that aren't |
arena who aren't ready. | | ready are removed from arena) |
- ``/ma restore <player>`` - Restore the inventory of the player with +-----------------------------+------------------------------------------------+
the given name, if possible. | ``/ma notready <arena>`` | List all players in an arena that aren't ready |
- ``/ma config reload`` - Reload the config-file into memory. This is +-----------------------------+------------------------------------------------+
useful if changes are made in the config-file while the server is | ``/ma restore <player>`` | Restore a player's inventory (if possible) |
running. +-----------------------------+------------------------------------------------+
| ``/ma config reload`` | Reload config file into memory |
+-----------------------------+------------------------------------------------+
**************
Setup commands Setup commands
~~~~~~~~~~~~~~ **************
Only ops (and the console, if it makes sense) can issue these commands. Players with OP privileges or assigned permissions can use these commands.
They include setting warp points, spawnpoints and region points.
- ``/ma setup <arena>`` - Enter [[Setup Mode\|Arena Setup]] for the +-----------------------------+------------------------------------------------+
given arena. | Command | Description |
- ``/ma addarena <arena>`` - Create a new arena-node in the current +=============================+================================================+
world. | ``/ma setup <arena>`` | Enter Setup Mode for an arena (see |
- ``/ma delarena <arena>`` - Delete the arena with the given name. | | :doc:`arena-setup` for more info) |
- ``/ma editarena <arena>`` - Toggle Edit Mode for the given arena. +-----------------------------+------------------------------------------------+
- ``/ma editarena <arena> [true|false]`` - Turn on or off Edit Mode for | ``/ma addarena <arena>`` | Create new arena node in current world |
the given arena. +-----------------------------+------------------------------------------------+
- ``/ma setting <arena>`` - List all per-arena settings for the given | ``/ma delarena <arena>`` | Delete arena with given name |
arena. +-----------------------------+------------------------------------------------+
- ``/ma setting <arena> <setting>`` - Check the current value of the | ``/ma editarena <arena>`` | Toggle Edit Mode for an arena |
given setting for the given arena. +-----------------------------+------------------------------------------------+
- ``/ma setting <arena> <setting> <value>`` - Set the value of the | ``/ma editarena <arena>`` | Turn Edit Mode on or off for an arena |
given setting for the given arena to the given value. | ``[true|false]`` | |
- ``/ma checkspawns`` - Shows the spawnpoints (of the arena you are +-----------------------------+------------------------------------------------+
currently standing in) which cover your current location as red wool | ``/ma setting <arena>`` | List per-arena settings for an arena |
blocks. This command can be used to check if specific points in your +-----------------------------+------------------------------------------------+
arena are actually covered by spawnpoints or not. | ``/ma setting <arena>`` | Check current value of a setting for an arena |
- ``/ma classchest <class>`` - While looking at a chest, link the chest | ``<setting>`` | |
to the given class as a [[linked class chest\|Class Chests]]. Linking +-----------------------------+------------------------------------------------+
a class chest means MobArena will always copy the items from the | ``/ma setting <arena>`` | Change a setting for an arena to given value |
linked chest, regardless of any local class chests in arena lobbies. | ``<setting> <value>`` | |
This is useful if you want a global class chest for a class. +-----------------------------+------------------------------------------------+
- ``/ma auto-generate <arena>`` - Auto-generate a new arena with the | ``/ma checkspawns`` | Show all spawnpoints in arena you are standing |
given name. The arena will be generated just below the player in the | | in as red wool blocks (helpful to check |
world they are standing in. | | spawnpoint coverage) |
- ``/ma auto-degenerate <arena>`` - Degenerate the arena with the given +-----------------------------+------------------------------------------------+
name, effectively restoring the patch that was "bulldozed" with the | ``/ma classchest <class>`` | Create a linked class chest for a class (see |
auto-generator. | | :doc:`class-chests` for more info) |
+-----------------------------+------------------------------------------------+
| ``/ma auto-generate`` | Auto-generate new arena with given name |
| ``<arena>`` | (generated directly below player) |
+-----------------------------+------------------------------------------------+
| ``/ma auto-degenerate`` | Degenerate an auto-generated arena with given |
| ``<arena>`` | name |
+-----------------------------+------------------------------------------------+
***********
Permissions
***********
See :doc:`permissions`.