nonebot-plugin-quote 0.1.6

一款适用于QQ群聊天的语录库插件

nonebot-plugin-quote

✨ QQ群聊 语录库 ✨

🧬 支持OCR识别，关键词搜索 | 一起记录群友的逆天言论吧！🎉

📖 介绍

一款适用于QQ群聊天的语录库插件。

• 上传聊天截图
• 随机投放聊天语录
• 根据关键词投放聊天语录

🎉 使用

上传

@机器人，发送上传指令，开启上传通道。

以图片的形式发送聊天语录，即可将语录上传至语录库中。

随机发送语录

@机器人，发送语录指令，机器人将从语录库中随机挑选一条语录发送。

关键词检索语录

@机器人，发送语录+关键词指令，机器人将从语录库中进行查找。若有匹配项，将从匹配项中随机一条发送；若无匹配项，将从整个语录库中随机挑选一条发送。

详细命令

默认配置下，@机器人加指令即可。

指令	需要@	范围	说明
上传/开始上传/上传开始	是	群聊	开启语录上传通道
语录上传通道开启后直接发送图片	否	群聊	上传图片至语录库
语录 + 关键词(可选)	是	群聊	根据关键词返回一个符合要求的图片, 没有关键词时随机返回

💿 安装

OCR支持

本插件需要使用OCR技术，为了使本插件正常运行，需要使用Docker快速部署OCR服务。

请自行参考 Docker 官方文档 安装 Docker。

docker pull mmmz/trwebocr:latest

docker run -itd --rm -p 8089:8089 --name trwebocr mmmz/trwebocr:latest 

本插件使用的OCR技术来自: https://github.com/alisen39/TrWebOCR，在此特别感谢。

下载

1. 通过包管理器安装，可以通过nb，pip，或者poetry等方式安装，以pip为例

pip install nonebot-plugin-quote -U

2. 手动安装

git clone https://github.com/RongRongJi/nonebot_plugin_quote.git

⚙️ 配置

在 nonebot2 项目的 .env 文件中添加下表中的必填配置

配置项	必填	默认值	说明
OCR_URL	否	'http://localhost:8089/api/tr-run/'	OCR所需的接口url, 如果你是按照上述命令运行的Docker镜像, 无需额外配置
RECORD_PATH	是	空字符串	必要的json文件路径, 示例'/data/record.json'
INVERTED_INDEX_PATH	是	空字符串	必要的json文件路径, 示例'/data/inverted_index.json'
TMP_DIR	否	空字符串	临时文件夹路径, 示例'/data/'

其中，需要在RECORD_PATH和INVERTED_INDEX_PATH中手动创建两个json文件，并在其中填入{}以确保其能够正确运行，如下图所示：

随后，在项目的pyproject.toml或bot.py中加上如下代码，加载插件（根据版本而定）

pyproject.toml中添加

# pip install的填这个
plugins = ["nonebot_plugin_quote"]

# 手动安装的填这个
plugin_dirs = ["nonebot_plugin_quote"]

或

bot.py中添加

# pip install的填这个
nonebot.load_plugin("nonebot_plugin_quote")

# 手动安装的填这个
nonebot.load_plugins("src/plugins", "nonebot_plugin_quote")

🎉 鸣谢

• NoneBot2：HarukaBot 使用的开发框架。
• go-cqhttp：稳定完善的 CQHTTP 实现。
• TrWebOCR：轻量又便捷的OCR镜像方案。