feature: add not enough memory warning screen (#96)

* Feature: Warning for high or low max allocated RAM

Added a method which checks the ram allocation and then gives a warning if it is offset by 1100 MB from the recommended max ram allocation. The offset for 1100 is set because AA-like categories use about 1000 MB more than other categories. MultiMC's Ram Allocation amounts may pass the 1000 MB barrier, to avoid it we add 100 more to the 1000 MB. There's also a system property to disable it.

* feature: warning screen for allocated memory check

Replaced the log message with a screen, removed the upper memory limit.

* feat: check memory when starting resetting

- Change the low memory warning to trigger when starting resetting,
not on launch, as it depends on the max queued seeds config.

- Mention max queued seeds in the warning, and link to the wiki.

* feat: memory warning wiki link description

Link: #96

---------

Co-authored-by: Crystal15118 <138210704+Crystal15118@users.noreply.github.com>

Author: me-nx

src/main/java/me/contaria/seedqueue/SeedQueue.java

@@ -4,6 +4,7 @@
 import me.contaria.seedqueue.compat.ModCompat;
 import me.contaria.seedqueue.debug.SeedQueueSystemInfo;
 import me.contaria.seedqueue.debug.SeedQueueWatchdog;
+import me.contaria.seedqueue.gui.MemoryWarningScreen;
 import me.contaria.seedqueue.gui.wall.SeedQueueWallScreen;
 import me.contaria.seedqueue.mixin.accessor.MinecraftClientAccessor;
 import me.contaria.seedqueue.mixin.accessor.MinecraftServerAccessor;
@@ -15,9 +16,7 @@
 import net.fabricmc.loader.api.Version;
 import net.minecraft.client.MinecraftClient;
 import net.minecraft.client.gui.WorldGenerationProgressTracker;
-import net.minecraft.client.gui.screen.ProgressScreen;
-import net.minecraft.client.gui.screen.SaveLevelScreen;
-import net.minecraft.client.gui.screen.Screen;
+import net.minecraft.client.gui.screen.*;
 import net.minecraft.server.MinecraftServer;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -45,11 +44,33 @@ public class SeedQueue implements ClientModInitializer {
     public static final ThreadLocal<SeedQueueEntry> LOCAL_ENTRY = new ThreadLocal<>();
     public static SeedQueueEntry currentEntry;
 
+    public static boolean memoryWarningShown = false;
+
     @Override
     public void onInitializeClient() {
         SeedQueueSounds.init();
     }
 
+    /**
+     * @return true if a warning was shown
+     */
+    public static boolean checkRamAllocation() {
+        int allocatedMem = (int)(Runtime.getRuntime().maxMemory() / (1024 * 1024));
+
+        int recommendedMinRam = 1800 + (config.maxCapacity * 180);
+
+        if (allocatedMem < recommendedMinRam && config.maxCapacity != 0) {
+            MinecraftClient.getInstance().openScreen(
+                // Add 128 MiB to the recommended amount to account for Runtime#maxMemory() inaccuracies
+                new MemoryWarningScreen(allocatedMem, recommendedMinRam + 128)
+            );
+
+            return true;
+        }
+
+        return false;
+    }
+
     /**
      * Polls a new {@link SeedQueueEntry} from the queue and plays it.
      *

src/main/java/me/contaria/seedqueue/SeedQueueConfig.java

@@ -113,6 +113,9 @@ public class SeedQueueConfig implements SpeedrunConfig {
     @Config.Numbers.Whole.Bounds(min = -1, max = 500, enforce = Config.Numbers.EnforceBounds.MIN_ONLY)
     public long chunkMapFreezing = -1;
 
+    @Config.Category("troubleshooting")
+    public boolean checkMinMemory = true;
+
     @Config.Category("advanced")
     public boolean showAdvancedSettings = false;
 
@@ -347,6 +350,12 @@ public boolean isAvailable() {
         return !SeedQueue.isActive();
     }
 
+    @Override
+    public void onSave(JsonObject jsonObject) {
+        // Changing the config can change whether the warning should be shown
+        SeedQueue.memoryWarningShown = false;
+    }
+
     public static class WindowSize {
         private int width;
         private int height;

src/main/java/me/contaria/seedqueue/gui/MemoryWarningScreen.java

@@ -0,0 +1,133 @@
+package me.contaria.seedqueue.gui;
+
+import me.contaria.seedqueue.SeedQueue;
+import net.minecraft.client.MinecraftClient;
+import net.minecraft.client.gui.screen.ConfirmChatLinkScreen;
+import net.minecraft.client.gui.screen.Screen;
+import net.minecraft.client.gui.screen.ScreenTexts;
+import net.minecraft.client.gui.widget.ButtonWidget;
+import net.minecraft.client.util.Rect2i;
+import net.minecraft.client.util.math.MatrixStack;
+import net.minecraft.text.*;
+import net.minecraft.util.Formatting;
+import net.minecraft.util.Util;
+
+import java.io.IOException;
+import java.util.List;
+
+public class MemoryWarningScreen extends Screen {
+	static final String WIKI_URI = "https://github.com/contariaa/seedqueue/wiki/Troubleshooting#not-enough-memory";
+
+	static final MutableText HOVERED_WIKI_LINK = new LiteralText(WIKI_URI)
+		.styled(style -> style.withFormatting(Formatting.UNDERLINE));
+
+	final Text message;
+	List<StringRenderable> messageParts;
+	int wikiLinkY;
+
+	public MemoryWarningScreen(int allocatedMem, int recommendedMinMem) {
+		super(new TranslatableText("seedqueue.menu.memoryWarning.title"));
+
+		this.message = new TranslatableText("seedqueue.menu.memoryWarning.message", allocatedMem, recommendedMinMem);
+	}
+
+	@Override
+	protected void init() {
+		super.init();
+
+		this.messageParts = this.textRenderer.wrapLines(this.message, this.width - 50);
+
+		int btnXBase = this.width / 2 - 155;
+		int btnY = this.height / 6 + 100;
+
+		this.addButton(new ButtonWidget(btnXBase, btnY, 150, 20, ScreenTexts.PROCEED, (_btn) ->
+				MinecraftClient.getInstance().openScreen(null)
+		));
+
+		Text ignoreWarningText = new TranslatableText("seedqueue.menu.memoryWarning.doNotWarnAgain");
+
+		this.addButton(new ButtonWidget(btnXBase + 160, btnY, 150, 20, ignoreWarningText, (_btn) -> {
+			SeedQueue.config.checkMinMemory = false;
+
+			try {
+				SeedQueue.config.container.save();
+			} catch (IOException e) {
+				SeedQueue.LOGGER.error("failed to save the SeedQueue config", e);
+			}
+
+			MinecraftClient.getInstance().openScreen(null);
+		}));
+	}
+
+	@Override
+	public void render(MatrixStack matrices, int mouseX, int mouseY, float delta) {
+		this.renderBackground(matrices);
+		this.drawCenteredText(matrices, this.textRenderer, this.title, this.width / 2, 70, 0xffffff);
+
+		int nextLineY = 90;
+
+		for (StringRenderable line : messageParts) {
+			this.drawCenteredText(matrices, this.textRenderer, line, this.width / 2, nextLineY, 0xffffff);
+			nextLineY += 9;
+		}
+
+		nextLineY += 9;
+
+		Text wikiLinkInfo = new TranslatableText("seedqueue.menu.memoryWarning.wikiLinkInfo");
+		this.drawCenteredText(matrices, this.textRenderer, wikiLinkInfo, this.width / 2, nextLineY, 0xffffff);
+		nextLineY += 9;
+
+		this.drawCenteredText(
+			matrices,
+			this.textRenderer,
+			this.mouseOverWikiText(mouseX, mouseY) ? HOVERED_WIKI_LINK : StringRenderable.plain(WIKI_URI),
+			this.width / 2,
+			nextLineY,
+			0xffffff
+		);
+		wikiLinkY = nextLineY;
+
+		super.render(matrices, mouseX, mouseY, delta);
+	}
+
+	@Override
+	public boolean mouseClicked(double mouseX, double mouseY, int button) {
+		assert this.client != null;
+
+		if (button == 0 && mouseOverWikiText((int) mouseX, (int) mouseY)) {
+			if (this.client.options.chatLinksPrompt) {
+				this.client.openScreen(new ConfirmChatLinkScreen((open) -> {
+					if (open) {
+						Util.getOperatingSystem().open(WIKI_URI);
+					}
+
+					this.client.openScreen(this);
+				}, WIKI_URI, true));
+			} else {
+				Util.getOperatingSystem().open(WIKI_URI);
+			}
+		}
+
+		return super.mouseClicked(mouseX, mouseY, button);
+	}
+
+	private boolean mouseOverWikiText(int mouseX, int mouseY) {
+		int wikiTextWidth = this.textRenderer.getWidth(WIKI_URI);
+
+		int startX = this.width / 2 - wikiTextWidth / 2;
+
+		Rect2i wikiTextRect = new Rect2i(startX, wikiLinkY, wikiTextWidth, textRenderer.fontHeight);
+
+		return wikiTextRect.contains(mouseX, mouseY);
+	}
+
+	@Override
+	public boolean keyPressed(int keyCode, int scanCode, int modifiers) {
+		if (keyCode == 256) {
+			MinecraftClient.getInstance().openScreen(null);
+			return true;
+		} else {
+			return super.keyPressed(keyCode, scanCode, modifiers);
+		}
+	}
+}

src/main/java/me/contaria/seedqueue/mixin/compat/atum/AtumMixin.java

@@ -12,6 +12,7 @@
 import net.minecraft.client.gui.screen.ProgressScreen;
 import net.minecraft.client.gui.screen.Screen;
 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;
@@ -30,6 +31,13 @@ public abstract class AtumMixin {
             )
     )
     private static void openSeedQueueWallScreen(MinecraftClient client, Screen screen, Operation<Void> original) {
+        if (!SeedQueue.memoryWarningShown && SeedQueue.config.checkMinMemory) {
+            if (SeedQueue.checkRamAllocation()) {
+                SeedQueue.memoryWarningShown = true;
+                return;
+            }
+        }
+
         if (!SeedQueue.isActive()) {
             original.call(client, screen);
             return;

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

@@ -7,6 +7,12 @@
   "seedqueue.menu.layout_exception.title": "Custom Layout failed!",
   "seedqueue.menu.layout_exception.description": "Failed with %s, check the log for more information.",
 
+  "seedqueue.menu.memoryWarning.title": "§6§lNot enough memory allocated",
+  "seedqueue.menu.memoryWarning.message": "SeedQueue might not have enough memory available (%d MiB). Try allocating at least %d MiB or lowering Max Queued Seeds.",
+  "seedqueue.menu.memoryWarning.messageLowerQueued": "SeedQueue might not have enough memory available (%d MiB). Try lowering 'Max Queued Seeds'.",
+  "seedqueue.menu.memoryWarning.wikiLinkInfo": "Click on this link to read more on the SeedQueue Wiki:",
+  "seedqueue.menu.memoryWarning.doNotWarnAgain": "Do not warn again",
+
   "seedqueue.menu.benchmark.title": "SeedQueue Benchmark",
   "seedqueue.menu.benchmark.result": "%s resets in %ss (%s RPS)",
 
@@ -48,6 +54,7 @@
   "speedrunapi.config.seedqueue.category.wall": "Wall Screen Settings",
   "speedrunapi.config.seedqueue.category.performance": "Performance Settings",
   "speedrunapi.config.seedqueue.category.misc": "Misc. Settings",
+  "speedrunapi.config.seedqueue.category.troubleshooting": "Troubleshooting",
   "speedrunapi.config.seedqueue.category.advanced": "Advanced Settings",
   "speedrunapi.config.seedqueue.category.threading": "Threading Settings",
   "speedrunapi.config.seedqueue.category.experimental": "Experimental Settings",
@@ -126,5 +133,6 @@
   "speedrunapi.config.seedqueue.option.benchmarkResets": "Benchmark Resets",
   "speedrunapi.config.seedqueue.option.benchmarkResets.description": "The default amount of resets done when starting a benchmark.\nYou can start a benchmark using the \"Start Benchmark\" keybind and cancel it before it reaches the configured amount of resets using the \"Stop Benchmark\" keybind.",
   "speedrunapi.config.seedqueue.option.showChunkMaps": "Chunkmap Overlay",
-  "speedrunapi.config.seedqueue.option.showChunkMaps.description": "Renders an overlay with all the chunkmaps of currently generating seeds."
+  "speedrunapi.config.seedqueue.option.showChunkMaps.description": "Renders an overlay with all the chunkmaps of currently generating seeds.",
+  "speedrunapi.config.seedqueue.option.checkMinMemory": "Check Allocated Memory"
 }