mirai/README.md

45 lines
2.0 KiB
Markdown
Raw Normal View History

2020-05-12 16:17:25 +08:00
<div align="center">
<img width="160" src="http://img.mamoe.net/2020/02/16/a759783b42f72.png" alt="logo"></br>
<img width="95" src="http://img.mamoe.net/2020/02/16/c4aece361224d.png" alt="title">
----
Mirai 是一个在全平台下运行,提供 QQ Android 和 TIM PC 协议支持的高效率机器人库
这个项目的名字来源于
<p><a href = "http://www.kyotoanimation.co.jp/">京都动画</a>作品<a href = "https://zh.moegirl.org/zh-hans/%E5%A2%83%E7%95%8C%E7%9A%84%E5%BD%BC%E6%96%B9">《境界的彼方》</a><a href = "https://zh.moegirl.org/zh-hans/%E6%A0%97%E5%B1%B1%E6%9C%AA%E6%9D%A5">栗山未来(Kuriyama <b>Mirai</b>)</a></p>
<p><a href = "https://www.crypton.co.jp/">CRYPTON</a><a href = "https://www.crypton.co.jp/miku_eng">初音未来</a>为代表的创作与活动<a href = "https://magicalmirai.com/2019/index_en.html">(Magical <b>Mirai</b>)</a></p>
图标以及形象由画师<a href = "">DazeCake</a>绘制
</div>
2020-05-10 14:05:51 +08:00
# mirai-console
高效率插件支持 QQ 机器人框架, 机器人核心来自 [mirai](https://github.com/mamoe/mirai)
2020-02-28 16:25:02 +08:00
2020-05-10 14:05:51 +08:00
## 模块说明
2020-02-28 16:25:02 +08:00
2020-05-10 14:05:51 +08:00
console 由后端和前端一起工作. 使用时必须选择一个前端.
2020-02-28 16:25:02 +08:00
2020-05-10 14:05:51 +08:00
- `mirai-console`: console 的后端, 包含插件管理, 指令系统, 配置系统. 还包含一个轻量命令行的前端 (因此可以独立启动 `mirai-console`).
- `mirai-console-graphical`: console 的 JavaFX 图形化界面前端.
- `mirai-console-terminal`: console 的 Unix 终端界面前端. (实验性)
2020-02-28 16:25:02 +08:00
2020-08-19 20:50:39 +08:00
**注意:`mirai-console` 后端和 pure 前端正在进行完全的重构**
重构计划:
- [x] `1.0-M1`: API 初步
- [x] `1.0-M2`: API 优化; Java 调用支持
- [ ] `1.0-M3`: Java 实现支持; 文档补全
2020-05-10 14:05:51 +08:00
### 插件开发与获取
2020-04-22 14:12:51 +08:00
2020-05-10 14:05:51 +08:00
mirai-console 支持 Jar 插件.
2020-04-22 14:12:51 +08:00
2020-05-10 14:05:51 +08:00
**mirai-console 目前仍为实验性阶段, 任何功能和 API 都不保证稳定性. 任何 API 都可能在没有警告的情况下修改.**
2020-05-10 14:05:51 +08:00
(实验性) [插件中心](https://github.com/mamoe/mirai-plugins)
[mirai-console插件开发快速上手](PluginDocs/ToStart.MD)