mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-10-30 04:15:45 +08:00
doc: 更换VitePress后的初步内容
This commit is contained in:
lazy
@@ -0,0 +1,38 @@
|
||||
# 部署教程
|
||||
|
||||
## 部署教程
|
||||
|
||||
请按照以下步骤部署 QChatGPT 项目：
|
||||
|
||||
- 第一步: [部署QChatGPT](qchatgpt/)
|
||||
- 第二步: [部署消息平台](platforms/)
|
||||
- 第三步: [填写配置信息](config.md)
|
||||
|
||||
完成以上三个步骤后，你接下来应该仔细阅读左栏中的[配置详解](../config/README.md)和[元数据配置](../metadata/README.md)，实现更多样化的配置需求
|
||||
|
||||
## 社区资源
|
||||
|
||||
### 视频教程
|
||||
|
||||
[【8月最新】5min部署 最强AI语音聊天+酒馆角色扮演+QQ机器人，全新角色扮演语音聊天QQ机器人](https://www.bilibili.com/video/BV1vypZeBEW1/?share_source=copy_web&vd_source=1335a044d4fd926920999a0e3ba0a731)
|
||||
|
||||
|
||||
## 本项目交流 QQ 群
|
||||
|
||||
### 社区群
|
||||
|
||||
> 遇到问题请先认真阅读文档，如无法解决再加群提问
|
||||
|
||||
Lazy的交流群一：891448839（已满）
|
||||
|
||||
Lazy的交流群二：738382634（已满）
|
||||
|
||||
Lazy的交流群三：248432104（已满）
|
||||
|
||||
Lazy的交流群四：619154800 ([链接](https://qm.qq.com/q/1K9GjQuza))
|
||||
|
||||
### 官方群
|
||||
|
||||
> 官方群不解答部署问题
|
||||
|
||||
四群：195992197 [链接](https://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=cSekvWmyezfCE4O8gXS7lSjkmPinjzpP&authKey=G4jHfz2%2BtQawxCRhn1ZRrQiI8bTvlepQubZL6F9fymFuz8jqZZ4FkYh6lhKLMCd9&noverify=0&group_code=195992197)
|
||||
@@ -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": ""
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
当前可用的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)
|
||||
|
||||
看图进行下载:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 尾声
|
||||
|
||||
解压你所下载的zip，打开到有Lagrange.OneBot.exe的目录，在此目录下打开cmd命令提示符，输入
|
||||
|
||||
```bash
|
||||
.\Lagrange.OneBot
|
||||
```
|
||||
|
||||
运行一次，如果输出了一个二维码，即可直接用机器人号扫码登录（若二维码显示不清楚，可以到lagrange的data目录下寻找图片文件）。
|
||||
|
||||
若无法登录，请检查是否正常填写了lagrange配置文件appsettings.json中的签名地址 SignServerUrl ，签名地址请到lagrange文档中寻找。
|
||||
|
||||
## 修改配置
|
||||
|
||||
需要配置 Lagrange 以让其连接上 QChatGPT，请编辑 Lagrange 的配置文件 appsettings.json，确保 Implementations 中的连接配置符合下图内容：
|
||||
|
||||
|
||||
|
||||
其中 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
|
||||
|
||||
|
||||
@@ -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号）：
|
||||
|
||||
参考下图红框修改内容，确保地址中 IP地址 是 QChatGPT 运行的主机的地址（若在同一网络内运行则为 127.0.0.1），后缀须为`/ws`：
|
||||
|
||||
|
||||
|
||||
然后重新运行登录即可，看到提示：
|
||||
|
||||
|
||||
@@ -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权限
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 安装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 适配器监听的地址和端口（详见填写配置信息页）。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
填写的被动 Websocket 地址为 QChatGPT 的 aiocqhttp 适配器监听的地址和端口，且路径必须为 `/ws`，例如 `ws://127.0.0.1:8080/ws`，详见填写配置信息页。
|
||||
|
||||
2. 并前往 LSPosed 的模块管理页面 启用模块 Shamrock
|
||||
|
||||
|
||||
|
||||
### 安装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 适配器接入。
|
||||
|
||||
|
||||
@@ -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可执行文件（建议直接下载可执行文件压缩包，而不是安装器）
|
||||
|
||||
|
||||
|
||||
## 运行并配置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
|
||||
|
||||
## 登录
|
||||
|
||||
双击登录脚本，一段时间后，可以看到提示
|
||||
|
||||
|
||||
|
||||
把`Captcha link: `后边的链接复制下来，用Chrome或者Edge浏览器打开，按F12打开开发者工具
|
||||
|
||||
点开 `Network`
|
||||
|
||||
|
||||
|
||||
在浏览器中完成验证, 在 `Network` 中找到名为 `cap_union_new_verify` 的请求, 在最下面
|
||||
|
||||
|
||||
|
||||
ticket 后那一坨就是要输入回 mirai 的内容，但不包括首尾的双引号
|
||||
|
||||
**注意**
|
||||
|
||||
- 复制的时候记得删掉引号(`"`, 前后都有一个), 那个不是ticket内容
|
||||
- 速度要快
|
||||
- 注意不要漏字符(没复制完, 后面还有很长)
|
||||
|
||||
把复制下来的东西，粘贴到运行go-cq的终端中
|
||||
|
||||
|
||||
|
||||
> 若启动后登录不成功，请尝试根据[此文档](https://docs.go-cqhttp.org/guide/config.html#%E8%AE%BE%E5%A4%87%E4%BF%A1%E6%81%AF)修改`device.json`的协议编号。
|
||||
|
||||
|
||||
## 后续步骤
|
||||
|
||||
查看填写配置信息页，通过 Nakuru 适配器接入。
|
||||
@@ -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)）
|
||||
@@ -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文件夹`中
|
||||
|
||||
|
||||
|
||||
|
||||
双击打开，一路回车。然后，你可以看到多出来一些文件。
|
||||
|
||||
|
||||
|
||||
继续点击`mcl.cmd`，看不到文件后缀的，参考这个文章来显示文件后缀名：[如何查看文件后缀](https://jingyan.baidu.com/article/9158e0004c6cbea2541228da.html)
|
||||
|
||||
双击后会显示如下图所示的类似界面，当出现`Enter to continue`时，表明你需要按回车健
|
||||
|
||||
|
||||
|
||||
当出现上面的一行绿字时，说明安装完成，到这里输入 exit，回车退出
|
||||
|
||||
## 安装 mirai-api-http
|
||||
|
||||
打开 `mcl.cmd`，输入`mcl --update-package net.mamoe:mirai-api-http --channel stable-v2 --type plugin` ，回车
|
||||
|
||||
|
||||
|
||||
再次打开`mcl.cmd`，一路回车，直至退出。
|
||||
|
||||
再打开 mcl.cmd，看到如以下界面，说明成功
|
||||
|
||||
键盘按下`Ctrl+C`，退出。
|
||||
找到mira/config/net.mamoe.mirai-api-http/setting.yml文件，右键用记事本打开
|
||||
|
||||
|
||||
|
||||
把内容全部删掉，换成
|
||||
|
||||
```yml
|
||||
adapters:
|
||||
- ws
|
||||
debug: true
|
||||
enableVerify: true
|
||||
verifyKey: yirimirai
|
||||
singleMode: false
|
||||
cacheSize: 4096
|
||||
adapterSettings:
|
||||
ws:
|
||||
host: localhost
|
||||
port: 8080
|
||||
reservedSyncId: -1
|
||||
```
|
||||
|
||||
再打开 `mcl.cmd`，可以看到输出
|
||||
|
||||
则 mirai-api-http 安装成功。
|
||||
|
||||
## 配置签名服务
|
||||
|
||||
在这个链接下载qsign一键签名包，点击下载最新的那个zip压缩包，如下图的`qsign-1.2.1-beta-dev-d62ddce-all.zip`【写于2023年12月19日】，[点我跳转下载页面](https://github.com/MrXiaoM/qsign/releases)
|
||||
|
||||
|
||||
|
||||
下载完成后，解压得到如图文件
|
||||
|
||||
|
||||
|
||||
将两个文件复制到mirai文件夹中
|
||||
|
||||
|
||||
|
||||
打开`txlib`文件夹，发现有若干数字命名的文件夹，记录下最大的那个
|
||||
|
||||
|
||||
|
||||
然后，双击运行`mcl.cmd`，稍等一会儿后，当提示`mirai-console started successfully`时，qsign就安装上了
|
||||
|
||||
之后，打开`mirai/config/top.mrxiaom.qsign`下的`config.yml`文件，用记事本打开
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
然后，按下`Ctrl+S`保存
|
||||
|
||||
然后，再次双击运行`mcl.cmd`，可以看到类似提示，如图
|
||||
|
||||
|
||||
|
||||
## 运行mirai
|
||||
|
||||
到这里，你已经安装并配置成功了，接下来，你就可以登录机器人QQ了
|
||||
|
||||
输入，其中 123456 是替换为你机器人的 QQ 号，67890 替换为你机器人 QQ 的密码
|
||||
|
||||
```bash
|
||||
login 12345 67890
|
||||
```
|
||||
|
||||
然后，可以看到提示
|
||||
|
||||
|
||||
|
||||
把`Captcha link: `后边的链接复制下来，用Chrome或者Edge浏览器打开，按F12打开开发者工具
|
||||
|
||||
点开 `Network`
|
||||
|
||||
|
||||
|
||||
在浏览器中完成验证, 在 `Network` 中找到名为 `cap_union_new_verify` 的请求, 在最下面
|
||||
|
||||
|
||||
|
||||
ticket 后那一坨就是要输入回 mirai 的内容，但不包括首尾的双引号
|
||||
|
||||
**注意**
|
||||
|
||||
- 复制的时候记得删掉引号(`"`, 前后都有一个), 那个不是ticket内容
|
||||
- 速度要快
|
||||
- 注意不要漏字符(没复制完, 后面还有很长)
|
||||
|
||||
把复制下来的东西，粘贴到运行mirai的终端中
|
||||
|
||||
|
||||
|
||||
然后回车，如果运气好的话，会提示你要收验证码，输入yes并回车，之后把验证码输入上去，然后回车即可成功登录了
|
||||
|
||||
如果运气不好，报错code=237了，建议换号
|
||||
|
||||
## 后续步骤
|
||||
|
||||
查看填写配置信息页，通过 YiriMirai 适配器接入。
|
||||
@@ -0,0 +1,14 @@
|
||||
# 使用 QQ 官方机器人 API 的教程
|
||||
|
||||
QQ 官方 API 可以将机器人接入 QQ 频道 和 QQ 群。
|
||||
QQ官方机器人所有人均可申请，可以在频道和群聊中使用，私聊也可。
|
||||
|
||||
（之前个人创建的机器人是没有此群聊权限的，只要重新申请创建一个即可）
|
||||
|
||||
## 注册 QQ 机器人
|
||||
|
||||
前往[QQ开放平台](https://q.qq.com/#/)，找到下方的 QQ 机器人文档，按照指引注册 QQ 频道机器人。
|
||||
|
||||
## 获取凭证
|
||||
|
||||
注册完成后，前往机器人控制台，找到 开发设置，获取 `AppId(机器人ID)` 和 `AppSecret(机器人密钥)`，接下来进入填写配置信息步骤。
|
||||
@@ -0,0 +1,48 @@
|
||||
# Docker部署(仅推荐在Linux上使用)
|
||||
|
||||
:::info 目录
|
||||
[[toc]]
|
||||
:::
|
||||
|
||||
:::warning
|
||||
请您确保您**确实**需要 Docker 部署，您**必须**具有以下能力：
|
||||
- 了解 `Docker` 和 `Docker Compose` 的使用
|
||||
- 了解容器间网络通信配置方式
|
||||
- 了解容器文件挂载机制
|
||||
- 了解容器调试操作
|
||||
- 动手能力强、资料查找能力强
|
||||
|
||||
若您不完全具有以上能力，请勿使用 Docker 部署，由于误操作导致的配置不正确，我们将不会解答您的问题并不负任何责任。
|
||||
**不建议**您在除 Linux 之外的系统上使用 Docker 进行部署。
|
||||
:::
|
||||
|
||||
:::note
|
||||
请先确保 Docker 和 Docker Compose 已安装
|
||||
:::
|
||||
|
||||
以下是推荐的`docker-compose.yaml`模板，您可以根据自己的需求进行修改。
|
||||
|
||||
```yaml
|
||||
version: "3"
|
||||
|
||||
services:
|
||||
qchatgpt:
|
||||
image: rockchin/qchatgpt:latest
|
||||
volumes:
|
||||
- ./data:/app/data
|
||||
- ./plugins:/app/plugins
|
||||
restart: on-failure
|
||||
# 根据具体环境配置网络
|
||||
```
|
||||
|
||||
保存到一个目录的`docker-compose.yaml`，运行命令:
|
||||
|
||||
```bash
|
||||
docker compose up
|
||||
```
|
||||
|
||||
无报错即为启动成功，请查看`部署消息平台`部分以配置消息平台框架。
|
||||
|
||||
## 注意
|
||||
|
||||
- 安装的插件都会保存在`plugins`(映射到本目录`plugins`)，安装插件时可能会自动安装相应的依赖，此时若`重新创建`容器，已安装的插件将被加载，但所需的增量依赖并未安装，会导致引入问题。您可以删除插件目录后重启，再次安装插件，以便程序可以自动安装插件所需依赖。
|
||||
@@ -0,0 +1,15 @@
|
||||
# QChatGPT部署教程
|
||||
|
||||
:::info 目录
|
||||
[[toc]]
|
||||
:::
|
||||
|
||||
选择一种部署 QChatGPT 的方式。
|
||||
|
||||
## 手动部署
|
||||
|
||||
- [<HopeIcon icon="support" size="1.2em"/> 点击查看手动部署的具体操作](manual.md)
|
||||
|
||||
## Docker部署
|
||||
|
||||
- [<HopeIcon icon="support" size="1.2em"/> 点击查看Docker部署的具体操作](docker.md)
|
||||
@@ -0,0 +1,71 @@
|
||||
# 手动部署(推荐，可以在所有平台上使用)
|
||||
|
||||
:::warning
|
||||
请使用Python 3.10.1（不包含3.10.0）及以上版本，推荐3.10.9版本，没有Python的需自行安装，参考[此教程](./more-details/python.md)
|
||||
:::
|
||||
|
||||
:::info 目录
|
||||
[[toc]]
|
||||
:::
|
||||
|
||||
|
||||
|
||||
## 安装主程序
|
||||
|
||||
1. 克隆此项目（按照下方命令，需要安装 Git） 或 前往[Release](https://github.com/RockChinQ/QChatGPT/releases)页面下载最新版本的压缩包（推荐）并解压
|
||||
|
||||
```bash
|
||||
git clone https://github.com/RockChinQ/QChatGPT
|
||||
cd QChatGPT
|
||||
```
|
||||
|
||||
2. 安装依赖
|
||||
|
||||
```bash
|
||||
pip3 install -r requirements.txt
|
||||
```
|
||||
|
||||
或者使用清华源
|
||||
|
||||
```bash
|
||||
pip3 install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple some-package
|
||||
```
|
||||
|
||||
3. 运行一次主程序，生成配置文件
|
||||
|
||||
```bash
|
||||
python3 main.py
|
||||
```
|
||||
|
||||
> 如果输入上面的指令无反应，并且你确认你已经装了python，则可以尝试使用`python main.py`，总之`python`是你启动的python的命令，可以使用 `python --version` 查看你的python版本。下同。
|
||||
|
||||
提示如下信息
|
||||
|
||||
```
|
||||
|
||||
___ ___ _ _ ___ ___ _____
|
||||
/ _ \ / __| |_ __ _| |_ / __| _ \_ _|
|
||||
| (_) | (__| ' \/ _` | _| (_ | _/ | |
|
||||
\__\_\\___|_||_\__,_|\__|\___|_| |_|
|
||||
|
||||
⭐️开源地址: https://github.com/RockChinQ/QChatGPT
|
||||
📖文档地址: https://q.rkcn.top
|
||||
|
||||
以下文件不存在，已自动生成，请按需修改配置文件后重启：
|
||||
- plugins/__init__.py
|
||||
- plugins/plugins.json
|
||||
- data/config/command.json
|
||||
- data/config/pipeline.json
|
||||
- data/config/platform.json
|
||||
- data/config/provider.json
|
||||
- data/config/system.json
|
||||
- data/config/sensitive-words.json
|
||||
- data/scenario/default.json
|
||||
```
|
||||
|
||||
接下来请查看[部署消息平台](../platforms/)页。
|
||||
|
||||
当你部署消息平台和填写配置文件后，再次运行
|
||||
```bash
|
||||
python3 main.py
|
||||
```
|
||||
@@ -0,0 +1,23 @@
|
||||
# Python的安装教程（QChatGPT）
|
||||
|
||||
## 第一步：安装Python
|
||||
|
||||
打开这个网址，[点我跳转](https://www.python.org/downloads/release/python-3109/)
|
||||
|
||||
翻到最下边，点击这个下载python安装器
|
||||
|
||||
|
||||
|
||||
然后，双击打开你刚才下载的，记得勾选下面的
|
||||
|
||||
|
||||
|
||||
然后，所有项保持默认即可
|
||||
|
||||
## 第二步：检测Python是否安装成功
|
||||
|
||||
按win+R键，输入cmd，回车，在输入python，回车
|
||||
|
||||
|
||||
|
||||
提示如图时，表明安装成功了
|
||||
@@ -0,0 +1,177 @@
|
||||
# 填写配置信息
|
||||
|
||||
修改以下配置文件即可启用 QChatGPT 的基本功能，当你阅读完此页面后，建议查看[配置详解](../config/)，以了解更多的配置项详解
|
||||
|
||||
- `data/config/platform.json`
|
||||
- `data/config/provider.json`
|
||||
- `data/config/system.json`
|
||||
|
||||
## platform.json
|
||||
|
||||
修改此配置文件以指定需要连接的消息平台，只需要关注`platform-adapters`字段。
|
||||
目前支持 `mirai`、`go-cqhttp`、`aiocqhttp`、`qq-botpy` 四种消息平台适配器，也可以同时启用多个同种类或不同种类的平台适配器
|
||||
|
||||
### aiocqhttp 适配器
|
||||
|
||||
如果你刚刚已经在 QChatGPT 的配置文件中启用了 aiocqhttp 适配器，那么你可以跳过这一步。
|
||||
用于接入 Lagrange 等兼容 OneBot 协议的机器人框架（仅支持反向ws）。
|
||||
|
||||
```json
|
||||
{
|
||||
"adapter": "aiocqhttp",
|
||||
"enable": false,
|
||||
"host": "127.0.0.1",
|
||||
"port": 8080,
|
||||
"access-token": ""
|
||||
},
|
||||
```
|
||||
|
||||
`"adapter": "aiocqhttp"`，无需改动。
|
||||
|
||||
`enable`：是否启用，配置完成后请将其设为`true`
|
||||
|
||||
`host`：监听的 IP 地址，使用 aiocqhttp 时，QChatGPT 作为服务端被动等待框架连接，请在 Shamrock 等框架中设置`被动 ws 地址`或者`反向 ws 地址`（具体视框架而定）为 QChatGPT 监听的地址，且路径为`/ws`，例如：`ws://127.0.0.1:8080/ws`。
|
||||
|
||||
`port`：设置监听的端口，默认8080，需在 Shamrock 等框架中设置为与此处一致的端口
|
||||
|
||||
`access-token`：设置访问密钥，与 Shamrock 等框架中设置的保持一致
|
||||
|
||||
### qq-botpy 适配器
|
||||
|
||||
用于接入 QQ 官方机器人 API。
|
||||
|
||||
```json
|
||||
{
|
||||
"adapter": "qq-botpy",
|
||||
"enable": false,
|
||||
"appid": "",
|
||||
"secret": "",
|
||||
"intents": [
|
||||
"public_guild_messages",
|
||||
"direct_message"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
`"adapter": "qq-botpy"`，无需动，表明是接入`QQ官方机器人`的配置
|
||||
|
||||
`enable`：是否启用，配置完成后请将其设为`true`
|
||||
|
||||
`appid`：申请到的QQ官方机器人的appid
|
||||
|
||||
`secret`：申请到的QQ官方机器人的secret
|
||||
|
||||
`intents`：控制监听的事件类型，需要填写才能接收到对应消息，目前支持的事件类型有：
|
||||
|
||||
- `public_guild_messages` QQ 频道消息
|
||||
- `direct_message` QQ 频道私聊消息
|
||||
- `public_messages` Q群消息（需要权限，具体请查看[QQ官方机器人API文档](https://q.qq.com/)）
|
||||
|
||||
### YiriMirai 适配器
|
||||
|
||||
用于接入 Mirai。
|
||||
|
||||
```json
|
||||
{
|
||||
"adapter": "yiri-mirai",
|
||||
"enable": false,
|
||||
"host": "127.0.0.1",
|
||||
"port": 8080,
|
||||
"verifyKey": "yirimirai",
|
||||
"qq": 123456789
|
||||
},
|
||||
```
|
||||
|
||||
`"adapter": "yiri-mirai"`，无需动，表明是接入`mirai`的配置
|
||||
|
||||
`enable`：是否启用，配置完成后请将其设为`true`
|
||||
|
||||
`host`：运行 mirai 的主机地址，一般不改动
|
||||
|
||||
`port`：设置端口，默认8080，与`mirai-api-http`里面设置的保持一致
|
||||
|
||||
`verifyKey`：密钥，默认yirimirai，与`mirai-api-http`里面设置的保持一致
|
||||
|
||||
`qq`：设置机器人QQ号，与当前mirai登录的机器人的QQ号保持一致
|
||||
|
||||
### Nakuru 适配器
|
||||
|
||||
用于接入 go-cqhttp。
|
||||
|
||||
```json
|
||||
{
|
||||
"adapter": "nakuru",
|
||||
"enable": false,
|
||||
"host": "127.0.0.1",
|
||||
"ws_port": 8080,
|
||||
"http_port": 5700,
|
||||
"token": ""
|
||||
},
|
||||
```
|
||||
|
||||
`"adapter": "nakuru"`，无需动，表明是接入`go-cqhttp`的配置
|
||||
|
||||
`enable`：是否启用，配置完成后请将其设为`true`
|
||||
|
||||
`host`：运行 go-cqhttp 的主机地址，一般不改动
|
||||
|
||||
`ws_port`：正向WS服务器监听地址，与`go-cqhttp`的`config.yml`里面的保持一致
|
||||
|
||||
`http_port`：http服务器监听地址，与`go-cqhttp`的`config.yml`里面的保持一致
|
||||
|
||||
`token`：验证密钥，，与`go-cqhttp`的`config.yml`里面的保持一致
|
||||
|
||||
## provider.json
|
||||
|
||||
修改此配置文件以设置所连接的 AI 提供商的相关信息，目前支持 `openai(GPT)`, `anthropic(claude)`, `moonshot(月之暗面)` 三种接口及对应模型。
|
||||
|
||||
> 如果你没有OpenAI API Key，你可以[在此获取](https://ai.lazyshare.top/)
|
||||
|
||||
以下仅讲解启用 OpenAI 接口的方式，具体设置方法请查看 [配置详解模块的`provider.json` 页](../config/provider.md)。
|
||||
|
||||
编辑 `data/provider.json`，在`keys`->`openai`中添加你的 OpenAI API Key，例如：
|
||||
|
||||
```json
|
||||
"keys": {
|
||||
"openai": [
|
||||
"sk-AAAAAAAAAAAABBBBBBBBBBBBCCCCCCCCCCCCCDDDDDDDDD"
|
||||
],
|
||||
"anthropic": [],
|
||||
"moonshot": [],
|
||||
"deepseek": []
|
||||
},
|
||||
```
|
||||
|
||||
如果你使用的是中转站，或者其他兼容 OpenAI 格式的平台，请将`requester`->`openai-chat-completions`->`base-url`设置为你的中转站地址。例如：
|
||||
|
||||
地址后记得加`/v1`。
|
||||
|
||||
```json
|
||||
"openai-chat-completions": {
|
||||
"base-url": "https://api.example.com/v1",
|
||||
"args": {},
|
||||
"timeout": 120
|
||||
},
|
||||
```
|
||||
|
||||
最后，将`model`改为你想要使用的模型，例如：
|
||||
|
||||
```json
|
||||
"model": "gpt-4o",
|
||||
```
|
||||
|
||||
## system.json
|
||||
|
||||
在 `data/system.json` 中修改 `admin-sessions`，添加 `person_你的QQ号` 把你设置为管理员，例如：
|
||||
|
||||
```json
|
||||
"admin-sessions": [
|
||||
"person_1010553892"
|
||||
],
|
||||
```
|
||||
|
||||
::: tip
|
||||
|
||||
阅读并完成以上教程后，你应该可以成功使用QChatGPT了，如果不能请再次阅读（你或许漏做或错做某些步骤），如果完全阅读并充分理解本文档后仍然确实无法使用，你可以在[这里](./README.md)找到交流群
|
||||
|
||||
:::
|
||||
Reference in New Issue
Block a user