config
You can edit several settings in the config. An explanation on what these settings are can be found here.
Prefix
This text will be printed before every line. If you want no prefix put in two single colons like this: ''.
If you want special markup (codes are below) in your prefix, then you also need to put this between single colons.
Interval
This is the amount of time (seconds or minutes) between broadcasts.
InSeconds
Set to true if you want the interval in seconds instead of minutes.
Debug
Set to true if you want to see the JSON string in the console
Messages
Put a list of messages that should be broadcasted here. After every interval the next message will be broadcast.
Separate messages with 4 spaces and a dash (-).
If you use special codes put the message (everything behind the -) between single colons.
UseGroups
Set to true if you want to make several broadcast groups.
Note: If you set this to true then you will have to add an extra layer into the config file. Here is an example:
Messages: TestGroup1: - 'message for TestGroup1' TestGroup2: - 'message for TestGroup2'
The permission node that a player will need to receive a broadcast is ServerCaster.Messages.TestGroup1. A player should never be part of two groups. To prevent this from happening make sure that you remove the previous permission node before adding the new one. For example:
Member: Permissions: - -ServerCaster.Messages.TestGroup1 - ServerCaster.Messages.TestGroup2
Available code (core)
| Short Code | Full Code | Color | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| &0; | &BLACK; | Black | ||||||||||||||||||||||||||||||||||||||
| &1; | &DARK_BLUE; | Dark Blue | ||||||||||||||||||||||||||||||||||||||
| &2; | &DARK_GREEN; | Dark Green | ||||||||||||||||||||||||||||||||||||||
| &3; | &DARK_AQUA; | Dark Aqua | ||||||||||||||||||||||||||||||||||||||
| &4; | &DARK_RED; | Dark Red | ||||||||||||||||||||||||||||||||||||||
| &5; | &DARK_PURPLE; | Dark Purple | ||||||||||||||||||||||||||||||||||||||
| &6; | &GOLD; | Gold | ||||||||||||||||||||||||||||||||||||||
| &7; | &GRAY; | Gray | ||||||||||||||||||||||||||||||||||||||
| &8; | &DARK_GRAY; | Dark Grey | ||||||||||||||||||||||||||||||||||||||
| &9; | &BLUE; | Blue | ||||||||||||||||||||||||||||||||||||||
| &a; | &GREEN; | Green | ||||||||||||||||||||||||||||||||||||||
| &b; | &AQUA; | Aqua | ||||||||||||||||||||||||||||||||||||||
| &c; | &RED; | Red | ||||||||||||||||||||||||||||||||||||||
| &d; | &LIGHT_PURPLE; | Light Purple | ||||||||||||||||||||||||||||||||||||||
| &e; | &YELLOW; | Yellow | ||||||||||||||||||||||||||||||||||||||
| &f; | &WHITE; | White |
Minecraft markup types are also available
| &k; | &MAGIC; | text becomes obuscated |
| &l; | &BOLD; | text becomes bold |
| &m; | &STRIKE; | |
| &n; | &UNDERLINE; | text becomes underlined |
| &o; | &ITALIC; | text becomes italic |
There are two extra commands you can use. You can combine these with the other commands to make the text more colorful. It does not have to be in any particular order.
| Code | Description | Version |
|---|---|---|
| &URL;{"URL"}{text} | adds a click-able link with text "text" | 1.5+ |
| &COMMAND;{command}{text} | adds a click-able command "/command" with the text "text" | 1.5+ |
| &SUGGEST;{suggest}{text} | when clicked on suggest will appear in the chat bar | 1.8+ |
Available code (extension)
This is 1.8+ only
| code | description | player specific |
|---|---|---|
| %PLING% | Plays a sound to all players receiving the broadcast | false |
| %RDMPLAYER% | Picks a random player from the players online | false |
| %SLOTS% | Shows the maximum number of slots that the server has | false |
| %PLAYERS% | Shows the amount of players currently online | false |
| %ONLINEPLAYERS% | Shows a list of names of all the players currently online | false |
| %LISTALLSTAFF% | Lists all staff specified inside the config.yml | false |
| %ONLINESTAFF% | List all staff that is currently online | false |
| %PLAYER% | Shows the name of the player receiving the message | true |
| %PING% | Shows the ping between the player and server (currently not working) | true |
Usages:
Here you can find all of the commands that you can use within messages for a fancy messages. Each command will be accompanied with explanation and an example.
To start of let's make some green text.
- &GREEN;{This is green.}
Notice here that a command always start with a "&" and ends with a ";". The text that you want to apply the markup to is always between "{" and "}" and you can't have command between those.
Now let's use several commands at the same time.
- &RED;&UNDERLINE;&BOLD;{I am underlined, bold and red.}
You can always use more then one markup at the same time. However you can only use one color at one time (makes sense right?).
Using links is also easy.
- &URL;{"http://google.com"}{Click here to go to google.com.}
Notice here that a URL is always surrounded by the " ". The reason for this is the YAML markup language.
You can also use extra markup with links.
- &BOLD;&URL;&RED;{"http://google.com"}{I am a link that is red and bold.}
Notice here that the order in witch you put in the code does not matter.
Letting players use commands from chat is also possible.
- &COMMAND;{spawn}{Click here to go to spawn.}
There are two things you have to take in mind when creating command messages. Firstly the players using it should have permission to use that specific command. Secondly you should not put in the "/" in front of the command.