构建系统

一些诸如 Gradle 或者 Maven 等构建系统可以帮助你管理你的项目的构建过程。作为一个和 IDE 无关的工具，你可以使用它们来管理你对 SpongeAPI 或者其他的插件的依赖，同时给予其他人一种方便的方式通过源代码构建你的插件。

备注

对于 SpongeAPI 来说，构建系统并 不 是创建插件所必须的，然而我们强烈建议使用构建系统。除了 不使用构建系统创建插件 这一部分，下面的部分将假设你正在使用一个可以方便地管理依赖的构建系统。

一般来说，你可以使用任何支持 Maven 依赖的构建系统，这也是绝大多数的 Java 项目构建系统支持的一项。下面的部分将侧重于 Gradle 和 Maven 这两个最常见的用于构建的选择。如果你不知道使用哪个系统更合适，我们推荐你使用 Gradle 作为构建系统，因为 Sponge 项目本身也在使用 Gradle；此外，使用 Gradle 可以让你在开发 Sponge 插件时体验到最量身定制的特性。

Gradle

Gradle 使用基于 Groovy 或 Kotlin 的脚本来配置项目。一个 Gradle 项目通常包含在你的项目的根目录中，并通过 build.gradle 这一文件告诉 Gradle 如何构建这一项目。

小技巧

请参阅 Gradle User Guide 以了解 Gradle 是如何安装的和一些相关的一般概念。如果你只是对如何把 Gradle 应用于一个新的 Java 项目感兴趣，那么你可以先考虑从 Gradle Java Quickstart 开始。

首先以 设置开发环境 介绍的方式设置你的开发环境，然后按照 设置 Gradle 说的去做。

Maven

Maven 使用基于 XML 的配置，又称为 Project Object Model (or POM) 以完成对项目的配置。一个典型的 Maven 项目在其根目录包含一个 pom.xml 文件，这一文件告诉 Maven 如何构建一个项目。

小技巧

请参阅 Maven User Guide 以了解 Maven 是如何安装的和一些相关的一般概念。如果你只是对如何把 Maven 应用于一个新的 Java 项目感兴趣，那么你可以先考虑从 Maven in 5 Minutes 开始。

首先以 设置开发环境 介绍的方式设置你的开发环境，然后按照 设置 Maven 说的去做。

不使用构建系统创建插件

创建一个 Sponge 插件也可以完全不使用任何构建系统，而只使用你手上的 IDE。

警告

我们十分不建议在没有构建系统的情况下使用 SpongeAPI 。在一个长期的开发过程中，使用构建系统会大大简化你和想要参与协助开发的其他人的开发流程。这种开发 Sponge 插件的方式不会收到 Sponge 团队的主动测试。

如果你不想使用构建系统开发 Sponge 插件，你需要从 SpongeAPI Download Page 中手动下载 SpongeAPI 依赖。为了不使用构建系统开发，我们提供一个 shaded 文件，这一文件把所有本应该使用构建系统自动下载的依赖集中到了一起。

在你下载完 shaded 文件并将其添加到你的 IDE 中的项目后，你可以开始开发你的插件了。你可以依照 插件标识符 这一部分选择你的插件 ID，然后你可以依照 插件的主类 继续你的工作。