mirai/docs/README.md

Mirai

欢迎来到 mirai 文档。

生态

Mirai 生态概览

确定 SDK

mirai 官方提供 Kotlin/Java 等 JVM 平台语言开发支持。如果不熟悉这些语言，请使用以下社区 SDK：

这些 SDK 基于 mirai-console。mirai-console 是 mirai 官方维护的一个*应用程序*。可以在 这里 了解如何启动 mirai-console（也可以稍后在各 SDK 的说明中了解）。

技术	维护者及项目地址
Http	mamoe/mirai-api-http
JavaScript	iTXTech/mirai-js
Python	Graia Framework
Node.js	RedBeanN/node-mirai
Go	Logiase/gomirai
Mozilla Rhino	StageGuard/mirai-rhinojs-sdk
C++	cyanray/mirai-cpp
C++	Chlorie/miraipp
C++	Nambers/MiraiCP
C#	Executor-Cheng/mirai-CSharp
Rust	HoshinoTented/mirai-rs
TypeScript	YunYouJun/mirai-ts
易语言	only52607/e-mirai
.Net/C#	Hyperai
酷 Q 插件	iTXTech/mirai-native
酷 Q HTTP	yyuueexxiinngg/cqhttp-mirai

想在这里添加你的项目？欢迎提交 PR。

特别地，有一些 SDK 直接基于 mirai-core 开发，不需要 mirai-console：

• Lua: lua-mirai

JVM 平台 Mirai 开发

Mirai 文档没有废话，请务必仔细阅读每一个字。仔细阅读文档花费的 1 分钟可能相当于不阅读文档而自己摸索解决办法的 1 小时。

1. JVM 环境和开发准备工作（2 分钟）
2. 配置项目依赖
   • 要把 mirai-core 嵌入一个应用使用，请阅读 配置项目依赖。
   • 要为 mirai-console 框架开发插件，请阅读 mirai-console 的配置插件项目。
3. 阅读 API 文档（见下文）

如果你不知道 mirai-console 是什么，请阅读 Mirai 生态概览。

如果你希望先确认 mirai 能够正常运行才能安心阅读文档，可克隆 mirai-hello-world 并运行其中 Kotlin 或 Java 入口点 main。

mirai-core API 文档

适用于 2.x 版本

• Bots
• Contacts
• Events
• Messages

希望改进文档? 请在 #848 提出建议