|
1 | | -这是一个为了简化部署的版本,只保留了核心的人数查询功能 |
2 | | -1.登录QQ |
| 1 | +# 简化版服务器人数查询机器人 |
3 | 2 |
|
4 | | -推荐使用https://github.com/NapNeko/NapCatQQ QQ机器人框架,当然其他框架也可以 |
| 3 | +这是一个 **简化部署版本**,只保留了 **核心的服务器人数查询功能**,方便快速上手。 |
5 | 4 |
|
6 | | -按照 https://github.com/NapNeko/NapCatQQ 提供的方法登录, |
| 5 | +## ✨ 功能简介 |
7 | 6 |
|
8 | | -如何修改配置文件如同,在config目录下“onebot11_QQ号”配置文件,修改如下部分 |
| 7 | +- 基于 OneBot 协议的 QQ 机器人功能 |
| 8 | +- 支持通过服务器 ID 查询玩家人数 |
| 9 | +- 国内高速低延迟 API 接入 |
| 10 | +- 查询结果自动缓存 1 分钟 |
9 | 11 |
|
10 | | - "ws": { |
11 | | - "enable": true, |
12 | | - "host": "127.0.0.1", |
13 | | - "port": 6700 |
14 | | - "reverseWs": { |
15 | | - "enable": true, |
16 | | - "urls": [ |
| 12 | +--- |
17 | 13 |
|
18 | | -也就是开启ws功能端口为6700 |
| 14 | +## 🚀 快速开始 |
19 | 15 |
|
20 | | -2.下载程序API版本设置配置文件 |
21 | | -打开app.config文件,格式如下 |
| 16 | +### 1. 登录 QQ |
22 | 17 |
|
23 | | - 《?xml version="1.0" encoding="utf-8" ?> |
24 | | - 《configuration> |
25 | | - 《appSettings> |
26 | | - 《add key="ServerPorts" value="10*20*30" /> |
27 | | - 《add key="ServerName1" value="1服0" /> |
28 | | - 《add key="ServerName2" value="2服2" /> |
29 | | - 《add key="ServerName3" value="3服4" /> |
30 | | - 《/appSettings> |
31 | | - 《/configuration> |
| 18 | +推荐使用 [NapCatQQ](https://github.com/NapNeko/NapCatQQ) 框架(支持 OneBot 协议),当然也可使用其他兼容 OneBot 协议的框架。 |
32 | 19 |
|
33 | | -其中ServerPorts填写对应的serverid以*** 号为隔断如1 * 2 * 3 (无需空格) |
| 20 | +登录方法请参考 NapCatQQ 官方文档:[NapCatQQ 登录教程](https://github.com/NapNeko/NapCatQQ) |
34 | 21 |
|
35 | | - 《add key="ServerName1" value="1服0" /> |
36 | | - |
37 | | -这个参数为对应服务器名称例如ServerName1对应者第一个参数也就是 ID为10的服务器 |
| 22 | +#### 修改配置文件启用 WebSocket 功能: |
38 | 23 |
|
| 24 | +编辑 `config/onebot11_你的QQ号` 中的配置项: |
39 | 25 |
|
40 | | -返回格式例如 |
41 | | - |
42 | | - 1服0:ID为10服务器的对应人数 |
| 26 | +```json |
| 27 | +"ws": { |
| 28 | + "enable": true, |
| 29 | + "host": "127.0.0.1", |
| 30 | + "port": 6700, |
| 31 | + "reverseWs": { |
| 32 | + "enable": true, |
| 33 | + "urls": [ |
| 34 | + ... |
| 35 | + ] |
| 36 | + } |
| 37 | +} |
| 38 | +``` |
43 | 39 |
|
44 | | -如果需要添加或者减少服务器按照格式添加,删除即可 |
| 40 | +确保 WebSocket 功能已启用,并使用端口 `6700`。 |
45 | 41 |
|
46 | | -服务器id可以前往[服务器列表](https://scp.manghui.net/list/)查看也就是列表上的srvID |
| 42 | +--- |
47 | 43 |
|
48 | | -请严格遵守GPL3.0许可协议 |
| 44 | +### 2. 启动本项目 |
49 | 45 |
|
50 | | -API调用缓存为1分钟 |
| 46 | +运行 `SocketServer-GoHttpQQBOT` 后,会提示输入服务器 ID,用 `*` 分隔多个 ID,例如: |
51 | 47 |
|
52 | | -API由我个人搭建,提供了国内的高速低延迟访问,请各位多多支持我,如果你也想使用可以与我联系 |
| 48 | +``` |
| 49 | +11*22*33 |
| 50 | +``` |
53 | 51 |
|
54 | | -可以前往[服务器状态监控](https://)查看API状态 |
| 52 | +**服务器 ID 可前往 [服务器列表](https://scp.manghui.net/list/) 查看(即 srvID 栏)** |
55 | 53 |
|
| 54 | +--- |
| 55 | + |
| 56 | +## 📡 API 状态监控 |
| 57 | + |
| 58 | +--- |
| 59 | + |
| 60 | +## 📄 许可证 |
| 61 | + |
| 62 | +本项目遵循 **[GNU GPL v3.0 License](https://www.gnu.org/licenses/gpl-3.0.html)** 开源协议。请严格遵守协议条款。 |
0 commit comments