Skip to main content

​
Prerequisites

Before installing ClansPlus, ensure your server meets the requirements:
  • Server Software: Spigot, Paper, or Folia (1.16+)
  • Java Version: Java 11 or newer
  • API Version: 1.16+

​
Installation Steps

1

Download ClansPlus

Download the latest version of ClansPlus from the official source:
  • SpigotMC Resource Page
  • GitHub Releases
Ensure you download the .jar file compatible with your server version.
2

Install the Plugin

Place the ClansPlus JAR file into your server’s plugins folder:
/your-server-directory/plugins/ClansPlus.jar
Do not rename the JAR file, as this may cause issues with updates and dependencies.
3

Install Dependencies (Optional)

For full functionality, install these optional soft dependencies:For Economy Support:
  • Download Vault (for Spigot/Paper)
  • OR VaultUnlocked (for Folia)
  • Install an economy plugin (EssentialsX, BetterEconomy, etc.)
For Alternative Currency:For Placeholders:Place all dependency JARs in your plugins folder alongside ClansPlus.
Folia Users: Use VaultUnlocked instead of Vault to prevent errors. BetterEconomy is recommended for the economy plugin.
4

Start Your Server

Start or restart your Minecraft server to load ClansPlus:
java -jar server.jar
Watch the console for ClansPlus initialization messages:
[ClansPlus] Loading ClansPlus v3.0
[ClansPlus] Loaded config.yml
[ClansPlus] Version: 3.0
[ClansPlus] Author: Cortez_Romeo
The plugin will generate configuration files in plugins/ClansPlus/.
5

Verify Installation

Check that ClansPlus loaded successfully:In Console:
[ClansPlus] Support:
[SUPPORTED] Vault
[SUPPORTED] PlaceholderAPI
[SUPPORTED] PlayerPoints
In Game:
/clan
You should see the ClansPlus command menu or GUI.

​
Initial Configuration

After installation, configure ClansPlus to match your server’s needs.

​
Main Configuration File

The main configuration file is located at: 
plugins/ClansPlus/config.yml

​
Essential Settings

# Set your preferred language
# Options: en (English), vi (Vietnamese)
language: en

​
Database Configuration

ClansPlus supports two database types:
Important: After changing database type, restart your server. Use /clanadmin transferPluginDatabaseType to migrate existing data between database types.

​
Configure Permissions

Grant admin permissions to manage ClansPlus:
permissions.yml
permissions:
  clanplus.admin:
    description: Full access to ClansPlus admin commands
    default: op
Optional Permissions:
  • clanplus.setspawn - Allow setting clan spawn points
  • clanplus.seticon - Allow setting custom clan icons
  • clanplus.setcustomname - Allow custom clan names with colors
  • clanplus.setmessage - Allow setting clan messages
  • clanplus.setpermission - Allow customizing clan permissions

​
Soft Dependencies Setup

If you installed optional dependencies:
1

Vault/VaultUnlocked + Economy

Install Vault (or VaultUnlocked for Folia) and an economy plugin:
  1. Install Vault/VaultUnlocked
  2. Install economy plugin (EssentialsX, CMI, BetterEconomy, etc.)
  3. Restart server
  4. Verify in console:
[ClansPlus] [SUPPORTED] Vault
2

PlayerPoints

For alternative point-based currency:
  1. Install PlayerPoints
  2. Configure in config.yml:
currency-requirement:
  type: PLAYERPOINTS
  value: 1000
3

PlaceholderAPI

For clan placeholders in other plugins:
  1. Install PlaceholderAPI
  2. Restart server
  3. Use placeholders like %clanplus_clan_name%
See the API documentation for a full list of available placeholders.

​
File Structure

After installation, ClansPlus creates the following structure: 
plugins/ClansPlus/
├── config.yml              # Main configuration
├── events.yml              # Clan war event settings
├── skills.yml              # Skill configurations
├── upgrade.yml             # Upgrade costs and settings
├── inventories/            # GUI inventory configs
│   ├── clan-menu-inventory.yml
│   ├── member-list-inventory.yml
│   └── ...
├── languages/              # Language files
│   ├── language_en.yml
│   └── language_vi.yml
├── backup/                 # Database backups
└── h2Database.mv.db        # H2 database file (if using H2)

​
Verification

Test your installation:
  1. Join your server as a player
  2. Run command: /clan
  3. Expected result: ClansPlus GUI opens or command help displays
If you see “You must be in a clan to do this,” the plugin is working correctly!

​
Troubleshooting

  • Check you’re using Java 11 or newer: java -version
  • Verify server is Spigot/Paper/Folia, not Bukkit
  • Check console for error messages
  • Ensure the JAR file is in the plugins folder
Folia servers must use VaultUnlocked instead of Vault:
  1. Remove Vault from plugins folder
  2. Install VaultUnlocked
  3. Install BetterEconomy or compatible economy plugin
  4. Restart server
If you see database errors:
  1. Stop the server
  2. In config.yml, set fix-bug-database: enabled: true
  3. Start the server
  4. Check console for resolved issues
  • Verify you have permission: clanplus.admin for admin commands
  • Check if another plugin conflicts with /clan command
  • Try aliases: /clansplus, /guild, /team

​
Next Steps

Now that ClansPlus is installed, learn how to create your first clan!

Quick Start Guide

Create your first clan and explore basic features

Build docs developers (and LLMs) love

Get started for freeTalk to us