SimpleClans
Search…
Configuration
The main configuration file for SimpleClans can be found here.

General Settings

Option
Description
Default
enable-gui
Enables the GUI
true
disable-messages
Disables broadcasts from plugin ("Clan Created", "Clan Disbanded", etc.)
false
tameable-mobs-sharing
If true, tameable mobs will be shared with your clan members. It also disables any clan damage to them
false
teleport-blocks
Fancy teleporting (placed glass block below)
false
teleport-home-on-spawn
Players will be teleported to their clan's home when they respawn
false
drop-items-on-clan-home
Drops defined items on teleporting to clan home
false
keep-items-on-clan-home
Keeps defined items on teleporting to clan home
false
item-list
List of defined items (used with keep-item-on-clan-home and drop-items-on-clan-home)
[]
show-debug-info
Shows debug info on console
false
enable-auto-groups
Manages group of a clan player by auto. (For example, a leader would be added to sc_leader group, trusted player to sc_trusted, etc.)
false
chat-compatibility-mode
Changes method of initiate tags. If you have a problem with tags, try to disable it.
true
rival-limit-percent
The percent of possible rivals per clan
Formula: (rivalsOfClan - 1) * rivalLimitPercent / 100
50
use-colorcode-from-prefix-for-name
Uses the last color code in the end of prefix
true
display-chat-tags
Shows clan tags in chat
true
unrivable-clans
The list of clans, which can't be rivaled
See Example below
show-unverified-on-list
Shows or not unverified clans on /clan list
(Doesn't affect on GUI)
false
blacklisted-worlds
Disables SimpleClans at defined worlds
[]
banned-players
List of banned players from using plugin
[]
disallowed-tags
List of tags, which wouldn't be used on clan creation
See Example below
language
Default language
en
user-language-selector
Allows players to change their language
true
disallowed-tag-colors
The list of tag colors, which wouldn't be used on clan creation
See Example below
server-name
The name of your server
&4SimpleClans
new-clan-verification-required
Should new clans requires being verified?
true
allow-regroup-command
Allows players to use regroup command
true
allow-reset-kdr
Allows players to reset their KDR
true
rejoin-cooldown
The time in minutes, when player will can join after resigning to the same clan
60
rejoin-cooldown-enabled
Should rejoin cooldown be enabled?
false
ranking-type
DENSE: if players have the same KDR, they will have the same rank position. Ex.: 12234
ORDINAL: Every player will have a different rank position. Ex.: 12345
DENSE

Example

1
settings:
2
enable-gui: true
3
disable-messages: false
4
tameable-mobs-sharing: false
5
teleport-blocks: false
6
teleport-home-on-spawn: false
7
drop-items-on-clan-home: false
8
keep-items-on-clan-home: false
9
item-list: []
10
show-debug-info: false
11
mchat-integration: true
12
enable-auto-groups: false
13
chat-compatibility-mode: true
14
rival-limit-percent: 50
15
use-colorcode-from-prefix-for-name: true
16
display-chat-tags: true
17
unrivable-clans:
18
- admin
19
- staff
20
- mod
21
show-unverified-on-list: false
22
blacklisted-worlds: []
23
banned-players: []
24
disallowed-tags:
25
- vip
26
- clan
27
language: en
28
language-per-player: false
29
disallowed-tag-colors:
30
- '4'
31
server-name: '&4SimpleClans'
32
new-clan-verification-required: true
33
allow-regroup-command: true
34
allow-reset-kdr: false
35
rejoin-cooldown: 60
36
rejoin-cooldown-enabled: false
37
ranking-type: DENSE
Copied!

War and protection

Option
Description
Default
war-enabled
Enables the war feature on the server
false
land-sharing
Enables the land sharing feature on the server
true
protection-providers
The list of land claim providers
See Example below
listeners.priority
It's not recommended to change it.
Used to set the priority of the overridden events
HIGHEST
listeners.ignored-list.place
The list of items that will be ignored by SimpleClans.
For example, WorldGuard blocked player' head in the region. If player' head is not on the list, SimpleClans will make WG allow the placement
See Example below
set-base-only-in-land
Allows a clan player to set the clan base only on claimed land
false
war-normal-expiration-time
The time of war expiration independently (in minutes)
0
war-disconnect-expiration-time
The time of war expiration if all members from one clan disconnects (in minutes)
0
edit-all-lands
Allows a clan player to change the action of all the lands instead of the one on which it stands
false
war-actions
The list of permitted actions regarding clan lands during the war
See Example below
war-start.request-enabled
If true, a war will require the approval from the clan leaders
true
war-start.members-online-max-difference
If the difference between the online members of two clans is greater than the one set, the war will not start
Example 1: Config value: 5
Clan #1 has 10 members online
Clan #2 has 5 members online
Max difference between clans = 10 - 5 = 5 The war will start. Example 2: Config value: 5
Clan #1 has 11 members online
Clan #2 has 5 members online
Max difference between clans = 11 - 5 = 6
The war will not start.
5
land-creation.only-leaders
Allows only clan leaders to create lands (not compatible with WorldGuard)
false
land-creation.only-one-per-clan
Allows to have only one land per clan (not compatible with WorldGuard)
false
1
war-and-protection:
2
war-enabled: false
3
land-sharing: true
4
protection-providers:
5
- WorldGuardProvider
6
- WorldGuard6Provider
7
- PlotSquared5Provider
8
- PlotSquared3Provider
9
- GriefPreventionProvider
10
listeners:
11
priority: HIGHEST
12
ignored-list:
13
PLACE:
14
- PLAYER_HEAD
15
set-base-only-in-land: false
16
war-normal-expiration-time: 0
17
war-disconnect-expiration-time: 0
18
edit-all-lands: false
19
war-actions:
20
CONTAINER: true
21
INTERACT: true
22
BREAK: true
23
PLACE: true
24
DAMAGE: true
25
INTERACT_ENTITY: true
26
war-start:
27
request-enabled: true
28
members-online-max-difference: 5
29
land-creation:
30
only-leaders: false
31
only-one-per-clan: false
Copied!

Tags

    default-color - color used when the clan leader didn't set any colors
    max-length - maximum length for tags
    bracket - brackets are the characters around the tag, ex.: [ ]
      color - the bracket color
      leader-color - this color is used when the player is a leader
      left - the left character
      right - the right character
    min-length - minimum length for tags
    separator - the separator is a character that separates the tag and the player name
      color - the separator color
      leader-color - this color is used when the player is a leader
      char - the separator character

Example

1
tag:
2
default-color: '8'
3
max-length: 5
4
bracket:
5
color: '8'
6
leader-color: '4'
7
left: ''
8
right: ''
9
min-length: 2
10
separator:
11
color: '8'
12
leader-color: '4'
13
char: ' .'
Copied!

General Commands

In this section you can edit the base commands of the plugin. Enable force-priority if other plugins are interfering with the commands.

Example

1
commands:
2
more: more
3
ally: ally
4
clan: clan
5
accept: accept
6
deny: deny
7
global: global
8
clan_chat: "."
9
force-priority: true
Copied!

KDR Grinding Prevention

    enable-max-kills - by enabling this, you can set a limit on kills per victim.
    max-kills-per-victim - this is the limit of kills per victim. If it's set to 10, for example, killing the same player for the 11th time won't affect the KDR
    enable-kill-delay - enables a delay between kills
    delay-between-kills - this is the delay in minutes between kills

Example

1
kdr-grinding-prevention:
2
enable-max-kills: false
3
max-kills-per-victim: 10
4
enable-kill-delay: false
5
delay-between-kills: 5
Copied!

Economy

    creation-price - the price to create a clan
    purchase-clan-create - players must pay to create a clan
    verification-price - the price to verify a clan
    purchase-clan-verify - players must pay to verify their clans
    invite-price - the price to invite a player to your clan
    purchase-clan-invite - players must pay to invite
    home-teleport-price - the price to teleport to the clan's home
    purchase-home-teleport - players must pay to teleport
    home-teleport-set-price - the price to set the clan's home
    purchase-home-teleport-set - players must pay to set the clan's home
    home-regroup-price - the price for regrouping the clan members
    purchase-home-regroup - players (or the clan) must pay to regroup
    unique-tax-on-regroup - if false, the price is multiplied by the amount of online members of the clan
    issuer-pays-regroup - if enabled, the player issuing the command pays for the regroup, otherwise the clan pays it
    money-per-kill - enables a prize in money for the killer clan
    money-per-kill-kdr-multipier - this is multiplied by the attacker's KDR, the result is the money prize for the clan
    purchase-reset-kdr - If true, players will be able to reset their KDR
    reset-kdr-price - the price to reset one's KDR
    purchase-member-fee-set - players must pay to set the member fee
    member-fee-set-price - the price to set the member fee
    member-fee-enabled - if clans can charge a daily fee from their members
    max-member-fee - the maximum amount clans can set for their member fee
    upkeep - the daily price for maintaining a clan (if not paid, the clan is disbanded)
    upkeep-enabled - if clans must pay the upkeep
    multiply-upkeep-by-clan-size - if the upkeep price should be multiplied by the amount of members
    charge-upkeep-only-if-member-fee-enabled - if the upkeep should be charged only for clans that choose to enable the member fee
    bank-log.enable - If true, all economy actions will be recorded in .CSV file (SimpleClans/logs/bank/)

Example

1
economy:
2
creation-price: 100.0
3
purchase-clan-create: false
4
verification-price: 1000.0
5
purchase-clan-verify: false
6
invite-price: 20.0
7
purchase-clan-invite: false
8
home-teleport-price: 5.0
9
purchase-home-teleport: false
10
home-teleport-set-price: 5.0
11
purchase-home-teleport-set: false
12
home-regroup-price: 5.0
13
purchase-home-regroup: false
14
unique-tax-on-regroup: true
15
issuer-pays-regroup: true
16
money-per-kill: false
17
money-per-kill-kdr-multipier: 10
18
purchase-reset-kdr: true
19
reset-kdr-price: 10000.0
20
purchase-member-fee-set: false
21
member-fee-set-price: 1000.0
22
member-fee-enabled: false
23
max-member-fee: 200.0
24
upkeep: 200.0
25
upkeep-enabled: false
26
multiply-upkeep-by-clan-size: false
27
charge-upkeep-only-if-member-fee-enabled: true
Copied!

Kill Weights

Here you can set the weight of every kill type. The weight can be negative too. It's used to calculate the KDR like so: (Kill Count * Kill Wight) / Death Count = KDR

Example

1
kill-weights:
2
rival: 2.0
3
civilian: 0.0
4
neutral: 1.0
5
ally: -1.0
6
deny-same-ip-kills: false
Copied!

Clan Settings

    homebase-teleport-wait-secs - the amount of seconds players must wait before teleporting to their clan' home
    homebase-can-be-set-only-once - if the clan's home can be set only once
    min-size-to-set-rival - the minimum amount of members a clan needs to add rivals
    max-length - the max length of the clan's name
    max-description-length - the maximum length of the clan's description
    min-description-length - the minimum length of the clan's description
    max-members - the maximum amount of members a clan can have
    confirmation-for-promote - if other leaders must confirm the promotion of members
    trust-members-by-default - if members are set as trusted by default
    confirmation-for-demote - if other leaders (except the one being demoted, of course) must confirm the demotion
    percentage-online-to-demote - the percentage of online leaders to demote
    ff-on-by-default - if the clan's friendly-fire is enabled by default
    min-length - the minimum length of the clan's name
    min-size-to-set-ally - the minimum amount of members a clan needs to add allies
    min-to-verify - The clan must have this amount of members to get verified (moderators can bypass this)

Example

1
clan:
2
homebase-teleport-wait-secs: 10
3
homebase-can-be-set-only-once: true
4
min-size-to-set-rival: 3
5
max-length: 25
6
max-description-length: 120
7
min-description-length: 10
8
max-members: 25
9
confirmation-for-promote: false
10
trust-members-by-default: false
11
confirmation-for-demote: false
12
percentage-online-to-demote: 100.0
13
ff-on-by-default: false
14
min-length: 2
15
min-size-to-set-ally: 3
16
min-to-verify: 1
Copied!

Tasks

This section allows you to set the time of collection for the two types of fee. The fees are described on the economy section.
The collect-upkeep-warning is sent when the clan doesn't have enough money to pay for its upkeep.
The time is in the 24-hour clock.

Example

1
tasks:
2
collect-upkeep:
3
hour: 1
4
minute: 30
5
collect-upkeep-warning:
6
hour: 12
7
minute: 0
8
collect-fee:
9
hour: 1
10
minute: 0
Copied!

Page

    untrusted-color -
    clan-name-color -
    subtitle-color -
    headings-color -
    trusted-color -
    leader-color -
    separator -
    size -

Example

1
page:
2
untrusted-color: '8'
3
clan-name-color: b
4
subtitle-color: '7'
5
headings-color: '8'
6
trusted-color: f
7
leader-color: '4'
8
separator: '-'
9
size: 100
Copied!

Clan Chat

    enable - enables the clan chat
    tag-based-clan-chat - if true, the command to talk on the clan chat is the clan tag
    announcement-color - color used for announcements
    format - the chat format
    rank - the member's rank format (used on the format)
    leader-color - the color for leaders (%nick-color%)
    trusted-color - the color for trusted players (%nick-color%)
    member-color - the color for non-leaders and non-trusted players (%nick-color%)

Example

1
clanchat:
2
enable: true
3
tag-based-clan-chat: false
4
announcement-color: e
5
format: "&b[%clan%&b] &4<%nick-color%%player%&4> %rank%: &b%message%"
6
rank: "&f[%rank%&f]"
7
leader-color: '4'
8
trusted-color: 'f'
9
member-color: '7'
Copied!

Request

Requests are messages sent to players to decide (accept or deny) on something (joining a clan, promoting someone, etc).
    message-color - the message color
    ask-frequency-secs - the interval in seconds between each message
    max-asks-per-request - maximum amount of messages before the request expires

Example

1
request:
2
message-color: b
3
ask-frequency-secs: 60
4
max-asks-per-request: 1440
Copied!

Bulletin Board

    color - the color
    accent-color - the accent color
    show-on-login - if enabled, the BB is sent to clan members when they login
    size - the BB size (when using its command)
    login-size - the BB size on login

Example

1
bb:
2
color: e
3
accent-color: '8'
4
show-on-login: true
5
size: 6
6
login-size: 6
Copied!

Ally Chat

The Ally Chat config works just like the Clan Chat one.

Example

1
allychat:
2
enable: true
3
format: "&b[Ally Chat] &4<%clan%&4> <%nick-color%%player%&4> %rank%: &b%message%"
4
rank: "&f[%rank%&f]"
5
leader-color: '4'
6
trusted-color: 'f'
7
member-color: '7'
Copied!

Purge Data

This feature allows you to purge data of inactive players or clans.

Example

1
purge:
2
inactive-player-data-days: 30
3
inactive-clan-days: 7
4
unverified-clan-days: 2
Copied!

mySQL Settings

The plugin supports SQLite and MySQL. By disabling MySQL, SQLite will be used automatically.
Set your credentials below to use MySQL on SimpleClans.

Example

1
mysql:
2
username: ''
3
host: localhost
4
port: 3306
5
enable: false
6
password: ''
7
database: ''
Copied!

Permissions

In this section, you can give clans specific permissions. In the example below, members of the clan "YourClanNameHere" will receive the permission "test.permission".
    auto-group-groupname - if enabled, members of clans will receive the permission "group.TAG" (tag, of course, gets replaced). Be careful with this setting, if you are using LuckPerms, players could create a clan called "admin" and be automatically added to the corresponding group. If you are using it, disable the creation of such clans (mod, admin, etc).

Example

1
permissions:
2
auto-group-groupname: false
3
YourClanNameHere:
4
- test.permission
Copied!

Performance

    save-periodically - The plugin will save its data periodically as opposed to right away, RECOMMENDED to set it true.
    save-interval - The interval in minutes in which changes are written to the database.
    use-threads - The plugin will not use the main thread to connect with the database if this is true, RECOMMENDED to set it true.
    use-bungeecord - deprecated setting, BungeeCord is not fully supported

Example

1
performance:
2
save-periodically: true
3
save-interval: 10
4
use-threads: true
5
use-bungeecord: false
Copied!

Safe Civilians

    safe-civilians - Civilians are safe from PvP, even civilian vs civilian combat is disabled

Example

1
safe-civilians: false
Copied!
Last modified 2mo ago