Blur 3.0.0 - Fade out & 1.19.4

- Add fade out effect (closes #41)
  - Duration can be configured seperately
  - Disabled by default until I get some feedback on it
- Improve config screen (tabs & sliders)
- French translations by @Calvineries
- Update to 1.19.4 by @backryun & @byquanton

.github/workflows/gradle.yml

@@ -1,8 +1,8 @@
 on:
   push:
-    branches: [ "fabric-1.19" ]
+    branches: [ "fabric-1.19.3" ]
   pull_request:
-    branches: [ "fabric-1.19" ]
+    branches: [ "fabric-1.19.3" ]
 
 permissions:
   contents: read

build.gradle

@@ -1,5 +1,5 @@
 plugins {
-	id 'fabric-loom' version '1.0-SNAPSHOT'
+	id 'fabric-loom' version '1.1-SNAPSHOT'
 	id 'maven-publish'
 }
 

gradle.properties

@@ -3,17 +3,17 @@ org.gradle.jvmargs=-Xmx1G
 
 # Fabric Properties
 	# check these on https://fabricmc.net/develop
-	minecraft_version=1.19.2
-	yarn_mappings=1.19.2+build.28
-	loader_version=0.14.10
+	minecraft_version=1.19.4
+	yarn_mappings=1.19.4+build.1
+	loader_version=0.14.17
 	
 # Mod Properties
-	mod_version = 2.6.1
-	maven_group = com.tterrag.blur
-	archives_base_name = blur
+	mod_version=3.0.0
+	maven_group=com.tterrag.blur
+	archives_base_name=blur
 
 # Dependencies
 	# currently not on the main fabric site, check on the maven: https://maven.fabricmc.net/net/fabricmc/fabric-api/fabric-api
-	fabric_version=0.66.0+1.19.2
-	satin_version = 1.9.0
-	midnightlib_version=1.0.0-fabric
+	fabric_version=0.76.0+1.19.4
+	satin_version=1.11.0
+	midnightlib_version=1.2.1-fabric

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-rc-2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

src/main/java/com/tterrag/blur/Blur.java

@@ -8,76 +8,83 @@ import ladysnake.satin.api.managed.ShaderEffectManager;
 import ladysnake.satin.api.managed.uniform.Uniform1f;
 import net.fabricmc.api.ClientModInitializer;
 import net.minecraft.client.MinecraftClient;
-import net.minecraft.client.gui.screen.ChatScreen;
 import net.minecraft.client.gui.screen.Screen;
 import net.minecraft.util.Identifier;
-import java.awt.Color;
-import java.util.ArrayList;
-import java.util.List;
 
 public class Blur implements ClientModInitializer {
 
     public static final String MODID = "blur";
-    public static List<String> defaultExclusions = new ArrayList<>();
+    public static final MinecraftClient client = MinecraftClient.getInstance();
+    public static long start;
+    public static String prevScreen;
+    public static boolean screenHasBackground;
 
-    private long start;
-
-    private final ManagedShaderEffect blur = ShaderEffectManager.getInstance().manage(new Identifier(MODID, "shaders/post/fade_in_blur.json"),
+    private static final ManagedShaderEffect blur = ShaderEffectManager.getInstance().manage(new Identifier(MODID, "shaders/post/fade_in_blur.json"),
             shader -> shader.setUniformValue("Radius", (float) BlurConfig.radius));
-    private final Uniform1f blurProgress = blur.findUniform1f("Progress");
-
-    public static final Blur INSTANCE = new Blur();
+    private static final Uniform1f blurProgress = blur.findUniform1f("Progress");
 
     @Override
     public void onInitializeClient() {
-        defaultExclusions.add(ChatScreen.class.getName());
-        defaultExclusions.add("com.replaymod.lib.de.johni0702.minecraft.gui.container.AbstractGuiOverlay$UserInputGuiScreen");
-        defaultExclusions.add("ai.arcblroth.projectInception.client.InceptionInterfaceScreen");
-        defaultExclusions.add("net.optifine.gui.GuiChatOF");
-        defaultExclusions.add("io.github.darkkronicle.advancedchatcore.chat.AdvancedChatScreen");
-        defaultExclusions.add("net.coderbot.iris.gui.screen.ShaderPackScreen");
         BlurConfig.init("blur", BlurConfig.class);
 
         ShaderEffectRenderCallback.EVENT.register((deltaTick) -> {
             if (start > 0) {
-                blurProgress.set(getProgress());
+                blurProgress.set(getProgress(client.currentScreen != null));
                 blur.render(deltaTick);
             }
         });
     }
 
-    private boolean doFade = false;
+    private static boolean doFade = false;
 
-    public void onScreenChange(Screen newGui) {
-        if (MinecraftClient.getInstance().world != null) {
+    public static void onScreenChange(Screen newGui) {
+        if (client.world != null) {
             boolean excluded = newGui == null || BlurConfig.blurExclusions.stream().anyMatch(exclusion -> newGui.getClass().getName().contains(exclusion));
             if (!excluded) {
+                screenHasBackground = false;
                 if (BlurConfig.showScreenTitle) System.out.println(newGui.getClass().getName());
                 blur.setUniformValue("Radius", (float) BlurConfig.radius);
                 if (doFade) {
                     start = System.currentTimeMillis();
                     doFade = false;
                 }
+                prevScreen = newGui.getClass().getName();
+            } else if (newGui == null && BlurConfig.fadeOutTimeMillis > 0 && !BlurConfig.blurExclusions.contains(prevScreen)) {
+                blur.setUniformValue("Radius", (float) BlurConfig.radius);
+                start = System.currentTimeMillis();
+                doFade = true;
             } else {
+                screenHasBackground = false;
                 start = -1;
                 doFade = true;
             }
         }
     }
 
-    private float getProgress() {
-        float x = Math.min((System.currentTimeMillis() - start) / (float) BlurConfig.fadeTimeMillis, 1);
-        if (BlurConfig.ease) x *= (2 - x);  // easeOutCubic
-        return x;
+    private static float getProgress(boolean fadeIn) {
+        if (fadeIn) {
+            float x = Math.min((System.currentTimeMillis() - start) / (float) BlurConfig.fadeTimeMillis, 1);
+            if (BlurConfig.ease) x *= (2 - x);  // easeInCubic
+            return x;
+        }
+        else {
+            float x = Math.max(1+(start - System.currentTimeMillis()) / (float) BlurConfig.fadeOutTimeMillis, 0);
+            if (BlurConfig.ease) x *= (2 - x);  // easeOutCubic
+            if (x <= 0) {
+                start = 0;
+                screenHasBackground = false;
+            }
+            return x;
+        }
     }
 
-    public int getBackgroundColor(boolean second) {
+    public static int getBackgroundColor(boolean second, boolean fadeIn) {
         int a = second ? BlurConfig.gradientEndAlpha : BlurConfig.gradientStartAlpha;
         var col = MidnightColorUtil.hex2Rgb(second ? BlurConfig.gradientEnd : BlurConfig.gradientStart);
         int r = (col.getRGB() >> 16) & 0xFF;
         int b = (col.getRGB() >> 8) & 0xFF;
         int g = col.getRGB() & 0xFF;
-        float prog = INSTANCE.getProgress();
+        float prog = getProgress(fadeIn);
         a *= prog;
         r *= prog;
         g *= prog;

src/main/java/com/tterrag/blur/config/BlurConfig.java

@@ -1,27 +1,39 @@
 package com.tterrag.blur.config;
 
-import com.tterrag.blur.Blur;
+import com.google.common.collect.Lists;
 import eu.midnightdust.lib.config.MidnightConfig;
+import net.minecraft.client.gui.screen.ChatScreen;
 
 import java.util.List;
 
 public class BlurConfig extends MidnightConfig {
-    @Entry
-    public static List<String> blurExclusions = Blur.defaultExclusions;
-    @Entry(min = 0, max = 5000, width = 4)
+    public static final String style = "style";
+    public static final String screens = "screens";
+
+
+    @Entry(category = screens)
+    public static List<String> blurExclusions = Lists.newArrayList(ChatScreen.class.getName(),
+        "com.replaymod.lib.de.johni0702.minecraft.gui.container.AbstractGuiOverlay$UserInputGuiScreen",
+        "ai.arcblroth.projectInception.client.InceptionInterfaceScreen",
+        "net.optifine.gui.GuiChatOF",
+        "io.github.darkkronicle.advancedchatcore.chat.AdvancedChatScreen",
+        "net.coderbot.iris.gui.screen.ShaderPackScreen");
+    @Entry(category = style, min = 0, max = 5000, width = 4)
     public static int fadeTimeMillis = 200;
-    @Entry
+    @Entry(category = style, min = 0, max = 5000, width = 4)
+    public static int fadeOutTimeMillis = 0;
+    @Entry(category = style)
     public static boolean ease = true;
-    @Entry(min = 0, max = 500, width = 3)
+    @Entry(category = style, isSlider = true, min = 0, max = 100)
     public static int radius = 8;
-    @Entry(isColor = true, width = 7, min = 7)
+    @Entry(category = style, isColor = true, width = 7, min = 7)
     public static String gradientStart = "#000000";
-    @Entry(min = 0, max = 255)
+    @Entry(category = style, isSlider = true, min = 0, max = 255)
     public static int gradientStartAlpha = 75;
-    @Entry(isColor = true, width = 7, min = 7)
+    @Entry(category = style, isColor = true, width = 7, min = 7)
     public static String gradientEnd = "#000000";
-    @Entry(min = 0, max = 255)
+    @Entry(category = style, isSlider = true, min = 0, max = 255)
     public static int gradientEndAlpha = 75;
-    @Entry
+    @Entry(category = screens)
     public static boolean showScreenTitle = false;
-}
+}

src/main/java/com/tterrag/blur/mixin/MixinInGameHud.java

@@ -0,0 +1,27 @@
+package com.tterrag.blur.mixin;
+
+import com.tterrag.blur.Blur;
+import com.tterrag.blur.config.BlurConfig;
+import net.minecraft.client.MinecraftClient;
+import net.minecraft.client.gui.DrawableHelper;
+import net.minecraft.client.gui.hud.InGameHud;
+import net.minecraft.client.util.math.MatrixStack;
+import org.spongepowered.asm.mixin.Final;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.Shadow;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
+
+@Mixin(InGameHud.class)
+public class MixinInGameHud extends DrawableHelper {
+    @Shadow private int scaledWidth;
+    @Shadow private int scaledHeight;
+    @Final @Shadow private MinecraftClient client;
+    @Inject(at = @At(value = "INVOKE", target = "Lcom/mojang/blaze3d/systems/RenderSystem;setShaderTexture(ILnet/minecraft/util/Identifier;)V", ordinal = 0, shift = At.Shift.BEFORE), method = "render")
+    public void blur$onRender(MatrixStack matrices, float tickDelta, CallbackInfo ci) {
+        if (client.currentScreen == null && client.world != null && Blur.start > 0 && !BlurConfig.blurExclusions.contains(Blur.prevScreen) && Blur.screenHasBackground) {
+            fillGradient(matrices, 0, 0, this.scaledWidth, this.scaledHeight, Blur.getBackgroundColor(false, false), Blur.getBackgroundColor(true, false));
+        }
+    }
+}

src/main/java/com/tterrag/blur/mixin/MixinMinecraftClient.java

@@ -19,6 +19,6 @@ public class MixinMinecraftClient {
                      target = "Lnet/minecraft/client/MinecraftClient;currentScreen:Lnet/minecraft/client/gui/screen/Screen;",
                      opcode = Opcodes.PUTFIELD))
     private void onScreenOpen(Screen newScreen, CallbackInfo info) {
-        Blur.INSTANCE.onScreenChange(newScreen);
+        Blur.onScreenChange(newScreen);
     }
 }

src/main/java/com/tterrag/blur/mixin/MixinScreen.java

@@ -1,12 +1,10 @@
 package com.tterrag.blur.mixin;
 
-import com.tterrag.blur.config.BlurConfig;
 import net.minecraft.client.MinecraftClient;
-import net.minecraft.client.font.TextRenderer;
 import net.minecraft.client.util.math.MatrixStack;
-import net.minecraft.text.TextColor;
-import net.minecraft.util.Formatting;
+import net.minecraft.text.Text;
 import org.jetbrains.annotations.Nullable;
+import org.spongepowered.asm.mixin.Final;
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.Shadow;
 import org.spongepowered.asm.mixin.injection.At;
@@ -19,33 +17,38 @@ import com.tterrag.blur.Blur;
 import net.minecraft.client.gui.screen.Screen;
 import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
 
-import java.util.Locale;
-
 @Mixin(Screen.class)
 public abstract class MixinScreen {
 
     @Shadow @Nullable protected MinecraftClient client;
 
-    @Shadow protected TextRenderer textRenderer;
+    @Shadow @Final protected Text title;
+    private final Text blurConfig = Text.translatable("blur.midnightconfig.title");
 
     @Inject(at = @At("HEAD"), method = "tick")
     private void blur$reloadShader(CallbackInfo ci) {
-        if (this.getClass().toString().toLowerCase(Locale.ROOT).contains("midnightconfigscreen") && this.client != null) {
-            Blur.INSTANCE.onScreenChange(this.client.currentScreen);
+        if (this.client != null && this.title.equals(blurConfig)) {
+            Blur.onScreenChange(this.client.currentScreen);
+        }
+    }
+    @Inject(at = @At("HEAD"), method = "renderBackground")
+    public void blur$getBackgroundEnabled(MatrixStack matrices, CallbackInfo ci) {
+        if (this.client != null && this.client.world != null) {
+            Blur.screenHasBackground = true;
         }
     }
 
     @ModifyConstant(
-            method = "renderBackground(Lnet/minecraft/client/util/math/MatrixStack;I)V",
+            method = "renderBackground",
             constant = @Constant(intValue = -1072689136))
     private int blur$getFirstBackgroundColor(int color) {
-        return Blur.INSTANCE.getBackgroundColor(false);
+        return Blur.getBackgroundColor(false, true);
     }
 
     @ModifyConstant(
-            method = "renderBackground(Lnet/minecraft/client/util/math/MatrixStack;I)V",
+            method = "renderBackground",
             constant = @Constant(intValue = -804253680))
     private int blur$getSecondBackgroundColor(int color) {
-        return Blur.INSTANCE.getBackgroundColor(true);
+        return Blur.getBackgroundColor(true, true);
     }
 }

src/main/resources/assets/blur/lang/de_de.json

@@ -1,12 +1,15 @@
 {
   "blur.midnightconfig.title": "Blur Konfiguration",
   "blur.midnightconfig.blurExclusions": "Blur-Ausnahmen",
+  "blur.midnightconfig.category.style": "Stil",
+  "blur.midnightconfig.category.screens": "Bildschirme",
   "blur.midnightconfig.fadeTimeMillis": "Überblendzeit (in Millisekunden)",
+  "blur.midnightconfig.fadeOutTimeMillis": "Ausblendzeit (in milliseconds)",
   "blur.midnightconfig.ease": "Geschmeidige Animation",
   "blur.midnightconfig.radius": "Radius",
   "blur.midnightconfig.gradientStart": "Farbverlauf-Anfangsfarbe",
   "blur.midnightconfig.gradientEnd": "Farbverlauf-Endfarbe",
   "blur.midnightconfig.gradientStartAlpha": "Farbverlauf-Anfangstransparenz",
   "blur.midnightconfig.gradientEndAlpha": "Farbverlauf-Endstransparenz",
-  "blur.midnightconfig.showScreenTitle": "Zeige Bildschirmtitel"
+  "blur.midnightconfig.showScreenTitle": "Logge Bildschirmtitel"
 }

src/main/resources/assets/blur/lang/en_us.json

@@ -1,12 +1,15 @@
 {
   "blur.midnightconfig.title": "Blur Config",
+  "blur.midnightconfig.category.style": "Style",
+  "blur.midnightconfig.category.screens": "Screens",
   "blur.midnightconfig.blurExclusions": "Blur Exclusions",
   "blur.midnightconfig.fadeTimeMillis": "Fade Time (in milliseconds)",
+  "blur.midnightconfig.fadeOutTimeMillis": "Fade Out Time (in milliseconds)",
   "blur.midnightconfig.ease": "Ease Animation",
   "blur.midnightconfig.radius": "Radius",
   "blur.midnightconfig.gradientStart": "Gradient Start Color",
   "blur.midnightconfig.gradientEnd": "Gradient End Color",
   "blur.midnightconfig.gradientStartAlpha": "Gradient Start Alpha",
   "blur.midnightconfig.gradientEndAlpha": "Gradient End Alpha",
-  "blur.midnightconfig.showScreenTitle": "Show screen title"
+  "blur.midnightconfig.showScreenTitle": "Log screen title"
 }

src/main/resources/assets/blur/lang/fr_fr.json

@@ -0,0 +1,12 @@
+{
+  "blur.midnightconfig.title": "Configuration du flou",
+  "blur.midnightconfig.blurExclusions": "Flouter les exclusions",
+  "blur.midnightconfig.fadeTimeMillis": "Temps de fondu (en millisecondes)",
+  "blur.midnightconfig.ease": "Fluidité de l'animation",
+  "blur.midnightconfig.radius": "Rayon",
+  "blur.midnightconfig.gradientStart": "Couleur de départ du dégradé",
+  "blur.midnightconfig.gradientEnd": "Couleur de fin du dégradé",
+  "blur.midnightconfig.gradientStartAlpha": "Alpha de début du dégradé",
+  "blur.midnightconfig.gradientEndAlpha": "Alpha de fin du dégradé",
+  "blur.midnightconfig.showScreenTitle": "Montrer le titre de l'écran"
+}

src/main/resources/fabric.mod.json

@@ -8,23 +8,26 @@
   "icon": "assets/blur/icon.png",
   "entrypoints": {
     "client": [
-      "com.tterrag.blur.Blur::INSTANCE"
+      "com.tterrag.blur.Blur"
     ]
   },
   "contact": {
-    "homepage": "https://www.curseforge.com/minecraft/mc-mods/blur-fabric",
+    "homepage": "https://modrinth.com/mod/blur-fabric",
     "sources": "https://github.com/Motschen/Blur",
     "issues": "https://github.com/Motschen/Blur/issues"
   },
   "authors": [
     "tterrag1098",
-    "Pyrofab",
     "Motschen",
+    "Pyrofab",
     "backryun",
     "byquanton"
   ],
   "description": "Modifies the background behind Minecraft GUIs to have a blur effect",
   "mixins": [
     "mixins.blur.json"
-  ]
+  ],
+  "depends": {
+    "satin": "*"
+  }
 }

src/main/resources/mixins.blur.json

@@ -5,7 +5,8 @@
   "compatibilityLevel": "JAVA_17",
   "client": [
   	"MixinScreen",
-    "MixinMinecraftClient"
+    "MixinMinecraftClient",
+    "MixinInGameHud"
   ],
   "injectors": {
     "defaultRequire": 1