Home

Awesome

CQHTTP

License Release Download Count Docker Build Status Docker Pulls QQ 群 Telegram 群

由于本人精力有限,且 酷Q 即将停止服务,本项目已停止维护,也不再会开发其它平台的同类插件,感谢大家一直以来的支持和鼓励!

通过 HTTP 或 WebSocket 对 酷Q 的事件进行上报以及接收请求来调用 酷Q 的 DLL 接口,从而可以使用其它语言编写 酷Q 插件。支持 Windows 7 和 Windows Server 2008 及更新版本,也可以运行在 Wine、Docker。

使用方法

使用方法见 https://cqhttp.cc/docs/。v1.x、v2.x 的旧版本文档在 https://cqhttp.cc/docs/legacy/

如果访问这个文档非常慢,请尝试国内的地址 http://richardchien.gitee.io/coolq-http-api/docs/

SDK/开发框架

对于下面这些语言的开发者,如果不想自己处理繁杂的请求和解析操作,可以尝试社区中开发者们已经封装好的的 SDK 或开发框架:

语言Web 框架通信方式地址核心作者
PythonQuartHTTP,<br>反向 WebSocketnonebot/nonebotrichardchien<br>yanyongyu
PythonQuartHTTP,<br>反向 WebSocketnonebot/aiocqhttprichardchien
Node.jsWebSocket-NodeWebSocketmomocow/node-cq-websocketmomocow
Node.jsExpressHTTP,<br>WebSocketkoishijs/koishiShigma
Node.jsWebSocket-NodeWebSocketCaoMeiYouRen/node-coolq-robotCaoMeiYouRen
Node.jsExpressHTTPXHMM/lemon-botXHMM
JavaScript-WebSocketpandolia/js-botpandolia
Deno标准库反向 WebSocketnenojs/deno-cqhttprikakomoe
PHPSwoole反向 WebSocketzhamao-robot/zhamao-frameworkcrazywhalecc
PHP-HTTPLovelyA72/YeziiBot-v2LovelyA72
Java标准库HTTPHyDevelop/PicqBotXHykilpikonna
Java<br>Kotlin<br>GroovySpring反向 WebSocketlz1998/Spring-CQ教程lz1998
Java标准库HTTPForteScarlet/simple-robot-coreForteScarlet
JavaJFinalHTTPthevsk/cqhttp-java-jfinal-sdkthevsk
Kotlin标准库HTTPJuerGenie/juerobotJuerGenie
Go标准库API:<br>HTTP,<br>WebSocket<br>Event:<br>HTTP,<br>长轮询,<br>WebSocket,<br>反向 WebSocketcatsworld/qq-bot-apicatsworld<br>rikakomoe
C#标准库HTTP,<br>WebSocketint-and-his-friends/Sisters.WudiLibbleatingsheep
C#标准库HTTP,<br>WebSocket,<br>反向 WebSocketfrank-bots/cqhttp.Cyanfrankli0324
C#Fleck反向 WebSocketcqbef/cqhttp.WebSocketReverse.NETCorecqbef
PowerShell.NETHTTPcqmoe/cqhttp-powershell-sdkrichardchien
Lualua-httpHTTP,<br>WebSocketcleoold/cqhttp-lua53-sdkcleoold

应用案例

QQ 机器人可以用来做很多有意思的事情,下面列出一些基于本插件的应用案例:

项目地址简介
milkice233/efb-qq-slave基于 ehForwarderBot 框架的 QQ 从端
projectriri/bot-gateway提供跨聊天平台的通用机器人 API 的机器人消息网关
jqqqqqqqqqq/UnifiedMessageRelayQQ <-> Telegram Bot Framework & Forwarder
Mother-Ship/cabbageWeb基于 Java Web 的 osu! 游戏数据查询机器人
bdbai/KobirtIngress 游戏辅助机器人
JRT-FOREVER/hub2coolqGitHub webhook 消息转发至 QQ 群
Kurarion/Bangumi-for-QQ用于在 QQ 平台便捷地使用 Bangumi 部分功能(查寻条目、更新条目进度等)
rikakomoe/cqhttp-twitter-bot自动订阅 Twitter 发送到 QQ
XiaoLin0815/QQ2TG帮助 QQ 与 Telegram 互联的小程序
spacemeowx2/splatoon2-qqbot宇宙第一的 Splatoon2 的地图机器人
OYMiss/forward-bot用 Telegram 和 QQ 好友聊天的转发机器人
mrthanlon/SICNUBOT专为四川师范大学设计用于审核发布消息用的 QQ 机器人
billjyc/pocket48监控成员口袋 48 聚聚房间、微博和摩点项目
chinshin/CQBot_hzx摩点 & 微博 & 口袋 48 机器人(BEJ48-黄子璇)
Ice-Hazymoon/grnd_bot订阅 RSSHub 更新并推送到 QQ 群
Ray-Eldath/Avalon多功能、可扩展的群机器人,支持 QQ 和 Discord
Bluefissure/FFXIVBOT基于 Django Channels 的最终幻想 14 游戏数据查询机器人
Milkitic/Daylily基于 ASP.NET Core 的跨平台机器人(含快速开发插件框架)
cczu-osa/aki基于 NoneBot 的多功能 QQ 机器人
cleoold/sendo-erika基于 cqhttp 和 NoneBot 的,主要通过私聊摇控的 QQ 机器人
duan602728596/qqtools基于 Nwjs 的 QQ 群工具(摩点、口袋 48、微博提醒、入群欢迎、定时喊话、自定义命令和回复信息等)
Tsuk1ko/CQ-picfinder-robot基于 Saucenao 的搜图机器人
kasora/diceCOC7 骰子 QQ 机器人
shidenggui/tuishujun-for-qq基于推书君的小说查询推荐 QQ 机器人
JuerGenie/cn.juerwhang.jgbot基于 JuerGenie/juerobot 的娱乐用 QQ 机器人
drsanwujiang/DiceRobot一个基于 coolq-http-api 插件的 TRPG 骰子机器人
UltraSoundX/SDFMU-Library山东第一医科大图书馆预约机器人
Quan666/ELF_RSS基于 NoneBot 的,交互式 RSS 订阅、转发机器人
lz1998/Spring-CQ-web基于 SpringCQ 的机器人 web 控制台
suisei-cn/stargazer-qq一个灵活的 vtuber 发推/直播动态监控机器人
Ninzore/Wecab网络内容聚合机器人,支持微博、B站、Twitter 等

以上列出的只是实际应用中的一小部分,如果你使用本插件编写了任何好的应用案例或开发框架,也可以通过 issue 或 pull request 添加到这里的列表,共同充实社区。

<!-- ## Nightly 版本 如果你急需测试尚未发布的最新特性,可以前往 https://ci.appveyor.com/project/richardchien/coolq-http-api/build/artifacts 下载从 master 分支的最新代码构建出的 DLL 和 JSON 文件,将它们放入 酷Q 的 `app` 文件夹并开启 酷Q 的开发模式即可使用。 **需要注意的是,master 分支所构建出的插件并不确保任何时候都是可用的,可能出现功能存在,但尚未完成的情况。** -->

修改、编译

本项目基于 CoolQ C++ SDK,构建方式和它一致,但由于一些历史原因,需要先手动下载预编译的依赖库,并且使用 Visual Studio 2019MSVC v141 构建(可以只安装 Build Tools,不必安装完整的 IDE)。

首先,克隆或下载本仓库代码:

git clone https://github.com/richardchien/coolq-http-api.git
cd coolq-http-api
git submodule init
git submodule update

然后,从 这里 下载 vcpkg-export-20191012.zip(也就是预编译的依赖),并解压到当前工程目录,确保工程目录结构如下:

coolq-http-api
├── ...
├── src
├── vcpkg-export-20191012
|   ├── installed
|   ├── scripts
│   └── .vcpkg-root
├── CMakeLists.txt
└── ...

最后生成并构建 CMake 项目:

powershell .\scripts\generate.ps1 Debug
powershell .\scripts\build.ps1 Debug

开源许可证、重新分发

本程序使用 GPLv3 许可证,并按其第 7 节添加如下附加条款:

总体来说,在当前许可证下,你可以:

问题、Bug 反馈、意见和建议

如果使用过程中遇到任何问题、Bug,或有其它意见或建议,欢迎提 issue

也欢迎加入 QQ 交流群 201865589 来和大家讨论~

感谢

相似项目

除了 CQHTTP,还有一些其它相似功能的插件:

除了上述基于 酷Q 平台的插件,还有一些基于其它机器人平台、旨在兼容 CQHTTP 接口的项目,为 QQ 机器人开发社区注入了新的活力: