Configuration File

The configuration file for ClaimChunk is really quite simple, but if you need a better explanation, look no further. The config file may be found in this directory: <SERVER>/plugins/ClaimChunk/config.yml

Sections:

• Basic Settings
• Log Settings
• Title Settings
• Color Settings
• Chunk Settings
• Protection Settings
• WorldGuard Integration
• Dynmap Integration
• Economy Settings
• Data Saving Settings
• MySQL Database Connection Settings
• Example Configuration File

Basic Settings

disablePermissions

• Default: false
• When enabled, the permissions system will be ignored and users will be treated as if they have the claimchunk.player permission by default.

checkForUpdates

• Default: true
• Whether or not the plugin will check for updates when ClaimChunk is loaded

Log Settings

debugSpam

• Default: false
• Whether to display extra debug information in the console. This is excessive.

anonymousMetrics

• Default: true
• Whether to send anonymous statistics regarding plugin and Spigot versions to allow better targeted bug fixes and features. Data can be found on the bStats website.

Title Settings

useTitlesInsteadOfChat

• Default: true
• Whether to use the title api. Messages will rarely be shown in chat if this is true.

useActionBar

• Default: false
• Whether to use action bar messages instead of the subtitles.

titleFadeInTime

• Default: 20
• The time (in ticks) during which the titles (if enabled) will fade in.

titleStayTime

• Default: 140
• The time (in ticks) during which the titles (if enabled) will remain on the screen.

titleFadeOutTime

• Default: 20
• The time (in ticks) during which the titles (if enabled) will fade out.

Color Settings

These colors apply to the messages whether useTitlesInsteadOfChat is enabled.

infoColor

• Default: GOLD
• The color for an unimportant message to be shown.

errorColor

• Default: RED
• The color for error messages to appear.

Chunk Settings

maxChunksClaimed

• Default: 50
• If set to an integer above 0, that integer will be the limit on chunks a single player may own at one time.
• This value is overridden by the ranks system!

particlesWhenClaiming

• Default: true
• Displays particle effects when a chunk is claimed.

chunkOutlineParticle

• Default: 'SMOKE_LARGE'
• What particle effect should be used when chunks are outlined. A full list can be found here

automaticUnclaimSeconds

• Default: -1
• Enable automatic unclaiming of inactive players' chunks.

unclaimCheckIntervalTicks

• Default: 1200
• How often to check for inactive players to determine if chunks should be automatically unclaimed.

displayNameOfOwner

• Default: true
• Whether to display the name of chunk owners when someone enters an owned chunk.

defaultSendAlertsToOwner

• Default: true
• Whether the owners of chunks should be alerted when someone enters their chunks. This can be toggled with the command /chunk alert but this is the default setting.

maxPerListPage

• Default: 5
• The number of chunks to display when listing chunks owned by a player.

disabledWorlds

• Default: []
• An array of worlds in which ClaimChunk will not be usable by normal players. If worldguard.allowAdminOverride is true, however, admins may override this and claim chunks in these worlds.
• Example: To disable ClaimChunk in the Spawn and Hungergames worlds, you could use something like this:

  disabledWorlds:
  - 'Spawn'
  - 'Hungergames'

Protection Settings

blockUnclaimedChunks

• Default: false
• Whether to protect unclaimed chunks as if they were claimed until someone claims them for themselves.

blockPlayerChanges

• Default: true
• If enabled, players cannot break or place blocks in chunks where they have not been given access by the owner.

blockInteractions

• Default: true
• If enabled, players cannot interact with chunks where they have not been given access by the owner.

blockTnt

• Default: true
• If enabled, TNT will not explode on claimed land.

blockCreeper

• Default: true
• If enabled, creepers will not explode on claimed land.

blockWither

• Default: true
• If enabled, withers cannot cause damage in claimed territory.

protectEntities

• Default: true
• If enabled, other players will be unable to damage entities in a claimed chunk without access.

blockPvp

• Default: false
• If enabled, PvP will not be possible within claimed chunks.

blockedCmds

• Default: []
• An array of commands that may not be used within claimed chunks by any player.

disableOfflineProtect

• Default: false
• When enabled, chunks will not be protected unless the player is online.

WorldGuard Integration

allowClaimsInRegionsByDefault

• Default: true
• Whether players should be allowed to claim chunks that contain/touch WorldGuard regions by default. If enabled, regions in which that players should not be able to claim land will need to have the flag chunk-claim explicitly set to DENY.

allowClaimingInNonGuardedWorlds

• Default: true
• Whether to allow players to claim chunks in worlds where WorldGuard is not enabled.

allowAdminOverride

• Default: true
• Whether players with the claimchunk.admin permission should be permitted to claim chunks that conflict with WorldGuard regions.

Economy Settings

enableEconomy

• Default: true
• Whether to use the built in economy system. If enabled, Vault and a Vault-supported economy plugin will be required.

claimPrice

• Default: 100.0
• The price to claim a chunk.

unclaimReward

• Default: 10.0
• The refund for unclaiming a chunk.

firstFreeChunks

• Default: 0
• The number of chunks users can claim for no cost before they start getting charged. If this is less than 1, no free chunks will be granted.

Data Saving Settings

saveDataInterval

• Default: 5
• How often (in minutes) that data will be saved and reloaded.

keepJsonBackups

• Default: true
• Whether the claimed chunks and joined players JSON files should be copied into a backups folder every time they are saved. When this is enabled, backups are stored in /plugins/ClaimChunk/data/backups/ and can be renamed to the correct filename when necessary to restore.

MySQL Database Connection Settings

useDatabase

• Default: true
• Whether to try to connect to a MySQL database instead of using JSON files for data storage.

groupRequests

• Default: true
• Whether to group requests to the MySQL database together. This means the database will only be queried when the plugin is loading, shutting down, or saving every minutes. Only set this to false if your database is hosted on the same computer as the Minecraft server.

convertOldData

• Default: true
• Whether old JSON data should be added into the database when the database is enabled.

hostname

• Default: 127.0.0.1
• The hostname/IP of the database server.

port

• Default: 3306
• The port to access the MySQL server.

database

• Default: MyServer
• The name of the database.

username

• Default: root
• The username for the user of the database. This user should have the ability to create tables and select, insert, update, and delete data.

password

• Default: root
• The password for the user to access the database.

printDebug

• Default: false
• Whether to print out the SQL statements when they are executed. This is purely for debug purposes and is useless for most users.

Example Configuration File

This is the example configuration file that is provided by default:

basic:
  disablePermissions: false
  checkForUpdates: true

log:
  debugSpam: false
  anonymousMetrics: true

titles:
  useTitlesInsteadOfChat: true
  useActionBar: true
  titleFadeInTime: 20
  titleStayTime: 140
  titleFadeOutTime: 20

colors:
  infoColor: GOLD
  errorColor: RED

chunks:
  maxChunksClaimed: 50
  particlesWhenClaiming: true
  chunkOutlineParticle: 'SMOKE_LARGE'
  automaticUnclaimSeconds: -1
  unclaimCheckIntervalTicks: 1200
  displayNameOfOwner: true
  defaultSendAlertsToOwner: true
  maxPerListPage: 5
  disabledWorlds: []

protection:
  blockUnclaimedChunks: false
  blockPlayerChanges: true
  blockInteractions: true
  blockTnt: true
  blockCreeper: true
  blockWither: true
  protectEntities: true
  blockPvp: false
  blockedCmds: []
  disableOfflineProtect: false

worldguard:
  allowClaimsInRegionsByDefault: true
  allowClaimingInNonGuardedWorlds: true
  allowAdminOverride: true

economy:
  useEconomy: true
  claimPrice: 100.0
  unclaimReward: 10.0
  firstFreeChunks: 0

data:
  saveDataInterval: 5
  keepJsonBackups: true

database:
  useDatabase: false
  groupRequests: true
  convertOldData: true
  hostname: '127.0.0.1'
  port: 3306
  database: 'MyServer'
  username: 'root'
  password: 'root'
  printDebug: false