mirror of
https://github.com/mamoe/mirai.git
synced 2025-01-10 02:20:14 +08:00
高效率 QQ 机器人支持库
.github/workflows | ||
backend | ||
buildSrc | ||
docs | ||
frontend | ||
gradle/wrapper | ||
.gitignore | ||
.gitmodules | ||
build.gradle.kts | ||
gradle.properties | ||
gradlew | ||
gradlew.bat | ||
LICENSE | ||
README.md | ||
settings.gradle.kts |
Mirai 是一个在全平台下运行,提供 QQ 协议支持的高效率机器人库
这个项目的名字来源于
京都动画作品《境界的彼方》的栗山未来(Kuriyama Mirai)
CRYPTON以初音未来为代表的创作与活动(Magical Mirai)
图标以及形象由画师DazeCake绘制mirai-console
高效率插件支持 QQ 机器人框架, 机器人核心来自 mirai
模块说明
console 由后端和前端一起工作. 使用时必须选择一个前端.
mirai-console
: console 的后端, 包含插件管理, 指令系统, 配置系统.
前端:
mirai-console-pure
: console 的轻量命令行前端.mirai-console-graphical
: console 的 JavaFX 图形化界面前端. (开发中)mirai-console-terminal
: console 的 Unix 终端界面前端. (开发中)
注意:mirai-console
后端和 pure 前端正在进行完全的重构, 所有 API 都不具有稳定性
使用
查看示例插件: mirai-console-example-plugin
正在更新中的文档:参考文档
Gradle
CORE_VERSION
:
CONSOLE_VERSION
:
build.gradle.kts
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 目前仍为实验性阶段, 任何功能和 API 都不保证稳定性. 任何 API 都可能在没有警告的情况下修改.