feat: add config to pause game if book is open

Closes #371

Author: klikli-dev

common/src/main/java/com/klikli_dev/modonomicon/client/gui/book/index/BookParentIndexScreen.java

@@ -408,6 +408,6 @@ protected boolean isClickOutsideEntry(double pMouseX, double pMouseY) {
 
     @Override
     public boolean isPauseScreen() {
-        return false;
+        return ClientServices.CLIENT_CONFIG.pauseGameWhenOpen();
     }
 }

common/src/main/java/com/klikli_dev/modonomicon/client/gui/book/node/BookParentNodeScreen.java

@@ -396,7 +396,7 @@ protected void onShowRecentlyUnlockedButtonClick(ShowRecentlyUnlockedButton butt
 
     @Override
     public boolean isPauseScreen() {
-        return false;
+        return ClientServices.CLIENT_CONFIG.pauseGameWhenOpen();
     }
 }
 

common/src/main/java/com/klikli_dev/modonomicon/platform/services/ClientConfigHelper.java

@@ -14,4 +14,6 @@ public interface ClientConfigHelper {
     boolean storeLastOpenPageWhenClosingEntry();
 
     List<String> fontFallbackLocales();
+
+    boolean pauseGameWhenOpen();
 }

fabric/src/main/java/com/klikli_dev/modonomicon/config/ClientConfig.java

@@ -27,6 +27,7 @@ public class ClientConfig {
     public static PropertyMirror<Boolean> enableSmoothZoom = PropertyMirror.create(ConfigTypes.BOOLEAN);
     public static PropertyMirror<Boolean> storeLastOpenPageWhenClosingEntry = PropertyMirror.create(ConfigTypes.BOOLEAN);
     public static PropertyMirror<List<String>> fontFallbackLocales = PropertyMirror.create(ConfigTypes.makeList(ConfigTypes.STRING));
+    public static PropertyMirror<Boolean> pauseGameWhenOpen = PropertyMirror.create(ConfigTypes.BOOLEAN);
 
     private static final ConfigTree CONFIG = ConfigTree.builder()
             .fork("qol")
@@ -41,6 +42,9 @@ public class ClientConfig {
             .beginValue("fontFallbackLocales", ConfigTypes.makeList(ConfigTypes.STRING), List.of("zh_cn", "ja_jp", "ko_kr"))
             .withComment("If your locale is not supported by the default Modonomicon font, indicated by the book just rendering blocky shapes instead of characters, add your locale to this list to fall back to the builtin Minecraft font.")
             .finishValue(fontFallbackLocales::mirror)
+            .beginValue("pauseGameWhenOpen", ConfigTypes.BOOLEAN, true)
+            .withComment("If true, the game will pause when a Modonomicon book is open (singleplayer only).")
+            .finishValue(pauseGameWhenOpen::mirror)
             .finishBranch()
             .build();
 

fabric/src/main/java/com/klikli_dev/modonomicon/config/FabricClientConfigHelper.java

@@ -25,4 +25,9 @@ public boolean storeLastOpenPageWhenClosingEntry() {
     public List<String> fontFallbackLocales() {
         return ClientConfig.fontFallbackLocales.getValue();
     }
+
+    @Override
+    public boolean pauseGameWhenOpen() {
+        return ClientConfig.pauseGameWhenOpen.getValue();
+    }
 }

fabric/src/main/java/com/klikli_dev/modonomicon/gui/FabricMultiLayerScreen.java

@@ -6,6 +6,7 @@
 
 package com.klikli_dev.modonomicon.gui;
 
+import com.klikli_dev.modonomicon.platform.ClientServices;
 import net.minecraft.CrashReport;
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.gui.ComponentPath;
@@ -75,7 +76,7 @@ public void triggerImmediateNarration(boolean onlyNarrateNew) {
 
     @Override
     public boolean isPauseScreen() {
-        return this.guiLayers.peek().isPauseScreen();
+        return ClientServices.CLIENT_CONFIG.pauseGameWhenOpen();
     }
 
 

forge/src/main/java/com/klikli_dev/modonomicon/config/ClientConfig.java

@@ -34,6 +34,7 @@ public static class QoLCategory {
         public final BooleanValue storeLastOpenPageWhenClosingEntry;
 
         public final ForgeConfigSpec.ConfigValue<List<String>> fontFallbackLocales;
+        public final BooleanValue pauseGameWhenOpen;
 
         public QoLCategory(ForgeConfigSpec.Builder builder) {
             builder.comment("Quality of Life Settings").push("qol");
@@ -47,6 +48,9 @@ public QoLCategory(ForgeConfigSpec.Builder builder) {
             this.fontFallbackLocales = builder.comment("If your locale is not supported by the default Modonomicon font, indicated by the book just rendering blocky shapes instead of characters, add your locale to this list to fall back to the builtin Minecraft font.")
                     .define("fontFallbackLocales", fontFallbackLocalesDefault);
 
+            this.pauseGameWhenOpen = builder.comment("If true, the game will pause when a Modonomicon book is open (singleplayer only).")
+                    .define("pauseGameWhenOpen", true);
+
             builder.pop();
         }
     }

forge/src/main/java/com/klikli_dev/modonomicon/config/ForgeClientConfigHelper.java

@@ -26,5 +26,13 @@ public List<String> fontFallbackLocales() {
         return ClientConfig.get().qolCategory.fontFallbackLocales.get();
     }
 
+    @Override
+    public boolean shouldShowResearchToasts() {
+        return ClientConfig.get().qolCategory.showResearchToasts.get();
+    }
 
+    @Override
+    public boolean pauseGameWhenOpen() {
+        return ClientConfig.get().qolCategory.pauseGameWhenOpen.get();
+    }
 }

neo/src/main/java/com/klikli_dev/modonomicon/config/ClientConfig.java

@@ -34,6 +34,7 @@ public static class QoLCategory {
         public final ModConfigSpec.BooleanValue storeLastOpenPageWhenClosingEntry;
 
         public final ModConfigSpec.ConfigValue<List<? extends String>> fontFallbackLocales;
+        public final ModConfigSpec.BooleanValue pauseGameWhenOpen;
 
         public QoLCategory(ModConfigSpec.Builder builder) {
             builder.comment("Quality of Life Settings").push("qol");
@@ -47,6 +48,9 @@ public QoLCategory(ModConfigSpec.Builder builder) {
             this.fontFallbackLocales = builder.comment("If your locale is not supported by the default Modonomicon font, indicated by the book just rendering blocky shapes instead of characters, add your locale to this list to fall back to the builtin Minecraft font.")
                     .defineList("fontFallbackLocales", fontFallbackLocalesDefault, () -> "", (e) -> true);
 
+            this.pauseGameWhenOpen = builder.comment("If true, the game will pause when a Modonomicon book is open (singleplayer only).")
+                    .define("pauseGameWhenOpen", true);
+
             builder.pop();
         }
     }

neo/src/main/java/com/klikli_dev/modonomicon/config/NeoClientConfigHelper.java

@@ -26,5 +26,8 @@ public List<String> fontFallbackLocales() {
         return ClientConfig.get().qolCategory.fontFallbackLocales.get().stream().map(String::toString).toList();
     }
 
-
+    @Override
+    public boolean pauseGameWhenOpen() {
+        return ClientConfig.get().qolCategory.pauseGameWhenOpen.get();
+    }
 }