logo
title ---- Mirai 是一个在全平台下运行,提供 QQ 协议支持的高效率机器人库 这个项目的名字来源于

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

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

图标以及形象由画师DazeCake绘制
# mirai-console 高效率 QQ 机器人框架,机器人核心来自 [mirai](https://github.com/mamoe/mirai) ![Gradle CI](https://github.com/mamoe/mirai-console/workflows/Gradle%20CI/badge.svg?branch=master) [![Gitter](https://badges.gitter.im/mamoe/mirai.svg)](https://gitter.im/mamoe/mirai?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) ## 使用 ### 安装 JAR 插件 将 `jar` 文件放入 `plugins` 并重启 Mirai Console 即可。 ### 执行指令 在控制台输入 `?` 查看可用指令列表。 ## 开发 **Mirai Console 基于 [Mirai](https://github.com/mamoe/mirai),因此请先阅读 [Mirai 文档](https://github.com/mamoe/mirai/tree/dev/docs)。** - **[配置项目](docs/ConfiguringProjects.md)** - **[启动 Console](docs/Run.md)** ### 后端插件开发基础 - 插件 - [Plugin 模块](docs/Plugins.md) - 指令 - [Command 模块](docs/Commands.md) - 存储 - [PluginData 模块](docs/PluginData.md) - 权限 - [Permission 模块](docs/Permissions.md) **示例插件**: - [mirai-console-example-plugin (Kotlin DSL)](https://github.com/Him188/mirai-console-example-plugin) - [mirai-console-example-plugin (Groovy DSL)](https://github.com/Karlatemp/mirai-console-example-plugin) ### 后端插件开发进阶 - 扩展 - [Extension 模块和扩展点](docs/Extensions.md) ### 实现前端 - [FrontEnd](docs/FrontEnd.md) ## 实用链接 - [社区 SDK](https://github.com/mamoe/mirai#%E4%BD%BF%E7%94%A8-mirai-console-%E6%9C%8D%E5%8A%A1%E7%AB%AF%E4%B8%BA-mirai-console-%E5%BC%80%E5%8F%91%E6%8F%92%E4%BB%B6) - 社区插件 - [awesome-mirai](https://github.com/project-mirai/awesome-mirai) - [Mirai 项目组](https://github.com/project-mirai) - Mirai 官方维护的插件: - [chat-command](https://github.com/project-mirai/chat-command) - [mirai-api-http](https://github.com/project-mirai/mirai-api-http)