mirai/docs/README.md

MiraiConsole

欢迎来到 mirai-console 开发文档!

准备工作

开发 mirai-console 插件的准备工作

• 需使用 IDE: IntelliJ IDEA
• IntelliJ 需装有 Kotlin Jvm Blocking Bridge 插件 (启动 IntelliJ, 点击 一键安装)
• 安装并配置 JDK 8

前置知识

要学习为 mirai-console 开发原生支持的插件, 需要:

• 掌握 Java 基础.
• 了解 Kotlin 基础语法:
  • 基本类型
  • 类与继承
  • 属性与字段
  • 接口
  • 扩展
  • 数据类
  • 对象
  • 密封类
  • Java 中调用 Kotlin
• 至少能使用 Java 或 Kotlin 一种一门语言解决问题
• 了解 JVM 和 Java 等同类编程语言的关系

目录

后端插件开发基础

• 包结构 net.mamoe.mirai.console.

  • command：指令模块：Command
  • data：存储模块：PluginData, PluginConfig, PluginDataStorage
  • event：Console 实现的事件.
  • plugin：插件模块：Plugin, PluginLoader, JvmPlugin
  • util：工具类：Annotations, BotManager, ConsoleInput, JavaPluginScheduler
  • internal：内部实现

• 插件 - Plugin 模块

• 指令 - Command 模块

• 存储 - PluginData 模块

• 权限 - Permission 模块

后端插件开发进阶

• 扩展 - Extension 模块和扩展点
• 扩展 - 实现 PluginLoader
• 扩展 - 实现 PermissionService

实现前端

• FrontEnd