Server Toolbox
  • âšī¸Introduction
    • Performance
  • 🔗Synergy
  • âš™ī¸Configuration
    • General
      • Modules
    • Kits
    • Broadcaster
    • Messages
  • đŸ› ī¸Commands
    • Customization
    • Categories
      • Mod
      • World
      • Teleportation
      • GUI
      • Customization
      • Player
      • Chat
  • 🔓Permissions
  • â›‘ī¸Troubleshooting
    • FAQ
  • 🌱API
  • ✨Planned Features / Bugfixes
Powered by GitBook
On this page

Was this helpful?

  1. Configuration

Broadcaster

Send global messages to players!

PreviousKitsNextMessages

Last updated 1 year ago

Was this helpful?

In broadcaster.conf you can find two options such as broadcasts and configVersion, you should only edit first one. It should look like this:

broadcasts {
    <broadcast_name> {
        // List with your messages
        messages=[
            {
                lines=[
                    "<red>My first broadcast?"
                ]
            },
            {
                lines=[
                    "<red>My second broadcast?"
                ]
            }
            // and etc...
        ]
        // This prefix will be applied to all messages sent
        prefix="[server]"
        // Minimum player requirement to send this broadcast
        min-players=1
        // Next time broadcast will be run, be sure NOT to
        // edit this unless you know what you're doing!
        next-date-time="2023-07-18T12:01:26.344175264"
        // Should messages be randomized or follow the order
        randomize=false
        // Only players with permissions will be able to receive broadcast
        requires-permission=false
        // Timeout in seconds between messages
        timeout=45
    }
}

I tried to explain everyting using comments above, but I still want to clarify some things about few parameters:

requires-permission

Players will receive message only if they have special permission which depends on your broadcast name, it looks like this: server-toolbox.broadcasts.<broadcast_name>.receive

timeout

This value represents timeout between messages in seconds, but please don't use too short timeouts (like 5,10,20 seconds) as it can affect the server performance too much!

Formatting and Placeholders

Broadcasts support formatting and placeholders in prefix and messages, to understand how it works.

âš™ī¸
use this documentation
Example message on server