Skip to content
TTS-STUDIO docs Discord

Plugins / ClaimsForge

Configuration reference

This is the config.yml ClaimsForge writes on first start, comments included. Every key you see here is the key the plugin reads; there are no hidden ones. Change a value, reload, and it applies.

Top-level sections: language, license-key, limits, cost, protection, entry-notification, map.

# ============================================================================
#  ClaimsForge — configuration
#  Lightweight chunk protection for Paper 1.21 with trust levels, particle
#  visualization, Vault/PAPI/Dynmap/BlueMap integration, and a public API.
# ============================================================================
#  Tip: every key documented inline. Reload at runtime with /claim admin reload
#       (where supported) or restart the server.
# ----------------------------------------------------------------------------

# Active language. ISO-639-1 two-letter code (lowercase).
# Bundled out of the box: es (Spanish), en (English).
# Missing keys fall back to en automatically. Operators can drop extra
# lang/<code>.yml files in plugins/ClaimsForge/lang/.
language: en

# BuiltByBit license key. Leave empty in development; required for paid builds.
license-key: ""

# ----------------------------------------------------------------------------
#  Claim limits
# ----------------------------------------------------------------------------
limits:
  # Base claim limit granted to every player.
  default: 10
  # Permission-based overrides. The highest matching node wins.
  #   claimsforge.limit.<n>            → raise limit to <n> (also accepted)
  #   claimsforge.limit.<role>         → custom roles below
  per-permission:
    "claimsforge.limit.vip": 25
    "claimsforge.limit.premium": 50

# ----------------------------------------------------------------------------
#  Cost per claim (Vault economy)
# ----------------------------------------------------------------------------
cost:
  # Set true to charge `per-claim` every time /claim succeeds.
  enabled: false
  # Vault currency amount withdrawn on a successful claim.
  per-claim: 100.0

# ----------------------------------------------------------------------------
#  Protection toggles
#  These gate physics/AI behavior inside claimed chunks.
# ----------------------------------------------------------------------------
# Server-wide defaults — claim owners can override per-claim via /claim manage → Flags
protection:
  # Allow PvP inside claims (false = members of the claim are safe from each
  # other and outsiders).
  pvp-in-claims: false
  # Allow hostile mob natural spawning inside claims.
  mob-spawning: true
  # Block fire from spreading into a claim from outside.
  fire-spread: false
  # Block creeper / TNT / wither explosions damaging claim blocks.
  explosions: false
  # Pistons crossing into a neighbouring claim cancel.
  piston-cross-border: false
  # Lava/water flowing into a claim from outside (true = allow flow).
  liquid-flow-in: true

# ----------------------------------------------------------------------------
#  Entry/exit notifications
#  Title shown when a player crosses a chunk boundary into/out of a claim.
#  Times are in ticks (20 ticks = 1 second).
# ----------------------------------------------------------------------------
entry-notification:
  enabled: true
  title-fade-in: 10
  title-stay: 40
  title-fade-out: 10

# ----------------------------------------------------------------------------
#  Map integration
#  Colors are #RRGGBB; opacity is 0.0..1.0.
# ----------------------------------------------------------------------------
map:
  # Dynmap marker color and fill opacity.
  dynmap-color: "#3399ff"
  dynmap-opacity: 0.3
  # BlueMap shape color and fill opacity.
  bluemap-color: "#3399ff"
  bluemap-opacity: 0.3