Markdown Guidebook (AppliedEnergistics#6792)

Introduced infrastructure for a Markdown/MDX based guidebook, including a Markdown parser (port of "Micromark"). Ported the content of the current website into that new guidebook framework. Also includes the initial Patchouli book content from VT-14s branch. Patchouli Textures by @Ridanisaurus, pulled from AppliedEnergistics@f42e9d3. Co-authored-by: VT-14 <[email protected]>
nekosmp · Dec 2, 2022 · 9439c2b · 9439c2b
1 parent 44184c3
commit 9439c2b
Show file tree

Hide file tree

Showing 587 changed files with 54,469 additions and 193 deletions.
diff --git a/.gitignore b/.gitignore
@@ -18,6 +18,10 @@
 # include sourcecode except generated
 !src/
 src/generated
+out
+build
+!/libs/
+!/guidebook
 
 # include git important files
 !.gitmodules

diff --git a/build.gradle b/build.gradle
@@ -25,56 +25,17 @@ plugins {
     id 'io.github.juuxel.loom-quiltflower' version '1.7.1'
 }
 
-repositories {
-    mavenLocal()
-    mavenCentral()
-    maven {
-        url "https://maven.shedaniel.me/"
-        content {
-            includeGroup "me.shedaniel"
-            includeGroup "me.shedaniel.cloth"
-            includeGroup "dev.architectury"
-        }
-    }
-    maven {
-        url "https://maven.bai.lol"
-        content {
-            includeGroup "mcp.mobius.waila"
-            includeGroup "lol.bai"
-        }
-    }
-    maven {
-        url "https://maven.parchmentmc.net/"
-        content {
-            includeGroup "org.parchmentmc.data"
-        }
-    }
-    // For the "No Indium?" mod
-    maven {
-        url = 'https://maven.cafeteria.dev/releases/'
-        content {
-            includeGroup "me.luligabi"
-        }
-    }
-
-    maven {
-        name 'modmaven'
-        url "https://modmaven.dev/"
-        content {
-            includeGroup "mezz.jei"
-        }
-    }
-
-    maven {
-        name 'cursemaven'
-        url "https://www.cursemaven.com"
-        content {
-            includeGroup "curse.maven"
-        }
-    }
+configurations {
+    includeInJar
+    portaforgyImplementation.extendsFrom(compileClasspath)
+    implementation.extendsFrom(includeInJar)
 }
 
 dependencies {
+    includeInJar project(path: ':libs:markdown', configuration: "archives")
+    includeInJar project(path: ':libs:shaded-snakeyaml', configuration: "shadow")
+    includeInJar project(path: ':libs:shaded-directory-watcher', configuration: "shadow")
+
     // To change the versions see the gradle.properties file
     minecraft "com.mojang:minecraft:${project.minecraft_version}"
     mappings loom.layered() {
@@ -84,14 +45,22 @@ dependencies {
 
     modImplementation "net.fabricmc:fabric-loader:${project.loader_version}"
 
+    // Always depend on the REI API to compile
+    modCompileOnly("me.shedaniel:RoughlyEnoughItems-api-fabric:${project.rei_version}") {
+        exclude group: "net.fabricmc.fabric-api"
+        exclude group: "org.yaml" // snakeyaml
+        exclude group: "blue.endless" // jankson
+    }
+    modCompileOnly("me.shedaniel:RoughlyEnoughItems-default-plugin-fabric:${project.rei_version}") {
+        exclude group: "net.fabricmc.fabric-api"
+        exclude group: "org.yaml" // snakeyaml
+        exclude group: "blue.endless" // jankson
+    }
+
     if (project.runtime_itemlist_mod == "jei") {
         modLocalRuntime modCompileOnly("mezz.jei:jei-${jei_minecraft_version}-fabric:${jei_version}") {
             exclude group: "mezz.jei"
         }
-
-        modCompileOnly("me.shedaniel:RoughlyEnoughItems-fabric:${project.rei_version}") {
-            exclude group: "net.fabricmc.fabric-api"
-        }
     } else if (project.runtime_itemlist_mod == "rei") {
         modCompileOnly("mezz.jei:jei-${jei_minecraft_version}-fabric:${jei_version}") {
             exclude group: "mezz.jei"
@@ -146,24 +115,82 @@ dependencies {
     testImplementation("com.google.guava:guava-testlib:21.0")
     testImplementation("org.mockito:mockito-junit-jupiter:4.0.0")
     testImplementation("org.mockito:mockito-inline:4.0.0")
-
 }
 
-group = artifact_group
 archivesBaseName = artifact_basename
 
-java {
-    toolchain {
-        languageVersion = JavaLanguageVersion.of(17)
+allprojects {
+    group = artifact_group
+
+    java {
+        toolchain {
+            languageVersion = JavaLanguageVersion.of(17)
+        }
     }
-}
 
-// ensure everything uses UTF-8 and not some random codepage chosen by gradle
-compileJava.options.encoding = 'UTF-8'
-tasks.withType(JavaCompile) {
-    options.encoding = 'UTF-8'
-    options.deprecation = false
-    options.compilerArgs << "-Xmaxerrs" << "9999"
+    repositories {
+        mavenLocal()
+        mavenCentral()
+        maven {
+            url "https://maven.shedaniel.me/"
+            content {
+                includeGroup "me.shedaniel"
+                includeGroup "me.shedaniel.cloth"
+                includeGroup "dev.architectury"
+            }
+        }
+        maven {
+            url "https://maven.bai.lol"
+            content {
+                includeGroup "mcp.mobius.waila"
+                includeGroup "lol.bai"
+            }
+        }
+        maven {
+            url "https://maven.parchmentmc.net/"
+            content {
+                includeGroup "org.parchmentmc.data"
+            }
+        }
+        // For the "No Indium?" mod
+        maven {
+            url = 'https://maven.cafeteria.dev/releases/'
+            content {
+                includeGroup "me.luligabi"
+            }
+        }
+
+        maven {
+            name 'modmaven'
+            url "https://modmaven.dev/"
+            content {
+                includeGroup "mezz.jei"
+            }
+        }
+
+        maven {
+            name 'cursemaven'
+            url "https://www.cursemaven.com"
+            content {
+                includeGroup "curse.maven"
+            }
+        }
+
+        maven {
+            url "https://maven.blamejared.com"
+            content {
+                includeGroup "vazkii.patchouli"
+            }
+        }
+    }
+
+    // ensure everything uses UTF-8 and not some random codepage chosen by gradle
+    compileJava.options.encoding = 'UTF-8'
+    tasks.withType(JavaCompile) {
+        options.encoding = 'UTF-8'
+        options.deprecation = false
+        options.compilerArgs << "-Xmaxerrs" << "9999"
+    }
 }
 
 ///////////////////
@@ -217,10 +244,6 @@ sourceSets {
     crowdin
 }
 
-configurations {
-    portaforgyImplementation.extendsFrom(compileClasspath)
-}
-
 test {
     useJUnitPlatform()
 }
@@ -239,6 +262,14 @@ loom {
         client {
             programArgs "--username", "AE2Dev"
             property "appeng.tests", "true"
+            property "appeng.guide-dev.sources", file("guidebook").absolutePath
+        }
+        guide {
+            client()
+            programArgs "--username", "AE2Dev"
+            property "appeng.tests", "true"
+            property "appeng.guide-dev.sources", file("guidebook").absolutePath
+            property "appeng.guide-dev.startup-page", "ae2:index.md"
         }
         datagen {
             client()
@@ -282,6 +313,12 @@ jar {
     from sourceSets.main.output.classesDirs
     from sourceSets.main.output.resourcesDir
 
+    from configurations.includeInJar.collect { zipTree it }
+
+    from('guidebook') {
+        into 'assets/ae2/ae2guide'
+    }
+
     manifest {
         attributes([
                 "Specification-Title"     : "Applied Energistics 2",

diff --git a/gradle.properties b/gradle.properties
@@ -27,12 +27,18 @@ no_indium_version=1.1.0+1.19
 
 # Set to rei or jei to pick which tooltip mod gets picked at runtime
 # for the dev environment.
-runtime_itemlist_mod=jei
+runtime_itemlist_mod=rei
 
 # Set to wthit or jade to pick which tooltip mod gets picked at runtime
 # for the dev environment.
 runtime_tooltip_mod=jade
 
+#########################################################
+# Third party dependencies
+#########################################################
+snakeyaml_version=1.33
+directory_watcher_version=0.17.1
+
 #########################################################
 # Deployment                                            #
 #########################################################

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