A library for communication with a Minecraft client/server.
Find a file
Alex 41eccedb93
Streamline api (#832)
This basically makes MinecraftCodec stateless and removes unused APIs.
The MinecraftCodecHelper has a state for an unused registry API, which is not needed at all. Developers can just send their own registry as seen in ServerListener. These only exist because there was an attempt at allowing multi-version support inside MinecraftCodecHelper, but that's not gonna be necessary if ViaVersion support gets added to MCPL.
The option to add back logic for multi-version support is fully open for the future. I didn't remove MinecraftCodecHelper being instance-based, so it's fully possible to readd the multi-version logic back in the future. Just level events and sounds being dynamic is not enough for multi-version support and thus should be removed to streamline the API.
This also removes many workarounds from the code that cause possible inconsistency. Often the MinecraftCodecHelper gets initialized in the tests with empty parameters. This removes them as parameters and removes the need to provide them by moving them to the object itself.
PacketCodecs were also improved to decrease the inheritance issues and streamline the code flow and remove the UnsupportedOperationExceptions being needed.
BufferedPacket was also removed since it's useless for Minecraft.
2024-07-20 16:26:32 -04:00
.github/workflows Move package/license to GeyserMC, gradle conventions and submodules (#782) 2024-01-11 12:21:23 -05:00
buildSrc Disable code signing for Jitpack (#813) 2024-06-02 01:16:19 -07:00
example Streamline api (#832) 2024-07-20 16:26:32 -04:00
gradle Replace MCAuth with RK_01 MinecraftAuth (#795) 2024-06-17 13:23:42 -07:00
protocol Streamline api (#832) 2024-07-20 16:26:32 -04:00
.editorconfig Add .editorconfig (#801) 2024-05-08 14:44:49 +01: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-01-11 12:21:23 -05: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 Fix Javadocs 2024-05-13 22:29:24 -04: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-01-11 12:21:23 -05:00
lombok.config Remove unused exceptions, use java 9+ features and checkerframework, other cleanup (#780) 2024-01-04 13:04:25 -05:00
README.md Update README.md (#805) 2024-05-04 01:05:51 -04:00
settings.gradle.kts Replace MCAuth with RK_01 MinecraftAuth (#795) 2024-06-17 13:23:42 -07: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 Gradle to manage dependencies. To build the source code, run ./gradlew clean build 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.