xCheck/config.yml

xCheck 1.0.0 documentation

config.yml

Configuration reference for config.yml.

Raw YAML

Examples match release 1.0.0. Back up your configuration before editing. Use this plugin's reload command where supported; restart after dependency or JAR changes.

Settings in this file

Values shown below are sanitized defaults from the release JAR. Empty private fields must be configured locally.

Default value is shown below. Keep the type and YAML structure when editing this setting.

Setting

Save intervals, data retention or storage settings. Preserve the existing data directory.

Setting

Default value is shown below. Keep the type and YAML structure when editing this setting.

Setting

Player-facing messages and command feedback. Preserve the placeholder spelling used in each default.

Setting

Default configuration

Preserve YAML indentation. Never publish your configured keys, tokens or player data.

# Date/time comes from the server clock in the selected timezone.
# Display format: dd.MM.yyyy HH:mm:ss (no milliseconds).
timezone: Europe/Zurich
storage:
  # Entries older than this are purged at startup and hourly.
  retention-days: 90
lookup:
  days: 7
  max-results: 500
  cooldown-milliseconds: 750
messages:
  no-permission: '&cYou do not have permission.'
  player-only: '&cThis command requires a player.'
  license-inactive: '&cA valid xCheck license is required. Use /xcheck license verify.'
  loading: '&7Looking up recorded history...'
  busy: '&eA lookup is already running, or the lookup service is busy. Try again shortly.'
  lookup-failed: '&cHistory could not be loaded. See the server log.'
  no-target: '&eLook at a block within six blocks, or use the inspector pickaxe.'
  inspect-on: '&axCheck inspection enabled. Click a block to inspect it.'
  inspect-off: '&7xCheck inspection disabled.'
  full-inventory: '&eMake room in your inventory before requesting the inspector.'
  wand-given: '&aInspector pickaxe added. Hold it and click a block.'
  reloaded: '&axCheck settings reloaded.'