🚀 V5 Branch: Active Development 🚧

---

Status: Mostly Stable, Active Development 🛠️

Welcome to the release/v5 branch! This is where the next major version of the project is currently being built.

Please Note:

• This branch is under active development.
• It is considered mostly stable and safe for production use.
• Breaking changes may still occur, but only if strictly necessary.
• New features and improvements will continue to land here.
• Once the API is deemed fully stable, prerelease versions will end and the first official release will be v5.0.0.

---

⚠️ release/v4 Branch: End of Life (EOL)

The release/v4 branch is now end-of-life and no longer supported.
No new features, bug fixes, or security patches will be provided.

However:

• v4 offers a more stable API surface for users who do not wish to migrate yet or prefer to wait for v5 stability with version 5.0.0+
• If you need long-term stability and do not require new features, you may continue using v4 at your own discretion.

---

 

Releases

The GitHub releases may be different from the spigot release

API Compatibility

The latest API version may not match the latest Minecraft Version.
(This is okay, as updates are not always required for every Minecraft version.)

DEVELOPMENT ROADMAP: https://github.com/users/Jake-Moore/projects/3

KamiCommon

SEE STRUCTURE.md FOR GRADLE MODULE BREAKDOWN

• A common library originally intended for Spigot plugin development, expanded for standalone use too.
• The spigot portions of this library aim to support all versions (since 1.8.x) via its sister project KamiCommonNMS
  • View the NMS disclaimers here: NMS Disclaimers

Modules

There are 6 common modules, 5 of which can be safely shaded

• The 5 modules that can be shaded are:
  • shared-utils, shared-jar, standalone-utils, standalone-jar, spigot-utils
• The last module, spigot-jar, compiles the spigot plugin and is only intended to be used as an api
  • When using this module, remember to modify the plugin.yml to include KamiCommon in the depend: list

Using KamiCommon

Repository Information

Add the following Repository to your build file.

Maven [pom.xml]:

<repository>
  <id>luxious-public</id>
  <name>Luxious Repository</name>
  <url>https://repo.luxiouslabs.net/repository/maven-public/</url>
</repository>

Gradle (kotlin) [build.gradle.kts]:

maven {
    name = "luxiousPublic"
    url = uri("https://repo.luxiouslabs.net/repository/maven-public/")
}

Gradle (groovy) [build.gradle]:

maven {
  name "luxiousPublic"
  url "https://repo.luxiouslabs.net/repository/maven-public/"
}

Dependency Information

• SEE STRUCTURE.md FOR GRADLE MODULE BREAKDOWN

Add the following dependency to your build file.
Replace {VERSION} with the version listed at the top of this page.
Replace {MODULE} with the module you want to use (spigot-jar, standalone-jar, etc.)

Maven Dependency [pom.xml]

<dependency>
  <groupId>com.kamikazejam.kamicommon</groupId>
  <artifactId>{MODULE}</artifactId>
  <version>{VERSION}</version>
  <scope>provided</scope> <!-- set to `compile` if shading a util or standalone jar -->
</dependency>

Gradle Dependency (groovy) [build.gradle]

implementation "com.kamikazejam.kamicommon:{MODULE}:{VERSION}"

Gradle Dependency (kotlin) [build.gradle.kts]

implementation("com.kamikazejam.kamicommon:{MODULE}:{VERSION}")

Features

See the wiki