Admin Commands - ClansPlus

Overview

The /clanadmin command provides server administrators with powerful tools to manage clans, modify data, control events, and maintain the plugin. All commands require the clanplus.admin permission.

Admin commands can make significant changes to clan data. Always create backups before making major modifications.

Permission Required

All /clanadmin commands require:

Permission: clanplus.admin

Core Administration

Reload Plugin

/clanadmin reload

Reloads all plugin configuration files, language files, inventory configurations, and skills without restarting the server. What gets reloaded:

Main config.yml
All inventory configuration files
Language files (English, Vietnamese)
Event configurations
Skill configurations
Upgrade configurations
Discord webhook settings

Example output:

Plugin reloaded (245ms)

Create Backup

/clanadmin backup
/clanadmin backup <custom_file_name>

Creates a backup of all clan and player data in the plugin’s backup folder. Parameters:

<custom_file_name> - (Optional) Custom name for the backup file

Prohibited characters: \ / : * ? < > | Examples:

/clanadmin backup                      # Create backup with auto-generated name
/clanadmin backup pre-update-backup    # Create backup with custom name

Always create a backup before transferring database types or making bulk modifications.

Chat Spy

/clanadmin chatspy

Toggles clan chat spy mode, allowing you to see all clan chat messages across the server. Works for:

Players with clanplus.admin permission
Console (when run from console)

Example:

Clan chat spy enabled successfully.

Database Management

Transfer Database Type

/clanadmin transferPluginDatabaseType <type>

Transfers all clan data from the current database type to a different one. Parameters:

<type> - The target database type: H2, MYSQL, MARIADB, SQLITE

Available types:

H2 - Local H2 database (default)
MYSQL - MySQL database
MARIADB - MariaDB database
SQLITE - SQLite database

For data safety, perform this operation while no players are online. Always create a backup first using /clanadmin backup.

Example:

/clanadmin transferPluginDatabaseType MYSQL

Delete Clan

/clanadmin delete <clan_name>

Permanently deletes a clan and removes all members from it. Parameters:

<clan_name> - The name of the clan to delete

Example:

/clanadmin delete Warriors

Clan Data Management

Set Clan Data

/clanadmin setClanData <clan_name> <type> <action> <value>

Modifies various aspects of a clan’s data. Parameters:

<clan_name> - The name of the clan
<type> - The data type to modify (see table below)
<action> - The action: set, give, remove, reset, add
<value> - The value to apply

Available Types and Actions

Type	Actions	Description	Example
`score`	`set`, `give`, `remove`, `reset`	Clan score points	`/clanadmin setClanData Warriors score give 100`
`warpoint`	`set`, `give`, `remove`, `reset`	War event points	`/clanadmin setClanData Warriors warpoint set 500`
`warning`	`set`, `give`, `remove`, `reset`	Warning count	`/clanadmin setClanData Warriors warning reset`
`createddate`	`set`	Creation timestamp (milliseconds)	`/clanadmin setClanData Warriors createddate set 1234567890`
`customname`	`set`, `reset`	Custom display name	`/clanadmin setClanData Warriors customname set &b&lWarriors`
`message`	`set`, `reset`	Clan message/description	`/clanadmin setClanData Warriors message set Welcome!`
`icon`	`set`	Clan icon	`/clanadmin setClanData Warriors icon set MATERIAL DIAMOND_SWORD`
`subjectpermission`	`set`, `reset`	Permission settings	`/clanadmin setClanData Warriors subjectpermission set INVITE MEMBER`
`discordchannelid`	`set`, `reset`	Discord channel ID	`/clanadmin setClanData Warriors discordchannelid set 123456`
`discordjoinlink`	`set`, `reset`	Discord invite link	`/clanadmin setClanData Warriors discordjoinlink set https://discord.gg/abc`
`members`	`add`, `remove`	Clan member list	`/clanadmin setClanData Warriors members add Steve`
`allies`	`add`, `remove`	Allied clans	`/clanadmin setClanData Warriors allies add Knights`

Icon Type Examples

# Set material icon
/clanadmin setClanData Warriors icon set MATERIAL DIAMOND_SWORD

# Set player head icon
/clanadmin setClanData Warriors icon set PLAYERHEAD Notch

# Set custom head icon
/clanadmin setClanData Warriors icon set CUSTOMHEAD 12345

Subject Permission Examples

# Allow all members to invite
/clanadmin setClanData Warriors subjectpermission set INVITE MEMBER

# Require manager for clan upgrades
/clanadmin setClanData Warriors subjectpermission set UPGRADE MANAGER

# Reset all permissions to default
/clanadmin setClanData Warriors subjectpermission reset

Set Clan Skill Data

/clanadmin setClanSkillData <clan_name> <skill_id> <skill_level>

Directly sets the level of a specific skill for a clan. Parameters:

<clan_name> - The name of the clan
<skill_id> - The numeric ID of the skill
<skill_level> - The level to set

Example:

/clanadmin setClanSkillData Warriors 1 10

Reset All Clans

/clanadmin clanResetAll <type>

Resets a specific stat for all clans on the server. Parameters:

<type> - The stat to reset: score, warpoint, or warning

Examples:

/clanadmin clanResetAll score      # Reset all clan scores
/clanadmin clanResetAll warpoint   # Reset all war points
/clanadmin clanResetAll warning    # Reset all warnings

This action affects ALL clans on the server and cannot be undone. Consider creating a backup first.

Player Data Management

Set Player Data

/clanadmin setPlayerData <player_name> <type> <action> <value>

Modifies player-specific clan data. Parameters:

<player_name> - The player’s username
<type> - The data type to modify (see table below)
<action> - The action: set or reset
<value> - The value to apply

Available Types and Actions

Type	Actions	Description	Example
`clanname`	`set`, `reset`	Player’s clan membership	`/clanadmin setPlayerData Steve clanname set Warriors`
`rank`	`set`	Player’s rank in clan	`/clanadmin setPlayerData Steve rank set MANAGER`
`joindate`	`set`	Join timestamp (milliseconds)	`/clanadmin setPlayerData Steve joindate set 1234567890`
`scorecollected`	`set`, `reset`	Score collected by player	`/clanadmin setPlayerData Steve scorecollected set 1000`
`lastactivated`	`set`	Last activity timestamp	`/clanadmin setPlayerData Steve lastactivated set 1234567890`

Available Ranks

MEMBER - Regular clan member
MANAGER - Clan manager with elevated permissions
LEADER - Clan owner/leader

Examples:

# Add player to a clan
/clanadmin setPlayerData Steve clanname set Warriors

# Promote player to manager
/clanadmin setPlayerData Steve rank set MANAGER

# Remove player from clan
/clanadmin setPlayerData Steve clanname reset

# Reset player's collected score
/clanadmin setPlayerData Steve scorecollected reset

When setting a player’s clan with clanname set, the player is automatically added to the clan’s member list.

Clan Storage Management

Open Clan Storage

/clanadmin openClanStorage <clan_name> <storage_number>

Opens a specific clan storage as an admin for viewing or modification. Parameters:

<clan_name> - The name of the clan
<storage_number> - The storage number to open (1 to max storage)

Example:

/clanadmin openClanStorage Warriors 1

This command is useful for recovering items, investigating issues, or helping clans with storage management.

Event Management

War Event Control

/clanadmin event war <action> [value]

Controls the clan war event system. Available Actions:

Start War Event

/clanadmin event war start

Manually starts a war event. Will not start if one is already running.

End War Event

/clanadmin event war end

Manually ends the current war event. Will not end if no event is running.

Set War Time

/clanadmin event war settime <seconds>

Sets the remaining time for the current war event. Parameters:

<seconds> - The new time remaining in seconds (minimum 1)

Example:

/clanadmin event war settime 600   # Set to 10 minutes remaining

Command Syntax Reference

When running /clanadmin without arguments, you’ll see this helpful syntax guide:

ClanPlus (Version: X.X) - Admin
Plugin developed by Cortez_Romeo

/clanadmin reload
/clanadmin chatspy
/clanadmin transferPluginDatabaseType <type>
/clanadmin backup (custom file name)
/clanadmin setClanData <clan name> <type> <give/add/set/remove/reset> <value>
Types: score, warpoint, warning, createddate, customname, message, icon, 
       spawnpoint, subjectpermission, discordchannelid, discordjoinlink, 
       members, allies
/clanadmin setClanSkillData <clan name> <skill id> <skill level>
/clanadmin setPlayerData <player name> <type> <set/reset> <value>
Types: clanname, rank, joindate, scorecollected, lastactivated
/clanadmin openClanStorage <clan name> <storage number>
/clanadmin clanResetAll <type>
Types: score, warpoint, warning
/clanadmin event <event> <start/end/settime> <value>
/clanadmin delete <clan name>

<>: Required
(): Optional

Best Practices

Before Making Changes

Always create a backup using /clanadmin backup
Test on a development server if possible
Notify players before making major changes
Document your changes for future reference

Database Safety

Backup before transfers - Always run /clanadmin backup before transferring database types
No players online - Ensure no players are online during database transfers
Test the new database - Verify data integrity after transfers
Keep old backups - Don’t delete old backups immediately after transfers

Bulk Operations

Use clanResetAll carefully - This affects all clans simultaneously
Announce beforehand - Let players know about bulk resets (like seasonal score resets)
Consider timing - Perform during low-activity periods
Document the reset - Keep records of when and why resets occur

Player Data Management

Verify player names - Double-check spelling before modifying data
Check current status - Review current data before making changes
Leader transfers - Be careful when changing clan leaders via setPlayerData
Handle disputes carefully - Document reasons for manual interventions

Common Admin Tasks

Seasonal Score Reset

# 1. Announce to players
# 2. Create backup
/clanadmin backup season-3-final

# 3. Reset all scores
/clanadmin clanResetAll score

# 4. Reset all war points
/clanadmin clanResetAll warpoint

Transfer Player Between Clans

# 1. Remove from old clan
/clanadmin setPlayerData Steve clanname reset

# 2. Add to new clan
/clanadmin setPlayerData Steve clanname set Warriors

# 3. Set appropriate rank
/clanadmin setPlayerData Steve rank set MEMBER

Fix Clan Permissions

# Reset to default permissions
/clanadmin setClanData Warriors subjectpermission reset

# Or set specific permission
/clanadmin setClanData Warriors subjectpermission set INVITE MANAGER

Database Migration

# 1. Announce maintenance
# 2. Remove all players from server
# 3. Create backup
/clanadmin backup pre-mysql-migration

# 4. Transfer database
/clanadmin transferPluginDatabaseType MYSQL

# 5. Verify data integrity
# 6. Allow players back

Troubleshooting

Command Not Working

Verify you have clanplus.admin permission
Check console for error messages
Ensure clan/player names are spelled correctly
Try /clanadmin reload to refresh configurations

Database Transfer Failed

Check that no players are online
Verify database credentials in config.yml
Restore from backup if needed
Check console logs for specific errors
Ensure target database is accessible

Data Not Saving

Run /clanadmin reload to refresh
Check file permissions on the plugin folder
Verify database connection is stable
Check console for save errors

Backup Issues

Verify backup folder exists and is writable
Check available disk space
Avoid special characters in backup names
Check console output for specific errors

Get Started

Core Concepts

Configuration

Commands

Features

​Overview

​Permission Required

​Core Administration

​Reload Plugin

​Create Backup

​Chat Spy

​Database Management

​Transfer Database Type

​Delete Clan

​Clan Data Management

​Set Clan Data

​Available Types and Actions

​Icon Type Examples

​Subject Permission Examples

​Set Clan Skill Data

​Reset All Clans

​Player Data Management

​Set Player Data

​Available Types and Actions

​Available Ranks

​Clan Storage Management

​Open Clan Storage

​Event Management

​War Event Control

​Start War Event

​End War Event

​Set War Time

​Command Syntax Reference

​Best Practices

​Common Admin Tasks

​Seasonal Score Reset

​Transfer Player Between Clans

​Fix Clan Permissions

​Database Migration

​Troubleshooting

Build docs developers (and LLMs) love

Overview

Permission Required

Core Administration

Reload Plugin

Create Backup

Chat Spy

Database Management

Transfer Database Type

Delete Clan

Clan Data Management

Set Clan Data

Available Types and Actions

Icon Type Examples

Subject Permission Examples

Set Clan Skill Data

Reset All Clans

Player Data Management

Set Player Data

Available Types and Actions

Available Ranks

Clan Storage Management

Open Clan Storage

Event Management

War Event Control

Start War Event

End War Event

Set War Time

Command Syntax Reference

Best Practices

Common Admin Tasks

Seasonal Score Reset

Transfer Player Between Clans

Fix Clan Permissions

Database Migration

Troubleshooting