📒 Formats

formats.yml decides what a line of chat looks like when it lands.

Which format a player gets

First match wins:

A LuckPerms group whose name matches the format id. Where several match, the heaviest group.
The permission polaroidchat.chatformat.<id> — not for default.
default, or the first format in the file if there is none.

A channel may override all of this with a format of its own.

A format

formats:
  vip:
    chat_color: '<#E9FDFB>'
    shadow: false
    shadow_color: '#000000'
    shadow_opacity: 1.0
    parts:
      prefix:
        display: '<#f2c42f>[VIP] '
        click_action: '[NONE]'
        tooltip:
          - '<#f2c42f>VIP player'
      name:
        display: '%player_displayname%'
        click_action: '[SUGGEST_COMMAND] /msg %player_name% '
        tooltip:
          - '<#95d027>▸ Click to send a private message'
      separator:
        display: '<#315a7a> ┇ '
        click_action: '[NONE]'
        tooltip: []

Key	Decides
`chat_color`	The message's own colour — used only where the player wears none of their own
`shadow`, `shadow_color`, `shadow_opacity`	The text shadow, 1.21.4 and newer
`parts`	The blocks the line is built from, in the order written

A part

Key	Decides
`display`	The text
`click_action`	What clicking it does
`tooltip`	The hover lines. An empty list shows no tooltip

Part names are yours. rank, name and separator are only what the shipped file happens to call them — rename or add freely. The message itself is appended after the last part.

Placeholders


`%player_name%`	The nick as plain text
`%player_displayname%`	The nick wearing its own colour and style
`%vault_group%`	Their group, if Vault is installed

Anything PlaceholderAPI offers works too, in every field.

Click actions

The same tokens everywhere in the plugin:

[NONE]
[RUN_COMMAND] /cmd      or  [EXECUTE] /cmd
[SUGGEST_COMMAND] /cmd  or  [SUGGEST] /cmd
[OPEN_URL] https://…    or  [URL] https://…
[COPY] text

Colours

Any form Minecraft understands works, mixed freely in one line: &f, §f, &#RRGGBB, #RRGGBB, or a MiniMessage tag such as <red> or <gradient:#ff0000:#0000ff>.

Write new text in MiniMessage. The shipped files use the Polaroid palette, which Messages sets out.

Adding a rank

Copy a block, rename it to match your LuckPerms group, change the prefix. Formats you add are kept across upgrades — the whole formats section is yours.