Skip to content

Panel Formatting ​

AnnouncementGUI does not send raw message lines directly. It builds a panel made of borders, optional header content, and body lines.

Default Panel Structure ​

The formatter renders content in this order:

  1. top border
  2. centered title
  3. centered description lines
  4. optional separator between header and body
  5. body lines
  6. bottom border

Default Format Settings ​

yml
formats:
  panel:
    top-border: "&6&m------------------------------------------------"
    body-divider: "&6&m------------------------------------------------"
    bottom-border: "&6&m------------------------------------------------"
    body-separator-mode: "DIVIDER"

Body Separator Modes ​

DIVIDER ​

Insert the configured body-divider.

BLANK ​

Insert one empty line between the header and body.

NONE ​

Do not insert any extra separator.

Title and Description Alignment ​

The plugin centers the title and description lines automatically.

That makes the title and subtitle feel like a proper panel header instead of a plain chat prefix.

Body Alignment ​

Body lines are left-aligned by default, but any individual line can be centered with a tag:

text
<center>&6Store: store.example.com</center>

That tag only affects the body line where it appears.

Supported Color Formats ​

The plugin supports:

  • legacy codes such as &a, &b, &6, &c
  • formatting codes such as &l, &m, &n, &o
  • hex colors such as &#55FFFF

Example:

text
&6Welcome to %server%
&#55FFFFdiscord.example.com
&lImportant update tonight

Supported Placeholders ​

The current formatter replaces these placeholders:

  • %server% -> current server.id
  • %online% -> number of online players on the current server

Example:

text
&6Welcome to %server%
&7Players online: %online%

Example Panel ​

Input:

text
Title: &6Welcome to %server%
Description: &7Network announcement panel
Body:
<center>&eStore: store.example.com</center>
&bDiscord: discord.example.com
&aPlayers online: %online%

Conceptual output:

text
------------------------------------------------
              Welcome to lobby-1
          Network announcement panel
------------------------------------------------
              Store: store.example.com
Discord: discord.example.com
Players online: 23
------------------------------------------------

Tips for Better Panels ​

  • keep the title short
  • keep description lines to one or two concise lines
  • use the body for the actionable details
  • center only the lines that deserve emphasis
  • avoid too many bright colors in one message

If the panel starts looking noisy, reduce formatting before adding more of it.

Built with Vue.js and VitePress