Clans
Let players team up in clans with roles, a private chat, a home, a shared bank, levels, alliances and clan land.
The Clans module lets players create clans and play together. Clans are shared across your whole network: a player sees the same clan, members and bank on every server.
This module requires the complete edition. See editions.
Features
- Create and manage a clan with a name and a short tag, from commands or from an in game menu.
- Roles. Each member has a role. You decide which roles exist, how high each one is and what each one is allowed to do (invite, remove, promote, claim land, withdraw from the bank and more). The leader can always do everything.
- Invitations and join requests. Members invite players with a clickable message. Players can also ask to join a closed clan, or join an open clan directly.
- Clan chat and allies chat. Send a single message or toggle a chat mode so everything you type goes to your clan or to your allies.
- Tag in chat and tab. The clan tag can be shown before player names through the
{clan}variable of the chat and tab formats, and through placeholders for other plugins. - Clan home that members can teleport to, on any server of the network.
- Clan bank. Members deposit money, roles with the right permission withdraw it. The last movements are listed with
/clan bank. Needs the economy module. - Alliances and enemies. Allies cannot hurt each other (unless you allow it) and can be given access to the clan land. Killing a member of an enemy clan gives more clan XP.
- Levels. Clans earn XP by playing, killing players and, if you use the progress module, from a share of their members' XP. Each level raises the member limit, the claim blocks and the bank limit, and unlocks tag colors.
- Clan land. Clans claim land together with their own pool of claim blocks. Needs the claims module.
- Rankings by level, members, bank or kills, in game with
/clan topand through placeholders. - Inactive clans can be disbanded automatically after a number of days.
- Full control from the web editor: browse and search every clan, rename it, change its tag and color, open or close it, add or take money from the bank, give or remove XP, change roles, remove members, pass the leadership, remove the home or disband the clan.
Setting it up
Open the Clans module in the web editor. It has four tabs: Clans, Roles, Levels and Commands, plus the Settings tab.
Clans
Lists every clan with its level, members, bank, land, allies and enemies, and leader. Click a clan to edit it. Disbanding a clan from here releases its members, frees its land and gives the bank to the leader if Give the bank to the leader when disbanded is on.
Roles
Each row is a role:
| Column | What it does |
|---|---|
| Name | The role name shown to players. |
| Id | A short identifier, lowercase letters, digits and _ only. Players can use it with /clan role. |
| Weight | Heavier roles are higher and can manage lighter ones. New members get the lightest role. |
| On clan land | What the role can do on the clan land: Nothing, Doors, Chests, Build or Manage. |
| Invite | Invite players and answer join requests. |
| Remove | Remove lower members. |
| Promote | Promote or demote lower members. |
| Roles | Give any lower role, open or close the clan. |
| Land | Claim and release clan land. |
| Withdraw | Take money from the bank. |
| Home | Set or remove the clan home. |
| Alliances | Ask for or end alliances. |
| Enemies | Declare enemies. |
The leader role is required and is always the highest. You need at least one other role. By default there are four roles: Leader, Officer, Member and Recruit.
Levels
Each row is a level:
| Column | What it does |
|---|---|
| Level | The level number. |
| Total XP | XP the clan needs to reach this level. One level must need 0 XP (the starting level). |
| Members | Maximum number of members. |
| Claim blocks | Total area of land the clan can claim. |
| Bank limit | Maximum amount in the bank. 0 means no limit. |
| Tag colors | Color codes unlocked at this level, for example a, b. They stay available at the following levels. |
By default there are five levels, from 5 to 20 members.
Settings
| Setting | What it does | Default |
|---|---|---|
| General | ||
| Currency | Currency used for the creation price, the renaming price and the bank. Empty means the main currency. | Main currency |
| Creating a clan | ||
| Creation price | What it costs to create a clan. 0 means free. | 1000 |
| Shortest name / Longest name | Allowed length of clan names. | 3 / 16 |
| Shortest tag / Longest tag | Allowed length of clan tags. | 2 / 5 |
| Characters allowed in names | Letters and digits, Letters, digits and spaces, or With accents and spaces. Tags only accept letters and digits, and colors are never allowed. | Letters, digits and spaces |
| Forbidden words | Refused in names and tags, even written with digits like 4dm1n. |
A list of common staff words and insults |
| Default tag color | The color every clan can use. Other colors are unlocked by levels or with a permission. | Gray |
| Renaming | ||
| Renaming price | What it costs to rename the clan. | 500 |
| Time between two renamings | How long a clan must wait before renaming again. | 7d |
| Members | ||
| Invitations expire after | How long an invitation stays valid. | 5m |
| Join requests | Players can ask to join a closed clan. Members allowed to invite accept or decline. | On |
| New clans are open | An open clan can be joined without invitation. | Off |
| Chat and tag | ||
| Clan chat | Format of clan chat messages. Variables: {tag}, {clan}, {role}, {player}, {message}. |
|
| Allies chat | Format of allies chat messages, same variables. | |
| Tag shown before names | Used by {clan} in the chat and tab formats, and by %ingliscore_clan_tag%. Variables: {color}, {tag}, {clan}. |
|
| Alliances and PvP | ||
| Alliances | Lets clans become allies. | On |
| Allies per clan | Maximum number of allies. 0 means no limit. | 3 |
| Enemies | Lets clans declare another clan an enemy. | On |
| Members can hurt each other | Allows PvP between members of the same clan. | Off |
| Allies can hurt each other | Allows PvP between allied clans. | Off |
| Allies on clan land | What allies can do on your clan's land: Nothing, Doors and buttons, Chests too, or Build too. | Doors and buttons |
| Clan XP | ||
| XP per hour played | Given for each member online. Players who are away from keyboard give nothing. | 10 |
| XP per player killed | Given when a member kills a player who is not in the clan or an ally. | 5 |
| XP per enemy killed | Given instead when the victim belongs to an enemy clan. | 15 |
| Share of members' XP (%) | Part of the XP members earn with the progress module that also goes to their clan. | 10 |
| Clan home | ||
| Clan home | Turns the clan home on or off. | On |
| Only on clan land | The home can only be set on land claimed by the clan. | Off |
| Clan bank | ||
| Clan bank | Turns the bank on or off. | On |
| Give the bank to the leader when disbanded | The bank balance goes to the leader when the clan is disbanded. | On |
| Clan land | ||
| Clan land | Lets clans claim land with /clan claim. Needs the claims module. |
On |
| Largest claim radius | Maximum radius accepted by /clan claim <radius>. |
16 |
| Inactivity | ||
| Disband after inactivity (days) | Clans with no member online for this many days are disbanded and their land released. 0 means never. | 0 |
Commands
Every action goes through one command, /clan (aliases /clans and /guild). By default /clan alone opens the clan menu. In the Commands tab you can change its aliases, permission, cooldown, price, worlds and rank rules, and choose whether it opens a menu or answers in the chat. See commands.
| Command | What it does | Who can use it |
|---|---|---|
/clan or /clan menu |
Opens the clan menu. | Everyone |
/clan help |
Lists the main commands. | Everyone |
/clan create <name> <tag> |
Creates a clan. | Players without a clan |
/clan info [clan] |
Shows a clan's level, members, bank and relations. | Everyone |
/clan list [page] |
Lists all clans. | Everyone |
/clan top [level|members|bank|kills] |
Shows the 10 best clans. | Everyone |
/clan invite <player> |
Invites a player. | Invite |
/clan accept [clan] |
Accepts an invitation. | Players without a clan |
/clan deny [clan] |
Declines an invitation. | Everyone |
/clan join <clan> |
Joins an open clan or sends a join request. | Players without a clan |
/clan requests |
Lists join requests with buttons to answer. | Invite |
/clan approve <player> |
Accepts a join request. | Invite |
/clan reject <player> |
Declines a join request. | Invite |
/clan kick <player> |
Removes a lower member. | Remove |
/clan leave |
Leaves the clan, after confirmation. | Members except the leader |
/clan promote <player> |
Moves a member one role up. | Promote |
/clan demote <player> |
Moves a member one role down. | Promote |
/clan role <player> <role> |
Gives a member a lower role. | Roles |
/clan leader <player> |
Passes the leadership to a member. | Leader |
/clan open |
Opens or closes the clan. | Roles |
/clan chat [message] |
Sends a message to the clan, or toggles clan chat mode. | Members |
/clan achat [message] |
Sends a message to allies, or toggles allies chat mode. | Members |
/clan home |
Teleports to the clan home. | Members |
/clan sethome |
Sets the clan home where you stand. | Home |
/clan delhome |
Removes the clan home. | Home |
/clan bank |
Shows the balance, the limit and the last movements. | Members |
/clan deposit <amount> |
Puts money in the bank. | Members |
/clan withdraw <amount> |
Takes money from the bank. | Withdraw |
/clan ally <clan> |
Asks for an alliance, or accepts one. | Alliances |
/clan enemy <clan> |
Declares a clan an enemy. | Enemies |
/clan neutral <clan> |
Ends an alliance or an enmity. | Alliances or Enemies |
/clan claim [radius] |
Claims the chunk you stand in, or a square of the given radius around you. | Land |
/clan unclaim |
Releases the clan land you stand in. | Land |
/clan claims |
Shows used and remaining claim blocks. | Members |
/clan color [code] |
Lists the unlocked colors, or changes the tag color. | Leader |
/clan rename <name> <tag> |
Renames the clan. | Leader |
/clan disband |
Disbands the clan, after confirmation. | Leader |
"Who can use it" refers to the role permissions set in the Roles tab. Leaving and disbanding ask for confirmation: the player clicks the button or types the command again with confirm within 30 seconds.
Permissions
| Permission | What it grants |
|---|---|
inglis.clans.clan |
Use /clan. Everyone has it by default. You can change this node in the Commands tab. |
inglis.clans.free |
Create and rename a clan for free, without the renaming wait. Operators have it by default. |
inglis.clans.color.<code> |
Use this tag color whatever the clan level, for example inglis.clans.color.6 for gold. |
Placeholders
| Placeholder | Value |
|---|---|
%ingliscore_clan_tag% |
The player's clan tag, formatted with Tag shown before names. Empty without a clan. |
%ingliscore_clan_tag_raw% |
The plain clan tag, without colors. |
%ingliscore_clan_name% |
The clan name. |
%ingliscore_clan_role% |
The player's role name. |
%ingliscore_clan_level% |
The clan level. |
%ingliscore_clan_members% |
Number of members. |
%ingliscore_clan_bank% |
The bank balance. |
%ingliscore_clan_top_<board>_<position>_<field>% |
Ranking entry. <board> is level, members, bank or kills, <position> is 1 to 10, <field> is name, tag or value. Example: %ingliscore_clan_top_kills_1_name%. |
Rankings are refreshed at most once per minute. See placeholders for how to use them.
Tips
- Clan land cannot overlap a protected region from the regions module, and can only be claimed in worlds where claims are allowed.
- A member whose role has the Land permission can manage the clan land like a claim manager, whatever its On clan land setting.
- Clan XP is saved once per minute, so a level up message can arrive a little after the kill that caused it.