Skip to content
Claim settings

Claim settings

Claims Settings

claims:
  # Auto-purge inactive claims
  auto-purge:
    enabled: true
    checker: 1h
    time-without-login: 90d
    # Days before purge to start warning the affected owner on join. 0 = no warning.
    warn-days-before: 7

  # Claim tax / rent (requires Vault) — see Features > Claim Tax / Rent
  tax:
    enabled: false
    taxation-period: 1d
    amount-per-chunk: 1.0
    grace-periods: 3
    notify: true            # message the owner + log to console on each charge — 2.6.7
  # Allow /claim respawn (see Claiming > Respawn in Claim)
  respawn-in-claim:
    enabled: false

  # /claim back scope. false = any visited claim. true = only the player's own claims.
  claim-back:
    only-own-claims: false

  # Confirmation prompts — action must be run twice to execute
  confirmation:
    claim: false
    unclaim: false
    addchunk: false
    delchunk: false
    merge: false
    owner: true
  confirmation-delay: 30

  # Let claim MODERATORs (not just the owner) manage members / bans / chunks via the
  # normal commands, targeting the claim as "<owner>:<claim>" (tab-completed).
  # Moderators can never promote/demote, nor target the owner or another moderator.
  moderator-management:
    members: true
    banned: true
    chunks: true

  # Protection violation delivery: CHAT | ACTIONBAR | TITLE | NONE
  protection-message: CHAT

  # Particles
  show-particles: true
  show-particles-for-bedrock: false
  see-duration-seconds: 10            # /claim see border display duration (seconds) — 2.6.6

  # Border particle performance (network usage) — 2.6.7. Applied live on /scs reload.
  particles:
    view-distance: 24                 # max blocks from the player at which border particles are sent
    update-interval-ticks: 10         # how often (ticks) borders are re-sent (20 = 1/s)
    vertical-range: 15                # vertical half-height of the particle wall around the player
    vertical-step: 2                  # spacing between vertical particles
    horizontal-step: 2                # spacing between particles along the border line

  # Names & descriptions
  template-name: "claim-%n"
  max-length-name: 32
  allowed-regex-name: "^[a-zA-Z0-9]+$"
  max-length-description: 64
  allowed-regex-description: "^[a-zA-Z0-9\\s]+$"
  blocked-words: ["fuck", "asshole"]

  invitation-delay: 120               # seconds before an invite expires
  only-adjacent-chunks: false
  addchunk-instead-if-possible: true

  # When a player's max claims/chunks is lowered below what they already own
  # (admin set-max-* / add-* commands), delete the surplus. Default: false.
  auto-delete-excess-on-limit-reduction: false

  # Default metadata applied to every new claim
  default:
    isBuyable: false
    price: 0.0
    icon: FARMLAND
    particles: false
    warp: false       # public warp closed by default (toggle via /claim settings)
    visitPrice: 0.0   # /claim visit fee charged to visitors (0 = free)
    hologram: true    # spawn the claim's hologram above new claims by default

  # Plugin message channels — each has independent enter / leave toggles.
  messages:
    chat:
      enter: false
      leave: false
    actionbar:
      enter: true
      leave: true
    title:
      enter: false
      leave: false

  # Claim economy (requires Vault)
  economy:
    enabled: true
    max-price: 1_000_000_000
    formatted-number: true
    # /claim sell broadcast channels.
    announce:
      chat: true
      actionbar: false
      title: false
      bossbar:
        enabled: true
        color: YELLOW
        overlay: PROGRESS

Key reference

KeyDescription
auto-purge.enabledRun the periodic purge job that deletes claims from long-inactive owners (players with auto-purge-bypass = true are skipped).
auto-purge.checkerHow often the purge runs. Format: 30m, 1h, 12h, 1d.
auto-purge.time-without-loginInactivity threshold. Same format as above.
auto-purge.warn-days-beforeHow many days before purge a doomed owner gets an in-game warning on join. 0 disables the warning.
tax.enabledEnable the claim tax/rent (requires Vault + an economy plugin). See Claim Tax / Rent for the full behaviour.
tax.taxation-periodHow often the tax is charged. Any duration: 30s, 15m, 1h, 2h, 1d, 1w. The check frequency is auto-derived (period ÷ 10, min 30s), not configurable.
tax.amount-per-chunkAmount charged per owned chunk, per taxation-period, summed across all of the owner's claims.
tax.grace-periodsConsecutive unpaid periods the owner may accumulate before all their claims are auto-unclaimed.
respawn-in-claim.enabledMaster toggle for the /claim respawn feature (see Respawn in Claim).
claim-back.only-own-claimsfalse: /claim back can teleport to any claim the player walked into this session. true: only their own.
messages.<channel>.enter / messages.<channel>.leaveClaim enter/leave notification toggles, per channel (chat, actionbar, title). Each channel × direction is independent — e.g. greet players on enter via actionbar.enter: true without spamming them again on leave by leaving actionbar.leave: false. Any combination can be enabled. Schema change in 2.5.0: the old single-boolean form (messages.chat: true) was replaced by a nested enter/leave pair. Existing installs are auto-migrated by the config updater — the old leaf is replaced with the new section seeded from the bundled defaults.
confirmation.*Per-action confirmation prompts. When true, the player must re-run the command within confirmation-delay seconds.
confirmation-delaySeconds after which a pending confirmation expires.
moderator-management.members / moderator-management.banned / moderator-management.chunksLet a claim's MODERATOR — not just the owner — manage members, bans and chunks through the normal commands, targeting the claim as <owner>:<claim> (tab-completed). Each section toggles independently; set one to false to reserve it for the owner. A moderator can never promote/demote, nor target the owner or another moderator.
protection-messageWhere the "you don't have permission" message appears when a player's action is blocked. CHAT, ACTIONBAR, TITLE or NONE.
show-particlesGlobal on/off for the continuous claim-boundary particles shown to claim members.
show-particles-for-bedrockWhen false, Bedrock clients (Geyser/Floodgate) never receive the continuous particles. They can stutter with dense particle loads.
see-duration-secondsHow long (in seconds) the temporary claim borders shown by /claim see stay visible. Default 10. Affects /claim see only — not /claim seenear nor the brief border flashes after other actions. (Added in 2.6.6)
particles.view-distanceMax distance (blocks) from the player at which border particles are sent, also capped by the client render distance. The main lever for cutting particle network usage. Default 24. (2.6.7)
particles.update-interval-ticksHow often (in ticks) the borders are recomputed and re-sent. 20 = once per second, 10 = twice per second. Default 10. (2.6.7)
particles.vertical-range / particles.vertical-stepVertical half-height of the particle wall around the player, and the spacing between vertical particles. Lower values send fewer packets per point. Defaults 15 / 2. (2.6.7)
particles.horizontal-stepSpacing (blocks) between particles along the border line. Default 2. (2.6.7)
template-nameDefault auto-generated name for new claims. %n → claim id, %player% → owner name.
max-length-name / allowed-regex-nameHard cap and regex enforced on claim names (same validation is applied by /claim create <name> and /claim setname).
max-length-description / allowed-regex-descriptionSame rules for claim descriptions. The default regex allows spaces.
blocked-wordsList of substrings: any claim name or description containing one of these is rejected.
invitation-delaySeconds before a pending /claim invite expires.
seenear.default-radius / seenear.max-radiusDefault and hard-cap (in chunks) for /claim seenear [radius], which renders the borders of every claim around the player.
sanctions.locationInternal — the expulsion point players are teleported to when kicked/banned from a claim. Empty ({}) by default; set in-game with /scs setExpulsionLocation (do not edit by hand). When unset, ejected players fall back to the world spawn.
only-adjacent-chunksWhen true, a new chunk added to a claim must touch one of the claim's existing chunks. Prevents scattered layouts.
addchunk-instead-if-possibleWhen true, running /claim next to an existing owned claim adds the current chunk to that claim instead of creating a new one.
auto-delete-excess-on-limit-reductionWhen true, lowering a player's max claims/chunks below what they currently own (via /scs player <p> set-max-claims|set-max-chunks or the add- variants) automatically deletes the surplus. Excess claims are removed newest-first; excess chunks are nibbled from the chunks farthest from the spawn while keeping each claim connected (no isolated chunks) and preserving its spawn chunk. Default false. Does not trigger on the bulk * form. It is also re-evaluated when the player connects (so a limit lowered while the owner was offline, e.g. a LuckPerms rank or group change, is enforced on their next login), and the player is notified of how many claims or chunks were removed. (Added in 2.5.9)
default.isBuyable / default.priceSale flags auto-applied to new claims. Usually kept at false / 0.0; the owner toggles with /claim sell.
default.iconMaterial shown as the claim icon in the claim-list GUI. Any Material enum.
default.particlesWhether the boundary-particle display is on by default for new claims.
default.warpWhether new claims open as public warps (visitable through /claim visit). Usually false — owners opt in via /claim settings.
default.visitPriceDefault Vault fee charged on every /claim visit, paid to the owner. 0.0 = free. Owners override per claim with /claim setvisitprice.
economy.enabledMaster toggle for claim economy. Requires Vault + an economy plugin.
economy.max-priceHard cap on any /claim sell price.
economy.formatted-numberWhen true, large prices display as 1,000,000 instead of 1000000.
economy.announce.chat / actionbar / title / bossbarPer-channel toggles for the /claim sell broadcast. The bossbar sub-block also takes color and overlay.

Auto-map & Enter Borders

Two optional visual helpers, both Folia-safe.

Auto-map (chat or scoreboard)

/claim map always prints the claims mini-map in chat. The auto-map (toggled per player) shows it automatically as you move — and you pick where it goes:

claims:
  auto-map:
    display: SCOREBOARD   # SCOREBOARD (live sidebar) or CHAT (printed on claim enter)
  • SCOREBOARD (default): a packet-based sidebar (via FastBoard — works on Folia, where the Bukkit Scoreboard API throws). It shows the exact same map as /claim map and refreshes every time the player changes chunk (move or teleport). Only displayed while the player has auto-map enabled.
  • CHAT: the classic behaviour — the map is printed in chat when the player enters a claim.

The sidebar title is the auto-map-scoreboard-title key in your language file; the map symbols/colours reuse the existing map-* language keys, so the chat and scoreboard maps stay identical.

Borders on enter

Briefly flash a claim's chunk borders when a player walks or teleports into it:

claims:
  show-borders-on-enter: false   # default off

The colour reflects the viewer's relation to the claim: green = your own, yellow = a claim you're a member of, pink = a protected area (server-owned), red = anyone else's. Skipped when the claim already shows a continuous border to its members (no double display).