Skip to content

Usage Examples ​

Use these examples when creating an announcement from /agui. The | character splits the description or message into multiple lines, so paste the full value into the matching chat prompt.

Announcement Panel ​

This template works well for a general server information panel that keeps players connected to your website, Discord, and store.

Title ​

text
&#38BDF8&lANNOUNCEMENT

Description ​

text
&7Stay connected with &fHellstar

Message ​

text
&fWelcome, &#F59E0B%player%&f!|&7Website: &#38BDF8www.example.com|&7Discord: &#A78BFAdiscord.gg/example|&7Store: &#22C55Estore.example.com

Network Notice ​

This template is better for update notices, maintenance information, or any message that should feel more important than a normal announcement.

Title ​

text
&#FACC15&lNETWORK NOTICE

Description ​

text
&7Important update from &fHellstar

Message ​

text
&fHello, &#38BDF8%player%&f!|&7We have a new update for all players.| |&#38BDF8Website: &fwww.example.com|&#A78BFADiscord: &fdiscord.gg/example|&#22C55EStore: &fstore.example.com

For both examples, start with these safe settings:

  • Name: use a short internal name, such as announcement or network_notice
  • Interval: 300 for every five minutes
  • Target: LOCAL for one server, or GLOBAL if Redis sync is configured for the network
  • Enabled: true

After saving, use the preview option in the editor to check line spacing, colors, and placeholders before broadcasting it to players.

Built with Vue.js and VitePress