CoolQ C++ SDK 使用教程

1. 项目的目录结构及介绍

CoolQ C++ SDK 的目录结构如下：

coolq-cpp-sdk/
├── src/
│   ├── cqcppsdk/
│   │   ├── cqcppsdk.hpp
│   │   └── ...
│   └── ...
├── tests/
│   └── ...
├── clang-format
├── editorconfig
├── gitignore
├── CMakeLists.txt
├── LICENSE
├── README.md
└── ...

目录介绍

• src/: 包含 SDK 的核心源代码文件。
  • cqcppsdk/: 主要的 SDK 头文件和实现文件。
• tests/: 包含 SDK 的测试代码。
• clang-format: 代码格式化配置文件。
• editorconfig: 编辑器配置文件。
• gitignore: Git 忽略文件配置。
• CMakeLists.txt: CMake 构建配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

CoolQ C++ SDK 的启动文件主要是 cqcppsdk.hpp，它包含了 SDK 的主要接口和初始化逻辑。

启动文件内容

#include <cqcppsdk/cqcppsdk.hpp>

using namespace cq;

CQ_INIT {
    on_private_message([](const auto &event) {
        try {
            send_message(event.target, event.message);
        } catch (const exception &e) {
            logging::error("private message", e.what());
        }
    });
}

启动流程

1. 包含 cqcppsdk.hpp 头文件。
2. 使用 CQ_INIT 宏定义初始化逻辑。
3. 在初始化块中注册事件处理函数，例如处理私聊消息。

3. 项目的配置文件介绍

CoolQ C++ SDK 的配置文件主要是 CMakeLists.txt，它定义了项目的构建配置。

配置文件内容

cmake_minimum_required(VERSION 3.10)
project(coolq-cpp-sdk)

set(CMAKE_CXX_STANDARD 17)

add_subdirectory(src)
add_subdirectory(tests)

# 其他配置...

配置文件说明

• cmake_minimum_required(VERSION 3.10): 指定 CMake 的最低版本要求。
• project(coolq-cpp-sdk): 定义项目名称。
• set(CMAKE_CXX_STANDARD 17): 设置 C++ 标准为 C++17。
• add_subdirectory(src): 添加源代码目录。
• add_subdirectory(tests): 添加测试代码目录。

通过以上配置，可以构建和运行 CoolQ C++ SDK 项目。