vaporvee/LoadSupport
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Yannik
2024-10-05 06:19:23 +02:00
committed by GitHub
parent d5e1042688
commit cf2434d3b2
1 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -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.<br>
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.