From a2888acddb315edc6c8c29f19b8d8efdac429e13 Mon Sep 17 00:00:00 2001 From: FernFerret Date: Sat, 28 Jan 2012 10:32:02 -0800 Subject: [PATCH] Add line breaks and transcript --- Permissions.md | 66 ++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 64 insertions(+), 2 deletions(-) diff --git a/Permissions.md b/Permissions.md index 1543944..f3b183d 100644 --- a/Permissions.md +++ b/Permissions.md @@ -2,6 +2,8 @@ _NOTE: Are you looking for [[the List of all MV Permissions|Big List O Permissio ## Multiverse Permissions Plugin Support Multiverse supports any plugin that adheres to the SuperPerms Bukkit Permissions API. As of now (1/19/2012) these are: PermissionsBukkit, bPerms, PEX and GroupManager. +--- + ## Multiverse World Permissions Multiverse allows you to control who can enter worlds via permissions! When you create a world or import a world into Multiverse-Core, it automatically creates a permission: `multiverse.access.WORLDNAME`. If a player _has_ `multiverse.access.WORLDNAME`, then they can enter that world. @@ -9,13 +11,16 @@ Multiverse allows you to control who can enter worlds via permissions! When you If you give a user `multiverse.access.*` they can go to all worlds. +--- + ## About PermissionsBukkit -[PermissionsBukkit](http://forums.bukkit.org/threads/26785) is the Official Bukkit plugin to manage permissions using the new [Permissions API](http://forums.bukkit.org/threads/25080/). Other permission plugins will probably begin incorporating the API to manage your servers permissions, but for now the official plugin([PermissionsBukkit](http://forums.bukkit.org/threads/26785)) is what we have. Luckily, there is a bridge included with [PermissionsBukkit](http://forums.bukkit.org/threads/26785) to satisfy plugins still requesting Permissions 2.7/3.1 and will bridge those requests through and handle them. The bridge is not required to use permissions with Multiverse 2. +[PermissionsBukkit](http://forums.bukkit.org/threads/26785) is the Official Bukkit plugin to manage permissions using the new [Permissions API](http://forums.bukkit.org/threads/25080/). Other permission plugins will probably begin incorporating the API to manage your servers permissions, but for now the official plugin([PermissionsBukkit](http://forums.bukkit.org/threads/26785)) is what we have. Luckily, there is a bridge included with [PermissionsBukkit](http://forums.bukkit.org/threads/26785) to satisfy plugins still requesting Permissions 2.7/3.1 and will bridge those requests through and handle them. The bridge is **not** required to use permissions with Multiverse 2. ## PermissionsBukkit config.yml ### NOTE: This is the config.yml that resides within the PermissionsBukkit folder! Setting up the permissions in the config is pretty straight forward. You may find it similar to pre-1000 permission plugins. Here is an example config file which includes some permissions for Multiverse 2: +```yaml users: myplayername: permissions: @@ -34,12 +39,17 @@ Setting up the permissions in the config is pretty straight forward. You may fin - default messages: build: '&cYou do not have permission to build here.' +``` With this setup, all users will have the ability to teleport themselves using the [`/mvtp`](https://github.com/Multiverse/Multiverse-Core/wiki/Command-Reference#teleport) command, while users assigned to the admin group will also have the ability create worlds. Notice also that the admin has `permissions.*: true` and therefore can use the PermissionsBukkit commands in game. This may be especially useful for Multiverse 2. +--- + ### MV2 Permissions You can use: `multiverse.*` to give someone all permissions for Multiverse. If you only want to give someone access to all worlds, use: `multiverse.access.*` for example. +--- + ## Setting Permissions in game Multiverse has the courtesy to show which permission node is needed for a command if you enter a /command and it fails due to permissions. Having this info readily available to you in the game can save you some time looking up the permission, and allow you to enter that permission into a group on the spot if need be. An admin can simply enter permissions in as you need them. For example you try to run [`/mvlist`](https://github.com/Multiverse/Multiverse-Core/wiki/Command-Reference#list) and oh my you dont have permission, but you will be notified that you need `multiverse.world.list` permission node. Entering @@ -47,5 +57,57 @@ Multiverse has the courtesy to show which permission node is needed for a comman will add the permission to your admin group and viola! you have permission to use that command. MV has a lot of commands and permissions, so adding them in a need-to-use basis can sometimes be easier. +--- + ## Setting OP's -OP's by default have all the Multiverse permissions set to true. So the easiest way to give your admins all the Multiverse permissions is to just make them OP. Of course, this may not be the best option for everyone. \ No newline at end of file +OP's by default have all the Multiverse permissions set to true. So the easiest way to give your admins all the Multiverse permissions is to just make them OP. Of course, this may not be the best option for everyone. + +--- + +## Sample Access Permissions Transcript +A lot of people seem to have trouble understanding how the access permissions work. This is an actual transcript of me (@FernFerret) playing on a test server, and typing exactly what happened. Whenever you see a `>` that means that I typed a command in the console. + +``` +11:18:38 [INFO] [world2] I do not have multiverse.core.list.worlds, I can't see any worlds +>perm player setperm fernferret multiverse.core.list.worlds true +11:18:59 [INFO] Player fernferret now has multiverse.core.list.worlds = true. +11:19:15 [INFO] [world2] cool. I can see the world list, but there are 0 worlds listed +>perm player setperm fernferret multiverse.access.world true +11:19:32 [INFO] Player fernferret now has multiverse.access.world = true. +11:19:42 [INFO] [world2] sweet. Now I can see the world 'world' +11:20:08 [INFO] [world2] I can't TP there though, I don't have *any* multiverse.teleport.X perm nodes +>perm player setperm fernferret multiverse.teleport.self.* true +11:20:26 [INFO] Player fernferret now has multiverse.teleport.self.* = true. +11:20:38 [INFO] [world] woo I'm in 'world' +11:20:54 [INFO] [world] now I can't tp to 'world' again, i need the spawn.self perm... +>perm player setperm fernferret multiverse.core.spawn.self true +11:21:05 [INFO] Player fernferret now has multiverse.core.spawn.self = true. +11:21:18 [INFO] [world] woo! now i'm at spawn!!!!!!111! +11:21:31 [INFO] [world] but I can't go back to world2... +11:21:34 [INFO] [world] I need some perms! +>perm player setperm fernferret multiverse.access.world2 true +11:21:44 [INFO] Player fernferret now has multiverse.access.world2 = true. +11:21:56 [INFO] [world2] hellz yea!!!!111! world2!! +11:24:05 [INFO] [world2] hmm ok, let's not give me the exact teleport perm... i'll test now! +11:24:15 [INFO] [world] ow... +11:24:20 [INFO] [world] i'm underground somewhere +11:24:25 [INFO] [world] the exact perm is dangerous +>perm player setperm fernferret multiverse.teleport.self.e false +11:24:40 [INFO] Player fernferret now has multiverse.teleport.self.e = false. +11:24:51 [INFO] [world] I went back to spawn +11:25:26 [INFO] [world] ok. I gave myself the false exact perm +11:25:36 [INFO] [world] but that gets checked _after_ the higher perm +11:25:48 [INFO] [world] so I need to deny myself the parent, and just give myself the child perms +>perm player setperm fernferret multiverse.teleport.self.* false +11:26:14 [INFO] Player fernferret now has multiverse.teleport.self.* = false. +11:26:24 [INFO] [world] ok. I have no tp perms again. +11:26:35 [INFO] [world] now i'll _just_ give myself the ones I want, world and player +>perm player setperm fernferret multiverse.teleport.self.w true +11:26:41 [INFO] Player fernferret now has multiverse.teleport.self.w = true. +>perm player setperm fernferret multiverse.teleport.self.pl true +11:26:47 [INFO] Player fernferret now has multiverse.teleport.self.pl = true. +11:26:55 [INFO] [world] oh, and cannon! cannons are awesome! +>perm player setperm fernferret multiverse.teleport.self.ca true +11:27:00 [INFO] Player fernferret now has multiverse.teleport.self.ca = true. +11:27:15 [INFO] [world] weeeeeeeeeeeee (shot out of cannon) +``` \ No newline at end of file