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
Kotlin Scripting	JVM	iTXTech/mirai-kts
Python	Mirai Http	Graia Framework
Python	Mirai Http / OneBot Http	NoneBot
C++	JNI	Nambers/MiraiCP
C++	Mirai Http	cyanray/mirai-cpp
C++	Mirai Http	Chlorie/miraipp
C#	Mirai Http	Executor-Cheng/mirai-CSharp
C#	Mirai Http	Hyperai
C#	WebSocket	Coloryr/ColorMirai
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	Node.js / Mirai Http	drinkal/Mirai-js
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. 选择框架

   • 若要将 mirai 当做依赖库嵌入你的应用使用，则需要使用 mirai-core，请阅读 配置项目依赖。

   • 若要以插件模式开发，可以使用 mirai-console，请阅读 mirai-console 的配置插件项目。

3. 阅读 API 文档（见下文）

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

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

之后...

• 让更多人看到你的项目 - 在论坛发布

mirai-core API 文档

请在 CoreAPI.md 阅读 JVM 平台的 mirai-core-api 使用文档。