Настройка Gradle

Использование SpongeGradle

SpongeGradle очень прост в использовании и позволяет минимизировать количество действий для создания Sponge плагина на Gradle. Кроме того, он обеспечивает интеграцию с Метаданные плагина, такую как автоматическое внедрение группы, названия проекта, версии и описания, определенных в build скрипте, в сборку вашего плагина. Таким образом вам нужно будет обновлять версию плагина только в одном файле.

Совет

Большинство проблем вызвано использованием устаревшей версии Gradle. Мы рекомендуем использовать последнюю версию Gradle и SpongeGradle. В статье о системах сборки, в разделе о Gradle описано как установить Gradle на свой компьютер.

Ниже приведен простой шаблон, который должен подойти для большинства плагинов. **Не забудьте заменить идентификатор группы в поле group, на ваше значение.* *

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

Эти несколько строк обрабатывают большинство параметров, которые вы обычно делаете вручную:

• Основные настройки Gradle Java

• Настройка проекта для компиляции с Java 8

• Добавление Maven репозитория Sponge (и Maven Central)

• Настройка имени проекта и плагина в нижнем регистре через поле plugin ID

• Автоматически включается в название проекта, описание и версию в:doc:/plugin/plugin-meta.

Ручная настройка идентификатора плагина

По умолчанию, Gradle плагин настроит ваш plugin ID на основании имени проекта (в нижнем регистре) которое было заранее задано. Если вы хотите использовать пользовательский plugin ID и по-прежнему использовать Метаданные плагина интеграцию, то вы можете изменить его вручную:

sponge {
    plugin {
        id = 'pluginidgoeshere'
    }
}

Переопределение значений по умолчанию

По умолчанию Gradle задаст имя плагина, версию плагина и описание автоматически в Метаданные плагина со значениями по умолчанию, определенными в свойствах проекта. Их также можно переопределить, если вы хотите указать их вручную:

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

Также можно полностью удалить значение по умолчанию:

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

Без использования SpongeGradle

Предупреждение

Мы рекомендуем использовать SpongeGradle так как он предоставляет дополнительную интеграцию Gradle с плагинами Sponge.

Как правило, для компиляции Sponge плагина с помощью Gradle, достаточно добавить SpongeAPI в качестве зависимости в ваш проект:

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

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