Replace Patchouli by GuideME (#1039)

Author: Technici4n

build.gradle

@@ -38,10 +38,6 @@ repositories {
             includeGroup "curse.maven"
         }
     }
-    // for Patchouli
-    maven {
-        url 'https://maven.blamejared.com'
-    }
     // for AE2 and JEI
     maven {
         name "Modmaven"
@@ -202,6 +198,10 @@ neoForge {
             // You can set various levels here.
             // Please read: https://stackoverflow.com/questions/2031163/when-to-use-the-different-log-levels
             systemProperty 'forge.logging.console.level', 'debug'
+
+            // Allows updates to the guide book to be watched for by GuideME.
+            systemProperty 'guideme.modern_industrialization.book.sources',
+                    file("src/main/resources/assets/modern_industrialization/mi_guidebook/").absolutePath
         }
 
         client {
@@ -251,6 +251,7 @@ configurations {
 
 dependencies {
     api jarJar("dev.technici4n:GrandPower:${project.grandpower_version}")
+    implementation "org.appliedenergistics:guideme:${project.guideme_version}"
 
     compileOnly "mezz.jei:jei-${project.jei_minecraft_version}-neoforge-api:${project.jei_version}"
     if (project.runtime_itemlist_mod == "jei") {
@@ -274,10 +275,6 @@ dependencies {
         throw new GradleException("Invalid runtime_itemlist_mod value: " + project.runtime_itemlist_mod)
     }
 
-    compileOnly "vazkii.patchouli:Patchouli:${project.patchouli_version}:api"
-    localRuntimeOnly "vazkii.patchouli:Patchouli:${project.patchouli_version}"
-    jarJar "vazkii.patchouli:Patchouli:${project.patchouli_version}"
-
     implementation "me.shedaniel.cloth:cloth-config-neoforge:${project.cloth_config_version}"
 
     localRuntimeOnly compileOnly("curse.maven:jade-324717:${project.jade_file_id}")
@@ -300,6 +297,7 @@ var generateModMetadata = tasks.register("generateModMetadata", ProcessResources
             mod_version: version,
             cloth_config_version_range: cloth_config_version_range,
             grandpower_version_range: grandpower_version_range,
+            guideme_version_range: guideme_version_range,
             ae2_version_range: ae2_version_range,
             jei_version_range: jei_version_range,
     ]
@@ -395,12 +393,12 @@ if (System.getenv("CURSEFORGE_API_KEY") && !version.endsWith("-SNAPSHOT")) {
 
             relations {
                 requiredDependency "cloth-config"
+                requiredDependency "guideme"
                 optionalDependency "wthit"
                 optionalDependency "emi"
                 optionalDependency "jei"
                 optionalDependency "roughly-enough-items"
                 embeddedLibrary "grandpower"
-                embeddedLibrary "patchouli"
             }
             mainArtifact(tasks.named("jar").flatMap { it.archiveFile }) {
                 displayName = "Modern Industrialization v${version}"
@@ -427,11 +425,11 @@ modrinth {
     loaders = ["neoforge"]
     dependencies {
         required.project "cloth-config"
+        required.project "guideme"
         optional.project "wthit"
         optional.project "emi"
         optional.project "jei"
         optional.project "rei"
-        embedded.project "patchouli"
     }
 }
 tasks.modrinth.onlyIf {

gradle.properties

@@ -29,6 +29,8 @@ cloth_config_version=15.0.128
 cloth_config_version_range=[15.0.128, 16)
 grandpower_version=3.0.0
 grandpower_version_range=[3.0.0, 4)
+guideme_version=21.1.5
+guideme_version_range=[21.1.5, 21.2)
 
 # Optional dependency versions
 ae2_version=19.0.12-alpha
@@ -47,6 +49,5 @@ jei_minecraft_version=1.21.1
 jei_version=19.20.0.241
 jei_version_range=[19.19.0,]
 kubejs_version=2100.7.0-build.102
-patchouli_version=1.21-87-NEOFORGE-SNAPSHOT
 rei_version=16.0.729
 rei_annotations_version=12.0.93

src/generated/resources/assets/modern_industrialization/lang/en_us.json

@@ -447,8 +447,6 @@
   "block.modern_industrialization.vacuum_freezer": "Vacuum Freezer",
   "block.modern_industrialization.vinyl_chloride": "Vinyl Chloride",
   "block.modern_industrialization.yttrium_block": "Block of Yttrium",
-  "book.modern_industrialization.landing_text": "Welcome to Modern Industrialization! To get started, be sure to collect a lot of Copper Ore and Tin Ore.",
-  "book.modern_industrialization.subtitle": "Modern Industrialization",
   "cable_tier_long.modern_industrialization.ev": "Extreme Voltage",
   "cable_tier_long.modern_industrialization.hv": "High Voltage",
   "cable_tier_long.modern_industrialization.lv": "Low Voltage",

src/main/java/aztech/modern_industrialization/MI.java

@@ -32,6 +32,8 @@
 import aztech.modern_industrialization.debug.DebugCommands;
 import aztech.modern_industrialization.definition.BlockDefinition;
 import aztech.modern_industrialization.definition.ItemDefinition;
+import aztech.modern_industrialization.guidebook.GuidebookEvents;
+import aztech.modern_industrialization.guidebook.MIGuide;
 import aztech.modern_industrialization.items.DynamicToolItem;
 import aztech.modern_industrialization.items.SteamDrillHooks;
 import aztech.modern_industrialization.items.armor.MIArmorEffects;
@@ -44,7 +46,6 @@
 import aztech.modern_industrialization.machines.init.SingleBlockSpecialMachines;
 import aztech.modern_industrialization.machines.multiblocks.world.ChunkEventListeners;
 import aztech.modern_industrialization.materials.MIMaterials;
-import aztech.modern_industrialization.misc.guidebook.GuidebookEvents;
 import aztech.modern_industrialization.misc.runtime_datagen.RuntimeDataGen;
 import aztech.modern_industrialization.network.MIPackets;
 import aztech.modern_industrialization.nuclear.FluidNuclearComponent;
@@ -127,6 +128,7 @@ public MI(IEventBus modBus, Dist dist) {
         ChunkEventListeners.init();
         DebugCommands.init();
         GuidebookEvents.init();
+        MIGuide.init();
         MIArmorEffects.init();
 
         NeoForge.EVENT_BUS.addListener(PlayerEvent.PlayerChangedDimensionEvent.class, event -> MIKeyMap.clear(event.getEntity()));

src/main/java/aztech/modern_industrialization/MIItem.java

@@ -27,6 +27,7 @@
 
 import aztech.modern_industrialization.api.energy.EnergyApi;
 import aztech.modern_industrialization.definition.ItemDefinition;
+import aztech.modern_industrialization.guidebook.GuideBookItem;
 import aztech.modern_industrialization.items.*;
 import aztech.modern_industrialization.items.armor.GraviChestPlateItem;
 import aztech.modern_industrialization.items.armor.JetpackItem;

src/main/java/aztech/modern_industrialization/datagen/translation/TranslationProvider.java

@@ -72,11 +72,6 @@ public void addTranslation(String key, String englishValue) {
 
     private void addManualEntries() {
         addTranslation("block.modern_industrialization.pipe", "Pipe(s)");
-        addTranslation("book.modern_industrialization.landing_text",
-                "Welcome to Modern Industrialization! To get started, be sure to collect a lot of Copper Ore and Tin Ore.");
-
-        addTranslation("book.modern_industrialization.subtitle",
-                "Modern Industrialization");
 
         addTranslation("entity.minecraft.villager.modern_industrialization.industrialist", "Industrialist");
 

src/main/java/aztech/modern_industrialization/items/GuideBookItem.java renamed to src/main/java/aztech/modern_industrialization/guidebook/GuideBookItem.java

@@ -21,23 +21,20 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package aztech.modern_industrialization.items;
+package aztech.modern_industrialization.guidebook;
 
-import aztech.modern_industrialization.MI;
 import aztech.modern_industrialization.MIText;
 import aztech.modern_industrialization.util.TextHelper;
+import guideme.GuidesCommon;
 import java.util.List;
 import net.minecraft.network.chat.Component;
-import net.minecraft.server.level.ServerPlayer;
 import net.minecraft.world.InteractionHand;
 import net.minecraft.world.InteractionResultHolder;
 import net.minecraft.world.entity.player.Player;
 import net.minecraft.world.item.Item;
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.item.TooltipFlag;
 import net.minecraft.world.level.Level;
-import net.neoforged.fml.ModList;
-import vazkii.patchouli.api.PatchouliAPI;
 
 public class GuideBookItem extends Item {
     public GuideBookItem(Properties settings) {
@@ -46,13 +43,8 @@ public GuideBookItem(Properties settings) {
 
     @Override
     public InteractionResultHolder<ItemStack> use(Level world, Player user, InteractionHand hand) {
-        if (!world.isClientSide && user instanceof ServerPlayer) {
-            if (ModList.get().isLoaded("patchouli")) { // a bit borderline...
-                PatchouliAPI.get().openBookGUI((ServerPlayer) user, MI.id("book"));
-                return InteractionResultHolder.success(user.getItemInHand(hand));
-            } else {
-                user.displayClientMessage(Component.literal("Patchouli is not loaded, can't open guide book!"), true);
-            }
+        if (world.isClientSide) {
+            GuidesCommon.openGuide(user, MIGuide.ID);
         }
         return InteractionResultHolder.consume(user.getItemInHand(hand));
     }

src/main/java/aztech/modern_industrialization/misc/guidebook/GuidebookEvents.java renamed to src/main/java/aztech/modern_industrialization/guidebook/GuidebookEvents.java

@@ -21,7 +21,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package aztech.modern_industrialization.misc.guidebook;
+package aztech.modern_industrialization.guidebook;
 
 import aztech.modern_industrialization.MIAdvancementTriggers;
 import aztech.modern_industrialization.MIConfig;

src/main/java/aztech/modern_industrialization/misc/guidebook/GuidebookPersistentState.java renamed to src/main/java/aztech/modern_industrialization/guidebook/GuidebookPersistentState.java

@@ -21,7 +21,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package aztech.modern_industrialization.misc.guidebook;
+package aztech.modern_industrialization.guidebook;
 
 import aztech.modern_industrialization.util.MISavedData;
 import java.util.*;

src/main/java/aztech/modern_industrialization/guidebook/MIGuide.java

@@ -0,0 +1,42 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020 Azercoco & Technici4n
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package aztech.modern_industrialization.guidebook;
+
+import aztech.modern_industrialization.MI;
+import guideme.Guide;
+import net.minecraft.resources.ResourceLocation;
+
+public class MIGuide {
+    public static final ResourceLocation ID = MI.id("book");
+    private static Guide guide;
+
+    public static void init() {
+        guide = Guide.builder(ID)
+                .folder("mi_guidebook")
+                .build();
+    }
+
+    private MIGuide() {
+    }
+}