Minecraft / Blogs

CraftBukkit Plugin Tutorials: PermissionsEx (15,000+ Views) (Recommended by the plugin author!)

  • 38
  • 11
  • comment171
  • playlist_add
  • share
  • more_horiz
avatar BENNETTMAN
Level 47 : Master Narwhal
32

I NO LONGER GIVE SUPPORT ON THIS BLOG POST, IT IS OUTDATED. I WILL BE WRITING A NEW BPERMISSIONS TUTORIAL IN THE NEAR FUTURE.

CraftBukkit Plugin Tutorials


Plugin:
PermissionsEx
Version: 1.17
Author: t3hk0d3
Works with: CraftBukkit 1.0.0-R1
Download: Here
Download tutorials files (Important!): Here
This tutorial has been recommended by the plugin author himself, so you know it's gonna work!
Check out the mention in the post: Here

I noticed a lot of people in the forums asking for help with their servers permissions set up.I decided to give a full a tutorial as possible on using the most powerful and efficient permissions system available, PermissionsEx.This plugin, along with ModifyWorld and ChatManager (which both come with PermissionsEx), gives you complete control over what goes on in your server.
Before we get started, i suggest you head over to this link, and download 'NotePad++', the best text editor work working with YML files.If you do not want to download this program, that is fine, but NotePad++ will make your life 10 times easier, and it is highly recommended.You will also need to download the files i have provided using the link provided in the description above.

Installing PermissionsEx

Head to the link at the top of this post, and scroll down the post. Download the 'Latest Development Version'.Once downloaded, open up the .zip folder in either WinRAR or 7zip.
You should have FIVE.jar files:
  • PermissionsEx
  • Permissions
  • ModifyWorld
  • ChatManager
  • PermissionsEx-javadoc
Extract these files into your servers plugins directory, making sure any old permissions system you use has been deleted.DO NOT EXTRACT THE 'PermissionsEx-javadoc.jar', this is only used if you are a craftbukkit plugin developer, javadocs are simply a library of explanations for the API.Run your server, and the plugins will generate the necessary files and folders needed to set up your permissions system.

Configuiring PermissionsEx

Once the server has finished loading, stop your server, and go to your plugins directory.You will now find there are four new folders, one for each of the .jar files your loaded into your server.
First of all, go to the '/plugins/PermissionsEx' folder, inside you will find a 'config.yml' and a 'permissions.yml'.Ignore the 'config.yml', you do not need to do anything with this.
Now, open up the 'UsingPermissionsEx.zip' folder you downloaded from the link at the top of the page.Inside you will find a file called 'permissions.yml'. You now need to replace the 'permissions.yml' in the /plugins/PermissionsEx directory, with the one i have given you in the 'UsingPermissionsEx.zip'.
Now open it, and inside you will see i have already prepared the basic bones of the system for you.You may change the names of these groups as you wish, simply highlight the group name, and type out a new name. This will avoid messing up the spacing, causing the plugin to fail to load.
Now you may begin to configure the permissions, REMEMBER, never use tabs, as YML files dislike them, and it will cause your system to break.

Adding Permissions:
Each group/user has a permissions list, all nodes you want available to a player/group must be defined in their list.
For example:
groups:
Default:
default: true
prefix:
suffix:
permissions:
- modifyworld.chat

This allows any member in the group 'Default' to chat on the server.
This permission is needed for players to chat, as it is a part of ModifyWorld, which we will go into with more detail later.

You can also add negative permissions, that will disallow users access to that permission, for example.
groups:
Default:
default: true
prefix:
suffix:
permissions:
- -modifyworld.chat

This will disallow players in this group to use the servers chat. This is useful for not allowing users to speak until they have been promoted to a higher rank, that has access to 'modifyworld.chat', very useful for battling those spammers!
Permissions can be given on a per-world basis, which is great for multi-world servers. So let's say for example you have a creative world, and a survival world, and you want a group to be able to spawn items in creative, but not survival (using the plugin 'Essentials' as an example', you would write this as:

groups:
Default:
default: true
prefix:
suffix:
permissions:
worlds:
creative:
permissions:
- essentials.item
survival:
permissions:

By giving the permission on a per-world basis, rather than defining it in the groups main permissions list, the group can now spawn items in the creative world, but because you haven't defined the permission in the survival worlds permissions, they do not have the permission to spawn items when in that world.When giving permissions on a per-world basis, the world name must be the same as the name of the world folder found in your server directory. All group/user/world names are CASE-SENSITIVE.

Finally, permissions can be given on a per-user basis also, which will override the group they are in, and give them their own personal permissions, plus the groups. You can define these by doing this:

users:
PLAYERNAME:
group:
- Default
permissions:
- essentials.item

This means that even if the group they are in has not got the 'essentials.item' permission, this user will have permission to use it.
In the 'UsingPermissionsEx.zip' folder i have provided, there is a file named 'Permissions-Set-Up.yml'.This file goes into detail about what each section of the permissions.yml is used for, and how to set up your permissions system without any error.

You can add permissions to a group in-game or via the console by using the command:

/pex group [group] add [permissions]

Replacing '[group]' with a group name, and '[permission]' with a permission node.

Applying players to groups.


There are two easy ways to assign players to groups, either by manually adding a group name to a user in the users section, like so:

users:
YOURNAMEHERE:
group:
- Owner

Or by using in-game commands (providing you have permissions to, but for simplicity, i have added the correct permissions to the highest ranking group in the permissions.yml file i have given you), via a chat command or through the console., like so:

/pex user [playername] group set [group]

Replacing '[playername]' with a players name, and '[group]' with a group name.

Using ModifyWorld.


ModifyWorld is a plugin which comes included with PermissionsEx, and provides a number of different permissions which control the way your users behave on your server, for example whether they can speak, use Minecarts/Boats, or even use beds.All of these nodes can be given in the same way any other node can, be it global, per-world, or per-user.
The use of negative nodes are not needed, if you do not want a group/user to be able to access a permission, simply do not define it.There is a file in the 'UsingPermissionsEx.zip' folder that lists all of the different permission nodes linked with Modifyworld, how to use them, and what they control.
PLEASE NOTE: You MUST give the relevant ModifyWorld permissions to your users, if you skip this step and do not give any of the nodes, your users will not be able to speak, or do anything.
Please remember to go into the config.txt for ModifyWorld, and set 'Enable' to true.

Using ChatManager.


Please remember to go into the config.txt for ChatManager, and set 'Enable' to true.
ChatManager is a server chat plugin desinged for use with PermissionsEx, it allows your users/groups to have prefixes/suffixes assigned to their names, for example: [Server][Owner] Playername'.
I do not recommend running this alongside any other chat formatting plugin, as they could intefere with each other. I advise removing other chat plugins, such as HeroChat, iChat, etc, and just using ChatManager, as it works perfectly with PermissionsEx, and other plugins such as Factions that add a prefix.

Configuiring ChatManager:

Go to your /plugins/ChatManager directory, and open the 'config.yml'. Replace the text in that file with this set up i have created in advance, to give a result that will look like the example above:

chat-range: 100.0
display-name-format: '%prefix%suffix%player'
global-message-format: <%prefix|%suffix%player> &e%message
enable: true
message-format: <%prefix%suffix%player> %
messageranged-mode: false

Hit save.

Giving a group a prefix/suffix:
Go back to you /plugins/PermissionsEx, and open the 'permissions.yml' file again.
You will notice under each group name i have placed two sections named prefix, and suffix.Adding these prefixes and suffixes is incredibly easy, and can look however you like.
In the file, i have given an example under the Default group that looks like this:

groups:
Default:
default: true
prefix: '&6[&7Default&6] &f'
suffix: '&f'
permissions:

The '&6, &7, and &f' denote colours/colors.
So in actual fact, this prefix would be displayed as:

[Default]

Since we have given a suffix of '&f', this means anything after the code will be displayed as white, meaning the PLAYERNAME and MESSAGE.
We can also use the suffix as an extra prefix, by typing something like this:

groups:
Default:
default: true
prefix: '&1[&2Server&1]'
suffix: '&6[&7Default&6] &f'
permissions:

Which will be displayed as:

[Server][Default]

And because we added '&f' the text after the suffix will be white, like the PLAYERNAME and MESSAGE.

Everything Else.


This was just a quick, basic tutorial for those were confused by permissions, if i have confused you even more i apologise, and if i have missed something, or you run into errors, please comment on this blog, or send me a PM, and i will help you the best i can.
For a full list of commands/permissions, and more in-depth set-up guides relating to PermissionsEx, go to: http://forums.bukkit.org/threads/admn-dev-permissionsex-pex-v1-14-tomorrow-is-today-1240.18140/
Creditt3hk0d3, Bukkit Logo Pixelart by: Eplemosen
Tags

5 Update Logs

Update #5 - Reformatted! : 12/20/2011 1:41:17 pmDec 20th, 2011

Formatting bug has been fixed, so now i have fixed up the ugly mess this blog had become.
I will be updating this tutorial for the latest version of PermissionsEx, with easier methods to achieve the things covered in this tutorial.

Also, we got over 10,000 views!
LOAD MORE LOGS

171 replies

1
10/16/2013 3:06 am
Level 33 : Artisan Geek
PPG
i accidently removed the config file plz send a link!?!? ?D:
1
06/28/2013 2:42 pm
Level 2 : Apprentice Miner
YYs100
Stop Advertising on others posts. Just start a new one of your own to do advertise.
1
01/10/2013 9:34 pm
Level 1 : New Explorer
NiteShadow7
Sweet! I've just received my free minecraft giftcode!

>> Minecraftcodes.info <<
1
12/07/2012 7:57 am
Level 9 : Apprentice Explorer
3skandar
You still active on commentin this post? I thoughyou wasnt
1
10/22/2012 4:59 am
Level 1 : New Miner
JAGGEZII
This is so cool! :D

Join my server!
pvp-riding-MCMMO-factions-shops and more!
89.255.132.113:25582
www.projectzedd.eu
1
10/22/2012 6:31 am
Level 47 : Master Narwhal
BENNETTMAN
1
10/09/2012 9:17 pm
Level 12 : Journeyman Miner
Zakoschris
if you suck my dick ill give you a peice of bacon mr.narwal
1
10/16/2012 7:27 am
Level 47 : Master Narwhal
BENNETTMAN
Why are people still commenting on this.
It hasn't been updated in 10 months.
Especially unnecessary waste of time comments like this, any real point, or are you trying to be funny on a old submission that isn't monitored?
1
10/04/2012 1:58 am
Level 11 : Journeyman Network
kraiku
Wow very nice tutorial I can now start on all my ranks and perms
1
07/12/2012 3:40 pm
Level 1 : New Miner
OObOO64
MC Olympia spoutcraft guns factions prision style!
108.163.251.100:25579
1
07/25/2012 10:02 am
Level 47 : Master Narwhal
BENNETTMAN
Don't advertise servers on another members submissions.
Does anybody on this site have any grasp on courtesy these days?
There are sections for that, my OLD DEAD submission isn't one of them.
1
06/04/2012 1:54 pm
Level 5 : Apprentice Architect
avianmax
could someone please help me out with my yml permission..ive done everything in this tutorial but nothing works. i will send you my whole plugins file if you decide to help Thanks!
1
05/28/2012 4:31 am
Level 3 : Apprentice Explorer
soccerrocks1
It says I don't have permission for the group Owner, but I am the owner of the server and I am op... any help? Also I am using a mac.
1
05/22/2012 8:47 pm
Level 27 : Expert Pokemon
Hzabooboo
1
06/03/2012 4:57 pm
Level 47 : Master Narwhal
BENNETTMAN
Don't advertise your work on other peoples posts.
1
06/03/2012 5:36 pm
Level 27 : Expert Pokemon
Hzabooboo
I'm so sorry I didn't know
1
04/05/2012 6:23 am
Level 6 : Apprentice Miner
TheNikkoCraft
BENNET, how do I do so like Default can chat? I have this problem on my server that anyone can't chat? Please help, fast! I wan't everyone to chat!
1
03/14/2012 8:07 pm
Level 1 : New Explorer
Arrow2Knee
Is There a way to make Inheritances IF so show me the Correct format or if you wan't edit the Post.
1
03/02/2012 10:33 am
Level 14 : Journeyman Modder
kuchiyo
My permission's prefixes wont work can someone help me? This is admin rank: Admin:
default: false
permissions:
- '*'
- mcbans.*
inheritance:
- moderator
info:
prefix: '&4[Admin]&f'
build: true
suffix: '&f'

with this ingame: <kuchiyo>
1
03/12/2012 6:51 pm
Level 7 : Apprentice Network
Piragi
its not formatted right I think.
groups:
Admin:
default: true
info:
prefix: '&a[Admin]&f'
suffix: '&f'
build: true
inheritance:
- Mod The inheritance rank can be of any rank before it.
permissions:
- permissions.node

You need to configure it like that. if it is the first rank on the list it has to have
groups:
Admin:
default: true
info:
prefix: '&a[Admin]&f'
suffix: '&f'
build: true
inheritance
- Mod
permissions:
- permissions.node

Keep in mind that the prefix and suffix codes can be any colors. A link to every color is:
www.minecraftwiki.net/wiki/Classic_server_protocol at the bottom of the page.
1
02/28/2012 3:09 pm
Level 1 : New Miner
Lemonhands
Hi, I am having a bit of trouble using permissions on my server, when I start it it tells me that permissions.yml is empty, ignoring it, also I can't use permissions even though I am owner or add colours to prefixes, could someone please help, this is my .yml file on Pastie:
http://pastie.org/3473397
1
03/02/2012 8:42 pm
Level 2 : Apprentice Miner
PotatoCraft123
ERROR:

while scanning an anchor
in "<unicode string>", line 5, column 18:
suffix: '&f'
^
expected alphabetic or numeric character, but found "'"
in "<unicode string>", line 5, column 20:
suffix: '&f'
1
02/27/2012 4:24 pm
Level 25 : Expert Explorer
rudolpho
How to make that, so new players automatically join in to default group ?

default : true is not working.
1
03/12/2012 6:52 pm
Level 7 : Apprentice Network
Piragi
that should work. Make sure they have not joined before, then make sure no other rank has default set to true.
1
02/24/2012 5:29 pm
Level 10 : Journeyman Engineer
littlehughes
Now I am getting this message:

174 recipes
27 achievements
17:27:54 [INFO] Starting minecraft server version 1.1
17:27:54 [INFO] Loading properties
17:27:54 [INFO] Starting Minecraft server on *:25565
17:27:54 [INFO] This server is running CraftBukkit version git-Bukkit-1.1-R3-b1846jnks (MC: 1.1) (Implementing API version 1.1-R3)
17:27:56 [SEVERE] mapping values are not allowed here
in "<reader>", line 3, column 16:
default: true
^
1
02/19/2012 10:19 pm
Level 13 : Journeyman Taco
Ga55246
Would you please just tell me how to fix this, when I try to change somebody's rank I get this, "Player not in this ladder." and when I can set their group they still appear as [Guest] instead of whatever rank i need them to be. So you can see if any of my plugins aren't compatible with PermissionsEx, Here are my .jars that are in my plugins folder.

AntiCreeper, BKCommonLib,ChatManager, Essentials,EssentialsChat(GeoIP, GroupBridge, Protect, Spawn, XMPP, iConomy, Lockette, Log, MobDisguise, Modifyworld, nc (no clue what that is), NoCheat, NoLagg, Permissions, PermissionsEx, Playerfreeze, ServerLogSaver, SideKick, SimpleJail, SimpleRestart, Worldedit, and WorldGuard

Please do take your time, I understand you may be busy thank you.
1
02/19/2012 2:10 am
Level 29 : Expert Archer
Medic0987
Please help when I try to promote myself it tells me:
"Dont have enough Permission for group Owner"

Like I cant promote myself up :/.
1
06/28/2013 2:50 pm
Level 2 : Apprentice Miner
YYs100
In terminal/ cmd write: pex group Owner user add <player>. Then do the command: pex group Owner prefix [Owner] . Then add the permissions for the owner in permissions.yml. Hope this helps.
1
02/19/2012 8:34 pm
Level 13 : Journeyman Taco
Ga55246
In the .bat (THE .bat FILE) file say manuadd [your name] [rank]
1
02/11/2012 5:35 pm
Level 10 : Journeyman Engineer
littlehughes
I am getting this Message:

17:32:19 [INFO] [PermissionsEx] sql backend registered!
17:32:19 [INFO] [PermissionsEx] file backend registered!
17:32:19 [INFO] [PermissionsEx] PermissionEx plugin initialized.
17:32:19 [INFO] [PermissionsEx] p2compat backend registered!
17:32:19 [INFO] [PermissionsCompat] Compatibility Layer Initalized!
17:32:19 [INFO] [PermissionsEx] Initializing file backend
17:32:19 [SEVERE] while scanning for the next token; found character 't' that cannot start any token initializing PermissionsEx v1.18 (Is it up to date?)
while scanning for the next token
found character 't' that cannot start any token
in "<reader>", line 7, column 1:
default: false
^

What do i do?
1
02/12/2012 11:38 am
Level 23 : Expert Explorer
Tromania
go into your permissions.yml in permmisonsEX
Scroll down to line 7, you probably have a space between the next line or something.
Delete that space and you should be good.
1
02/12/2012 11:38 am
Level 23 : Expert Explorer
Tromania
go into your permissions.yml in permmisonsEX
Scroll down to line 7, you probably have a space between the next line or something.
Delete that space and you should be good.
1
02/11/2012 2:53 pm
Level 31 : Artisan Miner
C4chaoskiller
how do i disable the Modifychat thing? like i want new players to chat .
1
02/08/2012 8:22 pm
Level 5 : Apprentice Network
Mancee
CAN SOMEONE PLEASE MAKE ME A PRE MADE REMISSIONS.YML WITH ADMIN RANK,
SUB-ADMIN RANK, MODERATOR RANK AND PLEASE MAKE ADMIN GET ALL COMMANDS EXCEPT
FOR /STOP IF YOU DO YOU YOU GET ADMIN ON MY SERVER!!!!!!!PLEASE HELP I AM A NOOB!!!!!!!!
1
02/09/2012 1:11 pm
Level 47 : Master Narwhal
BENNETTMAN
Use the tutorial and do it yourself.
1
02/15/2012 6:58 am
Level 5 : Apprentice Network
Mancee
I TRIED IT WONT LOAD
1
02/15/2012 9:19 am
Level 47 : Master Narwhal
BENNETTMAN
I don't help people who can't turn off capslock.
Be respectful.
1
02/08/2012 3:45 pm
Level 1 : New Miner
anonpmc111217
[deleted]
1
02/09/2012 4:09 pm
Level 1 : New Miner
anonpmc111217
[deleted]
1
02/05/2012 7:05 pm
Level 1 : New Explorer
BeefMamaFresh
Hello,
I am having two problems with My PermissionsEx. The problem is when I start my test server I get this,

18:49:51 [INFO] [Modifyworld] Loading Modifyworld v1.18.
18:49:51 [SEVERE] [Modifyworld] PermissionsEx not found, disabling
18:49:51 [INFO] [Modifyworld] Unloading Modifyworld v1.18.
18:49:51 [INFO] [Modifyworld] Modifyworld disabled!
18:49:51 [INFO] [Permissions] Loading Permissions v2.7.7.
18:49:51 [INFO] [PermissionsCompat] Compatibility layer enabled.
18:49:51 [INFO] [ChatManager] Loading ChatManager v1.18.
18:49:51 [SEVERE] [ChatManager] PermissionsEx not found, disabling
18:49:51 [INFO] [ChatManager] Unloading ChatManager v1.18.
18:49:51 [INFO] [ChatManager] ChatManager disabled!
18:49:51 [INFO] Server permissions file permissions.yml is empty, ignoring it
18:49:51 [INFO] Done (0.946s)! For help, type "help" or "?"

So my prefix and suffix specifications are not working because ChatManager is not loading I cant find out how to fix this problem. My second problem I am having is with promotion and demotion it is saying something about ladders? if anyone can help me that would be GREAT here is my permissions.yml
www.mediafire.com/?itq9lh3bzf974m4
you can also email me you will find my email in the ReadMeFirst.txt
1
02/07/2012 9:48 am
Level 47 : Master Narwhal
BENNETTMAN
Just copy and paste your permissions.yml to pastebin.com, I'm not downloading anything.
1
02/07/2012 7:59 pm
Level 1 : New Explorer
BeefMamaFresh
Here you go. I put it in pastebin.com for you :)
Here is the link: pastebin.com/djpppt35
1
02/07/2012 7:55 pm
Level 1 : New Explorer
BeefMamaFresh
ok
1
02/08/2012 6:08 am
Level 47 : Master Narwhal
BENNETTMAN
1
02/08/2012 9:47 pm
Level 1 : New Explorer
BeefMamaFresh
The prefix and suffix's are working but I am having the promotion error (user are not in this ladder) can you help me with that too please Thanks for helping me with iChat I cant thank you enough!!!!!!!!!
1
02/10/2012 3:23 pm
Level 1 : New Explorer
BeefMamaFresh
Can you please help with the error?
1
02/01/2012 4:26 am
Level 3 : Apprentice Crafter
n3wholy
how i can remove the brackets < > in the chat

chat-range: 200.0
display-name-format: '%prefix%player%suffix'
global-message-format: <%prefix%player&f%suffix> %message
enable: true
message-format: <%prefix%player&f%suffix> %message
ranged-mode: false
1
02/02/2012 9:21 am
Level 47 : Master Narwhal
BENNETTMAN
By deleting the < > symbols.
1
01/28/2012 10:29 pm
Level 1 : New Miner
lastcresendo
My color names and such aren't working(ranks the player isn't actually being a rank to limit his/her commands)...I also get quite a few errors but there are to many to put. Such as the command say doesn't work in console anymore.

pastie.org/3273591
1
01/16/2012 7:12 am
Level 1 : New Miner
carls1976
i download your files replace it for the one in the pex folder and when i boot my server its comes up with a load of errors

12:10 PM [SEVERE] Error occurred while enabling PermissionsEx v1.18 (Is it up to date?): null

12:10 PM [SEVERE] [ChatManager] PermissionsEx not found, disabling

12:10 PM [SEVERE] [Modifyworld] PermissionsEx not found, disabling

Planet Minecraft

Browse

Site

© 2010 - 2019
www.planetminecraft.com

Welcome