github-repos/mirai
1
0
Fork 0
mirror of https://github.com/mamoe/mirai.git synced 2025-01-30 10:50:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/master'

Browse Source
This commit is contained in:
Him188 2020-05-19 19:29:41 +08:00
commit 2ba31871e7
2 changed files with 25 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@ -1,5 +1,8 @@
# Version 1.x # Version 1.x
## `1.0-RC2-1` 2020/5/11
修复一个 `VerifyError`
## `1.0-RC2` 2020/5/11 ## `1.0-RC2` 2020/5/11
主要内容: 主要内容:
- 增强网络稳定性 (#298, #317), 修复 `Bot.close` 或 Bot 离线后没有从 `Bot.botInstances` 中删除的问题 (#317) - 增强网络稳定性 (#298, #317), 修复 `Bot.close` 或 Bot 离线后没有从 `Bot.botInstances` 中删除的问题 (#317)

25
docs/mirai.md
View File

@ -4,10 +4,17 @@
本文档基于 mirai 1.0-RC2-1, 最后修改时间为 2020/5/16 本文档基于 mirai 1.0-RC2-1, 最后修改时间为 2020/5/16
## 声明 ## 声明
1. mirai 为完全免费的开源项目. mirai 项目维护者和贡献者 (下文简称 '我们') 不通过任何方式收取任何费用, 也不提供任何稳定性保障. 1. mirai 为完全免费的开源项目，使用 AGPLv3 开源协议. mirai 项目维护者和贡献者 (下文简称 '我们') 不通过任何方式收取费用。所有人都可以免费获取并使用这个项目。
2. mirai 不允许被用于任何违反相关法律法规的工作, 包括但不限于: 盗取账号密码, 盗窃用户资金, 群发违禁内容. 因此我们没有支持设备锁验证, 也没有支持免密登录 (在非常用地点登录会频繁要求输入验证码). 2. mirai 不允许被用于任何违反相关法律法规的工作, 包括但不限于: 盗取账号密码, 盗窃用户资金, 群发违禁内容。 因此我们没有支持设备锁验证, 也没有支持免密登录 (在非常用地点登录会频繁要求输入验证码)。
3. mirai 不提供任何可能促进上述违法行为的功能, 包括但不限于: 收发红包, 收发转账, 主动添加好友. 3. mirai 不提供任何可能促进上述违法行为的功能, 包括但不限于: 收发红包, 收发转账, 主动添加好友。
4. mirai 不公开任何协议接口. 不支持任何协议扩展. 4. mirai 不公开任何协议接口. 不支持任何协议扩展.
5. mirai 开发者是友善的，建立在以下前提之上：
- 我们只帮助**友善**的人
- 我们只接受友善的**建议**，不接受任何**要求**
- **我们没有任何义务解答你的问题**
- 我们只接受友善的评价
- 我们有权利拒绝你使用 mirai 相关服务
## 项目整体架构 ## 项目整体架构
mirai 项目整体由 核心 (`mirai-core`) 与 控制台(`mirai-console`) 组成. mirai 项目整体由 核心 (`mirai-core`) 与 控制台(`mirai-console`) 组成.
@ -49,8 +56,12 @@ mirai 项目整体由 核心 (`mirai-core`) 与 控制台(`mirai-console`) 组
要能看懂下文, 建议至少学习 Java, Kotlin 或 C# 其中一门语言. 要能看懂下文, 建议至少学习 Java, Kotlin 或 C# 其中一门语言.
mirai 全部使用 Kotlin, 若你无法理解部分 API, 可先简略阅读 Kotlin 参考: [kotlincn.net](https://www.kotlincn.net/docs/reference/) 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<Unit> cont)`
Mirai 通过某种方式同时生成了桥梁方法 `public void sendMessage(Message msg)` 使得 Java 使用者可无缝接入。
### 开始 ### 开始
@ -110,7 +121,7 @@ mirai 全部使用 Kotlin, 若你无法理解部分 API, 可先简略阅读 Kotl
#### 第三方依赖 #### 第三方依赖
mirai 通过 gradle `api` 方式暴露了如下依赖库: mirai-core 通过 gradle 依赖的 `api` 方式暴露了如下依赖库:
- `kotlin-stdlib`: Kotlin 标准库, 版本至少为 1.3.72 - `kotlin-stdlib`: Kotlin 标准库, 版本至少为 1.3.72
- `kotlin-reflect`: Kotlin 反射, 版本至少为 1.3.72 - `kotlin-reflect`: Kotlin 反射, 版本至少为 1.3.72
@ -128,4 +139,4 @@ mirai 通过 gradle `api` 方式暴露了如下依赖库:
`mirai-core` 的实现部分. 不提供任何说明. 使用者无需考虑任何协议实现过程. `mirai-core` 的实现部分. 不提供任何说明. 使用者无需考虑任何协议实现过程.
## `mirai-console` ## `mirai-console`
此模块处于实验性阶段, 可能没有很好地文档支持, 详见 [mirai-console](https://github.com/mamoe/mirai-console) 控制台框架。此模块处于实验性阶段, 可能没有很好地文档支持, 详见 [mirai-console](https://github.com/mamoe/mirai-console)