Permissions and You

This documentation covers the faction 3.0 plugin. Right now the server is running on
version 4.0, so this guide might not be as useful as it once was. Some ideas might
still apply though.

How permissions work

By default, every member of your faction can do everything within your claimed land. Every other player (the public) can’t
use/break anything. Using permissions/subclaims you can change that.

This guide is work in progress. Please help us fix errors. Thanks.

Ranks

The first way to assign permissions is by rank. A few ranks are created by default:

leader

Only the current leader of the faction is having the leader rank

officer

All members assigned officers are in this rank

member

All members assigned to the rank member are in this rank.

recruit

All members added to the faction are assigned to this rank by default

public

All players outside the faction. Be careful when assigning permissions to this rank, as outside players might be able to break your blocks if you mess it up.

These ranks allow a simple hierachy within factions where recruits have little permissions and the leader is almighty.
Using custom ranks, you can build your own way of giving out permissions.

Use

/f list r

to list the ranks and their permissions. Use the Permission calculator below on how to decode the permission value.

You can create new ranks using

/f rank set {rankname} (use the Permission calculator below to set useful values)

The value behind the {rankname} is the default permission for this rank. It controls access of members to claimed land
(excluding subclaims!). For easier management, consider naming your ranks with with an uppercase first letter (use Test,
instead of test). This prevents collision with the default ranks.

To make use of the new rank, you have to assign players to it. You can assign players to any rank you created or to
the default ranks. A player can only be in one rank at a time:

/f rank ap {rankname} {playername}

Use

/f list mr

to find out which player is assigned to which rank and that ranks permission within the claimed land (not the subclaims!).

Each time a player of your faction interacts with the owner claimed land (not subclaims, they work a little different, see
below), permissions and ranks are checked. Actions taken by players are for example building/breaking blocks or opening chests
(see below for the complete list of permissions):

Get the rank the player is assigned to (e.g. player Notch is assigned rank Builder)

Check if the permission assigned to this rank allows the action (e.g. can the rank Builder rank open chests?)
Does the permission allow this action? Then allow it. End of check list.

Get the rank public and check if it allows the action. If allowed: Do it. End of check list.

Deny the action (and cause damage to the player if he repeats the action too often)

Subclaims

Subclaims allow controlled access to smaller areas inside your claimed land. Subclaims have to be at least 4x4x4 in size.
Unlike claims, subclaims don’t fill up the whole vertical space. So they are also limited in the Y direction too. Subclaims
must be fully contained inside a single claim. So they cannot cross claim borders. Subclaims do not cost money.

To create a subclaim, build a golden axe and hit the two corner blocks of the intended subclaim with it (while not
crouching). You will be asked for a name for that subclaim. Type the name into the chat.

To see your current subclaims, use the golden axe and hit the air with it. It will visualize all subclaims as boxes of
glass. Hit the air again to remove the subclaim display.

To resize a subclaim, first display the subclaim (see previous hint). Then crouch and hit the corner you want to move.
This will start the resizing. Then hit the new corner while being crouched. Your subclaim should now be resized.

You can also get a list of all your subclaims by typing /f list l. This will list all your claims with a list of all
subclaims included inside them.

To unclaim a subclaim, stand inside it and type /f unsubclaim. You can also use /f unsubclaim {name} with name being
the name of the subclaim.

Subclaim permissions

By default, no one, not even the leader can modify/use anything inside the new subclaim. You first have to assign
permissions to ranks:

This assigns the specified permissions to the subclaim for a specific rank. To get a list of all your subclaims, use:

/f list l

The orange names are the subclaims contained in a claim.

Permission Calculator

Permission

Value

(bit mask)

Block (build/break)

1

Chest access

2

Trapped Chest

4

Hopper

8

Furnace Access

16

Dispenser/Dropper Access

32

Anvil Access

64

Brewing Stand

128

Button Access (see warning below)

256

Lever Access

512

Wooden Door Access

1024

Fence Gate Access

2048

Trap Door Access

4096

New: Beacon (change effect)

8192

New: Item Frame

16384

All except Block (build/break)

65534

Full Access

65535

Permission Value

Warning: Wooden buttons can be triggered by everyone using bow and arrow.

You cannot give permissions to pressure plates, enchantment tables or crafting benches: They can be used by everyone.

Using Permissions: Private Rooms for members

Create a new rank for each member (called Member in the following example):

/f rank set RankMember

Use the Permissions calculator to customize the permission value (the last
argument for the /f rank call). This value will control the permissions this
member has outside all subclaimed areas. So if you want to give members control
over everything except the Building permission, use the value 65534.

Next, assign the player to the newly created rank:

/f rank ap RankMemberMember

Now Member is the only player in the rank RankMember. Next create a new
subclaim using the golden subclaiming axe. Give the new subclaim a name. Use
RoomMember as the subclaim name, to make it easy to see who owns the room.

Then assign the rank RankMember to the newly created subclaim RoomMember:

/f rank al RoomMember RankMember

Use the Permissions calculator to calculate the permissions. If you want to
give Member full permissions the room, use all (or 65535).

Repeat this process for each member you want to create a private room for.

If you (as the leader) wants to access a room, use

/f rank al RoomMember leader all

to give you full permissions in the subclaim.

Using Permissions: A public chest

Lets say you want to create a public chest, so that players can take or put
items into it.

First, create a new subclaim and name it PublicChest. Then assign the
permissions to that subclaim:

/f rank al PublicChest public 2

The value 2 was calculated using the Permissions Calculator. Test it yourself:
Only select the chest permission and look at the Permission Value.

To give every member of your faction access to the chest and all other
permissions inside the subclaim, use

/f rank al PublicChest member all

Using Permissions: Stopping a betrayal

If a rogue player in your faction begins destroying the base, here’s how you stop him
from modifying/using anything inside your claims:

/f rank set betray 0

This will create a new rank called betray that has no permissions to do anything
inside your claims. You might want to create this rank in advance without using it.
So it’s already there should you ever need it.

/f rank ap betray player

Assigns the player to the betray rank. Now the ranks permissions are in effect and the
player cannot do anything inside your claims. Make sure that you remove the player from
officer rank. Otherwise the player can just reenable access by issuing rank commands himself.

Notice that the player might still interact with subclaims as they overwrite default
rank permissions. Unless you added them, the betray rank shouldn’t have any subclaim
permissions, so if you don’t have any public subclaims, you should be safe.