Repository navigation
Broadcasts
ReinChat supports automatic scheduled broadcasts and manual broadcasts sent by staff. Broadcast messages can include formatting, hover text, and clickable actions.
Use the following command to send a server-wide broadcast:
/broadcast <message>
The /bc alias is also available.
Manual broadcasts can be enabled or disabled in broadcasts.yml:
manual:
enabled: true
permission: "reinchat.broadcast"The default permission declared by ReinChat is reinchat.broadcast, which is granted to operators by default. Operators with reinchat.admin also inherit this permission.
Automatic broadcasts are configured in:
plugins/ReinChat/broadcasts.yml
| Setting | Description |
|---|---|
enabled |
Enables or disables automatic broadcasts. |
interval-seconds |
Time between automatic broadcasts, in seconds. |
cycle |
When enabled, messages are sent in order and the cycle repeats. |
For example, an interval of 300 seconds means five minutes between broadcasts.
The format section controls the prefix and separator used when formatting broadcasts.
format:
prefix: "<dark_gray>[<#b00b69>Broadcast</#b00b69><dark_gray>] <gray>"
use-prefix: false
separator: ""| Setting | Description |
|---|---|
prefix |
Text displayed before a broadcast message. |
use-prefix |
Controls whether automatic broadcasts include the prefix. |
separator |
Text inserted between the prefix and message. Leave empty for no separator. |
Messages are defined under the messages list. Each entry can contain:
-
message— The broadcast text. -
hover— Additional text displayed when a player hovers over the message. -
click— An optional click action and its associated value.
Supported click actions shown in the configuration include:
| Action | Description |
|---|---|
open_url |
Opens the configured URL. |
run_command |
Runs the configured command when clicked. |
suggest_command |
Suggests the configured command in the player's chat input. |
For example, a clickable help announcement can be configured like this:
- message: "<#55ffcc>Need help? <gray>Ask a staff member."
hover: "<#55ffcc>Need assistance?<newline><dark_gray>Click to get help."
click:
action: "run_command"
value: "/help"You can create multiple entries under messages to provide different announcements, tips, and reminders.
Broadcast text supports MiniMessage-style formatting, including colors and gradients. The example configuration also uses <newline> for multi-line hover text.
Placeholders such as %server_online% and %server_max_players% can appear in messages and hover text, as shown in the provided configuration.
After editing broadcasts.yml, use:
/reinchat reload
Check the console for errors if your changes do not take effect.
- Check that
enabledis set totrue. - Verify
interval-seconds. - Make sure the
messageslist contains entries. - Check the console for configuration or reload errors.
- Confirm
manual.enabledis set totrue. - Check the permission configured under
manual.permission. - Verify that the sender has the required permission.
- Check the
click.actionandclick.valuefor the relevant message. - For
open_url, verify the URL. - For command actions, verify the configured command.
For related information, see Commands, Permissions, and Configuration.