A Basic Guide to Permissions


There have been a lot of questions on the forums about how to set up and configure permissions. So this guide will provide a basic setup and show you how to customize that setup to your liking.

Lets begin:

First off you need to install the permissions plugin and remove the essentials group manager and essentials group bridge from the mod list, then save the profile without restarting.

You should now have a new file plugins/permissions/config.yml and can begin editing it.

Here is an example of what a working permission file looks like:

Code:

plugin:
permissions:
system: default
copies:
groups:
Default:
default: true
info:
prefix: ''
suffix: ''
build: true
inheritance:
permissions:
- 'essentials.help'
- 'essentials.home'
- 'essentials.motd'
- 'essentials.rules'
- 'essentials.sethome'
Moderator:
default: false
info:
prefix: '&d'
suffix: ''
build: true
inheritance:
- Default
permissions:
- 'essentials.tp'
- 'essentials.tphere'
Admins:
default: false
info:
prefix: '&c'
suffix: ''
build: true
inheritance:
permissions:
- '*'
users:
MPUKWebmaster:
group: Admins
permissions:
jamesrwpowell:
group: Admins
permissions:
zipperi:
group: Moderator
permissions:
marksteele:
group: Admins
permissions:
sebastiannkl:
group: Admins
permissions:
rdf:
group: Moderator
permissions:

Now that you know what it looks like, we can begin customizing it to your needs, lets start with groups

Groups


Adding permissions:
To add a permission simply make a new space under the current permissions and press space 12 times (this is important)

Heres an example
Code:

groups:
Default:
default: true
info:
prefix: ''
suffix: ''
build: true
inheritance:
permissions:
- 'essentials.help'
- 'essentials.home'
- 'essentials.motd'
- 'essentials.rules'
- 'essentials.sethome'
- 'example.newpermission' #This is the new line I put in for the new permission

Inheritance:

There is a feature in permissions called inheritance. Basically what this does is allow one group to have all the permissions of another group.

Heres an example:

Code:

groups:
Default:
default: true
info:
prefix: ''
suffix: ''
build: true
inheritance:
permissions:
- 'essentials.help'
- 'essentials.home'
- 'essentials.motd'
- 'essentials.rules'
- 'essentials.sethome'
Example:
default: false
info:
prefix: ''
suffix: ''
build: true
inheritance:
- Default # This is an example of inheritance.
permissions:
- 'essentials.tp'

In this example the Example group gets all the permissions that the Default group has and in addition gets the essentials.tp permission.

Advanced: Removing a Permission

There may be a time when you want a group to inherit all the commands of another group except for certain permissions. you can do this by putting - before the permission.

Heres an example:

Code:

groups:
Default:
default: true
info:
prefix: ''
suffix: ''
build: true
inheritance:
permissions:
- 'essentials.help'
- 'essentials.home'
- 'essentials.motd'
- 'essentials.rules'
- 'essentials.sethome'
Example:
default: false
info:
prefix: ''
suffix: ''
build: true
inheritance:
- Default
permissions:
- '-essentials.motd' # This is an example of removing a permission

In this example the example group gets all the permissions of the default group except for the essentials.motd. That is removed by putting - before it.

Prefixes and Suffixes(Groups)

To add a chat prefix or suffix to a group you simply need to modify the info section. Adding words in the prefix line will add a prefix, and adding words in the suffix line will add a suffix.

Heres an example:

Code:

Admins:
default: false
info:
prefix: 'This is a prefix'
suffix: 'This is a suffix'
build: true
inheritance:
- Default
permissions:
- '*'

note: you may need an additional mod like iChat for this to work.

Things you need to know:

1. putting '*' as a permission gives that group all commands.

Heres an example
Code:

Admins:
default: false
info:
prefix: '&c'
suffix: ''
build: true
inheritance:
permissions:
- '*' # This gives the admin group all usable commands

2. If you use '*' do not have that group inherit any other groups

Heres an example of what NOT TO DO

Code:

Admins:
default: false
info:
prefix: '&c'
suffix: ''
build: true
inheritance:
- Default
permissions:
- '*'

You now know everything you need to set up groups. On to users.

Users

So now you have your groups set up and looking something like this:

Code:

plugin:
permissions:
system: default
copies:
groups:
Default:
default: true
info:
prefix: ''
suffix: ''
build: true
inheritance:
permissions:
- 'essentials.help'
- 'essentials.home'
- 'essentials.motd'
- 'essentials.rules'
- 'essentials.sethome'
Moderator:
default: false
info:
prefix: '&d'
suffix: ''
build: true
inheritance:
- Default
permissions:
- 'essentials.tp'
- 'essentials.tphere'
Admins:
default: false
info:
prefix: '&c'
suffix: ''
build: true
inheritance:
permissions:
- '*'

Its now time to add users into their groups.

Adding a User

to add a user write the following lines and the BOTTOM of the file

Code:

users:
yourminecraftname: # put your minecraft name here
group: youradmingroup # put the name of your admin group here
permissions: # leave this blank

You are now part of the admin group and can now use any permissions that you gave that group. To add more users, simply copy and paste the first one and change the minecraft name and the group.

Note: It is only necessary to add someone under users if they are not in the default group (such as an admin or moderator).

Adding permissions to users

Much like with groups, you can add permissions to users. This means that in addition to the permissions from the group, that user can also use the commands you give them here.

Here is an example:

Code:


rdf:
group: Moderator
permissions:
- 'essentials.afk' # this is an example of giving a permission to a user

In this example, rdf can use all the permissions from the moderator group AND essentials.afk. No other moderator can use essentials.afk unless it was added in the same way as it was in this example.

Adding user prefixes and suffixes

Much like with a group, you can add prefixes and suffixes to usernames. To do this simply add an info section under users.

Heres an example:

Code:

Joshn00b:
group: Admins
info:
prefix: 'Amazing permissions guy'
suffix: 'SexyMofo'
permissions: