Настройка Gradle

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

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

Совет

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

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

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

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

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

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

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

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

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

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

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

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

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

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