-2
Daily
-33
Weekly
-32
Monthly
14,761
stars
2,460
forks
135
watchers
600
prs
1,986
issues
185
releases
README
----
mirai 是一个在全平台下运行,提供 QQ Android 协议支持的高效率机器人库
这个项目的名字来源于
京都动画作品《境界的彼方》的栗山未来(Kuriyama mirai)
CRYPTON以初音未来为代表的创作与活动(Magical mirai)
图标以及形象由画师DazeCake绘制
mirai
English
声明
一切开发旨在学习,请勿用于非法用途
- mirai 是完全免费且开放源代码的软件,仅供学习和娱乐用途使用
- mirai 不会通过任何方式强制收取费用,或对使用者提出物质条件
- mirai 由整个开源社区维护,并不是属于某个个体的作品,所有贡献者都享有其作品的著作权。
许可证
Copyright (C) 2019-2023 Mamoe Technologies and contributors.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .
mirai 采用 AGPLv3 协议开源。为了整个社区的良性发展,我们强烈建议您做到以下几点:
- 间接接触(包括但不限于使用 Http API 或 跨进程技术)到 mirai 的软件使用 AGPLv3 开源
- 不鼓励,不支持一切商业使用
鉴于项目的特殊性,开发团队可能在任何时间停止更新或删除项目。
衍生软件需声明引用
- 若引用 mirai 发布的软件包而不修改 mirai,则衍生项目需在描述或应用内的任意部位提及使用 mirai。
- 若修改 mirai 源代码再发布,或参考 mirai 内部实现发布另一个项目,则衍生项目必须在文章首部或 'mirai' 相关内容首次出现的位置明确声明来源于本仓库 (https://github.com/mamoe/mirai)。不得扭曲或隐藏免费且开源的事实。
协议支持
支持的协议列表
消息相关
- 文字
- 原生表情
- 商城表情
- 戳一戳
- 图片 (自定义表情)
- XML,JSON 等富文本消息
- 长消息(5000 字符 + 50 图片)
- 引用回复
- 合并转发
- 撤回
- 提及群员
- 提及全体成员
- 语音
- 闪照
- 撤回群员消息
- 自定义消息
- 音乐分享
- 短视频
群相关
- 群列表
- 成员列表
- 群员权限
- 禁言
- 全体禁言
- 群公告管理
- 群设置(自动审批、入群公告、成员邀请、匿名聊天)
- 处理入群申请
- 移除群员
- 群文件
好友相关
- 好友列表
- 处理新好友申请
- 删除好友
其他客户端
- 同步其他客户端的消息
- 向其他客户端发送消息
不会支持的协议
- 金钱相关,如点赞、收付款
- 敏感操作,如主动添加好友、主动加入群、主动邀请好友加群
- 安全相关,获取账号登录凭证(token,cookie等)
一切开发旨在学习,请勿用于非法用途
快速使用
- 用户手册: UserManual
如果你希望快速部署一个 Mirai QQ 机器人,安装插件、并投入使用,请看这里
- 论坛: Mirai Forum
Mirai 只有唯一一个官方论坛 Mirai Forum
- 在线讨论: Gitter
开发相关
- 开发文档: 在 GitHub 阅读
或 在 docs.mirai.mamoe.net 阅读
- 参与贡献: CONTRIBUTING
- 更新日志: release
- 开发计划: milestones
- mirai 开发组和官方系列项目: project-mirai
- mirai 社区相关项目 (
旧): awesome-mirai
赞助
- 本着与更多 mirai 开发者、用户、支持者共建更好的学习环境为目的,mirai 自 2021 年 3 月 1 日发起官方社区的建设。社区建设可能涉及:学习论坛、插件中心(在建)等。由于社区的运维需要经费,mirai 项目开启 sponsor 功能。
- 请注意,赞助是全自愿的。赞助者不会获得特权,不赞助也可以使用全部的功能。为资金管理方便,赞助后不设退款、折现等选项。最终解释权归社区运营团队所有。
- 全部赞助金额、流向、票据单号等将透明化公示,欢迎任何人随时查看及提出建议。
鸣谢
IntelliJ IDEA 是一个在各个方面都最大程度地提高开发人员的生产力的 IDE,适用于 JVM 平台语言。
特别感谢 JetBrains 为开源项目提供免费的 IntelliJ IDEA 等 IDE 的授权Top issues
#1461bot因使用非官方QQ客户端被冻结37 comments · 2021-08-05#1584支持 WEBP 格式图片发送35 comments · 2021-09-26#2345疑似最新的风控23 comments · 2022-11-12#2798运行后没多久报错Received unknown oicq packet type = 3221 comments · 2023-09-14#1959插件无法主动结束进程21 comments · 2022-04-02#1772ImageId 重设计提案19 comments · 2021-12-29#2586在安卓系统上出现 java.lang.StackOverflowError: stack size 1037KB17 comments · 2023-03-22#2604长信息和xml信息发送失败16 comments · 2023-03-27
Discussions
#2855mirai后续还会更新嘛0 comments · 2024-07-26#2833235错误,提示版本过低1 comments · 2024-01-30#2821发送文件1 comments · 2023-11-17#2817论坛寄了,问了几个朋友都上不去QAQ2 comments · 2023-11-07#2816如何获取群发或私信的 图片处理并返回图片 或下载1 comments · 2023-10-31#28152.16.07 comments · 2023-10-22#2778关于环境配置0 comments · 2023-08-18#2759对于刚上手的新人2 comments · 2023-07-27
Latest release
2.16.0 v2.16.0 2023-10-22感谢大家四年以来对 mirai 的支持。阳光穿过秋天的枫叶,留下一张张独特的风景,如此灿烂,如此艳丽。 mirai-core 优化和修复 - 修复登录收到结果 180 时会无限重连的问题 - 修复 ShortVideo 文档 - 优化 ShortVideo 的内部日志 mirai-console 优化和修复 - 修复 JVM 插件 JAR 中使用 plugin.yml 加载时无法加载的问题 (2791 by @cssxsh)