Obsidian
An API aimed to simplify the development of Paper plugins
Info
This API is aimed to simplify the development of Paper plugins, providing a lot of utilities that will make your life (and mine) easier
Even though a standalone plugin version is available, it's recommended to shade this API into your plugins, as this API changes frequently and depending on the standalone version may cause some issues if server owners install some plugins that depend on different versions of this API
❗ You need Java 17+ to use this API/Plugin. If you are using a lower version consider upgrading
⚠️ You need to set your plugin to use Spigot mappings in order to preserve compatibility with Paper forks that are still using Spigot mappings. More information in the PaperMC documentation
⚠️ Only Minecraft 1.17 or superior is officially supported. Versions below 1.17 will not receive any support
It's mostly used in my plugins, but you can use it on your own plugins if you want, just make sure to give proper credit!
How to import
Gradle
repositories {
maven {
name = "devadri"
url = uri("https://repo.devadri.es/repository/releases") // Use dev repository for beta builds
}
}
dependencies {
implementation("me.devadri:obsidian:{VERSION}") // Replace {VERSION} with the desired version
}
Maven
<repositories>
<repository>
<id>devadri</id>
<url>https://repo.devadri.es/repository/releases</url> <!-- Use dev repository for beta builds -->
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>me.devadri</groupId>
<artifactId>obsidian</artifactId>
<version>{VERSION}</version> <!-- Replace {VERSION} with the desired version -->
</dependency>
</dependencies>
Credits
- Thanks to Byteflux and AlessioDP for creating the Libby library, which is used to manage dependencies at runtime.
- Thanks to CryptoMorin for creating the XSeries library, which is used to preserve compatibility with older and newer versions of Minecraft, as IDs and APIs can vary between versions.
