docs: plugin README with build instructions

This commit is contained in:
2026-07-19 03:06:23 +08:00
parent 7bc22dee0c
commit 37657a7ba4

View File

@@ -0,0 +1,41 @@
# MC Report Plugin - Paper 1.20.4
游戏内举报/注册/登录插件
## 编译
```bash
cd mc-report-plugin
mvn clean package
```
输出 `target/mc-report-plugin-1.0.0.jar`
## 安装
1. 将 jar 放入服务器 `plugins/` 目录
2. 重启服务器
3. 编辑 `plugins/MCReport/config.yml`
```yaml
api_url: "http://localhost:3100/api/external"
external_key: "你的external_api_key"
```
external_api_key 在 Web 安装时自动生成,位于 `data/config.json`
## 命令
| 命令 | 说明 |
|------|------|
| `/report reg <密码> <邮箱> [用户名]` | 注册(默认用户名=游戏名, 来源=皮肤站) |
| `/report login <密码> [用户名]` | 登录 |
| `/report report [玩家] <原因>` | 举报(自动检测管理员投诉) |
| `/report suggest <内容>` | 建议 |
| `/report track [id]` | 追踪工单 |
## 依赖
- Paper 1.20.4+
- Java 17+
- Maven 3.8+