Konfigurowanie Gradle

Używanie SpongeGradle

Korzystanie z SpongeGradle jest bardzo proste i pozwala Ci zminimalizować potrzebną konfigurację Gradle do utworzenia pluginu na Sponge. Dodatkowo, zapewnia integrację dla Metadane Wtyczek, na przykład, automatyczne dodawanie grupy, nazwy projektu, wersji oraz opisu zdefiniowanego w Twoim skrypcie budowy projektu do tworzonego pluginu, tak abyś musiał zmieniać wersję tylko w jednym pliku.

Wskazówka

Większość problemów jest spowodowana próbą użycia przestarzałej wersji Gradle. Zalecamy używanie najnowszej wersji Gradle wraz z SpongeGradle. Sekcja Gradle na stronie systemu komiplacji wyjaśnia jak skonfigurować Gradle na Twoim komputerze.

Poniżej znajduje się prosty szablon, który powinien być użyteczny dla większości pluginów. **Upewnij się że group ID jest takie jakie wybrałeś wcześniej.

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:6.0.0'
}

Te kilka linijek jest odpowiedzialne za większość ustawień, które normalnie musiałbyś zrobić ręcznie:

• Podstawowe ustawienia Gradle Java

• Ustaw swój projekt do kompilacji z Java 8

• Dodaj repozytorium Maven Sponge (i Maven Central)

• Skonfiguruj plugin, dodają w nim nazwę projektu pisną małymi literami jako plugin ID

• Automatically includes the project name, description and version in Metadane Wtyczek.

Ręczne ustawianie ID pluginu

Domyślnie, plugin (wtyczka) Gradle skonfiguruje Twoje ID pluginu z nazwą projektu (napisaną małymi literami), którą ustawiłeś. Jeśli chcesz użyć niestandardowego ID pluginu i dalej używać integracje z Metadane Wtyczek, możesz zmienić je manualnie:

sponge {
    plugin {
        id = 'mypluginid'
    }
}

Zastępowanie ustawień domyślnych

By default the Gradle plugin will contribute the plugin name, plugin version and description automatically to Metadane Wtyczek 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 = 'My Plugin'
            version = '1.0.0'
            description = 'This is a plugin'
        }
    }
}

Możesz także całkowicie usunąć wartość domyślną:

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

Bez SpongeGradle

Ostrzeżenie

Zalecamy użycie SpongeGradle dla pluginów Gradle, ponieważ zapewniają dodatkową integrację z pluginami Sponge.

Generalnie, wszystko co jest potrzebne do skompilowania pluginu (wtyczki) Sponge za pomocą Gradle może być zrobione poprzez dodanie zależności SpongeAPI do Twojego projektu.

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

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