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 库,实现了 QQ 的 Android 协议,让开发者能够构建与 Tencent 的 QQ 聊天平台交互的机器人。
这是独立的机器人应用,还是我需要在其基础上开发的库?它是一个库/框架:你可以基于 mirai 的 API 编写 Kotlin 或 Java 代码,也可以安装预构建的加载器并放入插件,来运行你自己的 QQ 机器人。
我怎样才能快速让机器人跑起来?如果想用插件快速部署,请按照官方《用户手册》操作;如果要进行自定义开发,请将 mirai 添加为依赖,并阅读 GitHub 或 docs.mirai.mamoe.net 上的开发者文档。
使用它需要 JVM 工具链吗?需要。mirai 使用 Kotlin 编写,面向基于 JVM 的语言,因此你需要 Java/Kotlin 开发环境才能构建或扩展它。
mirai 会拒绝支持哪些类型的操作?Mirai 有意不支持与金钱相关的操作(点赞、支付)、自动添加好友或自动加群等敏感操作,以及任何提取登录凭证(如 token 或 cookie)的行为。
从法律角度看,它是给谁用的?它面向正在学习或尝试开发的开发者;项目明确说明仅供学习和娱乐用途,严禁用于违法目的。
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