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 'java'
    id 'org.spongepowered.plugin' version '0.9.0'
}

// This may not be required, but has solved issues in the past
compileJava.options.encoding = 'UTF-8'

// TODO: Change the following to match your information
group = 'com.example'
version = '1.0.0-SNAPSHOT'
description = 'Here lies an example plugin definition'

repositories {
    jcenter()
}

dependencies {
    compile 'org.spongepowered:spongeapi:7.2.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

• Automatically includes the project name, description and version in Plugin Metadaten.

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 = 'pluginidgoeshere'
    }
}

Standardwerte überschreiben

By default, the Gradle plugin will contribute the plugin name, plugin version, and description automatically to Plugin Metadaten with defaults defined in the project properties. It is also possible to override these if you want to specify them manually:

sponge {
    plugin {
        meta {
            name = 'Example Plugin'
            version = '1.0.0-SNAPSHOT'
            description = 'This is an example plugin'
            url = 'http://www.example.com/'
        }
    }
}

Du kannst einen Standardwert auch komplett entfernen:

sponge {
    plugin {
        meta {
            name = null
            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 {
    jcenter()
    maven {
        name = 'sponge-repo'
        url = 'https://repo.spongepowered.org/maven'
    }
}

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