Updated for 1.21.4

Deprecated Pair (Alternatives exist in other libraries)
Deprecated UUID CODEC (One in neoforge now)
Massive Cleanup
Javadoc Improvements
Removed `DatTeleport` (Teleporting has changed)

Author: jtljac

build.gradle

@@ -1,8 +1,7 @@
 import net.darkhax.curseforgegradle.TaskPublishCurseForge
 
 plugins {
-    id 'net.neoforged.gradle' version '[6.0.18,6.2)'
-    id 'org.parchmentmc.librarian.forgegradle' version '1.+'
+    id 'net.neoforged.moddev' version '1.0.23'
 
     id 'idea'
 
@@ -21,91 +20,129 @@ base {
 }
 
 java {
-    toolchain.languageVersion = JavaLanguageVersion.of(17)
+    toolchain.languageVersion = JavaLanguageVersion.of(21)
 
     withJavadocJar()
     withSourcesJar()
 }
 
-minecraft {
-    mappings channel: mapping_channel, version: "${parchment_version}-${minecraft_version}"
+neoForge {
+    // Specify the version of NeoForge to use.
+    version = project.neo_version
 
-    // accessTransformer = file('src/main/resources/META-INF/accesstransformer.cfg')
+    parchment {
+        mappingsVersion = project.parchment_version
+        minecraftVersion = project.minecraft_version
+    }
 
-    copyIdeResources = true
+    // This line is optional. Access Transformers are automatically detected
+    // accessTransformers = project.files('src/main/resources/META-INF/accesstransformer.cfg')
 
     // Default run configurations.
-    // These can be tweaked, removed, or duplicated as needed.
     runs {
-        // applies to all the run configs below
-        configureEach {
-            workingDirectory project.file('run')
-
-            // Recommended logging data for a userdev environment
-            // The markers can be added/remove as needed separated by commas.
-            // "SCAN": For mods scan.
-            // "REGISTRIES": For firing of registry events.
-            // "REGISTRYDUMP": For getting the contents of all registries.
-            property 'forge.logging.markers', 'REGISTRIES'
-
-            property 'forge.logging.console.level', 'debug'
-
-            mods {
-                "${mod_id}" {
-                    source sourceSets.main
-                }
-            }
-        }
-
         client {
-            property 'forge.enabledGameTestNamespaces', mod_id
-            property 'mixin.env.remapRefMap', 'true'
-            property 'mixin.env.refMapRemappingFile', "${buildDir}/createSrgToMcp/output.srg"
+            client()
+
+            // Comma-separated list of namespaces to load gametests from. Empty = all namespaces.
+            systemProperty 'neoforge.enabledGameTestNamespaces', project.mod_id
         }
 
         server {
-            property 'forge.enabledGameTestNamespaces', mod_id
-            property 'mixin.env.remapRefMap', 'true'
-            property 'mixin.env.refMapRemappingFile', "${buildDir}/createSrgToMcp/output.srg"
-            args '--nogui'
+            server()
+            programArgument '--nogui'
+            systemProperty 'neoforge.enabledGameTestNamespaces', project.mod_id
         }
 
+        // This run config launches GameTestServer and runs all registered gametests, then exits.
+        // By default, the server will crash when no gametests are provided.
+        // The gametest system is also enabled by default for other run configs under the /test command.
         gameTestServer {
-            property 'forge.enabledGameTestNamespaces', mod_id
+            type = "gameTestServer"
+            systemProperty 'neoforge.enabledGameTestNamespaces', project.mod_id
         }
 
-        data {
-            // example of overriding the workingDirectory set in configureEach above
-            workingDirectory project.file('run-data')
+        clientData {
+            clientData()
+
+            // example of overriding the workingDirectory set in configureEach above, uncomment if you want to use it
+            // gameDirectory = project.file('run-data')
 
             // Specify the modid for data generation, where to output the resulting resource, and where to look for existing resources.
-            args '--mod', mod_id, '--all', '--output', file('src/generated/resources/'), '--existing', file('src/main/resources/')
+            programArguments.addAll '--mod', project.mod_id, '--all', '--output', file('src/generated/resources/').getAbsolutePath(), '--existing', file('src/main/resources/').getAbsolutePath()
+        }
+
+        // applies to all the run configs above
+        configureEach {
+            // Recommended logging data for a userdev environment
+            // The markers can be added/remove as needed separated by commas.
+            // "SCAN": For mods scan.
+            // "REGISTRIES": For firing of registry events.
+            // "REGISTRYDUMP": For getting the contents of all registries.
+            systemProperty 'forge.logging.markers', 'REGISTRIES'
+
+            // Recommended logging level for the console
+            // You can set various levels here.
+            // Please read: https://stackoverflow.com/questions/2031163/when-to-use-the-different-log-levels
+            logLevel = org.slf4j.event.Level.DEBUG
         }
     }
+
+    mods {
+        // define mod <-> source bindings
+        // these are used to tell the game which sources are for which mod
+        // mostly optional in a single mod project
+        // but multi mod projects should define one per mod
+        "${mod_id}" {
+            sourceSet(sourceSets.main)
+        }
+    }
+
+    unitTest {
+        // Enable JUnit support in the moddev plugin
+        enable()
+        // Configure which mod is being tested.
+        // This allows NeoForge to load the test/ classes and resources as belonging to the mod.
+        testedMod = mods."${mod_id}"
+    }
 }
 
 // Include resources generated by data generators.
 sourceSets.main.resources { srcDir 'src/generated/resources' }
 
+// Sets up a dependency configuration called 'localRuntime'.
+// This configuration should be used instead of 'runtimeOnly' to declare
+// a dependency that will be present for runtime testing but that is
+// "optional", meaning it will not be pulled by dependents of this mod.
+configurations {
+    runtimeClasspath.extendsFrom localRuntime
+}
+
 /* -------------------------------------------- */
 /*  Dependencies                                */
 /* -------------------------------------------- */
 
-repositories {}
+repositories {
+    mavenLocal()
+}
 
 dependencies {
-    minecraft "net.neoforged:forge:${minecraft_version}-${neo_version}"
-
     // Testing
     testImplementation "org.junit.jupiter:junit-jupiter-api:${junit_version}"
     testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:${junit_version}"
+    testImplementation "net.neoforged:testframework:${neo_version}"}
+
+idea {
+    module {
+        downloadSources = true
+        downloadJavadoc = true
+    }
 }
 
 /* -------------------------------------------- */
 /*  Tasks                                       */
 /* -------------------------------------------- */
 
-tasks.named('processResources', ProcessResources).configure {
+var generateModMetadata = tasks.register("generateModMetadata", ProcessResources) {
     var replaceProperties = [
             minecraft_version: minecraft_version, minecraft_version_range: minecraft_version_range,
             neo_version: neo_version, neo_version_range: neo_version_range,
@@ -115,12 +152,17 @@ tasks.named('processResources', ProcessResources).configure {
     ]
 
     inputs.properties replaceProperties
-
-    filesMatching(['META-INF/mods.toml', 'pack.mcmeta']) {
-        expand replaceProperties + [project: project]
-    }
+    expand replaceProperties
+    from "src/main/templates"
+    into "build/generated/sources/modMetadata"
 }
 
+// Include the output of "generateModMetadata" as an input directory for the build
+// this works with both building through Gradle and the IDE.
+sourceSets.main.resources.srcDir generateModMetadata
+// To avoid having to run "generateModMetadata" manually, make it run on every project reload
+neoForge.ideSyncTask generateModMetadata
+
 tasks.named('jar', Jar).configure {
     manifest {
         attributes([
@@ -133,8 +175,6 @@ tasks.named('jar', Jar).configure {
                 "Implementation-Timestamp": new Date().format("yyyy-MM-dd'T'HH:mm:ssZ")
         ])
     }
-
-    finalizedBy 'reobfJar'
 }
 
 tasks.register('printVersion') {

checkstyle.xml

@@ -59,6 +59,9 @@
     <!--No Tabs-->
     <module name="FileTabCharacter"/>
 
+    <module name="LineLength">
+        <property name="max" value="120"/>
+    </module>
 
     <module name="NewlineAtEndOfFile"/>
 

gradle.properties

@@ -1,23 +1,28 @@
-org.gradle.jvmargs=-Xmx3G
-org.gradle.daemon=false
+org.gradle.jvmargs=-Xmx1G
+org.gradle.daemon=true
+org.gradle.parallel=true
+org.gradle.caching=true
+org.gradle.configuration-cache=true
 
 release_postfix=
 
-minecraft_version=1.20.1
-minecraft_version_range=[1.20.1,1.21)
-neo_version=47.1.65
-neo_version_range=[47.1,)
-loader_version_range=[47,)
+minecraft_version=1.21.4
+minecraft_version_range=[1.21.4,1.22)
+neo_version=21.4.11-beta
+neo_version_range=[21.4.0-beta,)
+loader_version_range=[4,)
 
 mapping_channel=parchment
-parchment_version=2023.08.20
+parchment_version=2024.12.07
 
 junit_version=5.10+
+neogradle.subsystems.conventions.ide.idea.reconfigure-unit-test-templates=true
+
 
 mod_id=datmoddingapi
 mod_name=Dat Modding API
 mod_license=MIT
-mod_version=1.8.0
+mod_version=1.9.0
 mod_group_id=com.datdeveloper
 mod_authors=jtljac
 mod_description=A modding library for DatDeveloper

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.1.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.11.1-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

settings.gradle

@@ -1,5 +1,6 @@
 pluginManagement {
     repositories {
+        mavenLocal()
         gradlePluginPortal()
         maven { url = 'https://maven.neoforged.net/releases' }
         maven { url = 'https://maven.parchmentmc.org' }
@@ -8,7 +9,7 @@ pluginManagement {
 }
 
 plugins {
-    id 'org.gradle.toolchains.foojay-resolver-convention' version '0.5.0'
+    id 'org.gradle.toolchains.foojay-resolver-convention' version '0.9.0'
 }
 
 rootProject.name = 'datmoddingapi'

src/main/java/com/datdeveloper/datmoddingapi/DatConfig.java

@@ -1,37 +1,37 @@
 package com.datdeveloper.datmoddingapi;
 
-import net.minecraftforge.common.ForgeConfigSpec;
-import net.minecraftforge.common.ForgeConfigSpec.ConfigValue;
+import net.neoforged.neoforge.common.ModConfigSpec;
 
 /**
  * The config for DatModdingAPI
  */
-@SuppressWarnings("HideUtilityClassConstructor")
 public class DatConfig {
-    private static ConfigValue<Integer> delayedEventsPerTick;
-    private static ConfigValue<Integer> maxConcurrentThreadCount;
-    DatConfig(final ForgeConfigSpec.Builder builder) {
-        delayedEventsPerTick = builder
-                .comment("The amount of delayed events that are processed a tick, less is quicker")
-                .defineInRange("DelayedEventsPerTick", 1, 0, Integer.MAX_VALUE);
-
-        maxConcurrentThreadCount = builder
-                .worldRestart()
-                .comment("The maximum number of threads to use for executing concurrent tasks")
-                .comment("More threads means more concurrent tasks can be executed at the same time")
-                .comment("Too many threads can hog resources, and lots of threads only helps when there are many concurrent tasks")
-                .comment("You probably don't want to change this if you don't know it is")
-                .defineInRange("MaxAsyncThreadCount", 2, 1, Integer.MAX_VALUE);
-    }
-
     private DatConfig() {
+
     }
 
+    private static final ModConfigSpec.Builder BUILDER = new ModConfigSpec.Builder();
+
+    private static final ModConfigSpec.IntValue DELAYED_EVENTS_PER_TICK = BUILDER
+            .comment("The amount of delayed events that are processed a tick, less is quicker")
+            .defineInRange("DelayedEventsPerTick", 1, 0, Integer.MAX_VALUE);
+
+    private static final ModConfigSpec.ConfigValue<Integer> MAX_CONCURRENT_THREAD_COUNT = BUILDER
+            .worldRestart()
+            .comment("The maximum number of threads to use for executing concurrent tasks")
+            .comment("More threads means more concurrent tasks can be executed at the same time")
+            .comment("Too many threads can hog resources, and lots of threads only helps when there are many concurrent"
+                             + " tasks")
+            .comment("You probably don't want to change this if you don't know it is")
+            .defineInRange("MaxAsyncThreadCount", 2, 1, Integer.MAX_VALUE);
+
+    static final ModConfigSpec SPEC = BUILDER.build();
+
     public static int getDelayedEventsPerTick() {
-        return delayedEventsPerTick.get();
+        return DELAYED_EVENTS_PER_TICK.get();
     }
 
     public static int getMaxConcurrentThreadCount() {
-        return maxConcurrentThreadCount.get();
+        return MAX_CONCURRENT_THREAD_COUNT.get();
     }
 }