Setup

Install setup for the plugin

Install setup for a single Spigot server

1. Buy the plugin.
2. Put the jar in the plugins folder of your server.
3. Add PlaceholderAPI if you want placeholder support.
4. Add Vault if you want group related features to work.
5. Start the server.
6. Thats it the plugin will load and generate everything else.

You need to have Java 8 or higher in order for plugin to work properly.

Building your first announcer

All possible modules

First lets go over all of the possible fields you can use and what they do. Also worth to mention that if announcer is missing some of the fields that are not required it will use the default ones for that announcer. The only 2 fields you need for announcer to work are message-name and delay.

Field name	Required	Default	Description
message-name	yes	null	Used to enter message names(keys) that will bring linked message to that key back to the announcer, you can put multiple message names here in the form of a yaml list or just one as a single property.
delay	yes	-1	Interval in seconds, it tells the announcer to send message every X second you put there.
limit	no	0(unlimited)	Sets the limit for the announcer meaning that announcer message can be seen by player only X times you put there.
enabled	no	true	If announcer is tuned on or off.
prefix	no	false	If true announcer messages will come with plugin prefix attached,
show-on-join	no	false	If true announcer will send message when players join but will still respect the interval and limits, also synced announcers cant be used as join types.
random	no	false	If true announcer will pick random message from the offered one in the message-name to send.
synced	no	true	If true announcer will send messages to everyone who are eligible to see them at the same time, if false each player will receive message when they meet the requirements.
multilined	no	false	If true all messages that are in the message-name will be sent at once in the order they wore entered, you can use this to style multi-lined messages with headers and footers.
aligned-center	no	false	If true messages will be aligned on center instead of the left side.
show-groups-only	no	false	If true announcer will still show messages to players that dont have the rank with the default limit and delay, if false only player with groups entered in required-groups will see them.
required-groups	no	false	Here you put group that can see the messages and there group limits and delays, it can be used as a single property, list or a parent field.
required-worlds	no	false	Here you can enter a single property or a list of the worlds in which the announcer will work, if empty it will work in all worlds.

Example announcer configs

Heres how the announcers.yml file should look with a announcers using most of the features.

announcers:                            #Parent node congaing all the announcers.

  general-announcer:                   #Announcer name has to be unique.
    message-name: 'test-message'       #Message name from the 'messages.yml' file(single message example).
    delay: 60                          #Announcer will send message every 60 seconds.
    limit: 0                           #Since limit is 0 it will means its unlimited.
    enabled: true                      #Its true so it means announcer is turned on.
    prefix: false                      #Messages wont show prefix since its set to false.
    show-on-join: false                #Its false so the announcer will send messages when interval passes the delay.
    random: false                      #If you have only one message in announcer this field is irrelevant.
    synced: true                       #Announcer will send messages to everyone at same time.
    multilined: false                  #If you have only one message in announcer this field is irrelevant.
    aligned-center: true               #Messages will be centered and not aligned left like the rest the usual ones.
    show-groups-only: false            #Even the player that dont have groups will see the messages.
    required-groups:                   #Nodes used as parent for groups(parent example).
      groupname1:                      #Configuration for `groupname1' group.
        delay: 120                     #Player with 'groupname1' will receive announcement every 2 minutes instead of 1.
        limit: 0                       #Player with 'groupname1' wont have limit on this announcer.
      groupname2:                      #Configuration for 'groupname2' group.
        delay: 180                     #Player with 'groupname2' will receive announcement every 3 minutes instead of 1.
        limit: 50                      #Player with 'groupname2' will only see message from this announcer 50 times.
    required-worlds: world             #This announcer will only world if the player is in the world names 'world'(single property example). 

  another-announcer:                   #Announcer name has to be unique.
    message-name:                      #Message name from the 'messages.yml' file(multimessage example).
    - 'test-message' 
    - 'another-message'
    - 'and-another-one'      
    delay: 120                         #Announcer will send message every 120 seconds.
    limit: 500                         #Since limit is 500 player will only see this announcer 500 times.
    enabled: true                      #Its true so it means announcer is turned on.
    prefix: true                       #Messages will show prefix since its set to true.
    show-on-join: false                #Its false so the announcer will send messages when interval passes the delay.
    random: true                       #It will pick random message from 3 above to display, if false it would go in order.
    synced: false                      #Announcer will send messages to players when they is time for them too see them(not at the same time probably).
    multilined: false                  #Since we use random there is no point to display all messages at once.
    aligned-center: false              #Were using prefix so centered messages probably wont look nice.
    show-groups-only: true             #Only the player with provided groups will see the message.
    required-groups:                   #Nodes used as parent for groups(list example).
    - groupname1:                      #Since its list `groupname1' inherits limit and delay from the announcer group.                    
                                       #No world required property so the announcer will work in all worlds. 

  third-join-announcer:                #Announcer name has to be unique.
    message-name: 'join-message'       #Message name from the 'messages.yml' file(single message example).
    delay: 86400                       #Announcer will send message every 24 hours.
    limit: 0                           #Since limit is 0 it will means its unlimited.
    enabled: true                      #Its true so it means announcer is turned on.
    prefix: false                      #Messages wont show prefix since its set to false.
    show-on-join: true                 #Now the announcer will send this message when player joins but only once in the 24 hours.
    random: false                      #If you have only one message in announcer this field is irrelevant.
    synced: false                      #Has to be false since players join at different times.
    multilined: false                  #If you have only one message in announcer this field is irrelevant.
    aligned-center: true               #Messages will be centered and not aligned left like the rest the usual ones.
    show-groups-only: true             #Only the player with provided groups will see the message.
    required-groups: groupname1        #Only has one groups that inherits announcers limit and delay(single property example).
                                       #No world required property so the announcer will work in all worlds.