跳转至

创建第一个插件

欢迎来到Allay！Allay提供了强大的插件系统，允许你使用多种语言编写插件——Java、Kotlin、Scala以及任何基于JVM的语言。本指南将逐步引导你用Java创建一个简单的插件。

前置条件

开始之前，请确保已安装以下内容：

项目模板

为了快速开始，你可以使用以下插件模板之一：

本指南将使用JavaPluginTemplate。

创建新项目

  1. 打开JavaPluginTemplate页面
  2. 点击Use this template按钮 → Create a new repository
  3. 输入名称和描述，我们使用MyPlugin作为名称
  4. 点击Create repository

创建完成后，你会被重定向到新仓库的页面。克隆项目到本地：

git clone https://github.com/yourusername/MyPlugin.git
cd MyPlugin

初始化项目

在IntelliJ IDEA中打开项目后，按模板仓库给出的初始化步骤完成项目设置，然后重新加载Gradle项目。

提示

如果你没有使用JavaPluginTemplate，则需要手动编写plugin.json文件：

{
  "name": "MyPlugin",
  "entrance": "your.group.name.myplugin.MyPlugin",
  "authors": ["yourname"],
  "version": "0.1.0",
  "description": "你的插件描述",
  "website": "你的插件网站",
  "dependencies": [
     {
         "name": "AnotherPlugin1"
     },
     {
         "name": "AnotherPlugin2",
         "version": ">=0.1.0",
         "optional": true
     }
 ]
}

编辑plugin.json时，有几点需要注意：

  • 字段description、website和dependencies可以省略
  • 插件的version必须是有效的语义版本，否则插件不会被加载
  • 当前公开的插件描述文件架构中，dependencies里的每一项可以填写name、version和optional

运行包含插件的服务器

如果使用了AllayGradle插件（JavaPluginTemplate中已包含），可以直接从项目运行服务器：

./gradlew runServer

构建插件

要构建插件，运行：

./gradlew shadowJar

生成的文件会位于：

build/libs/MyPlugin-1.0.0-shaded.jar

然后将其复制到Allay服务器的plugins目录中使用。

现在你已经准备好为Allay创建自己的插件了！🎉

接下来，建议学习以下内容：

评论