KuClans 1.0

# KuClans

KuClans is a lightweight Paper plugin for Minecraft that provides clan management, clan chat, and a clan points system—designed primarily for PvP servers. It supports multi-language messages and integrates with PlaceholderAPI to expose clan placeholders for scoreboards and UI elements.

## Features

- Clan creation, invites, and persistent clan data
- Clan chat (team chat) with configurable format
- Clan points system and leaderboard to encourage competition
- Multi-language support. (English and Spanish included; easily extendable)
- Optional PlaceholderAPI integration for placeholders and scoreboards
- Designed and tuned for PvP servers and competitive gameplay

## Configuration

Main configuration lives in `config.yml` (generated in the plugin folder after the first run). Important keys:

- `database.type` — `sqlite` or `mysql`
- `max-members-per-clan` — maximum players in a clan (`-1` = unlimited)
- `clan-send-message-join-member` — whether to announce when a player joins a clan
- `clan-inventory-enabled` — enable the clan inventory UI
- `clan-chat.format` — format for clan chat messages

Language files are located in `resources/lang/` in the source and will be copied to the plugin data folder on first run. Edit `en_us.yml` or `es_es.yml` to customize messages or add translations.

## Points system

KuClans includes a clan points system intended to promote PvP competition. Points are awarded for clan kills: when a player kills a member of another clan the responsible clan gains points. These points can be used to rank clans on leaderboards and to trigger rewards or server events. Configure points-related behavior in `config.yml` (look for a `points` section or related keys) and use the provided placeholders to display leaderboard data in scoreboards or GUIs.

Purpose:
- Reward PvP activity (kills, objectives) and create competitive progression between clans.
- Provide leaderboard visibility via placeholders and UI integrations.

Basic setup:
- Adjust points earning/loss rules in `config.yml`.
- Ensure your server plugins that grant or track PvP events (kills, captures) are compatible or hooked into KuClans if you add custom integrations.

## PvP focus

KuClans is tailored for PvP servers: clan mechanics, chat, and the points leaderboard are optimized to support competitive player-versus-player gameplay and large-scale clan battles.

## Commands

- `/clan` — clan management.
- `/clanchat` — clan chat toggle and messaging.
- `/kuclans` — admin commands such as reload.

## Placeholders

- `%kuclans_top_1_name%` — name of top clan #1
- `%kuclans_top_1_points%` — points of top clan #1
- `%kuclans_clan_name%` — the player's clan name
- `%kuclans_clan_kills%` — deaths of the clan
- `%kuclans_in_clan%` — if the player is in a clan (true/false)
- `%kuclans_display_name%` — the player's display name with clan tag