README.md

RedLib

RedLib is a Spigot plugin development library, designed to make your life easier and soothe the pain points of plugin development. Below, find instructions for the various components of RedLib.

Installation for Development

RedLib is a standalone plugin, so you will need to install it on any servers that have plugins which depend on it, and specify it as a dependency in your plugin.yml like this:

depend: [RedLib]

To get the jar, either download it from the releases tab either here on GitHub or on Spigot, or build it locally.

With Jitpack:

Gradle:

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

dependencies {
        compileOnly 'com.github.Redempt:RedLib:Tag'
}

Replace Tag with a release tag for RedLib. Example: 4.3.6. You can also use master as the tag to get the latest version, though you will have to clear your gradle caches in order to update it.

Maven:

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

<dependency>
        <groupId>com.github.Redempt</groupId>
        <artifactId>RedLib</artifactId>
        <version>Tag</version>
        <scope>provided</scope>
</dependency>

Replace Tag with a release tag for RedLib. Example: 4.3.6. You can also use master as the tag to get the latest version, though you will have to clear your maven caches in order to update it.

Build locally:

For Windows, use Git Bash. For Linux or OSX, just ensure you have Git installed.Navigate to the directory where you want to clone the repository, and run:

git clone https://github.com/Redempt/RedLib
cd RedLib
./gradlew jar

After running these commands, the jar will be at build/libs/RedLib.jar. You may also need to add the jar to your classpath. After that, you should be good to go!

Usage

For info on how to use RedLib, please see the wiki.