Developer Documentation

This document outlines various developer resources concerning NuVotifier.

Contributing

NuVotifier is an open source GNU GPLv3 licensed project. We accept contributions through pull requests, and will make sure to credit you for your gracious contribution.

Building NuVotifier

NuVotifier can be built by running the following: ./gradlew build or ./gradlew.bat build on Windows. The resultant universal jar is built and written to universal/build/libs/nuvotifier-{version}.jar.

The build directories can be cleaned instead using the ./gradlew clean (and ./gradlew.bat build) command.

NuVotifier as a plugin dependency

ParallelBlock now maintains an independent Maven repository for free use by the community. Builds are automatically published by a CI operated by ParallelBlock.

Maven

You can have your project depend on NuVotifier as a dependency through the following code snippets:

<project>
...
    <repositories>
        <repository>
            <id>bintray-repo</id>
            <url>https://dl.bintray.com/ichbinjoe/public/</url>
        </repository>
        ...
    </repositories>
...
    <dependencies>
        <dependency>
            <groupId>com.vexsoftware</groupId>
            <artifactId>nuvotifier-universal</artifactId>
            <version>2.6.0</version>
            <scope>provided</scope>
        </dependency>
        ...
    </dependencies>
...
</project>

Gradle

You can include NuVotifier into your gradle project using the following lines:

...
repositories {
    maven {
        url 'https://dl.bintray.com/ichbinjoe/public/'
    }
    ...
}
...
dependencies {
    compileOnly "com.vexsoftware:nuvotifier-universal:version"
    ...
}
...

Vote Listeners and VotifierEvent

Read more about this here: https://github.com/vexsoftware/votifier/wiki/Vote-Listeners-and-VotifierEvent

Implementing NuVotifier v2 protocol in a server list

NuVotifier provides production ready reference implementations for interacting with NuVotifier servers. These libraries are available below:

• NodeJS
• PHP
• Golang