chore: bump versions, add better documentation

Signed-off-by: Pauline <git@ethanlibs.co>

Author: pauliesnug

README.md

@@ -5,4 +5,6 @@ Example mod implementing OneConfig.
 
 - Copy the template either by using GitHub's "Use this template" feature or downloading the repo manually.
 - **Remove the license named "LICENSE-TEMPLATE" and choose a new one.**
-- Refactor the template (specifically, the modid, version and name in the gradle.properties and most of the class names) to a different name.
+- Refactor the template (specifically, the modid, version and name in the gradle.properties and most of the class names)
+  to a different name.
+- Have fun modding! :D

build.gradle.kts

@@ -1,6 +1,7 @@
 import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
 import cc.polyfrost.gradle.util.noServerRunConfigs
 
+// Adds support for kotlin, and adds the Polyfrost Gradle Toolkit which we use to prepare the environment.
 plugins {
     kotlin("jvm")
     id("cc.polyfrost.multi-version")
@@ -13,72 +14,95 @@ plugins {
     java
 }
 
+// Gets the mod name, version and id from the `gradle.properties` file.
 val mod_name: String by project
 val mod_version: String by project
 val mod_id: String by project
 
+// Sets up the variables for when we preprocess to other Minecraft versions.
 preprocess {
     vars.put("MODERN", if (project.platform.mcMinor >= 16) 1 else 0)
 }
 
+// Replaces the variables in `ExampleMod.java` to the ones specified in `gradle.properties`.
 blossom {
     replaceToken("@VER@", mod_version)
     replaceToken("@NAME@", mod_name)
     replaceToken("@ID@", mod_id)
 }
 
+// Sets the mod version to the one specified in `gradle.properties`. Make sure to change this following semver!
 version = mod_version
+// Sets the group, make sure to change this to your own. It can be a website you own backwards or your GitHub username.
+// e.g. com.github.<your username> or com.<your domain>
 group = "cc.polyfrost"
+// Sets the name of the output jar (the one you put in your mods folder and send to other people)
+// It outputs all versions of the mod into the `build` directory.
 base {
     archivesName.set("$mod_id-$platform")
 }
 
+// Configures the Polyfrost Loom, our plugin fork to easily set up the programming environment.
 loom {
+    // Removes the server configs from IntelliJ IDEA, since we aren't developing a server mod.
     noServerRunConfigs()
+    // Adds the tweak class if we are building legacy version of forge as per the documentation (https://docs.polyfrost.cc)
     if (project.platform.isLegacyForge) {
         launchConfigs.named("client") {
             arg("--tweakClass", "cc.polyfrost.oneconfig.loader.stage0.LaunchWrapperTweaker")
-            property("mixin.debug.export", "true")
+            property(
+                "mixin.debug.export",
+                "true"
+            ) // This is enabled so OneConfig can read our Mixins and automatically apply them.
         }
     }
+    // Configures the mixins if we are building for forge. (Useful for when we are dealing with cross-platform projects.
     if (project.platform.isForge) {
         forge {
             mixinConfig("mixins.${mod_id}.json")
         }
     }
+    // Configures the name of the mixin "refmap" using an experimental loom api. You can ignore this warning.
     mixin.defaultRefmapName.set("mixins.${mod_id}.refmap.json")
 }
 
+// Creates the shade/shadow configuration, so we can include libraries inside our mod, rather than having to add them separately.
 val shade: Configuration by configurations.creating {
     configurations.implementation.get().extendsFrom(this)
 }
 
+// Configures the output directory for when building from the `src/resources` directory.
 sourceSets {
     main {
         output.setResourcesDir(java.classesDirectory)
     }
 }
 
+// Adds the Polyfrost maven repository so we can get the libraries necessary to develop the mod.
 repositories {
     maven("https://repo.polyfrost.cc/releases")
 }
 
+// Configures the libraries/dependencies for your mod.
 dependencies {
-    modCompileOnly("cc.polyfrost:oneconfig-$platform:0.2.0-alpha+")
+    modCompileOnly("cc.polyfrost:oneconfig-$platform:0.2.0-alpha+") // Adds the OneConfig library, so we can develop with it.
 
+    // If we are building for legacy forge, includes the launch wrapper with `shade` as we configured earlier.
     if (platform.isLegacyForge) {
         compileOnly("org.spongepowered:mixin:0.7.11-SNAPSHOT")
         shade("cc.polyfrost:oneconfig-wrapper-launchwrapper:1.0.0-beta+")
     }
 }
 
+// Processes the `src/resources/mcmod.info or fabric.mod.json` and replaces the mod id, name and version with the ones in `gradle.properties`
 tasks.processResources {
     inputs.property("id", mod_id)
     inputs.property("name", mod_name)
     val java = if (project.platform.mcMinor >= 18) {
-        17
+        17 // If we are playing on version 1.18, set the java version to 17
     } else {
-        if (project.platform.mcMinor == 17) 16 else 8
+        // Else if we are playing on version 1.17, use java 16.
+        if (project.platform.mcMinor == 17) 16 else 8 // For all previous versions, java version 8 is okay.
     }
     val compatLevel = "JAVA_${java}"
     inputs.property("java", java)
@@ -112,6 +136,7 @@ tasks.processResources {
 }
 
 tasks {
+    // Configures the resources to include if we are building for forge or fabric.
     withType(Jar::class.java) {
         if (project.platform.isFabric) {
             exclude("mcmod.info", "mods.toml")
@@ -124,24 +149,26 @@ tasks {
             }
         }
     }
+    // Configures our shadow/shade configuration, so we can include the OneConfig launch wrapper with our mod.
     named<ShadowJar>("shadowJar") {
-        archiveClassifier.set("dev")
+        archiveClassifier.set("dev") // TODO: machete gets confused by the `dev` prefix.
         configurations = listOf(shade)
         duplicatesStrategy = DuplicatesStrategy.EXCLUDE
     }
     remapJar {
         input.set(shadowJar.get().archiveFile)
         archiveClassifier.set("")
     }
+    // Sets the jar manifest attributes.
     jar {
         manifest {
             attributes(
                 mapOf(
-                    "ModSide" to "CLIENT",
-                    "ForceLoadAsMod" to true,
-                    "TweakOrder" to "0",
-                    "MixinConfigs" to "mixin.${mod_id}.json",
-                    "TweakClass" to "cc.polyfrost.oneconfig.loader.stage0.LaunchWrapperTweaker"
+                    "ModSide" to "CLIENT", // We aren't developing a server-side mod, so this is fine.
+                    "ForceLoadAsMod" to true, // We want to load this jar as a mod, so we force Forge to do so.
+                    "TweakOrder" to "0", // Makes sure that the OneConfig launch wrapper is loaded as soon as possible.
+                    "MixinConfigs" to "mixin.${mod_id}.json", // We want to use our mixin configuration, so we specify it here.
+                    "TweakClass" to "cc.polyfrost.oneconfig.loader.stage0.LaunchWrapperTweaker" // Loads the OneConfig launch wrapper.
                 )
             )
         }

gradle.properties

@@ -1,7 +1,13 @@
+# gradle.properties file -- CHANGE THE VALUES STARTING WITH `mod_*` AND REMOVE THIS COMMENT.
+# Sets the name of your mod.
 mod_name=ExampleMod
+# Sets the id of your mod that mod loaders use to recognize it.
 mod_id=examplemod
+# Sets the version of your mod. Make sure to update this when you make changes according to semver.
 mod_version=1.0.0
+# Sets the name of the jar file that you put in your mods folder.
 mod_archives_name=ExampleMod
+# Gradle Configuration -- DO NOT TOUCH THESE VALUES.
 loom.platform=forge
 polyfrost.defaults.loom=1
 org.gradle.daemon=true

gradle/wrapper/gradle-wrapper.jar

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