mirai 高效率 QQ 机器人框架

​

协议支持

支持的协议列表

消息相关

• 文字
• 原生表情
• 商城表情
• 戳一戳
• 图片 （自定义表情）
• XML，JSON 等富文本消息
• 长消息（5000 字符 + 50 图片）
• 引用回复
• 合并转发
• 撤回
• 提及群员
• 提及全体成员
• 语音
• 闪照
• 撤回群员消息
• 自定义消息
• 音乐分享

群相关

• 群列表
• 成员列表
• 群员权限
• 禁言
• 全体禁言
• 群公告管理
• 群设置（自动审批、入群公告、坦白说、成员邀请、匿名聊天）
• 处理入群申请
• 移除群员

好友相关

• 完整好友列表
• 处理新好友申请
• 删除好友

其他客户端

• 同步其他客户端的消息
• 向其他客户端发送消息

不会支持的协议

• 金钱相关，如点赞、收付款
• 敏感操作，如主动添加好友、主动加入群、主动邀请好友加群
• 安全相关，获取账号登录凭证(token，cookie等)

一切开发旨在学习，请勿用于非法用途

社区 SDK

mirai 官方提供 Kotlin/Java 等 JVM 平台语言开发支持。如果不熟悉这些语言，请使用以下社区 SDK：

这些 SDK 基于 ​​mirai-console​​​。​​mirai-console​​ 是 mirai 官方维护的一个应用程序。可以在 ​​这里​​​ 了解如何启动 ​​mirai-console​​（也可以稍后在各 SDK 的说明中了解）。

排名不分先后
想在这里添加你的项目？欢迎​​提交 PR​​。

特别地，有一些 SDK 直接基于 mirai-core 开发，不需要 mirai-console：

• Lua​: lua-mirai

JVM 平台 Mirai 开发

为了避免遇到各种问题，请仔细阅读。

1. JVM 环境和开发准备工作（2 分钟）
2. 配置项目依赖 （二选一）

• 要把 mirai-core 嵌入一个应用使用，请阅读 配置项目依赖。
• 要为 mirai-console​ 框架开发插件，请阅读 mirai-console 的配置插件项目。

3. 阅读 API 文档（见下文）

如果你不知道 mirai-core​ 或 mirai-console​ 是什么，请阅读 Mirai 生态概览。

如果你希望先确认 mirai 能够正常运行才能安心阅读文档，可克隆 mirai-hello-world​ 并运行其中 Kotlin 或 Java 入口点 main。

mirai-core API 文档

适用于 2.x 版本

• Bots
• Contacts
• Events
• Messages

希望改进文档? 请在 #848 提出建议