Skip to content

GUI Configuration

TejasLamba2006 edited this page Jul 26, 2026 · 1 revision

GUI Configuration

The GUI is configured in plugins/ChatColor3/gui.yml. It supports multiple named inventories with navigation between them.

Global Config

config:
  main-inventory: main          # Which inventory opens with /chatcolor gui
  select-sound: block.amethyst_block.step   # Sound on selection (registry key format)
  error-sound: entity.blaze.hurt            # Sound on error (registry key format)
  filler-item-material: LIGHT_BLUE_STAINED_GLASS_PANE
  color:
    selected-text: '&aSelected'
    unselected-text: '&7Click to select'
  modifier:
    selected-material: LIME_DYE
    unselected-material: GRAY_DYE
  no-permission-item:
    material: BARRIER           # or COPY to use the original item's material
    name: '&cNo Permission'

Note: Sounds use Minecraft registry key format (e.g. block.amethyst_block.step), not the old enum names.

Inventory Definition

main:
  title: '&8ChatColor'
  size: 54                    # Must be a multiple of 9
  fill-empty-slots: true      # Fill unused slots with the filler item
  inventory-type: STATIC      # STATIC = fixed slots, DYNAMIC = auto-packed

  items:
    0:
      type: COLOUR
      data: c                 # Colour code, hex, %custom, or "default"
      material: RED_DYE
      name: '&cRed'           # Optional, auto-generated if omitted
      lore:
        - '&7Click to select'
      no-permission-lore:
        - '&cYou need chatcolor.color.c'

    10:
      type: MODIFIER
      data: l                 # Modifier code (k, l, m, n, o)

    20:
      type: INVENTORY
      data: hex-colours       # Name of another inventory in this file
      name: '&bHex Colours'
      material: PAINTING

    45:
      type: COMMAND
      data: 'msg %player% Hello!'   # %player% is replaced with the player's name
      name: '&eSay Hello'
      material: PAPER

    53:
      type: FILLER            # Uses the global filler item

Item Types

Type Description Required Fields
COLOUR Selectable colour item data, material
MODIFIER Toggleable modifier item data
INVENTORY Opens another GUI data, name, material
COMMAND Runs a command on click data, name, material
FILLER Decorative filler item (none)

DYNAMIC Inventories

With inventory-type: DYNAMIC, items without explicit slots are auto-packed into empty slots. Items the player lacks permission for are hidden entirely (not shown as no-permission items).

Clone this wiki locally