Sam30800
Hello and Welcome to my Group Manager Tutorial. In this post, I will cover the basics in how to create and setup your own ranks and permissions. We will mainly be editing two files for this tutorial: globalgroups.yml and groups.yml. The groups.yml is where you put permissions for specific worlds. The globalgroups.yml file is ONLY used for declaring groups that will have the same permissions across all worlds.
Step 1: Get Group Manager
To start off you will first need to install Group Manager (GM) which you can download HERE. Because GM is part of Essentials, it is not available on bukkit and therefore it cannot be installed through Bukkit on your server control panel. GM requires a manual download, which you can find a tutorial on how to do with a simple Google search.
Step 2: Find globalgroups.yml and local groups
Okay now that you installed GM, restart your server. Once the server is finished loading go into your FTP File Access Area on your Control Panel. Once you type in your password click on the plugins folder in the list of files and them click on the GroupManager folder (Make sure it is the folder and has the folder icon on it, not the .jar file). You should now see 2 folders and 3 files. One of the files is labeled globalgroups.yml. Click on it to download it, and then save it to your desktop. Next click on the worlds folder this will take you to another lists of folders which will be you worlds. Click on the world you want to add permissions/ranks to (ex: world). In the folder click on the groups.yml and download it, and then save it to your desktop.
Step 3: Editing your globalgroups.yml
A: This is the most hardest part in setting up GM for most people. If you take the time to learn how to set up your groups it will seem easy. To start off lets open up our globalgroups.yml file that you saved to your desktop. You can open it with any text editing program like Notepad, but I highly recommend you use Notepad++ which you can download HERE. Notepad++ is great for editing YAML files which is what minecraft plugin config files use.
B: Once the file is open you should see something like this:
# These groups only contain permission nodes.
#
# **** You can NOT add anything other than permission nodes ****
# **** This is NOT where you set up the groups which you give to users! ****
# **** goto groupmanager/worlds/worldname/groups.yml if you want to set the actual groups! ****
#
# These collections are to be inherited in your different worlds groups.yml's
# They can also be added as one of a users subgroups, but NOT as a primary group.
# These collections are available to ALL group and user yml's.
#
# Add to and customize these groups to fit your needs.
groups:
# Permission nodes for GroupManager
# by ElgarL, snowleo, continued from gabrielcouto's original
# http://wiki.ess3.net
g:groupmanager_default:
permissions:
- groupmanager.notify.self
g:groupmanager_moderator:
permissions:
- groupmanager.listgroups
- groupmanager.mandemote
- groupmanager.manpromote
- groupmanager.manselect
- groupmanager.manuadd
- groupmanager.manudel
- groupmanager.manwhois
- groupmanager.notify.other
etc.
This is the default globalgroups.yml. For the sake of this tutorial, you can delete everything below 13th line which has "groups:"
Lines that start with "#" are comments and don't effect the plugin.
C: To start off, you always want to have "groups:" with no indent before it. Type it below the comments at the top of the file. Next under that we will indent 2 times and type your first group starting with a "g:" so that for example it will look like "g:Guest:".
D: Next we will start adding our permissions to our group. Plugin permissions can be found for specific plugins on their page on dev.bukkit.org. First, on the next line, indent 4 times and type "permissions:" then go to the next line and indent 4 times again and type a hyphen ( - ). All permissions have to be indented 4 times and have a hyphen ( - ) and a space after that before typing a permission. For this tutorial we will be adding a few Essentials permissions. After adding a few permissions it should look like this:
Code:
groups:
g:Guest:
permissions:
- essentials.motd
- essentials.mail
- essentials.spawn
- essentials.home
Notice the format in which the permissions is written. GM is very picky about its format.
E: You can add more groups after this. After adding three groups your file should be in this format:
Code:
groups:
g:Guest:
permissions:
- essentials.motd
- essentials.mail
- essentials.spawn
- essentials.home
g:Member:
permissions:
- essentials.tpa
- essentials.warp
- essentials.msg
g:Admin:
permissions:
- essentials.fly
- essentials.give
- essentials.vanish
Step 4: Editing your world groups (groups.yml)
Lets move on to your groups.yml file. Open it from your desktop. For the sake of this tutorial go ahead and delete everything below "groups:". Since there is a lot of things that you need to put here I will just make a list that will tell you the line number, followed by number of indents, followed by what you type.
1st Line | 0 indents | groups:
2nd Line | 2 indents | <Group Name> (ex: Guest) <-- (notice that there is no "g:")
3rd Line | 4 indents | default: <true or false> (True if this is the rank players start with)
4th Line | 4 indents | permissions:
5th Line + | 4 indents | <permissions if any> ( If none, put "[]" after "permissions:")
6th Line | 4 indents | inheritance: (Inheritance can be sorta of confusing. Earlier in the globalgroups.yml I had you put a "g:" before the name of the group. This declares the group as a global group. By using the inheritance, we can declare permissions in the globalgroups.yml file and then use those permissions in the groups.yml file. I will show you the format for that below.)
7th Line | 4 indents | <Inheritance groups>
8th Line | 4 indents | info:
9th Line | 6 indents | prefix: (I will cover the rest of this line below)
10th Line | 6 indents | build: true
11th Line | 6 indents | suffix: '' (Double apostrophes, not a quotation mark)
Lets see what this looks like with our guest rank:
Code:
groups:
Guest:
default: true
permissions: []
inheritance:
- g:Guest
info:
prefix: &7[&4Guest&7]
build: true
suffix: ''
A few things I would like to point out above. First is you can see how I put the square brackets after "permissions:". You must put these after permissions if you have none for that group, even in globalgroups.yml. The next thing is Inheritance which I will cover below. Finally the prefix, which is how you want to display the rank before the players name in chat. So for me, if I had the Guest rank it would look like Light Grey brackets and red lettering for Guest: [Guest]xWolfie07
The &# is minecraft color codes which you can view HERE.
So, what if we don't want to type the same permission for every rank? Well with inheritance we don't have to. So if I want my Member rank to have the same permissions as Guest I would put this under my inheritance for my Member group:
Code:
inheritance:
- g:Member
- Guest
This way, I get inheritance from both my global Member group and my previous Guest rank. The Guest rank however does not get any permissions from the Member rank.
(The part above might be confusing, just leave a comment below if you don't understand)
Step 5: Finish your files
Now you can finish up your globalgroups.yml and groups.yml and add the ranks and permissions you like. Once your done with this (it might take a while), go ahead and save your files.
Step 6: Check for Syntax errors
Like I said above Group Manger is very picky about the format because if it is not in the correct format, it can't understand the file. So to check for errors we will use this nifty tool called a YAML Parser which will check for syntax errors. You can find it HERE. Just copy and paste your files into the text box.
Step 7: Adding your new files
From here, return to your globalgroups.yml in your FTP File Access and just copy and paste you edited globalgroups.yml file into there and do the same for groups.yml for each worlds groups.yml that you will be using (this includes your main world, your nether world, and your end world).
Step 8: Reload Group Manager
Go ahead to your server console and type "manload" to reload your GM plugin. After that you should be done.
TIPS:
- The text inside your globalgroups.yml and groups.yml files are case-sensitive. "Guest" is not the same as "guest"
- Only use Spaces for indenting. Do not use TAB.
- Some plugins support what I call * or "star" permissions. Star permissions are used to shorten your permissions by compacting several individual permissions into one. Normally it would look something like this:
Code:
permissions:
- essentials.example.1
- essentials.example.2
- essentials.example.3
- essentials.example.4
Now lets pretend that those 4 permissions were combined into one. It would look like this:
Code:
permissions:
- essentials.example.*
Most star permissions are given on the plugin page.
- If you want a rank to not have a certain permission that a group that it inherits has, then you can make a negative permission node by putting a hyphen before the permission. It would look like this:
Code:
permissions:
- -essentials.fly
I would like to apologize for any grammer errors above :p
If you have any problems or errors that you can not find out how to fix, please leave a comment below or send me a message.
Step 1: Get Group Manager
To start off you will first need to install Group Manager (GM) which you can download HERE. Because GM is part of Essentials, it is not available on bukkit and therefore it cannot be installed through Bukkit on your server control panel. GM requires a manual download, which you can find a tutorial on how to do with a simple Google search.
Step 2: Find globalgroups.yml and local groups
Okay now that you installed GM, restart your server. Once the server is finished loading go into your FTP File Access Area on your Control Panel. Once you type in your password click on the plugins folder in the list of files and them click on the GroupManager folder (Make sure it is the folder and has the folder icon on it, not the .jar file). You should now see 2 folders and 3 files. One of the files is labeled globalgroups.yml. Click on it to download it, and then save it to your desktop. Next click on the worlds folder this will take you to another lists of folders which will be you worlds. Click on the world you want to add permissions/ranks to (ex: world). In the folder click on the groups.yml and download it, and then save it to your desktop.
Step 3: Editing your globalgroups.yml
A: This is the most hardest part in setting up GM for most people. If you take the time to learn how to set up your groups it will seem easy. To start off lets open up our globalgroups.yml file that you saved to your desktop. You can open it with any text editing program like Notepad, but I highly recommend you use Notepad++ which you can download HERE. Notepad++ is great for editing YAML files which is what minecraft plugin config files use.
B: Once the file is open you should see something like this:
# These groups only contain permission nodes.
#
# **** You can NOT add anything other than permission nodes ****
# **** This is NOT where you set up the groups which you give to users! ****
# **** goto groupmanager/worlds/worldname/groups.yml if you want to set the actual groups! ****
#
# These collections are to be inherited in your different worlds groups.yml's
# They can also be added as one of a users subgroups, but NOT as a primary group.
# These collections are available to ALL group and user yml's.
#
# Add to and customize these groups to fit your needs.
groups:
# Permission nodes for GroupManager
# by ElgarL, snowleo, continued from gabrielcouto's original
# http://wiki.ess3.net
g:groupmanager_default:
permissions:
- groupmanager.notify.self
g:groupmanager_moderator:
permissions:
- groupmanager.listgroups
- groupmanager.mandemote
- groupmanager.manpromote
- groupmanager.manselect
- groupmanager.manuadd
- groupmanager.manudel
- groupmanager.manwhois
- groupmanager.notify.other
etc.
This is the default globalgroups.yml. For the sake of this tutorial, you can delete everything below 13th line which has "groups:"
Lines that start with "#" are comments and don't effect the plugin.
C: To start off, you always want to have "groups:" with no indent before it. Type it below the comments at the top of the file. Next under that we will indent 2 times and type your first group starting with a "g:" so that for example it will look like "g:Guest:".
D: Next we will start adding our permissions to our group. Plugin permissions can be found for specific plugins on their page on dev.bukkit.org. First, on the next line, indent 4 times and type "permissions:" then go to the next line and indent 4 times again and type a hyphen ( - ). All permissions have to be indented 4 times and have a hyphen ( - ) and a space after that before typing a permission. For this tutorial we will be adding a few Essentials permissions. After adding a few permissions it should look like this:
Code:
groups:
g:Guest:
permissions:
- essentials.motd
- essentials.mail
- essentials.spawn
- essentials.home
Notice the format in which the permissions is written. GM is very picky about its format.
E: You can add more groups after this. After adding three groups your file should be in this format:
Code:
groups:
g:Guest:
permissions:
- essentials.motd
- essentials.mail
- essentials.spawn
- essentials.home
g:Member:
permissions:
- essentials.tpa
- essentials.warp
- essentials.msg
g:Admin:
permissions:
- essentials.fly
- essentials.give
- essentials.vanish
Step 4: Editing your world groups (groups.yml)
Lets move on to your groups.yml file. Open it from your desktop. For the sake of this tutorial go ahead and delete everything below "groups:". Since there is a lot of things that you need to put here I will just make a list that will tell you the line number, followed by number of indents, followed by what you type.
1st Line | 0 indents | groups:
2nd Line | 2 indents | <Group Name> (ex: Guest) <-- (notice that there is no "g:")
3rd Line | 4 indents | default: <true or false> (True if this is the rank players start with)
4th Line | 4 indents | permissions:
5th Line + | 4 indents | <permissions if any> ( If none, put "[]" after "permissions:")
6th Line | 4 indents | inheritance: (Inheritance can be sorta of confusing. Earlier in the globalgroups.yml I had you put a "g:" before the name of the group. This declares the group as a global group. By using the inheritance, we can declare permissions in the globalgroups.yml file and then use those permissions in the groups.yml file. I will show you the format for that below.)
7th Line | 4 indents | <Inheritance groups>
8th Line | 4 indents | info:
9th Line | 6 indents | prefix: (I will cover the rest of this line below)
10th Line | 6 indents | build: true
11th Line | 6 indents | suffix: '' (Double apostrophes, not a quotation mark)
Lets see what this looks like with our guest rank:
Code:
groups:
Guest:
default: true
permissions: []
inheritance:
- g:Guest
info:
prefix: &7[&4Guest&7]
build: true
suffix: ''
A few things I would like to point out above. First is you can see how I put the square brackets after "permissions:". You must put these after permissions if you have none for that group, even in globalgroups.yml. The next thing is Inheritance which I will cover below. Finally the prefix, which is how you want to display the rank before the players name in chat. So for me, if I had the Guest rank it would look like Light Grey brackets and red lettering for Guest: [Guest]xWolfie07
The &# is minecraft color codes which you can view HERE.
So, what if we don't want to type the same permission for every rank? Well with inheritance we don't have to. So if I want my Member rank to have the same permissions as Guest I would put this under my inheritance for my Member group:
Code:
inheritance:
- g:Member
- Guest
This way, I get inheritance from both my global Member group and my previous Guest rank. The Guest rank however does not get any permissions from the Member rank.
(The part above might be confusing, just leave a comment below if you don't understand)
Step 5: Finish your files
Now you can finish up your globalgroups.yml and groups.yml and add the ranks and permissions you like. Once your done with this (it might take a while), go ahead and save your files.
Step 6: Check for Syntax errors
Like I said above Group Manger is very picky about the format because if it is not in the correct format, it can't understand the file. So to check for errors we will use this nifty tool called a YAML Parser which will check for syntax errors. You can find it HERE. Just copy and paste your files into the text box.
Step 7: Adding your new files
From here, return to your globalgroups.yml in your FTP File Access and just copy and paste you edited globalgroups.yml file into there and do the same for groups.yml for each worlds groups.yml that you will be using (this includes your main world, your nether world, and your end world).
Step 8: Reload Group Manager
Go ahead to your server console and type "manload" to reload your GM plugin. After that you should be done.
TIPS:
- The text inside your globalgroups.yml and groups.yml files are case-sensitive. "Guest" is not the same as "guest"
- Only use Spaces for indenting. Do not use TAB.
- Some plugins support what I call * or "star" permissions. Star permissions are used to shorten your permissions by compacting several individual permissions into one. Normally it would look something like this:
Code:
permissions:
- essentials.example.1
- essentials.example.2
- essentials.example.3
- essentials.example.4
Now lets pretend that those 4 permissions were combined into one. It would look like this:
Code:
permissions:
- essentials.example.*
Most star permissions are given on the plugin page.
- If you want a rank to not have a certain permission that a group that it inherits has, then you can make a negative permission node by putting a hyphen before the permission. It would look like this:
Code:
permissions:
- -essentials.fly
I would like to apologize for any grammer errors above :p
If you have any problems or errors that you can not find out how to fix, please leave a comment below or send me a message.
