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-library'
    id("org.spongepowered.plugin") version '0.11.3'
}

// 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 {
    mavenCentral()
}

sponge {
    apiVersion("8.1.0")
    licence("MIT")
    loader {
        name(PluginLoaders.JAVA_PLAIN)
        version("1.0")
    }
    plugin("**plugin Id**") {
        displayName("**Plugin Name**")
        entrypoint("**Plugin Entrypoint**")
        description("**Plugin Description**")
        dependency("spongeapi") {
            loadOrder(PluginDependency.LoadOrder.AFTER)
            optional(false)
        }
    }
}

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

  • Podstawowe ustawienia Gradle Java

  • 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.

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-repo'
        url = 'https://repo.spongepowered.org/repository/maven-public/'
    }
}

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