Commands - PEXPlugins/PermissionsEx GitHub Wiki
PEX provides a rich command system, allowing you to control almost every aspect of PEX from either the server console or in game.
Help plugin support is also implemented (if installed, of course). Just type /help PermissionsEx.
Please note that with commands like "pex user <user> prefix [newprefix]", the [newprefix] value has to be enclosed in double quotes if you intend to use spaces.
- Arguments surrounded with <> are required
- Arguments surrounded with [] are optional
- Arguments such as <user> and <group> are to be replaced with a user or group name. They are not literal node names.
- Utility commands
- World-inheritance management
- User commands
- User's permission management
- User's group management
- Default groups management
- Group commands
- Group's user management
| Command | Permission | Description |
|---|---|---|
| pex | permissions.manage | Display help |
| pex toggle debug | permissions.debug | Enable/disable debug mode (WARNING: This will produce **many** entries in your server.log file. Use this only for debugging!) |
| pex user <user> toggle debug | permissions.debug.<user> | Enable/disable debug mode on one specific user (WARNING: This can still produce **many** entries in your server.log file. Best used immediately _before_ and _after_ a user executes an action or command.) |
| pex user <user> check <permission> | permissions.manage.<user> | Checks 1 specific permission against 1 specific user |
| pex reload | permissions.manage.reload | Reload the pex environment |
| pex config <node> [value] | permissions.manage.config | Print <node> value from plugin configuration. Specify [value] to set a new value |
| pex backend | permissions.manage.backend | Print the currently used backend |
| pex backend <backend> | permissions.manage.backend | Change the permissions backend on-the-fly (Use with caution!) Note that this will only change the backend on-the-fly, it will not save the change in the config file, nor will it convert anything. This is for testing only.) |
| pex hierarchy | permissions.manage.users | Print the complete user/group hierarchy |
| pex import <backend> | permissions.manage.dump | Import users/groups from selected format |
| pex users cleanup <group> [threshold] | permissions.manage.users.cleanup | Remove "dead" users from the file. [threshold] is in days and defaults to 30 |
World Inheritance Management (top)
| Command | Permission | Description |
|---|---|---|
| pex worlds | permissions.manage.worlds | Print the worlds PEX and the server know of |
| pex world <world> | permissions.manage.worlds | Print the <world> inheritance info |
| pex world <world> inherit <parentWorlds> | permissions.manage.worlds.inheritance | Set the parent worlds for <world>. <parentWorlds> can be just one world, or a comma-separated list of worlds. |
User commands (top)
| Command | Permission | Description |
|---|---|---|
| pex users list | permissions.manage.users | List all users defined in the permissions file |
| pex users | permissions.manage.users | List all users defined in the permissions file (alias to users list) |
| pex user | permissions.manage.users | List all users defined in the permissions file (alias to users) |
User's permission management (top)
| Command | Permission | Description |
|---|---|---|
| pex user | permissions.manage.users | List the registered users |
| pex user <user> | permissions.manage.users.permissions.<user> | List the permissions for <user> (alias to user <user> list) |
| pex user <user> prefix [newprefix] | permissions.manage.users.prefix.<user> | Get or set the prefix for <user> |
| pex user <user> suffix [newsuffix] | permissions.manage.users.suffix.<user> | Get or set the suffix for <user> |
| pex user <user> delete | permissions.manage.users.<user> | Remove <user> from the permissions file |
| pex user <user> list [world] | permissions.manage.users.permissions.<user> | List the permissions for <user> . Shows the permissions assigned to the user directly as well as those assigned via the group the user is a member of. Specify [world] to list the users permission for a single world |
| pex user <user> add <permission> [world] | permissions.manage.users.permissions.<user> | Add <permission> to <user>. Specify [world] to grant/deny permission only in [world] |
| pex user <user> remove <permission> [world] | permissions.manage.users.permissions.<user> | Remove <permission> from <user>. Specify [world] to remove permission only from [world] |
| pex user <user> timed add <permission> <lifetime in seconds> [world] | permissions.manage.users.permissions.timed.<user> | Add timed <permission> to <user> for <lifetime in seconds> in [world] |
| pex user <user> timed remove <permission> <lifetime in seconds> [world] | permissions.manage.users.permissions.timed.<user> | Remove timed <permission> from <user> for <lifetime in seconds> in [world] |
| pex user <user> set <option> <value> [world] | permissions.manage.users.permissions.<user> | Set <option> to <value>. Set value to "" (two double-quotes) if you want to remove the <option>. Specify [world] to set <option> only in [world] |
User's group management (top)
| Command | Permission | Description |
|---|---|---|
| pex user <user> group list | permissions.manage.membership.<user> | List all groups the <user> is currently in |
| pex user <user> group add <group> [world] [lifetime] | permissions.manage.membership.<group> | Add <user> to <group>. Optional param lifetime (in seconds) is used to make timed membership. You can replace world by '*' if the group of the user is applied for all worlds and you want applied a lifetime. |
| pex user <user> group set <group> [world] | permissions.manage.membership.<group> | Set <user> group to <group>. Note that this command removes the user from any other groups they are a member of. |
| pex user <user> group remove <group> [world] | permissions.manage.membership.<group> | Remove <user> from <group> |
Default groups management (top)
| Command | Permission | Description |
|---|---|---|
| pex default group [world] | permissions.manage.groups.inheritance | Print the default groups for specified world. If [world] is not specified, it will apply to the global config. |
| pex set default group <group> <value> [world] | permissions.manage.groups.inheritance | Set the default flag of <group> in [world]. Any number of groups can have this flag set. If [world] is not specified, it will apply to the global config. <value> is boolean 'true' or 'false'. |
Group commands (top)
| Command | Permission | Description |
|---|---|---|
| pex group | permissions.manage.groups.list | List all registered groups (alias to groups list) |
| pex groups | permissions.manage.groups.list | List all registered groups (alias to groups list) |
| pex groups list | permissions.manage.groups.list | List all registered groups |
| pex group <group> prefix [newprefix] | permissions.manage.groups.prefix.<group> | Get or set the prefix for <group> |
| pex group <group> suffix [newsuffix] | permissions.manage.groups.suffix.<group> | Get or set the suffix for <group> |
| pex group <group> create [parents] | permissions.manage.groups.create.<group> | Create <group>. Specify [parents] to set the groups it inherits from |
| pex group <group> delete | permissions.manage.groups.remove.<group> | Remove <group> |
| pex group <group> parents list | permissions.manage.groups.inheritance.<group> | List the parents for <group> |
| pex group <group> parents set <parents> | permissions.manage.groups.inheritance.<group> | Set the parent(s) for <group> (single or comma-separated list) |
| pex group <group> | permissions.manage.groups.permissions.<group> | List all <group> permissions (alias to group <group> list) |
| pex group <group> list [world] | permissions.manage.groups.permissions.<group> | List all permissions for <group>. Specify [world] to list the group's permissions for [world] |
| pex group <group> add <permission> [world] | permissions.manage.groups.permissions.<group> | Add <permission> to <group> |
| pex group <group> remove <permission> [world] | permissions.manage.groups.permissions.<group> | Remove <permission> from <group>. Specify [world] if this permission should be removed only in [world] |
| pex group <group> timed add <permission> [lifetime] [world] | permissions.manage.groups.permissions.timed.<group> | Add timed <permission> to <group> with [lifetime] in [world] |
| pex group <group> timed remove <permission> [world] | permissions.manage.groups.permissions.timed.<group> | Remove timed <permission> for <group> in [world] |
| pex group <group> set <option> <value> [world] | permissions.manage.groups.permissions.<group> | Set <option> <value> for <group>. Set value to "" (two double-quotes) if you want to remove the <option>. Specify [world] if the option should be set only in [world] |
| pex group <group> weight [weight] | permissions.manage.groups.weight.<group> | Prints the weight value of <group> in 'calories' where a lower value has _more_ priority than a group with a higher value. i.e., 1 has more priority than 2, 2 more than 3, etc. If [weight] is defined when using this command, sets the weight value of <group> to [weight]. |
Group's user management (top)
| Command | Permission | Description |
|---|---|---|
| pex group <group> users | permissions.manage.membership.<group> | List all users in <group> |
| pex group <group> user add <user> | permissions.manage.membership.<group> | Add <user> to <group> (single or comma-separated list) |
| pex group <group> user remove <user> | permissions.manage.membership.<group> | Remove <user> from <group> (single or comma-separated list) |
| pex promote <user> <ladder> | permissions.user.promote.<ladder> | Promote <user> on <ladder>. If <ladder> is not specified, the default ladder (named default) will be used. |
| pex demote <user> <ladder> | permissions.user.demote.<ladder> | Demote <user> on <ladder>. If <ladder> is not specified, the default ladder (named default) will be used. |
| Previous: Ranks (Promotion and Demotion), Next: Integrating with PEX |