From 115ba75c60757f1da425991d63269545ddae5e14 Mon Sep 17 00:00:00 2001 From: Yannik <80621863+vaporvee@users.noreply.github.com> Date: Sat, 5 Oct 2024 20:43:44 +0200 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 70d6d4c..90dec32 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,8 @@ ο»Ώ# Load Support -Shows when the user has too less Java memory allocated, and plays a sound when the game has loaded.
+Shows when the player has **too less Java memory** allocated, and **plays a sound** when the game has finished loading.
It is fully configurable in `config/loadsupport.toml`. -## Directly Shows a warning message -![image](https://github.com/user-attachments/assets/b571a607-ec88-4032-9996-876637c156c1) -## Blocks the title screen -![image](https://github.com/user-attachments/assets/e05b52bd-3cf2-4526-826b-db62c8723831) -## Config + +## Config πŸš€ The config in `config/loadsupport.toml` is pretty self explainatory: ```toml startSound = true @@ -14,3 +11,26 @@ 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. + +## Planned Features πŸ‘€ +- πŸ”Š Customizable startup sound +- πŸͺ› Ingame settings (Modlist support) +- 🧩 More features letting the player know why Minecraft is not loading + +## Features +### Directly show a warning when too less Java Memory was selected 🚨 +The player doesn't need to wait just to know that they selected the wrong amount of Java Memory. + +![Screenshot](https://cdn.modrinth.com/data/bnO15g6H/images/dfa614eed2075c99c9d1ab3031d73ca9a4b1c59f.png) + +#### Blocks the title screen🚧 +Make sure the player gets the correct performance experience. + + + +--- + +### Play a sound when Minecraft finished loading πŸ”Š +Directly know when Minecraft started when beeing in the background. + +Sound used: https://www.youtube-nocookie.com/embed/h2eBoIoq5vw