Skip to content

Latest commit

 

History

History
174 lines (135 loc) · 4.16 KB

README.md

File metadata and controls

174 lines (135 loc) · 4.16 KB

Java CI with Gradle Gradle Publish Deploy Dokka KDocs with GitHub Pages

PacketLib - A library for serializing Minecraft Packets typesafe in Kotlin

KDocs: PacketLib KDocs

Type Safe generated Minecraft Protocol Packets in Kotlin. For current versions: 1.19.3(also 1.19.4). But some complex Packets are not implemented yet.

Prewords

Special Thanks to wiki.vg for the protocol documentation. And to PrismarineJS/minecraft-data for the protocol data as json.

Repo

Jitpack:

Gradle Kotlin
repositories {
    maven { url = uri("https://jitpack.io") }
}

dependencies {
    implementation("com.github.layercraft:packetlib:0.0.23")
}
Gradle Groovy
repositories {
    maven { url = 'https://jitpack.io' }
}

dependencies {
    compile 'com.github.layercraft:packetlib:0.0.23'
}
Maven
<project>
    ...
    <repositories>
        <repository>
            <id>jitpack.io</id>
            <url>https://jitpack.io</url>
        </repository>
    </repositories>
    ...
    <dependencies>
        <dependency>
            <groupId>com.github.layercraft</groupId>
            <artifactId>packetlib</artifactId>
            <version>0.0.23</version>
        </dependency>
    </dependencies>
    ...
</project>

Github Packages:

Gradle Kotlin
repositories {
    maven {
        url = uri("https://maven.pkg.github.com/Layercraft/Translator-API")
        credentials {
            username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME")
            password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN")
        }
    }
}

dependencies {
    implementation("io.layercraft.connector:translator-api:0.0.23")
}
Gradle Groovy
repositories {
    maven {
        url = 'https://maven.pkg.github.com/Layercraft/Translator-API'
        credentials {
            username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
            password = project.findProperty("gpr.key") ?: System.getenv("TOKEN")
        }
    }
}

dependencies {
    compile 'io.layercraft.connector:translator-api:0.0.23'
}
Maven
<project>
    ...
    <repositories>
        <repository>
            <id>Translator-API</id>
            <url>https://maven.pkg.github.com/Layercraft/Translator-API</url>
        </repository>
    </repositories>
    ...
    <dependencies>
        <dependency>
            <groupId>io.layercraft.connector</groupId>
            <artifactId>translator-api</artifactId>
            <version>0.0.23</version>
        </dependency>
    </dependencies>
    ...
</project>

Settings.xml

<settings>
    ...
    <servers>
        <server>
            <id>Translator-API</id>
            <username>USERNAME</username>
            <password>TOKEN</password>
        </server>
    </servers>
    ...
</settings>

Serialization Implementations

There are no more default implementations for serialization in this library, so you have to write your own. But here are some old example implementations: https://gist.github.com/Newspicel/54184b844dee00a4f351e58de033e071

So you need to implement the MCProtocolSerializer interface and the MCProtocolDeserializer interface. Then just get your Packet over the MinecraftCodecs and serialize it.