Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boxbeam/redlib
A powerful library for Spigot plugin development with a wide range of tools to make your life easier
https://github.com/boxbeam/redlib
spigot spigot-plugins
Last synced: about 20 hours ago
JSON representation
A powerful library for Spigot plugin development with a wide range of tools to make your life easier
- Host: GitHub
- URL: https://github.com/boxbeam/redlib
- Owner: boxbeam
- License: mit
- Created: 2018-03-27T21:51:44.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-17T23:22:23.000Z (4 months ago)
- Last Synced: 2024-12-25T10:03:55.962Z (about 20 hours ago)
- Topics: spigot, spigot-plugins
- Language: Java
- Homepage:
- Size: 4 MB
- Stars: 179
- Watchers: 8
- Forks: 31
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
Support Discord: https://discord.gg/agu5xGy2YZ
Docs: https://redempt.dev/javadoc/com/github/Redempt/RedLib/index.html
# Installation for Development
RedLib is a standalone plugin, but can also be used as a shaded dependency if you do not want to distribute RedLib directly. To use it as a plugin dependency, you must add it as a dependency in your plugin.yml:
```yaml
depend: [RedLib]
```
To get the jar, either download it from the releases tab either here on [GitHub](https://github.com/Redempt/RedLib/releases) or on [Spigot](https://www.spigotmc.org/resources/redlib.78713/), or [build it locally](https://github.com/Redempt/RedLib#build-locally).
## Gradle
```groovy
repositories {
maven { url = 'https://redempt.dev' }
}
```
```groovy
dependencies {
compileOnly 'com.github.Redempt:RedLib:Tag'
}
```
Replace `Tag` with a release tag for RedLib. You can see the latest version [here](https://github.com/Redempt/RedLib/releases/latest).
To shade RedLib, change the dependency from `compileOnly` to `implementation`, and install the [gradle shadow plugin](https://github.com/johnrengelman/shadow).
If you are having a problem while building, such as plugin.yml is duplicate, try setting duplicatesStrategy to DuplicatesStrategy.EXCLUDE.
```groovy
tasks {
processResources {
duplicatesStrategy = DuplicatesStrategy.EXCLUDE
}
}
```
## Maven:
```xml
redempt.dev
https://redempt.dev
```
```xml
com.github.Redempt
RedLib
Tag
provided
```
Replace `Tag` with a release tag for RedLib. You can see the latest version [here](https://github.com/Redempt/RedLib/releases/latest).
To shade RedLib, change the scope from `provided` to `compile`.
## 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](https://github.com/Redempt/RedLib/wiki).