https://github.com/geysermc/mcprotocollib

A library for communication with a Minecraft client/server.
https://github.com/geysermc/mcprotocollib

java library minecraft minecraft-protocol protocol

Last synced: 4 days ago
JSON representation

A library for communication with a Minecraft client/server.

• Host: GitHub
• URL: https://github.com/geysermc/mcprotocollib
• Owner: GeyserMC
• License: mit
• Created: 2012-08-13T01:57:38.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2024-08-05T15:36:47.000Z (5 months ago)
• Last Synced: 2024-08-06T10:12:38.586Z (5 months ago)
• Topics: java, library, minecraft, minecraft-protocol, protocol
• Language: Java
• Homepage:
• Size: 4.12 MB
• Stars: 718
• Watchers: 43
• Forks: 201
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# 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](https://github.com/GeyserMC/MCProtocolLib/tree/master/example/src/main/java/org/geysermc/mcprotocollib) folder for sample usage.

## Adding as a Dependency

MCProtocolLib builds are published to the [Open Collaboration repository](https://repo.opencollab.dev/#/maven-snapshots/org/geysermc/mcprotocollib/protocol).

Follow the below steps to add MCProtocolLib as a dependency to your project.

### Maven

#### Add the Repository

```xml

    

        opencollab

        https://repo.opencollab.dev/main/

    

```

#### Add the Dependency

```xml

    org.geysermc.mcprotocollib

    protocol

    (version here)

```

### Gradle (Groovy DSL)

#### Add the Repository

```groovy

repositories {

    maven { 

        name 'opencollab'

        url 'https://repo.opencollab.dev/main/'

    }

}

```

#### Add the Dependency

```groovy

dependencies {

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

}

```

### Gradle (Kotlin DSL)

#### Add the Repository

```kotlin

repositories {

    maven("https://repo.opencollab.dev/main/") {

        name = "opencollab"

    }

}

```

#### Add the Dependency

```kotlin

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](https://ci.opencollab.dev/job/GeyserMC/job/MCProtocolLib/job/master/javadoc/overview-summary.html).

## 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](https://discord.gg/geysermc) and visit the **#mcprotocollib** channel for discussion and support for this project.

## License

MCProtocolLib is licensed under the **[MIT license](https://opensource.org/license/mit)**.