From cf2434d3b20a6cc3d727de2442c1c2582e8389d2 Mon Sep 17 00:00:00 2001 From: Yannik <80621863+vaporvee@users.noreply.github.com> Date: Sat, 5 Oct 2024 06:19:23 +0200 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 60cf0ac..64a8ff5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,16 @@ # Load Support Shows when the user has to less Java memory allocated, and plays a sound when the game has loaded.
-It is fully configurable in `config/enoughmemory.toml` +It is fully configurable in `config/enoughmemory.toml`. ## Directly Shows a warning message -![image](https://github.com/user-attachments/assets/7f3b152c-a744-4570-91b4-5d005ac6f94b) +![image](https://github.com/user-attachments/assets/b571a607-ec88-4032-9996-876637c156c1) ## Blocks the title screen -![image](https://github.com/user-attachments/assets/30ad49ba-ef25-4431-87ef-81ea161f17e3) +![image](https://github.com/user-attachments/assets/e05b52bd-3cf2-4526-826b-db62c8723831) +## Config +The config in `config/enoughmemory.toml` is pretty self explainatory: +```toml +startSound = true +minMemory = 4.0 +errorTitle = "Error: Not enough Java memory!" +errorDescription = "Please allocate at least {minMemory} GB of Java memory to your Minecraft Instance! You have currently {currentMemory} GB allocated." +``` +The errorDescription does automatic line breaks. `{minMemory}` and `{currentMemory}` get replaced by their actual values.