Configuración de Gradle

Utilización de SpongeGradle

El uso de SpongeGradle es muy simple y le permite minimizar la configuración necesaria de Gradle para configurar un complemento de Sponge en Gradle. Adicionalmente, proporciona integración para Metadatos del Complemento, ya que automáticamente contribuye al grupo, al nombre del proyecto, a la versión y a la descripción definidos en su script de compilación con el complemento compilado, solo necesita actualizar su versión del complemento en un archivo.

Truco

Muchos problemas son causados al intentar utilizar una versión anterior de Gradle. Recomendamos utilizar la última versión deGradle junto con SpongeGradle. La sección de Gradle de la página del sistema de compilación explica como configurar Gradle en su computadora.

A continuación se muestra una plantilla simple que debería ser utilizable por la mayoría de los complementos. Asegúrese de reemplazar el grupo con el ID del grupo que ha escogido antes.

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

Estas pocas líneas se encargan de la mayoría de las configuraciones que normalmente haría manualmente:

• Configuración Básica de Gradle Java

• Establezca su proyecto para compilar con Java 8

• Agregar el repositorio Maven de Sponge (y Maven Central)

• Configure un complemento con el nombre del proyecto en minúsculas como ID del complemento

• Automatically includes the project name, description and version in Metadatos del Complemento.

Establezca manualmente el ID del complemento

Por defecto, el complemento Gradle configurará su ID del complemento con el nombre del proyecto (en minúsculas) que haya configurado. Si quiere utilizar un ID del complemento personalizado y todavía utilizar la integración Metadatos del Complemento puede cambiarlo manualmente:

sponge {
    plugin {
        id = 'pluginidgoeshere'
    }
}

Sobrescribir valores predeterminados

By default, the Gradle plugin will contribute the plugin name, plugin version, and description automatically to Metadatos del Complemento 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/'
        }
    }
}

También puede eliminar completamente un valor predeterminado:

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

Sin SpongeGradle

Advertencia

Recomendamos utilizar SpongeGradle para complementos de Gradle ya que proporcionará integración adicional de Gradle para complementos de Sponge.

Generalmente, todo lo necesario para compilar un plugin de Sponge utilizando Gradle puede ser hecho al simplemente agregando la dependencia SpongeAPI a su proyecto:

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

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