TShock for Terraria

TShock for Terraria

Stuff

Get Started    Questions

Advanced User Management

Permissions and Advanced User Group Configuration

You might want to create or delete user groups. This can be easily done using the /group add [name] [optional permissions] command. This can add the group with the name specified and also give it any initial permissions you wish to provide. You can then delete user groups with the /group del [name] command. This will simply remove the group of the specified name.

You may also gather information about the user groups currently a part of your server. To find out which groups your server has you can use the /group list command. This will output all of the groups that are a part of your server. You can also find which permissions are a part of a group using the command /group listperm [group name]. This will output which permissions are granted to the specified group.

Now that you're able to organize your players into separate groups, you may want to allow or disallow them from performing specific actions. This can easily be done with the /group command as well.

The /group command also allows you to add or delete permissions for a specific group. To re-iterate, permissions are special settings that allow a group to perform certain actions.
The /group command has several sub-commands that allow for all sorts of group management.
The subcommands will now be listed exactly as I listed the user sub-commands:

Group Sub-Commands

Sub-command: add

  • Arguments: [group] [permissions]
  • Description: Allows you to create a new group with the name given and with the permissions provided.
  • Example Usage
  • /group add admin tshock.admin.warp

Sub-command: addperm

  • Arguments: [group] [permissions]
  • Description: Allows you to add permissions to a specific group. You may add permissions to all groups at once by using "*" in place of the group name. (Without the quotes)
  • Example Usage
  • /group addperm * tshock.warp

Sub-command: parent

  • Arguments: [group] [\new parent group]
  • Description: Allows you to set the parent of a group to another group. This means that the 'child' group will inherit all of the permissions of the 'parent' group.
  • Example Usage
  • /group parent admin newadmin

Sub-command: suffix

  • Arguments: [group] [suffix]
  • Description: Allows you to set the suffix of a group. This is text that will appear after the name of the group member but before their message in chat.
  • Example Usage
  • /group suffix admin "the Valiant"

Sub-command: prefix

  • Arguments: [group] [prefix]
  • Description: Allows you to set the prefix of a group. This is text that will appear before the name of the group member in their chat messages.
  • Example Usage
  • /group prefix admin "Admin"

Sub-command: color

  • Arguments: [group] [color (000,000,000)]
  • Description: Allows you to set the chat color of a group. The color must be in this format "R,G,B". R, G, or B must be a whole number between 0 and 255 representing its respective specific color in the RGB color scheme.
  • Example Usage
  • /group color admin 255,0,0

Sub-command: del

  • Arguments: [group]
  • Description: Deletes the specified group entirely.
  • Example Usage
  • /group del admin

Sub-command: delperm

  • Arguments: [group] [permission]
  • Description: Allows you to take away a permission from a specific group. This denies them access to all of the commands associated with the permission.
  • Example Usage
  • /group delperm newadmin ban

Sub-command: list

  • Arguments: [page]
  • Description: Lists all of the current groups.
  • Example Usage
  • /group list

Sub-command: listperm

  • Arguments: [group] [page]
  • Description: Lists all of the commands for a specific group.
  • Example Usage
  • /group listperm admin

Sub-command: help

  • Arguments: None
  • Description: Displays information about the usage of the /group command and its sub-commands.
  • Example Usage
  • /group help

Advanced User Management


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.