Chat Formatting

The chat/format.yml file allows you to create highly customized chat displays using modern formatting features.

Format Components

Each chat format is divided into four main components: prefix, name, suffix, and message.

For each component, you can configure:

• text: The actual content to display in chat. Supports MiniMessage and Placeholders.
• hover: A list of lines that will appear when a player hovers over this component.
• click: An action to perform when a player clicks this component. Supported actions:
  • OPEN_URL: Opens a webpage.
  • RUN_COMMAND: Executes a command.
  • SUGGEST_COMMAND: Places a command in the player's chat bar.
  • COPY_TO_CLIPBOARD: Copies text to the player's clipboard.

Multiple Formats

You can define multiple chat formats with different priorities and permissions.

formats:
  admin:
    priority: 100
    permission: "solaritychat.format.admin"
    prefix:
      text: '<red>[Admin]</red> '
    ...
  default:
    priority: 0
    permission: ""
    ...

• Priority: If a player has permission for multiple formats, the one with the highest priority will be used.
• Permission: The required permission to use the format. If empty, it's the default format.

Formatting Permissions

Under the formatting section, you can control whether legacy color codes and RGB hex colors are allowed and if players require specific permissions to use them in their own messages.

• allow-color-codes: Enable/disable legacy color codes like &c.
• allow-hex-colors: Enable/disable RGB hex colors like #FF0000.
• color-permissions.require-permission: The permission required to use colors (solaritychat.format.color).
• hex-permissions.require-permission: The permission required to use hex colors (solaritychat.format.hex).
• format-permissions: Define permissions for specific formatting styles (bold, italic, etc.).