diff --git a/README.md b/README.md index e12e62bd0..77f89cc3e 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ title ---- -Mirai 是一个在全平台下运行,提供 QQ Android 和 TIM PC 协议支持的高效率机器人库 +Mirai 是一个在全平台下运行,提供 QQ 协议支持的高效率机器人库 这个项目的名字来源于

京都动画作品《境界的彼方》栗山未来(Kuriyama Mirai)

@@ -13,17 +13,24 @@ Mirai 是一个在全平台下运行,提供 QQ Android 和 TIM PC 协议支持 图标以及形象由画师DazeCake绘制 - # mirai-console +[ ![Download](https://api.bintray.com/packages/him188moe/mirai/mirai-console/images/download.svg?) ](https://bintray.com/him188moe/mirai/mirai-console/) + 高效率插件支持 QQ 机器人框架, 机器人核心来自 [mirai](https://github.com/mamoe/mirai) ## 模块说明 console 由后端和前端一起工作. 使用时必须选择一个前端. -- `mirai-console`: console 的后端, 包含插件管理, 指令系统, 配置系统. 还包含一个轻量命令行的前端 (因此可以独立启动 `mirai-console`). -- `mirai-console-graphical`: console 的 JavaFX 图形化界面前端. -- `mirai-console-terminal`: console 的 Unix 终端界面前端. (实验性) +- `mirai-console`: console 的后端, 包含插件管理, 指令系统, 配置系统. + + + +前端: + +- `mirai-console-pure`: console 的轻量命令行前端. +- `mirai-console-graphical`: console 的 JavaFX 图形化界面前端. (开发中) +- `mirai-console-terminal`: console 的 Unix 终端界面前端. (开发中) **注意:`mirai-console` 后端和 pure 前端正在进行完全的重构** @@ -33,12 +40,35 @@ console 由后端和前端一起工作. 使用时必须选择一个前端. - [x] `1.0-M2`: API 优化; Java 调用支持 - [ ] `1.0-M3`: Java 实现支持; 文档补全 +### 使用 + +#### Gradle +`CORE_VERSION`: [ ![Download](https://api.bintray.com/packages/him188moe/mirai/mirai-core/images/download.svg?) ](https://bintray.com/him188moe/mirai/mirai-core/) +`CONSOLE_VERSION`: [ ![Download](https://api.bintray.com/packages/him188moe/mirai/mirai-console/images/download.svg?) ](https://bintray.com/him188moe/mirai/mirai-console/) + + +build.gradle.kts +```kotlin +repositories { + jcenter() +} + +dependencies { + implementation("net.mamoe:mirai-core:$CORE_VERSION") // mirai-core 的 API + implementation("net.mamoe:mirai-console:$CONSOLE_VERSION") // 后端 + + testImplementation("net.mamoe:mirai-console-pure:$CONSOLE_VERSION") // 前端, 用于启动测试 +} +``` + +#### Maven +同理 Gradle, 添加依赖即可 ### 插件开发与获取 -mirai-console 支持 Jar 插件. +mirai-console 原生支持 Jar 插件, 可由插件扩展支持其他语言的插件. **mirai-console 目前仍为实验性阶段, 任何功能和 API 都不保证稳定性. 任何 API 都可能在没有警告的情况下修改.** -(实验性) [插件中心](https://github.com/mamoe/mirai-plugins) -[mirai-console插件开发快速上手](PluginDocs/ToStart.MD) +(实验性) [插件中心 ](https://github.com/mamoe/mirai-plugins) +[mirai-console插件开发快速上手 (已过期)](PluginDocs/ToStart.MD)