Update alert function messaging

Show the actual guidance in a single acknowledgement dialog instead of a generic OK prompt, and update alert-based installer instructions to use the new helper contract.

.includes/functions.sh

@@ -1,13 +1,31 @@
 #!/usr/bin/env bash
+# shellcheck disable=SC2034,SC2154  # sourced by audiogame-manager with shared globals and exported state
 
 # Source IPFS game URLs
 source "${BASH_SOURCE[0]%/*}/ipfs.sh"
 
 # Alerts, for when user needs to read something.
 alert() {
+    local title="Alert"
+    local backTitle=""
+    local message="Press OK to continue."
+
+    if [[ $# -eq 1 ]]; then
+        message="$1"
+    elif [[ $# -eq 2 ]]; then
+        title="$1"
+        backTitle="$1"
+        message="$2"
+    elif [[ $# -ge 3 ]]; then
+        title="$1"
+        backTitle="$2"
+        shift 2
+        message="$*"
+    fi
+
     play -qnV0 synth 3 pluck D3 pluck A3 pluck D4 pluck F4 pluck A4 delay 0 .1 .2 .3 .4 remix - chorus 0.9 0.9 38 0.75 0.3 0.5 -t
     echo
-    agm_msgbox "Alert" "" "Press OK to continue."
+    agm_msgbox "${title}" "${backTitle}" "${message}"
 }
 
 check_requirements() {
@@ -54,7 +72,7 @@ clear_cache() {
 }
 
 download() {
-   local source=($@)
+   local source=("$@")
    for i in "${source[@]}" ; do
        local dest="${i##*/}"
        dest="${dest//%20/ }"
@@ -120,8 +138,7 @@ download() {
        esac
        if [[ $downloadError -ne 0 ]]; then
            rm -fv "${cache}/${dest}"
-                   agm_infobox "Audio Game Manager" "Audio Game Manager" "Error downloading \"${dest}\". Installation cannot continue."
-                   alert
+                   alert "Audio Game Manager" "Audio Game Manager" "Error downloading \"${dest}\". Installation cannot continue."
                    exit 1
        fi
    done
@@ -142,10 +159,10 @@ get_installer() {
         if echo "$2" | xclip -selection clipboard 2> /dev/null ; then
             message+="\n\nThe URL has been copied to the clipboard."
         fi
-        agm_msgbox "Audiogame Manager" "Audiogame Manager" "$message"
+        alert "Audiogame Manager" "Audiogame Manager" "$message"
         # Search the Desktop and Downloads directories for the installation file
         for i in ~/Downloads ~/Desktop ; do
-            find $i -type f -name "$1" -exec cp -v {} "${cache}/" \;
+            find "$i" -type f -name "$1" -exec cp -v {} "${cache}/" \;
         done
         # If the file is still not available abort.
         if [[ ! -f "${cache}/$1" ]]; then
@@ -157,8 +174,7 @@ get_installer() {
 get_steam() {
     # Arguments: $1 id of item for download, $2 url for game
     trap "exit 0" SIGINT
-    echo "manual intervention required."
-    alert
+    alert "Audiogame Manager" "Audiogame Manager" "Manual intervention required."
     agm_yesno "Audiogame Manager" "Audiogame Manager" "To install the game manually, place files in \"${WINEPREFIX}/drive_c/Program Files/${game}\". Continue with Steam installation?"
     case $? in
         0) echo "The next steps will install through steamcmd." ;;

.install/AudioQuake.sh

@@ -1,9 +1,8 @@
+# shellcheck shell=bash disable=SC2154  # cache and WINEPREFIX are set by audiogame-manager
 download "https://github.com/matatk/agrip/releases/download/2020.0-beta1/AudioQuake+LDL_2020.0-beta1_Windows.zip" "https://stormgames.wolfe.casa/downloads/quake.zip"
 export winVer="win7"
 install_wine_bottle
 install_with_progress unzip "Extracting game files..." -d "$WINEPREFIX/drive_c/Program Files" "${cache}/AudioQuake+LDL_2020.0-beta1_Windows.zip"
 install_with_progress unzip "Extracting game files..." -d "$WINEPREFIX/drive_c/Program Files/AudioQuake/id1" "${cache}/quake.zip"
 add_launcher "c:\Program Files\AudioQuake\AudioQuake.exe"
-echo
-echo "After you launch the game, press tab then enter and it should begin speaking."
-alert
+alert "After you launch the game, press tab then enter and it should begin speaking."

.install/Executioner's Rage.sh

@@ -1,3 +1,4 @@
+# shellcheck shell=bash disable=SC2154  # cache, WINEPREFIX, and game are set by audiogame-manager
 gameVersion=2.4.1
 download "https://dl.tweesecake.app/rage/rage${gameVersion}.zip"
 export WINEARCH=win64
@@ -6,9 +7,8 @@ install_wine_bottle
 install_with_progress unzip "Extracting game files..." -d "$WINEPREFIX/drive_c/Program Files/" "${cache}/rage${gameVersion}.zip"
 add_launcher "c:\Program Files\rage\rage.exe"
 url="https://techcake.games/games/executioners-rage/"
-echo "Before you can login, you need to create an account at:"
-echo "$url"
+message="Before you can login, you need to create an account at:\n${url}"
 if echo "$url" | xclip -selection clipboard 2> /dev/null ; then
     message+="\n\nThe URL has been copied to the clipboard."
 fi
-alert
+alert "Executioner's Rage" "Executioner's Rage" "$message"

.install/Galactic Strike.sh

@@ -1,8 +1,7 @@
+# shellcheck shell=bash disable=SC2154  # cache and WINEPREFIX are set by audiogame-manager
 get_installer "Galactic Strike 1.2.zip" "https://fusion-forged-games.itch.io/galactic-strike"
 export winVer="win10"
 install_wine_bottle
 install_with_progress unzip "Extracting game files..." -d "$WINEPREFIX/drive_c/Program Files/Galactic Strike" "${cache}/Galactic Strike 1.2.zip"
 add_launcher "c:\Program Files\Galactic Strike\Galactic Strike.exe"
-echo "Use controls wasd to movi and navigate the menu."
-echo "Use m to fire and select items from the menu."
-alert
+alert "Use controls wasd to movi and navigate the menu.\nUse m to fire and select items from the menu."

.install/Grizzly Gulch.sh

@@ -1,6 +1,6 @@
+# shellcheck shell=bash disable=SC2154  # cache and WINEPREFIX are set by audiogame-manager
 download "https://stormgames.wolfe.casa/downloads/grizzly-gulch.zip"
 install_wine_bottle vb6run mfc42
 install_with_progress unzip "Extracting game files..." -d "$WINEPREFIX/drive_c/Program Files" "$cache/grizzly-gulch.zip"
 add_launcher "c:\Program Files\grizzly-gulch\Grizzly Gulch.exe"
-echo "If the combat sequences happen too slow for your tastes, while in the town square, you can use f12 to turn up the combat speed and f11 to lower it."
-alert
+alert "If the combat sequences happen too slow for your tastes, while in the town square, you can use f12 to turn up the combat speed and f11 to lower it."

.install/Lunimals.sh

@@ -1,3 +1,4 @@
+# shellcheck shell=bash disable=SC2154  # cache and WINEPREFIX are set by audiogame-manager
 export WINEARCH="win64"  # Migrated to wine64 with WINETRICKS_FORCE=1
 export winVer="win7"
 export winetricksSettings="vd=1024x768"
@@ -6,5 +7,4 @@ install_wine_bottle sapi vb6run dx8vb quartz
 install_with_progress unzip "Extracting game files..." -d "$WINEPREFIX/drive_c/Program Files/lunimals" "${cache}/lunimals.zip"
 wine 'c:\Program Files\lunimals\checkup.exe' /verysilent
 add_launcher "c:\Program Files\lunimals\Lunimals.exe"
-echo "Note: Lunimals installed. Once you start the game, you must press tab until you hear sapi on to get speech." >&2
-alert
+alert "Note: Lunimals installed. Once you start the game, you must press tab until you hear sapi on to get speech."

.install/Mist World.sh

@@ -1,3 +1,4 @@
+# shellcheck shell=bash disable=SC2154  # cache and WINEPREFIX are set by audiogame-manager
 export WINEARCH="win64"  # Migrated to wine64
 export winVer="win7"
 
@@ -8,13 +9,4 @@ sed -i 's/1024m/768m/g' "$WINEPREFIX/drive_c/Program Files/Mist World/mw.exe.vmo
 cp "$WINEPREFIX/drive_c/Program Files/Mist World/"{mw.exe.vmoptions,update.exe.vmoptions}
 mkdir "$WINEPREFIX/drive_c/Program Files/Mist World/"{user,users}
 add_launcher 'c:\Program Files\Mist World\mw.exe'
-echo
-echo "If you do not have an account, There is a script in game-scripts to help."
-echo "Launch the game, press enter on create account, then drop into a console so the game window does not lose focus."
-echo "Change to the game-scripts directory and run"
-echo "./mist_world_account_creator.sh and follow the prompts."
-echo
-echo "To login, type your email address, press tab, and type your password."
-echo "If you want to enable automatic login, press tab two times followed by space, then tab and enter."
-echo "If you do not want to auto login, you can just press enter after typing your password."
-alert
+alert "If you do not have an account, There is a script in game-scripts to help.\nLaunch the game, press enter on create account, then drop into a console so the game window does not lose focus.\nChange to the game-scripts directory and run\n./mist_world_account_creator.sh and follow the prompts.\n\nTo login, type your email address, press tab, and type your password.\nIf you want to enable automatic login, press tab two times followed by space, then tab and enter.\nIf you do not want to auto login, you can just press enter after typing your password."

.install/Scramble!.sh

@@ -1,8 +1,9 @@
+# shellcheck shell=bash disable=SC2154  # cache and WINEPREFIX are set by audiogame-manager
+# shellcheck disable=SC2034  # consumed by shared bottle setup
 winetricksSettings="vd=1024x768"
 export winVer="win7"
 download "https://stevend.net/downloads/scramble_win32.zip"
 install_wine_bottle
 install_with_progress unzip "Extracting game files..." -d "$WINEPREFIX/drive_c/Program Files/" "${cache}/scramble_win32.zip"
-echo "Note: When you first start the game, it will say that tts initialization failed. Please answer that you do not want to attempt initialization of tts when the game starts to allow easy speech through speech dispatcher."
-alert
+alert "Note: When you first start the game, it will say that tts initialization failed. Please answer that you do not want to attempt initialization of tts when the game starts to allow easy speech through speech dispatcher."
 add_launcher "c:\Program Files\scramble_win32\scramble.exe"

.install/Shadow Line.sh

@@ -1,3 +1,4 @@
+# shellcheck shell=bash disable=SC2154  # cache and WINEPREFIX are set by audiogame-manager
 #//Disable since it's not working
 download "https://www.mm-galabo.com/sr/Download_files_srfv/shadowrine_fullvoice3.171.exe" "https://raw.githubusercontent.com/LordLuceus/sr-english-localization/master/language_en.dat"
 export WINEARCH="win64"  # Migrated to wine64 with WINETRICKS_FORCE=1
@@ -19,10 +20,4 @@ rm /tmp/bcrypt_override.reg
 wineserver -k 2>/dev/null || true
 mv -v "${cache}/language_en.dat" "${WINEPREFIX}/drive_c/Program Files (x86)/GalaxyLaboratory/ShadowRine_FullVoice/SystemData/language_en.dat"
 add_launcher "c:\Program Files (x86)\GalaxyLaboratory\ShadowRine_FullVoice\play_sr.exe"
-echo "Please set the language to English when the game opens."
-echo "Go to options and press enter."
-echo "Press down arrow 5 times and press enter."
-echo "Press down arrow 1 time and press enter."
-echo "Press up arrow 2 times and press enter."
-echo "If everything worked as expected you should be back on the game menu and speech should work."
-alert
+alert "Please set the language to English when the game opens.\nGo to options and press enter.\nPress down arrow 5 times and press enter.\nPress down arrow 1 time and press enter.\nPress up arrow 2 times and press enter.\nIf everything worked as expected you should be back on the game menu and speech should work."

.install/Super Deekout.sh

@@ -1,3 +1,4 @@
+# shellcheck shell=bash disable=SC2154  # cache and WINEPREFIX are set by audiogame-manager
 download "http://www.danielzingaro.com/superdeekout_setup.exe" "http://www.danielzingaro.com/sd_full.exe"
 install_wine_bottle vb6run dx8vb
 wine "${cache}/superdeekout_setup.exe" &
@@ -13,8 +14,7 @@ xdotool sleep 15 key --delay 250 alt+f 2> /dev/null
 xdotool sleep 3 key --delay 250 n 2> /dev/null
 wineserver -k
 install_with_progress 7z "Extracting game files..." x -y -o"$WINEPREFIX/drive_c/Program Files/Super Deekout" "${cache}/sd_full.exe"
-echo "Super Deekout needs some information before it will run:"
-alert
+alert "Super Deekout needs some information before it will run."
 read -erp "Please enter your first name: " fname
 read -erp "Please enter your last name: " lname
 read -erp "Please enter your email address: " email

.install/They'll Come from the Moon.sh

@@ -1,3 +1,4 @@
+# shellcheck shell=bash disable=SC2154  # cache and WINEPREFIX are set by audiogame-manager
 get_installer "theyll-come-from-the-moon-windows.zip" "https://soundrascal.itch.io/theyll-come-from-the-moon"
 export WINEARCH=win64
 export winVer="win8"
@@ -7,5 +8,4 @@ install_with_progress unzip "Extracting game files..." -d "$WINEPREFIX/drive_c/P
 winetricks -q usetakefocus=y
 winetricks -q usetakefocus=n
 add_launcher "c:\Program Files\tcftm\They'll Come from the Moon!.exe"
-echo "When the game launches, press the enter key to load the game which will begin to speak."
-alert
+alert "When the game launches, press the enter key to load the game which will begin to speak."

.install/VIP Mud.sh

@@ -1,12 +1,8 @@
+# shellcheck shell=bash disable=SC2154  # cache and WINEPREFIX are set by audiogame-manager
 export WINEARCH="win64"  # Migrated to wine64 with WINETRICKS_FORCE=1
 export winVer="win7"
 install_wine_bottle sapi vb6run dx8vb
 wine "${cache}/vipmud20016.exe" /silent
 mkdir -p "${HOME}/.local/wine/vip-mud/drive_c/users/${USER}/Documents/VIP Mud"
 add_launcher "c:\Program Files (x86)\VIPMud 2.0\vipmud2.exe"
-echo
-echo "When you first launch VIP Mud You will be presented with several inaccessible dialogs."
-echo "To bypass these dialogs, press alt+o, then press enter until speech starts."
-echo "To be sure that each new dialog has had time to complete, wait a second between each press of enter."
-echo "In each subsequent launch, you will need to hit enter a couple times before it starts speaking."
-alert
+alert "When you first launch VIP Mud You will be presented with several inaccessible dialogs.\nTo bypass these dialogs, press alt+o, then press enter until speech starts.\nTo be sure that each new dialog has had time to complete, wait a second between each press of enter.\nIn each subsequent launch, you will need to hit enter a couple times before it starts speaking."