Skip to content

README.md

Latest commit

 

History

History
83 lines (56 loc) · 1.59 KB

README.md

File metadata and controls

83 lines (56 loc) · 1.59 KB

UtilsLib

A shared code library for my projects. Feel free to use it anywhere you want. A wiki isn't available yet, but here's a quick overview

Features

ListenerSetup

Automatically register your event listeners without needing to manually register them in the main plugin class.

PaperPlugin class

Automatically handle plugin dependencies (currently supports FoliaLib, CommandAPI, ScoreboardLib and others) with verbose logging and automatically register listeners and variables.

CustomItem, CustomItemDSL & CustomItemRegistry

Create custom items easily using a dsl builder, with support for an even craft recipe.

Utilities

Many helpful utility functions, such as easy unenchantable items, easier adventure api builders, async dsl chains and many others

Shading

Gradle Shading

Add JitPack to your repositories:

repositories {
    maven("https://jitpack.io")
}

Add the dependency:

dependencies {
    implementation("com.github.justorl:UtilsLib:2.3.12")
}

Relocate the package if needed (recommended):

tasks.shadowJar {
    relocate("com.pulse.utilslib", "your.package")
}

Maven Shading

Add the repository:

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

Add the dependency:

<dependency>
  <groupId>com.github.justorl</groupId>
  <artifactId>UtilsLib</artifactId>
  <version>2.3.12</version>
</dependency>

Relocate the package if needed (recommended):

<relocation>
    <pattern>com.pulse.utilslib</pattern>
    <shadedPattern>your.package</shadedPattern>
</relocation>