mirror of
https://github.com/mamoe/mirai.git
synced 2025-01-27 17:00:14 +08:00
Update module descriptions
This commit is contained in:
parent
e2e68b091b
commit
d993dff499
20
CHANGELOG.md
20
CHANGELOG.md
@ -1,5 +1,23 @@
|
|||||||
# Version 1.x
|
# Version 1.x
|
||||||
|
|
||||||
|
## `1.1-EA` 2020/6/16
|
||||||
|
** 1.1.0 Early Access** / ** 1.1.0 预览版 **
|
||||||
|
** 此版本新增的 API 可能不稳定, 且可能在下一个版本中删除. **
|
||||||
|
|
||||||
|
**主要**:
|
||||||
|
- 支持 mirai 码解析, 添加 [mirai 码规范](docs\mirai-code-specification.md)
|
||||||
|
- 新模块 `mirai-serialization`
|
||||||
|
|
||||||
|
**不兼容变更**:
|
||||||
|
- 将 `PttMessage` 与 `Voice` 标注 `@MiraiExperimentalAPI` (missing)
|
||||||
|
|
||||||
|
**优化**:
|
||||||
|
|
||||||
|
- 删除 `Message.plus(another: Flow<Message>)` 的 `@ExperimentalCoroutinesApi`
|
||||||
|
- 提升发送群消息的稳定性
|
||||||
|
- 分离一些公开 API 与内部实现
|
||||||
|
- 其他内部优化
|
||||||
|
|
||||||
## `1.0.2` 2020/6/1
|
## `1.0.2` 2020/6/1
|
||||||
- 新增 `Bot.botInstancesSequence`
|
- 新增 `Bot.botInstancesSequence`
|
||||||
- 修复日志中的时间未更新的问题
|
- 修复日志中的时间未更新的问题
|
||||||
@ -20,7 +38,7 @@
|
|||||||
## `1.0.0` 2020/5/22
|
## `1.0.0` 2020/5/22
|
||||||
|
|
||||||
- `ContactOrBot` 现在继承 `CoroutineScope`
|
- `ContactOrBot` 现在继承 `CoroutineScope`
|
||||||
- 在没有手动指定 `deviceInfo` 时构建 Bot 将会发出警告, 须手动选择使用 `randomDeviceInfo` 或 `fileBasedDeviceInfo` 或自定义, 详见 [BotConfiguration.kt: Lines 69-72](mirai-core/src/commonMain/kotlin/net.mamoe.mirai/utils/BotConfiguration.kt#L69-L72)
|
- 在没有手动指定 `deviceInfo` 时构建 Bot 将会发出警告, 须手动选择使用 `randomDeviceInfo` 或 `fileBasedDeviceInfo` 或自定义, 详见 [BotConfiguration.kt: Lines 69-72](mirai-core/src/commonMain/kotlin/net.mamoe.mirai/utils/BotConfiguration.common.kt#L69-L72)
|
||||||
<br />
|
<br />
|
||||||
|
|
||||||
- 引入 `SimpleListenerHost` 以帮助 Java 处理事件监听
|
- 引入 `SimpleListenerHost` 以帮助 Java 处理事件监听
|
||||||
|
@ -6,6 +6,8 @@
|
|||||||
mirai 的部分 [消息](../mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/Message.kt) 可以表示为形如 `[mirai:atall]` 的字符串.
|
mirai 的部分 [消息](../mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/Message.kt) 可以表示为形如 `[mirai:atall]` 的字符串.
|
||||||
模块 `mirai-core` 包含消息到 mirai 码的单向转换; 模块 `mirai-serialization` 提供 mirai 码的解析.
|
模块 `mirai-core` 包含消息到 mirai 码的单向转换; 模块 `mirai-serialization` 提供 mirai 码的解析.
|
||||||
|
|
||||||
|
运行时: [mirai-serialization](../mirai-serialization/)
|
||||||
|
|
||||||
## 变更记录
|
## 变更记录
|
||||||
- `1.1.0`: 引入 mirai 码于 `mirai-serialization` 模块
|
- `1.1.0`: 引入 mirai 码于 `mirai-serialization` 模块
|
||||||
|
|
||||||
|
@ -29,6 +29,8 @@ mirai 项目整体由 核心 (`mirai-core`) 与 控制台(`mirai-console`) 组
|
|||||||
|
|
||||||
- `mirai-core-qqandroid` 继承 `mirai-core`, 是 Android QQ 协议的实现. 在使用时只需参考 `mirai-core` 的 API.
|
- `mirai-core-qqandroid` 继承 `mirai-core`, 是 Android QQ 协议的实现. 在使用时只需参考 `mirai-core` 的 API.
|
||||||
|
|
||||||
|
- `mirai-serialization` 依赖 `mirai-core`, 是 mirai-core 的序列化支持模块. 提供 `Message` 类型的序列化支持与相关 [mirai 码](mirai-code-specification.md) 支持.
|
||||||
|
此模块自 mirai `1.1.0` 起可用, 引用方法同 `mirai-core`.
|
||||||
|
|
||||||
- [`mirai-console`](https://github.com/mamoe/mirai-console) 是基于 `mirai-core` 的, 支持插件加载, 指令系统, 和配置等的**控制台框架**.
|
- [`mirai-console`](https://github.com/mamoe/mirai-console) 是基于 `mirai-core` 的, 支持插件加载, 指令系统, 和配置等的**控制台框架**.
|
||||||
**注意: 此模块正在重写, 短时间内不可用**
|
**注意: 此模块正在重写, 短时间内不可用**
|
||||||
@ -107,7 +109,7 @@ Mirai 通过某种方式同时生成了桥梁方法 `public void sendMessage(Mes
|
|||||||
<br><br>
|
<br><br>
|
||||||
一切准备就绪. 现在开始构造 `Bot` 实例:
|
一切准备就绪. 现在开始构造 `Bot` 实例:
|
||||||
|
|
||||||
1. `Bot` 的配置: [BotConfiguration](../mirai-core/src/commonMain/kotlin/net.mamoe.mirai/utils/BotConfiguration.kt)
|
1. `Bot` 的配置: [BotConfiguration](../mirai-core/src/commonMain/kotlin/net.mamoe.mirai/utils/BotConfiguration.common.kt)
|
||||||
可大致了解或跳过. 一般使用默认属性即可.
|
可大致了解或跳过. 一般使用默认属性即可.
|
||||||
2. 构造 `Bot` 实例: [BotFactory](../mirai-core/src/jvmMain/kotlin/net/mamoe/mirai/BotFactory.kt#L23), [newBot](../mirai-core/src/jvmMain/kotlin/net/mamoe/mirai/BotFactory.kt#L53)
|
2. 构造 `Bot` 实例: [BotFactory](../mirai-core/src/jvmMain/kotlin/net/mamoe/mirai/BotFactory.kt#L23), [newBot](../mirai-core/src/jvmMain/kotlin/net/mamoe/mirai/BotFactory.kt#L53)
|
||||||
|
|
||||||
|
@ -1,7 +1,10 @@
|
|||||||
# mirai-core
|
# mirai-core
|
||||||
Mirai 的核心部分. 含核心框架和协议.
|
|
||||||
|
|
||||||
Mirai 为多协议设计, `mirai-core` 只提供基础框架和抽象数据类. 具体的各协议实现为 `mirai-core-PROTOCOL`.
|
mirai 的核心公开 API.
|
||||||
这些模块都继承自 `mirai-core`.
|
|
||||||
|
mirai 为多协议设计, `mirai-core` 只提供基础框架和抽象数据类.
|
||||||
|
具体的各协议实现为 `mirai-core-PROTOCOL`, 这些协议模块都继承自 `mirai-core`.
|
||||||
|
|
||||||
|
可用的协议模块:
|
||||||
|
- [`mirai-core-qqandroid`](../mirai-core-qqandroid): Android QQ 8.3.0 版本协议实现.
|
||||||
|
|
||||||
每个模块均有相较于 `mirai-core` 额外提供的内容的介绍.
|
|
Loading…
Reference in New Issue
Block a user