继续完善README.md,增加权限节点和命令用法,以及TODO

This commit is contained in:
zhbaor 2020-06-17 10:57:11 +08:00
parent cfad7d2680
commit c15bb4ee0c

View file

@ -23,8 +23,43 @@ UnionBan中央服务器有一份联合封禁名单。参与此项目的Minecraft
- 将玩家添加到联合封禁列表中; - 将玩家添加到联合封禁列表中;
- 将玩家从联合封禁列表中移除。 - 将玩家从联合封禁列表中移除。
### 参与开发 #### 命令用法
```
/unionban help - 显示帮助
/unionban status - 显示服务器是否在线、服务端版本以及登录状态
/unionban login <用户名> <密码> - 登录
/unionban logout - 退出登录
/unionban ban <玩家名称> - 将玩家添加到联合封禁名单
/unionban pardon <玩家名称> - 将玩家从联合封禁名单中移除
```
插件将登录信息存储到`plugins/UnionBan-Client/config.yml`中。不推荐手动修改此文件的内容。插件加载时从`config.yml`中读取登录信息,自动登录。
#### 权限节点
`unionban.info`:默认所有玩家拥有。权限影响获取插件和服务端状态:
- `/unionban help`
- `/unionban status`
`unionban.account`:默认管理员拥有。权限影响修改账户信息:
- `/unionban login <username> <password>`
- `/unionban logout`
`unionban.ban`:默认管理员拥有。权限影响修改封禁名单:
- `/unionban ban <player>`
- `/unionban pardon <player>`
### 开发相关
欢迎提issue或者pull request。 欢迎提issue或者pull request。
项目使用JDK 1.8和maven,建议使用IDEA。 项目使用JDK 1.8和maven,建议使用IDEA。
#### TODO
- [ ] 复用HTTPS连接;
- [ ] 整理与服务端通信的代码,移到单独的repo中