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
Что это такое?Mirai — высокоэффективная библиотека на Kotlin, которая реализует протокол Android-клиента QQ и позволяет разработчикам создавать ботов для взаимодействия с чатом QQ от Tencent.
Это готовое приложение-бот или библиотека, на основе которой я что-то строю?Это библиотека/фреймворк: вы пишете код на Kotlin или Java с использованием API mirai либо устанавливаете готовый загрузчик и подключаете плагины, чтобы запустить собственного бота QQ.
Как быстро запустить бота?Для быстрого развёртывания с плагинами следуйте официальному Пользовательскому руководству; для собственной разработки добавьте mirai как зависимость и изучите документацию для разработчиков на GitHub или на docs.mirai.mamoe.net.
Нужен ли мне JVM-инструментарий, чтобы это использовать?Да, mirai написан на Kotlin и рассчитан на языки, работающие на JVM, поэтому для сборки или расширения проекта нужна среда разработки на Java/Kotlin.
Какие действия mirai откажется поддерживать?Mirai намеренно исключает финансовые действия (лайки, платежи), чувствительные операции вроде автоматического добавления в друзья или автоматического вступления в группы, а также любые действия, которые извлекают учётные данные для входа, такие как токены или cookies.
Для кого это предназначено с юридической точки зрения?Это рассчитано на разработчиков, которые изучают возможности библиотеки или экспериментируют с ней; проект прямо заявляет, что он предназначен только для учёбы и развлечения и не должен использоваться в незаконных целях.
Какие функции для сообщений mirai поддерживает из коробки?Поддерживаются текст, стикеры, изображения, богатые XML/JSON-сообщения, длинные сообщения (более 5000 символов, более 50 изображений), ответы с цитатой, пересланные сообщения, отзыв сообщений, упоминания через @, голосовые сообщения, фотографии-вспышки, отправку музыки и короткие видео.
Может ли mirai также управлять операциями с группами и друзьями?Да: он может выводить список участников групп и управлять ими и их правами, отключать пользователям возможность писать, обрабатывать заявки на вступление, управлять файлами и объявлениями групп, а также обрабатывать запросы в друзья и удаление из друзей.
Можно ли использовать mirai бесплатно?Да, он полностью бесплатный и с открытым исходным кодом; существует необязательное спонсорство для финансирования инфраструктуры сообщества, но оно не даёт никаких особых привилегий.
Откуда взялось название mirai?Название проекта, а также его талисман и иконку создал иллюстратор, сославшись на японское слово «mirai» (будущее).
Which topics is it in?qq, voice, bot, image, messaging, kotlin, cli-tool, agpl, chatbot, video, sdk, china
Creator
mamoe
Size
94.6 MB
Stars
14.8K
Age
7y
Commits · 90 Days