mirror of
https://github.com/mamoe/mirai.git
synced 2025-01-27 17:00:14 +08:00
Update docs
This commit is contained in:
Him188
parent
cc8856ed1a
commit
aff9e7c7a9
71
README.md
71
README.md
@ -109,84 +109,27 @@ mirai 是一个在全平台下运行，提供 QQ Android 协议支持的高效
|
|||||||
|
|
||||||
## 开始
|
## 开始
|
||||||
|
|
||||||
### 在开始之前，建议你了解一下 Mirai 生态
|
- 开发文档（新，编写中）：[docs](docs/README.md)
|
||||||
[Mirai 生态概览](docs/mirai-ecology.md)
|
- 开发文档（旧）：[docs/mirai.md](docs/mirai.md)
|
||||||
|
|
||||||
### 文档
|
|
||||||
|
|
||||||
**对于一般使用者, 更建议使用 [Mirai Console](https://github.com/mamoe/mirai-console)。拥有更完善的文档。**
|
|
||||||
|
|
||||||
- 快速上手：[quickstart](docs/guide_quick_start.md)
|
|
||||||
- 开发文档：[docs/mirai.md](docs/mirai.md)
|
|
||||||
- 常见问题: [docs/FAQ.md](docs/FAQ.md)
|
|
||||||
- 更新日志: [release](https://github.com/mamoe/mirai/releases)
|
- 更新日志: [release](https://github.com/mamoe/mirai/releases)
|
||||||
- 开发计划: [milestones](https://github.com/mamoe/mirai/milestones)
|
- 开发计划: [milestones](https://github.com/mamoe/mirai/milestones)
|
||||||
|
|
||||||
- 贡献: [CONTRIBUTING](CONTRIBUTING.md)
|
- 贡献: [CONTRIBUTING](CONTRIBUTING.md)
|
||||||
|
|
||||||
### 使用者
|
|
||||||
|
|
||||||
- [mirai-console](https://github.com/mamoe/mirai-console) 支持插件的控制台服务端，支持PC和Android平台 **本模块正在开发中**
|
|
||||||
- [awesome-mirai](https://github.com/project-mirai/awsome-mirai/blob/master/README.md) **mirai相关项目合集**
|
- [awesome-mirai](https://github.com/project-mirai/awsome-mirai/blob/master/README.md) **mirai相关项目合集**
|
||||||
|
- 常见问题: [docs/FAQ.md](docs/FAQ.md)
|
||||||
#### 从其他平台迁移
|
|
||||||
|
|
||||||
- 酷Q的插件可以在 `mirai` 中加载，详见 [Mirai Native](https://github.com/iTXTech/mirai-native)
|
|
||||||
- 使用 `酷Q HTTP API` 的插件将可以在 `mirai` 中通过`CQHTTP Mirai`加载，详见 [cqhttp-mirai](https://github.com/yyuueexxiinngg/cqhttp-mirai)
|
|
||||||
|
|
||||||
### 开发者
|
|
||||||
|
|
||||||
开发交流：[](https://gitter.im/mamoe/mirai?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
|
||||||
|
|
||||||
#### 使用 mirai-console 服务端，为 mirai-console 开发插件
|
|
||||||
|
|
||||||
官方支持 SDK 列表:
|
|
||||||
|
|
||||||
- `Java`，`Kotlin` 等 JVM 语言： 为 [mirai-console](https://github.com/mamoe/mirai-console) 直接编写插件并与其他插件开发者合作共享
|
|
||||||
- `Kotlin Script`： [mirai-kts](https://github.com/iTXTech/mirai-kts) 支持使用 `kts` 编写插件，享受 `Kotlin` 带来的一切便利（**仅 OpenJDK 8 以上环境，不支持 Android**）
|
|
||||||
- `C`，`C++` 等原生语言： [mirai-native](https://github.com/iTXTech/mirai-native) 支持酷 Q 插件在 mirai 上运行 **(仅限 `Windows 32 位 JRE`/支持 `Wine`)**
|
|
||||||
- `JavaScript`： [mirai-js](https://github.com/iTXTech/mirai-js) 支持使用 `JavaScript` 编写插件并**直接**与 mirai 交互
|
|
||||||
- *Http*：使用由 [mirai-api-http](https://github.com/mamoe/mirai-api-http) 提供的 http 接口进行接入
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>社区支持的 SDK 列表</summary>
|
|
||||||
|
|
||||||
基于 `mirai-core` (独立使用):
|
|
||||||
- `Lua`: [lua-mirai](https://github.com/only52607/lua-mirai) 基于 mirai-core 的 Lua SDK，并提供了 Java 扩展支持，可在 Lua 中调用 Java 代码开发机器人
|
|
||||||
|
|
||||||
|
|
||||||
基于 `mirai-http-api` (配合 [mirai-console](https://github.com/mamoe/mirai-console)):
|
|
||||||
|
|
||||||
- `Python`: [Graia Framework](https://github.com/GraiaProject/Application) 基于 `mirai-api-http` 的机器人开发框架
|
|
||||||
- `JavaScript`(`Node.js`): [node-mirai](https://github.com/RedBeanN/node-mirai) mirai 的 Node.js SDK
|
|
||||||
- `Go`: [gomirai](https://github.com/Logiase/gomirai) 基于 mirai-api-http 的 GoLang SDK
|
|
||||||
- `Mozilla Rhino`: [mirai-rhinojs-sdk](https://github.com/StageGuard/mirai-rhinojs-sdk) 为基于 Rhino(如 Auto.js 等安卓 app 或运行环境)的 JavaScript 提供简单易用的 SDK
|
|
||||||
- `C++`: [mirai-cpp](https://github.com/cyanray/mirai-cpp) mirai-http-api 的 C++ 封装，方便使用 C++ 开发 mirai-http-api 插件
|
|
||||||
- `C++`: [miraipp](https://github.com/Chlorie/miraipp-template) mirai-http-api 的另一个 C++ 封装，使用现代 C++ 特性，并提供了较完善的说明文档
|
|
||||||
- `C#`: [mirai-CSharp](https://github.com/Executor-Cheng/mirai-CSharp) 基于 mirai-api-http 的 C# SDK
|
|
||||||
- `Rust`: [mirai-rs](https://github.com/HoshinoTented/mirai-rs) mirai-http-api 的 Rust 封装
|
|
||||||
- `TypeScript`: [mirai-ts](https://github.com/YunYouJun/mirai-ts) mirai-api-http 的 TypeScript SDK，附带声明文件，拥有良好的注释和类型提示，也可作为 JavaScript SDK 使用。
|
|
||||||
- `易语言`: [e-mirai](https://github.com/only52607/e-mirai) mirai-api-http 的 易语言 SDK，使用全中文环境开发插件，适合编程新手使用。
|
|
||||||
- `.Net/C#`: [Hyperai](https://github.com/theGravityLab/ProjHyperai) 从 mirai-api-http 对接到机器人开发框架再到开箱即用的插件式机器人程序一应俱全。
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
#### 使用 mirai-core 为第三方依赖库引入项目
|
|
||||||
|
|
||||||
Demos: [mirai-demos](https://github.com/mamoe/mirai-demos)
|
|
||||||
|
|
||||||
- `Kotlin` 简略版： [mirai Guide - Quick Start](/docs/guide_quick_start.md)
|
|
||||||
- `Kotlin` 新手版： [mirai Guide - Getting Started](/docs/guide_getting_started.md)
|
|
||||||
- `Java`： 查看上述 Demos
|
|
||||||
|
|
||||||
## [贡献](CONTRIBUTING.md)
|
## [贡献](CONTRIBUTING.md)
|
||||||
|
|
||||||
我们欢迎一切形式的贡献。
|
我们欢迎一切形式的贡献。
|
||||||
我们也期待有更多人能加入 mirai 的开发。
|
我们也期待有更多人能加入 mirai 的开发。
|
||||||
|
|
||||||
若在使用过程中有任何疑问，可提交 `issue` 或是[邮件联系](mailto:support@mamoe.net). 我们希望 mirai 变得更易用.
|
若在使用过程中有任何疑问，可提交 [`issue`](https://github.com/mamoe/mirai/issues) 或在 [`Discussions`](https://github.com/mamoe/mirai/discussions) 讨论。 我们希望 mirai 变得更易用.
|
||||||
|
|
||||||
您的 `star` 是对我们最大的鼓励(点击项目右上角)
|
您的 `star` 是对我们最大的鼓励(点击项目右上角)
|
||||||
|
|
||||||
|
开发交流：[](https://gitter.im/mamoe/mirai?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
||||||
|
|
||||||
### 加入 mirai 开发组
|
### 加入 mirai 开发组
|
||||||
若您有意加入 mirai, mirai-console 和相关社区开发, 请 [邮件联系](mailto:support@mamoe.net) (`support@mamoe.net`), 并附加相关开发经验证明.
|
若您有意加入 mirai, mirai-console 和相关社区开发, 请 [邮件联系](mailto:support@mamoe.net) (`support@mamoe.net`), 并附加相关开发经验证明.
|
||||||
|
|
||||||
|
|||||||
@ -6,7 +6,57 @@
|
|||||||
|
|
||||||
[Mirai 生态概览](mirai-ecology.md)
|
[Mirai 生态概览](mirai-ecology.md)
|
||||||
|
|
||||||
## 配置项目
|
## 确定 SDK
|
||||||
|
|
||||||
|
mirai 官方提供 Kotlin/Java 等 JVM 平台语言开发支持。如果你不熟悉该语言，请使用以下社区提供的 SDK：
|
||||||
|
|
||||||
|
### 基于 `mirai-core` 的 SDK
|
||||||
|
|
||||||
|
使用基于 `mirai-core` 的 SDK 的很容易：
|
||||||
|
|
||||||
|
- `Lua`: [lua-mirai](https://github.com/only52607/lua-mirai) 基于 mirai-core 的 Lua SDK，并提供了 Java 扩展支持，可在 Lua 中调用 Java 代码开发机器人
|
||||||
|
|
||||||
|
### 基于 [`mirai-console`]
|
||||||
|
|
||||||
|
[`mirai-console`]: https://github.com/mamoe/mirai-console
|
||||||
|
|
||||||
|
这些 SDK 基于 [`mirai-console`]，意味着需要使用 [`mirai-console`] 框架。[`mirai-console`] 也是 mirai 的官方项目之一。
|
||||||
|
|
||||||
|
[mamoe/mirai-api-http]: https://github.com/mamoe/mirai-api-http
|
||||||
|
[iTXTech/mirai-native]: https://github.com/iTXTech/mirai-native
|
||||||
|
[iTXTech/mirai-js]: https://github.com/iTXTech/mirai-js
|
||||||
|
[GraiaProject/Application]: https://github.com/GraiaProject/Application
|
||||||
|
[RedBeanN/node-mirai]: https://github.com/RedBeanN/node-mirai
|
||||||
|
[Logiase/gomirai]: https://github.com/Logiase/gomirai
|
||||||
|
[StageGuard/mirai-rhinojs-sdk]: https://github.com/StageGuard/mirai-rhinojs-sdk
|
||||||
|
[cyanray/mirai-cpp]: https://github.com/cyanray/mirai-cpp
|
||||||
|
[Chlorie/miraipp]: https://github.com/Chlorie/miraipp-template
|
||||||
|
[Executor-Cheng/mirai-CSharp]: https://github.com/Executor-Cheng/mirai-CSharp
|
||||||
|
[HoshinoTented/mirai-rs]: https://github.com/HoshinoTented/mirai-rs
|
||||||
|
[YunYouJun/mirai-ts]: https://github.com/YunYouJun/mirai-ts
|
||||||
|
[only52607/e-mirai]: https://github.com/only52607/e-mirai
|
||||||
|
[theGravityLab/ProjHyperai]: https://github.com/theGravityLab/ProjHyperai
|
||||||
|
[yyuueexxiinngg/cqhttp-mirai]: https://github.com/yyuueexxiinngg/cqhttp-mirai
|
||||||
|
|
||||||
|
| 技术 | 维护者及项目地址 | 描述 |
|
||||||
|
|:----------------|:--------------------------------------------|:-----------------------------------------------------------------------|
|
||||||
|
| *Http* | [mamoe/mirai-api-http] | Mirai 官方维护的 HTTP API 插件 |
|
||||||
|
| `JavaScript` | [iTXTech/mirai-js] | 支持使用 `JavaScript` 编写插件并**直接**与 mirai 交互 |
|
||||||
|
| `Python` | [Graia Framework][GraiaProject/Application] | 基于 `mirai-api-http` 的机器人开发框架 |
|
||||||
|
| `Node.js` | [RedBeanN/node-mirai] | mirai 的 Node.js SDK |
|
||||||
|
| `Go` | [Logiase/gomirai] | 基于 mirai-api-http 的 GoLang SDK |
|
||||||
|
| `Mozilla Rhino` | [StageGuard/mirai-rhinojs-sdk] | 为基于 Rhino(如 Auto.js 等安卓 app 或运行环境)的 JavaScript 提供简单易用的 SDK |
|
||||||
|
| `C++` | [cyanray/mirai-cpp] | mirai-http-api 的 C++ 封装，方便使用 C++ 开发 mirai-http-api 插件 |
|
||||||
|
| `C++` | [Chlorie/miraipp] | mirai-http-api 的另一个 C++ 封装，使用现代 C++ 特性，并提供了较完善的说明文档 |
|
||||||
|
| `C#` | [Executor-Cheng/mirai-CSharp] | 基于 mirai-api-http 的 C# SDK |
|
||||||
|
| `Rust` | [HoshinoTented/mirai-rs] | mirai-http-api 的 Rust 封装 |
|
||||||
|
| `TypeScript` | [YunYouJun/mirai-ts] | mirai-api-http 的 TypeScript SDK，附带声明文件，拥有良好的注释和类型提示 |
|
||||||
|
| `易语言` | [only52607/e-mirai] | mirai-api-http 的 易语言 SDK，使用全中文环境开发插件，适合编程新手使用 |
|
||||||
|
| `.Net/C#` | [Hyperai][theGravityLab/ProjHyperai] | 从 mirai-api-http 对接到机器人开发框架再到开箱即用的插件式机器人程序一应俱全 |
|
||||||
|
| *酷 Q 插件* | [iTXTech/mirai-native] | 支持酷 Q 插件在 mirai 上运行 |
|
||||||
|
| *酷 Q HTTP* | [yyuueexxiinngg/cqhttp-mirai] | 在 mirai-console 开启酷 Q HTTP 服务。 |
|
||||||
|
|
||||||
|
## 配置 JVM 项目使用 mirai
|
||||||
|
|
||||||
> 可以首先体验让机器人发送消息：在 IDE 克隆 [mirai-hello-world](https://github.com/project-mirai/mirai-hello-world) 并运行其中入口点。
|
> 可以首先体验让机器人发送消息：在 IDE 克隆 [mirai-hello-world](https://github.com/project-mirai/mirai-hello-world) 并运行其中入口点。
|
||||||
|
|
||||||
@ -16,4 +66,7 @@
|
|||||||
|
|
||||||
## 开发
|
## 开发
|
||||||
|
|
||||||
|
***本文档正在更新中***
|
||||||
|
|
||||||
- [创建 Bot](CreatingBots.md)
|
- [创建 Bot](CreatingBots.md)
|
||||||
|
- [Contacts](Contacts.md)
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user