To use Cloud in a Gradle project using Groovy DSL (build.gradle), follow these steps:

1. Add plugins: Ensure java, java-library, and com.github.johnrengelman.shadow (version 8.1.1) are applied.
2. Add the repository: Include https://ci.mg-dev.eu/plugin/repository/everything.
3. Add dependencies: Use compileOnlyApi for BKCommonLib and compileOnly for the Cloud dependencies. Note that if you use Adventure MiniMessage, you may need to add net.kyori:adventure-api and net.kyori:adventure-text-minimessage as implementation dependencies.
4. Shadow/Relocate: Use the shadowJar task to relocate the packages to the com.bergerkiller.bukkit.common.dep prefix.

plugins {
    id "java"
    id "com.github.johnrengelman.shadow" version "8.1.1"
    id "java-library"
}

repositories {
    mavenCentral()
    maven {
        url = "https://ci.mg-dev.eu/plugin/repository/everything"
    }
}

dependencies {
    // BKCommonLib
    compileOnlyApi("com.bergerkiller.bukkit:BKCommonLib:1.21.1-v1")

    // Cloud integrated in BKCommonLib
    compileOnly("org.incendo:cloud-paper")
    compileOnly("org.incendo:cloud-annotations")
    compileOnly("org.incendo:cloud-minecraft-extras")

    // Adventure MiniMessage
    implementation("net.kyori:adventure-api:4.14.0")
    implementation("net.kyori:adventure-text-minimessage:4.14.0")
}

tasks.shadowJar {
    def commonPrefix = "com.bergerkiller.bukkit.common.dep"
    relocate("org.incendo.cloud", "${commonPrefix}.cloud")
    relocate("io.leangen.geantyref", "${commonPrefix}.typetoken")
    relocate("me.lucko.commodore", "${commonPrefix}.me.lucko.commodore")
    relocate("net.kyori", "${commonPrefix}.net.kyori")
}

If you cannot find a matching Mojang-style name for a Spigot class (handle or otherwise), use the SpigotMappingTest.testVisualizeMappings() helper to find the mapping.

1. Open src/test/java/com/bergerkiller/bukkit/common/SpigotMappingTest.java.
2. Locate the testVisualizeMappings() method.
3. Replace the example argument with the fully-qualified Spigot class name (or a keyword) you wish to investigate.
4. Run the test via your IDE or Gradle.

The visualization will print the known mappings, showing the associated Mojang name(s) and versions. For more specific lookups, you can use visualizeMappingsForSpigotClass or visualizeMappingsForMojangClass.

// example: visualize the mapping for the old Spigot packet class
mappings.visualizeMapping("net.minecraft.network.protocol.game.PacketPlayOutStatistic");

To run via Gradle:

./gradlew test --tests "com.bergerkiller.bukkit.common.SpigotMappingTest.testVisualizeMappings"

To use Cloud in a Gradle project using Kotlin DSL (build.gradle.kts), follow these steps:

1. Requirement: Use Gradle 8.5 or newer.
2. Add the repository: Include https://ci.mg-dev.eu/plugin/repository/everything/.
3. Add dependencies: Use compileOnlyApi for BKCommonLib and compileOnly for the Cloud dependencies (cloud-paper, cloud-annotations, cloud-minecraft-extras). Do not specify versions for Cloud; they are provided by BKCommonLib.
4. Shadow/Relocate: Use the com.github.johnrengelman.shadow plugin to relocate the packages to the com.bergerkiller.bukkit.common.dep prefix.

repositories {
    maven("https://ci.mg-dev.eu/plugin/repository/everything/")
}

dependencies {
    compileOnlyApi("com.bergerkiller.bukkit:BKCommonLib:1.21.1-v1")

    // Cloud integrated in BKCommonLib
    compileOnly("org.incendo:cloud-paper")
    compileOnly("org.incendo:cloud-annotations")
    compileOnly("org.incendo:cloud-minecraft-extras")
}

plugins {
    id("com.github.johnrengelman.shadow") version "8.1.1"
    id("java-library")
}

tasks {
    shadowJar {
        val commonPrefix = "com.bergerkiller.bukkit.common.dep"
        relocate("org.incendo.cloud", "$commonPrefix.cloud")
        relocate("io.leangen.geantyref", "$commonPrefix.typetoken")
        relocate("me.lucko.commodore", "$commonPrefix.me.lucko.commodore")
        relocate("net.kyori", "$commonPrefix.net.kyori")
    }
}

To use Cloud in a Maven project, follow these steps:

1. Add the BKCommonLib repository to your pom.xml.
2. Import the BKCommonLib-bom in the <dependencyManagement> section to manage versions automatically.
3. Add the dependencies (BKCommonLib, cloud-paper, cloud-annotations, and cloud-minecraft-extras) with provided scope.
4. Configure the maven-shade-plugin to relocate the Cloud and related packages to the BKCommonLib shaded paths. This step is mandatory for runtime stability.

Required Relocations:

• org.incendo.cloud $\rightarrow$ com.bergerkiller.bukkit.common.dep.cloud
• io.leangen.geantyref $\rightarrow$ com.bergerkiller.bukkit.common.dep.typetoken
• me.lucko.commodore $\rightarrow$ com.bergerkiller.bukkit.common.dep.me.lucko.commodore
• net.kyori $\rightarrow$ com.bergerkiller.bukkit.common.dep.net.kyori

<!-- See full Maven configuration in documentation -->