Notifications Module
Introduction
The Notifications Module supports broadcasting, titles and action bar messages.
/broadcast customisation
The /broadcast message is prefixed and suffixed by the message templates defined at broadcast-message-template.prefix and broadcast-message-template.suffix.
They work the same way as the chat module templates do, please see the Chat Module documentation for more information on creating the templates.
/plainbroadcast does not use these prefixes/suffixes.
/basictitle, /basicsubtitle and /basicactionbar
These commands allow for the use of ampersand encoded strings. They also accept the following flags:
-p [player]: The name of the player or a selector that defines who to send the message to. If omitted, sends to all on the server.-i [seconds]: The amount of time taken by the fade in effect, in seconds (does not affect action bar messages).-o [seconds]: The amount of time taken by the fade out effect, in seconds.-t [seconds]: The amount of time taken the message remains on the screen, in seconds.
Tokens in notifications.
Adding a token (such as {{displayname}} or {{name}} to the message will now show each player a personalised message - the tokens will be parsed based on each player rather than the sender. The sender’s name is accessible through the {{sender}} token.
This does not affect how the tokens for the prefix/suffix work - they will still be based on the sender.
For the list of tokens available for use by default, please see this page
The following are incompatibilities that may occur with this module, along with how to resolve the problem. For the full mod/plugin incompatibility list, see the compatibility page.
No plugin incompatibilities have been reported.
A message will be sent to the action bar of targeted players. Selectors may be used to target multiple players. The following flags are available:
* -i [time]: time for fade in effect, in seconds
* -o [time]: time for fade out effect, in seconds
* -t [time]: time message should remain on screen, in seconds
* -p [player/selector]: send message to the specified player(s)
Aliases:
/basicactionbar
Usage: /basicactionbar [-t <t>] [-i <i>] [-o <o>] [-p <p>] <message…>
Default Role: ADMIN
Basic Command Permission: nucleus.basicactionbar.base
Permissions
-
nucleus.basicactionbar.base- Default Role: ADMIN
Allows the user to run the command /basicactionbar
A subtitle message will be sent to the targeted players. Selectors may be used to target multiple players. The following flags are available:
* -i [time]: time for fade in effect, in seconds
* -o [time]: time for fade out effect, in seconds
* -t [time]: time message should remain on screen, in seconds
* -p [player/selector]: send message to the specified player(s)
Aliases:
/basicsubtitle
Usage: /basicsubtitle [-t <t>] [-i <i>] [-o <o>] [-p <p>] <message…>
Default Role: ADMIN
Basic Command Permission: nucleus.basicsubtitle.base
Permissions
-
nucleus.basicsubtitle.base- Default Role: ADMIN
Allows the user to run the command /basicsubtitle -
nucleus.basicsubtitle.multiple- Default Role: ADMIN
Allows the user to target multiple players with the command /basicsubtitle
A title message will be sent to the targeted players. Selectors may be used to target multiple players. The following flags areavailable:
* -i [time]: time for fade in effect, in seconds
* -o [time]: time for fade out effect, in seconds
* -t [time]: time message should remain on screen, in seconds
* -p [player/selector]: send message to the specified player(s)
Aliases:
/basictitle
Usage: /basictitle [-t <t>] [-i <i>] [-o <o>] [-p <p>] <message…>
Default Role: ADMIN
Basic Command Permission: nucleus.basictitle.base
Permissions
-
nucleus.basictitle.base- Default Role: ADMIN
Allows the user to run the command /basictitle -
nucleus.basictitle.multiple- Default Role: ADMIN
Allows the user to target multiple players with the command /basictitle
Aliases:
/broadcast, /bcast, /bc
Usage: /broadcast <message…>
Default Role: ADMIN
Basic Command Permission: nucleus.broadcast.base
Permissions
-
nucleus.broadcast.base- Default Role: ADMIN
Allows the user to run the command /broadcast
This command is an equivalent to the following command(s) in Essentials:
/broadcast, /bcast
Aliases:
/plainbroadcast, /pbcast, /pbc
Usage: /plainbroadcast <message…>
Default Role: OWNER
Basic Command Permission: nucleus.plainbroadcast.base
Permissions
-
nucleus.plainbroadcast.base- Default Role: OWNER
Allows the user to run the command /plainbroadcast
| Permission | Suggested Role | Description |
|---|---|---|
| nucleus.basicactionbar.base | ADMIN | Allows the user to run the command /basicactionbar |
| nucleus.basicactionbar.multiple | ADMIN | Allows the user to target multiple players with the command /basicactionbar |
| nucleus.basicsubtitle.base | ADMIN | Allows the user to run the command /basicsubtitle |
| nucleus.basicsubtitle.multiple | ADMIN | Allows the user to target multiple players with the command /basicsubtitle |
| nucleus.basictitle.base | ADMIN | Allows the user to run the command /basictitle |
| nucleus.basictitle.multiple | ADMIN | Allows the user to target multiple players with the command /basictitle |
| nucleus.broadcast.base | ADMIN | Allows the user to run the command /broadcast |
| nucleus.plainbroadcast.base | OWNER | Allows the user to run the command /plainbroadcast |
# The prefix and suffix when sending a broadcast message. Accepts chat tokens such as {{displayname}}, {{name}}, etc.
broadcast-message-template {
prefix="&a[Broadcast] "
suffix=""
}
# The defaults when sending a title. All times are in seconds.
title-defaults {
fade-in=1.0
fade-out=1.0
time-on-screen=5.0
}