Set up clan ranks and permissions
The 29 in-clan permissions, how weight decides who may act on whom, and the default-roles block new clans are built from.
Decide who in a clan can invite, kick, claim land or spend the bank, by creating ranks and ticking what each rank may do.
Before you start#
You need to be the clan leader, or hold a rank with the MANAGE_ROLES permission. Ranks belong to each clan: default-roles in config.yml only sets what a clan looks like on the day it is created, and nothing in that file reaches back into existing clans.
Steps#
Open the roles menu
Run /clan, click Settings, then Roles.
Create the rank
Click Create Role. Type the name in chat, then type its weight as a number. A higher weight outranks a lower one (the shipped ranks use 100, 50 and 1).
Tick its permissions
Click the new rank to open Manage Role. Each permission is a button, for example Kick member or Claim land; click it to give or take it away.
Choose who gets it
To give the rank to a member, run /clan, click Members, click the member, then Assign role, and pick the rank. To make it the rank every new member gets, click Set as default in Manage Role.
In Manage Role you can also change Weight, Rename or Delete the rank.
Check that it works#
Give a test member the rank and ask them to try one thing it allows (for example /clan invite) and one it does not. The second must be refused. In the roles menu each rank shows its weight, its member count and whether it is the default.
Who can act on whom#
Weight answers one question: may this member act on that member? Yes only when the actor's weight is strictly greater than the target's.
- Kick, ban, promote and demote all go through it.
- A rank heavier than the member's current one needs
PROMOTE; a lighter one needsDEMOTE./clan promoteand/clan demoteopen the same Assign role menu. - A weight must be unique in the clan and below the weight of whoever sets it.
- The heaviest rank cannot be deleted, and neither can the last remaining one.
Weights of 100, 50 and 1 let you insert a rank between two others without renumbering. Consecutive weights do not.
The leader is a column on the clan, not a rank. They pass every permission check whatever their rank allows and count as heavier than everybody. A leader cannot /clan leave: they must /clan transferleader or /clan disband, and disbanding needs the clan's DTR state to be NORMAL.
Change the ranks new clans start with#
Edit default-roles in plugins/ExyliaClans/config.yml, then /clanadmin reload. Clans created afterwards get these ranks; existing clans keep theirs. The keys (leader, officer, member) are yours to add, rename or delete. Exactly one entry should have is-default: true, and the founder gets the heaviest rank in the block.
/clan create refuses and logs Cannot create a clan: default-roles is empty in config.yml. Keep at least one rank.
What each permission allows#
The 29 rank permissions
| Permission | Menu button | What it allows |
|---|---|---|
INVITE | Invite member | /clan invite, cancelling an invite |
KICK | Kick member | /clan kick |
BAN | Ban member | /clan ban, /clan unban |
PROMOTE | Promote member | Assigning a rank above the member's current one |
DEMOTE | Demote member | Assigning a rank below it |
MANAGE_ROLES | Manage roles | Creating, renaming and deleting ranks, weights, the default rank, ticking permissions |
SEND_ALLIANCE_REQUEST | Send alliance request | /clan ally add |
ACCEPT_ALLIANCE | Accept alliance | /clan ally accept, /clan ally decline |
REMOVE_ALLY | Remove ally | /clan ally remove |
MANAGE_RIVALS | Manage rivals | /clan rival add, /clan rival remove |
SET_HOME | Set home | /clan sethome |
REGROUP | Call regroup | /clan regroup |
DEPOSIT_BANK | Deposit bank | /clan deposit |
WITHDRAW_BANK | Withdraw bank | /clan withdraw |
TOGGLE_FRIENDLY_FIRE | Friendly fire | /clan ff |
TOGGLE_OPEN | Toggle open | /clan open |
CLAIM_LAND | Claim land | /clan claim, /clan reclaim |
UNCLAIM_LAND | Unclaim land | /clan unclaim |
BUILD | Build in claim | Placing and breaking blocks, buckets and item frames inside the clan's own claim |
OPEN_DOORS | Open doors | Doors, trapdoors and fence gates inside the claim |
OPEN_CONTAINERS | Open containers | Chests and every other container inside the claim |
SEND_CLAN_MAIL | Send clan mail | Sending mail to the whole clan |
MANAGE_LFP | Manage LFP | Posting, editing, renewing and cancelling the clan's /lfp posting, and answering applications |
VIEW_LOGS | View logs | The logs menu |
FOCUS | Set focus | /clan focus, setting and clearing |
CAMP | Set camp | /clan camp |
RALLY | Call rally | /clan rally, /clan rally clear |
MANAGE_WEBHOOK | Manage webhook | Connecting, testing, configuring and removing the clan's Discord webhook |
MANAGE_WARS | Manage wars | Declaring, accepting and declining clan wars |
Every one has a toggle in Manage Role. BUILD, OPEN_DOORS and OPEN_CONTAINERS only apply when protection-mode is BUILTIN, see Claim land. Do not confuse these rank permissions with the server permissions in Permissions.
Technical details
default-roles:
leader:
name: Leader
weight: 100
permissions: [all 29, see the table]
is-default: false
officer:
name: Officer
weight: 50
permissions: [INVITE, KICK, BAN, PROMOTE, DEMOTE, SEND_ALLIANCE_REQUEST, ACCEPT_ALLIANCE, REMOVE_ALLY, MANAGE_RIVALS, SET_HOME, REGROUP, DEPOSIT_BANK, WITHDRAW_BANK, SEND_CLAN_MAIL, MANAGE_LFP, VIEW_LOGS, FOCUS, CAMP, RALLY, MANAGE_WARS]
is-default: false
member:
name: Member
weight: 1
permissions: [FOCUS]
is-default: true| Key | What it does |
|---|---|
name | What players see. Formatting is stripped, the text is trimmed and cut at 32 visible characters; a name empty after cleaning is refused with errors.role-name-invalid. The same applies to ranks written in game. |
weight | Higher outranks lower. |
permissions | The names in the table. Anything not listed is refused; an unknown name is dropped. |
is-default | Whether new members get this rank. |
The shipped leader rank has all 29 permissions; the officer has 20 (no MANAGE_ROLES, TOGGLE_FRIENDLY_FIRE, TOGGLE_OPEN, CLAIM_LAND, UNCLAIM_LAND, BUILD, OPEN_DOORS, OPEN_CONTAINERS, MANAGE_WEBHOOK); the member has only FOCUS.
Before 1.2.0 the marker commands checked no rank permission, so on the first start of 1.2.0 every existing rank was given FOCUS, CAMP and RALLY once (recorded in plugins/ExyliaClans/.migrations). MANAGE_WEBHOOK and MANAGE_WARS are not granted to existing ranks, so only the leader uses them until a clan ticks them for someone else.
Something missing on this page? Tell us on Discord