Home

👋 Welcome!

CraftLib is a Kotlin JVM project aiming to wrap the entire Minecraft codebase. Yes, everything.

The project will support numerous aspects of the Minecraft game, constantly being expanded. These projects are build to be modular and scalable, supporting all versions of Minecraft where applicable.

Additionally, we aim to support many community standards such as the schematic format. Any contributions are welcome and feedback is greatly appreciated.

Have fun!

🔨 Modules

Currently CraftLib is composed of five modules.

• Chat - Handles serializing and deserializing chat components from their JSON representation.
• Commons - Contains some common code to be shared among modules.
• NBT - IO operations for the NBT file format.
• Protocol - Wraps the entire Minecraft network protocol, currently supporting 1.7.x - 1.8.x.
• Schematic - Reads and writes schematic files.

🚀 Using it

To include CraftLib in your Kotlin / Java project, you'll need to add the Maven Central repository.

🌌 Maven

When using Maven, the central repository is already present by default in your build script. To add the depencendy, include the following in the dependencies tag.

<dependency>
    <groupId>dev.zerite.craftlib</groupId>
    <artifactId>craftlib-protocol</artifactId>
    <version>0.1.4</version>
</dependency>

🧱 Gradle

When using Gradle, you must explicitly include the central repository.

repositories {
    mavenCentral()
}

Then you can add CraftLib library as follows.

dependencies {
    implementation 'dev.zerite.craftlib:craftlib-protocol:0.1.4'
}