Skip to content

Broadcasts

wiicart edited this page Aug 23, 2024 · 3 revisions

Broadcasts

Strings offers an automatic broadcast feature available in broadcasts.yml.

By default, auto broadcasts are disabled. They can easily be enabled by setting enabled: true.

There are two options for sequences. These are ordered and random. When set to random, the order will be shuffled once every broadcast has been sent.

The delay between broadcasts can be set with the delay option. You can type in whatever number you want, followed by a unit.
Valid units are s for seconds and m for minutes.
For example, a 5 minute delay is represented as:
delay: 5m

For the broadcasts themselves, all broadcasts are under the broadcasts: section.
Each broadcast starts with its name and then there's a list of the messages in the broadcast.
Basic syntax:

broadcasts:
  <broadcast-name>:
     - 'Text'
     - 'Text
Default Configuration
# Strings - Broadcasts
# This plugin can automatically post broadcasts periodically.
# This file contains options for the broadcasts, and the broadcasts themselves.

# Should the automatic broadcast feature be enabled? (true/false)
enabled: false
# Should the broadcasts be posted ordered or randomly? (ordered/random)
sequence: ordered

# How often should broadcasts be posted?
# Type a number, followed by units
# s - seconds, m - minutes
# Example: 3m is 3 minutes
delay: 3m

# Broadcasts:
# The "website" broadcast is an example of the format.
# You can use as many lines and make as many broadcasts as you want.

broadcasts:
  website:
    - '&a&lCheck out our website!'
    - '&o&7&nhttps://www.minecraft.net'
  discord:
    - '&9Check out our Discord'
    - '&7Chat with our community!'
    - '&o&ndis

Clone this wiki locally