Skip to content

General features

Raphaël Fromentin edited this page Apr 23, 2021 · 3 revisions

Dependency and Repository shortcuts

ManaDrop includes dependency and repository shortcuts to fastly setup a new Minecraft development environment.

Import shortcuts

You need to import shortcuts before using them.

/*
Static imports are used allowing to use directly methods without calling class explicitly:
spigotRepository() instead of MinecraftRepositoryHelper.spigotRepository()
*/
import static fr.il_totore.manadrop.MinecraftDependencyHelper.*
import static fr.il_totore.manadrop.MinecraftRepositoryHelper.*


plugins {
    id 'java'
    id 'fr.il_totore.manadrop' version '0.2-SNAPSHOT'
}

repositories {
    spigot() //https://hub.spigotmc.org/nexus/content/repositories/snapshots/
    sonatype() //https://oss.sonatype.org/content/repositories/snapshots
}

dependencies {
    implementation spigotApi('1.15') //org.spigotmc:spigot-api:1.15-R0.1-SNAPSHOT
}

Shortcuts

Here is a list of existing shortcuts:

Name Description Type
bukkit The Bukkit API without CraftBukkit and NMS, requiring spigotRepository Dependency
bungeecordApi Bungeecord API requiring sonatypeRepository Dependency
craftbukkit CraftBukkit server including NMS. Requiring mavenLocal Dependency
paperApi The PaperSpigot API without NMS requiring paperRepository Dependency
paperPublic The Paper repository including Paper and Waterfall Repository
sonatype Sonatype's Maven repository Repository
spigotApi The Spigot API without CraftBukkit and NMS, requiring spigotRepository and sonatypeRepository Dependency
spigot The Spigot server including Spigot API, CraftBukkit and NMS. Requiring mavenLocal Dependency
spigotCentral Spigot's Maven main repository Repository
spigotSnapshot Spigot's Maven "SNAPSHOT" repository Repository
waterfallApi Waterfall API. Note Bungeecord plugins works in Waterfall requiring paperRepository Dependency

YAML Validation

You can use the checkYaml task to validate your YAML files like plugin.yml or bungee.yml.

checkYaml {
    check file('src/main/resources/plugin.yml')
    stopOnError true //Unrequired parameter. If set to false, the task will just print the error and skip the broken file.
}

processResources.dependsOn(checkYaml)