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

  # Snapshots of deleted claims, restorable with /scs snapshot — see Features > Claim snapshots (2.8)
  snapshots:
    enabled: false
    max-per-player: 5
    max-total: 500
    retention: 30d

  # 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

  # Staff in vanish — 2.8.1
  vanish:
    hide-from-api-events: false       # true = no ClaimEnterEvent / ClaimLeaveEvent for a vanished player

  # /claim opens a menu of the chunks around the player — 2.8.1 (see Claim menu below)
  claim-gui:
    enabled: false
    bedrock-radius: 1                 # Bedrock form: 1 = 3x3 chunks listed, 2 = 5x5
    icons:
      free: WHITE_STAINED_GLASS_PANE
      own: LIME_STAINED_GLASS_PANE
      member: YELLOW_STAINED_GLASS_PANE
      other: RED_STAINED_GLASS_PANE
      protected: PINK_STAINED_GLASS_PANE
      blocked: BARRIER

  # true = a chunk holding a Trial Chamber cannot be claimed — 2.8.1
  unclaimable-trial-chambers: 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

Claim menu

With claims.claim-gui.enabled: true, a bare /claim no longer claims the chunk under the player: it opens a map of the chunks around them, 9 columns by 5 rows, the player standing in the middle. The top of the map is the way the player faces, exactly like /claim map. The head at the bottom shows the same stats as in /claim list and /claim menu. (2.8.1)

• Confirmation: with confirmation.claim or confirmation.addchunk, the first click arms the chunk and its button turns into "click again to confirm". No chat button is involved.
• Spawn of the new claim: the player's position when they stand in the chunk, otherwise the centre of the chunk on the surface.
• Direct command: /claim create (no name) claims the chunk the player stands on without opening the menu. Auto-claim and the chat confirmation buttons use that direct path, so walking in auto-claim mode never opens the menu.
• /parea is not affected: it keeps creating a protected area on the current chunk.
• Layout: guis/menu_claim.yml (the slots list is the map, keep a full block of rows and columns) and bedrock-guis/menu_claim.yml. Texts are the claim-gui-* and bedrock-claim-* keys of the language file. Icons are set in claims.claim-gui.icons.
• Bedrock: a form has no grid, so the chunks are listed nearest first, each told by where it lies from the player (ahead, behind, left, right). Removing a chunk stays in the chunks menu.

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.

On a server version the sidebar library cannot drive, the plugin logs a single warning and falls back to the chat auto-map until the next reload, instead of failing on every chunk change. (2.8, FastBoard 2.2.1 supports up to Minecraft 26.2)

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).