doc: 更换VitePress后的初步内容

This commit is contained in:
lazy
2024-08-28 00:50:44 +08:00
parent f7d7dab296
commit d1698186e1
128 changed files with 3490 additions and 6886 deletions
+26
View File
@@ -0,0 +1,26 @@
# aiocqhttp适配器系列教程
## OneBot 11 协议
OneBot 是用于接入多种消息平台的标准化协议,详细介绍:[https://onebot.dev/](https://onebot.dev/)
以下消息框架可以通过 OneBot 11 协议接入,需选择使用`aiocqhttp`作为适配器,修改`data/platform.json`配置文件,在`platform-adapters`字段中添加以下内容(如果已经有aiocqhttp的适配器,可以直接将其enable改为true):
```json
{
"adapter": "aiocqhttp",
"enable": true,
"host": "0.0.0.0",
"port": 8080,
"access-token": ""
}
```
![data/platform.json](https://cos.thelazy.cn/pictures/202405292250017.jpeg)
当前可用的OneBot 11标准消息平台,你可以选择下方任意
- [Lagrange.OneBot的教程](./lagrange)
- [NapCat的教程](./napcat)
- [LiteLoaderQQNT的教程](./llonebot)
- [shamrock的教程](./shamrock)
@@ -0,0 +1,59 @@
# 部署消息平台Lagrange的教程
## Lagrange介绍
Lagrange 是一个 QQNT 协议逆向工程框架,比 Shamrock 或 Mirai 更加轻便,在目前也较为稳定。通过 OneBot 11 协议接入,需选择使用`aiocqhttp`作为适配器,填写配置时可参考 Shamrock 的方式。
可选平台(需要.NET 8 or 7支持):
- Mac OS 也可使用
- Linux Ubuntu 22.04,Debian 12应该都可以
- Windows 10,11,Server2019及以上
> 注意:
> 要使用NT QQ发信息,旧版QQ无法正常使用
## 部署步骤
以下仅提供 Windows 上的大致步骤,详细步骤或其他平台请参考 [Lagrange官方文档](https://lagrangedev.github.io/Lagrange.Doc/Lagrange.OneBot/)
### 环境配置
安装.NET 8运行时,[点击直达微软官网下载](https://dotnet.microsoft.com/zh-cn/download/dotnet/thank-you/runtime-desktop-8.0.4-windows-x64-installer)
### 从Github Actions下载最新的build
需要登录Github后才能下载,如果你不需要部分特性,可以在Release下载,看图片3
[Github Actions](https://github.com/KonataDev/Lagrange.Core/actions)
看图进行下载:
![图片1](/assets/image/dl_lgr_1.png)
![图片2](/assets/image/dl_lgr_2.png)
![图片3](/assets/image/dl_lgr_3.png)
### 尾声
解压你所下载的zip,打开到有Lagrange.OneBot.exe的目录,在此目录下打开cmd命令提示符,输入
```bash
.\Lagrange.OneBot
```
运行一次,如果输出了一个二维码,即可直接用机器人号扫码登录(若二维码显示不清楚,可以到lagrange的data目录下寻找图片文件)。
若无法登录,请检查是否正常填写了lagrange配置文件appsettings.json中的签名地址 SignServerUrl ,签名地址请到lagrange文档中寻找。
## 修改配置
需要配置 Lagrange 以让其连接上 QChatGPT,请编辑 Lagrange 的配置文件 appsettings.json,确保 Implementations 中的连接配置符合下图内容:
![配置连接](/assets/image/config_lgr.png)
其中 Type 必须为 `ReverseWebSocket`;
Host 为 QChatGPT 运行的主机 IP,若在同一主机上,可以写 `127.0.0.1`;
Suffix 必须为 `/ws`
@@ -0,0 +1,9 @@
# 部署消息平台LiteLoaderQQNT的教程
# LiteLoaderQQNT
- [LiteLoaderQQNT 的 OneBot API 插件](https://github.com/LLOneBot/LLOneBot) 注入 QQ 客户端并将其转换为 OneBot 11 协议
安装LiteLoaderQQNT的教程:https://llonebot.github.io/zh-CN/guide/getting-started
![image-20240515185909108](/assets/image/llob_cfg.png)
+35
View File
@@ -0,0 +1,35 @@
# 部署消息平台NapCat的教程
::: tip
复活赛已打赢,继续使用
:::
## NapCat介绍
NapCat 是一个 QQNT 协议逆向工程框架。
可选平台:
- Windows
- Linux Docker
- Linux 非 Docker
## NapCat安装教程
按照 [NapCat 官方文档安装](https://napneko.github.io/zh-CN/guide/getting-started)
运行后扫码登录
## NapCat配置教程
登录后,可以在config文件夹中,找到并修改文件(数字对应机器人QQ号):![image-20240514231529613](/assets/image/napcat_cfg_1.png)
参考下图红框修改内容,确保地址中 IP地址 是 QChatGPT 运行的主机的地址(若在同一网络内运行则为 127.0.0.1),后缀须为`/ws`:
![image-20240514231932514](/assets/image/napcat_cfg_2.png)
然后重新运行登录即可,看到提示:
![image-20240514232647329](/assets/image/napcat_cfg_3.png)
@@ -0,0 +1,74 @@
# 部署消息平台shamrock的教程
> 本文档仅为基本步骤,详细操作、答疑解惑及最新信息请前往[OpenShamrock官方文档](https://whitechi73.github.io/OpenShamrock/)。
::: tip
项目归档,不建议继续使用
:::
## OpenShamrock简介
Mirai、go-cqhttp 之类的是模拟 QQ 的协议进行通信,而 Shamrock 使用的是 安卓的 Hook 来操作 QQ 模拟点击,稳定性较高。
可选平台(or设备):
- 模拟器
- Linux服务器
- PVE
- 云手机
- 实体手机
## 步骤(模拟器)
### 环境配置
**注:建议使用[mumu模拟器](https://mumu.163.com/)**
参考[此文档](https://forum.libfekit.so/d/60-mumu12mo-ni-qi-an-zhuang-magiskhe-lsposed)安装Magisk和LSPosed
记得打开mumu模拟器的可写系统盘和root权限
![](/assets/image/sham_env_1.png)
![image-20240119154032682](/assets/image/sham_env_2.png)
### 安装OpenShamrock
从[OpenShamrock的Actions](https://github.com/whitechi73/OpenShamrock/actions)下载最新的OpenShamrock安装包,注意下载带有`all`字样的版本,如`Shamrock-v1.0.7.r253.81be383-all.zip`,解压,在mumu模拟器安装
#### 配置Shamrock
1. 在 Shamrock 的设置页面修改设置如图:
启用被动 Websocket,并填写 QChatGPT 的 aiocqhttp 适配器监听的地址和端口(详见填写配置信息页)。
![img](/assets/image/sham_cfg_1.png)
![img](/assets/image/sham_cfg_2.png)
填写的被动 Websocket 地址为 QChatGPT 的 aiocqhttp 适配器监听的地址和端口,且路径必须为 `/ws`,例如 `ws://127.0.0.1:8080/ws`,详见填写配置信息页。
2. 并前往 LSPosed 的模块管理页面 启用模块 Shamrock
![image-20240119154110877](/assets/image/sham_cfg_3.png)
### 安装QQ
参考[此页面](https://whitechi73.github.io/OpenShamrock/guide/faq.html#%E6%94%AF%E6%8C%81%E7%9A%84qq%E7%89%88%E6%9C%AC)给出的支持的QQ版本,选择最新即可
在[这里](https://qq.cn.uptodown.com/android/versions)选择对应的版本下载,在mumu模拟器安装即可
### 登录机器人QQ
1. 打开QQ,登录机器人QQ,关闭QQ,重启模拟器。
2. 启动 LSPosed,Shamrock 将会自动运行,启动 QQ。
3. 打开 Shamrock 页面,此时应显示 `已激活` 并可以查看到账号信息和相关消息日志。
### 后续步骤
查看填写配置信息页,通过 aiocqhttp 适配器接入。
![img](https://cos.thelazy.cn/pictures/202405292250017.jpeg)
+151
View File
@@ -0,0 +1,151 @@
# 部署消息平台go-cqhttp的教程
> 本文档仅为基本步骤,详细操作、答疑解惑及最新信息请前往[go-cqhttp官方文档](https://docs.go-cqhttp.org/)。
::: warning
gocq未归档,但原开发者表示:[https://github.com/Mrs4s/go-cqhttp/issues/2471](https://github.com/Mrs4s/go-cqhttp/issues/2471)
:::
## 下载go-cqhttp
从[go-cqhttp的Release](https://github.com/Mrs4s/go-cqhttp/releases/latest)下载最新的go-cqhttp可执行文件(建议直接下载可执行文件压缩包,而不是安装器)
![下载gocq](/assets/image/dl_gocq.png)
## 运行并配置go-cqhttp
解压并运行,首次运行会询问需要开放的网络协议,**请填入`02`并回车,必须输入`02`❗❗❗❗❗❗❗**
```
C:\Softwares\go-cqhttp.old> .\go-cqhttp.exe
未找到配置文件,正在为您生成配置文件中!
请选择你需要的通信方式:
> 0: HTTP通信
> 1: 云函数服务
> 2: 正向 Websocket 通信
> 3: 反向 Websocket 通信
请输入你需要的编号(0-9),可输入多个,同一编号也可输入多个(如: 233)
您的选择是:02
```
提示已生成`config.yml`文件,关闭go-cqhttp。
打开go-cqhttp同目录的`config.yml`
1. 编辑账号登录信息
只需要修改下方`uin`和`password`为你要登录的机器人账号的QQ号和密码即可。
```yaml
account: # 账号相关
uin: 1233456 # QQ账号
password: '' # 密码为空时使用扫码登录
encrypt: false # 是否开启密码加密
status: 0 # 在线状态 请参考 https://docs.go-cqhttp.org/guide/config.html#在线状态
relogin: # 重连设置
delay: 3 # 首次重连延迟, 单位秒
interval: 3 # 重连间隔
max-times: 0 # 最大重连次数, 0为无限制
```
2. 修改websocket端口
在`config.yml`下方找到以下内容
```yaml
- ws:
# 正向WS服务器监听地址
address: 0.0.0.0:8080
middlewares:
<<: *default # 引用默认中间件
```
**将`0.0.0.0:8080`改为`0.0.0.0:6700`**,保存并关闭`config.yml`。
3. 配置签名服务器
按照如下填写,
```yam
sign-servers:
- url: 'https://qsign.trpgbot.com/' # 主签名服务器地址, 必填
key: 'selfshare'
authorization: '-'
- url: 'https://qsign-v3.trpgbot.com/' # 次要服务器地址,选填
key: 'selfshare'
authorization: '-'
auto-register: true
```
写入文件/data/versions/6.json,
```json
{
"apk_id": "com.tencent.mobileqq",
"app_id": 537220362,
"sub_app_id": 537220362,
"app_key": "0S200MNJT807V3GE",
"sort_version_name": "9.0.56.16830",
"build_time": 1713424357,
"apk_sign": "a6b745bf24a2c277527716f6f36eb68d",
"sdk_version": "6.0.0.2560",
"sso_version": 21,
"misc_bitmap": 150470524,
"main_sig_map": 34869472,
"sub_sig_map": 66560,
"dump_time": 1713424357,
"qua": "V1_AND_SQ_9.0.56_6372_YYB_D",
"protocol_type": 6
}
```
感谢zhaodice大佬带来的QQ 9.0.56签名服务器
4. 若您的服务器位于公网,强烈建议您填写`access-token` (可选)
```yaml
# 默认中间件锚点
default-middlewares: &default
# 访问密钥, 强烈推荐在公网的服务器设置
access-token: ''
```
5. 配置完成,重新启动go-cqhttp
## 登录
双击登录脚本,一段时间后,可以看到提示
![登录gocq](/assets/image/first_launch.png)
把`Captcha link: `后边的链接复制下来,用Chrome或者Edge浏览器打开,按F12打开开发者工具
点开 `Network`
![过验证码](/assets/image/get_captcha.png)
在浏览器中完成验证, 在 `Network` 中找到名为 `cap_union_new_verify` 的请求, 在最下面
![获取token](/assets/image/get_gocq_login_token.png)
ticket 后那一坨就是要输入回 mirai 的内容,但不包括首尾的双引号
**注意**
- 复制的时候记得删掉引号(`"`, 前后都有一个), 那个不是ticket内容
- 速度要快
- 注意不要漏字符(没复制完, 后面还有很长)
把复制下来的东西,粘贴到运行go-cq的终端中
![粘贴token](/assets/image/paste_token.png)
> 若启动后登录不成功,请尝试根据[此文档](https://docs.go-cqhttp.org/guide/config.html#%E8%AE%BE%E5%A4%87%E4%BF%A1%E6%81%AF)修改`device.json`的协议编号。
## 后续步骤
查看填写配置信息页,通过 Nakuru 适配器接入。
+22
View File
@@ -0,0 +1,22 @@
# 消息平台部署教程
:::info 目录
[[toc]]
:::
## 可选的平台适配器
QChatGPT 需要一个中间程序,处理 QQ 等 IM 的协议(大部分是逆向工程)。
以下平台任选,也可以配置多个,QChatGPT支持同时接入一个或多个平台:
### 推荐
- aiocqhttp(QQ):[aiocqhttp适配器教程](aiocqhttp/)
- QQ官方API(QQ群、QQ频道):[QQ 官方 API 部署教程](official.md)
### 不推荐
以前流行的框架,现在长期不再维护或被腾讯严重围追堵截,不推荐使用:
- Mirai(QQ):[Mirai部署教程](mirai.md) (使用旧版协议,风控严重)
- go-cqhttp(QQ):[go-cqhttp部署教程(For nakuru)](nakuru.md)(使用旧版协议,[原开发者停止维护](https://github.com/Mrs4s/go-cqhttp?tab=readme-ov-file#%E9%87%8D%E8%A6%81%E4%BF%A1%E6%81%AF))
+152
View File
@@ -0,0 +1,152 @@
# 部署消息平台mirai的教程
> 本文档仅为基本步骤,详细操作、答疑解惑及最新信息请前往[Mirai官方代码库](https://github.com/mamoe/mirai)、[Mirai官方论坛](https://mirai.mamoe.net/)
::: warning
此消息平台不稳定,不要使用
:::
## 准备工作
> 注意:由于网络环境多样复杂,很多步骤中,有可能需要使用网络魔法,懂的都懂
1. 创建文件夹
在你的任意盘(D,E,F什么都都可以)里面新建一个文件夹(例如命名qqbot)
2. 创建子文件夹
双击进入刚刚创建的文件夹,分别新建两个文件夹(建议命名保持一致):mirai、QChatGPT
## 安装 mirai-console
在 [mcl-installer 的 releases 页面](https://github.com/iTXTech/mcl-installer/releases)下载对应版本的安装包,找到最新的安装包,即有“Latest”标志的安装包,点击`show all 14 assets`,下载 mcl-installer-X.X.X-windows-amd64.exe,如图,则下载`mcl-installer-1.0.7-windows-amd64.exe`,保存在刚才创建的`mirai文件夹`中
![屏幕截图 2023-11-23 223909.png](/assets/image/mirai_dl_1.png)
![image-20231218170548696](/assets/image/mirai_dl_2.png)
双击打开,一路回车。然后,你可以看到多出来一些文件。
![image-20231218170726759](/assets/image/mirai_dl_3.png)
继续点击`mcl.cmd`,看不到文件后缀的,参考这个文章来显示文件后缀名:[如何查看文件后缀](https://jingyan.baidu.com/article/9158e0004c6cbea2541228da.html)
双击后会显示如下图所示的类似界面,当出现`Enter to continue`时,表明你需要按回车健
![屏幕截图 2023-11-24 174015.png](/assets/image/mirai_dl_4.png)
![屏幕截图 2023-11-24 174650.png](/assets/image/mirai_dl_5.png)
当出现上面的一行绿字时,说明安装完成,到这里输入 exit,回车退出
## 安装 mirai-api-http
打开 `mcl.cmd`,输入`mcl --update-package net.mamoe:mirai-api-http --channel stable-v2 --type plugin` ,回车
![image-20231218172022449](/assets/image/mah_dl_1.png)
再次打开`mcl.cmd`,一路回车,直至退出。
再打开 mcl.cmd,看到如以下界面,说明成功
![屏幕截图 2023-11-24 184618.png](/assets/image/mah_dl_2.png)
键盘按下`Ctrl+C`,退出。
找到mira/config/net.mamoe.mirai-api-http/setting.yml文件,右键用记事本打开
![image-20231218172354159](/assets/image/mah_dl_3.png)
把内容全部删掉,换成
```yml
adapters:
- ws
debug: true
enableVerify: true
verifyKey: yirimirai
singleMode: false
cacheSize: 4096
adapterSettings:
ws:
host: localhost
port: 8080
reservedSyncId: -1
```
再打开 `mcl.cmd`,可以看到输出
![image-20231218174112536](/assets/image/mah_dl_4.png)
则 mirai-api-http 安装成功。
## 配置签名服务
在这个链接下载qsign一键签名包,点击下载最新的那个zip压缩包,如下图的`qsign-1.2.1-beta-dev-d62ddce-all.zip`【写于2023年12月19日】,[点我跳转下载页面](https://github.com/MrXiaoM/qsign/releases)
![image-20231219211250617](/assets/image/mirai_sign_1.png)
下载完成后,解压得到如图文件
![image-20231219211634274](/assets/image/mirai_sign_2.png)
将两个文件复制到mirai文件夹中
![image-20231219211904375](/assets/image/mirai_sign_3.png)
打开`txlib`文件夹,发现有若干数字命名的文件夹,记录下最大的那个
![image-20231219212926059](/assets/image/mirai_sign_4.png)
然后,双击运行`mcl.cmd`,稍等一会儿后,当提示`mirai-console started successfully`时,qsign就安装上了
之后,打开`mirai/config/top.mrxiaom.qsign`下的`config.yml`文件,用记事本打开
![image-20231219213026138](/assets/image/mirai_sign_5.png)
![image-20231219213255993](/assets/image/mirai_sign_6.png)
然后,按下`Ctrl+S`保存
然后,再次双击运行`mcl.cmd`,可以看到类似提示,如图
![image-20231219214603122](/assets/image/mirai_sign_7.png)
## 运行mirai
到这里,你已经安装并配置成功了,接下来,你就可以登录机器人QQ了
输入,其中 123456 是替换为你机器人的 QQ 号,67890 替换为你机器人 QQ 的密码
```bash
login 12345 67890
```
然后,可以看到提示
![image-20231219215234389](/assets/image/run_mirai_1.png)
把`Captcha link: `后边的链接复制下来,用Chrome或者Edge浏览器打开,按F12打开开发者工具
点开 `Network`
![img5](/assets/image/get_captcha.png)
在浏览器中完成验证, 在 `Network` 中找到名为 `cap_union_new_verify` 的请求, 在最下面
![img6](/assets/image/get_gocq_login_token.png)
ticket 后那一坨就是要输入回 mirai 的内容,但不包括首尾的双引号
**注意**
- 复制的时候记得删掉引号(`"`, 前后都有一个), 那个不是ticket内容
- 速度要快
- 注意不要漏字符(没复制完, 后面还有很长)
把复制下来的东西,粘贴到运行mirai的终端中
![image-20231219220645708](/assets/image/paste_token.png)
然后回车,如果运气好的话,会提示你要收验证码,输入yes并回车,之后把验证码输入上去,然后回车即可成功登录了
如果运气不好,报错code=237了,建议换号
## 后续步骤
查看填写配置信息页,通过 YiriMirai 适配器接入。
+14
View File
@@ -0,0 +1,14 @@
# 使用 QQ 官方机器人 API 的教程
QQ 官方 API 可以将机器人接入 QQ 频道 和 QQ 群。
QQ官方机器人所有人均可申请,可以在频道和群聊中使用,私聊也可。
(之前个人创建的机器人是没有此群聊权限的,只要重新申请创建一个即可)
## 注册 QQ 机器人
前往[QQ开放平台](https://q.qq.com/#/),找到下方的 QQ 机器人文档,按照指引注册 QQ 频道机器人。
## 获取凭证
注册完成后,前往机器人控制台,找到 开发设置,获取 `AppId(机器人ID)` 和 `AppSecret(机器人密钥)`,接下来进入填写配置信息步骤。