Content generated with AI — it may contain mistakes.

ExyliaClans/GuidesguideUpdated in v1.4.0

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.

Page 5 of 296 min read

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 needs DEMOTE. /clan promote and /clan demote open 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.
Leave gaps between weights

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.

An empty default-roles breaks clan creation

/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
PermissionMenu buttonWhat it allows
INVITEInvite member/clan invite, cancelling an invite
KICKKick member/clan kick
BANBan member/clan ban, /clan unban
PROMOTEPromote memberAssigning a rank above the member's current one
DEMOTEDemote memberAssigning a rank below it
MANAGE_ROLESManage rolesCreating, renaming and deleting ranks, weights, the default rank, ticking permissions
SEND_ALLIANCE_REQUESTSend alliance request/clan ally add
ACCEPT_ALLIANCEAccept alliance/clan ally accept, /clan ally decline
REMOVE_ALLYRemove ally/clan ally remove
MANAGE_RIVALSManage rivals/clan rival add, /clan rival remove
SET_HOMESet home/clan sethome
REGROUPCall regroup/clan regroup
DEPOSIT_BANKDeposit bank/clan deposit
WITHDRAW_BANKWithdraw bank/clan withdraw
TOGGLE_FRIENDLY_FIREFriendly fire/clan ff
TOGGLE_OPENToggle open/clan open
CLAIM_LANDClaim land/clan claim, /clan reclaim
UNCLAIM_LANDUnclaim land/clan unclaim
BUILDBuild in claimPlacing and breaking blocks, buckets and item frames inside the clan's own claim
OPEN_DOORSOpen doorsDoors, trapdoors and fence gates inside the claim
OPEN_CONTAINERSOpen containersChests and every other container inside the claim
SEND_CLAN_MAILSend clan mailSending mail to the whole clan
MANAGE_LFPManage LFPPosting, editing, renewing and cancelling the clan's /lfp posting, and answering applications
VIEW_LOGSView logsThe logs menu
FOCUSSet focus/clan focus, setting and clearing
CAMPSet camp/clan camp
RALLYCall rally/clan rally, /clan rally clear
MANAGE_WEBHOOKManage webhookConnecting, testing, configuring and removing the clan's Discord webhook
MANAGE_WARSManage warsDeclaring, 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
yaml
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
KeyWhat it does
nameWhat 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.
weightHigher outranks lower.
permissionsThe names in the table. Anything not listed is refused; an unknown name is dropped.
is-defaultWhether 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