# mirai-cpp

**Repository Path**: iclound/mirai-cpp

## Basic Information

- **Project Name**: mirai-cpp
- **Description**: No description available
- **Primary Language**: C++
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-05-12
- **Last Updated**: 2021-05-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mirai-cpp

![Build](https://github.com/cyanray/mirai-cpp/workflows/Build/badge.svg)

## 0x01 项目简介

[mirai](https://github.com/mamoe/mirai) 是全开源 QQ 机器人 / QQ 协议支持库。(使用Kotlin编写)

[mirai-api-http](https://github.com/project-mirai/mirai-api-http) 提供一系列 HTTP API 以便其他语言使用 mirai。

本项目为 mirai-api-http 的 C++ 封装，方便使用 C++ 开发基于 mirai-api-http 的插件。

在使用 mirai-cpp 和基于 mirai-cpp 的插件之前，你需要配置好 [mirai-console](https://github.com/mamoe/mirai-console) 并且安装 [mirai-api-http](https://github.com/project-mirai/mirai-api-http) 插件。

## 0x02 项目文档

> 推荐浏览顺序：使用说明 --> examples --> mirai_bot.hpp 的注释

使用说明: [使用说明](doc/使用说明.md)

对于刚入门的 C++ 用户，推荐从 [mirai-cpp-template](https://github.com/cyanray/mirai-cpp-template) 这个模板项目开始编写自己的程序。

对于 C++ 大佬，可以参考 [mirai-cpp-template](https://github.com/cyanray/mirai-cpp-template) 这个模板项目的 CMakeLists.txt 了解使用方法。（所以我就不写这部分的内容了，手动狗头）

推荐阅读 examples 目录下的示例以了解使用方法。

| 文件名                | 说明                         |
|----------------------|------------------------------|
| RepeatMessage.cpp    | 简单的复读机器人             |
| SendImageMessage.cpp | 发送图片示例                 |
| VoiceMessage.cpp     | 发送语音消息示例              |
| BotEvents.cpp        | 处理有关Bot相关的事件        |
| GetFriendList.cpp    | 打印Bot的好友列表            |
| GetGroupList.cpp     | 打印Bot的群组列表            |
| MemberJoinEvent.cpp  | 处理新成员加入群的申请和事件 |
| MemberLeaveEvent.cpp | 处理成员退出群的事件         |
| MessageType.cpp      | 获取/处理各种类型的消息      |
| NewFriendEvent.cpp   | 处理好友申请                 |
| Recall.cpp           | 撤回消息                   |
| RecallEvent.cpp      | 处理其他人撤回消息的事件     |
| Mute.cpp             | 和禁言有关的操作             |
| RichMessage.cpp      | 发送 JSON、闪照等类型的消息  |
| FetchEventsViaHTTP.cpp| 设置通过 HTTP 短轮询获取事件和消息 |
| GroupMemberInfo.cpp  | 获取/设置群成员的群名片与群头衔 |
| Command.cpp          | 指令系统相关的操作           |
| NudgeEvent.cpp       | 戳一戳事件和发送相关的操作    |

## 0x03 如何使用

### 1. 快速尝试 (运行 examples、参与开发)

#### (1) 使用 Visual Studio

1. 完整克隆/下载本仓库。

2. 如图所示，使用 Visual Studio 2019 直接打开这个文件夹。

3. 如果一切顺利，你可以直接运行我写好的示例，或者进行修改编写自己的机器人。

<details>

![使用 VS 直接打开 mirai-cpp 文件夹](./doc/pic/vs_1.png)

![项目配置](./doc/pic/vs_3.png)

![勾上 MIRAI_CPP_BUILD_EXAMPLES](./doc/pic/vs_4.png)

![开始运行 examples](./doc/pic/vs_2.png)

</details>

#### (2) 使用 Visual Studio Code

1. 完整克隆/下载本仓库。

2. 使用 VS Code 直接打开这个文件夹。

3. 安装 CMake Tools 扩展。

4. 如图，可以直接开始调试

![vsc 开始调试](./doc/pic/vsc.png)

### **2. 创建自己的机器人项目**

#### (1) 使用 CMake Project 模板

具体参考 [mirai-cpp-template](https://github.com/cyanray/mirai-cpp-template) 的说明。

#### (2) 在 Visual Studio 项目中使用 (VS 解决方案, sln)

// TODO: 编写如何在 Visual Studio 解决方案中使用 mirai-cpp

### 3. 其他使用方式

#### (1) 将程序移植、部署到 Linux 上

<details>

(以下内容基于 “快速尝试”，请先完成“快速尝试”。)

上面的内容介绍了如何在 Windows 上开发使用 mirai-cpp 的程序，下面来介绍如何将你的程序移植到 Linux 平台，以便将程序部署到 Linux 服务器上。

为了易于讲解与操作，以下内容在 **WSL** (**W**indows **S**ubsystem for **L**inux) 上进行。这里不对如何安装 WSL 进行说明，关于如何安装 WSL 还请自行查阅资料。

打开在 “快速尝试” 中用到的项目。按照如图所示步骤，创建一个针对 WSL 平台的配置。因为我的 WSL 安装了 GCC 编译器，所以这里选择 **WSL-GCC-Releas**。

![创建WSL-GCC平台配置1](./doc/pic/vs_3.png)

![创建WSL-GCC平台配置2](./doc/pic/vs_configure_linux_project.png)

如果一切顺利，等待 CMake 缓存生成成功后，即可编译出 Linux 平台的可执行文件。

</details>

#### (2) 使用 vcpkg 安装 mirai-cpp

要使用 vcpkg 管理 mirai-cpp，你需要将 [https://github.com/cyanray/mirai-cpp-vcpkg-port](https://github.com/cyanray/mirai-cpp-vcpkg-port) 中的 **mirai-cpp** 文件夹复制到 vcpkg 安装目录下的 **ports** 文件夹中。

然后就可以使用 `./vcpkg install mirai-cpp:x86-windows mirai-cpp:x64-windows` 安装 mirai-cpp。


## 0x04 项目依赖

> 本项目所有依赖都为 Header-Only 库，已经内置到本项目的 mirai-third-party 文件夹中。

1. [**yhirose/cpp-httplib**](https://github.com/yhirose/cpp-httplib) A C++ header-only HTTP/HTTPS server and client library.

2. [**nlohmann/json**](https://github.com/nlohmann/json) JSON for Modern C++.

3. [**progschj/ThreadPool**](https://github.com/progschj/ThreadPool) A simple C++11 Thread Pool implementation.

4. [**cyanray/LightWebSocketClient**](https://github.com/cyanray/LightWebSocketClient) A simple cross-platform WebSocket client.

## 0x05 参与开发

mirai-cpp 目前还有许多不足，欢迎提出 issues 或 pull requests。

## 0x06 以下项目正在使用 mirai-cpp

> 如果你愿意分享你开发的程序，欢迎提出 issues 或 pull requests 在下方分享你的程序

1. [MocliaMusic](https://github.com/Moclia-Developer-Team/MocliaMusic) : 基于Mirai-Api-Http和Mirai-cpp的点歌项目