📝 Included functionality

Included current and planned functionality.
Added release badge.
Improved formatting to improve structure and readability.

Author: GarnServo

README.md

@@ -1,6 +1,11 @@
-# Minecraft Startup Script
+<div align="center">
 
-A fully-customisable, modular .bat startup script for Minecraft servers, where all variables can be modified on the fly and applied upon server restart.
+  # `Minecraft Startup Script`
+![GitHub Release](https://img.shields.io/github/v/release/GarnServo/mc-startup-script?style=for-the-badge&logo=github&labelColor=1a1a1a&color=EB5B27)
+
+### A fully-customisable, modular .bat startup script for Minecraft servers, where all variables can be modified on the fly and applied upon server restart.
+
+</div>
 
 ## Features
 1️⃣ Toggleable auto-restart  
@@ -15,7 +20,7 @@ A fully-customisable, modular .bat startup script for Minecraft servers, where a
 - Java 17
 
 ## How to Use
-1. Download the script's latest release (ensure it is saved as a '.bat').
+1. Download the script's [latest release](https://github.com/GarnServo/mc-startup-script/releases/latest) (ensure it is saved as a '.bat').
 2. Place it in your Minecraft server's root directory.
 3. Run the script by either double clicking the file, or executing via CMD.
 4. Upon first use, the script will run you through the configuration prompts.
@@ -33,6 +38,36 @@ No need to restart the script.
 
 ![Console Screenshot](https://raw.githubusercontent.com/GarnServo/mc-startup-script/main/imgs/Console_launch.png)
 
+## Functionality
+### First Launch/Initial Setup
+- [X] Prompts user for server .jar filename. Checks if the file exists.
+- [X] Prompts user to allocate initial and maximum RAM for the server. Checks if entry is a valid value.
+- [X] Queries user whether the server should auto-restart or not.
+- [X] Queries user whether server should use pre-configured JVM arguments. Regardless of result, will generate file for flag storage.
+- [X] Queries user whether to launch with GUI.
+- [X] Lets user confirm choices. If confirmed, continue to normal startup. If rejected, will restart initial configuration.
+- [X] Stores configuration in /config/StartupScript.conf, and JVM args in /config/jvm_args.txt.
+- [X] Generates auto-accepted EULA.
+### Normal Startup
+- [X] Checks for config folder, config file, and sets restart counter. If config is missing, reverts back to initial setup.
+- [X] Checks for EULA, if non-existent, creates accepted eula.txt.
+- [X] Reads script config file and stores contents as environment variables.
+- [X] Displays configuration to user and initialises the server.
+- [X] Checks for JVM arguments file, if non-existent, will create one with optimised flags. If it exists, loads the args into an environment variable.
+- [X] Checks auto-restart config to decide launch path.
+#### Auto-Restart Enabled
+- [X] Launches server and changes console title to the configurable title + restart count.
+- [X] Upon crash or restart, increments the restart counter and reloads configuration + JVM flags.
+#### Auto-Restart Disabled
+- [X] Launches server and changes console title to the configurable title.
+- [X] Upon crash or restart, prompts user whether to restart or exit.  
+
+### Planned
+- [ ] Include version checking for this script
+- [ ] Auto-update this script
+- [ ] Improved text formatting
+- [ ] 
+
 ## Disclaimer
 By using this script, you are indicating your agreement to the [Minecraft EULA](https://aka.ms/MinecraftEULA).