README.md

GG Wave

Lightweight plugin to say GGs to your donors!
Report Bug · Request Feature

Table of Contents

1. About The Project
2. Commands
3. Developer API
4. License
5. Contact

About The Project

Extremely lightweight yet essential plugin to encourage donating.

Here's why you should use this plugin:

• Lightweight & Optimized
• Easy setup; Drag & Drop
• All messages are configurable, even with documentation!
• Developer API in case you want to implement this in your plugins!

(back to top)

Commands

This is a list of commands available in the plugin. Note that all commands require the ggwave.admin permission!

Command	Description
/ggwave	Display's the help menu
/ggwave start <duration>	Start a GG wave with the specified duration in seconds
/ggwave stop	Stop the current GG wave

(back to top)

Developer API

This section is for developers who want to make use of this plugin's API.

API

package com.thepwo.ggwave.api;

public interface GGWaveAPI {

    /**
     * Check if there is any GG wave currency running
     *
     * @return ~ whether any GG is running
     */
    boolean isGGWaveRunning();

    /**
     * Start a GG wave, failing silently if a GG wave is already running
     *
     * @param duration ~ Number of seconds the GG wave should last
     */
    void startGGWave(long duration);

    /**
     * Stops any current GG wave, failing silently if there is no current GG wave
     */
    void stopGGWave();
}

To get the API implementation:

GGWaveAPI api =  ((GGWave) Bukkit.getPluginManager().getPlugin("GGWave")).getPlugin().getApi();

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

TheTrustyPwo - Pwo#0001 - thetrustypwo@gmail.com

Project Link: https://github.com/TheTrustyPwo/GGWave

(back to top)