mClans

Clans

Features

* Modular Design: Create, join, and manage clans with configurable roles (Leader, Deputy, Member). * Modular Design: Earn points for killing other players. * Modular Design: Supports multiple databases (MongoDB, MySQL, FLAT). * Modular Design: Clean API allowing developers to extend functionality.

Installation

1. Download the latest version from the releases page. 2. Place the JAR file into your server’s `plugins` directory. 3. Restart the server. 4. Configure the plugin in the `plugins/Clans` folder.

Permissions

* `clans.create` – Create clans * `clans.invite` – Invite players to a clan * `clans.kick` – Kick members from a clan * `clans.upgrade` – Upgrade clan properties * `clans.admin` – Administrative commands

Commands

* `/clan create <tag>` – Create a new clan * `/clan invite <player>` – Invite a player to your clan * `/clan join` – Join a clan (if you have been invited) * `/clan leave` – Leave your current clan * `/clan info [tag]` – Display clan information * `/clan deputy <player>` – Assign a deputy to a clan member * `/clan menu` – Open the upgrade and member management menu * `/clan delete` – Delete a clan * `/clan pvp <on/off/toggle>` – Edit the clan PvP status

Configuration

Clear and simple YML configuration.

PlaceholderAPI

For the displayed player: `%clans_user_{kills/deaths/assists/points}%`

For the player leaderboard (from 1 to 100): `%clans_users_{1-100}_{kills/deaths/assists/points}%`

For the player’s clan: `%clans_clan_{kills/deaths/assists/points}%`

For the clan leaderboard (from 1 to 100): `%clans_clans_{1-100}_{kills/deaths/assists/points}%`

Developer API

Easy, clean, and well-structured — check out the API module.

Building the Project

1. Clone the repository 2. Run `./gradlew build` 3. Find the built JAR file in `spigot/build/libs/`

Contributing

Contributions are welcome! You can submit pull requests or open issues for bugs and feature suggestions. I also appreciate constructive criticism — if something is poorly designed, let me know!

License

This project is licensed under the MIT License — see the LICENSE file for more information.