feat(linuxgsm): various ui improvements (#2554)

* added column to debug
* added colour to header
* colourised LinuxGSM header text
* updated donate message
* ascii logo
* warn colour and altered header

Author: dgibbs64

lgsm/config-default/config-lgsm/hwserver/_default.cfg

@@ -145,7 +145,7 @@ glibc="2.15"
 ## Server Specific Directories
 systemdir="${serverfiles}"
 executabledir="${serverfiles}"
-executable=$([ "$(uname -m)" == "x86_64" ] && echo "./Hurtworld.x86_64" || echo "./Hurtworld.x86")
+executable=$([ "$(uname -m)" == "x86_64" ] && echo -e "./Hurtworld.x86_64" || echo -e "./Hurtworld.x86")
 
 ## Backup Directory
 backupdir="${lgsmdir}/backup"

lgsm/config-default/config-lgsm/qlserver/_default.cfg

@@ -128,7 +128,7 @@ glibc="2.15"
 ## Server Specific Directories
 systemdir="${serverfiles}"
 executabledir="${serverfiles}"
-executable=$([ "$(uname -m)" == "x86_64" ] && echo "./run_server_x64.sh" || echo "./run_server_x86.sh")
+executable=$([ "$(uname -m)" == "x86_64" ] && echo -e "./run_server_x64.sh" || echo -e "./run_server_x86.sh")
 servercfg="${servicename}.cfg"
 servercfgdefault="server.cfg"
 servercfgdir="${serverfiles}/baseq3"

lgsm/config-default/config-lgsm/sdtdserver/_default.cfg

@@ -129,7 +129,7 @@ glibc="2.15"
 ## Server Specific Directories
 systemdir="${serverfiles}"
 executabledir="${serverfiles}"
-executable=$([ "$(uname -m)" == "x86_64" ] && echo "./7DaysToDieServer.x86_64" || echo "./7DaysToDieServer.x86")
+executable=$([ "$(uname -m)" == "x86_64" ] && echo -e "./7DaysToDieServer.x86_64" || echo -e "./7DaysToDieServer.x86")
 servercfgdefault="serverconfig.xml"
 servercfgdirdefault="${serverfiles}"
 servercfgfullpathdefault="${servercfgdirdefault}/${servercfgdefault}"

lgsm/functions/alert.sh

@@ -118,7 +118,7 @@ elif [ "${discordalert}" != "on" ]&&[ "${function_selfname}" == "command_test_al
 	fn_script_log_warn "Discord alerts not enabled"
 elif [ -z "${discordtoken}" ]&&[ "${function_selfname}" == "command_test_alert.sh" ]; then
 	fn_print_error_nl "Discord token not set"
-	echo "	* https://docs.linuxgsm.com/alerts/discord"
+	echo -e "	* https://docs.linuxgsm.com/alerts/discord"
 	fn_script_error "Discord token not set"
 fi
 
@@ -139,7 +139,7 @@ elif [ "${iftttalert}" != "on" ]&&[ "${function_selfname}" == "command_test_aler
 	fn_script_log_warn "IFTTT alerts not enabled"
 elif [ -z "${ifttttoken}" ]&&[ "${function_selfname}" == "command_test_alert.sh" ]; then
 	fn_print_error_nl "IFTTT token not set"
-	echo "	* https://docs.linuxgsm.com/alerts/ifttt"
+	echo -e "	* https://docs.linuxgsm.com/alerts/ifttt"
 	fn_script_error "IFTTT token not set"
 fi
 
@@ -150,7 +150,7 @@ elif [ "${mailgunalert}" != "on" ]&&[ "${function_selfname}" == "command_test_al
 	fn_script_log_warn "Mailgun alerts not enabled"
 elif [ -z "${mailguntoken}" ]&&[ "${function_selfname}" == "command_test_alert.sh" ]; then
 	fn_print_error_nl "Mailgun token not set"
-	echo "	* https://docs.linuxgsm.com/alerts/mailgun"
+	echo -e "	* https://docs.linuxgsm.com/alerts/mailgun"
 	fn_script_error "Mailgun token not set"
 fi
 
@@ -161,7 +161,7 @@ elif [ "${pushbulletalert}" != "on" ]&&[ "${function_selfname}" == "command_test
 	fn_script_log_warn "Pushbullet alerts not enabled"
 elif [ -z "${pushbullettoken}" ]&&[ "${function_selfname}" == "command_test_alert.sh" ]; then
 	fn_print_error_nl "Pushbullet token not set"
-	echo "	* https://docs.linuxgsm.com/alerts/pushbullet"
+	echo -e "	* https://docs.linuxgsm.com/alerts/pushbullet"
 	fn_script_error "Pushbullet token not set"
 fi
 
@@ -172,7 +172,7 @@ elif [ "${pushoveralert}" != "on" ]&&[ "${function_selfname}" == "command_test_a
 	fn_script_log_warn "Pushover alerts not enabled"
 elif [ -z "${pushovertoken}" ]&&[ "${function_selfname}" == "command_test_alert.sh" ]; then
 	fn_print_error_nl "Pushover token not set"
-	echo "	* https://docs.linuxgsm.com/alerts/pushover"
+	echo -e "	* https://docs.linuxgsm.com/alerts/pushover"
 	fn_script_error "Pushover token not set"
 fi
 
@@ -183,11 +183,11 @@ elif [ "${telegramalert}" != "on" ]&&[ "${function_selfname}" == "command_test_a
 	fn_script_log_warn "Telegram Messages not enabled"
 elif [ -z "${telegramtoken}" ]&&[ "${function_selfname}" == "command_test_alert.sh" ]; then
 	fn_print_error_nl "Telegram token not set."
-	echo "	* https://docs.linuxgsm.com/alerts/telegram"
+	echo -e "	* https://docs.linuxgsm.com/alerts/telegram"
 	fn_script_error "Telegram token not set."
 elif [ -z "${telegramchatid}" ]&&[ "${function_selfname}" == "command_test_alert.sh" ]; then
 	fn_print_error_nl "Telegram chat id not set."
-	echo "	* https://docs.linuxgsm.com/alerts/telegram"
+	echo -e "	* https://docs.linuxgsm.com/alerts/telegram"
 	fn_script_error "Telegram chat id not set."
 fi
 
@@ -198,6 +198,6 @@ elif [ "${slackalert}" != "on" ]&&[ "${function_selfname}" == "command_test_aler
 	fn_script_log_warn "Slack alerts not enabled"
 elif [ -z "${slacktoken}" ]&&[ "${function_selfname}" == "command_test_alert.sh" ]; then
 	fn_print_error_nl "Slack token not set"
-	echo "	* https://docs.linuxgsm.com/alerts/slack"
+	echo -e "	* https://docs.linuxgsm.com/alerts/slack"
 	fn_script_error "Slack token not set"
 fi

lgsm/functions/check_config.sh

@@ -11,7 +11,7 @@ if [ ! -e "${servercfgfullpath}" ]; then
 	if [ "${shortname}" != "hw" ]&&[ "${shortname}" != "ut3" ]&&[ "${shortname}" != "kf2" ]; then
 		fn_print_dots ""
 		fn_print_warn_nl "Configuration file missing!"
-		echo "${servercfgfullpath}"
+		echo -e "${servercfgfullpath}"
 		fn_script_log_warn "Configuration file missing!"
 		fn_script_log_warn "${servercfgfullpath}"
 		install_config.sh
@@ -22,14 +22,14 @@ if [ "${shortname}" == "rust" ]; then
 	if  [ -z "${rconpassword}" ]; then
 		fn_print_dots ""
 		fn_print_fail_nl "RCON password is not set!"
-		echo "  * Not setting an RCON password causes issues with ${gamename}"
+		echo -e "  * Not setting an RCON password causes issues with ${gamename}"
 		fn_script_log_fatal "RCON password is not set"
 		fn_script_log_fatal "Not setting an RCON password causes issues with ${gamename}"
 		core_exit.sh
 	elif [ "${rconpassword}" == "CHANGE_ME" ]; then
 		fn_print_dots ""
 		fn_print_warn_nl "Default RCON Password detected!"
-		echo " * Having ${rconpassword} as a password is not very safe."
+		echo -e " * Having ${rconpassword} as a password is not very safe."
 		fn_script_log_warn "Default RCON Password detected"
 	fi
 fi

lgsm/functions/check_deps.sh

@@ -36,9 +36,9 @@ fn_install_mono_repo(){
 					eval ${cmd}
 				else
 					fn_print_warn_nl "Installing Mono repository"
-					echo "Mono auto install not available for ${distroname}"
-					echo "	Follow instructions on mono site to install the latest version of Mono."
-					echo "	https://www.mono-project.com/download/stable/#download-lin"
+					echo -e "Mono auto install not available for ${distroname}"
+					echo -e "	Follow instructions on mono site to install the latest version of Mono."
+					echo -e "	https://www.mono-project.com/download/stable/#download-lin"
 					monoautoinstall="1"
 				fi
 			elif [ "${distroid}" == "debian" ]; then
@@ -52,9 +52,9 @@ fn_install_mono_repo(){
 					cmd="sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF;sudo apt install apt-transport-https;echo 'deb https://download.mono-project.com/repo/debian stable-jessie main' | sudo tee /etc/apt/sources.list.d/mono-official-stable.list;sudo apt update"
 					eval ${cmd}
 				else
-					echo "Mono auto install not available for ${distroname}"
-					echo "	Follow instructions on mono site to install the latest version of Mono."
-					echo "	https://www.mono-project.com/download/stable/#download-lin"
+					echo -e "Mono auto install not available for ${distroname}"
+					echo -e "	Follow instructions on mono site to install the latest version of Mono."
+					echo -e "	https://www.mono-project.com/download/stable/#download-lin"
 					monoautoinstall="1"
 				fi
 			elif [ "${distroid}" == "centos" ]; then
@@ -68,18 +68,18 @@ fn_install_mono_repo(){
 					cmd="rpm --import 'https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF';su -c 'curl https://download.mono-project.com/repo/centos6-stable.repo | tee /etc/yum.repos.d/mono-centos6-stable.repo'"
 					eval ${cmd}
 				else
-					echo "Mono auto install not available for ${distroname}"
-					echo "	Follow instructions on mono site to install the latest version of Mono."
-					echo "	https://www.mono-project.com/download/stable/#download-lin"
+					echo -e "Mono auto install not available for ${distroname}"
+					echo -e "	Follow instructions on mono site to install the latest version of Mono."
+					echo -e "	https://www.mono-project.com/download/stable/#download-lin"
 					monoautoinstall="1"
 				fi
 			elif [ "${distroid}" == "fedora" ]; then
 				cmd="rpm --import 'https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF'; su -c 'curl https://download.mono-project.com/repo/centos7-stable.repo | tee /etc/yum.repos.d/mono-centos7-stable.repo'; dnf update"
 				eval ${cmd}
 			else
-				echo "Mono auto install not available for ${distroname}"
-				echo "	Follow instructions on mono site to install the latest version of Mono."
-				echo "	https://www.mono-project.com/download/stable/#download-lin"
+				echo -e "Mono auto install not available for ${distroname}"
+				echo -e "	Follow instructions on mono site to install the latest version of Mono."
+				echo -e "	https://www.mono-project.com/download/stable/#download-lin"
 				monoautoinstall="1"
 			fi
 			if [ "${monoautoinstall}" != "1" ];then
@@ -95,11 +95,11 @@ fn_install_mono_repo(){
 			fi
 		else
 			fn_print_information_nl "Installing Mono repository"
-			echo ""
+			echo -e ""
 			fn_print_warning_nl "$(whoami) does not have sudo access. Manually install Mono repository."
 			fn_script_log_warn "$(whoami) does not have sudo access. Manually install Mono repository."
-			echo "	Follow instructions on mono site to install the latest version of Mono."
-			echo "	https://www.mono-project.com/download/stable/#download-lin"
+			echo -e "	Follow instructions on mono site to install the latest version of Mono."
+			echo -e "	https://www.mono-project.com/download/stable/#download-lin"
 		fi
 	fi
 }
@@ -134,8 +134,8 @@ fn_install_universe_repo(){
 		else
 			fn_print_warning_nl "$(whoami) does not have sudo access. Manually add Universe repository."
 			fn_script_log_warn "$(whoami) does not have sudo access. Manually add Universe repository."
-			echo "	Please run the following command as a user with sudo access, and re-run the installation"
-			echo "	sudo apt-add-repository universe"
+			echo -e "	Please run the following command as a user with sudo access, and re-run the installation"
+			echo -e "	sudo apt-add-repository universe"
 		fi
 	fi
 }
@@ -238,7 +238,7 @@ fn_found_missing_deps(){
 		fi
 		if [ -n "${jqstatus}" ]; then
 			fn_print_warning_nl "jq is not available in the ${distroname} repository"
-			echo "	* https://docs.linuxgsm.com/requirements/jq"
+			echo -e "	* https://docs.linuxgsm.com/requirements/jq"
 		fi
 		if [ "${autoinstall}" == "1" ]; then
 			sudo -n true > /dev/null 2>&1
@@ -268,18 +268,18 @@ fn_found_missing_deps(){
 			if [ $? != 0 ]; then
 				fn_print_failure_nl "Unable to install dependencies"
 				fn_script_log_fatal "Unable to install dependencies"
-				echo ""
+				echo -e ""
 				fn_print_warning_nl "Manually install dependencies."
 				fn_script_log_warn "Manually install dependencies."
 				if [ -n "$(command -v dpkg-query 2>/dev/null)" ]; then
-					echo "	sudo dpkg --add-architecture i386; sudo apt update; sudo apt install ${array_deps_missing[@]}"
+					echo -e "	sudo dpkg --add-architecture i386; sudo apt update; sudo apt install ${array_deps_missing[@]}"
 				elif [ -n "$(command -v dnf 2>/dev/null)" ]; then
-					echo "	sudo dnf install ${array_deps_missing[@]}"
+					echo -e "	sudo dnf install ${array_deps_missing[@]}"
 				elif [ -n "$(command -v yum 2>/dev/null)" ]; then
-					echo "	sudo yum install ${array_deps_missing[@]}"
+					echo -e "	sudo yum install ${array_deps_missing[@]}"
 				fi
 				if [ "${steamcmdfail}" ]; then
-					echo ""
+					echo -e ""
 					fn_print_failure_nl "Missing dependencies required to run SteamCMD."
 					fn_script_log_fatal "Missing dependencies required to run SteamCMD."
 					core_exit.sh
@@ -289,23 +289,23 @@ fn_found_missing_deps(){
 				fn_script_log_pass "Install dependencies completed"
 			fi
 		else
-			echo ""
+			echo -e ""
 			fn_print_warning_nl "$(whoami) does not have sudo access. Manually install dependencies."
 			fn_script_log_warn "$(whoami) does not have sudo access. Manually install dependencies."
 			if [ -n "$(command -v dpkg-query 2>/dev/null)" ]; then
-				echo "	sudo dpkg --add-architecture i386; sudo apt update; sudo apt install ${array_deps_missing[@]}"
+				echo -e "	sudo dpkg --add-architecture i386; sudo apt update; sudo apt install ${array_deps_missing[@]}"
 			elif [ -n "$(command -v dnf 2>/dev/null)" ]; then
-				echo "	sudo dnf install ${array_deps_missing[@]}"
+				echo -e "	sudo dnf install ${array_deps_missing[@]}"
 			elif [ -n "$(command -v yum 2>/dev/null)" ]; then
-				echo "	sudo yum install ${array_deps_missing[@]}"
+				echo -e "	sudo yum install ${array_deps_missing[@]}"
 			fi
 			if [ "${steamcmdfail}" ]; then
-				echo ""
+				echo -e ""
 				fn_print_failure_nl "Missing dependencies required to run SteamCMD."
 				fn_script_log_fatal "Missing dependencies required to run SteamCMD."
 				core_exit.sh
 			fi
-			echo ""
+			echo -e ""
 		fi
 		if [ "${function_selfname}" == "command_install.sh" ]; then
 			sleep 5
@@ -562,16 +562,16 @@ fn_deps_build_redhat(){
 
 if [ "${function_selfname}" == "command_install.sh" ]; then
 	if [ "$(whoami)" == "root" ]; then
-		echo ""
-		echo "Checking Dependencies as root"
-		echo "================================="
+		echo -e ""
+		echo -e "${lightyellow}Checking Dependencies as root${default}"
+		echo -e "================================="
 		fn_print_information_nl "Checking any missing dependencies for ${gamename} server only."
 		fn_print_information_nl "This will NOT install a ${gamename} server."
 		fn_sleep_time
 	else
-		echo ""
-		echo "Checking Dependencies"
-		echo "================================="
+		echo -e ""
+		echo -e "${lightyellow}Checking Dependencies${default}"
+		echo -e "================================="
 	fi
 fi
 

lgsm/functions/check_executable.sh

@@ -10,7 +10,7 @@ local function_selfname="$(basename "$(readlink -f "${BASH_SOURCE[0]}")")"
 # Check if executable exists
 if [ ! -f "${executabledir}/${execname}" ]; then
 	fn_print_fail_nl "executable was not found"
-	echo "* ${executabledir}/${execname}"
+	echo -e "* ${executabledir}/${execname}"
 	if [ -d "${lgsmlogdir}" ]; then
 		fn_script_log_fatal "Executable was not found: ${executabledir}/${execname}"
 	fi

lgsm/functions/check_permissions.sh

@@ -41,7 +41,7 @@ fn_check_ownership(){
 			fi
 
 		} | column -s $'\t' -t | tee -a "${lgsmlog}"
-		echo ""
+		echo -e ""
 		fn_print_information_nl "please see https://docs.linuxgsm.com/support/faq#fail-starting-game-server-permission-issues-found"
 		fn_script_log "For more information, please see https://docs.linuxgsm.com/support/faq#fail-starting-game-server-permission-issues-found"
 		if [ "${monitorflag}" == 1 ]; then
@@ -164,12 +164,12 @@ fn_sys_perm_errors_detect(){
 
 # Display a message on how to fix the issue manually.
 fn_sys_perm_fix_manually_msg(){
-	echo ""
+	echo -e ""
 	fn_print_information_nl "This error causes servers to fail starting properly"
 	fn_script_log_info "This error causes servers to fail starting properly."
-	echo "	* To fix this issue, run the following command as root:"
+	echo -e "	* To fix this issue, run the following command as root:"
 	fn_script_log_info "To fix this issue, run the following command as root:"
-	echo "	  chmod a+rx /sys /sys/class /sys/class/net"
+	echo -e "	  chmod a+rx /sys /sys/class /sys/class/net"
 	fn_script_log "chmod a+rx /sys /sys/class /sys/class/net"
 	fn_sleep_time
 	if [ "${monitorflag}" == 1 ]; then

lgsm/functions/check_steamcmd.sh

@@ -23,7 +23,7 @@ fn_check_steamcmd_user(){
 		else
 			fn_print_fail_nl "Steam login not set. Update steamuser in ${configdirserver}"
 		fi
-		echo "	* Change steamuser=\"username\" to a valid steam login."
+		echo -e "	* Change steamuser=\"username\" to a valid steam login."
 		if [ -d "${lgsmlogdir}" ]; then
 			if [ "${legacymode}" == "1" ]; then
 				fn_script_log_fatal "Steam login not set. Update steamuser in ${selfname}"

lgsm/functions/check_tmuxception.sh

@@ -12,8 +12,8 @@ fn_check_is_in_tmux(){
 		fn_print_fail_nl "tmuxception error: Sorry Cobb you cannot start a tmux session inside of a tmux session."
 		fn_script_log_fatal "Tmuxception error: Attempted to start a tmux session inside of a tmux session."
 		fn_print_information_nl "LinuxGSM creates a tmux session when starting the server."
-		echo "It is not possible to run a tmux session inside another tmux session"
-		echo "https://docs.linuxgsm.com/requirements/tmux#tmuxception"
+		echo -e "It is not possible to run a tmux session inside another tmux session"
+		echo -e "https://docs.linuxgsm.com/requirements/tmux#tmuxception"
 		core_exit.sh
 	fi
 }
@@ -23,8 +23,8 @@ fn_check_is_in_screen(){
 		fn_print_fail_nl "tmuxception error: Sorry Cobb you cannot start a tmux session inside of a screen session."
 		fn_script_log_fatal "Tmuxception error: Attempted to start a tmux session inside of a screen session."
 		fn_print_information_nl "LinuxGSM creates a tmux session when starting the server."
-		echo "It is not possible to run a tmux session inside screen session"
-		echo "https://docs.linuxgsm.com/requirements/tmux#tmuxception"
+		echo -e "It is not possible to run a tmux session inside screen session"
+		echo -e "https://docs.linuxgsm.com/requirements/tmux#tmuxception"
 		core_exit.sh
 	fi
 }