mirai/mirai-console/docs/FrontEnd.md

34 lines
1.0 KiB
Markdown
Raw Normal View History

2020-09-13 01:52:46 +08:00
# Mirai Console Frontend
Mirai Console 前端开发文档。
2020-11-21 09:14:27 +08:00
[`MiraiConsole`]: ../backend/mirai-console/src/MiraiConsole.kt
2020-09-13 01:52:46 +08:00
## 实现前端
### 添加编译器设置
`build.gradle``build.gradle.kts` 添加:
```kotlin
2020-11-21 09:14:27 +08:00
kotlin.sourceSets.all {
2021-08-10 04:20:08 +08:00
languageSettings.optIn("net.mamoe.mirai.console.ConsoleFrontEndImplementation")
2020-09-13 01:52:46 +08:00
}
```
此后就可以使用 `net.mamoe.mirai.console.ConsoleFrontEndImplementation` 标记的所有 API。
### 实现 Mirai Console
2020-11-21 09:14:27 +08:00
[`MiraiConsole`] 是后端的公开对象,由 [MiraiConsoleImplementationBridge](../backend/mirai-console/src/internal/MiraiConsoleImplementationBridge.kt) 代理,与前端链接。
2020-09-13 01:52:46 +08:00
2021-01-14 17:21:50 +08:00
前端需要实现 [MiraiConsoleImplementation.kt](../backend/mirai-console/src/MiraiConsoleImplementation.kt)。
2020-09-13 01:52:46 +08:00
由于实现前端需要一定的技术能力,相信实现者都能理解源码内注释。
### 启动 Mirai Console
通过 `public fun MiraiConsoleImplementation.start()`
2020-11-21 09:14:27 +08:00
[MiraiConsoleImplementation.kt: Line 161](../backend/mirai-console/src/MiraiConsoleImplementation.kt#L161)