设置 Gradle

使用 SpongeGradle

使用 SpongeGradle 非常简单，它允许你尽可能减少用于 Sponge 插件上必要的 Gradle 配置。此外，它为 Gradle 提供了对插件的元数据的集成，从而在构建插件时自动添加 Group ID、项目名、版本号等在构建脚本中定义的值，因此你只需要在一个文件里更新你的插件版本。

小技巧

很多问题的原因都和使用过时的 Gradle 版本有关。我们十分建议开发者使用 SpongeGradle 时搭配最新的 Gradle 版本。你可以查看相关页面来了解如何在你的计算机上安装并使用 Gradle。

下面是一个可以用于大部分插件的一个简单模板。 请确保你已经把 Group ID 替换成了对应于你的插件的 Group ID。

plugins {
    id 'org.spongepowered.plugin' version '0.8.1'
}

group = 'com.example' // TODO
version = '1.0-SNAPSHOT'
description = 'An example plugin'

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

这几行用于处理你通常会手动完成的大部分设置：

基本的 Gradle Java 设置
请设置你的项目使用 Java 8 编译
添加 Sponge 的 Maven 库（和中央库，Maven Central）
设置你的项目的插件名称为 plugin ID ，并全部使用小写字母
在插件的元数据中自动包含项目名称、说明和版本。

手动设置插件 ID

转为情况下，Gradle 插件将使用你的项目名称的小写字母形式配置你的插件 ID（plugin ID）。如果你想要使用一个自定义的 plugin ID 而仍然使用插件的元数据的集成，你可以这样手动修改它：

sponge {
    plugin {
        id = 'mypluginid'
    }
}

覆盖默认值

默认情况下，Gradle 插件将使用插件的元数据设置你在项目属性中定义的插件名称、插件版本、和说明（ plugin name ， plugin version 和 description ）。你也可以手动覆盖它们：

sponge {
    plugin {
        meta {
            name = 'My Plugin'
            version = '1.0.0'
            description = 'This is a plugin'
        }
    }
}

你也可以完全删除一个默认值：

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

不使用 SpongeGradle

警告

我们建议使用名为 SpongeGradle 的 Gradle 插件，以在使用 Gradle 的同时，享受 Sponge 插件的相关集成带来的便利。

一般说来，一切必要的编译一个 Sponge 插件的工作都可以通过在你的项目中使用 Gradle 并简单地把 SpongeAPI 添加到依赖（Dependency）中来完成：

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

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