FrogAnnounce

Configuration

It's pretty easy to configure my plugin. Here's an example configuration file:

Configuration.yml

#
#Hey, you! You might want to run this command: /fa off
#    before configuring. This will stop it from announcing the unnecessary (as you're already configuring it) messages telling you
#    to configure it.
#Leave no whitespace, unless the empty line has a # on it somewhere! USE NO TABS. ONLY SPACES.
#
# WARNING: WHEN YOU USE A COMMAND THAT CHANGES THE CONFIGURATION, ALL OF THE COMMENTS EXPLAINING HOW TO CONFIGURE THIS WILL BE ERASED. READ THEM BEFORE YOU DO IT.
Settings:
    #Interval: Time in minutes to announce by.
    Interval: 5
    #Random: Announce randomly? true = random announcement selected every x minutes (interval), false = sequential, looping back to the first announcement when it reaches the end of the list.
    Random: false
    #Permission: Use permissions? True/False should be obvious. Requires Vault. If you want a non-OP to be able to administrate FrogAnnounce, give them frogannounce.* or frogannounce.admin.
    Permission: true
    #displayMessageOnJoin: Should the plugin display a message to users when they log in? Will not display if they are opted-out of announcements.
    #Default: false
    displayMessageOnJoin: false
    #showConsoleAnnouncements: Should the plugin display a message saying that it is announcing now, with the announcement?
    #Default: false
    showConsoleAnnouncements: false
Announcer:
    #Tag: This will go in front of every announcement. You may remove it by leaving it blank: ''
    Tag: '&AQUA;[FrogAnnounce]'
    #ToGroups: Only announce to the groups you specify in "Groups"? (Only available if you have Vault disable, if you do not have it)
    ToGroups: false
    #Groups: List the groups that you want the announcements will go to. You do not need to do this if ToGroups is false. (Only available if you have Vault)
    Groups:
        #Follow the below format.
        #- 'GroupName'
        #You must keep the dash (-) and the apostophes ('').
        - 'Everyone'
        - 'Default'
        - 'Donators'
        - 'Moderators'
        - 'Administrators'
        - 'SomeOtherGroup'
    #Strings: What you want the plugin to say.    
    Strings:
        #Follow this format.
        #- "&COLOUR;Message"
        #or
        #- "Message"
        #You must keep the dash (-) and the quotation marks ("").
        #You can specify what groups you want each announcement to go to - see the third announcement down or see this webpage, detailing how to do it:
        # http://dev.bukkit.org/server-mods/frogannounce/pages/miscellaneous-explanations/#w-announcement-specific-group-filters
        - "&RED;You have yet to configure &GREEN;FrogAnnounce!&NEW_LINE;&DARK_GREEN;Please configure it soon."
        - "&DARK_PURPLE;No, seriously. Configure me."
        - "&DARK_RED;Y U NO CONFIGURE PLUGINS, SERVER OWNER?"
        - "&LIGHT_PURPLE;Moo. Anyone there?"
        #Oh, did you just configure it? I see. Okay, that works then.
        #
        #You can use either /fa reload, /frogannounce reload, or just use Bukkit's built-in reload (/reload) to reload this configuration.
        #And yes, /fa reload will load the new announcements.
        #
        #You may use the following colours:
        # &AQUA;
        # &DARK_AQUA;
        # &BLACK;
        # &BLUE;
        # &DARK_BLUE;
        # &GRAY;
        # &DARK_GRAY;
        # &GREEN;
        # &DARK_GREEN;
        # &LIGHT_PURPLE;
        # &DARK_PURPLE;
        # &RED;
        # &DARK_RED;
        # &GOLD;
        # &WHITE;
        # (New in 2.0):
        # &MAGIC;
        # &BOLD;
        # &ITALIC;
        # &UNDERLINE;
        # &STRIKE;
        #
        #You may also use use this to split announcements over two (or several) lines:
        #&NEW_LINE;
        #Note that this will also repeat the Tag (The thing that defaults to "&AQUA;[FrogAnnounce]"). Also, colours work on that second line.
    #joinMessage: A message you want to display the users when they log in.
    #Default: Welcome to the server! Use /help for assistance.
    joinMessage: &GREEN;Welcome to the server! Use /help for assistance.

You must login to post a comment. Don't have an account? Register to get one!

Facts

Date created
Oct 21, 2011
Last updated
Mar 12, 2013

Author