Configuration

ChatColor uses multiple YAML files to keep settings, colors, patterns, and messages organized and easy to customize.


config.yml

This file controls general settings and the titles used in the plugin's graphical user interface.

gui:
  main-menu-title: "<gradient:blue:aqua><bold>ChatColor"
  color-selector-title: "<aqua><bold>Solid Colors"
  gradient-selector-title: "<gradient:red:blue><bold>Gradients"
  pattern-selector-title: "<rainbow><bold>Patterns"

settings:
  apply-to-message: true   # Whether to apply colors to chat messages
  apply-to-name: false     # Whether to apply colors to the player's display name
  default-color: "NONE"    # The default color for new players (Key from colors.yml/patterns.yml)
  event-priority: "LOWEST" # The listener priority for the chat event (LOWEST to HIGHEST)
  papi-integration: true   # Whether to enable PlaceholderAPI integration
  late-bind: false         # Enable if you have issues with other chat plugins

colors.yml

This file defines all your solid colors and gradients.

Solid Colors

Solid colors use a single MiniMessage tag or a hex code.

colors:
  red:
    display-name: "Red"
    tag: "<red>"
    permission: "chatcolor.color.red"
    icon: "RED_WOOL"
  hot-pink:
    display-name: "Hot Pink"
    tag: "<#FF69B4>"
    permission: "chatcolor.color.hot_pink"
    icon: "PINK_WOOL"

Gradients

Gradients use the <gradient:color1:color2:...> tag.

gradients:
  sunset:
    display-name: "Sunset"
    tag: "<gradient:#FF4500:#FF8C00:#FFD700>"
    permission: "chatcolor.gradient.sunset"
    icon: "ORANGE_WOOL"

patterns.yml

Patterns cycle colors character-by-character throughout the message.

patterns:
  rainbow:
    display-name: "Rainbow"
    permission: "chatcolor.pattern.rainbow"
    icon: "YELLOW_WOOL"
    colors:
      - "<red>"
      - "<gold>"
      - "<yellow>"
      - "<green>"
      - "<aqua>"
      - "<blue>"
      - "<light_purple>"

messages.yml

All plugin messages can be fully customized with MiniMessage formatting. Use <prefix> to include the defined prefix.

prefix: "<dark_gray>[<gradient:blue:aqua>ChatColor<dark_gray>] "
color-applied: "<prefix><green>Color <reset><color> <gray>has been applied!"
color-created: "<prefix><green>Custom color '<gray><name><green>' has been created!"
color-reset: "<prefix><gray>Your chat color has been <red>reset<gray>."
no-permission: "<prefix><red>You don't have permission to use that color."
config-reloaded: "<prefix><green>Configuration reloaded successfully."