Gradle einrichten

SpongeGradle verwenden

SpongeGradle zu verwenden ist sehr einfach und erlaubt dir die notwendige Konfiguration, um ein Sponge Plugin mit Gradle einzurichten zu vermindern. Außerdem stellt es eine Integration mit Plugin Metadaten zur Verfügung, so dass es automatisch die Gruppe, den Projektnamen, die Version und die Beschreibung aus dem Build-Script zu dem erstellten Plugin hinzufügt. Dadurch musst du die Plugin-Version nur in einer Datei ändern.

Tipp

Die meisten Probleme werden dadurch verursacht, dass eine veraltete Gradle Version verwendet wird. Wir empfehlen daher immer die neuste Version zusammen mit SpongeGradle. Der Gradle Abschnitt der Build-System Seite erklärt, wie Grade auf deinem Computer installiert wird.

Unten ist eine einfache Vorlage, die für die meisten Plugins funktionieren sollte. Ersetze die Gruppe und Gruppen-ID mit den vorher ausgewählten Werten.

plugins {
    id 'org.spongepowered.plugin' version '0.8.1'
}

group = 'com.example' // TODO
version = '1.0-SNAPSHOT'
description = 'An example plugin'

dependencies {
    compile 'org.spongepowered:spongeapi:5.1.0'
}

Diese wenigen Zeilen verwalten die Meisten Einstellungen, die du sonst selbst machen müsstest:

• Grundeinstellungen von Gradle Java

• Java-Einstellung für das Projekt auf Java 8 stellen

• Sponge Maven Repository hinzufügen (und Maven Central)

• Ein Plugin mit dem Projektnamen in Kleinbuchstaben als Plugin-ID erstellen

• Trägt automatisch den Projektnamen, die Beschreibung und die Version in Plugin Metadaten ein.

Die Plugin ID manuell festlegen

Standardmäßig wird das Gradle-Plugin deine Plugin-ID mit dem Projektnamen (in Kleinbuchstaben), den du konfiguriert hast, konfigurieren. Wenn du eine eigene Plugin-ID und die Plugin Metadaten-Integration verwenden willst, dann kannst du sie manuell ändern:

sponge {
    plugin {
        id = 'mypluginid'
    }
}

Standardwerte überschreiben

Standardmäßig wird das Gradle-Plugin Pluginname, Plugin-Version und Beschreibung automatisch zu Plugin Metadaten mit den Standardwerten in den Projekteinstellungen eintragen. Es ist genauso möglich diese zu überschreiben, wenn du sie manuell ändern willst:

sponge {
    plugin {
        meta {
            name = 'My Plugin'
            version = '1.0.0'
            description = 'This is a plugin'
        }
    }
}

Du kannst einen Standardwert auch komplett entfernen:

sponge {
    plugin {
        meta {
            description = null
        }
    }
}

Ohne SpongeGradle

Warnung

Wir empfehlen SpongeGradle für auf Gradle basierende Plugins zu verwenden, da es zusätzliche Funktionen für Sponge Plugins bereitstellt.

Zum kompilieren eines Sponge Plugins mit Gradle reicht es die SpongeAPI als Abhängigkeit zu deinem Projekt hinzuzufügen:

repositories {
    mavenCentral()
    maven {
        name = 'sponge'
        url = 'https://repo.spongepowered.org/maven'
    }
}

dependencies {
    compile 'org.spongepowered:spongeapi:5.1.0'
}