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

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

• Automatycznie umieszcza nazwę projektu, opis i version w 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 = 'pluginidgoeshere'
    }
}

Zastępowanie ustawień domyślnych

Domyślnie, plugin (wtyczka) Gradle automatycznie prześle nazwę pluginu, wersję pluginu oraz opis do Metadane Wtyczek z ustawieniami domyślnymi zdefiniowanymi we właściwościach projektu. Możliwe jest również nadpisanie tych danych jeśli chcesz określić je manualnie:

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

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

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

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