Minecraft 1.20.0 backport

Author: LostLuma

build-logic/src/main/kotlin/dynamic_fps.base.gradle.kts

@@ -24,7 +24,7 @@ if (project.hasProperty("loom.platform")) {
 tasks.withType<ProcessResources> {
     inputs.property("version", modVersion)
 
-    filesMatching(listOf("fabric.mod.json", "mods.toml", "neoforge.mods.toml", "quilt.mod.json")) {
+    filesMatching(listOf("fabric.mod.json", "META-INF/mods.toml", "META-INF/neoforge.mods.toml", "quilt.mod.json")) {
         expand(inputs.properties)
     }
 }

build-logic/src/main/kotlin/dynamic_fps.java.gradle.kts

@@ -6,14 +6,14 @@ java {
     withSourcesJar()
 
     toolchain {
-        languageVersion = JavaLanguageVersion.of(21)
+        languageVersion = JavaLanguageVersion.of(17)
     }
 }
 
 tasks.withType<JavaCompile> {
     options.encoding = "UTF-8"
 
     javaCompiler = javaToolchains.compilerFor {
-        languageVersion = JavaLanguageVersion.of(21)
+        languageVersion = JavaLanguageVersion.of(17)
     }
 }

gradle.properties

@@ -10,9 +10,9 @@ maven_group = juliand665
 archives_name = dynamic-fps
 
 # File naming version
-minecraft_version = 1.21.0
+minecraft_version = 1.20.0
 # Version for publishing
-minecraft_version_min = 1.21
-minecraft_version_max = 1.21
+minecraft_version_min = 1.20
+minecraft_version_max = 1.20.4
 
-enabled_platforms=fabric,neoforge,quilt
+enabled_platforms=fabric,forge,neoforge,quilt

gradle/libs.versions.toml

@@ -1,14 +1,14 @@
 [versions]
-minecraft = "1.21"
+minecraft = "1.20.4"
 
 # Platform libraries
 
 fabric_loader = "0.15.10"
-fabric_api = "0.100.1+1.21"
+fabric_api = "0.96.1+1.20.4"
 
 forge = "1.20.4-49.0.30"
 
-neoforge = "21.0.0-beta"
+neoforge = "20.4.237"
 
 quilt_loader = "0.25.0"
 quilt_standard_libraries = "8.0.0-alpha.12+1.20.4"
@@ -19,8 +19,8 @@ battery = "1.1.0"
 
 # Modding libraries
 
-modmenu = "11.0.0-beta.1"
-cloth_config = "15.0.127"
+modmenu = "9.0.0"
+cloth_config = "13.0.121"
 
 mixinextras = "0.3.5"
 

platforms/common/src/main/java/dynamic_fps/impl/DynamicFPSMod.java

@@ -14,12 +14,14 @@
 import dynamic_fps.impl.util.FallbackConfigScreen;
 import dynamic_fps.impl.util.Logging;
 import dynamic_fps.impl.feature.state.OptionHolder;
+import dynamic_fps.impl.util.ModCompatHelper;
 import dynamic_fps.impl.util.ResourceLocations;
 import dynamic_fps.impl.util.Version;
 import dynamic_fps.impl.feature.volume.SmoothVolumeHandler;
 import dynamic_fps.impl.util.duck.DuckLoadingOverlay;
 import dynamic_fps.impl.feature.state.WindowObserver;
 import dynamic_fps.impl.service.Platform;
+import dynamic_fps.impl.util.duck.DuckScreen;
 import net.lostluma.battery.api.State;
 import net.minecraft.Util;
 import net.minecraft.client.Minecraft;
@@ -174,7 +176,7 @@ public static boolean shouldShowToasts() {
 	}
 
 	public static boolean shouldShowLevels() {
-		return isDisabled() || !isLevelCoveredByOverlay();
+		return isDisabled() || !(isLevelCoveredByScreen() || isLevelCoveredByOverlay());
 	}
 
 	public static void onBatteryChargeChanged(int before, int after) {
@@ -196,11 +198,17 @@ public static void onBatteryStatusChanged(State before, State after) {
 	private static void doInit() {
 		// NOTE: Init battery tracker first here
 		// Since the idle handler queries it for info
+		ModCompatHelper.init();
+
 		BatteryTracker.init();
 		IdleHandler.init();
 		SmoothVolumeHandler.init();
 	}
 
+	private static boolean isLevelCoveredByScreen() {
+		return minecraft.screen != null && ((DuckScreen) minecraft.screen).dynamic_fps$rendersBackground();
+	}
+
 	private static void showNotification(String titleTranslationKey, String iconPath) {
 		if (!DynamicFPSConfig.INSTANCE.batteryTracker().notifications()) {
 			return;

platforms/common/src/main/java/dynamic_fps/impl/feature/battery/BatteryTracker.java

@@ -58,7 +58,7 @@ public static void init() {
 			}
 		} else {
 			manager = temp; // Keep around to allow updating batteries
-			Thread.ofVirtual().name("refresh-battery").start(BatteryTracker::updateBatteries);
+			new Thread(BatteryTracker::updateBatteries, "refresh-battery").start();
 		}
 	}
 
@@ -127,7 +127,7 @@ private static void updateBatteries() {
 			updateState();
 
 			try {
-				Thread.sleep(updateInterval);
+				Thread.sleep(updateInterval.toMillis());
 			} catch (InterruptedException e) {
 				active = false;
 				Thread.currentThread().interrupt();

platforms/common/src/main/java/dynamic_fps/impl/mixin/ScreenMixin.java

@@ -0,0 +1,50 @@
+package dynamic_fps.impl.mixin;
+
+import dynamic_fps.impl.service.ModCompat;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.Unique;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
+
+import dynamic_fps.impl.util.duck.DuckScreen;
+import net.minecraft.client.gui.screens.Screen;
+
+@Mixin(Screen.class)
+public class ScreenMixin implements DuckScreen {
+	@Unique
+	private boolean dynamic_fps$canOptimize = false;
+
+	@Unique
+	private boolean dynamic_fps$hasOptedOut = false;
+
+	@Override
+	public boolean dynamic_fps$rendersBackground() {
+		return dynamic_fps$canOptimize;
+	}
+
+	@Override
+	public void dynamic_fps$setRendersBackground() {
+		this.dynamic_fps$canOptimize = true;
+	}
+
+	@Inject(method = "init", at = @At("HEAD"))
+	private void onInit(CallbackInfo callbackInfo) {
+		String name = this.getClass().getName();
+
+		this.dynamic_fps$hasOptedOut = ModCompat.getInstance().isScreenOptedOut(name);
+
+		// Allow other mods to opt out on behalf of vanilla screens
+		// That Dynamic FPS forced to opt in via its own mod metadata.
+		if (!this.dynamic_fps$hasOptedOut) {
+			this.dynamic_fps$canOptimize = ModCompat.getInstance().isScreenOptedIn(name);
+		}
+	}
+
+	@Inject(method = "renderDirtBackground", at = @At("HEAD"))
+	private void onRenderDirtBackground(CallbackInfo callbackInfo) {
+		if (!this.dynamic_fps$hasOptedOut) {
+			this.dynamic_fps$canOptimize = true; // Signal to apply optimizations on next frame
+		}
+	}
+}

platforms/common/src/main/java/dynamic_fps/impl/mixin/StatsScreenMixin.java

@@ -0,0 +1,17 @@
+package dynamic_fps.impl.mixin;
+
+import dynamic_fps.impl.util.duck.DuckScreen;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
+
+import net.minecraft.client.gui.screens.achievement.StatsScreen;
+
+@Mixin(StatsScreen.class)
+public class StatsScreenMixin {
+	@Inject(method = "onStatsUpdated", at = @At("HEAD"))
+	private void onStatsUpdated(CallbackInfo callbackInfo) {
+		((DuckScreen) this).dynamic_fps$setRendersBackground();
+	}
+}

platforms/common/src/main/java/dynamic_fps/impl/service/ModCompat.java

@@ -1,10 +1,23 @@
 package dynamic_fps.impl.service;
 
+import java.util.Set;
+
 public interface ModCompat {
 	boolean isDisabled();
 
 	boolean disableOverlayOptimization();
 
+	Set<String> getOptedInScreens();
+	Set<String> getOptedOutScreens();
+
+	default boolean isScreenOptedIn(String className) {
+		return getOptedInScreens().contains(className);
+	}
+
+	default boolean isScreenOptedOut(String className) {
+		return getOptedOutScreens().contains(className);
+	}
+
 	static ModCompat getInstance() {
 		return Services.MOD_COMPAT;
 	}

platforms/common/src/main/java/dynamic_fps/impl/util/FallbackConfigScreen.java

@@ -33,6 +33,7 @@ protected void init() {
 
 	@Override
 	public void render(GuiGraphics guiGraphics, int mouseX, int mouseY, float partialTicks) {
+		this.renderDirtBackground(guiGraphics);
 		super.render(guiGraphics, mouseX, mouseY, partialTicks);
 
 		int width = guiGraphics.guiWidth() / 2;

platforms/common/src/main/java/dynamic_fps/impl/util/ModCompatHelper.java

@@ -0,0 +1,40 @@
+package dynamic_fps.impl.util;
+
+import dynamic_fps.impl.service.ModCompat;
+import dynamic_fps.impl.service.Platform;
+
+import java.util.Optional;
+
+public class ModCompatHelper {
+	public static void init() {
+		fixFastloadSoftLock();
+	}
+
+	/**
+	 * Fix softlock in combination with Fastload <=3.4.0 due to our screen / loading overlay optimization.
+	 *
+	 * See the <a href="https://github.com/juliand665/Dynamic-FPS/issues/129">issue report</a> for more info.
+	 */
+	private static void fixFastloadSoftLock() {
+		Optional<Version> optional = Platform.getInstance().getModVersion("fastload");
+
+		if (optional.isEmpty()) {
+			return;
+		}
+
+		Version other;
+
+		try {
+			other = Version.of("3.4.0");
+		} catch (Version.VersionParseException e) {
+			throw new RuntimeException(e);
+		}
+
+		// If a version below 3.4.0 is present opt their custom world loading screen out of our optimization
+		if (optional.get().compareTo(other) <= 0) {
+			ModCompat.getInstance().getOptedOutScreens().add(
+				"io.github.bumblesoftware.fastload.client.BuildingTerrainScreen"
+			);
+		}
+	}
+}

platforms/common/src/main/java/dynamic_fps/impl/util/ResourceLocations.java

@@ -4,6 +4,6 @@
 
 public class ResourceLocations {
 	public static ResourceLocation of(String namespace, String path) {
-		return ResourceLocation.fromNamespaceAndPath(namespace, path);
+		return new ResourceLocation(namespace, path);
 	}
 }

platforms/common/src/main/java/dynamic_fps/impl/util/VariableStepTransformer.java

@@ -1,6 +1,7 @@
 package dynamic_fps.impl.util;
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.Comparator;
 import java.util.List;
 
@@ -13,9 +14,11 @@
 public class VariableStepTransformer {
 	private boolean unsorted;
 	private final List<Step> steps;
+	private final List<Step> reversedSteps;
 
 	public VariableStepTransformer() {
 		this.steps = new ArrayList<>();
+		this.reversedSteps = new ArrayList<>();
 	}
 
 	/**
@@ -27,6 +30,7 @@ public VariableStepTransformer() {
 	public void addStep(int change, int max) {
 		this.unsorted = true;
 		this.steps.add(new Step(change, max));
+		this.reversedSteps.add(new Step(change, max));
 	}
 
 	/**
@@ -42,7 +46,7 @@ public int toStep(int value) {
 		int currentChange = 0;
 		int currentValue = value;
 
-		for (Step pair : this.steps.reversed()) {
+		for (Step pair : this.reversedSteps) {
 			if (currentValue > pair.max && currentChange != 0) {
 				step += Math.floorDiv(currentValue - pair.max, currentChange);
 				currentValue = pair.max;
@@ -86,6 +90,14 @@ public int compare(Step self, Step other) {
 				return Integer.compare(self.max, other.max);
 			}
 		});
+
+		this.reversedSteps.sort(new Comparator<Step>() {
+			@Override
+			public int compare(Step self, Step other) {
+				return Integer.compare(self.max, other.max);
+			}
+		});
+		Collections.reverse(this.reversedSteps);
 	}
 
 	private record Step(int change, int max) {}

platforms/common/src/main/java/dynamic_fps/impl/util/duck/DuckScreen.java

@@ -0,0 +1,11 @@
+package dynamic_fps.impl.util.duck;
+
+public interface DuckScreen {
+	default boolean dynamic_fps$rendersBackground() {
+		throw new RuntimeException("No implementation for dynamic_fps$rendersBackground was found.");
+	}
+
+	default void dynamic_fps$setRendersBackground() {
+		throw new RuntimeException("No implementation for dynamic_fps$rendersBackground was found.");
+	}
+}

platforms/common/src/main/resources/dynamic_fps-common.mixins.json

@@ -8,7 +8,9 @@
         "GuiMixin",
         "LoadingOverlayMixin",
         "MinecraftMixin",
+        "ScreenMixin",
         "SoundEngineMixin",
+        "StatsScreenMixin",
         "ToastComponentMixin",
         "WindowMixin",
         "bugfix.BlockableEventLoopMixin"

platforms/fabric/build.gradle

@@ -85,13 +85,11 @@ publishMods {
 		accessToken = providers.environmentVariable("CURSEFORGE_SECRET")
 		projectId = "335493"
 
-		/*
 		minecraftVersionRange {
 			start = project.property("minecraft_version_min").toString()
 			end = project.property("minecraft_version_max").toString()
 		}
-		*/
-		minecraftVersions.add(project.property("minecraft_version_min").toString())
+		// minecraftVersions.add(project.property("minecraft_version_min").toString())
 
 		clientRequired = true
 		serverRequired = false
@@ -104,15 +102,13 @@ publishMods {
 		accessToken = providers.environmentVariable("MODRINTH_SECRET")
 		projectId = "LQ3K71Q1"
 
-		/*
 		minecraftVersionRange {
 			start = project.property("minecraft_version_min").toString()
 			end = project.property("minecraft_version_max").toString()
 
 			includeSnapshots = true
 		}
-		*/
-		minecraftVersions.add(project.property("minecraft_version_min").toString())
+		// minecraftVersions.add(project.property("minecraft_version_min").toString())
 
 		requires("fabric-api")
 		optional("cloth-config", "modmenu")

platforms/fabric/src/main/java/net/lostluma/dynamic_fps/impl/fabric/mixin/GuiMixin.java

@@ -14,7 +14,13 @@ public class GuiMixin {
 	/**
 	 * Render info on whether Dynamic FPS is disabled or always reducing the user's FPS.
 	 */
-	@Inject(method = "renderSavingIndicator", at = @At("HEAD"))
+	@Inject(
+		method = "render",
+		at = @At(
+			value = "INVOKE",
+			target = "Lnet/minecraft/client/gui/Gui;renderSavingIndicator(Lnet/minecraft/client/gui/GuiGraphics;)V"
+		)
+	)
 	private void renderSavingIndicator(CallbackInfo callbackInfo, @Local(argsOnly = true) GuiGraphics guiGraphics) {
 		HudInfoRenderer.renderInfo(guiGraphics);
 	}