[ADMN/DEV] PermissionsBukkit v2.0 - Official Default Groups Plugin [1.5.2-R1.0]

PermissionsBukkit - the Official Default Groups Plugin
Current Version: v2.0
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:

Show Spoiler Hide Spoiler

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 setrank <player> <group> - set a player to be in a group with per-group 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:

Show Spoiler Hide Spoiler

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:

Show Spoiler Hide Spoiler

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:

1. Where are my * nodes? (open) 1. Where are my * nodes? (close)

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.

2. How do I use SuperpermsBridge? (open) 2. How do I use SuperpermsBridge? (close)

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.

3. How do I use the root permissions.yml? (open) 3. How do I use the root permissions.yml? (close)

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)

4. How do I switch from (other Permissions plugin)? (open) 4. How do I switch from (other Permissions plugin)? (close)

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.

5. Where are prefixes and suffixes (or option nodes)? (open) 5. Where are prefixes and suffixes (or option nodes)? (close)

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.

6. (Coders) How do I set up my plugin.yml? (open) 6. (Coders) How do I set up my plugin.yml? (close)

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).

7. Is PermissionsBukkit outdated? (open) 7. Is PermissionsBukkit outdated? (close)

No! PermissionsBukkit 2.0 was last updated for 1.3.1-R2.0, is verified to work on 1.4.7-R1.0, and is unlikely to break on future releases.

Downloads:
Current Version:

PermissionsBukkit v2.0 (jar) (details)
Old Versions:
PermissionsBukkit v1.6 (jar) (details)



Changelog:

Friday 7 September 2012 (2.0)

• Fixed a case-sensitivity issue with setting per-world permissions that could cause some permissions to fail to apply.
• Added /perm setrank <player> <group> subcommand (alias rank) with per-group permissions (permissions.setrank and permissions.setrank.<group>)
• Added plugin metrics via http://mcstats.org/plugin/PermissionsBukkitMCStats (disableable in plugins/PluginMetrics/config.yml)

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.

 

So if I use permissions 3.x using superpermsbridge and permissionsbukkit I don't have to change anything and my plugins will work?

WHy is this so complicated, bukkit didn't even need to add permissions.

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

okay so here is my config:

Code:

groups:
    default:
        permissions:
            essentials.signs.disposal.use: true
            iConomy.bank.*: true
            iConomy.access: true
            iConomy.rank: true
            iConomy.list: true
            iConomy.payment: true
            tombstone.use: true
            tombstone.lwc: true
            tombstone.sign: true
            tombstone.quickloot: true
            permissions.build: false
            commandbook.who: true
            commandbook.motd: true
            commmandbook.rules: true
            commandbook.time.check: true
            commandbook.spawn: true
            commandbook.call: true
            commandbook.msg: true
            blift.*: true
            chat.admin: false
            chat.mod: false
            chat.builder: false
            chat.guest: true
    Builder:
        permissions:
            lwc.protect: true
            wolfpound.use: true
            essentials.warp: true
            essentials.tpa: true
            essentials.tpdeny: true
            essentials.tpaccept: true
            essentials.sethome: true
            essentials.home: true
            essentials.back: true
            essentials.protect: true
            essentials.back.ondeath: true
            essentials.warp.list: true
            essentials.tpahere: true
            iConomyChestShop.*: true
            personal.warps.use: true
            lockette.user.create.*: true
            SignShop.Signs.*: true
            residence.create: true
            essentials.me: true
            tombstone.*: true
            worldedit.navigation.jumpto: true
            permissions.build: true
            chat.admin: false
            chat.mod: false
            chat.builder: true
            chat.guest: false
        inheritance:
        - default
    Moderator:
        permissions:
            worldedit.*: true
            lockette.*: true
            BigBrother.*: true
            essentials.tp: true
            essentials.tphere: true
            essentials.setwarp: true
            zombe.allowfly: true
            chat.admin: false
            chat.mod: true
            chat.builder: false
            chat.guest: false
        inheritance:
        - Builder
    Admin:
        permissions:
            worldguard.*: true
            slots.*: true
            vanish.*: true
            SignShops.*: true
            iConomy.*: true
            personal.warps.*: true
            lwc.*: true
            wolfpound.*: true
            antixray.*: true
            kit.admin: true
            permissions.*: true
            commandbook.*: true
            essentials.tpall: true
            essentials.burn: true
            essentials.invsee: true
            essentials.fireball: true
            essentials.home.others: true
            essentials.jump: true
            essentials.top: true
            essentials.joinfullserver: true
            essentials.signs.*: true
            chat.admin: true
            chat.mod: false
            chat.builder: false
            chat.guest: false
        inheritance:
         -Moderator
messages:
    build: '&cYou do not have permission to build here.'

i am an admin and yet i cannot use lwc also my friend is a mod but cannot use world edit but i can
EDIT: i also cannot use vanishnopickup eventhough it clearly states i can

 

Alright, here is my problem. My users do not have access to airships in movecraft, even if they are in the group Lieutenant:
My config:

Code:

users:
    Specops343:
        groups:
        - General
    caelrock:
        groups:
        - architect
    tenkensa:
        groups:
        - servant
    disturbedwarrior:
        groups:
        - major
    elmodag:
        groups:
        - servant
    lord_epic:
        groups:
        - Citizen
    dylan_the_miner:
        groups:
        - Lieutenant
groups:
    Citizen:
        permissions:
            essentials.mail.send: true
            essentials.mail: true
            essentials.msg: true
            essentials.spawn: true
            essentials.suicide: true
            factions.participate: true
            essentials.list: true
            essentials.motd: true
            essentials.home: true
            essentials.sethome: true
            mchat.prefix.Citizen: true
            mchat.suffix.Citizen: true
            permissions.build: true
            falsebook.blocks.*: true
        inheritance:
        - default
    Lieutenant:
        permissions:
            mchat.prefix.Lieutenant: true
            mchat.suffix.Lieutenant: true
            mchat.prefix.SecondLieutenant: false
            mchat.suffix.SecondLieutenant: false
            movecraft.airship*: true
        inheritance:
        - Citizen
    Captain:
        permissions:
            mchat.prefix.Captain: true
            mchat.suffix.Captain: true
            mchat.prefix.Lieutenant: false
            mchat.suffix.Lieutenant: false
        inheritance:
        - Lieutenant
    Major:
        permissions:
            mchat.prefix.Major: true
            mchat.suffix.Major: true
            mchat.prefix.Captain: false
            mchat.suffix.Captain: false
            movecraft.boat.*: true
        inheritance:
        - Captain
    LieutenantColonel:
        permissions:
            movecraft.aircraft.*: true
            mchat.prefix.LieutenantColonel: true
            mchat.suffix.LieutenantColonel: true
            mchat.prefix.Major: false
            mchat.suffix.Major: false
        inheritance:
        - Major
    Architect:
        permissions:
            mchat.prefix.Architect: true
            mchat.suffix.Architect: true
            mchat.prefix.Citizen: false
            mchat.suffix.Citizen: false
            worldedit.*: true
        inheritance:
        - Citizen
    Servant:
        permissions:
            essentials.kick: true
            essentials.tempban: true
            essentials.unban: true
            essentials.ban: true
            essentials.tp: true
            essentials.teleport.cooldown.bypass: true
            essentials.teleport.timer.bypass: true
            essentials.spawn: true
            mchat.prefix.Servant: true
            mchat.suffix.Servant: true
        inheritance:
        - Citizen
    General:
        permissions:
            superpermbridge.*: true
            mchat.prefix.General: true
            mchat.suffix.General: true
            mchat.prefix.Citizen: false
            mchat.suffix.Citizen: false
        inheritance:
        - Citizen

 

change things like 'movecraft.boat.*: true' to 'superpermbridge.movecraft.boat.*'
this must be done for any * nodes for plugins that don't directly support superperms.

 

Thank you sir, apologies for being so naive.

 

I hate to be a bother but can you give a configuration example of how to set custom permissions per world? Thanks. I'm quite confused on it D:

Also I'm wondering that if I set world permissions that if it works through inheritance like permissions? I'm assuming so but just making sure.

 

Just come to post this, I'm getting the exact same thing. Any help?

 

Code:

groups:
    default:
        permissions:
            superpermbridge.worldguard.region.info.*: true
            superpermbridge.worldguard.region.list: true
            PlayerList.players.node: true
        worlds:
            world1:
                giveto.self: true
                magicspells.cast.*: true
           world2:
                giveto.self: false
                magicspells.cast.*: false

 

@Fly007 – There was a small error in the correction @ACStache made to your config; the "inheritance" line and the one following it do not need to be (and should not be) indented more than they were in your original config.

 

I've been having similar problems. Very frustrating. It seems there is a problem with "worlds".

 

I installed the plugin, because I needed it for multiarrow. The problem is (not related to multiarrow, that works fine): default / normal users can't damage a player or a mob! How to add permission for that? What can I do, this is more than weird...

 

I assume you either have some other plugin causing that, or have pvp disabled in the server.properties.

 

When will appear the new version?
Sry, but it sucks, the last relase was 18 July and no changes :/
(PlayerQuit and Permissions after world switch)

 

I found that there is an error when doing it like that and you failed to provide all the infomation to avoid permissions from creative_world being used in Pvp_world it needs to be setup like this to avoid permissions jumping worlds. (well used to any way may of been fixed)

FIXED Sample groups with worlds configuration (open) FIXED Sample groups with worlds configuration (close)

Code:

groups:
    default:
        permissions:
            permission.available.in.all.worlds: true
        world:
            creative_world:
                permission.available.only.in.creative.world: true
                permission.available.only.in.pvp.world: false
            pvp_world:
                permission.available.only.in.pvp.world: true
                permission.available.only.in.creative.world: false

 

I don't like to whine but I must agree. If this is the "official" bukkit group manager you'd think it would be updated to fix such a major bug. Maybe the guy went on vacation or something. For now I'm stuck using this and 3.1.6, oh well.

 

So... any update about superpermsbridgwe not working correctly? In that sense- if i add permissions to my admins (superpermbridge.* or superpermsbridge.*) they don't get the permissions?

 

My understanding is that it doesn't work like that, and there's no way to get an "every single permission" node. (short of creating one yourself in permissions.yml.) you can do individual plugin .* nodes with superpermsbridge.<pluginname>.* (Ex. 'superpermbridge.movecraft.*')

 

Any note about when they gonna dd that? cause otherwise ill stick to permissions 3

 

whoops! didn't realize that. thanks for catching it, going to go edit the post now
edit: fixed it

 

Hello i am very new to bukkit and i was woundring if any 1 can have a look at my permission setup to see if i have done something wrong

http://pastebin.com/PsLk5Rej

 

at a glance it looks fine. what's not working for you? are you getting any errors on server start up (would have been recorded in your server.log file)

 

well for starters if i de op myself i cant kick, ban etc but i have acces to /perm and stuff and also i cant get prefixes to work when im using simple prefix (asked for help in theyr thread for that)

 

kick/ban/time commands are for Ops only or if you get a plugin like CommandBook or DefaultCommands. As for the prefixes, idk how they work.

 

thanks for the help i got everything working now i think.. changed essentials to commandbook and now the prefixes work to

 

I figured it out, it was caused by DefaultCommands plugin. But there are other error, like SimpleTime plugin doesn't work... I don't know if it is related to PermissionBukkit.

 

Ah, interesting, so there's a workaround for the bug with per-world permissions not refreshing properly. Good to know.

No, superpermbridge.* should work. It's not identical to the old *, but it functions as such for plugins that are accessing permissions through the SuperpermBridge. Generally speaking, to get the effect of *, you'll need to add pluginname.* for each plugin, though you can define * in your permissions.yml if you like to make it more concise.

 

Can someone please help me? I've been trying to get help for 2 weeks now on this thread. I have a problem where when i join the server it says [Operator] Thought_Ninja has joined the game (i use mchat) and my prefix comes up in the chat so it is reading that I am in the group Operator, however i have no permissions that an operator should and it lists me as a default user when i do the list command in the console. My config is on the top of page 18 if you need it (I don't want to be a bother an post it again)

--Thought_Ninja

 

so tired of spending hours and hours migrating from one plugin to another, one permission mod to another only to have things not updated and die. This isn't so much a wahhhh post about the plugins / mod in particular but instead a complain about the horrible nature of mods in minecraft in general. It's just such a huge PITA to get anything done as a server admin its ridiculous.

 

Then you're not trying hard enough

 

Hello me again. We just made our server public and got alot of people in and they imidiatly started reporting problems with permissions, apparently they dont get most of the permissions

heres my permission setup

http://pastebin.com/fDzVTUmz

please have a good look i would really like my user to have permissions to go to spawn and use /msg etc