Build Systeme

Build Systeme wie Gradle oder Maven können den Build-Prozess von einem Projekt verwalten. Als ein von der IDE unabhängiges Tool kannst du diese nutzen um die Abhängigkeiten von der SpongeAPI oder anderen Plugins zu verwalten und anderen einen einfachen Weg zu bieten dein Plugin aus dem Quellcode zu erstellen.

Bemerkung

Die SpongeAPI verlangt kein Build-System um Plugins zu erstellen, es ist allerdings empfohlen eines zu verwenden. Die folgenden Abschnitte, mit Ausnahme des Abschnitts Ein Plugin ohne Build-System erstellen, gehen davon aus, dass ein Build-System verwendet wird, welches die Abhängigkeiten verwaltet.

Im Allgemeinen kannst du jedes Build-System benutzen, das Maven Abhängigkeiten unterstützt, welches ein Standard ist, der von der Mehrheit der Build Systeme für Java unterstützt wird. Die folgenden Abschnitte werden sich auf Gradle und Maven fokussieren, welche die zwei meist verwendeten Build-Systeme sind. Wenn du unsicher bist, für welches du dich entscheiden sollst, empfehlen wir dir die Benutzung von Gradle, da dies auch für die Sponge Projekte verwendet wird und die beste Integration für Sponge Plugins bietet.

Gradle

Gradle verwendet Groovy-basierte Skripts für die Konfiguration von Projekten. Ein Gradle Projekt besteht typischerweise aus einer build.gradle-Datei im Stammverzeichnis deines Projekts, die Gradle erklärt, wie das Projekt gebaut werden soll.

Tipp

Beziehe dich auf das Gradle User Guide für die Installation und eine allgemeine Einführung in das Konzept von Gradle. Wenn du nur an der Verwendung von Gradle für einfache Java Projekte interessiert bist, wäre der Gradle Java Quickstart ein guter Einstieg.

Richte deine Arbeitsumgebung ein wie in Den Arbeitsbereich einrichten erklärt, folge dann Gradle einrichten.

Maven

Maven verwendet eine XML-basierte Konfiguration namens Project Object Model (oder * POM *) für die Konfiguration von Projekten. Ein Maven-Projekt enthält in der Regel eine pom.xml Datei im Stammverzeichnis des Projekts, die Maven erklärt, wie das Projekt gebaut werden soll.

Tipp

Beziehe dich auf das Maven Users Centre für die Installation und eine allgemeine Einführung in das Konzept von Maven. Wenn du nur an der Verwendung von Maven für einfache Java Projekte interessiert bist, wäre Maven in 5 Minutes ein guter Einstieg.

Richte deine Arbeitsumgebung ein wie in Den Arbeitsbereich einrichten erklärt, folge dann Setting Up Maven.

Ein Plugin ohne Build-System erstellen

Es ist auch möglich Sponge Plugins ohne den Einsatz eines Build Systems, nur mit den mitgelieferten Werkzeugen in deiner IDE zu erstellen.

Warnung

Wir sprechen uns deutlich gegen die Verwendung der SpongeAPI ohne Build-System aus. Auf lange Sichte vereinfacht die Verwendung eines Build-Systems den Entwicklungsprozess für dich und andere, die zu deinem Projekt beitragen möchten. Diese Methode der Entwicklung von Plugins wird nicht aktiv vom Sponge Team getestet.

Für die Entwicklung ohne Build-System musst du zuerst die SpongeAPI händisch von der SpongeAPI Download Page herunterladen. Für die Entwicklung ohne Build-System bieten wir das shaded Artefakt an, dass alle notwendigen Bibliotheken, die normalerweise vom Build-System heruntergeladen würden, beeinhaltet.

Nachdem du das shaded Artefakt heruntergeladen hast und es in der IDE dem Projekt hinzugefügt hast, kannst du die Entwicklung an deinem Plugin beginnen. Fahre fort mit Plugin Identifiers, um eine Identifizierung für dein Projekt zu wählen, und anschließen mit Hauptklasse des Plugins.