Configuration

Everything Sculk does is controlled by one file: plugins/Sculk/config.yml. No GUI maze, no scattered files. This page walks the annotated sample below.

Changes apply with /sculk reload — no restart needed.

Annotated config.yml

# ------------------------------------------------------------
# Sculk AntiCheat — main configuration
# Reload with /sculk reload after editing.
# ------------------------------------------------------------

settings:
  # Language file to use from plugins/Sculk/lang/
  locale: en

  # If true, alerts include a click-to-teleport hover for staff.
  interactive-alerts: true

  # Async worker threads for packet analysis.
  # "auto" sizes to available cores; set a number to pin it.
  workers: auto

alerts:
  # Minimum violation level before an in-game alert fires.
  # Flags below this still accumulate silently.
  min-vl-to-alert: 5

  # Cooldown (seconds) per player+check pair, so one cheater
  # cannot flood staff chat.
  alert-cooldown: 8

checks:
  # Every check follows this shape. Anything omitted uses the
  # built-in default, so a minimal config stays minimal.
  killaura:
    enabled: true
    # Max violation level before the configured punishment runs.
    max-vl: 40
    # What runs at max-vl: FLAG, SETBACK, or BAN_WAVE.
    # See /docs/punishments for how staging works.
    punishment: BAN_WAVE

  reach:
    enabled: true
    max-vl: 25
    punishment: BAN_WAVE
    # Extra tolerance (blocks) granted per 100ms of player ping.
    latency-compensation: 0.05

  speed:
    enabled: true
    max-vl: 35
    # Setback quietly snaps the player to their last legal
    # position instead of punishing — good for movement checks.
    punishment: SETBACK

exempt:
  # Players with sculk.bypass are always exempt (staff testing).
  # Add worlds where checks should not run at all:
  worlds: []
  # Grace period (ticks) after teleports/respawns, when clients
  # legitimately send weird movement.
  teleport-grace: 40

Conventions

• Omission means default. You only write what you change. A 10-line config is normal.
• max-vl is per check. Violation levels decay over time, so an afternoon of borderline flags never accumulates into a punishment.
• Defaults are safe. Shipped thresholds are deliberately conservative; raise sensitivity gradually with verbose mode rather than starting strict.

FAQ

Do I need to configure anything on install? No. Defaults protect a typical survival/PvP server out of the box.

Can I disable a single check? Yes — enabled: false under that check.

Where do punishments go when they fire? See Punishment configuration.