Configuration Guide

Everything in config.yml is fully customizable. Here’s a breakdown of the key settings.

Basic Settings

  • rules-version: Increment to force all players to re-accept the rules when they change.
  • gui-title: Title shown at the top of the rules GUI.
  • accepted-message: Message after a player accepts the rules.
  • rules-updated-message: Message sent when players must re-accept after an update.
  • error-message: Message shown if a player tries to act before accepting.

Accept Button

  • accept-button.name: Label for the accept button in the GUI.
  • accept-button.item: Item/block used for the accept button (e.g. EMERALD_BLOCK).

Rules List

rules:
  - title: "§e1. Rule title"
    description: "§7What the rule means"
    punishment: "§cPunishment text"
    item: ITEM_NAME
  • title: Display name of the rule (supports color codes).
  • description: Short explanation shown in lore.
  • punishment: Optional consequence shown in lore.
  • item: Minecraft item ID used as the icon (uppercase).

Navigation Buttons

  • previous-page.name / previous-page.item
  • next-page.name / next-page.item

Logs

  • log-empty-message, log-error-message
  • logs-header, logs-footer
  • logs-player-line: supports {name}, {version}, {date}
  • logs-page-size, logs-page-line: pagination for /rules logs vX [page]
  • logs-recent-limit, logs-recent-line: control the recent view of /rules logs

Admin Messages

  • reload-message, no-permission-reload
  • no-permission-logs
  • usage-message (fallback when a subcommand is wrong)

View Available Commands →