-----------------
|  Quick Notes  |
-----------------

1. There are not a whole lot of permfiles included currently. If you create any I would appreciate you sending them to me to host for others in the community. (puckmaster_84@hotmail.com)
2. Ensure that the there is no empty lines before the first "groups" key in each of your groups files. (It won't break the plugin if there is, but I don't parse the header to check.)
3. If you don't want to create your own permfiles you could always just petition the plugin devs to add support for my plugin! :D (This does not mean scream and yell. Ask politely. Once.)

I've most likely forgotten something, email me at puckmaster_84@hotmail.com anytime you want and I should reply within an hour or so depending if it's a weekend or school day and what time of day it is.


--------------------------------
|  Creating Permissions Files  |
--------------------------------

The permissions displayed in the gui are not hardcoded. This would severely limit the scope of its capabilities. To avoid this, each plugin on your server has its own file to load its own permissions from.

I won't always be able to make a file for each and every person for each and every plugin so this basic tutorial will teach you how to generate your own. (Although, if you send me the files you make with this tutorial I'll give them a quick once over and include them in my repo if feasible. Hopefully plugin developers will begin to include their own for you as well.)

Step one: Get Permissions
	Get the list of your permissions and make sure they are in the format "permissionOne.permissionTwo.permissionsThree"
	
Step two: Organize Permissions
	Sort your permissions into categories based first on the first level ("permissionOne" in the above case).
		Eg.
			Unsorted:
				worldedit.blah.blah
				worldguard.something.else
				worldedit.foo
				worldedit.bar
				worldguard.another
				worldguard.something.(unused)
				worldguard.something.more.random
		
			Sorted:
				worldedit.blah.blah
				worldedit.foo
				worldedit.bar
				worldguard.something.else
				worldguard.another
				worldguard.something.(unused)
				worldguard.something.more.random
				
	Sort again based on second level ("permissionTwo").
		Eg.
			Unorted:
				worldedit.blah.blah
				worldedit.foo
				worldedit.bar
				worldguard.something.else
				worldguard.another
				worldguard.something.(unused)
				worldguard.something.more.random
				
			Sorted:
				worldedit.blah.blah
				worldedit.foo
				worldedit.bar
				worldguard.something.(unused)
				worldguard.something.else
				worldguard.something.more.random
				worldguard.another
				
	Repeat until all your levels are organized.
	
Step Three: Get Name of Plugin
	From the console of your server with PermGUI installed, run the command "namesout".
	Navigate to the PermGUI config.yml (server directory> plugins> PermGUI> config.yml).
	A new section should have been generated named simply "names".
	Look through the list for the name of the plugin that will be recognized by PermGUI (eg. WorldEdit v4.7).

Step Four: Create Your File
	Navigate to the permfiles directory (server directory> plugins> PermGUI> permfiles).
	Create a new file called "<pluginNameFound in step three>.yml". If you can't change the extension to .yml you can always copy, paste, rename and clear the contents in the copied file.
	
Step Five: Format Your Permissions
	Take your first level permissions (worldedit in the example above) and create your first level keys.
		Eg.
			worldedit:
			worldguard:
			
	Take your second level permissions and insert them.
		Eg.
			worldedit:
				blah:
				foo:
				bar:
			worldguard:
				something:
				another:
				
	Insert your third level permissions.
		Eg.
			worldedit:
				blah:
					blah:
				foo:
				bar:
			worldguard:
				something:
					(unused):
					else:
					more:
				another:
				
	Fourth level.
		Eg.
			worldedit:
				blah:
					blah:
				foo:
				bar:
			worldguard:
				something:
					(unused):
					else:
					more:
						random:
				another:
				
Step six: Descriptions
	Include a description for all of the end level permissions.
		Eg.
			worldedit: <not end level>
				blah: <not end level>
					blah:
				foo:
				bar:
			worldguard: <not end level>
				something: <not end level>
					(unused): <special case>
					else:
					more: <not end level>
						random:
				another:
				
		Turns into:
			worldedit: 
				blah: 
					blah: I say blah.
				foo: Fuuuuu.
				bar: When the blonde hit it, she said ouch.
			worldguard: 
				something: 
					(unused): Something world guard does.
					else: I'm something else.
					more: 
						random: I'm random!
				another: Something else worldguard does.
				
	** The (unused) tag is used when you need to return the permission above, but the permission also has subcategories. A good example is WorldEdit's superpickaxe. You require the "worldedit.superpickaxe" permission to use it, but without the (unused) tag, the permissions would not be visible in the GUI.
		Eg.
			worldedit:
				superpickaxe:
					(unused): Toggle the super pickaxe pickaxe function.  Select super pickaxe mode.
					recursive: Enable the recursive super pickaxe pickaxe mode.
					area: Enable the area super pickaxe pickaxe mode.
				
		Permissions shown in GUI with description:
			"worldedit.superpickaxe" - "Toggle the super pickaxe pickaxe function.  Select super pickaxe mode."
			"worldedit.superpickaxe.recursive" - "Enable the recursive super pickaxe pickaxe mode."
			"worldedit.superpickaxe.area" - "Enable the area super pickaxe pickaxe mode."
	
	--------------------------------
	|  Tips on Creating Permfiles  |
	--------------------------------
		1. Any asterisk permissions must be surrounded by quotes. (Eg. '*':)
		2. Check your yml file set up by putting it through the parser at http://yaml-online-parser.appspot.com/
		3. [ or ] are not allowed to surround a permission, use < and > or surround it with quotes. This is a yml limitation, not my own.
		4. A permission won't show in the GUI unless there is a description for the permission.