GradleGalaxy/xyz.srnyx.gradlegalaxy.utility

Package-level declarations

Types

Link copied to clipboard
class SemanticVersion(version: String) : Comparable<SemanticVersion>

A class to represent a semantic version (example: 1.19.2)

Functions

Link copied to clipboard
fun Project.addBuildShadowTask()

Adds the task that makes gradle build run gradle shadowJar

Link copied to clipboard
fun Project.addCompilerArgs(vararg args: String)

Adds the specified compiler arguments to the project

Link copied to clipboard
fun Project.addJavadocSourcesJars(javadocClassifier: String? = null, sourcesClassifier: String? = null)

Adds the task that generates the Javadoc and sources jar files

Link copied to clipboard
fun Project.addReplacementsTask(files: Set<String> = setOf("plugin.yml"), replacements: Map<String, String> = getDefaultReplacements())

Configures the ProcessResources task to add replacements

Link copied to clipboard
fun Project.adventure(vararg dependencies: AdventureDependency, configurationAll: String? = null)
Link copied to clipboard
fun Project.annoyingAPI(config: DependencyConfig): ExternalModuleDependency
Link copied to clipboard
fun <T : ModuleDependency> Project.dependencyRelocate(dependency: T, relocateFrom: String, relocateTo: String = ".libs.", configuration: String = "implementation", configurationAction: T.() -> Unit = {}): T
fun Project.dependencyRelocate(dependency: String, relocateFrom: String = dependency.split(":").first(), relocateTo: String = ".libs.", configuration: String = "implementation", configurationAction: ExternalModuleDependency.() -> Unit = {}): ExternalModuleDependency
Link copied to clipboard
fun Project.getAnnoyingApiMetadata(version: String): AnnoyingMetadata?

Gets the metadata for the Annoying API with the specified version

Link copied to clipboard
fun Project.getDefaultReplacements(): Map<String, String>

Returns the default replacements map for addReplacementsTask

Link copied to clipboard
fun getEnvironmentVariable(name: String): String?

Gets the environment variable with the specified name

Link copied to clipboard
fun Project.getJavaExtension(): JavaPluginExtension

Gets the Java plugin extension

Link copied to clipboard
fun getJavaVersionForMC(minecraftVersion: String): JavaVersion

Returns the correct Java version that is required for the Minecraft version

Link copied to clipboard
fun Project.getPackage(): String

Gets the main package of the project

Link copied to clipboard
fun Project.getPublishing(): PublishingExtension
Link copied to clipboard
fun getVersionString(version: String): String

Returns the version string with -R0.1-SNAPSHOT appended to it

Link copied to clipboard
fun Project.hasApplicationPlugin(): Boolean

Checks if the application plugin is applied

Link copied to clipboard
fun Project.hasJavaPlugin(): Boolean

Checks if the java plugin is applied

Link copied to clipboard
fun Project.hasPublishPlugin(): Boolean

Checks if the maven-publish plugin is applied

Link copied to clipboard
fun Project.hasShadowPlugin(): Boolean

Checks if the Shadow plugin is applied

Link copied to clipboard
fun Project.jda(config: DependencyConfig): ExternalModuleDependency
Link copied to clipboard
fun Project.lazyLibrary(config: DependencyConfig): ExternalModuleDependency
Link copied to clipboard
fun Project.magicMongo(config: DependencyConfig): ExternalModuleDependency
Link copied to clipboard
fun makePackageSafe(path: String): String

Makes the given package path safe to use

Link copied to clipboard
fun Project.paper(config: DependencyConfig, spigotConfig: SpigotConfig = SpigotConfig()): ExternalModuleDependency
Link copied to clipboard
fun Project.relocate(from: String, to: String = ".libs.", action: SimpleRelocator.() -> Unit = {})

Relocates the specified package to the specified package

Link copied to clipboard
fun Project.setJavaVersion(version: JavaVersion = JavaVersion.VERSION_1_8)

Sets the Java version for the project

Link copied to clipboard
fun Project.setMainClass(mainClassName: String? = null)

Sets the main class for the project

Link copied to clipboard
fun Project.setShadowArchiveClassifier(classifier: String = "")

Sets the artifact/archive classifier for the JAR and Shadow JAR tasks

Link copied to clipboard
fun Project.setTextEncoding(encoding: String = "UTF-8")

Sets the text encoding for the project

Link copied to clipboard
fun Project.setupAnnoyingAPI(javaSetupConfig: JavaSetupConfig = JavaSetupConfig(), mcSetupConfig: MCSetupConfig = MCSetupConfig(), annoyingSetupConfig: AnnoyingSetupConfig = AnnoyingSetupConfig(), annoyingAPIConfig: DependencyConfig)

Sets up the project using Annoying API. The root project's name must be the same as the one in plugin.yml!

Link copied to clipboard
fun Project.setupJava(config: JavaSetupConfig = JavaSetupConfig())

Sets up the project for a simple Java project

Link copied to clipboard
fun Project.setupJda(javaSetupConfig: JavaSetupConfig = JavaSetupConfig(), jdaSetupConfig: JdaSetupConfig = JdaSetupConfig(), jdaConfig: DependencyConfig)

Sets up the project using JDA (Java-Discord API)

Link copied to clipboard
fun Project.setupLazyLibrary(javaSetupConfig: JavaSetupConfig = JavaSetupConfig(), jdaSetupConfig: JdaSetupConfig = JdaSetupConfig(), jdaConfig: DependencyConfig, lazyLibraryConfig: DependencyConfig)

Sets up the project using Lazy Library

Link copied to clipboard
fun Project.setupMC(javaSetupConfig: JavaSetupConfig = JavaSetupConfig(), mcSetupConfig: MCSetupConfig = MCSetupConfig())

Sets up the project for Minecraft development

Link copied to clipboard
fun Project.setupPublishingEnv(simpleConfig: PublishingSimpleConfig = PublishingSimpleConfig(this), envConfig: PublishingEnvConfig = PublishingEnvConfig()): MavenPublication

Sets up a bit more advanced publishing configuration using environment variables and a custom repository

Link copied to clipboard
fun Project.setupPublishingSimple(config: PublishingSimpleConfig = PublishingSimpleConfig(this)): MavenPublication

Sets up a simple publishing configuration

Link copied to clipboard
fun Project.spigotAPI(config: DependencyConfig, spigotConfig: SpigotConfig = SpigotConfig()): ExternalModuleDependency
Link copied to clipboard
fun Project.spigotNMS(config: DependencyConfig, spigotConfig: SpigotConfig = SpigotConfig()): ExternalModuleDependency