Awesome

ChatGPT Mirai QQ Bot

一款使用 OpenAI 的 ChatGPT 进行聊天的 QQ 机器人！

2023/2/10
本项目分为 ChatGPT(网页) 版和 API 版两种模式。
ChatGPT(网页) 版代表版本号为 v1.5.x 的版本； API 版代表版本号为 v1.6 的版本
具体区别见：https://github.com/lss233/chatgpt-mirai-qq-bot/issues/82
当前浏览的是网页版，点这里切换至 API 版。

基于：

支持：

文字转图片发送
群聊回复引用
关键词触发回复
正向代理
多种方式登录 OpenAI
多账号支持
支持 ChatGPT Plus
预设人格初始化
交流群会发布最新的项目动态。
加群之前先看这里的内容能不能解决你的问题。
如果不能解决，把遇到的问题、日志和配置文件准备好后再提问。
调试群这个群里有很多 ChatGPT QQ 机器人，不解答技术问题。

Preview

🔧 使用

如果你在使用的过程中遇到问题，可以看搭建常见问题解答 | FAQ。

对于 Windows 用户，此处有一个视频教程供你参考：https://www.bilibili.com/video/av991984534

<details> <summary>Linux: 通过快速部署脚本部署（新人推荐)</summary>

执行下面这行命令启动自动部署脚本。
它会为你安装 Docker、 Docker Compose 和编写配置文件。

bash -c "$(curl -fsSL https://gist.githubusercontent.com/lss233/6f1af9510f47409e0d05276a3af816df/raw/chatgpt-mirai-installer.sh)"

</details> <details> <summary>Linux: 通过 Docker Compose 部署（自带 Mirai)</summary>

我们使用 docker-compose.yaml 整合了 lss233/mirai-http 和本项目来实现快速部署。
但是在部署过程中仍然需要一些步骤来进行配置。

你可以在 Wiki 查看搭建教程。

</details> <details> <summary>Linux: 通过 Docker 部署（适合已经有 Mirai 的用户)</summary>

找个合适的位置，写你的 config.cfg。
执行以下命令，启动 bot：

# 修改 /path/to/config.cfg 为你 config.cfg 的位置
# XPRA_PASSWORD=123456 中的 123456 是你的 Xpra 密码，建议修改
docker run --name mirai-chatgpt-bot \
    -e XPRA_PASSWORD=123456 \ 
    -v /path/to/config.cfg:/app/config.cfg \
    --network host \
    lss233/chatgpt-mirai-qq-bot:latest

启动后，在浏览器访问 http://你的服务器IP:14500 可以访问到登录 ChatGPT 的浏览器页面

</details> <details> <summary>Windows: 快速部署包 (自带 Mirai，新人推荐）</summary>

我们为 Windows 用户制作了一个快速启动包，可以在 Release 中找到。

文件名为：quickstart-windows-amd64.zip 或者 Windows快速部署包.zip

</details> <details> <summary>Linux: 手动部署</summary>

提示：你需要 Python >= 3.9 才能运行本项目

部署 Mirai ，安装 mirai-http-api 插件。
下载本项目:

git clone https://github.com/lss233/chatgpt-mirai-qq-bot
cd chatgpt-mirai-qq-bot
pip3 install -r requirements.txt

参照下文调整配置文件。
启动 bot.

python3 bot.py

</details>

⚙ 配置文件

参考 config.example.cfg 调整配置文件。将其复制为 config.cfg，然后修改 config.cfg。

配置文件主要包含 mirai-http-api 的连接信息和 OpenAI 的登录信息。

OpenAI 注册教程： https://www.cnblogs.com/mrjade/p/16968591.html

OpenAI 配置的信息可参考这里。

[mirai]
# Mirai 相关设置

qq = 请填写机器人的 QQ 号

# 以下设置如果不懂 无需理会

api_key = "1234567890" # mirai-http-api 中的 verifyKey
http_url = "http://localhost:8080" # mirai-http-api 中的 http 回调地址
ws_url = "http://localhost:8080"# mirai-http-api 中的 ws 回调地址

[openai]
# OpenAI 相关设置

# 第 1 个 OpenAI 账号的登录信息
[[openai.accounts]]
# 模式选择，详情见下方 README
mode = "browser"

# 你的 OpenAI 邮箱
email = "xxxx" 
# 你的 OpenAI 密码
password = "xxx"

# 对于通过 Google 登录或者微软登录的同学，可以使用 session_token 登录
# 此时的 password 可以直接删除 (email 必填)
# session_token = "一串 ey 开头的东西"

# 你的 OpenAI access_token，登录后访问`https://chat.openai.com/api/auth/session`获取
# access_token = "一串 ey 开头的东西"

# 如果你在国内，需要配置代理
# proxy="http://127.0.0.1:1080"

# 使用 ChatGPT Plus（plus 用户此项设置为 true）
paid = false

# 以下是多账号的设置
# 如果你想同时使用多个账号进行负载均衡，就删掉前面的注释

# # 第 2 个 OpenAI 账号的登录信息
# [[openai.accounts]]
# 模式选择，详情见下方 README
# mode = "browser"

# # 你的 OpenAI 邮箱
# email = "xxxx" 
# # 你的 OpenAI 密码
# password = "xxx"

# # 对于通过 Google 登录或者微软登录的同学，可以使用 session_token 登录
# # 此时 email 和 password 可以直接删除
# # session_token = "一串 ey 开头的东西"

# # 如果你在国内，需要配置代理
# # proxy="http://127.0.0.1:1080"

# # 使用 ChatGPT Plus（plus 用户此项设置为 true）
# paid = false

# # 第 3 个 OpenAI 账号的登录信息
# [[openai.accounts]]
# 模式选择，详情见下方 README
# mode = "browser"

# # 你的 OpenAI 邮箱
# email = "xxxx" 
# # 你的 OpenAI 密码
# password = "xxx"

# # 对于通过 Google 登录或者微软登录的同学，可以使用 session_token 登录
# # 此时 email 和 password 可以直接删除
# # session_token = "一串 ey 开头的东西"

# # 如果你在国内，需要配置代理
# # proxy="http://127.0.0.1:1080"

# # 使用 ChatGPT Plus（plus 用户此项设置为 true）
# paid = false

[text_to_image]
# 文字转图片
font_size = 30 # 字体大小
width = 700  # 图片宽度
font_path = "fonts/sarasa-mono-sc-regular.ttf"  # 字体
offset_x = 50  # 起始点 X
offset_y = 50 # 起始点 Y

[trigger]
# 配置机器人要如何响应，下面所有项均可选 (也就是可以直接删掉那一行)

# 符合前缀才会响应，可以自己增减
prefix = [ "",]

# 配置群里如何让机器人响应，"at" 表示需要群里 @ 机器人，"mention" 表示 @ 或
require_mention = "at"

# 重置会话的命令
reset_command = [ "重置会话",]

# 回滚会话的命令
rollback_command = [ "回滚会话",]

[response]
# 匹配指令成功但没有对话内容时发送的消息
placeholder = "您好！我是 Assistant，一个由 OpenAI 训练的大型语言模型。我不是真正的人，而是一个计算机程序，可以通过文本聊天来帮助您解决问题。如果您有任何问题，请随时告诉我，我将尽力回答。\n如果您需要重置我们的会话，请回复`重置会话`。"

# 发生错误时要发送的消息
error_format = "出现故障！如果这个问题持续出现，请和我说“重置会话” 来开启一段新的会话，或者发送 “回滚对话” 来回溯到上一条对话，你上一条说的我就当作没看见。\n{exc}"

# 是否要回复触发指令的消息
quote = true

# 发送下面那个提醒之前的等待时间
timeout = 30.0

# 超过响应时间时要发送的提醒
timeout_format = "我还在思考中，请再等一下~"

# 重置会话时发送的消息
reset = "会话已重置。"

# 回滚成功时发送的消息
rollback_success = "已回滚至上一条对话，你刚刚发的我就忘记啦！"

# 回滚失败时发送的消息
rollback_fail = "回滚失败，没有更早的记录了！"

# 服务器提示 429 错误时的回复
request_too_fast = "当前正在处理的请求太多了，请稍等一会再发吧！"

# 等待处理的消息的最大数量，如果要关闭此功能，设置为 0
max_queue_size = 10

# 队列满时的提示
queue_full = "抱歉！我现在要回复的人有点多，暂时没有办法接收新的消息了，请过会儿再给我发吧！"

# 新消息加入队列会发送通知的长度最小值
queued_notice_size = 3

# 新消息进入队列时，发送的通知。 queue_size 是当前排队的消息数
queued_notice = "消息已收到！当前我还有{queue_size}条消息要回复，请您稍等。"

[system]
# 是否自动同意进群邀请
accept_group_invite = false

# 是否自动同意好友请求
accept_friend_request = false

[presets]
# 切换预设的命令： 加载预设 猫娘
command = "加载预设 (\\w+)"

loaded_successful = "预设加载成功！"

[presets.keywords]
# 预设关键词 <-> 实际文件
"正常" = "presets/default.txt"
"猫娘" = "presets/catgirl.txt"

多账号支持

你可以登录多个不同的 OpenAI 账号，当机器人开始产生新对话时，我们会从你登录的账号中选择一个来使用 ChatGPT 和用户聊天。

一个对话会绑定在一个号上，所以你不必担心丢失上下文的问题。

这可以降低聊天频率限制出现的概率。

[openai]
# OpenAI 相关设置

# 第 1 个 OpenAI 账号的登录信息
[[openai.accounts]]
# 里面是一些设置

# 第 2 个 OpenAI 账号的登录信息
[[openai.accounts]]
# 里面是一些设置

# 第 3 个 OpenAI 账号的登录信息
[[openai.accounts]]
# 里面是一些设置

模式选择

现在我们支持多种方式访问 OpenAI 服务器，你可以在配置文件中选择所使用的模式。

[openai]
# OpenAI 相关设置

# 第 N 个 OpenAI 账号的登录信息
[[openai.accounts]]
# 前面别的东西

# 模式选择
mode = "browser"

# 后面别的东西

支持的模式有：

browser - 浏览器登录。该模式会在你的电脑上启动一个 Chrome 浏览器来登录并验证 OpenAI
browserless - 无浏览器模式。该模式将你的账号信息发送到第三方服务器进行认证，从而不需要浏览器。

邮箱密码登录

当你使用这种方式登录时，我们会自动打开一个浏览器页面完成 OpenAI 的登录。

我们会自动点击页面中的 Log in 按钮、为您填写 email，并完成登录。

登录完成后，浏览器会自动退出。

# 前面别的东西
[openai]
# OpenAI 相关设置

# 第 N 个 OpenAI 账号的登录信息
[[openai.accounts]]
# 你的 OpenAI 邮箱
email = "xxxx" 
# 你的 OpenAI 密码
password = "xxx"
# 后面别的东西

session_token 登录

对于通过 Google 登录或者微软登录的同学，可以使用 session_token 方式进行登录。

使用这种方式登录时不需要填写邮箱和密码。

需要注意的是，session_token 过期比较频繁，过期后需要重新设置。

session_token 的获取方式可参考：请问怎么获取 session_token

# 前面别的东西
[openai]
# OpenAI 相关设置

# 第 N 个 OpenAI 账号的登录信息
[[openai.accounts]]

session_token = "一串 ey 开头的东西"

access_token 登录

配合 mode="browserless"使用，这种方式登录时不需要填写邮箱和密码、session_token。
在手动科学上网登录openai网站后，打开浏览器的开发者工具-网络，访问https://chat.openai.com/api/auth/session,响应json如下：

{
	"user": {
		"id": "user-*****",
		"name": "***",
		"email": "***",
		"image": "***",
		"picture": "***",
		"groups": []
	},
	"expires": "2023-03-18T09:11:03.546Z",
	"accessToken": "eyJhbGciOiJS*****X7GdA"
}

获取以上json中accessToken的值即可，有效期在30天左右。过期后需要重新设置。

# 前面别的东西

[[openai.accounts]]
access_token = "一串 ey 开头的东西"

浏览器登录不了？使用无浏览器模式！

如果你登录过程中遇到了卡死的情况，

可以尝试设置 mode="browserless" 配置项。

开启后，你的账户密码将发送至一个第三方的代理服务器进行验证。

# 前面别的东西
[openai]
# OpenAI 相关设置

# 第 N 个 OpenAI 账号的登录信息
[[openai.accounts]]
mode = "browserless"
# 你的 OpenAI 邮箱
email = "xxxx" 
# 你的 OpenAI 密码
password = "xxx"
# 后面别的东西

使用正向代理

如果你的网络访问 OpenAI 出现一直弹浏览器的问题，或者你的 IP 被封锁了，可以通过配置代理的方式来连接到 OpenAI。支持使用正向代理方式访问 OpenAI，你需要一个 HTTTP/HTTPS 代理服务器：

# 前面别的东西
[openai]
# OpenAI 相关设置

# 第 N 个 OpenAI 账号的登录信息
[[openai.accounts]]

# 请注意，由于现在 OpenAI 封锁严格，你需要一个
# 尽量使用独立的代理服务器，不要使用和其他人共用 IP 的代理
# 否则会出现无限弹出浏览器的问题  

proxy="http://127.0.0.1:1080"

# 后面别的东西

🦊 加载预设

如果你想让机器人自动带上某种聊天风格，可以使用预设功能。

我们自带了 猫娘 和 正常 两种预设，你可以在 presets 文件夹下了解预设的写法。

使用 加载预设猫娘 来加载猫娘预设。

你可以参考 Awesome-ChatGPT-prompts-ZH_CN 来调教你的 ChatGPT。

📷 图片转文字

向 QQ 群发送消息失败时，自动将消息转为图片发送。

字体文件存放于 fonts/ 目录中。

默认使用的字体是更纱黑体。

Star History

如果你觉得本项目对你有帮助的话，欢迎点一个 Star!