mirror of https://github.com/mamoe/mirai.git synced 2025-01-10 18:40:15 +08:00

高效率 QQ 机器人支持库

Go to file

Him188 2fe2d2a681 API stabilization for PluginData: Move members valueNodes, ValueNode, track from PluginData to AbstractPluginData; Move findBackingFieldValue, findBackingFieldValueNode from PluginData.kt to AbstractPluginData.kt; Mark unstable APIs with `@ConsoleExperimentalApi`		2020-09-18 20:35:36 +08:00
.github/workflows	Terminal (#179 )	2020-09-18 12:43:57 +08:00
backend	API stabilization for PluginData:	2020-09-18 20:35:36 +08:00
buildSrc	Merge remote-tracking branch 'origin/master'	2020-09-18 20:01:10 +08:00
docs	Terminal (#179 )	2020-09-18 12:43:57 +08:00
frontend	Terminal (#179 )	2020-09-18 12:43:57 +08:00
gradle/wrapper	Update versions	2020-09-02 08:24:17 +08:00
tools	Merge remote-tracking branch 'origin/master'	2020-09-18 20:01:10 +08:00
.editorconfig	Configure .editorconfig	2020-09-17 22:20:48 +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	Terminal (#179 )	2020-09-18 12:43:57 +08:00
settings.gradle.kts	Terminal (#179 )	2020-09-18 12:43:57 +08:00

README.md

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

这个项目的名字来源于

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

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

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

mirai-console

高效率插件支持 QQ 机器人框架, 机器人核心来自 mirai

模块说明

console 由后端和前端一起工作. 使用时必须选择一个前端.

mirai-console: console 的后端, 包含插件管理, 指令系统, 配置系统.

前端:

mirai-console-terminal: console 的 Unix 终端界面前端.
mirai-console-graphical: console 的 JavaFX 图形化界面前端. (开发中)

注意：mirai-console 后端和 terminal 前端正在进行完全的重构, 所有 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-terminal:$CONSOLE_VERSION") // 前端, 用于启动测试
}

Maven

同理 Gradle