genanik/mirai-console

mirai 的高效率 QQ 机器人控制台

---

Mirai 是一个在全平台下运行，提供 QQ Android 和 TIM PC 协议支持的高效率机器人框架

这个项目的名字来源于

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

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

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

mirai-console

高效率插件支持机器人框架

插件开发与获取

插件中心
mirai-console插件开发快速上手

使用

下载(download)
请下载最新的 mirai-console-wrapper-x.x.x.jar

参数

--native / -n                    以图形界面模式启动
                                 
--update [KEEP|STABLE|EA]        版本升级策略. "KEEP" 为停留在当前版本; "STABLE"
                                 为更新到最新稳定版; "EA" 为更新到最新预览版.
                                 
--console [Graphical|Terminal|Pure]
                                 UI 类型. "GRAPHICAL" 为 JavaFX 图形界面;
                                 "TERMINAL" 为 Unix 终端界面; "PURE" 为纯命令行.
                                 
-h, --help                       显示这个帮助

对于Windows用户

你可以下载这里的一键安装包来快速启动mirai-console，这是最简单的方法 下载地址

请注意

• 使用时请留意安装包里的说明文字
• 目前本安装包只支持Windows系统，且mirai-console仍在开发中，可能会存在一些bug
• 关于安装包本身的一切问题请到QQ群内反馈
• 如果上面的链接下载过慢，你可以到QQ群内高速下载

对于Linux用户

运行本软件需要openjdk11，请在上面的链接下载mirai-console-wrapper-x.x.x-all.jar直接运行即可

如何启动

如果是打包好的软件, 双击
如果是命令行运行, 请注意运行目录, 推荐cd到jar的文件夹下运行, 运行目录与Console的全部配置文件储存位置有关

如何添加插件

如果是打包好的软件, 请根据UI操作
如果是命令行运行, 请将插件放入 运行目录/plugins 下

如何更改插件配置

如果是打包好的软件, 请根据UI操作
如果是命令行运行, 插件的所有配置文件将出现在 运行目录/plugins/插件名 下，推荐在mirai-console关闭时修改

如何选择版本

Mirai Console 提供了6个版本以满足各种需要
所有版本的 Mirai Console API 相同 插件系统相同

名称	介绍
Mirai-Console-Pure	最纯净版, CLI环境, 通过标准输入与标准输出 交互
Mirai-Console-Terminal	(UNIX)Terminal环境 提供简洁的富文本控制台(暂未发布)
Mirai-Console-Android	安卓APP (TODO)
Mirai-Console-Graphical	JavaFX的图形化界面 (.jar/.exe/.dmg)
Mirai-Console-WebPanel	Web Panel操作(TODO)
Mirai-Console-Ios	IOS APP (TODO)

1: Mirai-Console-Pure 兼容性最高, 在其他都表现不佳的时候请使用
2: 以系统区分

    return when(operatingSystem){
        WINDOWS -> listOf("Graphical","WebPanel","Pure")
        MAC_OS  -> listOf("Graphical","Terminal","WebPanel","Pure") 
        LINUX   -> listOf("Terminal","Pure")
        ANDROID -> listOf("Android","Pure","WebPanel") 
        IOS     -> listOf("Ios") 
        else    -> listOf("Pure") 
    }      

3: 以策略区分

    return when(task){
        体验         -> listOf("Graphical","Terminal","WebPanel","Android","Pure")
        测试插件      -> listOf("Pure") 
        调试插件      -> byOperatingSystem() 
        稳定挂机      -> listOf("Terminal","Pure") 
        else         -> listOf("Pure") 
    }      

---

对于上面的一键安装包来说，默认的启动版本是Graphical，如果你需要启动Pure版本请点击启动(Pure)

常见问题

我无法正常启动Graphical版本

请检查你的Java环境是否带有javafx相关组件；对于Windows用户，我们建议使用上面的一键安装包启动Graphical版本