d124218100
* Improve wording * Description in `pom.xml` now matches README (shortened) * Use proper Markdown syntax throughout README * Switch README JitPack references from `Steveice10` to `GeyserMC` (resolves GeyserMC/MCProtocolLib#666, resolves GeyserMC/MCProtocolLib#673) * Changed meta references of "Steveice10" to "GeyserMC" (resolves GeyserMC/MCProtocolLib#667) * Added GeyserMC org to Maven `<developers>` list * Changed `Steveice10` in example URL to `GeyserMC` * Switch Maven repo references to Open Collab * Added note regarding snapshot builds
1.8 KiB
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 example/com/github/steveice10/mc/protocol/test/MinecraftProtocolTest.java 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
<repositories>
<repository>
<id>opencollab</id>
<url>https://repo.opencollab.dev/maven-releases/</url>
</repository>
</repositories>
<dependency>
<groupId>com.github.steveice10</groupId>
<artifactId>mcprotocollib</artifactId>
<version>(version here)</version>
</dependency>
Gradle
allprojects {
repositories {
maven { url 'https://repo.opencollab.dev/maven-releases/' }
}
}
dependencies {
implementation 'com.github.steveice10:mcprotocollib:(version here)'
}
Snapshots
To use snapshot builds, switch the URL to https://repo.opencollab.dev/maven-snapshots/.
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.