Basic NeoForge mod for Minecraft 1.21

.gitignore

@@ -1,17 +1,15 @@
-# gradle
-/.gradle/
+# IntelliJ
+
+/.idea/
+*.iml
+*.ipr
+*.iws
+
+# Gradle
+
+.gradle/
 build/
 
-# idea
-/.idea/
+# Game
 
-# eclipse
-/bin/
-*.launch
-.settings
-.metadata
-.classpath
-.project
-
-# game
 /run/

build.gradle.kts

@@ -0,0 +1,110 @@
+val javaVersion: String by project
+
+val minecraftVersion: String by project
+val parchmentVersion: String by project
+val kotlinForForgeVersion: String by project
+val neoForgeVersion: String by project
+
+val minecraftVersionRange: String by project
+val neoForgeVersionRange: String by project
+val kotlinForForgeVersionRange: String by project
+
+plugins {
+	idea
+	kotlin("jvm") version "1.9.23"
+	id("net.neoforged.moddev") version "1.0.10" // https://projects.neoforged.net/neoforged/ModDevGradle
+}
+
+idea {
+	module {
+		excludeDirs.add(file("gradle"))
+		excludeDirs.add(file("run"))
+		
+		isDownloadSources = true
+		isDownloadJavadoc = true
+	}
+}
+
+repositories {
+	maven(url = "https://thedarkcolour.github.io/KotlinForForge") {
+		name = "KotlinForForge"
+		content { includeGroup("thedarkcolour") }
+	}
+}
+
+java {
+	toolchain {
+		languageVersion.set(JavaLanguageVersion.of(javaVersion))
+	}
+	
+	manifest {
+		attributes(
+			"Specification-Title" to "hee",
+			"Specification-Vendor" to "chylex",
+			"Specification-Version" to "0",
+			"Implementation-Title" to "Hardcore-Ender-Expansion-2",
+			"Implementation-Vendor" to "chylex",
+			"Implementation-Version" to version,
+		)
+	}
+}
+
+neoForge {
+	version = neoForgeVersion
+	
+	parchment.minecraftVersion.set(minecraftVersion)
+	parchment.mappingsVersion.set(parchmentVersion)
+	
+	runs {
+		configureEach {
+			gameDirectory.set(file("run"))
+			systemProperty("forge.logging.console.level", "debug")
+		}
+		
+		register("client") {
+			ideName.set("Client")
+			client()
+		}
+		
+		register("server") {
+			ideName.set("Server")
+			server()
+		}
+		
+		register("data") {
+			ideName.set("Data")
+			data()
+			
+			programArguments.apply {
+				add("--all")
+				addAll("--mod", "hee")
+				addAll("--existing", file("src/main/resources").absolutePath)
+				addAll("--output", file("src/generated/resources").absolutePath)
+			}
+		}
+	}
+}
+
+dependencies {
+	implementation("thedarkcolour:kotlinforforge-neoforge:$kotlinForForgeVersion")
+}
+
+tasks.withType<JavaCompile> {
+	options.encoding = "UTF-8"
+}
+
+tasks.withType<AbstractArchiveTask>().configureEach {
+	isPreserveFileTimestamps = false
+	isReproducibleFileOrder = true
+}
+
+tasks.processResources {
+	inputs.property("version", version)
+	inputs.property("minecraftVersionRange", minecraftVersionRange)
+	inputs.property("neoForgeVersionRange", neoForgeVersionRange)
+	inputs.property("kotlinForForgeVersionRange", kotlinForForgeVersionRange)
+	
+	filesMatching("META-INF/neoforge.mods.toml") {
+		expand(inputs.properties)
+	}
+}

gradle.properties

@@ -0,0 +1,20 @@
+# Mod
+group=com.chylex.hee
+version=2.0.0-dev
+
+# Dependencies
+javaVersion=21
+minecraftVersion=1.21
+parchmentVersion=2024.07.07
+neoForgeVersion=21.0.96-beta
+kotlinForForgeVersion=5.4.0
+
+# Constraints
+minecraftVersionRange=[1.21,)
+neoForgeVersionRange=[21.0.96-beta,)
+kotlinForForgeVersionRange=[5.4.0,)
+
+# Gradle
+org.gradle.jvmargs=-Xmx3G
+org.gradle.caching=true
+org.gradle.parallel=true

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradlew

@@ -55,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,13 +80,11 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -133,22 +131,29 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
+    fi
 fi
 
 # Increase the maximum file descriptors if we can.
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -193,11 +198,15 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \

gradlew.bat

@@ -26,6 +26,7 @@ if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
 if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
@@ -42,11 +43,11 @@ set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
 if %ERRORLEVEL% equ 0 goto execute
 
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -56,11 +57,11 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
 if exist "%JAVA_EXE%" goto execute
 
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 

settings.gradle.kts

@@ -0,0 +1 @@
+rootProject.name = "hee"

src/main/kotlin/com/chylex/hee/HardcoreEnderExpansion.kt

@@ -0,0 +1,8 @@
+package com.chylex.hee
+
+import net.neoforged.fml.common.Mod
+
+@Mod(HardcoreEnderExpansion.ID)
+object HardcoreEnderExpansion {
+	const val ID = "hee"
+}

src/main/resources/META-INF/neoforge.mods.toml

@@ -0,0 +1,26 @@
+modLoader="kotlinforforge"
+loaderVersion = "${kotlinForForgeVersionRange}"
+
+license = "MPL-2.0"
+issueTrackerURL = "https://github.com/chylex/Hardcore-Ender-Expansion-2/issues"
+
+[[mods]]
+modId = "hee"
+displayName = "Hardcore Ender Expansion 2"
+displayURL = "https://hee.chylex.com"
+description = "WIP"
+version = "${version}"
+
+[[dependencies.hee]]
+modId = "minecraft"
+type = "required"
+versionRange = "${minecraftVersionRange}"
+ordering = "NONE"
+side = "BOTH"
+
+[[dependencies.hee]]
+modId = "neoforge"
+type = "required"
+versionRange = "${neoForgeVersionRange}"
+ordering = "NONE"
+side = "BOTH"