Broadcast

A sponge plugin for sending automated messages to your server.

This plugin is designed to be a simple and lightweight plugin for sending information to your players. Whether it be new server updates, social media links, or shoutouts, you need a simple way to communicate with players.

About

This free and open source software is licensed under GPL v3. You can read more about our license here.

Want to help out? Fork me on Github.

Donations of any kind are always appreciated. Donate here!

Installation

Prerequisites

Java 8
SpongeVanilla or SpongeForge

Installation Steps

Download Broadcast to your server.
Place the downloaded jar file in your mods folder.
Restart your server.
Done! Now you can move onto configuration.

Configuration

Default Config

{
    "delay": {
        "type": "constant",
        "constant": 60,
        "random": {
            "min": 5,
            "max": 20
        }
    },
    "messages": [
        {
            "color": "red",
            "text": "Thank you for choosing Broadcast!"
        },
        {
            "color": "yellow",
            "text": "This plugin was written by zachoooo & morrissimo."
        },
        {
            "color": "aqua",
            "text": "Edit the configuration to put your own messages in."
        },
        {
            "color": "yellow",
            "extra": [
                {
                    "text": "["
                },
                {
                    "clickEvent": {
                        "action": "open_url",
                        "value": "http://www.github.com/morrissimo/Broadcast"
                    },
                    "color": "green",
                    "text": "Github"
                },
                {
                    "text": "]"
                }
            ],
            "text": "Fork me on "
        }
    ],
    "prefix": {
        "extra": [
            {
                "color": "yellow",
                "text": "Broadcast"
            },
            {
                "text": "] "
            }
        ],
        "text": "["
    },
    "random": false,
    "no-repeat": true
}

delay: Contains settings to control how much time (in seconds) elapses between broadcasts being displayed. The subkey "type" should be one of "constant" or "random"; the other subkeys should be used to configure the behavior based on the specified "type".

prefix: Some text displayed before a broadcast to indicate that the message is a broadcast.

random: Whether or not to display the messages randomly or in order.

no-repeat: If random is set to true, then don't repeat the same message twice.

You can use configuration formatting from here: http://minecraft.gamepedia.com/Commands#Raw_JSON_text

There are some generators that you can use to help you format chat:

Building

Prerequisites

Java 8
Git
Gradle (Packaged with project)

Note: If you do not have Gradle installed then use ./gradlew for Unix systems or Git Bash and gradlew.bat for Windows systems in place of any 'gradle' command.

Run the following commands to build the project yourself.

git clone https://github.com/zachoooo/Broadcast.git
cd Broadcast
gradle build

The compiled jar will be located in ./build/libs.

Authors

zachoooo
morrissimo