Home

About

ForestRedisAPI allows you to easily communicate between servers using Redis. Library also allows you to send your custom objects using built-in Gson. Receiving data is handled by custom Spigot/Bungee Events, so you can easily implement the features using standard Listeners.

Getting started

Make sure the server has ForestRedisAPI plugin installed. Otherwise, look at Standalone Usage.

Add ForestRedisAPI to your project

First, you need to setup the dependency on the ForestRedisAPI. Replace VERSION with the version of the release.

Maven:

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.github.ForestTechMC</groupId>
        <artifactId>ForestRedisAPI</artifactId>
        <version>VERSION</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Gradle:

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

dependencies {
    implementation 'com.github.ForestTechMC:ForestRedisAPI:VERSION'
}

Plugin configuration

You need to (soft)depend on ForestRedisAPI in order to work properly. Choose depend(s) for mandatory usage of the ForestRedisAPI or softdepend(s) for optional usage.

plugin.yml

# Required dependency
depend: [ForestRedisAPI]
# Optional dependency
softdepend: [ForestRedisAPI]

bungee.yml

# Required dependency
depends: [ForestRedisAPI]
# Optional dependency
softDepends: [ForestRedisAPI]