高效率 QQ 机器人支持库
Go to file
2020-09-04 09:49:38 +08:00
.github/workflows Fix shadow 2020-08-26 23:28:28 +08:00
backend Update docs: PluginData 2020-09-03 22:26:27 +08:00
buildSrc Introduce general supertypes for Extension 2020-09-02 22:32:27 +08:00
docs Add PluginConfig 2020-09-04 09:49:38 +08:00
frontend Expose CoroutineScopeUtils to public 2020-09-02 20:20:26 +08:00
gradle/wrapper Update versions 2020-09-02 08:24:17 +08:00
.gitignore Fix frontend 2020-06-29 22:10:52 +08:00
.gitmodules Link MiraiAndroid 2020-06-24 16:38:34 +08:00
build.gradle.kts Public API stabilization 2020-08-16 23:21:11 +08:00
gradle.properties fix Vcs 2020-03-29 18:14:08 +08:00
gradlew Separate mirai-console series from main repository 2020-02-27 13:18:33 +08:00
gradlew.bat Separate mirai-console series from main repository 2020-02-27 13:18:33 +08:00
LICENSE Fix LICENSE 2020-08-28 20:34:35 +08:00
README.md Update README 2020-08-31 22:49:26 +08:00
settings.gradle.kts Fix build 2020-08-01 21:53:24 +08:00

logo
title

Mirai 是一个在全平台下运行,提供 QQ 协议支持的高效率机器人库

这个项目的名字来源于

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

CRYPTON初音未来为代表的创作与活动(Magical Mirai)

图标以及形象由画师DazeCake绘制

mirai-console

Download

高效率插件支持 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: Download CONSOLE_VERSION: Download

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 都可能在没有警告的情况下修改.

(实验性) 插件中心
mirai-console插件开发快速上手 (已过期)