# 开始使用

CoolQ C++ SDK 使用 CMake 作为构建管理工具，使用现代 C++ 作为开发语言。对于这两者的新手来说，建议阅读本页的入门版开始教程，跳过高级版；而如果你是老手，可以直接跳到高级版开始教程。

# 准备

# CMake

如果你的系统中还没有安装 CMake，请先前往 官网 下载最新版 CMake 安装，也可使用 HomeBrew、APT、Pacman、Scoop、Chocolatey 等你所熟悉的包管理器安装。

安装完成后，可以在命令行运行：

cmake --version

来检查是否安装成功。

# C++ 编译器

如果你的系统中还没有安装 C++ 编译器，请先安装 GCC 9+ 或 Visual Studio 2019 生成工具等，其中 GCC 可使用各种包管理器安装，Visual Studio 2019 生成工具可在 这里 最下方「所有下载」的「Visual Studio 2019 工具」中找到，安装时需要勾选「C++ 生成工具」。

Windows 上建议使用 Visual Studio 2019 生成工具。

# 代码编辑器 / IDE

可以使用 Visual Studio Code、Visual Studio 2019 或 CLion 等编辑器或 IDE 进行开发，其中 VS 2019 和 CLion 作为成熟的商业 IDE，已经有较好的图形界面提示和教程，后面将主要以 VS Code 为例。

如果还没有安装 VS Code，可前往 官网 下载安装，在左侧「Extensions」中安装 Chinese (Simplified) Language Pack、C/C++、CMake、CMake Tools。

# 下载/克隆项目模板

有三种方式下载 CoolQ C++ SDK 项目模板，任选其一即可。

# 1. 直接下载

前往 cqmoe/cqcppsdk-template，点击页面上的「Clone or download」，然后点击「Download ZIP」即可直接下载项目模板。

解压后再前往 cqmoe/cqcppsdk 用同样的方式下载并解压。

将 cqcppsdk-master 中的所有内容拷贝到 cqcppsdk-template-master\extern\cqcppsdk 内。

可选地将 cqcppsdk-template-master 改名为你想要的项目名称，如 awesome-bot。

# 2. 直接克隆

在命令行进入适当的目录，运行：

git clone https://github.com/cqmoe/cqcppsdk-template.git awesome-bot
cd awesome-bot
git submodule update --init # 初始化 Git 子模块

# 3. 先从模板创建仓库再克隆

在 cqmoe/cqcppsdk-template 点击「Use this template」，根据提示可从项目模板创建一个新的仓库，例如 yourname/awesome-bot。

然后在命令行进入适当目录，运行：

git clone https://github.com/yourname/awesome-bot.git awesome-bot
cd awesome-bot
git submodule add https://github.com/cqmoe/cqcppsdk.git extern/cqcppsdk # 添加 Git 子模块

# 构建

使用 VS Code 打开 awesome-bot 目录，按 Ctrl+Shift+P 打开命令面板，运行「CMake: 配置」命令：

选择任一工具包（Windows 上建议「Visual Studio 生成工具 2019 - x86」，其它系统建议 GCC），之后 VS Code 会开始配置 CMake，成功后会输出「Generating done」：

[cmake] -- build cqcppsdk tests: OFF
[cmake] -- can build std mode: YES
[cmake] -- cqcppsdk dir: C:/Users/Richard/Projects/cqmoe/cqcppsdk-template/extern/cqcppsdk
[cmake] -- app id: com.example.demo
[cmake] -- add std mode dll: app
[cmake] -- install destination: dev/com.example.demo
[cmake] -- add dev mode executable: app_dev
[cmake] -- Configuring done
[cmake] -- Generating done

此时 awesome-bot 目录下出现 build 目录。

再在命令面板运行「CMake: 生成」命令（或在 VS Code 底部状态栏点击生成按钮 ，默认情况下将构建所有目标，对于 Visual Studio 生成工具 x86 或 MinGW w64 i686，将会构建 app.dll 和 app_dev.exe，对于其它工具包，将会构建 app_dev（Windows 上是 app_dev.exe），生成的链接库和可执行文件在 build 目录中。

# 运行

# Dev 模式

直接在命令行运行：

./build/app_dev # 如果是 Windows 命令提示符则需要运行 .\build\app_dev

即可使用 Dev 模式测试你的机器人。

Dev 模式本质上是一个模拟的私聊窗口，输入消息内容后会产生一个「假的」私聊消息事件，触发事件处理流程；而 API 调用不会真实地发送 QQ 消息，而是在命令行输出调用的函数名和参数值。

# Std 模式

如果你正在 Windows 上使用 Visual Studio 生成工具 x86 或 MinGW w64 i686，则可在 酷Q 中真实地运行应用。

首先需要打开 酷Q 的开发模式，见 开发模式，然后将 awesome-bot 中的 app.json 和 awesome-bot/build 中的 app.dll 一同放进 酷Q 的 dev/com.example.demo 目录（需手动创建），此时 酷Q 目录结构为：

.
├── app
├── bin
├── conf
├── data
├── dev
│   └── com.example.demo
│       ├── app.dll
│       └── app.json
│
└── CQA.exe (或 CQP.exe)

再重启 酷Q 或重载应用即可在应用管理中看到 demo 应用，启用即可。

# 开发

项目模板中的演示程序核心逻辑在 src/demo.cpp，参考演示用法和后续文档即可编写你自己的 QQ 机器人了！