Update run environment and add extra documentation

README.md

@@ -35,9 +35,9 @@ You must run that project's `gen<IDE>Runs` task and use its classpath at runtime
 
 For datagen, you may still use each project's individual runs.
 
-## Known issues and currently untested features
+## Known issues
 Please check the [runenv template](https://github.com/amadornes/fg-multiproject-runenv) repository, as that will contain
-the latest information regarding compatibility. Further updates will most likely be pushed there.
+the latest information regarding compatibility.
 
 ## Contributions
 Pull requests adding extended feature support and bugfixes are welcome.  

build.gradle

@@ -1,26 +1,42 @@
+plugins {
+    id("org.jetbrains.gradle.plugin.idea-ext") version "1.1"
+}
+
 subprojects {
-	configurations.all {
-		if (it.name.startsWith("_")) {
-			exclude group: "com.example", module: "examplelib"
-			return
-		}
-
-		resolutionStrategy.dependencySubstitution {
-			substitute module("com.example:examplelib") using project(":examplelib")
-		}
-	}
+    configurations.all {
+        if (it.name.startsWith("_")) {
+            // You must exclude the same modules you substitute here, because ForgeGradle
+            exclude group: "com.example", module: "examplelib"
+            return
+        }
+
+        resolutionStrategy.dependencySubstitution {
+            // Apply substitutions for modules your projects depend on, replacing them with another project
+            substitute module("com.example:examplelib") using project(":examplelib")
+        }
+    }
 }
 
 project('runenv') {
-	ext {
-		mcversion = '1.17.1'
-		forgeversion = '37.0.13'
-	}
-	repositories {
-	}
-	dependencies {
-		// This is where any additional runtime dependencies for your dev environment go
-	}
+    ext {
+        mcversion = '1.18.2'
+        forgeversion = '40.1.31'
+        // javaversion = 17 // Defaults to 17 already
+        // mappings = channel: 'official', version: '1.18.2' // Defaults to mojmap for the specified MC version
+        // runArgs = [ ] // Arguments applied to all runs
+        // runProps = [ name: value ] // Properties applied to all runs
+    }
+    repositories {
+        // Repositories for additional runtime dependencies go here
+    }
+    afterEvaluate {
+        dependencies {
+            // This is where any additional runtime dependencies for your dev environment go
+        }
+    }
 }
 
-
+// Ensure the run directory is excluded from the idea module
+idea.module {
+    excludeDirs << file("run")
+}

settings.gradle

@@ -1,5 +1,7 @@
 rootProject.name = 'Multiproject' // Optionally set a custom name for the root
 
+// This is where all the projects in this environment are registered
+// Use the relative path to the directory where their buildscript is in your includes
 include 'examplelib'
 include 'examplemod'