⚙️ Configuration Guide

Everything in config.yml is fully customizable. Here's a complete breakdown of every setting:

📌 Basic Settings

  • gui-title: Title that appears at the top of the GUI shown to players.
  • error-message: Message shown to players who try to use commands or chat before accepting the rules.
  • accepted-message: Message shown after a player accepts the rules.

🟩 Accept Button

  • accept-button.name: Custom label for the accept button in the GUI.
  • accept-button.item: The Minecraft item/block used for the accept button (e.g. EMERALD_BLOCK).

📜 Rules List

Each rule has the following structure:

rules:
    - title: "§e1. Rule title"
      description: "§7What the rule means"
      punishment: "§cPunishment text"
      item: ITEM_NAME
  • title: Shown as the name of the rule in the GUI (use color codes if desired).
  • description: A short explanation of the rule's intent.
  • punishment: (Optional) Consequence for breaking the rule, shown in item lore.
  • item: Minecraft item ID used as icon for that rule (use UPPERCASE).

🧪 Developer & Command Messages

  • reload-message: What is shown after executing /rules reload.
  • no-permission-reload: Message shown if player lacks permission for reload.
  • no-permission-logs: Message if player tries /rules logs without permission.
  • usage-message: Fallback message when a subcommand is wrong (e.g., /rules abc).

📊 Logs Section

When players accept rules, their names are logged. These settings customize the log display:

  • log-empty-message: Message when no one has accepted yet.
  • log-error-message: Message if log file cannot be read.
  • logs-header: Array of strings shown at the top of the log table.
  • logs-player-line: Format line per player. Use {name} as a placeholder.
  • logs-footer: Array of strings shown at the bottom of the log table.

⬅️➡️ Navigation Buttons

  • previous-page.name: Text label shown on the "Previous Page" button.
  • previous-page.item: Minecraft item used for the "Previous Page" button (e.g. ARROW).
  • next-page.name: Text label for the "Next Page" button.
  • next-page.item: Minecraft item used for the "Next Page" button.

View Available Commands →