Getting Started

AbyssalLib eases creation of content in minecraft plugins and is developed to provide as many useful features as possible (as well as provide easy ways to integrate with other plugins using AbyssalLib)

Features

Item API: an easy to use Item API for making items with custom behaviours (e.g when hitting entity, breaking block etc), aswell as an easy to use Component system which allows custom components aswell! (layer for Data Component API)
Gui API: AbyssalLib comes with a Builder-Style GUI Api (also an `extend`able AbstractGui class) which allows easy creation of GUIs, the basis of the GUI API are of "Elements" and "Layers" (These are VERY simple)
Block API: AbyssalLib also comes with a Block API for creation of custom blocks which can be ticked and store data (using a custom data object which is entirely optional)
Block API is Highly Experimental and can be entirely rewritten ANY time, use with care!
Particle API: an easy to use Builder-Style Particle API which also supports ItemStacks as particles!
And MUCH more!

Adding as a Dependency

Follow these steps to add AbyssalLib as a dependency for your project:

Adding the repository:

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

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

Adding the dependency:

dependencies {
    implementation('com.github.darksoulq:AbyssalLib:<version>')
}

<dependency>
    <groupId>com.github.darksoulq</groupId>
    <artifactId>AbyssalLib</artifactId>
    <version>version</version>
</dependency>

Adding into paper-plugin.yml:

dependencies:
  server:
    AbyssalLib:
      required: true
      load: BEFORE
  bootstrap:
    AbyssalLib:
      required: true
      load: BEFORE

03 October 2025