Improve gradle build setup

Erdragh · Feb 7, 2025 · ab19875 · ab19875
1 parent c4c321b
commit ab19875
Show file tree

Hide file tree

Showing 22 changed files with 491 additions and 430 deletions.
diff --git a/.gitignore b/.gitignore
@@ -39,6 +39,7 @@ faq
 
 # Minecraft
 **/run
+**/runs
 
 # Architectury
 .architectury-transformer
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,278 +1,12 @@
-import org.jetbrains.kotlin.gradle.utils.extendsFrom
-import java.nio.charset.StandardCharsets
-import java.text.SimpleDateFormat
-import java.util.*
-
 plugins {
-    // Since this mod/bot is written in Kotlin and expected to run on Minecraft and as such
-    // the JVM, the Kotlin plugin is needed
-    alias(libs.plugins.kotlin)
-    // For generating documentation based on comments in the code
-    alias(libs.plugins.dokka)
-    java
-    // Required for NeoGradle
-    idea
-    // For publishing the mod
-    alias(libs.plugins.publish)
-
-    // NeoForge and Common development
-    alias(libs.plugins.moddev) apply false
-    // Fabric development
+    // see https://fabricmc.net/develop/ for new versions
     alias(libs.plugins.loom) apply false
+    // see https://projects.neoforged.net/neoforged/moddevgradle for new versions
+    alias(libs.plugins.moddev) apply false
+    // so we can enable soruce download
+    idea
 }
 
-val minecraftVersion: String by project
-
-repositories {
-    mavenCentral()
-}
-
-subprojects {
-    apply(plugin = "java")
-    apply(plugin = rootProject.libs.plugins.publish.get().pluginId)
-
-    // Gets some values from the gradle.properties files in the
-    // sub- and root projects
-    val modLoader = project.name
-    val modId: String by project
-    val modName = rootProject.name
-    val modAuthor: String by project
-    val isCommon = modLoader == rootProject.projects.common.name
-
-    base {
-        // This will be the final name of the exported JAR file
-        archivesName.set("$modId-$modLoader-$minecraftVersion")
-    }
-
-    extensions.configure<JavaPluginExtension> {
-        toolchain.languageVersion.set(JavaLanguageVersion.of(21))
-        withSourcesJar()
-    }
-
-    repositories {
-        mavenCentral()
-        maven(url = "https://maven.neoforged.net/releases/")
-        maven("https://repo.spongepowered.org/repository/maven-public/") { name = "Sponge / Mixin" }
-        maven("https://maven.blamejared.com") { name = "BlameJared Maven (JEI / CraftTweaker / Bookshelf)" }
-        // For the parchment mappings
-        maven(url = "https://maven.parchmentmc.org")
-        maven(url = "https://maven.resourcefulbees.com/repository/maven-public/")
-        maven {
-            name = "Kotlin for Forge"
-            setUrl("https://thedarkcolour.github.io/KotlinForForge/")
-        }
-        // Forge Config API port
-        maven {
-            name = "Fuzs Mod Resources"
-            setUrl("https://raw.githubusercontent.com/Fuzss/modresources/main/maven/")
-        }
-    }
-
-    // Configuration for JiJ-ed dependencies
-    val includeBotDep by configurations.registering {
-        isTransitive = false
-    }
-    // Configuration for libraries that are needed at runtime
-    val runtimeLib by configurations.registering {
-        isTransitive = false
-    }
-    // Configuration for depending on the common project
-    val commonDep by configurations.creating
-    configurations.implementation.extendsFrom(configurations.named(includeBotDep.name))
-    configurations.implementation.extendsFrom(configurations.named(runtimeLib.name))
-    configurations.implementation.extendsFrom(configurations.named(commonDep.name))
-
-    dependencies {
-        arrayOf(
-            // Library to build a connection with the sqlite database
-            rootProject.libs.sqlite,
-            // Library used to parse and convert markdown
-            rootProject.libs.commonmark,
-
-            // Library used to communicate with Discord, see https://jda.wiki
-            rootProject.jda.jda,
-                // JDA's dependencies
-                rootProject.jda.commons.collections,
-                rootProject.jda.trove4j,
-                rootProject.jda.jackson.annotations,
-                rootProject.jda.jackson.core,
-                rootProject.jda.jackson.databind,
-                rootProject.jda.websocket,
-                rootProject.jda.okhttp,
-                rootProject.jda.okio,
-                rootProject.jda.tink,
-            // Library used for sending messages via Discord Webhooks
-            rootProject.dcwebhooks.webhooks,
-            rootProject.dcwebhooks.json,
-
-            // Library to interact with the SQLite database,
-            // see: https://github.com/JetBrains/Exposed
-            rootProject.exposed.core,
-            rootProject.exposed.dao,
-            rootProject.exposed.jdbc
-        ).forEach {
-            runtimeLib(it) {
-                exclude(module = "opus-java")
-                exclude(group = "org.slf4j")
-                exclude(group = "org.jetbrains.kotlin")
-                exclude(group = "org.jetbrains.kotlinx")
-            }
-            includeBotDep(it) {
-                exclude(module = "opus-java")
-                exclude(group = "org.slf4j")
-                exclude(group = "org.jetbrains.kotlin")
-                exclude(group = "org.jetbrains.kotlinx")
-            }
-        }
-    }
-
-    tasks.test {
-        // There are no tests and the Neo build fails
-        exclude("**/*")
-    }
-
-    java {
-        withSourcesJar()
-        modularity.inferModulePath = true
-    }
-
-    tasks.jar {
-        from(rootProject.file("LICENSE")) {
-            rename { "${it}_$modId" }
-        }
-
-        manifest {
-            attributes(
-                "Specification-Title" to modId,
-                "Specification-Vendor" to modAuthor,
-                "Specification-Version" to archiveVersion,
-                "Implementation-Title" to project.name,
-                "Implementation-Version" to archiveVersion,
-                "Implementation-Vendor" to modAuthor,
-                "Implementation-Timestamp" to SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ").format(Date()),
-                "Timestamp" to System.currentTimeMillis(),
-                "Built-On-Java" to "${System.getProperty("java.vm.version")} (${System.getProperty("java.vm.vendor")})",
-                "Built-On-Minecraft" to minecraftVersion
-            )
-        }
-    }
-
-    tasks.processResources {
-        val version: String by project
-        val group: String by project
-        val minecraftVersionRange: String by project
-        val fabricApiVersion: String by project
-        val fabricLoaderVersion: String by project
-        val fabricKotlinVersion: String by project
-        val neoVersion: String by project
-        val neoVersionRange: String by project
-        val kffLoaderRange: String by project
-        val license: String by project
-        val description: String by project
-        val credits: String by project
-
-        val expandProps = mapOf(
-            "version" to version,
-            "group" to group, //Else we target the task's group.
-            "minecraft_version" to minecraftVersion,
-            "minecraft_version_range" to minecraftVersionRange,
-            "fabric_version" to fabricApiVersion,
-            "fabric_loader_version" to fabricLoaderVersion,
-            "fabric_kotlin_version" to fabricKotlinVersion,
-            "neoforge_version" to neoVersion,
-            "neoforge_loader_version_range" to neoVersionRange,
-            "kff_loader_range" to kffLoaderRange,
-            "mod_name" to modName,
-            "mod_author" to modAuthor,
-            "mod_id" to modId,
-            "license" to license,
-            "description" to description,
-            "credits" to credits
-        )
-
-        filesMatching(listOf("pack.mcmeta", "*.mixins.json", "META-INF/*.mods.toml", "fabric.mod.json")) {
-            expand(expandProps)
-        }
-        inputs.properties(expandProps)
-    }
-
-    if (!isCommon) {
-        dependencies {
-            commonDep(project(":common")) {
-                isTransitive = false
-            }
-        }
-
-        tasks.jar {
-            dependsOn(project(":common").tasks.jar)
-            from(project(":common").sourceSets.main.get().output)
-            duplicatesStrategy = DuplicatesStrategy.EXCLUDE
-        }
-    }
-
-    // Disables Gradle's custom module metadata from being published to maven. The
-    // metadata includes mapped dependencies which are not reasonably consumable by
-    // other mod developers.
-    tasks.withType<GenerateModuleMetadata> {
-        enabled = false
-    }
-
-    tasks.withType<JavaCompile> {
-        options.encoding = "UTF-8"
-        targetCompatibility = JavaVersion.VERSION_21.majorVersion
-        sourceCompatibility = JavaVersion.VERSION_21.majorVersion
-    }
-
-    // Publishing settings
-    if (!isCommon) {
-        publishMods {
-            // These titles get used based on subproject name
-            val titles by extra {
-                mapOf(
-                    "fabric" to "Fabric",
-                    "neoforge" to "NeoForge",
-                    "forge" to "Forge",
-                    "quilt" to "Quilt"
-                )
-            }
-            val curseforgePublish by extra {
-                curseforgeOptions {
-                    accessToken = providers.environmentVariable("CURSEFORGE_TOKEN")
-                    minecraftVersions.add(minecraftVersion)
-                    projectId = providers.environmentVariable("CURSEFORGE_ID")
-                    embeds("sqlite-jdbc")
-                }
-            }
-            val modrinthPublish by extra {
-                modrinthOptions {
-                    accessToken = providers.environmentVariable("MODRINTH_TOKEN")
-                    minecraftVersions.add(minecraftVersion)
-                    projectId = providers.environmentVariable("MODRINTH_ID")
-                    embeds("sqlite-jdbc")
-                }
-            }
-            val changelog by extra {
-                // Only gets the lines for the latest version from the Changelog
-                // file. This allows me to keep all previous changes in the file
-                // without having to worry about them being included on new file
-                // uploads.
-                File(rootDir, "CHANGELOG.md")
-                    .readText(StandardCharsets.UTF_8)
-                    .replace(Regex("[^^](#(#|\\n|.)+)|(^#.+)"), "")
-                    .trim()
-            }
-            val type by extra {
-                STABLE
-            }
-        }
-    }
-}
-
-kotlin {
-    jvmToolchain(21)
-}
-
-
 // IDEA no longer automatically downloads sources/javadoc jars for dependencies, so we need to explicitly enable the behavior.
 idea {
     module {

diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts
@@ -0,0 +1,14 @@
+plugins {
+    id("groovy-gradle-plugin")
+}
+
+dependencies {
+    implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:${libs.versions.kotlin.get()}")
+    implementation("org.jetbrains.dokka:dokka-gradle-plugin:${libs.versions.dokka.get()}")
+    implementation("me.modmuss50:mod-publish-plugin:${libs.versions.publish.get()}")
+}
+
+repositories {
+    mavenCentral()
+    gradlePluginPortal()
+}
diff --git a/buildSrc/settings.gradle.kts b/buildSrc/settings.gradle.kts
@@ -0,0 +1,7 @@
+dependencyResolutionManagement {
+    versionCatalogs {
+        register("libs") {
+            from(files("../libs.versions.toml"))
+        }
+    }
+}