mirai README

The project's README from github.com/mamoe/mirai. As one markdown file: README.md.

logo
title

Gitter MiraiForum

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

这个项目的名字来源于

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

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

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

mirai

English

声明

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

许可证

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 <http://www.gnu.org/licenses/>.

mirai 采用 AGPLv3 协议开源。为了整个社区的良性发展,我们强烈建议您做到以下几点:

鉴于项目的特殊性,开发团队可能在任何时间停止更新或删除项目。

衍生软件需声明引用

协议支持

支持的协议列表

消息相关

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

群相关

  • 群列表
  • 成员列表
  • 群员权限
  • 禁言
  • 全体禁言
  • 群公告管理
  • 群设置(自动审批、入群公告、成员邀请、匿名聊天)
  • 处理入群申请
  • 移除群员
  • 群文件

好友相关

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

其他客户端

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

不会支持的协议

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

快速使用

开发相关

赞助

鸣谢

IntelliJ IDEA 是一个在各个方面都最大程度地提高开发人员的生产力的 IDE,适用于 JVM 平台语言。

特别感谢 JetBrains 为开源项目提供免费的 IntelliJ IDEA 等 IDE 的授权

mirai (mamoe/mirai)

Searching Database…

14.8K ·GitHub
What is this?Mirai is a high-efficiency Kotlin library that implements the QQ Android protocol, letting developers build bots that interact with Tencent's QQ chat platform.
Is this a standalone bot app or a library I build on top of?It is a library/framework: you write Kotlin or Java code against mirai's APIs, or install a prebuilt loader and drop in plugins, to run your own QQ bot.
How do I get a bot running quickly?For a quick deployment with plugins, follow the official User Manual; for custom development, add mirai as a dependency and read the developer docs on GitHub or docs.mirai.mamoe.net.
Do I need a JVM toolchain to use it?Yes, mirai is written in Kotlin and targets JVM-based languages, so you need a Java/Kotlin development environment to build or extend it.
What kinds of actions will mirai refuse to support?Mirai deliberately excludes money-related actions (likes, payments), sensitive operations like auto-adding friends or auto-joining groups, and anything that extracts login credentials such as tokens or cookies.
Who is this for, legally speaking?It's aimed at developers learning or experimenting; the project explicitly states it's for study and entertainment purposes only and must not be used for illegal purposes.
What messaging features does mirai support out of the box?It supports text, stickers, images, XML/JSON rich messages, long messages (5000+ chars, 50+ images), quote-replies, forwarded messages, recalls, @mentions, voice, flash photos, music sharing, and short videos.
Can mirai manage group and friend operations too?Yes: it can list and manage group members and permissions, mute users, handle join requests, manage group files and announcements, and handle friend requests and removals.
Is mirai free to use?Yes, it is completely free and open source; optional sponsorship exists to fund community infrastructure but grants no special privileges.
Where does the name mirai come from?The project's name and mascot/icon were created by an illustrator, referencing the Japanese word 'mirai' (future).
Which topics is it in?qq, bot, voice, image, messaging, kotlin, cli-tool, agpl, chatbot, video, sdk, china
Creator
mamoe
Size
94.6 MB
Stars
14.8K
Age
7y
Commits · 90 Days