From b24cbd85d81baffd2243feb96187eb102ef2904a Mon Sep 17 00:00:00 2001 From: CerberusV1 Date: Wed, 16 Oct 2024 14:16:53 +0200 Subject: [PATCH] README adjustments --- README.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9ffe725..bc07ca3 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,27 @@ -# minecraft_deploy -Deploymentscript for an Minecraft Server lol +# Minecraft-Server Deployment and management script +This is an deployment script for minecraft servers. It gets developed to make it easier to setup a minecraft server. It consists of two scripts. The first script (`deploy.sh`) will never be on your computer. `server_manager.sh` gets pulled on your computer in order for you to manage the server. + +## Features +- Server management script: + - Configuring the EULA + - Configuring the RAM + - Starting and reconnecting to the server (using tmux) +- Deployment + - Setting the server name + - Available for every minecraft and mod loader version + + + +# Requirements: +This script should run on all distribution which use the apt packet manager. + +# How To Use +Copy the line below and paste it into your terminal and press `RETURN`. + +>[!NOTE] +>The script will check for dependencies for the server automatically once started. After checking and installing dependencies the script will prompt you to enter the name for your server. Until here `java` and `tmux`got installed and no other changes were made. As soon as you enter a server name and press RETURN, the folder structure gets created. If you exit the script after entering an name you need to remove it yourself. -# Expectations: -- Ubuntu as a base system -# Run the script ``` bash -c "$(curl -sS https://raw.githubusercontent.com/CerberusV1/minecraft_deploy/refs/heads/main/deploy.sh)" ```