Skip to main content

​
Overview

The config.yml file is the main configuration file for ClansPlus. It controls core plugin behavior, performance settings, and default clan settings.

​
File Location

plugins/ClansPlus/config.yml

​
Debug Settings

​
debug.enabled
boolean
default:"false"
Enable debug mode for troubleshooting. Only enable when necessary.
​
debug.prefix
string
default:"&e[CLAN+ DEBUG] "
Prefix for debug messages displayed in console and chat.

​
Language Configuration

​
language
string
default:"en"
Language to be used for displaying messages.Available Options:
  • en - English
  • vi - Vietnamese
See Messages Configuration for customization.

​
Progress Bar Display

​
progress-bar.total-bars
integer
default:"20"
Total number of bars to display in progress indicators.
​
progress-bar.symbol.completed
string
default:"&2&m━"
Symbol and color for completed portion of progress bar.
​
progress-bar.symbol.not-completed
string
default:"&f&m━"
Symbol and color for incomplete portion of progress bar.

​
Clan Creation Settings

​
clan-settings.creating-clan-settings.currency-requirement.enabled
boolean
default:"true"
Whether creating a clan requires currency payment.
​
clan-settings.creating-clan-settings.currency-requirement.type
string
default:"VAULT"
Currency type required to create a clan.Available Options:
  • VAULT - Economy via Vault
  • PLAYERPOINTS - PlayerPoints plugin
​
clan-settings.creating-clan-settings.currency-requirement.value
number
default:"1000"
Cost in the specified currency to create a clan.
​
clan-settings.creating-clan-settings.maximum-member-default
integer
default:"5"
Default maximum number of members when a clan is created.
​
clan-settings.creating-clan-settings.icon-default.type
string
default:"MATERIAL"
Default icon type for new clans.Options:
  • MATERIAL - Minecraft material
  • CUSTOMHEAD - Custom player head
​
clan-settings.creating-clan-settings.icon-default.value
string
default:"ITEM_FRAME"
Material name or custom head value for the default clan icon.
​
clan-settings.creating-clan-settings.max-storage-default
integer
default:"1"
Number of storage inventories available to new clans. Set to 0 to disable.

​
Skill Level Defaults

​
clan-settings.creating-clan-settings.skill-level-default
object
Default skill levels by skill ID for newly created clans.
skill-level-default:
  1: 0  # Skill ID 1 starts at level 0
  2: 0  # Skill ID 2 starts at level 0
  3: 0  # Skill ID 3 starts at level 0
  4: 0  # Skill ID 4 starts at level 0
You can add or remove skill entries as needed.

​
Creation Broadcast

​
clan-settings.creating-clan-settings.creation-broadcast
array
Messages broadcast to the entire server when a clan is created. One random message from the list is selected.Available Placeholders:
  • %player% - Player who created the clan
  • %clanName% - Name of the new clan
Set to a single empty line - '' to disable broadcasts.
creation-broadcast:
  - '&#3498eb&lNEW CLAN&r &#35d11d&l| &e%player% &fjust created a new clan named &b%clanName%&f.'
  - '&#3498eb&lNEW CLAN&r &#35d11d&l| &b%clanName% &fjust got created by &e%player%&f.'

​
Spawn Settings

​
clan-settings.spawn-settings.enabled
boolean
default:"true"
Enable clan spawn teleportation feature.
​
clan-settings.spawn-settings.countdown.enabled
boolean
default:"true"
Enable countdown before teleporting to clan spawn.
​
clan-settings.spawn-settings.countdown.seconds
integer
default:"5"
Seconds to wait before teleporting. Player must stand still.

​
Set Spawn Settings

​
clan-settings.set-spawn-settings.blacklist-worlds.enabled
boolean
default:"true"
Enable world blacklist for setting clan spawn points.
​
clan-settings.set-spawn-settings.blacklist-worlds.worlds
array
List of world names where spawn points cannot be set.
worlds:
  - blacklistworld1
  - blacklistworld2

​
Invite Settings

​
clan-settings.invite-settings.time-to-accept
integer
default:"30"
Seconds a player has to accept a clan invitation before it expires.

​
Clan Name Settings

​
clan-settings.clan-name-settings.prohibited-name
array
List of names that cannot be used for clan names or custom names.
prohibited-name:
  - admin
  - staff
  - moderator
​
clan-settings.clan-name-settings.prohibited-character
array
List of characters not allowed in clan names.
The & character is still allowed for custom names to enable color codes.
prohibited-character:
  - '&'
​
clan-settings.clan-name-settings.minimum-length.clan-name
integer
default:"3"
Minimum character length for clan names (excluding color codes).
​
clan-settings.clan-name-settings.maximum-length.clan-name
integer
default:"20"
Maximum character length for clan names (excluding color codes).
​
clan-settings.clan-name-settings.minimum-length.clan-custom-name
integer
default:"3"
Minimum character length for custom clan names (excluding color codes).
​
clan-settings.clan-name-settings.maximum-length.clan-custom-name
integer
default:"30"
Maximum character length for custom clan names (excluding color codes).

​
Chat Settings

​
chat-settings.use-paper-async-chat
boolean
default:"false"
Use Paper’s async chat event system.
Some chat plugins have not yet supported Paper async chat. Setting this to true may cause issues where ClansPlus still sends messages even when using clan chat features.
​
chat-settings.stop-using-chat-word
string
default:"?cancel"
Word players can type to cancel chat interactions like setting custom names or messages.

​
Sign Input Settings

​
sign-input-settings.time-out
integer
default:"15"
Seconds before sign input prompts (like search) automatically close.

​
Vanish Settings

​
vanish-settings.hide-vanish-player.enabled
boolean
default:"true"
Whether to show vanished players in GUIs. When enabled, vanished players appear as OFFLINE.
Supports SuperVanish, PremiumVanish, EssentialsX, VanishNoPacket, and other vanish plugins.

​
Storage Settings

​
storage-settings.enabled
boolean
default:"true"
Enable clan storage feature.
​
storage-settings.slots
integer
default:"54"
Number of inventory slots per storage (standard chest = 27, double chest = 54).
Changing this value after clans have created storage may cause item loss!
​
storage-settings.max-storage
integer
default:"30"
Maximum number of storage inventories a clan can have.Storage numbers exceeding this limit cannot be used or upgraded.

​
Custom Heads Support

​
custom-heads.API-v2.enabled
boolean
default:"true"
Use minecraft-heads.com API v2 for custom head support.
ClansPlus version 2.8 and below used API v1, which is outdated. API v2 will become mandatory in future versions.
​
custom-heads.API-v2.custom-key
string
default:""
Custom API key for Patreon supporters of minecraft-heads.com. Leave blank to use the default key.If you have a Patreon account linked with minecraft-heads.com, you can use your custom key to access more heads.

​
Join Messages

​
clan-settings.messages-settings.on-join.war-event.enabled
boolean
default:"true"
Send war event status to players when they join.
​
clan-settings.messages-settings.on-join.war-event.delay
integer
default:"1"
Delay in seconds before sending war event status.
​
clan-settings.messages-settings.on-join.clan-broadcast.enabled
boolean
default:"true"
Send clan broadcast messages to players when they join.
​
clan-settings.messages-settings.on-join.clan-broadcast.delay
integer
default:"2"
Delay in seconds before sending clan broadcast.

​
Example Configuration

config.yml
# Basic setup example
debug:
  enabled: false
  prefix: '&e[CLAN+ DEBUG] '

language: en

clan-settings:
  creating-clan-settings:
    currency-requirement:
      enabled: true
      type: VAULT
      value: 1000
    maximum-member-default: 5
    icon-default:
      type: MATERIAL
      value: ITEM_FRAME
    max-storage-default: 1

  spawn-settings:
    enabled: true
    countdown:
      enabled: true
      seconds: 5

  invite-settings:
    time-to-accept: 30

storage-settings:
  enabled: true
  slots: 54
  max-storage: 30
After modifying config.yml, restart your server for changes to take effect.

Build docs developers (and LLMs) love

Get started for freeTalk to us