Merge pull request #16 from simylein/dev

functional programming

README.md

@@ -1,25 +1,35 @@
-MinecraftServer
-===============
+# MinecraftServer
+
 Scripts for a Minecraft Server on Linux Debian using screen.
 
-This tutorial contains important steps if you would like to host a minecraft server from the command line. 
+This tutorial contains important steps if you would like to host a minecraft server from the command line.
+
 ## software
+
 In order for the Server to run we will need to install some packages: (please note: some of them could be installed already) <br>
 This command installs all packages you will need to run your server.
+
 ```
 sudo apt install openjdk-17-jre-headless iputils-ping net-tools mailutils coreutils dnsutils sendmail screen grep nano wget less cron man sed pv
 ```
+
 ## setup
+
 Then, you can download and execute the setup script. <br>
-This command downloads, makes exectable and executes the setup script. 
+This command downloads, makes exectable and executes the setup script.
+
 ```
 wget -O setup.sh https://raw.githubusercontent.com/Simylein/MinecraftServer/main/setup.sh && chmod +x setup.sh && ./setup.sh
 ```
-The Script will ask you some Questions. Please answer them in order for the Server to work. If you do not know what you like right now you can edit all answers later in the server.* files and going with the prefilled answer works for most people. Now you got yourself a server directory. It is called ${servername} (it's the name you have chosen for your server) and inside ${servername} a directory is called backups. Like you can imagine ${servername} holds your live server and backups stores your backups. 
+
+The Script will ask you some Questions. Please answer them in order for the Server to work. If you do not know what you like right now you can edit all answers later in the server.\* files and going with the prefilled answer works for most people. Now you got yourself a server directory. It is called ${servername} (it's the name you have chosen for your server) and inside ${servername} a directory is called backups. Like you can imagine ${servername} holds your live server and backups stores your backups.
+
 ## serverstart
+
 Start your Server for the first time: `./start.sh`
 
 ## screen
+
 Screen is an amzing comand line tool that creates a "virtual" terminal inside your terminal.
 
 You can view all your active screens by typing: `screen -list`
@@ -30,7 +40,9 @@ If you would like to scroll inside a screen session press Ctrl+A and Esc (enter
 For returning back to normal press Esc.
 
 To exit the screen terminal press Ctrl+A and Ctrl+D
+
 ## server commands
+
 Your minecraft server can understand certain commands. <br>
 I will explain some of them to you.
 
@@ -44,19 +56,24 @@ I will explain some of them to you.
 `tp ${playername} ${playername}` teleporting a player to another player.
 
 Important: If you do these commands ingame you will need to put a `/` before each command. <br>
-In the screen terminal you don't need a `/` before your command. 
+In the screen terminal you don't need a `/` before your command.
+
 ## server.settings
+
 This is your file that holds the variables you have chosen with the setup script. <br>
 If you know what your are doing feel free to edit it to suit your needs.
+
 ```
 nano server.settings
 ```
+
 It looks like this: (there will be alot of variables after setup.sh)
+
 ```
 #!/bin/bash
 # minecraft server settings
 
-# This file stores all the variables for the server. 
+# This file stores all the variables for the server.
 # If you know what you are doing, feel free to tinker with them ;^)
 
 # command line colours
@@ -71,44 +88,53 @@ white="$(tput setaf 7)"
 nocolor="$(tput sgr0)"
 ...
 ```
+
 ## server.properties
-If you would like to costumize your server further have a look at your server.properties file. 
+
+If you would like to costumize your server further have a look at your server.properties file.
+
 ```
 nano server.properties
 ```
+
 Important settings are:
 
-`max-players=`          (limuts the maximumg amount of players on the server at the same time) <br>
-                        [Warning large numbers may impact performance] <br>
-`difficulty=`           (defines ingame difficulty) [peaceful, easy, normal, hard] <br>
-`view-distance=`        (defines number of ingame chnuks to be rendered) <br>
-                        [Warning large numbers may impact performance] <br>
-`white-list=`           (turns on the whitelist) [I would strongely recomment to set this to true] <br>
-`motd=`                 (this will be displayed in the menu below your server - chose what you like) <br>
-`server-port=`          (default by 25565. Only importent if you are dealing with multiple server) <br>
-                        [if you run multiple servers each server wants to have its own port] <br>
-`gamemode=`             (default survival. Defines your game mode. For creative server replace with creative) <br>
-                        [survival/creative/adventure/spectator] <br>
-`spawn-protection=`     (the number of block at the worldspawn only operators can touch) <br>
-`pvp=`                  (ability for player to do damage to oneanother) [true/false] <br>
+`max-players=` (limuts the maximumg amount of players on the server at the same time) <br>
+[Warning large numbers may impact performance] <br>
+`difficulty=` (defines ingame difficulty) [peaceful, easy, normal, hard] <br>
+`view-distance=` (defines number of ingame chnuks to be rendered) <br>
+[Warning large numbers may impact performance] <br>
+`white-list=` (turns on the whitelist) [I would strongely recomment to set this to true] <br>
+`motd=` (this will be displayed in the menu below your server - chose what you like) <br>
+`server-port=` (default by 25565. Only importent if you are dealing with multiple server) <br>
+[if you run multiple servers each server wants to have its own port] <br>
+`gamemode=` (default survival. Defines your game mode. For creative server replace with creative) <br>
+[survival/creative/adventure/spectator] <br>
+`spawn-protection=` (the number of block at the worldspawn only operators can touch) <br>
+`pvp=` (ability for player to do damage to oneanother) [true/false] <br>
 `enable-command-block=` (enables command blocks to tinker with) [true/false] <br>
 
 ## scripts
+
 There are lots of script in your ${serverdirectory}. Normally, the executable ones are green and can be executed with:
 
 ```
 ./${scriptname}.sh ${arguments}
 ```
 
-Example: `./start.sh -v`
+Example: `./start.sh -verbose`
+Example: `./start.sh -now`
 
-Arguments: `-i --immediately -q --quiet -v --verbose`
+Arguments: `-f --force, -n --now -q --quiet -v --verbose`
 
 ## crontab
+
 If you would like to automate some of those task on your server you can create a crontab.
+
 ```
 crontab -e
 ```
+
 A new file will open (If you got one already the existing one will open) <br>
 Side note: the setup script will already put these lines in your crontab if you chose to do so. <br>
 In this file, you can automate things as follows: <br>
@@ -120,22 +146,29 @@ Forth star: Month [0 - 12] <br>
 Fifth star: Day of Week [0 - 6]
 
 Generic Example: (In order to work, please replace the variables with your own ones)
+
 ```
 # minecraft ${servername} your description of command here
 * * * * * cd ${serverdirectory} && ${serverdirectory}/NameOfScript.sh
 ```
+
 Close and save your crontab. (Press Ctrl X and Y)
+
 ## logfiles
+
 Your server will write two growing logfiles (located in your ${serverdirectory}) <br>
 screen.log and backup.log <br>
-screen.log contains everything that get's written inside your screen terminal while backup.log logs all action of the backup script. 
+screen.log contains everything that get's written inside your screen terminal while backup.log logs all action of the backup script.
 
 to view them:
+
 ```
 less screen.log
 less backup.log
 ```
+
 ## ending
+
 I hope you learned something and that those scripts I provide may help you and your minecraft server experience. <br>
 Have fun and enjoy the Game ;^)