Skip to content

Troubleshooting ​

Use this page when the plugin loads but the behavior is not what you expect.

The GUI does not open ​

Check the following:

  • you are running the command as a player, not as console
  • you have announcementgui.open or announcementgui.admin
  • the plugin loaded successfully on server startup

Commands that should open the menu:

text
/announcementgui
/agui
/announcement open

An announcement never broadcasts ​

The most common causes are:

  • the announcement is disabled
  • the interval is too long for the test you are doing
  • no players are online when it runs
  • the target does not match the current server
  • the message body is empty and the draft was never saved correctly

Quick checks:

  • confirm the status in the edit list
  • verify interval-seconds
  • confirm server.id and server.groups
  • force test with /announcement broadcast <id>

GROUP target does not work ​

Make sure:

  • the current server has the expected group in server.groups
  • the target value matches the configured group logically
  • you entered the target through the GUI as comma-separated text when needed

Remember that groups are logical network categories, not world names.

GLOBAL only shows on one server ​

GLOBAL means β€œbroadcast everywhere that knows about the announcement.” It does not replace sync.

If only one server sees the announcement, verify:

  • sync.enabled: true
  • same Redis URI on every server
  • same Redis channel on every server
  • every server has a unique server.id
  • every server is online and connected when the change event is published

Redis sync is not working ​

Check these items in order:

  1. Redis is reachable from the Paper host
  2. the URI is valid
  3. all servers use the same channel
  4. sync is enabled on every participating server
  5. server IDs are not duplicated

Also remember that the current implementation is event-based. If a server is offline during a sync event, it may miss the update.

Changing storage.file with reload does nothing ​

That behavior is expected from the source code. The plugin warns that changing storage.file at runtime is not supported and keeps the original file.

Use a full server restart if you need to switch storage filenames.

Body lines are not centered ​

The body is left-aligned by default. To center a body line, wrap that individual line with:

text
<center>your line</center>

Title and description lines are already centered automatically.

Multiline input looks wrong ​

In chat prompts:

  • use | to split description lines
  • use | to split message body lines
  • use commas to split target values
  • use cancel to abort a prompt safely

Staff cannot create or delete announcements ​

Check the exact permission nodes:

  • announcementgui.create
  • announcementgui.edit
  • announcementgui.delete
  • announcementgui.broadcast
  • announcementgui.reload

Or give:

text
announcementgui.admin

Good Final Test ​

After setup, run this sequence:

  1. open /agui
  2. create one local announcement
  3. force broadcast it
  4. restart the server
  5. confirm it still exists
  6. if on a network, edit it on one server and verify another server receives the update

If that sequence passes, the core plugin flow is in good shape.

Built with Vue.js and VitePress