github.com/mamoe/mirai ↗

About mamoe/mirai

Mirai is a high-performance QQ robot library that runs on all platforms and provides support for the QQ Android protocol. Written in Kotlin, it enables developers to create chatbots and automation tools that interact with QQ messaging services. The project is completely free and open source, distributed under the AGPLv3 license, with an emphasis that it is intended purely for learning and entertainment purposes.

The library supports an extensive range of QQ protocol features including various message types such as text, images, emojis, voice messages, video, XML and JSON rich text, quoted replies, and merged forwards. It handles group operations like member management, muting, announcements, and file sharing, as well as friend list management and new friend request handling. Notably, it also supports synchronizing messages with other QQ clients and sending messages to them. The project deliberately excludes support for certain sensitive features like financial operations, friend adding, group joining, or credential access for security and safety reasons.

The project maintains an official community forum and provides comprehensive development documentation for those wanting to build on the library. There is an active contributor community, with the core development team reserving the right to halt updates or remove the project at any time due to its sensitive nature. Mirai emphasizes that derivative software using the library must properly acknowledge and credit the original project to maintain transparency about its free and open-source nature.