From 3f3d9c67ed33a745c70e77fdf3095af794fe796d Mon Sep 17 00:00:00 2001 From: Him188 Date: Sat, 16 May 2020 16:29:53 +0800 Subject: [PATCH 1/5] Update mirai.md --- docs/mirai.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/mirai.md b/docs/mirai.md index fb26e2df6..678af210a 100644 --- a/docs/mirai.md +++ b/docs/mirai.md @@ -4,10 +4,17 @@ 本文档基于 mirai 1.0-RC2-1, 最后修改时间为 2020/5/16 ## 声明 -1. mirai 为完全免费的开源项目. mirai 项目维护者和贡献者 (下文简称 '我们') 不通过任何方式收取任何费用, 也不提供任何稳定性保障. -2. mirai 不允许被用于任何违反相关法律法规的工作, 包括但不限于: 盗取账号密码, 盗窃用户资金, 群发违禁内容. 因此我们没有支持设备锁验证, 也没有支持免密登录 (在非常用地点登录会频繁要求输入验证码). -3. mirai 不提供任何可能促进上述违法行为的功能, 包括但不限于: 收发红包, 收发转账, 主动添加好友. +1. mirai 为完全免费的开源项目，使用 AGPLv3 开源协议. mirai 项目维护者和贡献者 (下文简称 '我们') 不通过任何方式收取费用。所有人都可以免费获取并使用这个项目。 +2. mirai 不允许被用于任何违反相关法律法规的工作, 包括但不限于: 盗取账号密码, 盗窃用户资金, 群发违禁内容。 因此我们没有支持设备锁验证, 也没有支持免密登录 (在非常用地点登录会频繁要求输入验证码)。 +3. mirai 不提供任何可能促进上述违法行为的功能, 包括但不限于: 收发红包, 收发转账, 主动添加好友。 4. mirai 不公开任何协议接口. 不支持任何协议扩展. +5. mirai 开发者是友善的，建立在以下前提之上： + - 我们只帮助**友善**的人 + - 我们只接受友善的**建议**，不接受任何**要求** + - **我们没有任何义务解答你的问题** + - 我们只接受友善的评价 + - 我们有权利拒绝你使用 mirai 相关服务 + ## 项目整体架构 mirai 项目整体由 核心 (`mirai-core`) 与 控制台(`mirai-console`) 组成. From a66da62a8a02ba45c57b056f83ec097d38941e0e Mon Sep 17 00:00:00 2001 From: Him188 Date: Sat, 16 May 2020 16:37:24 +0800 Subject: [PATCH 2/5] Update mirai.md --- docs/mirai.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/mirai.md b/docs/mirai.md index 678af210a..2669aed8c 100644 --- a/docs/mirai.md +++ b/docs/mirai.md @@ -84,16 +84,16 @@ mirai 全部使用 Kotlin, 若你无法理解部分 API, 可先简略阅读 Kotl 3. 接下来可按需阅读各类型消息 [各类型消息](../mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/). 一个文件包含一种消息. -4. '事件' - mirai 支持异步的事件系统. +4. '事件' + mirai 支持异步的事件系统. 1. [事件接口 Event](../mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/Event.kt) 2. [广播事件 Event.broadcast](../mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/Event.kt) 3. - Kotlin: [函数式监听事件 subscribe](../mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/subscriber.kt) - Kotlin & Java: [方法反射监听事件 JvmMethodListeners](../mirai-core/src/jvmMain/kotlin/net/mamoe/mirai/event/JvmMethodListeners.kt) 4. 内建事件列表 [README](../mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/events/README.md). **注意**: mirai 将接收到的消息事件独立放置在 `net.mamoe.mirai.message` 下, 并命名为 `MessageEvent`. 并为他们实现了一些扩展. 详见 [MessageEvent.kt](../mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/MessageEvent.kt) - 5. 事件工具类和工具函数 (仅 Kotlin) (可以跳过本节): - 标注 (*) 的几种处理方式可能需要比较好的 Kotlin 技能才能理解并正确使用. 建议在不熟悉时不要使用它们. + 5. 事件工具类和工具函数 (仅 Kotlin) (可以跳过本节): + 标注 (*) 的几种处理方式可能需要比较好的 Kotlin 技能才能理解并正确使用. 建议在不熟悉时不要使用它们. - 挂起当前协程, 直到返回下一个事件实例: [nextEvent](../mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/nextEvent.kt) - 挂起当前协程, 并从一个事件中同步一个值: [syncFromEvent](../mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/linear.kt) - (*) 消息事件监听 DSL: [subscribeMessages](../mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/subscribeMessages.kt) @@ -117,7 +117,7 @@ mirai 全部使用 Kotlin, 若你无法理解部分 API, 可先简略阅读 Kotl #### 第三方依赖 -mirai 通过 gradle `api` 方式暴露了如下依赖库: +mirai-core 通过 gradle 依赖的 `api` 方式暴露了如下依赖库: - `kotlin-stdlib`: Kotlin 标准库, 版本至少为 1.3.72 - `kotlin-reflect`: Kotlin 反射, 版本至少为 1.3.72 @@ -135,4 +135,4 @@ mirai 通过 gradle `api` 方式暴露了如下依赖库: `mirai-core` 的实现部分. 不提供任何说明. 使用者无需考虑任何协议实现过程. ## `mirai-console` -此模块处于实验性阶段, 可能没有很好地文档支持, 详见 [mirai-console](https://github.com/mamoe/mirai-console) +控制台框架。此模块处于实验性阶段, 可能没有很好地文档支持, 详见 [mirai-console](https://github.com/mamoe/mirai-console) From dee740cd24432a79d160835ae56ac954421cdc5d Mon Sep 17 00:00:00 2001 From: Him188 Date: Sat, 16 May 2020 20:35:46 +0800 Subject: [PATCH 3/5] Update CHANGELOG.md --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index d32363809..c0b586db7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,8 @@ # Version 1.x ## `1.0-RC2` 2020/5/11 +**(请使用 `1.0-RC2-1` 版本)** + 主要内容: - 增强网络稳定性 (#298, #317), 修复 `Bot.close` 或 Bot 离线后没有从 `Bot.botInstances` 中删除的问题 (#317) - `subscribeMessages` 现在默认使用 `MONITOR` 优先级 From d5bba2aca4046e3accd7420c2eeace77cb18ce53 Mon Sep 17 00:00:00 2001 From: Him188 Date: Sat, 16 May 2020 20:36:41 +0800 Subject: [PATCH 4/5] Update CHANGELOG.md --- CHANGELOG.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c0b586db7..f4c0d57da 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,9 @@ # Version 1.x -## `1.0-RC2` 2020/5/11 -**(请使用 `1.0-RC2-1` 版本)** +## `1.0-RC2-1` 2020/5/11 +修复一个 `VerifyError` +## `1.0-RC2` 2020/5/11 主要内容: - 增强网络稳定性 (#298, #317), 修复 `Bot.close` 或 Bot 离线后没有从 `Bot.botInstances` 中删除的问题 (#317) - `subscribeMessages` 现在默认使用 `MONITOR` 优先级 From e440e7412a6da20fea7860d53bcc0cee5c03e921 Mon Sep 17 00:00:00 2001 From: Him188 Date: Tue, 19 May 2020 13:00:42 +0800 Subject: [PATCH 5/5] Update mirai.md --- docs/mirai.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/mirai.md b/docs/mirai.md index 2669aed8c..6b04124f5 100644 --- a/docs/mirai.md +++ b/docs/mirai.md @@ -56,8 +56,12 @@ mirai 项目整体由 核心 (`mirai-core`) 与 控制台(`mirai-console`) 组 要能看懂下文, 建议至少学习 Java, Kotlin 或 C# 其中一门语言. mirai 全部使用 Kotlin, 若你无法理解部分 API, 可先简略阅读 Kotlin 参考: [kotlincn.net](https://www.kotlincn.net/docs/reference/) -有关协程 (`suspend`)部分, mirai 做了大量的兼容性转换以让 Java 使用相同的 API 阻塞地调用一个协程函数. -因此, 对于函数如 `suspend fun sendMessage(Message)`, Java 使用者也可以直接调用它. + +有关协程 (`suspend` 修饰符)部分, mirai 做了大量的兼容性转换以让 Java 使用相同的 API 阻塞地调用一个协程函数。 +对于 Kotlin 函数如 `suspend fun sendMessage(msg: Message)`, +Kotlin 编译后生成 Java 方法 `public Object sendMessage(Message msg, Continuation cont)` +Mirai 通过某种方式同时生成了桥梁方法 `public void sendMessage(Message msg)` 使得 Java 使用者可无缝接入。 + ### 开始