GUI Customization

GUI Customization

The graphical interface of ChatColor is fully customizable via the gui/gui.yml file. This allows you to change everything from titles and item materials to the exact layout of the menus.

📂 Configuration File: gui/gui.yml

The file is divided into several main sections:

1. titles

Define the titles for each page of the GUI. MiniMessage formatting is supported.

titles:
  main: "<gradient:blue:aqua><bold>ChatColor"
  solid: "<aqua><bold>Solid Colors"
  gradient: "<gradient:red:blue><bold>Gradients"
  pattern: "<rainbow><bold>Patterns"

2. layouts

Control the size of the inventory and where items are placed.

  • main: The category selection menu.

    • size: Must be a multiple of 9 (e.g., 27, 54).
    • filler-slots: Slots that will be filled with the filler item.
    • solid-slot, gradient-slot, pattern-slot, reset-slot: Specific slots for category buttons.

  • selector: The menu showing the actual colors/gradients/patterns.

    • size: Usually 54.
    • content-slots: Number of slots used for displaying entries.
    • nav-row-start: The row where navigation buttons start.

3. items

Customize the appearance of button items.

items:
  solid:
    material: LIME_DYE
    name: "<green><bold>Solid Colors"
    lore:
      - "<gray>Browse and apply solid colors"
  reset:
    material: BARRIER
    name: "<red><bold>Reset Color"

4. status

These messages are appended to the lore of color items based on the player's status.

  • selected: Shown if the player currently has this color active.
  • click-to-apply: Shown if the player has access but hasn't selected it.
  • has-access: General access indicator.
  • no-access: Shown if the player lacks the required permission.

🛠️ Tips for Customization

  1. Filler Items: Change filler.material and filler.name to match your server's theme.
  2. Navigation: You can change the materials for next-page, previous-page, and back-menu items in the items section.
  3. MiniMessage: Use the MiniMessage Viewer to preview your titles and lore before applying them.