A library for communication with a Minecraft client/server.
Find a file
Alex fa6b59ad02 Move package/license to GeyserMC, gradle conventions and submodules (#782)
* Change packages

* Move everything to a protocol submodule

* gradle conventions, update license

---------

Co-authored-by: Konicai <71294714+Konicai@users.noreply.github.com>
2024-04-24 08:58:19 +02:00
.github/workflows Move package/license to GeyserMC, gradle conventions and submodules (#782) 2024-04-24 08:58:19 +02:00
buildSrc Move package/license to GeyserMC, gradle conventions and submodules (#782) 2024-04-24 08:58:19 +02:00
example Move package/license to GeyserMC, gradle conventions and submodules (#782) 2024-04-24 08:58:19 +02:00
gradle Move package/license to GeyserMC, gradle conventions and submodules (#782) 2024-04-24 08:58:19 +02:00
protocol Move package/license to GeyserMC, gradle conventions and submodules (#782) 2024-04-24 08:58:19 +02:00
.gitignore Migrate to gradle, fix examples (#769) 2023-12-19 13:01:53 -05:00
build.gradle.kts Move package/license to GeyserMC, gradle conventions and submodules (#782) 2024-04-24 08:58:19 +02:00
gradlew Migrate to gradle, fix examples (#769) 2023-12-19 13:01:53 -05:00
gradlew.bat Migrate to gradle, fix examples (#769) 2023-12-19 13:01:53 -05:00
Jenkinsfile Migrate to gradle, fix examples (#769) 2023-12-19 13:01:53 -05:00
jitpack.yml Create jitpack.yml (#778) 2023-12-22 19:32:29 -08:00
LICENSE.txt Move package/license to GeyserMC, gradle conventions and submodules (#782) 2024-04-24 08:58:19 +02:00
lombok.config Remove unused exceptions, use java 9+ features and checkerframework, other cleanup (#780) 2024-04-24 08:50:31 +02:00
README.md Move package/license to GeyserMC, gradle conventions and submodules (#782) 2024-04-24 08:58:19 +02:00
settings.gradle.kts Move package/license to GeyserMC, gradle conventions and submodules (#782) 2024-04-24 08:58:19 +02:00

MCProtocolLib

MCProtocolLib is a simple library for communicating with Minecraft clients and servers. It allows developers to build custom bots, clients, or servers for Minecraft with ease.

Example Code

See the example folder for sample usage.

Adding as a Dependency

MCProtocolLib builds are published to the Open Collaboration repository. Follow the below steps to add MCProtocolLib as a dependency to your project.

Maven

Add the Repository

<repositories>
    <repository>
        <id>opencollab</id>
        <url>https://repo.opencollab.dev/maven-releases/</url>
    </repository>
</repositories>

Add the Dependency

<dependency>
    <groupId>org.geysermc.mcprotocollib</groupId>
    <artifactId>protocol</artifactId>
    <version>(version here)</version>
</dependency>

Gradle (Groovy DSL)

Add the Repository

repositories {
    maven { 
        name 'opencollab'
        url 'https://repo.opencollab.dev/maven-releases/'
    }
}

Add the Dependency

dependencies {
    implementation 'org.geysermc.mcprotocollib:protocol:(version here)'
}

Gradle (Kotlin DSL)

Add the Repository

repositories {
    maven("https://repo.opencollab.dev/maven-releases/") {
        name = "opencollab"
    }
}

Add the Dependency

dependencies {
    implementation("org.geysermc.mcprotocollib:protocol:(version here)")
}

Snapshots

To use snapshot builds, switch the URL to https://repo.opencollab.dev/maven-snapshots/.

Javadocs

You can find the Javadocs for MCProtocolLib on opencollab.

Building the Source

MCProtocolLib uses Maven to manage dependencies. To build the source code, run mvn clean install in the project root directory.

Support and Development

Please join the GeyserMC Discord server and visit the #mcprotocollib channel for discussion and support for this project.

License

MCProtocolLib is licensed under the MIT license.