在README.md中添加了相关说明

This commit is contained in:
zhbaor 2020-06-19 16:16:58 +08:00
parent fb69fb1ffe
commit 503338ef92

View file

@ -38,6 +38,22 @@ UnionBan中央服务器有一份联合封禁名单。参与此项目的Minecraft
插件将登录信息存储到`plugins/UnionBan-Client/config.yml`中。不推荐手动修改此文件的内容。插件加载时从`config.yml`中读取登录信息,自动登录。 插件将登录信息存储到`plugins/UnionBan-Client/config.yml`中。不推荐手动修改此文件的内容。插件加载时从`config.yml`中读取登录信息,自动登录。
#### 配置文件
```yaml
# UnionBan server address
ServerAddress: "https://api.unionban.icu"
# Login information.
# Do NOT change these manually!
username: ""
password: ""
api_key: ""
```
`ServerAddress`为联合封禁服务器的地址,管理员选择延迟较低的一个节点填入。
`username`,`password`和`api_key`为登录信息,管理员请**不要**手动更改,请使用`login`和`logout`子命令登录或登出账号。
#### 权限节点 #### 权限节点
`unionban.info`:默认所有玩家拥有。权限影响获取插件和服务端状态: `unionban.info`:默认所有玩家拥有。权限影响获取插件和服务端状态:
@ -64,4 +80,14 @@ UnionBan中央服务器有一份联合封禁名单。参与此项目的Minecraft
#### TODO #### TODO
- [ ] 复用HTTPS连接; - [ ] 复用HTTPS连接;
- [ ] 整理与服务端通信的代码,移到单独的repo中 - [ ] 整理与服务端通信的代码,移到单独的repo中
### 修改历史
#### v1.0.1
可以在配置文件中修改联合封禁服务端的地址,并可在插件启动时及`/unionban status`命令输出中看到当前设置。
#### v1.0.0
完成基础功能。