Bump version

Fixes #25

lug-helper.sh

@@ -61,10 +61,10 @@ if [ ! -x "$(command -v curl)" ]; then
     notify-send "lug-helper" "The required package 'curl' was not found on this system.\n" --icon=dialog-warning
     exit 1
 fi
-if [ ! -x "$(command -v mktemp)" ] || [ ! -x "$(command -v basename)" ]; then
+if [ ! -x "$(command -v mktemp)" ] || [ ! -x "$(command -v basename)" ] || [ ! -x "$(command -v sort)" ]; then
     # Print to stderr and also try warning the user through notify-send
-    printf "lug-helper.sh: One or more required packages were not found on this system.\nPlease check that the following packages are installed:\n- mktemp (part of gnu coreutils)\n- basename (part of gnu coreutils)\n" 1>&2
-    notify-send "lug-helper" "One or more required packages were not found on this system.\nPlease check that the following packages are installed:\n- mktemp (part of gnu coreutils)\n- basename (part of gnu coreutils)\n" --icon=dialog-warning
+    printf "lug-helper.sh: One or more required packages were not found on this system.\nPlease check that the following packages are installed:\n- mktemp (part of gnu coreutils)\n- basename (part of gnu coreutils)\n- sort (part of gnu coreutils)\n" 1>&2
+    notify-send "lug-helper" "One or more required packages were not found on this system.\nPlease check that the following packages are installed:\n- mktemp (part of gnu coreutils)\n- basename (part of gnu coreutils)\n- sort (part of gnu coreutils)\n" --icon=dialog-warning
     exit 1
 fi
 
@@ -145,9 +145,9 @@ else
 fi
 
 # Github repo and script version info
-repo="the-sane/lug-helper"
-releases_url="https://github.com/the-sane/lug-helper/releases"
-current_version="v1.11.1"
+repo="starcitizen-lug/lug-helper"
+releases_url="https://github.com/$repo/releases"
+current_version="v1.12"
 
 ############################################################################
 ############################################################################
@@ -304,7 +304,7 @@ menu() {
     elif [ -z "$menu_height" ]; then
         debug_print exit "Script error: The string 'menu_height' was not set\nbefore calling the menu function. Aborting."
     elif [ -z "$cancel_label" ]; then
-        debug_print exit "Script error: The string 'menu_height' was not set\nbefore calling the menu function. Aborting."
+        debug_print exit "Script error: The string 'cancel_label' was not set\nbefore calling the menu function. Aborting."
     fi
     
     # Use Zenity if it is available
@@ -637,7 +637,7 @@ mapcount_check() {
     # Add to the results and actions arrays
     if [ "$mapcount" -ge 16777216 ]; then
         # All good
-        preflight_pass+=("vm.max_map_count is set to at least 16777216.")
+        preflight_pass+=("vm.max_map_count is set to $mapcount.")
     elif grep -E -x -q "vm.max_map_count" /etc/sysctl.conf /etc/sysctl.d/* 2>/dev/null; then
         # Was it supposed to have been set by sysctl?
         preflight_fail+=("vm.max_map_count is configured to at least 16777216 but the setting has not been loaded by your system.")
@@ -702,7 +702,7 @@ filelimit_check() {
     # Add to the results and actions arrays
     if [ "$filelimit" -ge 524288 ]; then
         # All good
-        preflight_pass+=("Hard open file descriptors limit is set to at least 524288.")
+        preflight_pass+=("Hard open file descriptors limit is set to $filelimit.")
     else
         # The file limit should be changed
         preflight_fail+=("Your hard open file descriptors limit is $filelimit\nand should be set to at least 524288\nto increase the maximum number of open files.")
@@ -806,6 +806,22 @@ lutris_restart() {
 
 #------------------------- begin download functions ----------------------------#
 
+# Display post download message or instructions if needed
+# Expects the variables message_heading, post_download_msg_text,
+# post_download_msg_italics, and downloaded_item_name
+post_download() {
+    if [ "$trigger_post_download" = "true" ]; then
+        message_heading="Download Complete"
+        
+        if [ "$use_zenity" -eq 1 ]; then
+            message_heading="<b>$message_heading</b>"
+            post_download_msg_italics="<i>$post_download_msg_italics</i>"
+        fi
+        message info "$message_heading\n\n$post_download_msg_text\n\n$post_download_msg_italics\n$downloaded_item_name"
+    fi
+    trigger_post_download="false"
+}
+
 # Uninstall the selected item
 download_delete() {
     # This function expects an index number for the array
@@ -956,9 +972,10 @@ download_install() {
     num_files=0
     for extracted_item in "$tmp_dir/$download_name"/*; do
         if [ -d "$extracted_item" ]; then
-            num_dirs="$((num_dirs+1))"
+            num_dirs="$(($num_dirs+1))"
+            extracted_dir="$(basename "$extracted_item")"
         elif [ -f "$extracted_item" ]; then
-            num_files="$((num_files+1))"
+            num_files="$(($num_files+1))"
         fi
     done
 
@@ -966,21 +983,25 @@ download_install() {
     if [ "$num_dirs" -eq 0 ] && [ "$num_files" -eq 0 ]; then
         # Sanity check
         message warning "The downloaded archive is empty. There is nothing to do."
-        # Cleanup tmp download
-        debug_print continue "Removing $tmp_dir/$download_file..."
-        rm "$tmp_dir/$download_file"
-        return 1
     elif [ "$num_dirs" -eq 1 ] && [ "$num_files" -eq 0 ]; then
         # If the archive contains only one directory, install that directory
-        debug_print continue "Installing $download_type into $download_dir..."
+        # We rename it to the name of the archive in case it is different
+        # so we can easily detect installed items in download_select_install()
+        debug_print continue "Installing $download_type into $download_dir/$download_name..."
         if [ "$use_zenity" -eq 1 ]; then
             # Use Zenity progress bar
-            mkdir -p "$download_dir" && cp -r "$tmp_dir"/"$download_name"/* "$download_dir" | \
+            mkdir -p "$download_dir" && cp -r "$tmp_dir/$download_name/$extracted_dir" "$download_dir/$download_name" | \
                     zenity --progress --pulsate --no-cancel --auto-close --title="Star Citizen LUG Helper" --text="Installing ${download_type}...\n" 2>/dev/null
         else
-            mkdir -p "$download_dir" && cp -r "$tmp_dir"/"$download_name"/* "$download_dir"
+            mkdir -p "$download_dir" && cp -r "$tmp_dir/$download_name/$extracted_dir" "$download_dir/$download_name"
         fi
+
+        # We need to restart Lutris for the download to be detected
         lutris_needs_restart="true"
+        # Store the final name of the downloaded directory
+        downloaded_item_name="$download_name"
+        # Trigger the post_download() function
+        trigger_post_download="true"
     elif [ "$num_dirs" -gt 1 ] || [ "$num_files" -gt 0 ]; then
         # If the archive contains more than one directory or
         # one or more files, we must create a subdirectory
@@ -992,7 +1013,13 @@ download_install() {
         else
             mkdir -p "$download_dir/$download_name" && cp -r "$tmp_dir"/"$download_name"/* "$download_dir"/"$download_name"
         fi
+
+        # We need to restart Lutris for the download to be detected
         lutris_needs_restart="true"
+        # Store the final name of the downloaded directory
+        downloaded_item_name="$download_name"
+        # Trigger the post_download() function
+        trigger_post_download="true"
     else
         # Some unexpected combination of directories and files
         debug_print exit "Script error:  Unexpected archive contents in download_install function. Aborting"
@@ -1000,8 +1027,11 @@ download_install() {
     fi
 
     # Cleanup tmp download
-    debug_print continue "Removing $tmp_dir/$download_file..."
+    debug_print continue "Cleaning up $tmp_dir/$download_file..."
     rm "$tmp_dir/$download_file"
+
+    # Display any post-download messages or instructions
+    post_download
 }
 
 # List available items for download
@@ -1193,6 +1223,10 @@ download_manage() {
 
 # Configure the download_manage function for runners
 runner_manage() {
+    # Set some defaults
+    lutris_needs_restart="false"
+    trigger_post_download="false"
+
     # Use indirect expansion to point download_sources
     # to the runner_sources array set at the top of the script
     declare -n download_sources=runner_sources
@@ -1203,6 +1237,15 @@ runner_manage() {
     download_menu_description="The runners listed below are wine builds created for Star Citizen"
     download_menu_height="140"
 
+    # Set the post download instructions
+    # Format:
+    # A header is automatically displayed that reads: Download Complete
+    # msg_text is displayed below the header
+    # msg_italics is displayed below that in italics when zenity is in use
+    # Lastly, the downloaded directory name is automatically displayed
+    post_download_msg_text="Select the runner in Lutris from the dropdown menu"
+    post_download_msg_italics="Configure->Runner Options->Wine version"
+
     # Call the download_manage function with the above configuration
     # The argument passed to the function is used for special handling
     # and displayed in the menus and dialogs.
@@ -1211,6 +1254,10 @@ runner_manage() {
 
 # Configure the download_manage function for dxvks
 dxvk_manage() {
+    # Set some defaults
+    lutris_needs_restart="false"
+    trigger_post_download="false"
+
     # Use indirect expansion to point download_sources
     # to the dxvk_sources array set at the top of the script
     declare -n download_sources=dxvk_sources
@@ -1221,6 +1268,15 @@ dxvk_manage() {
     download_menu_description="The DXVK versions below may help improve game performance"
     download_menu_height="140"
 
+    # Set the post download instructions
+    # Format:
+    # A header is automatically displayed that reads: Download Complete
+    # msg_text is displayed below the header
+    # msg_italics is displayed below that in italics when zenity is in use
+    # Lastly, the downloaded directory name is automatically displayed
+    post_download_msg_text="Type the DXVK folder name in your Lutris settings"
+    post_download_msg_italics="Configure->Runner Options->DXVK version"
+
     # Call the download_manage function with the above configuration
     # The argument passed to the function is used for special handling
     # and displayed in the menus and dialogs.
@@ -1375,7 +1431,7 @@ maintenance_menu() {
 # Get a random Penguin's Star Citizen referral code
 referral_randomizer() {
     # Populate the referral codes array
-    referral_codes=("STAR-4TZD-6KMM" "STAR-4XM2-VM99" "STAR-2NPY-FCR2" "STAR-T9Z9-7W6P" "STAR-VLBF-W2QR" "STAR-BYR6-YHMF" "STAR-3X2H-VZMX" "STAR-BRWN-FB9T" "STAR-FG6Y-N4Q4" "STAR-VLD6-VZRG" "STAR-T9KF-LV77" "STAR-4XHB-R7RF" "STAR-9NVF-MRN7" "STAR-3Q4W-9TC3" "STAR-3SBK-7QTT" "STAR-XFBT-9TTK" "STAR-F3H9-YPHN" "STAR-BYK6-RCCL" "STAR-XCKH-W6T7" "STAR-H292-39WK" "STAR-ZRT5-PJB7" "STAR-GMBP-SH9Y" "STAR-PLWB-LMFY" "STAR-TNZN-H4ZT" "STAR-T5G5-L2GJ" "STAR-6TPV-7QH2" "STAR-THHD-TV3Y" "STAR-7ZFS-PK2L" "STAR-SRQN-43TB" "STAR-9TDG-D4H9" "STAR-BPH3-THJC" "STAR-HL3M-R5KC" "STAR-GBS5-LTVB" "STAR-CJ3Y-KZZ4" "STAR-5GRM-7HBY" "STAR-G2GX-Y2QJ" "STAR-YWY3-H4XX" "STAR-6VGM-PTKC" "STAR-T6MZ-QFHX" "STAR-T2K6-LXFW" "STAR-XN25-9CJJ" "STAR-47V3-4QGB")
+    referral_codes=("STAR-4TZD-6KMM" "STAR-4XM2-VM99" "STAR-2NPY-FCR2" "STAR-T9Z9-7W6P" "STAR-VLBF-W2QR" "STAR-BYR6-YHMF" "STAR-3X2H-VZMX" "STAR-BRWN-FB9T" "STAR-FG6Y-N4Q4" "STAR-VLD6-VZRG" "STAR-T9KF-LV77" "STAR-4XHB-R7RF" "STAR-9NVF-MRN7" "STAR-3Q4W-9TC3" "STAR-3SBK-7QTT" "STAR-XFBT-9TTK" "STAR-F3H9-YPHN" "STAR-BYK6-RCCL" "STAR-XCKH-W6T7" "STAR-H292-39WK" "STAR-ZRT5-PJB7" "STAR-GMBP-SH9Y" "STAR-PLWB-LMFY" "STAR-TNZN-H4ZT" "STAR-T5G5-L2GJ" "STAR-6TPV-7QH2" "STAR-THHD-TV3Y" "STAR-7ZFS-PK2L" "STAR-SRQN-43TB" "STAR-9TDG-D4H9" "STAR-BPH3-THJC" "STAR-HL3M-R5KC" "STAR-GBS5-LTVB" "STAR-CJ3Y-KZZ4" "STAR-5GRM-7HBY" "STAR-G2GX-Y2QJ" "STAR-YWY3-H4XX" "STAR-6VGM-PTKC" "STAR-T6MZ-QFHX" "STAR-T2K6-LXFW" "STAR-XN25-9CJJ" "STAR-47V3-4QGB" "STAR-YD4Z-TQZV" "STAR-XLN7-9XNJ" "STAR-N62T-2R39" "STAR-3S3D-9HXQ" "STAR-TRZF-NMCV" "STAR-TLLJ-SMG4")
     # Pick a random array element. Scale a floating point number for
     # a more random distribution than simply calling RANDOM
     random_code="${referral_codes[$(awk '{srand($2); print int(rand()*$1)}' <<< "${#referral_codes[@]} $RANDOM")]}"
@@ -1435,14 +1491,14 @@ if [ -x "$(command -v zenity)" ]; then
     use_zenity=1
 fi
 
-# Set some defaults
+# Set defaults
 live_or_ptu="$live_dir"
-lutris_needs_restart="false"
 
 # Check if a newer verison of the script is available
 latest_version="$(get_latest_release "$repo")"
 
-if [ "$latest_version" != "$current_version" ]; then
+if [ "$latest_version" != "$current_version" ] &&
+   [ "$current_version" = "$(printf "$current_version\n$latest_version" | sort -V | head -n1)" ]; then
     if [ "$use_zenity" -eq 1 ]; then
         releases_url_formatted="<a href='$releases_url'>$releases_url</a>"
     else
@@ -1463,6 +1519,7 @@ if [ "$#" -gt 0 ]; then
 Usage: lug-helper <options>
   -p, --preflight-check     Run system optimization checks
   -m, --manage-runners      Install or remove Lutris runners
+  -k, --manage-dxvk         Install or remove DXVK versions
   -u, --delete-user-folder  Delete Star Citizen USER folder, preserving keybinds
   -s, --delete-shaders      Delete Star Citizen shaders directory
   -c, --delete-dxvk-cache   Delete Star Citizen dxvk cache file
@@ -1480,6 +1537,9 @@ Usage: lug-helper <options>
             --manage-runners | -m )
                 cargs+=("runner_manage")
                 ;;
+            --manage-dxvk | -k )
+                cargs+=("dxvk_manage")
+                ;;
             --delete-user-folder | -u )
                 cargs+=("sanitize")
                 ;;