zerite / craftlib Goto Github PK

The entire Minecraft codebase as a library, with protocol, NBT, chat and schematic file support.

1. What IS CraftLib?
2. Using it
3. Special Thanks

CraftLib is a simple Kotlin library which aims to completely recreate many of the essential concepts of Minecraft. This includes protocol, NBT, chat, localization, schematics and more to come!

This library includes full support for Kotlin's features out of the box with additional functions being introduced to ensure Java interoperability is simple and straightforward.

To include CraftLib into your project, add the Maven Central repository to your project. Then add the appropriate dependency notation for your build system to include our package.

Note: The wiki is currently a WIP. This file will be updated accordingly once it is sufficiently complete.

Maven

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

Gradle

implementation 'dev.zerite.craftlib:craftlib-protocol:0.1.4'

A HUGE thank you to the team at #mcdevs (Freenode IRC) and their wiki. Without their work documenting the Minecraft codebase, this project wouldn't be possible. Some comments from their wiki pages (particularly protocol) have been used throughout the codebase and all rights to those texts belong to their team.

YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor.