qidouhai/coolq-http-api

CoolQ 插件实现通过 HTTP 上报事件信息及调用接口

CoolQ HTTP API 插件

通过 HTTP 对酷 Q 的事件进行上报以及接收 HTTP 请求来调用酷 Q 的 C++ 接口，从而可以使用其它语言编写酷 Q 插件。

使用方法

手动安装

直接到 Releases 下载最新的 cpk 文件放到酷 Q 的 app 文件夹，然后启用即可。由于要上报事件、接受调用请求，因此需要所有权限。

注意如果系统中没有装 VC++ 2017 运行库，酷 Q 启动时会报错说插件加载失败，需要去下载 Microsoft Visual C++ Redistributable for Visual Studio 2017 x86 安装（注意一定要安装 x86 版本）。

启用后插件将开启一个后台线程用来监听 HTTP，默认监听 0.0.0.0:5700，首次启用会生成一个默认配置文件，在酷 Q app 文件夹的 io.github.richardchien.coolqhttpapi 文件夹中，文件名 config.cfg，使用 ini 格式填写。关于配置项的说明，见 配置文件说明。

此时通过 http://192.168.1.123:5700/ 即可调用酷 Q 的函数，例如 http://192.168.1.123:5700/send_private_msg?user_id=123456&message=你好，注意这里的 192.168.1.123 要换成你自己电脑的 IP，如果在本地跑，可以用 127.0.0.1，user_id 也要换成你想要发送到的 QQ 号。具体的 API 列表见 API 描述。如果需要使用 HTTPS 来访问，见 HTTPS。

酷 Q 收到的消息、事件会被 POST 到配置文件中指定的 post_url，为空则不上报。上报数据格式见 上报数据格式。

停用插件将会关闭 HTTP 线程，再次启用将重新读取配置文件。

另外，本插件所支持的 CQ 码在原生的基础上进行了一些增强，见 CQ 码，并且支持以字符串或数组格式表示消息，见 消息格式。

对于其它可能比较容易遇到的问题，见 FAQ。

使用 Docker

如果你使用 docker 来部署服务，可以直接运行已制作好的 docker 镜像，容器将会按照环境变量的配置来下载或更新插件到指定或最新版本，并自动修改配置文件，例如：

$ docker pull richardchien/cqhttp
$ docker run -ti --rm --name cqhttp-test \
             -p 9000:9000 -p 5700:5700 \
             -e CQHTTP_VERSION=2.1.0 \
             -e CQHTTP_HOST=0.0.0.0 \
             -e CQHTTP_POST_URL=http://example.com:8080 \
             -e CQHTTP_SERVE_DATA_FILE=yes \
             richardchien/cqhttp

具体请参考 richardchien/cqhttp-docker。

文档

更多文档，见 CoolQ HTTP API 插件文档。

修改、编译

整个项目目录是一个 VS 2017 工程，使用了 VS 2017 (v141) 工具集，直接打开 CoolQHttpApi.sln 即可修改、编译。项目根目录也提供了 build.bat 脚本，可以直接 cmd /k build.bat 来编译，不过请注意查看脚本中的 VS 路径是否和你系统中的路径相符。

工程属性中配置了一个自定义的「后期生成事件」命令，也就是编译成功后执行的脚本，默认情况下什么都不做，你可以在项目根目录加一个文件 post_build.bat 在里面进行你需要的操作（比如移动 dll 文件到酷 Q 的 app 文件夹），这个文件被 Git 忽略掉了，因此不会影响 Git 仓库上的内容。

除了 io.github.richardchien.coolqhttpapi.json，其它所有文件均使用 UTF-8 编码，并且编译命令加入了 /utf-8 选项，因此如果你要修改代码，也请使用 UTF-8 编码，以便正常通过编译（注意，VS 创建文件之后输入中文可能会默认使用 GBK 编码，需要手动另存为到 UTF-8）。

io.github.richardchien.coolqhttpapi.json 文件使用 GBK 编码，否则酷 Q 无法识别。

开源许可证、重新分发

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

• 本程序的修改版本应以合理的方式标志为和原版本不同的版本（附加条款 c）

总体来说，在当前许可证下，你可以：

• 修改源代码并自己使用，在不重新分发（编译之后的程序）的情况下，没有任何限制
• 不修改源代码并重新分发，对程序收费或免费提供下载，或提供其它服务，此时你需要保证在明显的地方提供本程序的源码地址并保持协议不变（包括附加条款）
• 修改源代码并重新分发，对程序收费或免费提供下载，或提供其它服务，此时你需要注明源码修改的地方、提供源码地址、保持协议不变（可删除全部或部分附加条款）、修改程序的名称

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

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

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

捐助

由于酷 Q 的一些功能只有 Pro 付费版才有，而我在编写插件时需要对每个可能的功能进行测试，我自己的使用中也没有对 Pro 版的需求，因此这将成为额外开销。如果你觉得本插件挺好用的，或对酷 Q Pro 的功能有需求，不妨进行捐助。你的捐助将用于开通酷 Q Pro 以测试功能，同时也会让我更加有动力完善插件。感谢你的支持！

这里 列出了捐助者名单，由于一些收款渠道无法知道对方是谁，如有遗漏请联系我修改。

支付宝

微信支付