mirai/docs

Mirai

欢迎来到 mirai 文档。

生态

Mirai 生态概览

社区 SDK

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

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

技术	实现	维护者及项目地址
Mirai Http	Mirai 标准	mamoe/mirai-api-http
OneBot Http	OneBot 标准	yyuueexxiinngg/onebot-kotlin
C++	JNI	Nambers/MiraiCP
Kotlin Scripting	JVM	iTXTech/mirai-kts
Python	Mirai Http	Graia Framework
C++	Mirai Http	cyanray/mirai-cpp
C++	Mirai Http	Chlorie/miraipp
C#	Mirai Http	Executor-Cheng/mirai-CSharp
Rust	Mirai Http	HoshinoTented/mirai-rs
JavaScript	Rhino / JVM	iTXTech/mirai-js
JavaScript	Node.js / Mirai Http	RedBeanN/node-mirai
JavaScript	TypeScript / Mirai Http	YunYouJun/mirai-ts
JavaScript	Rhino / JVM	StageGuard/mirai-rhinojs-sdk
.Net/C#	Mirai Http	Hyperai
Go	Mirai Http	Logiase/gomirai
易语言	Mirai Http	only52607/e-mirai
酷 Q DLL 插件	JNI	iTXTech/mirai-native

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

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

• Lua: lua-mirai

JVM 平台 Mirai 开发

为了避免遇到各种问题，请仔细阅读。

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

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

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

mirai-core API 文档

适用于 2.x 版本

• Bots
• Contacts
• Events
• Messages

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