mirai Download - mirai Source code download

mirai

Other source code

2.16.0

Download

mirai is a high-efficiency robot library that runs on all platforms and provides support for the QQ Android protocol.

The name of this project comes from

Kuriyama Mirai from Kyoto Animation's "Beyond the Realm"

CRYPTON’s creations and activities represented by Hatsune Miku (Magical mirai )

Icons and images were drawn by artist DazeCake

Mirai

English

statement

All development is for learning, please do not use it for illegal purposes.

mirai is completely free and open source software for learning and entertainment purposes only
mirai will not force fees or impose material conditions on users in any way
Mirai is maintained by the entire open source community and is not the work of an individual. All contributors enjoy the copyright of their works.

license

 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 is open source using the AGPLv3 protocol. For the healthy development of the entire community, we strongly recommend that you do the following:

Indirect contact (including but not limited to use of Http API or cross-process technology) to mirai 's software is open sourced using AGPLv3
All commercial use is discouraged and not supported

Due to the special nature of the project, the development team may stop updating or delete the project at any time.

Derived software must declare a citation

If you reference a software package published by mirai without modifying mirai, the derivative project must mention the use of mirai anywhere in the description or application.
If you modify the mirai source code and publish it again, or publish another project with reference to mirai's internal implementation , the derivative project must clearly state that it comes from this repository ( https://github.com/mamoe/mirai ) at the beginning of the article or where 'mirai' related content first appears . https://github.com/mamoe/mirai ). The fact that it is free and open source must not be distorted or hidden.

Protocol support

Supported protocol list

News related

Word
Native emoticons
Mall emoticons
Give it a poke
Picture (custom expression)
Rich text messages such as XML and JSON
Long message (5000 characters + 50 images)
Quote Reply
merge forward
withdraw
Mention group members
Mention all members
voice
flash
Withdraw group member messages
Custom message
music sharing
short video

Group related

Group list
Member list
Group member permissions
Ban
All muted
Group announcement management
Group settings (automatic approval, group announcement, member invitation, anonymous chat)
Process application for joining the group
Remove group members
group file

Friends related

friends list
Process new friend requests
delete friend

Other clients

Synchronize messages from other clients
Send messages to other clients

Protocols that will not be supported

Money-related, such as likes, payment and receipt
Sensitive operations, such as actively adding friends, actively joining groups, and actively inviting friends to join groups
Security-related, obtain account login credentials (token, cookie, etc.)

All development is for learning, please do not use it for illegal purposes.

Quick to use

User Manual : UserManual
If you want to quickly deploy a Mirai QQ robot, install the plug-in, and put it into use, please see here
Forum: Mirai Forum
Mirai has only one official forum Mirai Forum
Online discussion: Gitter

development related

Development documentation: Read it on GitHub or read it at docs.mirai.mamoe.net
Contribution: CONTRIBUTING
Update log: release
Development plan: milestones
mirai development team and official series projects: project-mirai
mirai community related projects (old): awesome-mirai

sponsor

With the purpose of building a better learning environment with more mirai developers, users, and supporters, mirai has launched the construction of an official community since March 1, 2021. Community building may involve: learning forum, plug-in center (under construction), etc. Since the operation and maintenance of the community requires funds, the mirai project enables the sponsor function.
Please note that sponsorship is entirely voluntary. Patrons do not receive privileges, and full functionality is available without sponsoring. For the convenience of fund management, there are no options such as refunds and discounts after sponsorship. The final right of interpretation belongs to the community operation team.
All sponsorship amounts, flows, bill numbers, etc. will be disclosed transparently, and anyone is welcome to check and make suggestions at any time.