DeluxeGroups/docs/source/commands.rst

29 lines
971 B
ReStructuredText

.. include:: common.rst
.. _deluxegroups_commands:
Commands
========
``/deluxegroups`` - Base command (used for reloading with ``/deluxegroups reload``) |br|
Alias ``/deluxegroup`` and ``/dg``
``/group <sub-command> <arg1> <arg2> <...>`` - Base group command. With no sub-command, it will display your current group.
Sub-Commands
------------
``list [<group>]`` - List the players in your group. If the player is an admin, they can list the players from any group.
``create <name> [<password> <confirm password>]`` - Create a new group, optionally with a password.
``join <name> [<password>]`` - Join an existing group, supplying password if needed.
``leave`` - Leave your current group.
.. warning::
Once all players leave a group, that group will be removed.
``password <group> <new password> <confirm new password>`` - Modify the password of a group. **Currently admin only**
``kick <player>`` - Kicks a player from their group. **Currently admin only**