Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vaporvee authored Oct 5, 2024
1 parent f4c4842 commit 97f7669
Showing 1 changed file with 29 additions and 7 deletions.
36 changes: 29 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# Load Support
Shows when the user has too less Java memory allocated, and plays a sound when the game has loaded.<br>
# Load Support

Shows when the player has **too less Java memory** allocated, and **plays a sound** when the game has finished loading.<br>
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
Expand All @@ -14,3 +12,27 @@ 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.

<img src="https://cdn.modrinth.com/data/bnO15g6H/images/881f15c2413795ba1ba0bebd2baf4c0f4862336c.png" width="600px">

---

### Play a sound when Minecraft finished loading 🔊
Directly know when Minecraft started when beeing in the background.

Sound effect used:
https://www.youtube-nocookie.com/embed/h2eBoIoq5vw

0 comments on commit 97f7669

Please sign in to comment.