[ADMN/DEV] PermissionsBukkit v1.6 - Official Default Groups Plugin [1.1-R5]

PermissionsBukkit - the Official Default Groups Plugin
Current Version: v1.6 (The R5 Update Take Two)
Find PermissionsBukkit on BukkitDev!

If you are getting a specific error or cannot determine what is wrong with your permissions file, filing a ticket on BukkitDev will make me much more likely to respond to you; general questions are best to ask in this thread or on the forums on BukkitDev.

It's been a long time coming, but with the accomplishment of build 1000 Bukkit has finally accomplished a built-in Permissions system (codenamed Superperms). For more info on how they work, and how to integrate them with your plugin, see the official Permissions FAQ. Keep in mind that you should rarely, if ever, have to hook this plugin directly; instead keep things in the realm of checking player.hasPermission("yourplugin.node"). The FAQ thread has more info on how to use Superperms with things like chat prefixes/suffixes.

Features:

• Storage of users and groups in plugins/PermissionsBukkit/config.yml.
• Both users and groups can be assigned individual permissions and parent groups to inherit permissions from.
• Support for global and per-world permissions.
• Reload configuration from file with out reloading the plugin.
• Ability to check if a player has a specific permission node.
• Ability to dump all permissions a player has and the plugins that set them.
• Ability to print plugin, description, and default for a given permission node.
• Ability to modify the permissions of groups and users and the groups of a user in-game.
• Built-in antibuild via the "permissions.build" node (defaults to allowing anyone to build).
• A minimalistic bridge from Permissions 3.0 to Superperms is available as a separate plugin, which does not depend on PermissionsBukkit.

Command Usage:

PermissionsBukkit uses the command /permissions, with aliases /perms and /perm.

/permissions reload - reload the configuration from disk.
/permissions check <node> [player] - check if a player or the sender has a permission (any plugin).
/permissions info <node> - prints information on a specific permission.
/permissions dump [player] [page] - prints info about a player's (or the sender's) permissions.
/permissions group - list group-related commands.
/permissions group list - list all groups.
/permissions group players <group> - list players in a group.
/permissions group setperm <group> <[world:]node> [true|false] - set a permission on a group.
/permissions group unsetperm <group> <[world:]node> - unset a permission on a group.
/permissions player - list player-related commands.
/permissions player groups <player> - list groups a player is in.
/permissions player setgroup <player> <group,...> - set a player to be in only the given groups.
/permissions player addgroup <player> <group> - add a player to a group.
/permissions player removegroup <player> <group> - remove a player from a group.
/permissions player setperm <player> <[world:]node> [true|false] - set a permission on a player.
/permissions player unsetperm <player> <[world:]node> - unset a permission on a player.

All commands have in-game help and are usable from the server console.

Configuration:

A permission node is a string like 'permissions.build', usually starting with the name of the plugin. Refer to a plugin's documentation for what permissions it cares about. Each node should be followed by true to grant that permission or false to revoke it, as in 'permissions.build: true'. Some plugins provide permission nodes that map to a group of permissions - for example, PermissionsBukkit has 'permissions.*', which automatically grants permissions for all PermissionsBukkit commands. You can also specify false for permissions of this type.

Users inherit permissions from the groups they are a part of. If a user is not specified here, or does not have a 'groups' node, they will be in the group 'default'. Permissions for individual users may also be specified by using a 'permissions' node with a list of permission nodes, which will override their group permissions. World permissions may be assigned to users with a 'worlds:' entry.

Groups can be assigned to players and all their permissions will also be assigned to those players. Groups can also inherit permissions from other groups. Like user permissions, groups may override the permissions of their parent group(s). Unlike users, groups do NOT automatically inherit from default. World permissions may be assigned to groups with a 'worlds:' entry.

The cannot-build message is configurable. If it is left blank, no message will be displayed to the player if PermissionsBukkit prevents them from building, digging, or interacting with a block. Use '&' characters to signify color codes.

An example configuration file might look like this:

Code:

users:
    ConspiracyWizard:
        permissions:
            permissions.example: true
        groups:
        - admin
groups:
    default:
        permissions:
            permissions.build: false
    admin:
        permissions:
            permissions.*: true
        inheritance:
        - user
    user:
        permissions:
            permissions.build: true
        worlds:
            creative:
                coolplugin.item: true
        inheritance:
        - default
messages:
    build: '&cYou do not have permission to build here.'

Permissions:

PermissionsBukkit checks for the following permission nodes:

• permissions.build - Allows a player to build. Defaults to true.
• permissions.help - Allows viewing of usage for /permissions.
• permissions.reload - Allows use of /permissions reload.
• permissions.check - Allows use of /permissions reload.
• permissions.info - Allows use of /permissions reload.
• permissions.dump - Allows use of /permissions reload.
• permissions.group.help - Allows viewing of usage for /permissions group.
• permissions.group.list - Allows use of /permissions group list.
• permissions.group.players - Allows use of /permissions group players.
• permissions.group.setperm - Allows use of /permissions group setperm.
• permissions.group.unsetperm - Allows use of /permissions group unsetperm.
• permissions.player.help - Allows viewing of usage for /permissions player
• permissions.player.groups - Allows use of /permissions player groups.
• permissions.player.setgroup - Allows use of /permissions player setgroup.
• permissions.player.addgroup - Allows use of /permissions player addgroup.
• permissions.player.removegroup - Allows use of /permissions player removegroup.
• permissions.player.setperm - Allows use of /permissions player addgroup.
• permissions.player.unsetperm - Allows use of /permissions player removegroup.

Also, the following parent nodes are provided for convenience:

• permissions.* - Maps to permissions.help, .reload, .check, .info, .dump, and to permissions.group.* and permissions.player.*. Defaults to op.
• permissions.group.* - Maps to permissions.group.help, .list, .players, .setperm, and .unsetperm.
• permissions.player.* - Maps to permissions.player.help, .groups, .setgroup, .addgroup, .removegroup, .setperm, and .unsetperm.

Frequently Asked Questions:

Bukkit's Superperms has no built-in concept of a global '*' node that automatically gives all permissions, which is intentional - a player can instead be given all permissions by being given 'op' status (that is, listed in ops.txt). Additionally, individual plugins define a parent node (which could be 'pluginname.*' or 'pluginname.all' or anything else) which maps to whatever subpermissions in that plugin the author desires.

An example is PermissionsBukkit, which provides three such permissions: 'permissions.group.*' for all /permissions group commands, 'permissions.player.*' for all /permissions player commands, and'permissions.*' for all /permissions commands (including permissions.group.* and permissions.player.*).

If you are using SuperpermsBridge, you can do something similar to '*' nodes for plugins which use Permissions 2.7/3.1 - see the next FAQ for more information.

SuperpermsBridge is kind of like FakePermissions for GroupManager or PermissionsBridge for PermissionsEx. Once it's installed, it pretends to be the Permissions plugin and converts any plugins that use Permissions 2.7 or Permissions 3.1 to use Superperms instead.

You can have PermissionsBukkit without SuperpermsBridge or SuperpermsBridge without PermissionsBukkit if you like, but both of these are limited in functionality. If you install SuperpermsBridge without PermissionsBukkit you will not be able to make use of PermissionsBukkit's groups feature or admin commands, and if you install PermissionsBukkit without SuperpermsBridge, plugins that have not updated to use Superperms directly will not function.

For plugins that use Permissions 2.7/3.1, you can use the special node 'superpermbridge.*' to give the equivalent of what used to be the '*' node for plugins that do not use Superperms directly. If you don't want to give the * node, you can also use the node 'superpermbridge.pluginname' to do the equivalent of what used to be the 'pluginname.*' node. Once again, these only apply to plugins that SuperpermsBridge handles and not to plugins using Superperms directly.

The file 'permissions.yml' in the root of your server can be used to set up custom parent permissions. Parent permissions are a single node that, when given to a player or group, automatically give all their children node. Here's a simple example:

Code:

server.basics:
    children:
        commandbook.motd: true
        commandbook.say: true
        commandbook.say.me: true
        commandbook.time: true

Now, if you give a player the node 'server.basics', they automatically get all the nodes listed here. Children may also say 'false' instead of 'true', in which case giving the parent will remove the child instead of giving it.

You can also specify a description if you like, which can be used by plugins to provide information on your node (such as PermissionsBukkit's /perm info command). If you want, you can also provide a default, which can be one of "true", "false", "op", or "notop". CraftBukkit will automatically assign everyone, no one (default), ops, or non-ops the children permissions based on the specified default. Without any plugin like PermissionsBukkit, you can use this defaults system as a limited way to assign people permissions. Here's a more complex example:

Code:

server.basics:
    description: Basic permissions for My Cool Server.
    default: true
    children:
        commandbook.motd: true
        commandbook.say: true
        commandbook.say.me: true
        commandbook.time: true
server.admin:
    description: Admin permissions for My Cool Server.
    default: op
    children:
        commandbook.broadcast: true
        commandbook.teleport: true
        commandbook.kick: true
        commandbook.ban: true

You can also define permissions without children, but this is of limited usefulness in permissions.yml (though is important in plugin.yml; see question #6)

Depends on the Permissions plugin! If you were using PEX's YAML backend, I have a converter done and available on the PermissionsBukkit Tools page. Also available on the tools page is an automatic converter for Essentials GroupManager users.yml and groups.yml files. Automatic converters for Permissions 2.7 and 3.x are on their way, but in the meantime you can still convert your configurations manually.

Bukkit Superperms has no built-in prefix/suffix settings or non-boolean permission nodes, so individual chat plugins will have to start supporting Superperms in order to make use of non-Permissions-plugin based prefixes and suffixes. Herochat, iChat, and Simple Suffix are all aware of the Superperms update, but in the meantime you can use mChat, which already supports Superperms.

Once you install mChat and configure the mchat.prefix, mchat.suffix, and mchat.group names in its configuration file (see the example), use PermissionsBukkit to give players or groups the permissions "mchat.prefix.admin", replacing "admin" with whatever node you configured. For example, with an mchat configuration that looks similar to this:

Code:

da-name-format: '+prefix+name&e'
date-format: HH:mm:ss
message-format: '+prefix+name&f: +message'
mchat:
    prefix:
        admin: '&4DtK [SO] &7 '
        sadmin: '&9DtK [SA] &7 '
        jadmin: '&aDtK [JA] &7  '
        member: '&cDtK [M] &7 '

You can assign players or groups the mchat.prefix.admin node to get the "SO" prefix, mchat.prefix.sadmin to get the "SA" prefix, and so on.

Take a look at this post in Dinnerbone's FAQ for an example. This is a lot like the setup of permissions.yml (see above), but you can also define non-parent permissions (just include description and default and leave out children).

No! PermissionsBukkit is fully updated for 1.1-R5.

Downloads:
Current Version:
PermissionsBukkit v1.5 (jar) (details) Might be buggy, please report any issues!
Old Versions:
PermissionsBukkit v1.2 (jar) (details)
SuperpermsBridge v1.2 (jar) (details) (not recommended)


Changelog:
Wednesday 29 February 2012 (1.6)

• Fixed some massive issues that were caused due to having uploaded a buggy, in-development version instead of 1.5.
• Note: If your configuration was messed up as a result of this issue, the new build should gradually correct it as needed.

Saturday 25 February 2012 (1.5b)

• Revamped to be compatible with R5.
• Fixed issues with permissions not carrying properly on world change.
• Many internal improvements for performance and stability.
• SuperpermsBridge: in honor of R5 removing deprecated code, SuperpermsBridge is officially gone!

Monday 18 July 2011 (1.1/1.2)

• Fix BukkitContrib incompatibility issues.
• Improved the output of the /perm check command.
• Fixed issues when 'users:' is not specified in the config file.
• Fixed the /permissions reload command.
• SuperpermsBridge: improve wildcard handling; in addition to 'superpermbridge.*' and 'superpermbridge.pluginname', now supported are 'superpermbridge.plugin.*', 'superpermbridge.plugin.subnode.*', and so on.

Monday 18 July 2011 (1.0/1.1)

• SuperpermsBridge: adding the special 'superpermbridge.*' and 'superpermbridge.pluginname' nodes (see #2 in the FAQ for details).

Sunday 17 July 2011 (1.0/1.0)

• Initial release of PermissionsBukkit v1.0 and SuperpermsBridge v1.0.