MiniDay/hamster-ball
1
0
Fork 0
Code Issues Pull Requests Actions Releases 9 Activity

docs: readme

Browse Source
This commit is contained in:
叁只仓鼠
2023-11-20 16:06:00 +08:00
parent 6d3d92daeb
commit d32d7c550d
1 changed files with 12 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -6,17 +6,14 @@
# 环境变量
为了适配 pterodactyl 面板，本插件除了从 `config.yml` 中配置服务器信息以外，还支持从环境变量中读取
为了适配 docker 环境，本插件除了从 `config.yml` 中配置服务器信息以外，还支持从环境变量中读取
| 环境变量名称 | 描述 | 对应 config 值 |
|:----------------------------|:-------------------|:------------------------------|
| BALL_SERVER_HOST | 仓鼠球服务器地址 | ball-server.host |
| BALL_SERVER_PORT | 仓鼠球服务器端口 | ball-server.port |
| BALL_EVENT_LOOP_THREAD | 处理器线程数 | ball-server.event-loop-thread |
| BALL_LOCAL_SERVER_IP | 本服务器 IP | server-info.host |
| BALL_LOCAL_SERVER_PORT | 本服务器端口 | server-info.port |
| BALL_LOCAL_SERVER_INFO_ID | 本服务器唯一识别码，最长 32 字符 | server-info.id |
| BALL_LOCAL_SERVER_INFO_NAME | 本服务端名称，用于展示给玩家看 | server-info.name |
| 环境变量 | 描述 | 对应 config 值 |
|:----------------------------|:-------------------|:-----------------|
| BALL_LOCAL_SERVER_IP | 本服务器 IP | server-info.host |
| BALL_LOCAL_SERVER_PORT | 本服务器端口 | server-info.port |
| BALL_LOCAL_SERVER_INFO_ID | 本服务器唯一识别码，最长 32 字符 | server-info.id |
| BALL_LOCAL_SERVER_INFO_NAME | 本服务端名称，用于展示给玩家看 | server-info.name |
# 添加依赖
@@ -32,9 +29,9 @@ repositories {
dependencies {
// 对于 Bukkit 插件
compileOnly "cn.hamster3.mc.plugin:ball-bukkit:1.0.0"
compileOnly "cn.hamster3.mc.plugin:ball-bukkit:1.4.0"
// 对于 BungeeCord 插件
compileOnly "cn.hamster3.mc.plugin:ball-bungeecord:1.0.0"
compileOnly "cn.hamster3.mc.plugin:ball-bungee:1.4.0"
}
```
@@ -57,13 +54,13 @@ dependencies {
<dependency>
<groupId>cn.hamster3.mc.plugin</groupId>
<artifactId>ball-bukkit</artifactId>
<version>1.0.0</version>
<version>1.4.0</version>
</dependency>
<!--对于 BungeeCord 插件-->
<dependency>
<groupId>cn.hamster3.mc.plugin</groupId>
<artifactId>ball-bungeecord</artifactId>
<version>1.0.0</version>
<artifactId>ball-bungee</artifactId>
<version>1.4.0</version>
</dependency>
</dependencies>
</project>