how-to-use-plugin-template

如何使用 mirai-console-plugin-template.

1. 创建项目

   1. 点击绿色按钮 "Use this template" (绿色按钮在哪?)

   2. 填写 Repository name, 即项目名. 可选填写 Description 即项目描述. 如果你想让其他人看到你的项目, 请选择 'Public', 否则选择 'Private'----这样只有你自己和你授权的人才能看到

   3. 点击绿色按钮 "Create repository from template". 这将会创建一个项目到你的 GitHub 账户.

   4. 使用你的 IDE 克隆并引入新建的项目 (怎么做?)

2. 修改模板

   1. 打开 settings.gradle.kts, 修改最后一行:

      rootProject.name = "mirai-console-plugin-template" // 这是项目名称, 修改为你自己的.

   2. 打开 build.gradle.kts, 参考 Mirai 版本选择, 将

      id("net.mamoe.mirai-console") version "2.4.1"
      

      中的 2.4.1 修改为你需要的 Mirai 版本号. 通常把它更改为最新的稳定版本号最佳.

   3. 打开 src/main/kotlin/PluginMain.kt, 修改里面的插件描述信息

   4. 修改包名 (默认包名为 org.example.mirai.plugin):

      1. 修改 src/main/kotlin/PluginMain.kt 的 package
      2. 修改 src/main/test/RunMirai.kt 的 package
      3. 修改 src/main/resources/META-INF/services/net.mamoe.mirai.console.plugin.jvm.JvmPlugin 的内容为主类的全限定名 (带包名的名称)

   5. 修改主类类名 (可选) (怎么做?)

3. 运行测试

   模板配置了 Mirai Console 嵌入启动, 你可以在 src/test/kotlin/RunMirai.kt 找到.

   你可以通过 Run Configuration 启动 (怎么做?), 或者通过 main 函数旁边的图标启动 (怎么做?)

   loginTestBot 将会登录一个测试账号, 如果不需要, 可以删除.

4. 开始开发

5. 发布插件

   要打包插件 JAR 文件: 执行 Gradle 任务 buildPlugin (如何在 IntelliJ IDEA 中做?, 如何在命令行做?)

   这个 JAR 文件后缀为 .mirai.jar, 可以放入 Mirai Console plugins 目录被加载.

   如果你感兴趣, 也可以在 Mirai 官方论坛 发布插件, 让更多人使用到你的插件.

附录

如果你已经完成了上文阅读, 不需要阅读这个章节.

注意, Android Studio 是基于 IntelliJ IDEA 开发的, 本教程同样适用于 Android Studio.

如何使用 IntelliJ IDEA 克隆并引入 GitHub 项目

如果你同时使用 Google Chrome, 能访问 Chrome 插件中心, 且使用 JetBrains Toolbox:

1. 安装插件 JetBrains Toolbox Extension

   

2. 重启 Chrome

3. 现在 GitHub 克隆按钮旁边会多出一个按钮使用 IntelliJ IDEA 打开:

   

如果你不使用上述工具,

1. 打开 IntelliJ IDEA, 点击 File -> New -> Project from Version Control

   

2. URL 填入从这里获得的你项目的 Git 地址:

   

3. 点击 Clone.