Skip to content

Configuration Reference

config.yml

Main plugin configuration file located at plugins/LandClaimPlugin/config.yml.

General Settings

KeyTypeDefaultDescription
prefixString<dark_gray>[<gold>LandClaim<dark_gray>]</gold>Chat prefix (MiniMessage format)
languageStringen-USLocale file to load from locales/ folder
requireConnectedClaimsBooleanfalseRequire new claims to touch existing claims
allowDiagonalConnectionsBooleantrueAllow diagonal adjacency for connected claims
cooldownUnstuckInteger30Seconds cooldown for unstuck command
useSeparatePremissionBooleanfalseIf true, separate LuckPerms permissions like landclaim.menu.<menu>, landclaim.menu.*, and command-specific permissions will be checked. If false, these separate permissions are bypassed.
bannedClaimNamesFileStringbanned-claim-name.txtThe file name containing banned words (one per line) that cannot be used in claim names.

Placeholder Brackets

For all messages and placeholders, the plugin supports both angle brackets <owner> and curly braces {owner} interchangeably.

Claim Limits

KeyTypeDefaultDescription
chunkClaimLimitInteger5Default max chunks per player
maxWarpsInteger3Default max warps per player

Permission overrides: landclaim.limit.<n>, landclaim.warps.limit.<n>

Multi-Profile System

KeyTypeDefaultDescription
multiProfilesEnabledBooleanfalseEnable multi-profile support
maxProfilesPerPlayerInteger2Max profiles a player can own

WARNING

If you disable multiProfilesEnabled after players have already created multiple profiles, they will lose access to all secondary profiles. This setting should be treated as permanent once enabled.

World & Command Blocking

KeyTypeDefaultDescription
blockWorldList[world_nether, world_the_end]Worlds where claiming is disabled
blockCmdList[setwarp, warp]Commands blocked inside others' claims

TIP

Changes to blockWorld and blockCmd take effect immediately on server startup — no /claim admin reload needed. To unblock a dimension, simply remove it from the list and restart.

Protection Gaps

KeyTypeDefaultDescription
worldguardGapInteger0Minimum chunks between claims and WorldGuard regions (0 = disabled)
minClaimGapInteger0Minimum chunks between different players' claims (0 = disabled)

Database

KeyTypeDefaultDescription
database.typeStringSQLITEDatabase backend: SQLITE or MYSQL
database.hostStringlocalhostMySQL host
database.portInteger3306MySQL port
database.databaseNameStringlandclaimMySQL database name
database.usernameStringrootMySQL username
database.passwordStringpasswordMySQL password (or set LANDCLAIM_DB_PASSWORD env var)
database.tablePrefixStringlc_Prefix for all SQL tables
database.maximumPoolSizeInteger10HikariCP max pool size
database.minimumIdleInteger2HikariCP min idle connections
database.connectionTimeoutLong30000Connection timeout in ms

Redis (Cross-Server Sync)

KeyTypeDefaultDescription
redis.enabledBooleanfalseEnable Redis pub/sub sync
redis.hostStringlocalhostRedis host
redis.portInteger6379Redis port
redis.passwordString""Redis password (empty = no auth)
redis.channelStringlandclaim:syncPub/sub channel name

Map Integrations

Each map plugin has identical configuration:

KeyTypeDefaultDescription
<map>.enabledBooleantrueEnable this map hook
<map>.fillColorString3366FFFill color (hex)
<map>.fillOpacityDouble0.3Fill opacity (0.0-1.0)
<map>.borderColorString3366FFBorder color (hex)
<map>.borderOpacityDouble0.8Border opacity (0.0-1.0)

Supported maps: dynmap, bluemap, squaremap, pl3xmap

Visualization

KeyTypeDefaultDescription
actionbarUpdateIntervalInteger20Ticks between actionbar updates

Bedrock / Geyser Support

KeyTypeDefaultDescription
geyserFormsBooleantrueWhen Geyser 2.x is installed, Bedrock players receive native Bedrock forms (CustomForm text input for renames/colors, ModalForm confirmations for abandon/ban/unclaim-all) instead of Java-only chat-prompt fallbacks. If Geyser is not installed, this option has no effect.

TIP

Geyser-Spigot and Floodgate are listed in soft-depend so the server attempts to load them before LandClaimPlugin. The Bedrock form code is reflection-based — it does not introduce a hard dependency on either plugin.

::: note Map plugins The squaremap and Pl3xMap hooks both wait for the corresponding plugin's PluginEnableEvent and retry their API call on the next tick if the API isn't ready yet. Markers should appear automatically after a /claim reload or after a fresh claim. If you do not see your claims on the live map:

  1. Confirm the world is enabled in your map plugin's config (e.g. squaremap/config.yml's worlds: section).
  2. Confirm the chunk is in the same Bukkit world name the map plugin reports (the plugin handles minecraft:worldworld automatically).
  3. Run /claim admin reload to force a full map refresh. :::

Wilderness Protection

KeyTypeDefaultDescription
wildernessProtection.enabledBooleanfalseWhen true, the flags in deniedFlags are denied in unclaimed chunks. Admins (landclaim.admin) always bypass.
wildernessProtection.exceptionWorldsList[]Worlds where wilderness protection does not apply. Use the plain Bukkit world name (e.g. world, world_nether).
wildernessProtection.deniedFlagsListbuild / interaction flags only (see below)The permission flags denied in the wilderness. The default list contains only build / interaction flags — combat flags (DAMAGE_ANIMALS, DAMAGE_MONSTERS, BREED_ANIMALS, SHEAR_ENTITIES, TRADE_VILLAGERS, FEED_ANIMALS, LEASH_ENTITIES) and PvP are NOT denied by default, so players can still hunt and fight mobs in the wilderness. Add a flag to the list to deny it; remove to allow it. Matching is case-insensitive.

Default deniedFlags list (build / interaction only):

BLOCK_BREAK, BLOCK_PLACE, BLOCK_IGNITE, USE_BUCKETS, USE_FERTILIZER, MODIFY_SIGNS,
USE_DOORS, USE_TRAPDOORS, USE_FENCE_GATES, USE_CONTAINERS, USE_WORKSTATIONS,
USE_BEDS, USE_REDSTONE, USE_LECTERNS, USE_BELLS, TRAMPLE_CROPS,
MODIFY_ARMOR_STANDS, MODIFY_ITEM_FRAMES

Use case

Enable wilderness protection on a towny-style survival server where the only safe place to build is inside a clan claim. Players can still walk, chat, hunt mobs, drop items, throw ender pearls, and fight in the wilderness, but cannot break or place blocks until they find a claim or get admin help.

Combat flags and PvP

By default, combat flags (DAMAGE_ANIMALS, DAMAGE_MONSTERS, BREED_ANIMALS, etc.) and PvP are NOT in deniedFlags, so players retain the ability to hunt and fight in the wilderness. If you want to lock those down too, add them to the list (e.g. deniedFlags: [..., DAMAGE_ANIMALS, DAMAGE_MONSTERS, PVP]).

Explosions

Wilderness protection does not affect explosion damage (ExplosionProtectionListener) — that listener has its own logic. To make wilderness fully off-limits, combine this with a blockWorld entry for the world, or use another plugin to disable mob spawning / explosions.

PvP

KeyTypeDefaultDescription
pvp.forceEnabledBooleanfalseWhen true, PvpProtectionListener always allows PvP regardless of the per-claim pvpEnabled flag, and /claim pvp refuses to toggle (sends pvp-force-locked). Designed for PvP-focused servers that want every claim to have PvP on with no opt-out.

Permission Flags

Complete list of permission flags used across roles, trusted players, and visitor settings.

Block Interaction Flags

FlagDescription
USE_DOORSOpen/close doors
USE_TRAPDOORSOpen/close trapdoors
USE_FENCE_GATESOpen/close fence gates
USE_CONTAINERSAccess chests, barrels, hoppers, etc.
USE_WORKSTATIONSUse crafting tables, anvils, enchanting tables, etc.
USE_BEDSSleep in beds
USE_REDSTONEUse buttons, levers, pressure plates
USE_LECTERNSRead lecterns
USE_BELLSRing bells

Entity Interaction Flags

FlagDescription
DAMAGE_ANIMALSHarm passive mobs
DAMAGE_MONSTERSHarm hostile mobs
BREED_ANIMALSBreed animals
SHEAR_ENTITIESShear sheep
TRADE_VILLAGERSTrade with villagers
FEED_ANIMALSFeed animals
LEASH_ENTITIESUse leads on entities
MODIFY_ARMOR_STANDSEdit armor stands
MODIFY_ITEM_FRAMESRotate/place items in frames

Vehicle Flags

FlagDescription
RIDE_VEHICLESEnter minecarts, boats, etc.
PLACE_VEHICLESPlace vehicles
DESTROY_VEHICLESBreak vehicles

Misc Flags

FlagDescription
USE_ENDER_PEARLSThrow ender pearls
USE_CHORUS_FRUITEat chorus fruit
PICKUP_ITEMSPick up dropped items
DROP_ITEMSDrop items from inventory

Administrative Flags

These flags grant control over the claim management systems.

FlagDescription
CLAIM_LANDAllow members to claim new chunks for the owner's profile
ADMIN_MENUAllow members to open the /claim menu while standing in the claim
MANAGE_SETTINGSAccess to claim settings (PvP, Color, Toggles)
MANAGE_MEMBERSAccess to member management (Add/Remove/Trust)
MANAGE_ROLESAccess to role management (Create/Edit/Delete)

Owner-Only Restrictions

Even with ADMIN_MENU and management flags, the following actions are strictly owner-only for regular player claims:

  • Abandoning/Deleting the entire profile or claim.
  • Renaming the claim.
  • Transferring Ownership.

Admin & Server Land

Administrators with the landclaim.admin permission have special bypasses for managing server-owned land.

  • Admin Profile: A global, dedicated profile (UUID 00000000-0000-0000-0000-000000000000) is used for all Server Land.
  • Management Bypass: Any player with landclaim.admin can manage the Admin Profile using /claim admin menu.
  • Full Control: Unlike regular members, admins bypass the "Owner-Only" restrictions when managing the Admin Profile, allowing them to Rename (e.g., to "Spawn") or Abandon server chunks.
  • Command Bypass: /claim admin claim allows instant claiming for the server profile, bypassing all connection and limit checks.

Default Roles

Every new ClaimProfile gets two built-in roles:

Member

Priority: 100 (lower priority than CoOwner) Flags: USE_DOORS, USE_TRAPDOORS, USE_FENCE_GATES, USE_CONTAINERS, USE_WORKSTATIONS, USE_BEDS, USE_REDSTONE

CoOwner

Priority: 10 (higher priority than Member) Flags: All 25 flags listed above


All GUI menus are fully configurable via YAML files in the plugins/LandClaimPlugin/menus/ directory. Each menu config lets you customize:

  • Materials — Item types for buttons, fillers, and navigation
  • Display Names — MiniMessage-formatted text for all items
  • Lore — Item descriptions and instructions
  • Layout — Slot positions and structure patterns

Available menu configs:

  • mainmenu.yml — Main claim management GUI
  • profile-selector.yml — Profile selector GUI
  • ClaimSettings.yml — Claim settings toggles
  • And many more for members, allies, warps, roles, etc.

Released under the MIT License.