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
-
-## Blocks the title screen
-
-## 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.
+
+
+
+#### 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