Clans

Clans with roles, a shared bank, levels, private chat, a menu and a value leaderboard. Every block mined by a member adds value to the clan.

Module: clans. Placeholders: %pulseprison_clan_name%, _tag, _level, _members, _balance and _value.

Configuration — `clans.yml`

yaml

clans:
  min-name-length: 3
  max-name-length: 16
  max-tag-length: 4
  max-members: 50

  levels:
    1:
      required-exp: 0
      bank-limit: 10000
      member-slots: 10
    2:
      required-exp: 5000
      bank-limit: 25000
      member-slots: 20
    3:
      required-exp: 15000
      bank-limit: 50000
      member-slots: 30
    4:
      required-exp: 40000
      bank-limit: 100000
      member-slots: 40
    5:
      required-exp: 100000
      bank-limit: 250000
      member-slots: 50

  roles:
    leader:
      permissions:
        - invite
        - kick
        - disband
        - deposit
        - withdraw
        - manage-roles
    manager:
      permissions:
        - invite
        - kick
        - deposit
        - withdraw
    member:
      permissions:
        - deposit
        - withdraw
    recruit:
      permissions:
        - deposit

Clan levels

Level	Required EXP	Bank limit	Members
1	0	$10,000	10
2	5,000	$25,000	20
3	15,000	$50,000	30
4	40,000	$100,000	40
5	100,000	$250,000	50

Role hierarchy

text

LEADER        → Every permission
  └── MANAGER → Invite, Kick, Deposit, Withdraw
        └── MEMBER  → Deposit, Withdraw
              └── RECRUIT → Deposit only

Commands

Command	Aliases	Permission	Description
`/clan create <name>`	`/c create`	`pulseprison.clan`	Create a clan (3-16 alphanumeric characters)
`/clan disband`		`pulseprison.clan`	Disband the clan (leader only)
`/clan invite <player>`		`pulseprison.clan`	Invite a player (leader/manager)
`/clan join <clan>`		`pulseprison.clan`	Accept a pending invitation
`/clan deny <clan>`		`pulseprison.clan`	Decline an invitation
`/clan kick <player>`		`pulseprison.clan`	Kick a member (hierarchy checked)
`/clan leave`		`pulseprison.clan`	Leave the clan (not the leader)
`/clan chat <message>`		`pulseprison.clan`	Private clan chat
`/clan info [name]`		`pulseprison.clan`	Clan information
`/clan deposit <amount>`		`pulseprison.clan`	Deposit into the clan bank
`/clan withdraw <amount>`		`pulseprison.clan`	Withdraw from the bank (leader/manager)
`/clan promote <player>`		`pulseprison.clan`	Promote a member
`/clan demote <player>`		`pulseprison.clan`	Demote a member
`/clan list [page]`		`pulseprison.clan`	Paginated clan list
`/clan top`		`pulseprison.clan`	Leaderboard by mined value
`/clan menu`		`pulseprison.clan`	Clan menu (`menus/clan.yml`)
`/clan help`		`pulseprison.clan`	Help

Global aliases: /clans, /c

Invitations

Invitations expire after 5 minutes
A player can't be in two clans
Names may only contain letters, numbers and underscores

Clan JSON data

json

// plugins/PulsePrison/data/clans/{CLAN_UUID}.json
{
  "clanId": "550e8400-e29b-41d4-a716-446655440001",
  "name": "EliteClan",
  "tag": "ELITE",
  "leaderUUID": "550e8400-e29b-41d4-a716-446655440000",
  "level": 3,
  "exp": 15000,
  "bankBalance": 50000.00,
  "creationDate": 1707349452000,
  "members": [
    "550e8400-e29b-41d4-a716-446655440000",
    "550e8400-e29b-41d4-a716-446655440002"
  ]
}