diff --git a/README.md b/README.md index 8dbef39..a7dd754 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,56 @@ -# HamsterBall +# [HamsterBall](https://github.com/MiniDay/hamster-ball) -仓鼠球:一个基于 Netty 的 Minecraft 服务端通用消息中间件(原HamsterService) +仓鼠球:一个基于 Netty 的 Minecraft 服务端通用消息中间件(原HamsterService) + +该插件依赖于 [仓鼠核心](https://github.com/MiniDay/hamster-core) + +# 添加依赖 + +## Gradle (`build.gradle`) + +```groovy +// 添加仓库 +repositories { + maven { + url "https://maven.airgame.net/maven-public" + } +} + +dependencies { + // 对于 Bukkit 插件 + compileOnly "cn.hamster3.mc.plugin:hamster-ball-bukkit:1.0.0" + // 对于 BungeeCord 插件 + compileOnly "cn.hamster3.mc.plugin:hamster-ball-bungeecord:1.0.0" +} +``` + +## Maven (`pom.xml`) + +```xml + + + + + + airgame-repo + AirGame Maven仓库 + https://maven.airgame.net/maven-public + + + + + + + cn.hamster3.mc.plugin + hamster-ball-bukkit + 1.0.0 + + + + cn.hamster3.mc.plugin + hamster-ball-bungeecord + 1.0.0 + + + +```