更新文档

Author: cyanray

README.md

@@ -18,33 +18,55 @@
 
 ## 项目文档
 
-[使用说明](doc/使用说明.md)
+项目文档: [使用说明](doc/使用说明.md)
+
+更加推荐阅读完 examples 后，“按照直觉” 来使用 mirai-cpp。
+
+| 文件名               | 说明                         |
+|----------------------|------------------------------|
+| RepeatMessage.cpp    | 简单的复读机器人             |
+| SendImageMessage.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、闪照等类型的消息  |
 
 ## 如何使用
 
 ### 1. 快速尝试
 
-1. 使用 Visual Studio
+#### (1) 使用 Visual Studio
 
-完整克隆/下载本仓库。
+> 1. 完整克隆/下载本仓库。
 
-如图所示，使用 Visual Studio 2019 直接打开这个文件夹。
+> 2. 如图所示，使用 Visual Studio 2019 直接打开这个文件夹。
 
-![使用 VS 直接打开 mirai-cpp 文件夹](./doc/pic/vs_1.png)
+> 3. 如果一切顺利，你可以直接运行我写好的示例，或者进行修改编写自己的机器人。
+
+<details>
 
-如果一切顺利，你可以直接运行我写好的示例，或者进行修改编写自己的机器人。
+![使用 VS 直接打开 mirai-cpp 文件夹](./doc/pic/vs_1.png)
 
 ![开始运行 examples](./doc/pic/vs_2.png)
 
-2. 使用 Visual Studio Code
+</details>
 
-完整克隆/下载本仓库。
+#### (2) 使用 Visual Studio Code
 
-使用 VS Code 直接打开这个文件夹。
+> 1. 完整克隆/下载本仓库。
 
-安装 CMake Tools 扩展。
+> 2. 使用 VS Code 直接打开这个文件夹。
 
-直接开始调试: 
+> 3. 安装 CMake Tools 扩展。
+
+> 4. 直接开始调试
 
 ![vsc 开始调试](./doc/pic/vsc.png)
 
@@ -53,15 +75,14 @@
 
 #### (1) 将程序轻松移植、部署到 Linux 上
 
+<details>
 
 (以下内容基于 “快速尝试”，请先完成“快速尝试”。)
 
 上面的内容介绍了如何在 Windows 上开发使用 mirai-cpp 的程序，下面来介绍如何将你的程序移植到 Linux 平台，以便将程序部署到 Linux 服务器上。
 
 为了易于讲解与操作，以下内容在 **WSL** (**W**indows **S**ubsystem for **L**inux) 上进行。这里不对如何安装 WSL 进行说明，关于如何安装 WSL 还请自行查阅资料。
 
-1. 创建针对 WSL 的配置
-
 打开在 “快速尝试” 中用到的项目。按照如图所示步骤，创建一个针对 WSL 平台的配置。因为我的 WSL 安装了 GCC 编译器，所以这里选择 **WSL-GCC-Releas**。
 
 ![创建WSL-GCC平台配置1](./doc/pic/vs_3.png)
@@ -70,6 +91,7 @@
 
 如果一切顺利，等待 CMake 缓存生成成功后，即可编译出 Linux 平台的可执行文件。
 
+</details>
 
 #### (2) 使用 CMake-GUI 编译
 

doc/使用说明.md

@@ -115,7 +115,13 @@ bot.On<NewFriendRequestEvent>([&](NewFriendRequestEvent e)
 bot.EventLoop();
 ```
 
-bot.EventLoop() 方法会阻塞当前线程，内含死循环不断轮询新的事件。该方法不会抛出异常。(因为抛出异常会打断死循环，所以在循环里面会捕捉异常并在 cerr 输出，不知道有没有更优雅的解决方法)
+bot.EventLoop() 方法会阻塞当前线程，内含死循环不断轮询新的事件。该方法不会抛出异常，如果有错误默认会在 cerr 输出。
+
+如果希望自定义 EventLoop 处理错误信息的方式，可以尝试这样写：
+
+```C++
+bot.EventLoop([](const char* errMsg){/*...*/ });
+```
 
 # 如何发送消息、引用回复、撤回消息
 
@@ -159,6 +165,9 @@ void GroupMsgProcessor(GroupMessage m)
     // 直接撤回
     m.Recall();
     // bot.Recall(m.GetMessageId());
+
+    // 判断有没有 At 我 (仅限 GroupMessage)
+    m.AtMe()
 }
 
 // 定义好消息处理函数后，不要忘了将它与事件绑定起来
@@ -185,9 +194,11 @@ MessageChain msg = MessageChain()
                     .AtAll();
 ```
 
-## 获得 ImageId
+## 获得 ImageId 以发送图片
+
+使用 UploadFriendImage 、UploadGroupImage 、 UploadTempImage 方法上传图片，其返回值分别为 FriendImage 、 GroupImage 、TempImage 类型的图片。(FriendImage 、 GroupImage 、TempImage 都是 MiraiImage 的别称)
 
-使用 UploadFriendImage 、UploadGroupImage 、 UploadTempImage 方法上传图片，其返回值分别为 FriendImage 、 GroupImage 、TempImage 类型的图片。(之所以分成三个类型是因为它们的 ID 格式不一样)
+> 注意: 三种图片的 ID 的格式互不相同，所有不要将各类型的图片混用，比如将 FriendImage 发送给某个群组。虽然 mirai-cpp 没有限制你这样做，但是这一定达不到预期的结果，并且很可能会引发异常。
 
 ```C++
 GroupImage img = UploadGroupImage("D:\\test.png");
@@ -216,7 +227,14 @@ string msg_str = msg.GetPlainText();
 
 ## 获取其他消息类型的内容
 
-还没写相关的 API...
+MessageChain 提供了 GetXXX 的方法，其中 XXX 为消息类型，作用是获得所有该类型的消息，储存在 vector 中。
+
+| 方法签名                            | 说明                                            |
+|-------------------------------------|-------------------------------------------------|
+| vector<string> GetPlain() const     | 获取所有 Plain 类型消息                         |
+| vector<MiraiImage> GetImage() const | 获取所有 Image、FlashImage 类型消息(图片和闪照) |
+| vector<QQ_t> GetAt() const          | 获取所有 At 类型消息                            |
+| vector<int> GetFace() const         | 获取所有 Face 类型消息                          |
 
 ## 其他函数
 
@@ -228,8 +246,32 @@ GetTimestamp 方法可以获得这条消息的时间戳(类型为 int64_t )。
 
 建议参考 /examples 的源代码，其中的 examples 会随着 mirai-cpp 的更新而更新。
 
+(强烈建议将 examples 都阅读一遍，因为精力关系我没能把所有函数都写在文档上)
+
+| 文件名               | 说明                         |
+|----------------------|------------------------------|
+| RepeatMessage.cpp    | 简单的复读机器人             |
+| SendImageMessage.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、闪照等类型的消息  |
+
+
 # 关于异常
 
 MiraiBot 中的方法几乎都会抛出异常，建议捕捉起来。
 
-EventLoop 方法不会抛出异常，因为一些原因，它会捕捉异常，并在 cerr 中输出。(这是因为我不知道如何优雅地处理这里抛出的异常。如果你不希望输出，除了直接修改源码外暂时没有其他办法，如果有好的处理方法可以提交 issues 让我修改)
+EventLoop 方法不会抛出异常，它会捕捉异常，并在 cerr 中输出。
+如果希望自定义 EventLoop 处理错误信息的方式，可以尝试这样写：
+
+```C++
+bot.EventLoop([](const char* errMsg){/*...*/ });
+```