设置 Maven

把下面的内容加入你项目的 pom.xml 中的 <project> 块以添加对 SpongeAPI 的依赖:

<repositories>
    <repository>
        <id>sponge</id>
        <url>https://repo.spongepowered.org/maven</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>org.spongepowered</groupId>
        <artifactId>spongeapi</artifactId>
        <version>5.1.0</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

使用插件原型(Archetype)

此外,Sponge 有一个用于生成插件的基本结构的简单原型。

生成的 pom 包括一个发布配置文件,该配置文件根据将项目提交到 Sonatype OSS 的指南中的建议,为 JavaDocs 、二进制、和源代码等生成 GPG 签名的 JAR(但是,这目前不适用于 Sponge 插件,因为 Sponge API 目前不在 Maven Central 上托管)。

属性

插件原型接受几个属性:

属性名

示例值

说明

groupId

io.github.user

Maven 的 Group ID,在插件相互依赖时很有用处,不过它应和你插件的包名相符

artifactId

myproject

项目 ID,一般是插件 ID 和生成的文件夹的名称

version

1.0-SNAPSHOT

插件的初始版本号。可以(也应该)在开发过程中不断上升

package

io.github.user.myproject

你的插件类对应的包

githubProject

user/repo

Github 项目。如果这一值不是 user/repo 的话,那么 Issue Tracking 和 SCM Section 将被添加到 pom 中

这些可以在 Maven 中以 -Dproperty=value 的方式加入命令行参数

使用方法

插件原型需要 Maven 3 或更高版本。调用 Maven 的目标是 archetype:generate 。Maven 将提示所有需要的属性,同时所有可选的属性必须在命令行参数中声明。

$ mvn archetype:generate -DarchetypeArtifactId=sponge-plugin-archetype -DarchetypeGroupId=org.spongepowered -DarchetypeRepository=http://repo.spongepowered.org/maven -DarchetypeVersion=1.2 -DgithubProject=waylon531/spongeparty

前四个参数指定 Maven 可以使用哪个原型及其版本。 -DgithubProject=waylon531/spongeparty 参数是一个可选的属性,你可以在生成项目时留下来,也可以直接丢弃它,如果你不想在 GitHub 上发布插件的话。

当你的项目生成完成后,你需要将其导入你的 IDE。具体内容参见 设置开发环境 部分。