feat(rwrserver): add Running With Rifles server (#5021)

* feat(newserver): add Running With Rifles server

* fix(rwrserver): show rwr_server in the port diagnostic command

* feat(rwrserver): start game modes from their own package with startpackage

* fix(rwrserver): add the 32-bit libgpg-error dependency

* docs(rwrserver): note the game and DLC ownership requirements in the config

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

@@ -0,0 +1,207 @@
+##################################
+######## Default Settings ########
+##################################
+# DO NOT EDIT, ANY CHANGES WILL BE OVERWRITTEN!
+# Copy settings from here and use them in either:
+# common.cfg - applies settings to every instance.
+# [instance].cfg - applies settings to a specific instance.
+
+#### Game Server Settings ####
+
+## SteamCMD Login | https://docs.linuxgsm.com/steamcmd#steamcmd-login
+# The Steam account must own Running With Rifles. The server is part of the game.
+# WW2 game modes also need the account to own the Pacific and/or Edelweiss DLC.
+steamuser="username"
+steampass='password'
+
+## Game Mode Script | https://docs.linuxgsm.com/game-servers/running-with-rifles
+# Server name, port, comment, mode and max players are set in the start script.
+# Edit them in: serverfiles/media/packages/vanilla/scripts/rwrserver.as (a copy of start_invasion.as, created on install).
+# For another game mode, set the package and its start script, e.g.
+# startpackage="media/packages/deathmatch" and startscript="start_deathmatch_server.as"
+startpackage="media/packages/vanilla"
+startscript="${selfname}.as"
+
+## Server Parameters | https://docs.linuxgsm.com/configuration/start-parameters#additional-parameters
+## Game Server Docs | https://runningwithrifles.fandom.com/wiki/How_to_host_a_different_game_mode_as_dedicated_server
+startparameters=""
+
+#### LinuxGSM Settings ####
+
+## LinuxGSM Stats
+# Send useful stats to LinuxGSM developers.
+# https://docs.linuxgsm.com/configuration/linuxgsm-stats
+# (on|off)
+stats="off"
+
+## Notification Alerts
+# (on|off)
+
+# Display IP | https://docs.linuxgsm.com/alerts#display-ip
+displayip=""
+
+# More info | https://docs.linuxgsm.com/alerts#more-info
+postalert="off"
+
+# Alert on Start/Stop/Restart
+statusalert="off"
+
+# Discord Alerts | https://docs.linuxgsm.com/alerts/discord
+discordalert="off"
+discordwebhook="webhook"
+
+# Email Alerts | https://docs.linuxgsm.com/alerts/email
+emailalert="off"
+email="email@example.com"
+emailfrom=""
+
+# Gotify Alerts | https://docs.linuxgsm.com/alerts/gotify
+gotifyalert="off"
+gotifytoken="token"
+gotifywebhook="webhook"
+
+# IFTTT Alerts | https://docs.linuxgsm.com/alerts/ifttt
+iftttalert="off"
+ifttttoken="accesstoken"
+iftttevent="linuxgsm_alert"
+
+# ntfy Alerts | https://docs.linuxgsm.com/alerts/ntfy
+ntfyalert="off"
+ntfytopic="LinuxGSM"
+ntfyserver="https://ntfy.sh"
+ntfytoken=""
+ntfyusername=""
+ntfypassword=""
+ntfypriority=""
+ntfytags=""
+
+# Pushbullet Alerts | https://docs.linuxgsm.com/alerts/pushbullet
+pushbulletalert="off"
+pushbullettoken="accesstoken"
+channeltag=""
+
+# Pushover Alerts | https://docs.linuxgsm.com/alerts/pushover
+pushoveralert="off"
+pushovertoken="accesstoken"
+pushoveruserkey="userkey"
+
+# Rocket.Chat Alerts | https://docs.linuxgsm.com/alerts/rocket.chat
+rocketchatalert="off"
+rocketchatwebhook="webhook"
+
+# Slack Alerts | https://docs.linuxgsm.com/alerts/slack
+slackalert="off"
+slackwebhook="webhook"
+
+# Telegram Alerts | https://docs.linuxgsm.com/alerts/telegram
+# You can add a custom cURL string eg proxy (useful in Russia) in "curlcustomstring".
+# For example "--socks5 ipaddr:port" for socks5 proxy see more in "curl --help all".
+telegramapi="api.telegram.org"
+telegramalert="off"
+telegramtoken="accesstoken"
+telegramchatid=""
+telegramthreadid=""
+telegramsilentnotification="false"
+curlcustomstring=""
+
+## Updating | https://docs.linuxgsm.com/commands/update
+updateonstart="off"
+
+## Backup | https://docs.linuxgsm.com/commands/backup
+maxbackups="4"
+maxbackupdays="30"
+stoponbackup="on"
+
+## Logging | https://docs.linuxgsm.com/features/logging
+consolelogging="on"
+logdays="7"
+
+## Monitor | https://docs.linuxgsm.com/commands/monitor
+# Query delay time
+querydelay="5"
+
+## ANSI Colors | https://docs.linuxgsm.com/features/ansi-colors
+ansi="on"
+
+#### Advanced Settings ####
+
+## Message Display Time | https://docs.linuxgsm.com/features/message-display-time
+sleeptime="0.5"
+
+## SteamCMD Settings | https://docs.linuxgsm.com/steamcmd
+# Server appid
+appid="270150"
+steamcmdforcewindows="no"
+# SteamCMD Branch | https://docs.linuxgsm.com/steamcmd/branch
+branch=""
+betapassword=""
+# Master Server | https://docs.linuxgsm.com/steamcmd/steam-master-server
+steammaster="false"
+
+## Stop Mode | https://docs.linuxgsm.com/features/stop-mode
+# 1: tmux kill
+# 2: CTRL+c
+# 3: quit
+# 4: quit 120s
+# 5: stop
+# 6: q
+# 7: exit
+# 8: 7 Days to Die
+# 9: GoldSrc
+# 10: Avorion
+# 11: end
+# 12: shutdown
+# 13: soulmask
+# 14: Running With Rifles
+stopmode="14"
+
+## Query mode
+# 1: session only
+# 2: gamedig (gsquery fallback)
+# 3: gamedig
+# 4: gsquery
+# 5: tcp
+querymode="1"
+querytype=""
+
+## Console type
+consoleverbose="yes"
+consoleinteract="no"
+
+## Game Server Details
+# Do not edit
+gamename="Running With Rifles"
+engine="rwr"
+glibc="2.11"
+
+#### Directories ####
+# Edit with care
+
+## Game Server Directories
+systemdir="${serverfiles}"
+executabledir="${serverfiles}"
+executable="./launch_server"
+servercfgdir="${systemdir}/media/packages/vanilla/scripts"
+servercfg="${selfname}.as"
+servercfgdefault="start_invasion.as"
+servercfgfullpath="${servercfgdir}/${servercfg}"
+
+## Backup Directory
+backupdir="${lgsmdir}/backup"
+
+## Logging Directories
+[ -n "${LGSM_LOGDIR}" ] && logdir="${LGSM_LOGDIR}" || logdir="${rootdir}/log"
+lgsmlogdir="${logdir}/script"
+consolelogdir="${logdir}/console"
+lgsmlog="${lgsmlogdir}/${selfname}-script.log"
+consolelog="${consolelogdir}/${selfname}-console.log"
+alertlog="${lgsmlogdir}/${selfname}-alert.log"
+postdetailslog="${lgsmlogdir}/${selfname}-postdetails.log"
+
+## Logs Naming
+lgsmlogdate="${lgsmlogdir}/${selfname}-script-$(date '+%Y-%m-%d-%H:%M:%S').log"
+consolelogdate="${consolelogdir}/${selfname}-console-$(date '+%Y-%m-%d-%H:%M:%S').log"
+
+## Log Parameters
+logtimestamp="off"
+logtimestampformat="%Y-%m-%d %H:%M:%S"

lgsm/data/almalinux-8.csv

@@ -100,6 +100,7 @@ rsdw
 rtcw
 rust,zlib-devel
 rw,java-11-openjdk
+rwr,libgpg-error.i686,libX11.i686,libXext.i686,zlib.i686
 samp
 sb
 sbots

lgsm/data/almalinux-9.csv

@@ -100,6 +100,7 @@ rsdw
 rtcw
 rust,zlib-devel
 rw,java-21-openjdk
+rwr,libgpg-error.i686,libX11.i686,libXext.i686,zlib.i686
 samp
 sb
 sbots

lgsm/data/centos-7.csv

@@ -100,6 +100,7 @@ rsdw
 rtcw
 rust,zlib-devel
 rw,java-11-openjdk
+rwr,libgpg-error.i686,libX11.i686,libXext.i686,zlib.i686
 samp
 sb
 sbots

lgsm/data/centos-8.csv

@@ -100,6 +100,7 @@ rsdw
 rtcw
 rust,zlib-devel
 rw,java-11-openjdk
+rwr,libgpg-error.i686,libX11.i686,libXext.i686,zlib.i686
 samp
 sb
 sbots

lgsm/data/centos-9.csv

@@ -100,6 +100,7 @@ rsdw
 rtcw
 rust,zlib-devel
 rw,java-21-openjdk
+rwr,libgpg-error.i686,libX11.i686,libXext.i686,zlib.i686
 samp
 sb
 sbots

lgsm/data/debian-10.csv

@@ -100,6 +100,7 @@ rsdw
 rtcw
 rust,lib32z1
 rw,openjdk-11-jre
+rwr,libgpg-error0:i386,libx11-6:i386,libxext6:i386,zlib1g:i386
 samp
 sb
 sbots

lgsm/data/debian-11.csv

@@ -101,6 +101,7 @@ rsdw
 rtcw
 rust,lib32z1
 rw,openjdk-17-jre
+rwr,libgpg-error0:i386,libx11-6:i386,libxext6:i386,zlib1g:i386
 samp
 sb
 sbots

lgsm/data/debian-12.csv

@@ -101,6 +101,7 @@ rsdw
 rtcw
 rust,lib32z1
 rw,openjdk-17-jre
+rwr,libgpg-error0:i386,libx11-6:i386,libxext6:i386,zlib1g:i386
 samp
 sb
 sbots

lgsm/data/debian-13.csv

@@ -101,6 +101,7 @@ rsdw
 rtcw
 rust,lib32z1
 rw,openjdk-25-jre
+rwr,libgpg-error0:i386,libx11-6:i386,libxext6:i386,zlib1g:i386
 samp
 sb
 sbots

lgsm/data/debian-9.csv

@@ -101,6 +101,7 @@ rsdw
 rtcw
 rust,lib32z1
 rw,openjdk-8-jre
+rwr,libgpg-error0:i386,libx11-6:i386,libxext6:i386,zlib1g:i386
 samp
 sb
 sbots

lgsm/data/rhel-7.csv

@@ -100,6 +100,7 @@ rsdw
 rtcw
 rust,zlib-devel
 rw,java-11-openjdk
+rwr,libgpg-error.i686,libX11.i686,libXext.i686,zlib.i686
 samp
 sb
 sbots

lgsm/data/rhel-8.csv

@@ -100,6 +100,7 @@ rsdw
 rtcw
 rust,zlib-devel
 rw,java-21-openjdk
+rwr,libgpg-error.i686,libX11.i686,libXext.i686,zlib.i686
 samp
 sb
 sbots

lgsm/data/rhel-9.csv

@@ -100,6 +100,7 @@ rsdw
 rtcw
 rust,zlib-devel
 rw,java-21-openjdk
+rwr,libgpg-error.i686,libX11.i686,libXext.i686,zlib.i686
 samp
 sb
 sbots

lgsm/data/rocky-8.csv

@@ -100,6 +100,7 @@ rsdw
 rtcw
 rust,zlib-devel
 rw,java-21-openjdk
+rwr,libgpg-error.i686,libX11.i686,libXext.i686,zlib.i686
 samp
 sb
 sbots

lgsm/data/rocky-9.csv

@@ -100,6 +100,7 @@ rsdw
 rtcw
 rust,zlib-devel
 rw,java-21-openjdk
+rwr,libgpg-error.i686,libX11.i686,libXext.i686,zlib.i686
 samp
 sb
 sbots

lgsm/data/serverlist.csv

@@ -99,6 +99,7 @@ rsdw,rsdwserver,RuneScape: Dragonwilds,ubuntu-24.04
 rtcw,rtcwserver,Return to Castle Wolfenstein,ubuntu-24.04
 rust,rustserver,Rust,ubuntu-24.04
 rw,rwserver,Rising World,ubuntu-24.04
+rwr,rwrserver,Running With Rifles,ubuntu-24.04
 samp,sampserver,San Andreas Multiplayer,ubuntu-24.04
 sb,sbserver,Starbound,ubuntu-24.04
 sbots,sbotsserver,StickyBots,ubuntu-24.04

lgsm/data/ubuntu-16.04.csv

@@ -101,6 +101,7 @@ rsdw
 rtcw
 rust,lib32z1
 rw,openjdk-8-jre
+rwr,libgpg-error0:i386,libx11-6:i386,libxext6:i386,zlib1g:i386
 samp
 sb
 sbots

lgsm/data/ubuntu-18.04.csv

@@ -101,6 +101,7 @@ rsdw
 rtcw
 rust,lib32z1
 rw,openjdk-11-jre
+rwr,libgpg-error0:i386,libx11-6:i386,libxext6:i386,zlib1g:i386
 samp
 sb
 sbots

lgsm/data/ubuntu-20.04.csv

@@ -101,6 +101,7 @@ rsdw
 rtcw
 rust,lib32z1
 rw,openjdk-21-jre
+rwr,libgpg-error0:i386,libx11-6:i386,libxext6:i386,zlib1g:i386
 samp
 sb
 sbots

lgsm/data/ubuntu-22.04.csv

@@ -101,6 +101,7 @@ rsdw
 rtcw
 rust,lib32z1
 rw,openjdk-21-jre
+rwr,libgpg-error0:i386,libx11-6:i386,libxext6:i386,zlib1g:i386
 samp
 sb
 sbots

lgsm/data/ubuntu-23.04.csv

@@ -101,6 +101,7 @@ rsdw
 rtcw
 rust,lib32z1
 rw,openjdk-21-jre
+rwr,libgpg-error0:i386,libx11-6:i386,libxext6:i386,zlib1g:i386
 samp
 sb
 sbots

lgsm/data/ubuntu-23.10.csv

@@ -101,6 +101,7 @@ rsdw
 rtcw
 rust,lib32z1
 rw,openjdk-21-jre
+rwr,libgpg-error0:i386,libx11-6:i386,libxext6:i386,zlib1g:i386
 samp
 sb
 sbots

lgsm/data/ubuntu-24.04.csv

@@ -100,6 +100,7 @@ rsdw
 rtcw
 rust,lib32z1
 rw,openjdk-25-jre
+rwr,libgpg-error0:i386,libx11-6:i386,libxext6:i386,zlib1g:i386
 samp
 sb
 sbots

lgsm/data/ubuntu-26.04.csv

@@ -100,6 +100,7 @@ rsdw
 rtcw
 rust,lib32z1
 rw,openjdk-25-jre
+rwr,libgpg-error0:i386,libx11-6:i386,libxext6:i386,zlib1g:i386
 samp
 sb
 sbots

lgsm/modules/check_system_requirements.sh

@@ -49,6 +49,8 @@ elif [ "${shortname}" == "pz" ]; then
 	ramrequirementgb="3"
 elif [ "${shortname}" == "rsdw" ]; then
 	ramrequirementgb="2"
+elif [ "${shortname}" == "rwr" ]; then
+	ramrequirementgb="1"
 elif [ "${shortname}" == "rust" ]; then
 	ramrequirementgb="9"
 elif [ "${shortname}" == "sdtd" ]; then

lgsm/modules/command_start.sh

@@ -30,6 +30,25 @@ fn_start_hyt_console() {
 	fi
 }
 
+# Running With Rifles: the server starts in a lobby and runs a game mode once its start script is sent to the console.
+fn_start_rwr_script() {
+	for _ in {1..120}; do
+		if fn_start_hyt_console | grep -a -q "Game loaded"; then
+			TERM=screen tmux -L "${socketname}" send-keys -t "${sessionname}" "start_script ${startscript} ${startpackage}" ENTER
+			fn_script_log_info "Sent start_script ${startscript} ${startpackage}"
+			sleep 5
+			if fn_start_hyt_console | grep -a -q "script build failed"; then
+				fn_print_warn_nl "Running With Rifles could not start ${startpackage}/scripts/${startscript}. Check startpackage and startscript in ${configdirserver}"
+				fn_script_log_warn "Running With Rifles could not start ${startscript}"
+			fi
+			return
+		fi
+		sleep 1
+	done
+	fn_print_warn_nl "Running With Rifles did not finish loading, the game mode was not started"
+	fn_script_log_warn "Running With Rifles did not finish loading, start_script ${startscript} was not sent"
+}
+
 fn_start_hyt_login() {
 	hytloginurl=""
 	local hytloginsent="${hytloginpending}"
@@ -218,6 +237,8 @@ fn_start_tmux() {
 		fi
 		if [ "${shortname}" == "hyt" ]; then
 			fn_start_hyt_login
+		elif [ "${shortname}" == "rwr" ]; then
+			fn_start_rwr_script
 		fi
 	fi
 	rm -f "${lgsmlogdir:?}/.${selfname}-tmux-error.tmp" 2> /dev/null

lgsm/modules/command_stop.sh

@@ -333,6 +333,16 @@ fn_stop_graceful_avorion() {
 	fi
 }
 
+fn_stop_graceful_rwr() {
+	fn_print_dots "Graceful: save_profiles stop_server"
+	fn_script_log_info "Graceful: save_profiles stop_server"
+	TERM=screen tmux -L "${socketname}" send-keys -t "${sessionname}" save_profiles ENTER > /dev/null 2>&1
+	fn_sleep_time_5
+	TERM=screen tmux -L "${socketname}" send-keys -t "${sessionname}" stop_server ENTER > /dev/null 2>&1
+	fn_sleep_time_5
+	fn_stop_graceful_ctrlc
+}
+
 fn_stop_graceful_select() {
 	if [ "${stopmode}" == "1" ]; then
 		fn_stop_tmux
@@ -360,6 +370,8 @@ fn_stop_graceful_select() {
 		fn_stop_graceful_cmd "shutdown" 30
 	elif [ "${stopmode}" == "13" ]; then
 		fn_stop_graceful_sm
+	elif [ "${stopmode}" == "14" ]; then
+		fn_stop_graceful_rwr
 	fi
 }
 

lgsm/modules/info_game.sh

@@ -1846,6 +1846,27 @@ fn_info_game_rsdw() {
 	worldname="${worldname:-"NOT SET"}"
 }
 
+# Config Type: AngelScript (start_server command)
+# Comment: //
+# Example: server_name='SERVERNAME'
+# Filetype: as
+fn_info_game_rwr() {
+	local startscriptfile="${serverfiles}/${startpackage:-media/packages/vanilla}/scripts/${startscript}"
+	if [ ! -f "${startscriptfile}" ]; then
+		startscriptfile="${servercfgfullpath}"
+	fi
+	if [ -f "${startscriptfile}" ]; then
+		servername="$(sed -n "s/.*server_name='\([^']*\)'.*/\1/p" "${startscriptfile}" | head -1)"
+		port="$(sed -n "s/.*server_port='\([0-9]*\)'.*/\1/p" "${startscriptfile}" | head -1)"
+		maxplayers="$(sed -n "s/.*max_players='\([0-9]*\)'.*/\1/p" "${startscriptfile}" | head -1)"
+		gamemode="$(sed -n "s/.*mode='\([^']*\)'.*/\1/p" "${startscriptfile}" | head -1)"
+	fi
+	servername="${servername:-"NOT SET"}"
+	port="${port:-"0"}"
+	queryport="${port}"
+	maxplayers="${maxplayers:-"0"}"
+	gamemode="${gamemode:-"NOT SET"}"
+}
 # Config Type: QuakeC
 # Comment: // or /* */
 # Example: set sv_hostname "SERVERNAME"
@@ -2479,6 +2500,8 @@ elif [ "${shortname}" == "rsdw" ]; then
 	fn_info_game_rsdw
 elif [ "${shortname}" == "rtcw" ]; then
 	fn_info_game_rtcw
+elif [ "${shortname}" == "rwr" ]; then
+	fn_info_game_rwr
 elif [ "${shortname}" == "rust" ]; then
 	fn_info_game_rust
 elif [ "${shortname}" == "rw" ]; then

lgsm/modules/info_messages.sh

@@ -719,7 +719,7 @@ fn_info_messages_ports_edit() {
 
 	startparameterslocation="${red}UNKNOWN${default}"
 	# engines/games that require editing in the config file.
-	local ports_edit_array=("ac" "arma3" "armar" "bo" "bt" "ct" "dst" "eco" "idtech2" "idtech3" "idtech3_ql" "jc2" "jc3" "lwjgl2" "mcb" "nec" "pc" "pc2" "prism3d" "pz" "qw" "refractor" "renderware" "rw" "sb" "sdtd" "st" "stn" "ts3" "tw" "terraria" "unreal" "unreal2" "unreal3" "vints" "xnt" "wurm")
+	local ports_edit_array=("ac" "arma3" "armar" "bo" "bt" "ct" "dst" "eco" "idtech2" "idtech3" "idtech3_ql" "jc2" "jc3" "lwjgl2" "mcb" "nec" "pc" "pc2" "prism3d" "pz" "qw" "refractor" "renderware" "rw" "rwr" "sb" "sdtd" "st" "stn" "ts3" "tw" "terraria" "unreal" "unreal2" "unreal3" "vints" "xnt" "wurm")
 	for port_edit in "${ports_edit_array[@]}"; do
 		if [ "${shortname}" == "ut3" ]; then
 			startparameterslocation="${servercfgdir}/UTWeb.ini"
@@ -754,6 +754,8 @@ fn_info_messages_ports() {
 		portcommand="ss -tuplwn | grep enfMain"
 	elif [ "${shortname}" == "q4" ]; then
 		portcommand="ss -tuplwn | grep q4ded.x86"
+	elif [ "${shortname}" == "rwr" ]; then
+		portcommand="ss -tuplwn | grep rwr_server"
 	elif [ "${shortname}" == "hyt" ] || [ "${shortname}" == "mc" ] || [ "${shortname}" == "nec" ] || [ "${shortname}" == "pmc" ] || [ "${shortname}" == "vpmc" ] || [ "${shortname}" == "wmc" ]; then
 		portcommand="ss -tuplwn | grep java"
 	elif [ "${shortname}" == "terraria" ]; then
@@ -1433,6 +1435,21 @@ fn_info_messages_rsdw() {
 	} | column -s $'\t' -t
 }
 
+fn_info_messages_rwr() {
+	{
+		fn_port "header"
+		fn_port "Game" port udp
+	} | column -s $'\t' -t
+	echo -e ""
+	echo -e "${bold}${lightgreen}${gamename} Game Settings${default}"
+	fn_messages_separator
+	{
+		echo -e "${lightblue}Start package:\t${default}${startpackage}"
+		echo -e "${lightblue}Start script:\t${default}${startscript}"
+		echo -e "${lightblue}Game mode:\t${default}${gamemode}"
+	} | column -s $'\t' -t
+}
+
 fn_info_messages_rtcw() {
 	{
 		fn_port "header"
@@ -1938,6 +1955,8 @@ fn_info_messages_select_engine() {
 		fn_info_messages_ro
 	elif [ "${shortname}" == "rsdw" ]; then
 		fn_info_messages_rsdw
+	elif [ "${shortname}" == "rwr" ]; then
+		fn_info_messages_rwr
 	elif [ "${shortname}" == "rtcw" ]; then
 		fn_info_messages_rtcw
 	elif [ "${shortname}" == "samp" ]; then

lgsm/modules/install_config.sh

@@ -715,6 +715,9 @@ elif [ "${shortname}" == "squad" ]; then
 	fn_default_config_remote
 	fn_set_config_vars
 	fn_list_config_locations
+elif [ "${shortname}" == "rwr" ]; then
+	fn_default_config_local
+	fn_list_config_locations
 elif [ "${shortname}" == "sb" ]; then
 	array_configs+=(starbound_server.config)
 	fn_default_config_remote