Finish updating to 1.20.1

build.gradle

@@ -7,7 +7,7 @@ plugins {
     id 'org.parchmentmc.librarian.forgegradle' version '1.+'
 }
 
-version = "${minecraft_version}-${mod_version}"
+version = mod_version
 group = mod_group_id
 
 base {
@@ -15,6 +15,7 @@ base {
 }
 
 java {
+
     withSourcesJar()
 }
 
@@ -22,11 +23,11 @@ configurations {
     provided
     compile.extendsFrom(provided)
 }
+
 // Mojang ships Java 17 to end users in 1.18+, so your mod should target Java 17.
 java.toolchain.languageVersion = JavaLanguageVersion.of(17)
 
 println "Java: ${System.getProperty 'java.version'}, JVM: ${System.getProperty 'java.vm.version'} (${System.getProperty 'java.vendor'}), Arch: ${System.getProperty 'os.arch'}"
-
 minecraft {
     // The mappings can be changed at any time and must be in the following format.
     // Channel:   Version:
@@ -37,17 +38,34 @@ minecraft {
     // See more information here: https://github.com/MinecraftForge/MCPConfig/blob/master/Mojang.md
     //
     // Parchment is an unofficial project maintained by ParchmentMC, separate from MinecraftForge
-    // Additional setup is needed to use their mappings: https://github.com/ParchmentMC/Parchment/wiki/Getting-Started
+    // Additional setup is needed to use their mappings: https://parchmentmc.org/docs/getting-started
     //
     // Use non-default mappings at your own risk. They may not always work.
     // Simply re-run your setup task after changing the mappings to update your workspace.
-    mappings channel: 'parchment', version: "${parchment_version}-${minecraft_version}"
+    mappings channel: mapping_channel, version: mapping_version
-    // mappings channel: 'official', version: "${minecraft_version}"
 
+    // When true, this property will have all Eclipse/IntelliJ IDEA run configurations run the "prepareX" task for the given run configuration before launching the game.
+    // In most cases, it is not necessary to enable.
+    // enableEclipsePrepareRuns = true
+    // enableIdeaPrepareRuns = true
+
+    // This property allows configuring Gradle's ProcessResources task(s) to run on IDE output locations before launching the game.
+    // It is REQUIRED to be set to true for this template to function.
+    // See https://docs.gradle.org/current/dsl/org.gradle.language.jvm.tasks.ProcessResources.html
     copyIdeResources = true
 
+    // When true, this property will add the folder name of all declared run configurations to generated IDE run configurations.
+    // The folder name can be set on a run configuration using the "folderName" property.
+    // By default, the folder name of a run configuration is the name of the Gradle project containing it.
+    // generateRunFolders = true
 
-    // accessTransformer = file('src/main/resources/META-INF/accesstransformer.cfg') // Currently, this location cannot be changed from the default.
+    // This property enables access transformers for use in development.
+    // They will be applied to the Minecraft artifact.
+    // The access transformer file can be anywhere in the project.
+    // However, it must be at "META-INF/accesstransformer.cfg" in the final mod jar to be loaded by Forge.
+    // This default location is a best practice to automatically put the file in the right place in the final jar.
+    // See https://docs.minecraftforge.net/en/latest/advanced/accesstransformers/ for more information.
+    // accessTransformer = file('src/main/resources/META-INF/accesstransformer.cfg')
 
     // Default run configurations.
     // These can be tweaked, removed, or duplicated as needed.
@@ -129,40 +147,45 @@ repositories {
         url = "https://maven.zontreck.dev/repository/zontreck"
     }
 
-
 }
 
 dependencies {
-    // Specify the version of Minecraft to use. If this is any group other than 'net.minecraft', it is assumed
+    // Specify the version of Minecraft to use.
-    // that the dep is a ForgeGradle 'patcher' dependency, and its patches will be applied.
+    // Any artifact can be supplied so long as it has a "userdev" classifier artifact and is a compatible patcher artifact.
-    // The userdev artifact is a special name and will get all sorts of transformations applied to it.
+    // The "userdev" classifier will be requested and setup by ForgeGradle.
+    // If the group id is "net.minecraft" and the artifact id is one of ["client", "server", "joined"],
+    // then special handling is done to allow a setup of a vanilla dependency without the use of an external repository.
     minecraft "net.minecraftforge:forge:${minecraft_version}-${forge_version}"
 
-    // Real mod deobf dependency examples - these get remapped to your current mappings
-    // compileOnly fg.deobf("mezz.jei:jei-${minecraft_version}:${jei_version}:api") // Adds JEI API as a compile dependency
-    // runtimeOnly fg.deobf("mezz.jei:jei-${minecraft_version}:${jei_version}") // Adds the full JEI mod as a runtime dependency
-    // implementation fg.deobf("com.tterrag.registrate:Registrate:MC${minecraft_version}-${registrate_version}") // Adds registrate as a dependency
-
-    // Examples using mod jars from ./libs
-    // implementation fg.deobf("blank:coolmod-${minecraft_version}:${coolmod_version}")
-    //compileOnly ("net.luckperms:api:${luckperms_api_version}")
-    //runtimeOnly fg.deobf("curse.maven:luckperms-431733:4443551")
-    //implementation fg.deobf("blank:LuckPerms:Forge-5.4.12")
-
     provided "dev.zontreck:LibAC:${libac}"
     implementation "dev.zontreck:LibAC:${libac}"
     minecraftLibrary "dev.zontreck:LibAC:${libac}"
 
+
     provided "dev.zontreck:EventsBus:${eventsbus}"
     implementation "dev.zontreck:EventsBus:${eventsbus}"
     minecraftLibrary "dev.zontreck:EventsBus:${eventsbus}"
 
+    // Example mod dependency with JEI - using fg.deobf() ensures the dependency is remapped to your development mappings
+    // The JEI API is declared for compile time use, while the full JEI artifact is used at runtime
+    // compileOnly fg.deobf("mezz.jei:jei-${mc_version}-common-api:${jei_version}")
+    // compileOnly fg.deobf("mezz.jei:jei-${mc_version}-forge-api:${jei_version}")
+    // runtimeOnly fg.deobf("mezz.jei:jei-${mc_version}-forge:${jei_version}")
 
-    // For more info...
+    // Example mod dependency using a mod jar from ./libs with a flat dir repository
+    // This maps to ./libs/coolmod-${mc_version}-${coolmod_version}.jar
+    // The group id is ignored when searching -- in this case, it is "blank"
+    // implementation fg.deobf("blank:coolmod-${mc_version}:${coolmod_version}")
+
+    // For more info:
     // http://www.gradle.org/docs/current/userguide/artifact_dependencies_tutorial.html
     // http://www.gradle.org/docs/current/userguide/dependency_management.html
 }
 
+// This block of code expands all declared replace properties in the specified resource targets.
+// A missing property will result in an error. Properties are expanded using ${} Groovy notation.
+// When "copyIdeResources" is enabled, this will also run before the game launches in IDE environments.
+// See https://docs.gradle.org/current/dsl/org.gradle.language.jvm.tasks.ProcessResources.html
 tasks.named('processResources', ProcessResources).configure {
     var replaceProperties = [
             minecraft_version   : minecraft_version, minecraft_version_range: minecraft_version_range,
@@ -178,30 +201,28 @@ tasks.named('processResources', ProcessResources).configure {
     }
 }
 
+// Example for how to get properties into the manifest for reading at runtime.
 tasks.named('jar', Jar).configure {
-    from {
-        configurations.provided.asFileTree.collect { zipTree(it) }
-    }
     manifest {
         attributes([
-                "Specification-Title"     : mod_id,
+                'Specification-Title'     : mod_id,
-                "Specification-Vendor"    : mod_authors,
+                'Specification-Vendor'    : mod_authors,
-                "Specification-Version"   : "${mod_version}",
+                'Specification-Version'   : '1', // We are version 1 of ourselves
-                "Implementation-Title"    : project.name,
+                'Implementation-Title'    : project.name,
-                "Implementation-Version"  : "${mod_version}",
+                'Implementation-Version'  : project.jar.archiveVersion,
-                "Implementation-Vendor"   : mod_authors,
+                'Implementation-Vendor'   : mod_authors,
-                "Implementation-Timestamp": new Date().format("yyyy-MM-dd'T'HH:mm:ssZ")
+                'Implementation-Timestamp': new Date().format("yyyy-MM-dd'T'HH:mm:ssZ")
         ])
     }
 
+    // This is the preferred method to reobfuscate your jar file
     finalizedBy 'reobfJar'
 }
 
-
+// However if you are in a multi-project build, dev time needs unobfed jar files, so you can delay the obfuscation until publishing by doing:
-compileJava.finalizedBy('sourcesJar')
+// tasks.named('publish').configure {
-
+//     dependsOn 'reobfJar'
-// However if you are in a multi-project build, dev time needs unobfed jar files, so you can delay the obfuscation until publishing by doing
+// }
-// publish.dependsOn('reobfJar')
 
 
 def MAVEN_PASSWORD_PROPERTY = "AriasCreationsMavenPassword"
@@ -229,8 +250,3 @@ publishing {
 tasks.withType(JavaCompile).configureEach {
     options.encoding = 'UTF-8' // Use the UTF-8 charset for Java compilation
 }
-
-
-artifacts {
-    archives sourcesJar
-}

gradle.properties

@@ -3,46 +3,62 @@
 org.gradle.jvmargs=-Xmx3G
 org.gradle.daemon=false
 
-forge_version=47.2.0
+
 parchment_version=2023.09.03
 # luckperms_api_version=5.4
 
 libac=1.4.1
 eventsbus=1.0.16
+## Environment Properties
 
-
-
-# The Forge version range can use any version of Forge as bounds or match the loader version range
-forge_version_range=[47,)
-# The loader version range can only use the major version of Forge/FML as bounds
-loader_version_range=[47,)
 # The Minecraft version must agree with the Forge version to get a valid artifact
 minecraft_version=1.20.1
 # The Minecraft version range can use any release version of Minecraft as bounds.
 # Snapshots, pre-releases, and release candidates are not guaranteed to sort properly
 # as they do not follow standard versioning conventions.
 minecraft_version_range=[1.20.1,1.21)
+# The Forge version must agree with the Minecraft version to get a valid artifact
+forge_version=47.2.0
+# The Forge version range can use any version of Forge as bounds or match the loader version range
+forge_version_range=[47,)
+# The loader version range can only use the major version of Forge/FML as bounds
+loader_version_range=[47,)
+# The mapping channel to use for mappings.
+# The default set of supported mapping channels are ["official", "snapshot", "snapshot_nodoc", "stable", "stable_nodoc"].
+# Additional mapping channels can be registered through the "channelProviders" extension in a Gradle plugin.
+#
+# | Channel   | Version              |                                                                                |
+# |-----------|----------------------|--------------------------------------------------------------------------------|
+# | official  | MCVersion            | Official field/method names from Mojang mapping files                          |
+# | parchment | YYYY.MM.DD-MCVersion | Open community-sourced parameter names and javadocs layered on top of official |
+#
+# You must be aware of the Mojang license when using the 'official' or 'parchment' mappings.
+# See more information here: https://github.com/MinecraftForge/MCPConfig/blob/master/Mojang.md
+#
 # Parchment is an unofficial project maintained by ParchmentMC, separate from Minecraft Forge.
 # Additional setup is needed to use their mappings, see https://parchmentmc.org/docs/getting-started
-mapping_channel=official
+mapping_channel=parchment
 # The mapping version to query from the mapping channel.
 # This must match the format required by the mapping channel.
-mapping_version=1.20.1
+mapping_version=2023.09.03-1.20.1
+
+
+## Mod Properties
 
 # The unique mod identifier for the mod. Must be lowercase in English locale. Must fit the regex [a-z][a-z0-9_]{1,63}
 # Must match the String constant located in the main mod class annotated with @Mod.
 mod_id=libzontreck
 # The human-readable display name for the mod.
-mod_name=Zontreck's Library Mod
+mod_name=Zontreck Library Mod
 # The license of the mod. Review your options at https://choosealicense.com/. All Rights Reserved is the default.
-mod_license=All Rights Reserved
+mod_license=GPLv3
 # The mod version. See https://semver.org/
-mod_version=1.0.8.1119230115
+mod_version=1.0.8.1119230242
 # The group ID for the mod. It is only important when publishing as an artifact to a Maven repository.
 # This should match the base package used for the mod sources.
 # See https://maven.apache.org/guides/mini/guide-naming-conventions.html
 mod_group_id=dev.zontreck
 # The authors of the mod. This is a simple text string that is used for display purposes in the mod list.
-mod_authors=Zontreck
+mod_authors=zontreck
 # The description of the mod. This is a simple multiline text string that is used for display purposes in the mod list.
-mod_description=This is a library mod. It contains code used commonly in all or most Zontreck Projects
+mod_description=LibZontreck\nLibrary Mod!

settings.gradle

@@ -2,12 +2,9 @@ pluginManagement {
     repositories {
         gradlePluginPortal()
         maven { url = "https://maven.zontreck.dev/repository/internal" }
-        //maven { url = 'https://maven.minecraftforge.net/' }
-        //maven { url = 'https://maven.parchmentmc.org' } // Add this line
     }
 }
 
-
 plugins {
     id 'org.gradle.toolchains.foojay-resolver-convention' version '0.5.0'
 }

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

@@ -16,22 +16,20 @@ issueTrackerURL="https://github.com/zontreck/LibZontreckMod/issues" #optional
 [[mods]] #mandatory
 # The modid of the mod
 modId="${mod_id}" #mandatory
-# The version number of the mod - there's a few well known ${} variables useable here or just hardcode it
+# The version number of the mod
-# ${file.jarVersion} will substitute the value of the Implementation-Version as read from the mod's JAR file metadata
+version="${mod_version}" #mandatory
-# see the associated build.gradle script for how to populate this completely automatically during a build
+# A display name for the mod
-version="${file.jarVersion}" #mandatory
- # A display name for the mod
 displayName="${mod_name}" #mandatory
-# A URL to query for updates for this mod. See the JSON update specification https://mcforge.readthedocs.io/en/latest/gettingstarted/autoupdate/
+# A URL to query for updates for this mod. See the JSON update specification https://docs.minecraftforge.net/en/latest/misc/updatechecker/
 #updateJSONURL="https://change.me.example.invalid/updates.json" #optional
 # A URL for the "homepage" for this mod, displayed in the mod UI
 #displayURL="https://change.me.to.your.mods.homepage.example.invalid/" #optional
 # A file name (in the root of the mod JAR) containing a logo for display
-logoFile="library.png" #optional
+#logoFile="examplemod.png" #optional
 # A text field displayed in the mod UI
-#credits="Zontreck" #optional
+#credits="" #optional
 # A text field displayed in the mod UI
-authors="#{mod_authors}" #optional
+authors="${mod_authors}" #optional
 # Display Test controls the display for your mod in the server connection screen
 # MATCH_VERSION means that your mod will cause a red X if the versions on client and server differ. This is the default behaviour and should be what you choose if you have server and client elements to your mod.
 # IGNORE_SERVER_VERSION means that your mod will not cause a red X if it's present on the server but not on the client. This is what you should use if you're a server only mod.
@@ -41,10 +39,7 @@ authors="#{mod_authors}" #optional
 #displayTest="MATCH_VERSION" # MATCH_VERSION is the default if nothing is specified (#optional)
 
 # The description text for the mod (multi line!) (#mandatory)
-description='''
+description='''${mod_description}'''
-This mod provides common code to all of zontreck's mods.
-
-'''
 # A dependency - use the . to indicate dependency for a specific modid. Dependencies are optional.
 [[dependencies.${mod_id}]] #optional
     # the modid of the dependency
@@ -52,16 +47,24 @@ This mod provides common code to all of zontreck's mods.
     # Does this dependency have to exist - if not, ordering below must be specified
     mandatory=true #mandatory
     # The version range of the dependency
-    versionRange="${loader_version_range}" #mandatory
+    versionRange="${forge_version_range}" #mandatory
-    # An ordering relationship for the dependency - BEFORE or AFTER required if the relationship is not mandatory
+    # An ordering relationship for the dependency - BEFORE or AFTER required if the dependency is not mandatory
+    # BEFORE - This mod is loaded BEFORE the dependency
+    # AFTER - This mod is loaded AFTER the dependency
     ordering="NONE"
-    # Side this dependency is applied on - BOTH, CLIENT or SERVER
+    # Side this dependency is applied on - BOTH, CLIENT, or SERVER
     side="BOTH"
 # Here's another dependency
 [[dependencies.${mod_id}]]
     modId="minecraft"
     mandatory=true
-# This version range declares a minimum of the current minecraft version up to but not including the next major version
+    # This version range declares a minimum of the current minecraft version up to but not including the next major version
-    versionRange="${minecraft_range}"
+    versionRange="${minecraft_version_range}"
     ordering="NONE"
     side="BOTH"
+
+# Features are specific properties of the game environment, that you may want to declare you require. This example declares
+# that your mod requires GL version 3.2 or higher. Other features will be added. They are side aware so declaring this won't
+# stop your mod loading on the server for example.
+#[features.${mod_id}]
+#openGLVersion="[3.2,)"

src/main/resources/pack.mcmeta

@@ -1,8 +1,8 @@
 {
-    "pack": {
+  "pack": {
-        "description": {
+    "description": {
-            "text": "${mod_id} Resources. This is a library mod"
+      "text": "${mod_id} resources"
-        }
+    },
-        "pack_format": 15
+    "pack_format": 15
-    }
+  }
 }