69 lines
2.2 KiB
Markdown
69 lines
2.2 KiB
Markdown
# [HamsterBall](https://gitee.com/MiniDay/hamster-ball)
|
||
|
||
仓鼠球：一个基于 Netty 的 Minecraft 服务端通用消息中间件（原HamsterService）
|
||
|
||
该插件依赖于 [仓鼠核心](https://gitee.com/MiniDay/hamster-core)
|
||
|
||
# 环境变量
|
||
|
||
除了从 `config.yml` 中配置服务器信息以外，本插件还支持从环境变量中读取
|
||
|
||
| 环境变量名称 | 描述 | 对应 config 值 |
|
||
|:-----------------------|:------------------|:------------------------------|
|
||
| BALL_SERVER_HOST | 服务器唯一识别码，最长 32 字符 | ball-server.host |
|
||
| BALL_SERVER_PORT | 服务器唯一识别码，最长 32 字符 | ball-server.port |
|
||
| BALL_EVENT_LOOP_THREAD | 服务器唯一识别码，最长 32 字符 | ball-server.event-loop-thread |
|
||
| BALL_SERVER_INFO_ID | 服务器唯一识别码，最长 32 字符 | server-info.id |
|
||
| BALL_SERVER_INFO_NAME | 服务端名称，用于展示给玩家看 | server-info.name |
|
||
|
||
# 添加依赖
|
||
|
||
## 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
|
||
|
||
<project>
|
||
<!--添加仓库-->
|
||
<repositories>
|
||
<repository>
|
||
<id>airgame-repo</id>
|
||
<name>AirGame Maven仓库</name>
|
||
<url>https://maven.airgame.net/maven-public</url>
|
||
</repository>
|
||
</repositories>
|
||
|
||
<dependencies>
|
||
<!--对于 Bukkit 插件-->
|
||
<dependency>
|
||
<groupId>cn.hamster3.mc.plugin</groupId>
|
||
<artifactId>hamster-ball-bukkit</artifactId>
|
||
<version>1.0.0</version>
|
||
</dependency>
|
||
<!--对于 BungeeCord 插件-->
|
||
<dependency>
|
||
<groupId>cn.hamster3.mc.plugin</groupId>
|
||
<artifactId>hamster-ball-bungeecord</artifactId>
|
||
<version>1.0.0</version>
|
||
</dependency>
|
||
</dependencies>
|
||
</project>
|
||
```
|