|
|
@@ -1,7 +1,7 @@
|
|
|
# mirai
|
|
|
欢迎来到 mirai 文档.
|
|
|
|
|
|
-本文档基于 mirai 1.0.0, 最后修改时间为 2020/5/11
|
|
|
+本文档基于 mirai 1.0-RC2-1, 最后修改时间为 2020/5/16
|
|
|
|
|
|
## 声明
|
|
|
1. mirai 为完全免费的开源项目. mirai 项目维护者和贡献者 (下文简称 '我们') 不通过任何方式收取任何费用, 也不提供任何稳定性保障.
|
|
|
@@ -24,6 +24,7 @@ mirai 项目整体由 核心 (`mirai-core`) 与 控制台(`mirai-console`) 组
|
|
|
|
|
|
|
|
|
- [`mirai-console`](https://github.com/mamoe/mirai-console) 是基于 `mirai-core` 的, 支持插件加载, 指令系统, 和配置等的**控制台框架**.
|
|
|
+ **注意: 此模块正在重写, 短时间内可能不可用**
|
|
|
console 由 '后端' 和 '前端' 组成.
|
|
|
`mirai-console` 即为后端, 包含所有开发时需要用到的功能.
|
|
|
可用的前端:
|
|
|
@@ -107,6 +108,22 @@ mirai 全部使用 Kotlin, 若你无法理解部分 API, 可先简略阅读 Kotl
|
|
|
使用 mirai 作为一个依赖库: 阅读 [Quick Start](../docs/guide_quick_start.md) 配置依赖.
|
|
|
使用 mirai 作为控制台框架: 使用 [mirai-console](https://github.com/mamoe/mirai-console) 开发插件
|
|
|
|
|
|
+#### 第三方依赖
|
|
|
+
|
|
|
+mirai 通过 gradle `api` 方式暴露了如下依赖库:
|
|
|
+
|
|
|
+- `kotlin-stdlib`: Kotlin 标准库, 版本至少为 1.3.72
|
|
|
+- `kotlin-reflect`: Kotlin 反射, 版本至少为 1.3.72
|
|
|
+- `kotlinx-coroutines-core`: Kotlin 协程, 版本至少为 1.3.5
|
|
|
+- `kotlinx-serialization-runtime`: Kotlin 序列化运行时, 和 JSON 序列化, 版本至少为 0.20.0
|
|
|
+- `kotlinx-serialization-protobuf`: Kotlin ProtocolBuffers 序列化, 版本至少为 0.20.0
|
|
|
+- `kotlinx-io`: Kotlin IO, 版本至少为 0.1.16 (此库非常不稳定, 不建议使用它)
|
|
|
+- `kotlinx-coroutines-io`: Kotlin 异步 IO, 版本至少为 0.1.16 (此库非常不稳定, 不建议使用它)
|
|
|
+- `kotlinx-atomicfu`: Kotlin 原子操作, 版本至少为 0.14.2
|
|
|
+- `ktor-client-core`, `ktor-network`, `ktor-client-cio`: Ktor HTTP
|
|
|
+
|
|
|
+在 JVM, mirai 使用 `"org.bouncycastle:bcprov-jdk15on:1.64"` 进行密匙计算.
|
|
|
+
|
|
|
## `mirai-core-qqandroid`
|
|
|
`mirai-core` 的实现部分. 不提供任何说明. 使用者无需考虑任何协议实现过程.
|
|
|
|
Him188