CoolQ C++ SDK 使用指南

CoolQ C++ SDK 使用指南

coolq-cpp-sdk CoolQ C++ SDK 项目地址: https://gitcode.com/gh_mirrors/co/coolq-cpp-sdk

1. 项目目录结构及介绍

CoolQ C++ SDK 是一个针对酷Q插件开发的C++库，旨在简化插件的编写过程。以下是该SDK的基本目录结构及其简介：

coolq-cpp-sdk/
├── appveyor.yml                    # AppVeyor持续集成配置文件
├── clang-format                    # Clang格式化配置文件
├── cmake                           # CMake相关脚本和配置
│   ├── CMakeLists.txt              # 主要的CMake构建文件
│   └── ...                         # 其他CMake辅助文件
├── gitignore                       # Git忽略文件列表
├── gitmodules                      # Git子模块配置
├── CMakeLists.txt                  # 顶层构建配置文件
├── CMakeSettings.json              # Visual Studio特定的CMake设置
├── LICENSE                         # 许可证文件，MIT协议
├── README.md                       # 项目说明文档
├── app                             # 示例应用程序代码
│   ├── app.cpp                     # 插件主体逻辑
│   └── app_id.txt                  # 应用ID配置文件
├── src                             # 源代码目录
│   └── cqsdk                        # SDK的核心源代码
│       └── cqsdk.h                 # SDK的主要头文件
└── scripts                         # 构建和部署辅助脚本
    ├── generate.ps1                # 用于生成构建文件的PowerShell脚本
    ├── install.ps1                 # 插件自动安装脚本
    ├── post_build.ps1              # 构建后执行的脚本
    ├── prepare.ps1                 # 准备构建环境的脚本
    ├── prepare_prebuilt.ps1        # 准备预编译依赖的脚本
    └── vcpkg.ps1                   # 使用vcpkg安装依赖的脚本

2. 项目的启动文件介绍

项目中并没有传统意义上的“启动文件”，而是通过CMake构建系统来生成对应的可执行文件或动态链接库(DLL)。然而，若要说与“启动”密切相关的代码，那就是位于app/app.cpp的代码片段。这里定义了插件的行为，特别是CQ_MAIN宏标记的地方，它是插件生命周期管理和事件响应的起点。

CQ_MAIN
[
    // 插件初始化、事件监听等功能配置放在这里
]

在这区域内，你可以配置日志记录、注册事件处理器等，这些操作相当于插件的“启动序列”。

3. 项目的配置文件介绍

app_id.txt

这个简短的文本文件是用来存放你的插件的唯一标识符（App Id）。其内容应遵循一定的命名规则，如com.example.myplugin。此配置至关重要，因为它帮助酷Q识别并加载正确的插件。

app.json

虽然教程中未明确提及，但在CoolQ插件开发中通常会有app.json配置文件，它定义了插件的一些元信息，如插件的名称、作者、版本等。这里的配置直接影响到插件在酷Q中的显示和管理。尽管目录结构中没有直接列出，但它应该是和app_id.txt一起位于应用程序的根目录下，用于提供插件的基本信息配置。

请注意，实际上具体的配置文件内容可能会根据版本更新有所变化，务必参考最新的SDK文档或示例进行配置。

coolq-cpp-sdk CoolQ C++ SDK 项目地址: https://gitcode.com/gh_mirrors/co/coolq-cpp-sdk