diff --git a/CentOS/Arma/README.md b/CentOS/Arma/README.md index 8df2911..0aa9b12 100644 --- a/CentOS/Arma/README.md +++ b/CentOS/Arma/README.md @@ -1,6 +1,6 @@ # Arma Scripts Documentation -All script usages can be found by passing the "-h" flag unless explicity stated otherwise, for example: +All script usages can be found by passing the "-h" flag unless explicitly stated otherwise, for example: `Arma-Start-Server -h` ## Arma-Install-Mod diff --git a/CentOS/Minecraft/Minecraft-Start-Server.bash b/CentOS/Minecraft/Minecraft-Start-Server.bash index 1f2da4c..f3e920c 100755 --- a/CentOS/Minecraft/Minecraft-Start-Server.bash +++ b/CentOS/Minecraft/Minecraft-Start-Server.bash @@ -72,7 +72,7 @@ log() { fi local FORMAT - FORMAT="[$(echo_rgb "$(date +%Y-%m-%dT%H:%M:%S%z)" 180 140 255)]" + FORMAT="[$(echo_rgb "$(date +%Y-%m-%dT%H:%M:%S)" 180 140 255)]" # Convert the level to uppercase local level diff --git a/CentOS/Minecraft/README.md b/CentOS/Minecraft/README.md index 37ba982..add5871 100644 --- a/CentOS/Minecraft/README.md +++ b/CentOS/Minecraft/README.md @@ -1 +1,81 @@ -Minecraft Server Uses Spigot \ No newline at end of file +# Minecraft Scripts Documentation + +All script usages can be found by passing the "-h" flag unless explicitly stated otherwise, for example: +`Minecraft-Start-Server -h` + + +## Ports + +| Type | Range | +| --- | --- | +| Game Ports | 12000-12099 | +| Query Ports | 12100-12199 | +| RCON Ports | 12200-12299 | + + +## Minecraft-Start-Server +Used to install or start a minecraft server. All minecraft servers are installed to ~/Minecraft/ (this directory +is created automatically) + +All Minecraft servers backup their `server.propeerties` file when launched with this script to their +server directory/backups. e.g. `~/Minecraft/Server-1/backups/` + +- Usage: + - To run an existing server and overwrite RCON password + - `Minecraft-Start-Server -s ` + - Example: + - `Minecraft-Start-Server -s 0` + - This would start "Minecraft-Server-0" and overwrite Minecraft's RCON password with the password + provided by the script + - To run an existing server, but don't overwrite the RCON password + - `Minecraft-Start-Server -s -r` + - Example: + - `Minecraft-Start-Server -s 0` + - This would start "Minecraft-Server-0", but not overwrite the RCON password in Minecraft's config + - To install a new server + - `Minecraft-Start-Server -s -j ` + - Example: + - `Minecraft-Start-Server -s 0 -j ~/minecraft_server1.17.1.jar` + - This would copy the provided server jar to Server-0 and install the server + - Flags + - `-s` | `--server` + - The server id that is provided to start/install the server + - Corresponds with the server in ~/Minecraft where the ID is the number in the directory name + - `-r` | `--rcon-ignore` + - This flag will ensure that Minecraft's rcon password is not overwritten by the script + - `-j` | `--jar` + - Path to a minecraft server jar and the server will install that jar to the given ID + +##Minecraft-Connect-Server +Used to connect to a running Minecraft server's console to see log output or kill the server with ^C (control + c) + +To disconnect from an Minecraft server without killing it type ^B D, that being hold `control` and `b` and then let go of +*both* and hit `d`. + + +- Usage + - `Minecraft-Connect-Server ` + - Example: + - `Minecraft-Connect-Server 0` + - This would connect to the server prefixed with server number "0" + - Positional Arguments + - `` + - The server number corresponding to the server in ~/Minecraft/ where the server number is the last character in + the server name + - E.g. The server is named: "Server-0" then the server number would be "0" + +##Minecraft-Stop-Server +Used to stop a running Minecraft server + +This sends ^C (control c) to the Minecraft server + +- Usage + - `Minecraft-Stop-Server ` + - Example: + - `Minecraft-Stop-Server 0` + - This would stopthe server prefixed with server number "0" + - Positional Arguments + - `` + - The server number corresponding to the server in ~/Minecraft/ where the server number is the last character in + the server name + - E.g. The server is named: "Server-0" then the server number would be "0" \ No newline at end of file