建置系統

諸如 GradleMaven 等建置系統能夠幫助你管理你的專案的建置流程。作為一個與 IDE 無關的獨立工具,你可以使用它們來管理你對 SpongeAPI 或其他插件的依賴,並給予其他人一種從原始碼建置你的插件的簡易方式。

備註

對於建立 SpongeAPI 插件而言,建置系統並不是必要的,然而我們強烈建議使用它。除了不使用建置系統建立插件這部份之外,以下部分將假設你正在使用一個可以協助你管理依賴的建置系統。

一般來說,你可以使用任何支援 Maven 依賴的建置系統,而 Java 專案的建置系統大多支援該標準。以下章節將著重於 GradleMaven 這兩個最普遍被選擇的建置系統。如果你不確定要使用何者,我們推薦使用 Gradle,因為它也能使用於 Sponge 插件,並為 Sponge 插件提供最佳整合。

Gradle

Gradle 使用基於 GroovyKotlin 的腳本來設定專案。一個 Gradle 專案通常由一個位於專案根目錄的 build.gradle 檔案構成,用來告知 Gradle 如何建置該專案。

小訣竅

請參閱 Gradle User Guide 以了解 Gradle 如何安裝與一般概念的介紹,如果你只對如何將 Gradle 應用於一個簡單的 Java 專案感興趣,那麼 Gradle Java Quickstart 會是個作為開始的好地方。

根據 建立你的工作空間 解釋的方式設定你的工作空間,接著按照 設定 Gradle 的引導去做。

Maven

Maven 使用名為 Project Object Model(或 POM)這個基於 XML 的設定檔來設定專案,一個 Maven 專案通常在專案根目錄包含一個 pom.xml 檔案,用來告知 Maven 如何建置專案。

小訣竅

請參閱 Maven Users Centre 以了解 Maven 如何安裝與一般概念的介紹,如果你只對如何將 Maven 應用於一個簡單的 Java 專案感興趣,那麼 Maven in 5 Minutes 會是個作為開始的好地方。

根據 建立你的工作空間 解釋的方式設定你的工作空間,接著按照 設定 Maven 的引導去做。

不使用建置系統建立插件

建立 Sponge 插件也可以不使用建置系統,而只使用你的 IDE 所包含的工具。

警告

我們十分不建議在沒有建置系統的情況下使用 SpongeAPI。長遠來看,使用建置系統將簡化你與想對你專案給予貢獻的其他人的開發流程。這種開發插件的方式將不會受到 Sponge 團隊的活躍測試。

對於不使用建置系統開發插件,你必須從 SpongeAPI Download Page 手動下載 SpongeAPI 依賴。為了不使用建置系統,我們提供了 shaded 這個 artifact,這將使用建置系統自動下載的所有依賴集中在一起。

在你下載 shaded artifact 並將其加到你的 IDE 中的專案後,你可以開始開發插件了。根據 插件識別碼 選個專案 ID,接著按照 主要的插件 Class 繼續。