Skip to content

Commit 09cc7d8

Browse files
authored
📜 Added README.md
Created README.md
1 parent 0e1c71f commit 09cc7d8

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Minecraft Startup Script
2+
3+
A fully-customisable, modular .bat startup script for Minecraft servers, where all variables can be modified on the fly and applied upon server restart.
4+
5+
## Features
6+
1️⃣ Toggleable auto-restart
7+
2️⃣ Customisable JVM arguments/flags - including optional optimised preset
8+
3️⃣ Customisable RAM allocation
9+
4️⃣ Auto-generate+accept EULA
10+
5️⃣ GUI toggle
11+
6️⃣ Customisable console title
12+
13+
## Requirements
14+
- Windows OS
15+
- Java 17
16+
17+
## How to Use
18+
1. Download the script's latest release (ensure it is saved as a '.bat').
19+
2. Place it in your Minecraft server's root directory.
20+
3. Run the script by either double clicking the file, or executing via CMD.
21+
4. Upon first use, the script will run you through the configuration prompts.
22+
23+
To edit configurations:
24+
JVM arguments = /config/jvm_args.txt
25+
Script config = /config/StartupScript.conf
26+
27+
To apply configuration changes while the script is still running (i.e. console is still open), simply restart the Minecraft server.
28+
No need to restart the script.
29+
30+
## Screenshots
31+
Coming soon...
32+
33+
## Disclaimer
34+
By using this script, you are indicating your agreement to the [Minecraft EULA](https://aka.ms/MinecraftEULA).
35+
36+
## License
37+
[GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/)

0 commit comments

Comments
 (0)