Updating for V1.4

Updated template-vars settings and comments.
Fixed/added to minecraftctl.sh .
Updated README, including V1.4 changelog.
More details within README

Author: HoodedDeath

README.md

@@ -3,7 +3,7 @@
 This project defines a template systemd service unit file for hosting several minecraft servers via docker.
 This repo was forked from the version by [nathanielc](https://github.com/nathanielc/minecraft-multi-server)
 
-# Install
+## Install
 
 This system runs the minecraft server in a docker container, so you must first install docker.
 
@@ -21,11 +21,11 @@ NOTE: `grep` and `sed` are also required in order to watch the minecraft logs fo
 
 NOTE: You may need to add your user to the minecraft group to modify files within `/srv/minecraft/` without the need to use super user.
 
-# AUR Package
+### AUR Package
 
 AUR package available [here](https://aur.archlinux.org/packages/minecraft-server-manager/)
 
-# Usage
+## Usage
 
 Run `minecraftctl` to view usage message.
 
@@ -36,7 +36,7 @@ Running `minecraftctl start <NAME>` will start the server without the systemd se
 Each is given a name and can be configured in an `/etc/minecraft/<NAME>` file.
 A template configuration file is supplied as `/etc/minecraft/default` with most available options
 
-## EULA
+### EULA
 
 Minecraft requires that you accept the EULA in order to run a server.
 Either add `EULA=true` to all your `/etc/minecraft/<NAME>` files, or edit the `minecraftctl.sh` script to set `EULA=true` for all worlds.
@@ -99,7 +99,22 @@ sudo systemctl enable minecraftd-backup@<NAME>.timer
 sudo systemctl start minecraftd-backup@<NAME>.timer
 ```
 
+If you would like a one time backup instead, your can run the backup service or use the control script.
+
+For example:
+
+```
+sudo systemctl start minecraftd-backup@<NAME>.service
+```
+
+or
+
+```
+minecraftctl backup <NAME>
+```
+
 This will enable weekly backups of a server.
+
 Backups are stored in `$DATA_DIR/$BACKUP_DIR` which is `/srv/minecraft/<NAME>/backups` by default.
 If you want to copy them off-site you will need to manage that yourself.
 
@@ -119,3 +134,22 @@ If you run into an issue (especially any that you believe to be a bug), please f
 This project is based on nathianielc's minecraft-multi-server [here](https://github.com/nathanielc/minecraft-multi-server) and as such, is leveraging the work of the https://hub.docker.com/r/itzg/minecraft-server/ docker container for minecraft.
 Many thanks to both projects for making this one possible.
 
+## Changelog
+
+- 1.1
+  - Initial rewrite of code to fit personal style
+- 1.2
+  - Fixed an error in `Makefile` which caused failed builds
+- 1.3
+  - Fixed an error in `Makefile` which caused `minecraftctl` script to be non-executable
+- 1.3.1
+  - Fixed memory allocation issue which was causing servers to always be limited to 1G memory
+    - Setting memory within `JVM_OPTS` using the `-Xmx` and `-Xms` flags fails to set memory, using docker flags `MAX_MEMORY` and `INIT_MEMORY` works properly
+    - Within the start-minecraftFinalSetup file from https://github.com/itgz/docker-minecraft-server/ (line 155 as of March 13, 2021), the setup overrides the `-Xmx` and `-Xms` JVM flags using the `MAX_MEMORY` and `INIT_MEMORY` variables
+- 1.4
+  - Updated template-vars file with some additional settings and better comments on settings
+    - Added WORLD and SPAWN_PROTECTION settings
+  - Fixed an issue with copying server-icon.png that would cause an existing world to fail to restart if a server icon exists and should be copied
+    - When starting, the script would only check if the desired icon file exists, which would cause the script to attempt to overwrite the icon within the server directory, leading to permission denied and the script exiting due to failure
+  - Added SPAWN_PROTECTION option to docker call for starting server
+  - Reordered environment variables checks to look a bit nicer

src/minecraftctl.sh

@@ -56,7 +56,7 @@ function start {
     stop_container
 
     # Copy requested server icon if it exists
-    if [[ -f "${ICON}" ]]; then
+    if [[ -f "${ICON}" ]] && [[ ! -f "${DATA_DIR}/${name}/server-icon.png" ]]; then
         mkdir "${DATA_DIR}/${name}"
         cp "${ICON}" "${DATA_DIR}/${name}/server-icon.png"
     fi
@@ -66,7 +66,7 @@ function start {
         vol_mount=""
         echo "Ephemeral server, a restart will lose all world data"
     fi
-#        -e "JVM_OPTS=-Xmx${MAXHEAP}M -Xms${MINHEAP}M -D${name}" \
+
     $DOCKER run -d -i \
         --name "$name" \
         $vol_mount \
@@ -109,6 +109,7 @@ function start {
         -e "GID=$MINECRAFT_GID" \
         -e "ENABLE_AUTOPAUSE=$AUTOPAUSE" \
         -e "TIMEOUT=$TIMEOUT" \
+        -e "SPAWN_PROTECTION=$SPAWN_PROTECTION" \
         itzg/minecraft-server
 
     echo "Started minecraft container $name"
@@ -196,120 +197,151 @@ if [[ -z "$name" ]]; then
 elif [[ "x$name" == "xdefault" ]]; then
     unuseable_name
 fi
+
 # Attempt to source the related configuration file
 if [[ -f "/etc/minecraft/$name" ]]; then
     source "/etc/minecraft/$name"
 fi
+
+# Check Environment variables
+
+# Get system default docker path if none is provided in configuration file
+if [[ -z $DOCKER ]]; then
+    DOCKER=$(which docker)
+fi
+# Default listen port
+# This is the published host port,
+# internally, the container always listens on 25565
+if [[ -z $PORT ]]; then
+    PORT="25565"
+fi
+# Default listen port for Rcon
+# This is the published host port,
+# internally, the container always listens on 25575
+if [[ -z $RCON_PORT ]]; then
+    RCON_PORT="25575"
+fi
+# Default Rcon password
+if [[ -z $RCON_PASSWORD ]]; then
+    RCON_PASSWORD="minecraft"
+fi
+# Set Rcon command template
+RCON_CMD="mcrcon -P ${RCON_PORT} -p ${RCON_PASSWORD}"
+# Default min java heap size in MB
+if [[ -z $MINHEAP ]]; then
+    MINHEAP="512"
+fi
+# Default max java heap size in MB
+if [[ -z $MAXHEAP ]]; then
+    MAXHEAP="2048"
+fi
+# EULA - Defaults to false, must be set to true to start server
+if [[ -z $EULA ]]; then
+    EULA=false
+fi
 # Server type
 if [[ -z $TYPE ]]; then
     TYPE="vanilla"
 fi
-# Docker autopause
-if [[ -z $AUTOPAUSE ]]; then
-    AUTOPAUSE=true
-fi
-# Level type
-if [[ -z $LEVEL_TYPE ]]; then
-    LEVEL_TYPE="default"
+# Game version
+if [[ -z $VERSION ]]; then
+    VERSION="LATEST"
 fi
-# PVP
-if [[ -z $PVP ]]; then
-    PVP=true
+# Game difficulty
+if [[ -z $DIFFICULTY ]]; then
+    DIFFICULTY="normal"
 fi
-# Message of the day
-if [[ -z $MOTD ]]; then
-    MOTD="A Minecraft server"
+# Server icon
+if [[ -z $ICON ]]; then
+    ICON="/srv/minecraft/default/server-icon.png"
 fi
-# View distance
-if [[ -z $VIEW_DISTANCE ]]; then
-    VIEW_DISTANCE=10
+# Max players
+if [[ -z $MAX_PLAYERS ]]; then
+    MAX_PLAYERS="10"
 fi
-# Spawn NPCs
-if [[ -z $SPAWN_NPCS ]]; then
-    SPAWN_NPCS=true
+# Max world size
+if [[ -z $MAX_WORLD_SIZE ]]; then
+    MAX_WORLD_SIZE="29999984"
 fi
-# Spawn monsters
-if [[ -z $SPAWN_MONSTERS ]]; then
-    SPAWN_MONSTERS=true
+# Allow nether
+if [[ -z $ALLOW_NETHER ]]; then
+    ALLOW_NETHER=true
 fi
-# Max tick time
-if [[ -z $MAX_TICK_TIME ]]; then
-    MAX_TICK_TIME=60000
+# Announce player achievements
+if [[ -z $ANNOUNCE_PLAYER_ACHIEVEMENTS ]]; then
+    ANNOUNCE_PLAYER_ACHIEVEMENTS=true
 fi
-# Max build height
-if [[ -z $MAX_BUILD_HEIGHT ]]; then
-    MAX_BUILD_HEIGHT=256
+# Enable command blocks
+if [[ -z $ENABLE_COMMAND_BLOCK ]]; then
+    ENABLE_COMMAND_BLOCK=false
 fi
-# Hardcore
-if [[ -z $HARDCORE ]]; then
-    HARDCORE=false
+# Force gamemode
+if [[ -z $FORCE_GAMEMODE ]]; then
+    FORCE_GAMEMODE=false
 fi
 # Generate structures
 if [[ -z $GENERATE_STRUCTURES ]]; then
     GENERATE_STRUCTURES=true
 fi
-# Force gamemode
-if [[ -z $FORCE_GAMEMODE ]]; then
-    FORCE_GAMEMODE=false
+# Hardcore
+if [[ -z $HARDCORE ]]; then
+    HARDCORE=false
 fi
-# Enable command blocks
-if [[ -z $ENABLE_COMMAND_BLOCK ]]; then
-    ENABLE_COMMAND_BLOCK=false
+# Max build height
+if [[ -z $MAX_BUILD_HEIGHT ]]; then
+    MAX_BUILD_HEIGHT=256
 fi
-# Announce player achievements
-if [[ -z $ANNOUNCE_PLAYER_ACHIEVEMENTS ]]; then
-    ANNOUNCE_PLAYER_ACHIEVEMENTS=true
+# Max tick time
+if [[ -z $MAX_TICK_TIME ]]; then
+    MAX_TICK_TIME=60000
 fi
-# Allow nether
-if [[ -z $ALLOW_NETHER ]]; then
-    ALLOW_NETHER=true
+# Spawn monsters
+if [[ -z $SPAWN_MONSTERS ]]; then
+    SPAWN_MONSTERS=true
 fi
-# Max world size
-if [[ -z $MAX_WORLD_SIZE ]]; then
-    MAX_WORLD_SIZE="29999984"
+# Spawn NPCs
+if [[ -z $SPAWN_NPCS ]]; then
+    SPAWN_NPCS=true
 fi
-# Max players
-if [[ -z $MAX_PLAYERS ]]; then
-    MAX_PLAYERS="10"
+# View distance
+if [[ -z $VIEW_DISTANCE ]]; then
+    VIEW_DISTANCE=10
 fi
-# Server icon
-if [[ -z $ICON ]]; then
-    ICON="/srv/minecraft/default/server-icon.png"
+# Gamemode ?
+if [[ -z $MODE ]]; then
+    MODE="survival"
 fi
-# Game difficulty
-if [[ -z $DIFFICULTY ]]; then
-    DIFFICULTY="normal"
+# Message of the day
+if [[ -z $MOTD ]]; then
+    MOTD="A Minecraft server"
 fi
-# Game version
-if [[ -z $VERSION ]]; then
-    VERSION="LATEST"
+# PVP
+if [[ -z $PVP ]]; then
+    PVP=true
 fi
-# Default listen port
-# This is the published host port,
-# internally the container always listens on 25565
-if [[ -z $PORT ]]; then
-    PORT="25565"
+# Level type
+if [[ -z $LEVEL_TYPE ]]; then
+    LEVEL_TYPE="default"
 fi
-# Default listen port for rcon
-# This is the published host port,
-# internally the container always listens on 25575
-if [[ -z $RCON_PORT ]]; then
-    RCON_PORT="25575"
+# Name of world dir
+if [[ -z $LEVEL ]]; then
+    LEVEL="world"
 fi
-if [[ -z $RCON_PASSWORD ]]; then
-    RCON_PASSWORD="minecraft"
+# World folder name ?
+if [[ -z $WORLD ]]; then
+    WORLD="world"
 fi
-RCON_CMD="mcrcon -P ${RCON_PORT} -p ${RCON_PASSWORD}"
-# Default max java heap size in MB
-if [[ -z $MAXHEAP ]]; then
-    MAXHEAP="2048"
+# IDs of minecraft user and group
+MINECRAFT_UID=$(id -u minecraft)
+MINECRAFT_GID=$(id -g minecraft)
+# Docker autopause
+if [[ -z $AUTOPAUSE ]]; then
+    AUTOPAUSE=true
 fi
-# Default min java heap size in MB
-if [[ -z $MINHEAP ]]; then
-    MINHEAP="512"
+# Game command timeout
+if [[ -z $TIMEOUT ]]; then
+    TIMEOUT="0"
 fi
-# Path to docker executable
-DOCKER=$(which docker)
 # Wether to mount a persistent volume for the server
 # If true a volume will not be mounted and a restart will lose all world data
 if [[ -z $EPHEMERAL ]]; then
@@ -323,26 +355,15 @@ fi
 if [[ -z $BACKUP_DIR ]]; then
     BACKUP_DIR="./backups"
 fi
-# IDs of minecraft user and group
-MINECRAFT_UID=$(id -u minecraft)
-MINECRAFT_GID=$(id -g minecraft)
-# Name of world dir
-if [[ -z $LEVEL ]]; then
-    LEVEL="world"
-fi
-# Game command timeout
-if [[ -z $TIMEOUT ]]; then
-    TIMEOUT="0"
+# Default spawn protection region
+if [[ -z $SPAWN_PROTECTION ]]; then
+    SPAWN_PROTECTION=64
 fi
-# EULA
-if [[ -z $EULA ]]; then
-    EULA=false
-fi
-
+# Set debug flag to print trace for select commands
 if [[ -n "$DEBUG" ]]; then
     set -x
 fi
-
+# Handle command issued to script
 case "$1" in
 	status)     status;;
 	start)      start;;