mirror of
https://github.com/mamoe/mirai.git
synced 2025-01-01 09:50:36 +08:00
fe649726f3
* 对 README 做了一丢丢改动 把用户和开发者部分的索引分开以便用户区分 调整了一点点细节 * 完善用户手册 补充了简单易懂的安装教程 * 规范 README 文档语法 * Apply suggestions from code review Co-authored-by: Yurinann <1713574450@qq.com> Co-authored-by: Him188 <Him188@mamoe.net> * 规范了用户手册的文档内容 * 订正了一个空格错误 * 订正一个语法错误 * Update docs/UserManual.md --------- Co-authored-by: Yurinann <1713574450@qq.com> Co-authored-by: Him188 <Him188@mamoe.net>
151 lines
6.3 KiB
Markdown
151 lines
6.3 KiB
Markdown
<div align="center">
|
||
<img width="160" src="docs/mirai.png" alt="logo"></br>
|
||
|
||
<img width="95" src="docs/mirai.svg" alt="title">
|
||
|
||
----
|
||
|
||
[](https://gitter.im/mamoe/mirai?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
||
[](https://mirai.mamoe.net)
|
||
|
||
mirai 是一个在全平台下运行，提供 QQ Android 协议支持的高效率机器人库
|
||
|
||
这个项目的名字来源于
|
||
<p><a href = "http://www.kyotoanimation.co.jp/">京都动画</a>作品<a href = "https://zh.moegirl.org.cn/zh-hans/%E5%A2%83%E7%95%8C%E7%9A%84%E5%BD%BC%E6%96%B9">《境界的彼方》</a>的<a href = "https://zh.moegirl.org.cn/zh-hans/%E6%A0%97%E5%B1%B1%E6%9C%AA%E6%9D%A5">栗山未来(Kuriyama <b>mirai</b>)</a></p>
|
||
<p><a href = "https://www.crypton.co.jp/">CRYPTON</a>以<a href = "https://www.crypton.co.jp/miku_eng">初音未来</a>为代表的创作与活动<a href = "https://magicalmirai.com/2019/index_en.html">(Magical <b>mirai</b>)</a></p>
|
||
图标以及形象由画师<a href = "https://github.com/DazeCake">DazeCake</a>绘制
|
||
</div>
|
||
|
||
|
||
## mirai
|
||
|
||
**[English](README-eng.md)**
|
||
|
||
## 声明
|
||
|
||
### 一切开发旨在学习，请勿用于非法用途
|
||
|
||
- mirai 是完全免费且开放源代码的软件，仅供学习和娱乐用途使用
|
||
- mirai 不会通过任何方式强制收取费用，或对使用者提出物质条件
|
||
- mirai 由整个开源社区维护，并不是属于某个个体的作品，所有贡献者都享有其作品的著作权。
|
||
|
||
### 许可证
|
||
|
||
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` 协议开源。为了整个社区的良性发展，我们**强烈建议**您做到以下几点：
|
||
|
||
- **间接接触（包括但不限于使用 `Http API` 或 跨进程技术）到 `mirai` 的软件使用 `AGPLv3` 开源**
|
||
- **不鼓励，不支持一切商业使用**
|
||
|
||
鉴于项目的特殊性，开发团队可能在任何时间**停止更新**或**删除项目**。
|
||
|
||
### 衍生软件需声明引用
|
||
|
||
- 若引用 mirai 发布的软件包而不修改 mirai，则衍生项目需在描述或应用内的任意部位提及使用 mirai。
|
||
- 若修改 mirai 源代码再发布，**或参考 mirai 内部实现发布另一个项目**，则衍生项目必须在**文章首部**或 'mirai' 相关内容**首次出现**的位置**明确声明**来源于本仓库 (`https://github.com/mamoe/mirai`)。不得扭曲或隐藏免费且开源的事实。
|
||
|
||
## 协议支持
|
||
|
||
<details>
|
||
<summary>支持的协议列表</summary>
|
||
|
||
**消息相关**
|
||
|
||
- 文字
|
||
- 原生表情
|
||
- 商城表情
|
||
- 戳一戳
|
||
- 图片 （自定义表情）
|
||
- XML，JSON 等富文本消息
|
||
- 长消息（5000 字符 + 50 图片）
|
||
- 引用回复
|
||
- 合并转发
|
||
- 撤回
|
||
- 提及群员
|
||
- 提及全体成员
|
||
- 语音
|
||
- 闪照
|
||
- 撤回群员消息
|
||
- 自定义消息
|
||
- 音乐分享
|
||
|
||
**群相关**
|
||
- 群列表
|
||
- 成员列表
|
||
- 群员权限
|
||
- 禁言
|
||
- 全体禁言
|
||
- 群公告管理
|
||
- 群设置（自动审批、入群公告、成员邀请、匿名聊天）
|
||
- 处理入群申请
|
||
- 移除群员
|
||
- 群文件
|
||
|
||
**好友相关**
|
||
- 好友列表
|
||
- 处理新好友申请
|
||
- 删除好友
|
||
|
||
**其他客户端**
|
||
- 同步其他客户端的消息
|
||
- 向其他客户端发送消息
|
||
|
||
</details>
|
||
|
||
#### 不会支持的协议
|
||
- 金钱相关，如点赞、收付款
|
||
- 敏感操作，如主动添加好友、主动加入群、主动邀请好友加群
|
||
- 安全相关，获取账号登录凭证(token，cookie等)
|
||
|
||
**一切开发旨在学习，请勿用于非法用途**
|
||
|
||
## 快速使用
|
||
|
||
- **用户手册**: [UserManual](docs/UserManual.md)
|
||
|
||
> 如果你希望快速部署一个 Mirai QQ 机器人，安装插件、并投入使用，请看这里
|
||
- 论坛: [Mirai Forum](https://mirai.mamoe.net/)
|
||
|
||
> Mirai 只有**唯一一个**官方论坛 Mirai Forum
|
||
- 在线讨论: [Gitter](https://gitter.im/mamoe/mirai?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
||
|
||
## 开发相关
|
||
|
||
- 开发文档: [在 GitHub 阅读](docs/README.md)
|
||
或 [在 docs.mirai.mamoe.net 阅读](https://docs.mirai.mamoe.net/)
|
||
- 参与贡献: [CONTRIBUTING](docs/contributing/README.md)
|
||
- 更新日志: [release](https://github.com/mamoe/mirai/releases)
|
||
- 开发计划: [milestones](https://github.com/mamoe/mirai/milestones)
|
||
|
||
- mirai 开发组和官方系列项目: [project-mirai](https://github.com/project-mirai)
|
||
- mirai 社区相关项目 (
|
||
旧): [awesome-mirai](https://github.com/project-mirai/awsome-mirai/blob/master/README.md)
|
||
|
||
|
||
## 赞助
|
||
- 本着与更多 mirai 开发者、用户、支持者共建更好的学习环境为目的，mirai 自 2021 年 3 月 1 日发起官方社区的建设。社区建设可能涉及：[学习论坛](https://mirai.mamoe.net)、[插件中心（在建）](https://github.com/project-mirai/mirai-plugin-center)等。由于社区的运维需要经费，mirai 项目开启 sponsor 功能。
|
||
- 请注意，赞助是全自愿的。赞助者不会获得特权，不赞助也可以使用全部的功能。为资金管理方便，赞助后不设退款、折现等选项。最终解释权归社区运营团队所有。
|
||
- 全部赞助金额、流向、票据单号等将<a href="https://github.com/project-mirai/mirai-sponsor/tree/main">透明化公示</a>，欢迎任何人随时查看及提出建议。
|
||
|
||
|
||
## 鸣谢
|
||
|
||
> [IntelliJ IDEA](https://zh.wikipedia.org/zh-hans/IntelliJ_IDEA) 是一个在各个方面都最大程度地提高开发人员的生产力的 IDE，适用于 JVM 平台语言。
|
||
|
||
特别感谢 [JetBrains](https://www.jetbrains.com/?from=mirai) 为开源项目提供免费的 [IntelliJ IDEA](https://www.jetbrains.com/idea/?from=mirai) 等 IDE 的授权
|
||
[<img src=".github/jetbrains-variant-3.png" width="200"/>](https://www.jetbrains.com/?from=mirai)
|