# ⚔️ Welcome to ClansPlugin!
**ClansPlugin** is a lightweight, highly customizable, and feature-rich clan management system for your Minecraft server.
Let your players team up, create alliances, and dominate the server!
---
## ✨ Features
- **Easy Clan Management**
Players can easily create, disband, and manage their clans.
- **Role System**
Assign different roles within the clan (e.g., Leader, Moderator, Member).
- **Clan Chat**
Private communication channel for clan members.
- **Economy Integration**
Charge players for creating or expanding clans (powered by Vault).
- **Fully Customizable**
Tweak messages, settings, and costs in `config.yml`.
---
## 📦 Dependencies
To get the most out of ClansPlugin, the following plugins are required/supported:
- **[Vault]** – Required for economy features (creating clans, clan banks).
- **[PlaceholderAPI]** – Required to display clan tags and stats on scoreboards, chat formatting, and tab lists.
- **[LuckPerms]** – Highly recommended for seamless permission and prefix/suffix management.
---
## ⚙️ PlaceholderAPI Integration
Use these placeholders to display clan stats on scoreboards, chat formats, and tab lists.
### 👤 Player Placeholders
- `%clanes_has_clan%` — Returns true/false if the player is in a clan.
- `%clanes_player_clan%` — The player's clan name.
- `%clanes_player_clan_tag%` — The player's clan tag.
- `%clanes_player_rank%` — The player's rank/role within the clan.
- `%clanes_player_rank_color%` — The color code of the player's rank.
- `%clanes_player_rank_formatted%` — Formatted player's rank with colors.
- `%clanes_player_is_leader%` — Returns true/false if the player is the clan leader.
### 🏰 Clan Placeholders
- `%clanes_clan_name%` — Clan name.
- `%clanes_clan_tag%` — Clan tag.
- `%clanes_clan_level%` — Clan level.
- `%clanes_clan_exp%` — Current clan EXP.
- `%clanes_clan_exp_needed%` — EXP required for the next level.
- `%clanes_clan_progress%` — Visual progress bar.
- `%clanes_clan_progress_percent%` — Level progress in percentage (%).
- `%clanes_clan_members%` — Current number of members.
- `%clanes_clan_max_members%` — Maximum member limit.
- `%clanes_clan_balance%` — Clan bank balance.
- `%clanes_clan_pvp%` — Clan friendly-fire status (ON/OFF).
- `%clanes_clan_description%` — Clan description.
- `%clanes_clan_motd%` — Clan Message of the Day (MOTD).
- `%clanes_clan_territory%` — Number of claimed chunks.
- `%clanes_clan_max_territory%` — Maximum chunks allowed.
- `%clanes_clan_allies%` — Current number of allies.
- `%clanes_clan_max_allies%` — Maximum ally limit.
- `%clanes_clan_wars_won%` — Total wars won.
- `%clanes_clan_wars_played%` — Total wars played.
- `%clanes_clan_position%` — Clan's position on the leaderboard.
- `%clanes_clan_in_war%` — Returns true/false if the clan is currently in a war.
- `%clanes_clan_chests%` — Available clan chests.
- `%clanes_clan_leader%` — Name of the clan leader.
### 🏆 Top Rankings Placeholders
> **Note:** You can change the number `1` to any number like `2`, `3`, etc., to show other positions.
- `%clanes_top_level_1_name%` — #1 Clan by level (Name).
- `%clanes_top_level_1_value%` — #1 Clan by level (Value).
- `%clanes_top_balance_1_name%` — #1 Clan by balance (Name).
- `%clanes_top_balance_1_value%` — #1 Clan by balance (Value).
- `%clanes_top_wars_1_name%` — #1 Clan by wars won (Name).
- `%clanes_top_wars_1_value%` — #1 Clan by wars won (Value).
