部署

部署过程中遇到任何问题,请先在 QChatGPTqcg-installer 的 issue 里进行搜索

注册 OpenAI 账号

可以直接进群找群主购买 或参考以下文章自行注册:

注册成功后请前往个人中心查看 api_key 完成注册后,使用以下自动化或手动部署步骤。

自动化部署

展开查看,以下方式二选一,Linux 首选 Docker,Windows 首选安装器。

Docker 方式

请查看此仓库 mikumifa/QChatGPT-Docker-Installer

安装器方式

使用此安装器(若无法访问请到 Gitee)进行部署。

  • 安装器目前仅支持部分平台,请到仓库文档查看,其他平台请手动部署。

手动部署

手动部署适用于所有平台:

  • 请使用 Python 3.9.x 以上版本
  • 请注意 OpenAI 账号额度消耗
    • 每个账户仅有 18 美元免费额度,如未绑定银行卡,则会在超出时报错
    • OpenAI 收费标准:默认使用的 text-davinci-003 模型 0.02 美元/千字

配置 Mirai

按照此教程配置 Mirai 及 YiriMirai。启动 mirai-console 后,使用 login 命令登录 QQ 账号,保持 mirai-console 运行状态。

配置主程序

  1. 克隆此项目:
1
2
git clone https://github.com/RockChinQ/QChatGPT
cd QChatGPT
  1. 安装依赖:
1
2
pip3 install yiri-mirai openai colorlog func_timeout
pip3 install dulwich
  1. 运行一次主程序,生成配置文件:
1
python3 main.py
  1. 编辑配置文件 config.py

按照文件内注释填写配置信息。

  1. 运行主程序:
1
python3 main.py

无报错信息即为运行成功。

常见问题

  • mirai 登录提示 QQ 版本过低,见此 issue
  • 如提示安装 uvicornhypercorn不要安装,这两个不是必需的,目前存在未知原因 bug
  • 如报错 TypeError: As of 3.10, the *loop* parameter was removed from Lock(),请参考此处

使用

查看 Wiki 功能使用页

在 mirai 上登录 QQ

1
login <机器人QQ号> <机器人QQ密码>

具体见此教程

配置自动登录

当机器人账号登录成功以后,执行:

1
2
autologin add <机器人QQ号> <机器人密码>
autologin setConfig <机器人QQ号> protocol IPAD

出现 mirai 登录时提示版本过低 报错时候删除 mirai/bots 文件夹里面的数据,见此 issue

完成后,Ctrl + C 退出。

编写配置文件

  • bot 目录下创建 config.py,将 config-template.py 的内容复制进去,编辑 config.py 修改必需项

  • mirai/config/net.mamoe.mirai-api-http 文件夹中找到 setting.yml,这是 mirai-api-http 的配置文件。

  • 将这个文件的内容修改为:

1
2
3
4
5
6
7
8
9
10
11
12
adapters:
- ws
debug: true
enableVerify: true
verifyKey: yirimirai
singleMode: false
cacheSize: 4096
adapterSettings:
ws:
host: localhost
port: 8080
reservedSyncId: -1

verifyKey 要求与 botconfig.py 中的 verifyKey 相同。

插件生态

现已支持自行开发插件对功能进行扩展或自定义程序行为,详见 Wiki 插件使用页,开发教程见 Wiki 插件开发页

示例插件

tests/plugin_examples 目录下,将其整个目录复制到 plugins 目录下即可使用:

  • cmdcn - 主程序指令中文形式
  • hello_plugin - 在收到消息 hello 时回复相应消息
  • urlikethisijustsix - 收到冒犯性消息时回复相应消息

更多

欢迎提交新的插件:

About

在 QQ 上与 ChatGPT 等语言模型进行对话,OpenAI + Mirai 实现,支持插件、多 APIKEY 管理,多平台一键部署。


Installer for QChatGPT

QChatGPT 项目 使用 Go 语言编写的一键部署脚本,自动化部署所需依赖。

  • 注意:下载的 Python 和 mirai 均为免安装版,不影响系统其他环境。

使用方法

部署过程中遇到任何问题,请先在 QChatGPTqcg-installer 的 issue 里进行搜索,若找不到请前往:交流、答疑群: 204785790

1. 注册 OpenAI 账号

参考以下文章:

注册成功后请前往个人中心查看 api_key

2. 安装器

  • Release 页面下载可执行文件,若无法访问请到 Gitee
  • 保存到电脑上某个空目录,直接运行,等待配置环境
  • 完毕后根据提示输入 api-keyQQ号
  • 到此安装完成

常见问题

网络状况不好,下载失败?

解决方法:

  • 若您有网络代理可用于提速,可在启动安装器时提供参数 -p <代理地址>,如:
1
qcg-installer-0.1-windows-x64.exe -p http://localhost:7890

3. 运行程序

之后每次重启之后均需要按照以下步骤启动程序。

启动 mirai

  • 运行 run-mirai.bat (Windows) 或 ./run-mirai.sh (Linux) 启动 mirai
  • 并输入 login <QQ号> <QQ密码> 根据提示登录账号

运行主程序

  • 登录完成后运行 run-bot.bat (Windows) 或 ./run-bot.sh (Linux) 启动主程序。

常见问题

  • mirai 登录提示 QQ 版本过低,见此 issue
  • 运行 run-bot.bat 闪退请见此解决方案
  • 若启动后提示安装 uvicornhypercorn,请不要安装,会导致不明原因 bug

目前支持的平台和架构

  • Windows x64
  • CentOS x64(以及其他使用 yum 作为包管理器的操作系统)
  • Ubuntu x64(以及其他使用 apt 作为包管理器的操作系统)
  • Raspbian arm64