search

kyubotics / coolq-cpp-sdk

CoolQ C++ SDK
MIT License
145 stars 23 forks source link
coolq cpp qq qqbot qqrobot

readme

CoolQ C++ SDK

本项目为旧版 CoolQ C++ SDK，已不再维护，请使用新版，见 cqmoe/cqcppsdk。

CoolQ C++ SDK 封装了跟 DLL 接口相关的底层逻辑，包括：

并且对外提供了更现代的 C++ 接口，从而为更方便地编写插件提供可能。

目录

示例

#include "cqsdk/cqsdk.h"

// namespace cq::app 包含插件本身的生命周期事件和管理
// namespace cq::event 用于注册 QQ 相关的事件处理函数
// namespace cq::api 用于调用酷 Q 提供的接口
// namespace cq::logging 用于日志
// namespace cq::message 提供封装了的 Message 等类

// 插件入口，在静态成员初始化之后，app::on_initialize 事件发生之前被执行，用于配置 SDK 和注册事件回调
CQ_MAIN {
    cq::app::on_enable = [] {
        // cq::logging、cq::api、cq::dir 等命名空间下的函数只能在事件回调函数内部调用，而不能直接在 CQ_MAIN 中调用
        cq::logging::debug(u8"启用", u8"插件已启动");
    };

    cq::event::on_private_msg = [](const cq::PrivateMessageEvent &e) {
        cq::logging::debug(u8"消息", u8"收到私聊消息：" + e.message + u8"，发送者：" + std::to_string(e.user_id));

        if (e.user_id != 1002647525) return;

        try {
            cq::api::send_private_msg(e.user_id, e.message); // echo 回去

            cq::api::send_msg(e.target, e.message); // 使用 e.target 指定发送目标

            // MessageSegment 类提供一些静态成员函数以快速构造消息段
            cq::Message msg = cq::MessageSegment::contact(cq::MessageSegment::ContactType::GROUP, 201865589);
            msg.send(e.target); // 使用 Message 类的 send 成员函数
        } catch (const cq::exception::ApiError &err) {
            // API 调用失败
            cq::logging::debug(u8"API", u8"调用失败，错误码：" + std::to_string(err.code));
        }

        e.block(); // 阻止事件继续传递给其它插件
    };

    cq::event::on_group_msg = [](const auto &e /* 使用 C++ 的 auto 关键字 */) {
        const auto memlist = cq::api::get_group_member_list(e.group_id); // 获取数据接口
        cq::Message msg = u8"本群一共有 "; // string 到 Message 自动转换
        msg += std::to_string(memlist.size()) + u8" 个成员"; // Message 类可以进行加法运算
        cq::message::send(e.target, msg); // 使用 message 命名空间的 send 函数
    };
}

更多请看 src/demo.cpp。

使用方式

预备

本项目使用 CMake 构建，依赖项通过 vcpkg 管理。如果你没有使用过这两个工具，请先前往它们的官方网站了解基本用法。

在开始使用之前，请确保你已经安装了 Git，且 PATH 中存在 git 命令。不需要安装 vcpkg，后面的脚本中会自动安装。

构建脚本要求 PowerShell 5+，如果系统是 Windows 10，则使用自带的即可，如果是 Windows 7 或 8.1，可以安装 PowerShell Core 6 或更新版本，安装方法见 在 Windows 上安装 PowerShell Core。

然后确保安装了 Visual Studio 2019 或 Visual Studio 2019 生成工具（如果使用 2017 版本可能需要自行修改 CMakeSettings.json 中的 generator 参数），并勾选「使用 C++ 的桌面开发」，确保安装了 MSVC v142、Windows 10 SDK、用于 Windows 的 C++ CMake 工具 这三个组件。其中，如果系统中已经安装了 CMake，无需再在 VS Installer 中安装，但需要确保命令已添加进 PATH。除此之外，vcpkg 还要求安装 VS 的英文语言包。

推荐使用 VS Code 开发，只需安装 Visual Studio 2019 生成工具，不需要安装臃肿的 VS IDE。

下载 SDK

git clone https://github.com/richardchien/coolq-cpp-sdk.git my-awesome-app
cd my-awesome-app
git submodule init
git submodule update

准备构建环境

powershell .\scripts\prepare.ps1

# 如果打算使用预编译的依赖，可以运行：
powershell .\scripts\prepare_prebuilt.ps1

# 请不要混用上面的两个脚本，只需运行一个即可

scripts/prepare.ps1 脚本会在当前项目目录的 vcpkg 子目录中安装 vcpkg，并安装所需依赖；scripts/prepare_prebuilt.ps1 脚本则会下载预编译的依赖库，直接解压到当前项目目录。

如何选择？如果你只是想快速试用 demo，建议使用 prepare_prebuilt；如果你的网络环境不佳，使用 prepare 安装依赖太慢，也可以使用 prepare_prebuilt；如果你打算开发较大型的插件项目，且希望使用 vcpkg 来方便地管理依赖，可以使用 prepare。

注意，如果 PowerShell 提示不让运行脚本，需要先使用管理员权限打开 PowerShell，运行 Set-ExecutionPolicy Unrestricted，然后再重新运行上面的脚本；如果 vcpkg 安装依赖时出错，比较常见的问题是网络超时，请适当设置 HTTP_PROXY 和 HTTPS_PROXY，或使用预编译依赖。

修改 App Id 和相关信息

修改 app_id.txt 的内容为你的 App Id，例如 com.company.my-awesome-app，这个 App Id 的命名规范见 appid 规范。

按需修改 app.json 文件中的信息，通常需要修改 name、version、version_id、author、description，根据实际功能可能还需要修改 menu 和 auth，具体字段含义见 app.json。请不要修改 event 字段，因为事件处理函数的名字已经写死在了 SDK 中。

编写功能

移除 src/demo.cpp 或在其基础上修改，实现自己的功能。

具体 API 请参考 src/demo.cpp，或顺着 src/cqsdk/cqsdk.h 头文件找进去，IDE 的自动补全帮助会很大。除此之外，还可以参考 richardchien/coolq-http-api 项目。

注意，所有代码文件必须使用 UTF-8 编码。如果你使用 VS，则它默认使用 ANSI 编码保存新创建的文件，需要手动修改为 UTF-8。

构建项目

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

上面两条命令分别生成 build 目录和构建项目，将 Debug 改为 Release 可以构建 release 版本。如果安装了 CMake 还没支持的较新版本 VS，需要先手动进入 VS 2019 的 Developer Command Prompt，再执行上面的命令。

如果你使用 VS Code，可以直接运行 task；如果使用 VS，可以直接选择菜单 CMake - 全部生成。

安装插件到 酷Q

首先确保开启了 酷Q 的开发模式，并了解 酷Q 应用开发、调试、打包的基本流程，见 快速入门。

在项目构建完成后，复制 build/Debug/Debug（如果是 release 编译则是 build/Release/Release）中和你的 App Id 名字相同的文件夹到 酷Q 的 dev 目录下，在 酷Q 中重载应用即可。

如果不想每次构建后都手动安装插件，可以添加 scripts/install.ps1 文件（使用 UTF-16 LE 编码）如下：

$coolqRoot = "C:\Users\Richard\Lab\酷Q Pro" # 注意修改 酷Q 目录

$appId = $args[0]
$libName = $args[1]
$appOutDir = $args[2]

$coolqAppDevDir = "$coolqRoot\dev\$appId"
$dllName = "$libName.dll"
$dllPath = "$appOutDir\$dllName"
$jsonName = "$libName.json"
$jsonPath = "$appOutDir\$jsonName"

Write-Host "正在拷贝插件到 酷Q 应用文件夹……"

New-Item -Path $coolqAppDevDir -ItemType Directory -ErrorAction SilentlyContinue
Copy-Item -Force $dllPath "$coolqAppDevDir\$dllName"
Copy-Item -Force $jsonPath "$coolqAppDevDir\$jsonName"

Write-Host "拷贝完成" -ForegroundColor Green

后期生成事件脚本 scripts\post_build.ps1 发现存在 scripts/install.ps1 时会自动运行它，从而将构建出的 DLL 和 JSON 文件安装到 酷Q，此时在 酷Q 悬浮窗快速重启即可。

更新 SDK

git submodule update

此命令会更新 src/cqsdk 中的 SDK 核心代码。

如果需要更新 CMakeLists.txt、scripts 等构建相关文件，使用 git pull，注意可能需要处理冲突。

安装依赖

如果需要安装依赖，可以直接使用 vcpkg（注意，前提是前面的准备步骤中安装了完整的 vcpkg，而不是预编译依赖），通过 --triplet x86-windows-static-custom 指定 triplet，或者使用 SDK 提供的包装脚本（参数和 vcpkg 相同），例如：

.\scripts\vcpkg.ps1 install curl

然后按需在 CMakeLists.txt 添加相应 find_package 语句和修改 target_link_libraries。注意，vcpkg 的 CMake 工具链文件有时并不能正确找到依赖的依赖的 LIB 文件，需要手动编写 FindXxx.cmake 文件，参考 richardchien/coolq-http-api/cmake/Modules/FindCURL.cmake。

固定依赖包版本

对于依赖比较多的大型项目，依赖之间关系可能比较复杂，vcpkg 默认是直接安装最新版本，这会导致在部分依赖进行了不兼容的更新、而另一些依赖还没有跟进的情况下，整个项目无法编译。

Vcpkg 官方建议的做法 是，使用 Git 将 ports 目录固定在一切 OK 的版本，例如：

git checkout 7578a485b181ded330b87cc72726f01e38ff7ed6 -- ports

为了避免每次换开发环境都要手动 checkout，可以在项目根目录添加文件 vcpkg-commit.txt 如下：

7578a485b181ded330b87cc72726f01e38ff7ed6

内容是 Git commit 的 hash。scripts/prepare.ps1 脚本会自动在准备构建环境的时候将 ports 目录固定到此 commit 的版本。

使用 CI 自动构建

.appveyor.yml 提供了 AppVeyor 的配置，几乎不用修改便可直接使用：在 AppVeyor 中新建项目，选好项目仓库，然后在 Settings 中「Custom configuration .yml file name」处填写 .appveyor.yml 即可。

在每次 Git 推送之后，CI 会自动运行构建脚本，并将构建出的 app.dll 和 app.json 打包进 <app_id>.zip，可在 AppVeyor 构建任务的「Artifacts」处下载。

注意，目前无法直接打包成 CPK 格式，如需分发，仍需手动在 酷Q 应用目录中打包。

分发应用

如果需要向用户分发应用（打包好的 CPK），需要提示用户安装 Visual C++ 可再发行软件包，下载地址见 最新支持的 Visual C++ 下载。

插件生命周期

+-----------------------------------------+
|             Enabled At Start            |
+-----------------------------------------+
| on_initialize                           |
|       +                                 |
|       |                                 |
|       v                                 |
| on_coolq_start                          |
|       +                                 |
|       |                                 |
|       v     disabled by user            |
|   on_enable +--------------> on_disable |
|       +                           +     |
|       |                           |     |
|       v                           |     |
| on_coolq_exit <-------------------+     |
+-----------------------------------------+

+---------------------------------------+
|            Disabled At Start          |
+---------------------------------------+
| on_initialize +------+                |
|       +              |enabled by user |
|       |              |                |
|       |              v                |
|       |       on_coolq_start          |
|       |              +                |
|       |              |                |
|       |              v                |
|       |          on_enable            |
|       |              +                |
|       |              |                |
|       v              |                |
| on_coolq_exit <------+                |
+---------------------------------------+

应用案例

项目地址 简介
richardchien/coolq-http-api 酷Q HTTP API 插件
JogleLew/coolq-telegram-bot-x QQ / Telegram 群组消息转发机器人
dynilath/coolq-dicebot 酷Q 骰子机器人