config.yml

Configuration guide for the "config.yml" file.

General settings

Lang setting

lang: en_US.yml

You can set up your own language file. You just have to create a new yaml file, and translate all the messages, then use the name of your file into lang setting in config.yml. Use /scs reload OR restart your server to apply setting.

Database

database: false
database-settings:
  hostname: localhost
  port: 3306
  database_name: test_server
  username: root
  password: pass

You can set up database instead of files for claims storage, I actually advise using a database, it's more optimized. If you don't have a lot of players, there is no need.

Commands aliases

command-aliases:
  claim:
    - /territory
  unclaim:
    - /unterritory
  claims:
    - /territories

You can set up the commands aliases, for example, you can use /territory instead of /claim. You can add as many aliases as you want.

Claim settings

Auto-purge

auto-purge: true
auto-purge-checking: 60
auto-purge-time-without-login: 14d

You can set up the auto-purge system, every how long the server must purge claims, and how long the player must be disconnected for their claims to be deleted.

auto-purge-checking is in minutes (every X minutes the server will purge)

auto-purge-time-without-login is in the format "5s for 5 seconds, 5m for 5 minutes.. 5h, 5d, 5w, 5M, 5y)

Claims mode per world

claims-worlds-mode:
  world: SURVIVAL
  world_nether: SURVIVAL
  world_the_end: SURVIVAL
  example_world: DISABLED
  example_only_claims: SURVIVAL_REQUIRING_CLAIMS

You can set up the mode of claims system for all the worlds you want.

The available modes are :

  • SURVIVAL : Classic mode, claims are available, you can build inside/outside your claims.

  • SURVIVAL_REQUIRING_CLAIMS : Advanced mode, claims are available, you can build only inside your claims.

  • DISABLED : Claims are completely disabled in the world.

/!\ PERMS outside claims for the mode SURVIVAL_REQUIRING_CLAIMS are configurable, see below!

Protection message

protection-message: ACTION_BAR

You can choose where the protection message is sent. Availables types : ACTION_BAR, TITLE, SUBTITLE and CHAT.

Keep chunks loaded

keep-chunks-loaded: false

You can enable chunks to keep loading when there are no players in them.

Max-length

# Length max for claim name
max-length-claim-name: 16

# Length max for claim description
max-length-claim-description: 50

You can set up max length for these settings : claim-name and claim-description. This feature allows you not to have names/description that are too long (for guis or others things).

Invitations system

# Is there an invitation system for claims? If not, players can add anyone to their claims
claim-invitations-system: false

# Expiration of an invitation (in seconds)
claim-invitation-expiration-delay: 120

You can set up the invitations system (disabled by default), you can let it disabled if you prefer your players to add their friends without invitation requests. Otherwise, set it to true.

Claim confirmation

claim-confirmation: false

You can enable the claim confirmation (disabled by default). This feature allows you to ask the player if he really wants to claim this chunk.

Fly system

# Disable claim fly on damage (of any type)
claim-fly-disabled-on-damage: true

# Send a message to player when auto fly enable the fly ?
claim-fly-message-auto-fly: true

You can set up how the fly system is working : if any damage, disable the fly and if the message of the auto-fly is sent automatically when the player moves.

Enter/Leave messages

# Enable/Disable the enter/leave message in the action bar
enter-leave-messages: true

# Enable/Disable the enter/leave message in the title and subtitle
enter-leave-title-messages: true

# Enable/Disable the enter/leave message in the chat
enter-leave-chat-messages: true

You can enable/disable the messages when you enter/leave a claim. "enter-leave-messages" is for messages in the action bar. "enter-leave-title-messages" is for messages in title and subtitle (in the center of your screen). "enter-leave-chat-messages" is for messages in the chat.

Claims visibility

claims-visitors-off-visible: true

Should claims with the GuiTeleport setting disabled be displayed in /claims?

Economy

# Enable/Disable the economy system (sell/buy claims)
economy: true

# Max sell price for a claim
max-sell-price: 1000000000

# If /claim is paid
claim-cost: false
# If adding chunk to a claim is paid
chunk-cost: false

# If claim cost is multiplied (for example if claim-cost-multipler = 2, first claim will be the claim-cost, 1000 for example,
# the second claim will cost 2000, the third one 4000 ..)
claim-cost-multiplier: false
# Same for adding chunk
chunk-cost-multiplier: false

# Use formatted number for costs (10,000,000 = 10M for example)
use-formatted-number: true

# Settings of announce
announce-sale:
  
  # Announce sale in bossbar
  bossbar: true
  bossbar-settings:
    color: RED
    style: SOLID
  
  # Announce sale in chat
  chat: true
  
  # Announce sale in title/subtitle
  title: true
  
  # Announce sale in actionbar
  actionbar: true

You can set up an economy system. When enabled, players can sell/buy claims. You can also make /claim paid with the claim cost setting. Claim cost multiplier allows you to increase the cost for each new claim (for example, the first one will be 1000$, the second one 2000$, etc). Same system for chunks.

You can set up if when a claim is for sale, the sale is announced or not when a player enter the claim. It can be displayed by bossbar, title/subtitle, actionbar and/or chat messages. You can change bossbar settings too when a claim is for sale.

You can enable the "use-formatted-number" if you prefer numbers like 1m$ instead of 1,000,000$.

BossBar

# Enable/Disable the bossbar when you are in a territory
# Placeholders :
# Use %owner% for owner's name (not for protected area)
# Use %player% for player's name
# Use %name% for claim's name
bossbar: true
bossbar-settings:
  color: YELLOW
  style: SOLID

You can set up bossbar when you are in a claim, you can use these colors : 

yellow, blue, green, pink, purple, red, white

And these styles : 

SOLID, SEGMENTED_6, SEGMENTED_10, SEGMENTED_12, SEGMENTED_20

Teleportation delay moving

# If delay > 0, can the player move
# true = can move, false = cannot move
teleportation-delay-moving: false

You can enable the moves during a teleportation (disabled by default), then the teleportation will be not cancelled while the player moving

Auto-map

# Where the auto-map is sent.
# Available types : CHAT and SCOREBOARD.
map-type: SCOREBOARD

You can set up where the auto-map is sent. Default is 'SCOREBOARD', but you can use 'CHAT' to sent in the chat the map like on the older versions. 'SCOREBOARD' is disabled on Folia server for the moment.

Expulsion location

# Location when a player is banned/kicked from a claim
expulsion-location: {}

You can set up where the player is teleported when he got kicked or banned from a claim. You can define this location with /scs setexpulsionlocation.

Map settings

Dynmap

# Dynmap support
dynmap: true
dynmap-settings:
  claim-border-color: FFFFFF
  claim-fill-color: A5A5A5
  claim-hover-text: "%claim-name% - Owner: %owner%"

You can set up how the claims are displayed on the dynmap, the color of the border, the fill color and the tooltip text. For colors, use HTML colors (RRGGBB). You can also enable/disable the integration of Dynmap.

Bluemap

# Bluemap support
bluemap: true
bluemap-settings:
  claim-border-color: FFFFFF
  claim-fill-color: A5A5A5
  claim-hover-text: "%claim-name% - Owner: %owner%"

You can set up how the claims are displayed on the bluemap, the color of the border, the fill color and the tooltip text. For colors, use HTML colors (RRGGBB). You can also enable/disable the integration of Bluemap.

Pl3xmap

# Pl3xmap support
pl3xmap: true
pl3xmap-settings:
  claim-border-color: FFFFFF
  claim-fill-color: A5A5A5
  claim-hover-text: "%claim-name% - Owner: %owner%"

You can set up how the claims are displayed on the pl3xmap, the color of the border, the fill color and the tooltip text. For colors, use HTML colors (RRGGBB). You can also enable/disable the integration of Pl3xmap.

Permissions settings

Groups

# Groups settings with permissions
# 0 for infinite claims
# 0 for no delay (in seconds)
# 0 for unlimited members
# Be careful, if you set the claim radius to 0, there is a risk of lag if players claim with a too large radius
# Be careful of max-radius-claims and max-chunks-per-claim, one depends of the other, for example :
# if you put 4 to max-chuns-per-claim and 1 to max-radius-claims, players cannot use radius claim because the max chunks is set to 4
# it must be 9 for radius 1
# same for max-chunks-total
groups:
  admin:
    permission: scs.group.admin
    max-claims: 0
    max-radius-claims: 0
    teleportation-delay: 0
    max-members: 0
    claim-cost: 0
    claim-cost-multiplier: 0
    max-chunks-per-claim: 0
    claim-distance: 0
    max-chunks-total: 0
    chunk-cost: 0
    chunk-cost-multiplier: 0
  vip: # Example
    permission: scs.group.vip
    max-claims: 15
    max-radius-claims: 2
    teleportation-delay: 0
    max-members: 5
    claim-cost: 50
    claim-cost-multiplier: 2
    max-chunks-per-claim: 10
    claim-distance: 0
    max-chunks-total: 50
    chunk-cost: 0
    chunk-cost-multiplier: 0
  default:
    max-claims: 1
    max-radius-claims: 1
    teleportation-delay: 5
    max-members: 2
    claim-cost: 100
    claim-cost-multiplier: 2
    max-chunks-per-claim: 4
    claim-distance: 0
    max-chunks-total: 20
    chunk-cost: 0
    chunk-cost-multiplier: 0

You can set up a group system to limit any settings of claim system. You create any groups you want, don't forget to add the permission. Use 0 for infinite (infinite claims, infinite radius, no delay, infinite members, no cost, no cost multiplier, no max chunks per claim, no claim distance and no max chunks total).

Players

# Players settings
# 0 for infinite claims
# 0 for no delay (in seconds)
# 0 for unlimited members
# Be careful, if you set the claim radius to 0, there is a risk of lag if players claim with a too large radius
# Be careful of max-radius-claims and max-chunks-per-claim, one depends of the other, for example :
# if you put 4 to max-chuns-per-claim and 1 to max-radius-claims, players cannot use radius claim because the max chunks is set to 4
# it must be 9 for radius 1
# same for max-chunks-total
players:
  Xyness:
    max-claims: 0
    max-radius-claims: 0
    teleportation-delay: 0
    max-members: 0
    claim-cost: 0
    claim-cost-multiplier: 0
    max-chunks-per-claim: 0
    claim-distance: 0
    max-chunks-total: 20
    chunk-cost: 0
    chunk-cost-multiplier: 0

You can set up limits for players in the same way than group system. Player limits will override group limits.

Status settings

# Enable/Disable settings, if you put "false", players cannot change this setting is their claims
status-settings:
  Build: true
  Destroy: true
  Buttons: true
  Items: true
  InteractBlocks: true
  Levers: true
  Plates: true
  Doors: true
  Trapdoors: true
  Fencegates: true
  Tripwires: true
  RepeatersComparators: true
  Bells: true
  Entities: true
  Explosions: true
  Liquids: true
  Redstone: true
  Frostwalker: true
  Firespread: true
  Teleportations: true
  Damages: true
  Pvp: true
  Monsters: true
  Weather: true
  Fly: true
  GuiTeleport: true
  Portals: true
  Enter: true
  ItemsPickup: true
  ItemsDrop: true
  SpecialBlocks: true
  Elytra: true
  Windcharges: true

You can disable any settings you want to (all enabled by default), then if a setting is disabled, player can not change the value of this setting in his claim. For example, if you want to force the protection of explosions, you put false on "Explosions" in the settings and in the "default-values-settings" section too. Then the explosions will be disabled and this setting can not be changed by the player in /claim settings.

Default values settings

# List of default values for the settings
default-values-settings:
  Members:
    Build: true
    Destroy: true
    Buttons: true
    Items: true
    InteractBlocks: true
    Levers: true
    Plates: true
    Doors: true
    Trapdoors: true
    Fencegates: true
    Tripwires: true
    RepeatersComparators: true
    Bells: true
    Entities: true
    Frostwalker: true
    Teleportations: true
    Damages: true
    Fly: true
    Weather: false
    GuiTeleport: true
    Portals: true
    Enter: true
    ItemsPickup: true
    ItemsDrop: true
    SpecialBlocks: false
    Elytra: true
    Windcharges: true
  Visitors:
    Build: false
    Destroy: false
    Buttons: true
    Items: true
    InteractBlocks: false
    Levers: true
    Plates: true
    Doors: true
    Trapdoors: true
    Fencegates: true
    Tripwires: true
    RepeatersComparators: true
    Bells: true
    Entities: false
    Frostwalker: false
    Teleportations: false
    Damages: false
    Fly: false
    Weather: true
    GuiTeleport: true
    Portals: false
    Enter: true
    ItemsPickup: false
    ItemsDrop: false
    SpecialBlocks: false
    Elytra: false
    Windcharges: false
  Natural:
    Explosions: false
    Liquids: false
    Redstone: false
    Firespread: false
    Monsters: true
    Pvp: false

You can set up the default values of the settings of a claim (per role). So when a player create a new claim, there are the values that the settings of its claim will take. Role "Natural" is natural flags by Minecraft.

Permissions for SurvivalRequiringClaims mode

# List of permissions to use when world mode is SurvivalRequiringClaims (outside the claims)
permissions-on-SurvivalRequiringClaims:
  Build: false
  Destroy: false
  Buttons: false
  Items: true
  InteractBlocks: false
  Levers: false
  Plates: false
  Doors: false
  Trapdoors: false
  Fencegates: false
  Tripwires: false
  RepeatersComparators: false
  Bells: false
  Entities: false
  Frostwalker: true
  Teleportations: true
  Damages: false
  Portals: false
  ItemsPickup: true
  ItemsDrop: true
  SpecialBlocks: false
  Elytra: true
  Windcharges: true
  Explosions: false
  Liquids: false
  Redstone: false
  Firespread: false
  Monsters: true
  Pvp: false

You can set up which permissions is enabled/disabled for the mode SURVIVAL_REQUIRING_CLAIMS. For example, if you enable Buttons (you set it to true), you will enable your players to use buttons even if they are not in their claims.

Blocked interact blocks

# List of blocked containers for the setting "Interact with blocks"
# https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html
blocked-interact-blocks:
- FURNACE
- BLAST_FURNACE
- ANVIL
- DAMAGED_ANVIL
- BREWING_STAND
- CHISELED_BOOKSHELF
- COMPOSTER
- DISPENSER
- DROPPER
- ENCHANTING_TABLE
- HOPPER
- JUKEBOX
- STONECUTTER
- BARREL
- BEACON
- CRAFTING_TABLE
- SHULKER_BOX
- CHEST
- ENDER_CHEST
- TRAPPED_CHEST
- DRAGON_EGG
- RESPAWN_ANCHOR
- CAULDRON
- LAVA_CAULDRON
- WATER_CAULDRON
- WHITE_SHULKER_BOX
- ORANGE_SHULKER_BOX
- MAGENTA_SHULKER_BOX
- LIGHT_BLUE_SHULKER_BOX
- YELLOW_SHULKER_BOX
- LIME_SHULKER_BOX
- PINK_SHULKER_BOX
- GRAY_SHULKER_BOX
- LIGHT_GRAY_SHULKER_BOX
- CYAN_SHULKER_BOX
- PURPLE_SHULKER_BOX
- BLUE_SHULKER_BOX
- BROWN_SHULKER_BOX
- GREEN_SHULKER_BOX
- RED_SHULKER_BOX
- BLACK_SHULKER_BOX
- CRAFTER
- WHITE_BED
- ORANGE_BED
- MAGENTA_BED
- LIGHT_BLUE_BED
- YELLOW_BED
- LIME_BED
- PINK_BED
- GRAY_BED
- LIGHT_GRAY_BED
- CYAN_BED
- PURPLE_BED
- BLUE_BED
- BROWN_BED
- GREEN_BED
- RED_BED
- BLACK_BED
- OAK_SIGN
- SPRUCE_SIGN
- BIRCH_SIGN
- JUNGLE_SIGN
- ACACIA_SIGN
- CHERRY_SIGN
- DARK_OAK_SIGN
- MANGROVE_SIGN
- BAMBOO_SIGN
- CRIMSON_SIGN
- WARPED_SIGN
- OAK_HANGING_SIGN
- SPRUCE_HANGING_SIGN
- BIRCH_HANGING_SIGN
- JUNGLE_HANGING_SIGN
- ACACIA_HANGING_SIGN
- CHERRY_HANGING_SIGN
- DARK_OAK_HANGING_SIGN
- MANGROVE_HANGING_SIGN
- BAMBOO_HANGING_SIGN
- CRIMSON_HANGING_SIGN
- WARPED_HANGING_SIGN
- OAK_WALL_SIGN
- SPRUCE_WALL_SIGN
- BIRCH_WALL_SIGN
- ACACIA_WALL_SIGN
- CHERRY_WALL_SIGN
- JUNGLE_WALL_SIGN
- DARK_OAK_WALL_SIGN
- MANGROVE_WALL_SIGN
- BAMBOO_WALL_SIGN
- OAK_WALL_HANGING_SIGN
- SPRUCE_WALL_HANGING_SIGN
- BIRCH_WALL_HANGING_SIGN
- ACACIA_WALL_HANGING_SIGN
- CHERRY_WALL_HANGING_SIGN
- JUNGLE_WALL_HANGING_SIGN
- DARK_OAK_WALL_HANGING_SIGN
- MANGROVE_WALL_HANGING_SIGN
- CRIMSON_WALL_HANGING_SIGN
- WARPED_WALL_HANGING_SIGN
- BAMBOO_WALL_HANGING_SIGN
- CRIMSON_WALL_SIGN
- WARPED_WALL_SIGN
- LOOM
- SMOKER

You can set up the list of blocked interact blocks, these are the blocks that will be blocked on a player's claim. You can add as many blocks as you want.

List of Materials : https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html

Blocked items

# List of blocked items for the setting "Use items"
# https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html
blocked-items:
- ENDER_PEARL
- BOW
- CROSSBOW
- TRIDENT
- FLINT_AND_STEEL
- FIRE_CHARGE
- BUCKET
- WATER_BUCKET
- LAVA_BUCKET
- CHORUS_FRUIT
- FIREWORK_ROCKET
- FIREWORK_STAR
- ENDER_EYE
- FISHING_ROD
- LEAD

You can set up the list of blocked items, these are the items that will be blocked on a player's claim. You can add as many items as you want.

List of Materials : https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html

Blocked entities

# List of blocked entity type for the setting "Entities"
# https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html
blocked-entities:
- VILLAGER
- SHEEP
- ITEM_FRAME
- GLOW_ITEM_FRAME
- ARMOR_STAND
- PAINTING
- BOAT
- MINECART
- HORSE
- DONKEY
- MULE
- PIG
- STRIDER
- LLAMA

You can set up the list of blocked entities, these are the entities that will be blocked on a player's claim. You can add as many items as you want. For example, "SHEEP" to prevent players from shearing sheeps.

List of Entities : https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html

Special blocks

special-blocks:
- SPAWNER

You can set up the list of special blocks, these are the blocks that will be invincible in a player's claim even if the "Destroy" setting is enabled, This allows you to make an exception for certain blocks. You can add as many blocks as you want.

List of Materials : https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html

Ignored break blocks

ignored-break-blocks:
- BEDROCK

You can set up the list of ignored break blocks, these are the blocks that will be blocked from breaking on a player's claim. You can add as many blocks as you want.

List of Materials : https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html

Ignored place blocks

ignored-place-blocks:
- BEDROCK

You can set up the list of ignored place blocks, these are the blocks that will be blocked from placing on a player's claim. You can add as many blocks as you want.

List of Materials : https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html

PreviousInstallationNextHow to set up a gui

Last updated