added download option for TKG runners

3.17 shaders

README.md

@@ -1,4 +1,4 @@
-# LUG-Helper
+# LUG Helper
 **Star Citizen's Linux Users Group Helper Script**  
 https://robertsspaceindustries.com/orgs/LUG
 
@@ -8,7 +8,7 @@ _**This script is designed to help you manage and optimize Star Citizen on Linux
 Zenity menus are used for a GUI experience with a fallback to terminal-based menus where Zenity is unavailable.  
 Command line arguments are available for quickly launching functions from the terminal.  
 
-Configuration is saved in *$XDG_CONFIG_HOME/starcitizen-lug/*.  
+Configuration is saved in *$XDG_CONFIG_HOME/starcitizen-lug/*  
 Keybinds are backed up to *$XDG_CONFIG_HOME/starcitizen-lug/keybinds/*
 
 ## Options:
@@ -23,10 +23,13 @@ Keybinds are backed up to *$XDG_CONFIG_HOME/starcitizen-lug/keybinds/*
 `Install Star Citizen`
 - Launches Lutris and uses the bundled json to install Star Citizen
 
+`Deploy Easy Anti-Cheat Workaround`
+- Applies the workaround to /etc/hosts and deletes the necessary EAC files
+
 `Manage Lutris Runners`
 - Quickly install and delete Lutris wine runners
 
-`Manage DXVK Versions`
+`Manage Lutris DXVK Versions`
 - Quickly install and delete DXVK versions for Lutris
 
 `Maintenance and Troubleshooting`
@@ -60,9 +63,9 @@ Keybinds are backed up to *$XDG_CONFIG_HOME/starcitizen-lug/keybinds/*
 ## Installation:
 
 From Source:
-1. Download it!
+1. Download it! https://github.com/starcitizen-lug/lug-helper/releases
-2. Run it!
+2. Extract it!
-3. If you want, move *lug-logo.png* to */usr/share/pixmaps/*
+3. Run it!
 
 Arch Linux: https://aur.archlinux.org/packages/lug-helper/
 
@@ -72,4 +75,5 @@ Arch Linux: https://aur.archlinux.org/packages/lug-helper/
 - https://github.com/gort818
 - https://github.com/victort
 - https://github.com/Wrzlprnft
+- https://github.com/ananace
 - Runner Downloader inspired by https://github.com/richardtatum/sc-runner-updater

lug-helper.sh

@@ -72,6 +72,8 @@ if [ ! -x "$(command -v mktemp)" ] || [ ! -x "$(command -v sort)" ] || [ ! -x "$
     exit 1
 fi
 
+######## Config ############################################################
+
 wine_conf="winedir.conf"
 game_conf="gamedir.conf"
 
@@ -83,7 +85,7 @@ data_dir="${XDG_DATA_HOME:-$HOME/.local/share}"
 conf_subdir="starcitizen-lug"
 
 # Helper directory
-helper_dir="$(realpath "$0" | xargs dirname)"
+helper_dir="$(realpath "$0" | xargs -0 dirname)"
 
 # Temporary directory
 tmp_dir="$(mktemp -d --suffix=".lughelper")"
@@ -100,6 +102,8 @@ install_path="drive_c/Program Files/Roberts Space Industries/$sc_base_dir"
 live_dir="LIVE"
 ptu_dir="PTU"
 
+# AppData directory
+appdata_path="drive_c/users/$USER/AppData/Local/Star Citizen"
 # Remaining directory paths are set at the end of the getdirs() function
 
 ######## Runners ###########################################################
@@ -116,6 +120,7 @@ runner_sources=(
     "Molotov/Snatella" "https://api.github.com/repos/snatella/wine-runner-sc/releases"
     "/dev/null" "https://api.github.com/repos/gort818/wine-sc-lug/releases"
     "GloriousEggroll" "https://api.github.com/repos/GloriousEggroll/wine-ge-custom/releases"
+    "TKG" "https://api.github.com/repos/Frogging-Family/wine-tkg-git/releases"
 )
 
 ######## DXVK ##############################################################
@@ -130,6 +135,7 @@ dxvk_dir="$data_dir/lutris/runtime/dxvk"
 dxvk_sources=(
     "Sporif Async" "https://api.github.com/repos/Sporif/dxvk-async/releases"
     "/dev/null" "https://api.github.com/repos/gort818/dxvk/releases"
+    "gnusenpai" "https://api.github.com/repos/gnusenpai/dxvk/releases"
 )
 
 # Set a maximum number of versions to display from each download url
@@ -139,7 +145,7 @@ max_download_items=20
 # used to dynamically determine the height of menus
 menu_option_height="25"
 
-############################################################################
+######## Bundled Files #####################################################
 
 # Use logo installed by a packaged version of this script if available
 # Otherwise, default to the logo in the same directory
@@ -151,13 +157,23 @@ else
     lug_logo="info"
 fi
 
-# Lutris install script
+# Use Lutris install script installed by a packaged version of this script if available
-install_script="$helper_dir/lug-lutris-install.json"
+# Otherwise, default to the json in the same directory
+if [ -f "/usr/share/lug-helper/lug-lutris-install.json" ]; then
+    install_script="/usr/share/lug-helper/lug-lutris-install.json"
+else
+    install_script="$helper_dir/lug-lutris-install.json"
+fi
+
+######## Links #############################################################
+
+# LUG Wiki
+lug_wiki="https://github.com/starcitizen-lug/information-howtos/wiki"
 
 # Github repo and script version info
 repo="starcitizen-lug/lug-helper"
 releases_url="https://github.com/$repo/releases"
-current_version="v1.14"
+current_version="v1.21"
 
 ############################################################################
 ############################################################################
@@ -334,7 +350,7 @@ menu() {
         done
         
         # Display the zenity radio button menu
-        choice="$(zenity --list --radiolist --width="480" --height="$menu_height" --text="$menu_text_zenity" --title="Star Citizen LUG Helper" --hide-header --cancel-label "$cancel_label" --window-icon=$lug_logo --column="" --column="Option" "${zen_options[@]}" 2>/dev/null)"
+        choice="$(zenity --list --radiolist --width="480" --height="$menu_height" --text="$menu_text_zenity" --title="Star Citizen LUG Helper" --hide-header --cancel-label "$cancel_label" --window-icon="$lug_logo" --column="" --column="Option" "${zen_options[@]}" 2>/dev/null)"
 
         # Loop through the options array to match the chosen option
         matched="false"
@@ -421,7 +437,7 @@ getdirs() {
     # If we don't have the directory paths we need yet,
     # ask the user to provide them
     if [ -z "$wine_prefix" ] || [ -z "$game_path" ]; then
-        message info "Star Citizen must be installed before proceeding.\n\nAt the next screen, please select your Star Citizen WINE prefix.\nIt will be remembered for future use."
+        message info "Star Citizen must be installed before proceeding.\n\nAt the next screen, please select your Star Citizen install directory (WINE prefix)\nIt will be remembered for future use.\n\nLutris default install path: ~/Games/star-citizen"
         if [ "$use_zenity" -eq 1 ]; then
             # Using Zenity file selection menus
             # Get the wine prefix directory
@@ -448,7 +464,7 @@ getdirs() {
                             message warning "An unexpected error has occurred. The Helper is unable to proceed."
                             return 1
                         elif [ "$(basename "$game_path")" != "$sc_base_dir" ]; then
-                            message warning "You must select the Star Citizen base game directory.\n\nFor Example:  prefix/drive_c/Program Files/Roberts Space Industries/StarCitizen"
+                            message warning "You must select the base game directory named '$sc_base_dir'\n\nie. [prefix]/drive_c/Program Files/Roberts Space Industries/StarCitizen"
                         else
                             # All good or cancel
                             break
@@ -512,7 +528,7 @@ getdirs() {
     # The location within the USER directory to which the game exports keybinds
     keybinds_dir="$user_dir/Controls/Mappings"
     # Shaders directory
-    shaders_dir="$user_dir/shaders"
+    shaders_dir="$wine_prefix/$appdata_path/shaders"
     # dxvk cache file
     dxvk_cache="$game_path/$live_or_ptu/StarCitizen.dxvk-cache"
     # Where to store backed up keybinds
@@ -629,8 +645,8 @@ mapcount_once() {
 mapcount_set() {
     if [ -d "/etc/sysctl.d" ]; then
         # Newer versions of sysctl
-        preflight_actions+=('printf "\n# Added by LUG-Helper:\nvm.max_map_count = 16777216\n" >> /etc/sysctl.d/20-max_map_count.conf && sysctl --system')
+        preflight_actions+=('printf "\n# Added by LUG-Helper:\nvm.max_map_count = 16777216\n" > /etc/sysctl.d/20-starcitizen-max_map_count.conf && sysctl --system')
-        preflight_results+=("The vm.max_map_count configuration has been appended to:\n/etc/sysctl.d/20-max_map_count.conf")
+        preflight_results+=("The vm.max_map_count configuration has been appended to:\n/etc/sysctl.d/20-starcitizen-max_map_count.conf")
     else
         # Older versions of sysctl
         preflight_actions+=('printf "\n# Added by LUG-Helper:\nvm.max_map_count = 16777216" >> /etc/sysctl.conf && sysctl -p')
@@ -665,7 +681,7 @@ mapcount_check() {
         # Add info for manually changing the setting
         if [ -d "/etc/sysctl.d" ]; then
             # Newer versions of sysctl
-            preflight_manual+=("To change vm.max_map_count permanently, add the following line to\n'/etc/sysctl.d/20-max_map_count.conf' and reload with 'sudo sysctl --system':\n    vm.max_map_count = 16777216\n\nOr, to change vm.max_map_count temporarily until next boot, run:\n    sudo sysctl -w vm.max_map_count=16777216")
+            preflight_manual+=("To change vm.max_map_count permanently, add the following line to\n'/etc/sysctl.d/20-starcitizen-max_map_count.conf' and reload with 'sudo sysctl --system'\n    vm.max_map_count = 16777216\n\nOr, to change vm.max_map_count temporarily until next boot, run:\n    sudo sysctl -w vm.max_map_count=16777216")
         else
             # Older versions of sysctl
             preflight_manual+=("To change vm.max_map_count permanently, add the following line to\n'/etc/sysctl.conf' and reload with 'sudo sysctl -p':\n    vm.max_map_count = 16777216\n\nOr, to change vm.max_map_count temporarily until next boot, run:\n    sudo sysctl -w vm.max_map_count=16777216")
@@ -689,8 +705,8 @@ filelimit_set() {
     if [ -f "/etc/systemd/system.conf" ]; then
         # Using systemd
         # Append to the file
-        preflight_actions+=('printf "\n# Added by LUG-Helper:\nDefaultLimitNOFILE=524288\n" >> /etc/systemd/system.conf && systemctl daemon-reexec')
+        preflight_actions+=('mkdir -p /etc/systemd/system.conf.d && printf "[Manager]\n# Added by LUG-Helper:\nDefaultLimitNOFILE=524288\n" > /etc/systemd/system.conf.d/20-starcitizen-filelimit.conf && systemctl daemon-reexec')
-        preflight_results+=("The open files limit configuration has been appended to:\n/etc/systemd/system.conf")
+        preflight_results+=("The open files limit configuration has been added to:\n/etc/systemd/system.conf.d/20-starcitizen-filelimit.conf")
     elif [ -f "/etc/security/limits.conf" ]; then
         # Using limits.conf
         # Insert before the last line in the file
@@ -722,7 +738,7 @@ filelimit_check() {
         # Add info for manually changing the settings
         if [ -f "/etc/systemd/system.conf" ]; then
             # Using systemd
-            preflight_manual+=("To change your open file descriptors limit, add the following line to\n'/etc/systemd/system.conf':\n    DefaultLimitNOFILE=524288")
+            preflight_manual+=("To change your open file descriptors limit, add the following to\n'/etc/systemd/system.conf.d/20-starcitizen-filelimit.conf':\n\n[Manager]\nDefaultLimitNOFILE=524288")
         elif [ -f "/etc/security/limits.conf" ]; then
             # Using limits.conf
             preflight_manual+=("To change your open file descriptors limit, add the following line to\n'/etc/security/limits.conf':\n    * hard nofile 524288")
@@ -735,6 +751,15 @@ filelimit_check() {
 
 #------------------------- end filelimit functions ---------------------------#
 
+# Check if WINE is installed
+wine_check() {
+    if [ -x "$(command -v wine)" ]; then
+        preflight_pass+=("Wine is installed on your system.")  
+    else
+        preflight_fail+=("Wine does not appear to be installed.\nAt a minimum, wine dependencies must be installed.\nPlease refer to our Quick Start Guide:\n$lug_wiki")
+    fi
+}
+
 # Check total system memory
 memory_check() {
     memtotal="$(LC_NUMERIC=C awk '/MemTotal/ {printf "%.1f \n", $2/1024/1024}' /proc/meminfo)"
@@ -754,73 +779,130 @@ avx_check() {
     fi
 }
 
+# Check if swap is set up
+swap_check() {
+    if cat /proc/swaps | grep -vq "Filename"; then
+        preflight_pass+=("You have swap space configured.")  
+    else
+        preflight_fail+=("You don't appear to have swap space configured.\nWe recommend configuring an 8-16 GB swap file.")
+    fi
+}
+
+# Check that the system is optimized for Star Citizen
+preflight_check() {
+    # Initialize variables
+    unset preflight_pass
+    unset preflight_fail
+    unset preflight_action_funcs
+    unset preflight_actions
+    unset preflight_results
+    unset preflight_manual
+    unset preflight_followup
+    
+    # Call the optimization functions to perform the checks
+    wine_check
+    memory_check
+    swap_check
+    avx_check
+    mapcount_check
+    filelimit_check
+
+    # Populate info strings with the results and add formatting
+    if [ "${#preflight_pass[@]}" -gt 0 ]; then
+        preflight_pass_string="Passed Checks:"
+        for (( i=0; i<"${#preflight_pass[@]}"; i++ )); do
+            preflight_pass_string="$preflight_pass_string\n- ${preflight_pass[i]//\\n/\\n    }"
+        done
+        # Add extra newlines if there are also failures to report
+        if [ "${#preflight_fail[@]}" -gt 0 ]; then
+            preflight_pass_string="$preflight_pass_string\n\n"
+        fi
+    fi
+    if [ "${#preflight_fail[@]}" -gt 0 ]; then
+        preflight_fail_string="Failed Checks:"
+        for (( i=0; i<"${#preflight_fail[@]}"; i++ )); do
+            if [ "$i" -eq 0 ]; then
+                preflight_fail_string="$preflight_fail_string\n- ${preflight_fail[i]//\\n/\\n    }"
+            else
+                preflight_fail_string="$preflight_fail_string\n\n- ${preflight_fail[i]//\\n/\\n    }"
+            fi
+        done
+    fi
+    for (( i=0; i<"${#preflight_manual[@]}"; i++ )); do
+        if [ "$i" -eq 0 ]; then
+            preflight_manual_string="${preflight_manual[i]}"
+        else
+            preflight_manual_string="$preflight_manual_string\n\n${preflight_manual[i]}"
+        fi
+    done
+
+    # Display the results of the preflight check
+    if [ -z "$preflight_fail_string" ]; then
+        # Formatting
+        message_heading="Preflight Check Complete"
+        if [ "$use_zenity" -eq 1 ]; then
+            message_heading="<b>$message_heading</b>"
+        fi
+        
+        message info "$message_heading\n\nYour system is optimized for Star Citizen!\n\n$preflight_pass_string"
+    else
+        if [ -z "$preflight_action_funcs" ]; then
+            message warning "$preflight_pass_string$preflight_fail_string"
+        elif message question "$preflight_pass_string$preflight_fail_string\n\nWould you like configuration issues to be fixed for you?"; then
+            # Call functions to build fixes for any issues found
+            for (( i=0; i<"${#preflight_action_funcs[@]}"; i++ )); do
+                ${preflight_action_funcs[i]}
+            done
+            # Populate a string of actions to be executed
+            for (( i=0; i<"${#preflight_actions[@]}"; i++ )); do
+                if [ "$i" -eq 0 ]; then
+                    preflight_actions_string="${preflight_actions[i]}"
+                else
+                    preflight_actions_string="$preflight_actions_string; ${preflight_actions[i]}"
+                fi
+            done
+
+            # Execute the actions set by the functions
+            if [ ! -z "$preflight_actions_string" ]; then
+                # Use pollkit's pkexec for gui with a fallback to sudo
+                if [ -x "$(command -v pkexec)" ]; then
+                    pkexec sh -c "$preflight_actions_string"
+                else
+                    sudo sh -c "$preflight_actions_string"
+                fi
+            fi
+
+            # Call any followup functions
+            for (( i=0; i<"${#preflight_followup[@]}"; i++ )); do
+                ${preflight_followup[i]}
+            done
+
+            # Populate the results string
+            for (( i=0; i<"${#preflight_results[@]}"; i++ )); do
+                if [ "$i" -eq 0 ]; then
+                    preflight_results_string="${preflight_results[i]}"
+                else
+                    preflight_results_string="$preflight_results_string\n\n${preflight_results[i]}"
+                fi
+            done
+
+            # Display the results
+            message info "$preflight_results_string"
+        else
+            # User declined to automatically fix configuration issues
+            # Show manual configuration options
+            if [ ! -z "$preflight_manual_string" ]; then
+                message info "$preflight_manual_string"
+            fi
+        fi
+    fi
+}
+
 #------------------------- end preflight check functions ---------------------#
 
-# Install Star Citizen using Lutris
+#------------------------- begin download functions ----------------------------#
-install_game() {
-    # Check if Lutris is installed
-    if [ ! -x "$(command -v lutris)" ]; then
-        message warning "Lutris is required but does not appear to be installed."
-        return 0
-    fi
-    # Check if the install script exists
-    if [ ! -f "$install_script" ]; then
-        message warning "Lutris install script not found.\n\n$install_script\n\nIt is included in our official releases here:\n$releases_url"
-        return 0
-    fi
 
-    lutris --install "$install_script" &
+# Restart lutris if necessary
-    message info "The installation will continue in Lutris"
-}
-
-# Delete the shaders directory
-rm_shaders() {
-    # Get/Set directory paths
-    getdirs
-    if [ "$?" -eq 1 ]; then
-        # User cancelled and wants to return to the main menu, or error
-        return 0
-    fi
-
-    # Sanity check
-    if [ ! -d "$shaders_dir" ]; then
-        message warning "Shaders directory not found. There is nothing to delete!\n\n$shaders_dir"
-        return 0
-    fi
-
-    # Delete the shader directory
-    if message question "The following directory will be deleted:\n\n$shaders_dir\n\nDo you want to proceed?"; then
-        debug_print continue "Deleting $shaders_dir..."
-        rm -r "$shaders_dir"
-        message info "Your shaders have been deleted!"
-    fi
-}
-
-# Delete DXVK cache
-rm_dxvkcache() {
-    # Get/Set directory paths
-    getdirs
-    if [ "$?" -eq 1 ]; then
-        # User cancelled and wants to return to the main menu
-        # or there was an error
-        return 0
-    fi
-
-    # Sanity check
-    if [ ! -f "$dxvk_cache" ]; then
-        message warning "Unable to find the DXVK cache file. There is nothing to delete!\n\n$dxvk_cache"
-        return 0
-    fi
-
-    # Delete the cache file
-    if message question "The following file will be deleted:\n\n$dxvk_cache\n\nDo you want to proceed?"; then
-        debug_print continue "Deleting $dxvk_cache..."
-        rm "$dxvk_cache"
-        message info "Your DXVK cache has been deleted!"
-    fi
-}
-
-# Restart lutris
 lutris_restart() {
     if [ "$lutris_needs_restart" = "true" ] && [ "$(pgrep lutris)" ]; then
         if message question "Lutris must be restarted to detect the changes.\nWould you like this Helper to restart it for you?"; then
@@ -831,22 +913,42 @@ lutris_restart() {
     lutris_needs_restart="false"
 }
 
-#------------------------- begin download functions ----------------------------#
+# Perform post-download actions, display messages or instructions
-
-# 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
+# Optional: post_download_msg_more_info and post_download_msg_link
 post_download() {
-    if [ "$trigger_post_download" = "true" ]; then
+    # Check if lutris needs to be restarted after making changes
+    lutris_restart
+    
+    if [ "$display_post_download_msg" = "true" ]; then
         message_heading="Download Complete"
         
+        # Format some variables for zenity
         if [ "$use_zenity" -eq 1 ]; then
             message_heading="<b>$message_heading</b>"
             post_download_msg_italics="<i>$post_download_msg_italics</i>"
+            
+            # If we have a link to provide, format it as well
+            if [ -n "$post_download_msg_link" ]; then
+                post_download_msg_link="<a href='$post_download_msg_link'>$post_download_msg_link</a>"
             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"
+
+        # Add newlines to the optional variables if set
+        if [ -n "$post_download_msg_more_info" ]; then
+            post_download_msg_more_info="\n\n$post_download_msg_more_info"
+        fi
+        if [ -n "$post_download_msg_link" ]; then
+            post_download_msg_link="\n$post_download_msg_link"
+        fi
+
+        # Display the info
+        message info "$message_heading\n\n$post_download_msg_text\n$post_download_msg_italics\n\n$downloaded_item_name$post_download_msg_more_info$post_download_msg_link"
+    fi
+
+    # Reset
+    display_post_download_msg="false"
 }
 
 # Uninstall the selected item
@@ -932,6 +1034,9 @@ download_install() {
         *.tar.xz)
             download_name="$(basename "$download_file" .tar.xz)"
             ;;
+        *.tar.zst)
+            download_name="$(basename "$download_file" .tar.zst)"
+            ;;
         *)
             debug_print exit "Unknown archive filetype in download_install function. Aborting."
             ;;
@@ -1028,7 +1133,7 @@ download_install() {
         # Store the final name of the downloaded directory
         downloaded_item_name="$download_name"
         # Trigger the post_download() function
-        trigger_post_download="true"
+        display_post_download_msg="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
@@ -1046,7 +1151,7 @@ download_install() {
         # Store the final name of the downloaded directory
         downloaded_item_name="$download_name"
         # Trigger the post_download() function
-        trigger_post_download="true"
+        display_post_download_msg="true"
     else
         # Some unexpected combination of directories and files
         debug_print exit "Script error:  Unexpected archive contents in download_install function. Aborting"
@@ -1056,9 +1161,6 @@ download_install() {
     # Cleanup tmp download
     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
@@ -1086,11 +1188,13 @@ download_select_install() {
     esac
 
     # For runners, check GlibC version against runner requirements
-    if [ "download_type" = "runner" ] && [ "$contributor_name" = "/dev/null" ]; then
+    if [ "$download_type" = "runner" ] && [ "$contributor_name" = "/dev/null" ]; then
         required_glibc="2.33"
         system_glibc="$(ldd --version | awk '/ldd/{print $NF}')"
 
-        if [ "$(bc <<< "$required_glibc > $system_glibc")" = "1" ]; then
+        # Sort the versions and check if the installed glibc is smaller
+        if [ "$required_glibc" != "$system_glibc" ] &&
+           [ "$system_glibc" = "$(printf "$system_glibc\n$required_glibc" | sort -V | head -n1)" ]; then
             message warning "Your glibc version is incompatible with the selected runner.\n\nSystem glibc: v$system_glibc\nMinimum required glibc: v$required_glibc"
             return 1
         fi
@@ -1135,13 +1239,19 @@ download_select_install() {
             *.tar.xz)
                 download_name="$(basename "${download_versions[i]}" .tar.xz)"
                 ;;
+            *.tar.zst)
+                download_name="$(basename "${download_versions[i]}" .tar.zst)"
+                ;;
             *)
-                debug_print exit "Unknown archive filetype in download_select_install function. Aborting."
+                download_name="skip"
+                debug_print continue "Unknown archive filetype in download_select_install function. Offending String: ${download_versions[i]}"
                 ;;
         esac
 
         # Add the file names to the menu
-        if [ -d "$download_dir/$download_name" ]; then
+         if [[ "$download_name" = "skip" ]] || [[ "${download_versions[i]}" = "proton"* ]] ; then # filter out other file types or proton-downloads (needed for TKG)
+            continue
+        elif [ -d "$download_dir/$download_name" ]; then
             menu_options+=("$download_name    [installed]")
         else
             menu_options+=("$download_name")
@@ -1240,19 +1350,16 @@ download_manage() {
        
         # Call the menu function.  It will use the options as configured above
         menu
+        # Perform post-download actions and display messages or instructions
+        post_download
     done
-    
-    # Check if lutris needs to be restarted after making changes
-    lutris_restart
 }
 
-#-------------------------- end download functions -----------------------------#
-
 # Configure the download_manage function for runners
 runner_manage() {
     # Set some defaults
     lutris_needs_restart="false"
-    trigger_post_download="false"
+    display_post_download_msg="false"
 
     # Use indirect expansion to point download_sources
     # to the runner_sources array set at the top of the script
@@ -1269,9 +1376,13 @@ runner_manage() {
     # 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
+    # Then, the downloaded directory name is automatically displayed
-    post_download_msg_text="Select the runner in Lutris from the dropdown menu"
+    # Optional variables post_download_msg_more_info and
+    # post_download_msg_link will be displayed if set
+    post_download_msg_text="Select the following runner in Lutris from the dropdown menu under:"
     post_download_msg_italics="Configure->Runner Options->Wine version"
+    post_download_msg_more_info=""
+    post_download_msg_link=""
 
     # Call the download_manage function with the above configuration
     # The argument passed to the function is used for special handling
@@ -1283,7 +1394,7 @@ runner_manage() {
 dxvk_manage() {
     # Set some defaults
     lutris_needs_restart="false"
-    trigger_post_download="false"
+    display_post_download_msg="false"
 
     # Use indirect expansion to point download_sources
     # to the dxvk_sources array set at the top of the script
@@ -1291,8 +1402,8 @@ dxvk_manage() {
     download_dir="$dxvk_dir"
 
     # Configure the text displayed in the menus
-    download_menu_heading="DXVK Versions"
+    download_menu_heading="Lutris DXVK Versions"
-    download_menu_description="The DXVK versions below may help improve game performance"
+    download_menu_description="The DXVK versions below may help reduce stuttering"
     download_menu_height="140"
 
     # Set the post download instructions
@@ -1300,9 +1411,13 @@ dxvk_manage() {
     # 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
+    # Then, the downloaded directory name is automatically displayed
-    post_download_msg_text="Type the DXVK folder name in your Lutris settings"
+    # Optional variables post_download_msg_more_info and
+    # post_download_msg_link will be displayed if set
+    post_download_msg_text="Type the following DXVK name into your Lutris settings under:"
     post_download_msg_italics="Configure->Runner Options->DXVK version"
+    post_download_msg_more_info="See our wiki for instructions on setting the DXVK_ASYNC environment variable in Lutris:"
+    post_download_msg_link="https://github.com/starcitizen-lug/information-howtos/wiki/Performance-Tuning#dxvk-async"
 
     # Call the download_manage function with the above configuration
     # The argument passed to the function is used for special handling
@@ -1310,115 +1425,7 @@ dxvk_manage() {
     download_manage "dxvk"
 }
 
-#-------------------------- end dxvk functions -----------------------------#
+#-------------------------- end download functions -----------------------------#
-
-# Check that the system is optimized for Star Citizen
-preflight_check() {
-    # Initialize variables
-    unset preflight_pass
-    unset preflight_fail
-    unset preflight_action_funcs
-    unset preflight_actions
-    unset preflight_results
-    unset preflight_manual
-    unset preflight_followup
-    
-    # Call the optimization functions to perform the checks
-    memory_check
-    avx_check
-    mapcount_check
-    filelimit_check
-
-    # Populate info strings with the results and add formatting
-    if [ "${#preflight_pass[@]}" -gt 0 ]; then
-        preflight_pass_string="Passed Checks:"
-        for (( i=0; i<"${#preflight_pass[@]}"; i++ )); do
-            preflight_pass_string="$preflight_pass_string\n- ${preflight_pass[i]//\\n/\\n    }"
-        done
-        # Add extra newlines if there are also failures to report
-        if [ "${#preflight_fail[@]}" -gt 0 ]; then
-            preflight_pass_string="$preflight_pass_string\n\n"
-        fi
-    fi
-    if [ "${#preflight_fail[@]}" -gt 0 ]; then
-        preflight_fail_string="Failed Checks:"
-        for (( i=0; i<"${#preflight_fail[@]}"; i++ )); do
-            if [ "$i" -eq 0 ]; then
-                preflight_fail_string="$preflight_fail_string\n- ${preflight_fail[i]//\\n/\\n    }"
-            else
-                preflight_fail_string="$preflight_fail_string\n\n- ${preflight_fail[i]//\\n/\\n    }"
-            fi
-        done
-    fi
-    for (( i=0; i<"${#preflight_manual[@]}"; i++ )); do
-        if [ "$i" -eq 0 ]; then
-            preflight_manual_string="${preflight_manual[i]}"
-        else
-            preflight_manual_string="$preflight_manual_string\n\n${preflight_manual[i]}"
-        fi
-    done
-
-    # Display the results of the preflight check
-    if [ -z "$preflight_fail_string" ]; then
-        # Formatting
-        message_heading="Preflight Check Complete"
-        if [ "$use_zenity" -eq 1 ]; then
-            message_heading="<b>$message_heading</b>"
-        fi
-        
-        message info "$message_heading\n\nYour system is optimized for Star Citizen!\n\n$preflight_pass_string"
-    else
-        if [ -z "$preflight_action_funcs" ]; then
-            message warning "$preflight_pass_string$preflight_fail_string"
-        elif message question "$preflight_pass_string$preflight_fail_string\n\nWould you like configuration issues to be fixed for you?"; then
-            # Call functions to build fixes for any issues found
-            for (( i=0; i<"${#preflight_action_funcs[@]}"; i++ )); do
-                ${preflight_action_funcs[i]}
-            done
-            # Populate a string of actions to be executed
-            for (( i=0; i<"${#preflight_actions[@]}"; i++ )); do
-                if [ "$i" -eq 0 ]; then
-                    preflight_actions_string="${preflight_actions[i]}"
-                else
-                    preflight_actions_string="$preflight_actions_string; ${preflight_actions[i]}"
-                fi
-            done
-
-            # Execute the actions set by the functions
-            if [ ! -z "$preflight_actions_string" ]; then
-                # Use pollkit's pkexec for gui with a fallback to sudo
-                if [ -x "$(command -v pkexec)" ]; then
-                    pkexec sh -c "$preflight_actions_string"
-                else
-                    sudo sh -c "$preflight_actions_string"
-                fi
-            fi
-
-            # Call any followup functions
-            for (( i=0; i<"${#preflight_followup[@]}"; i++ )); do
-                ${preflight_followup[i]}
-            done
-
-            # Populate the results string
-            for (( i=0; i<"${#preflight_results[@]}"; i++ )); do
-                if [ "$i" -eq 0 ]; then
-                    preflight_results_string="${preflight_results[i]}"
-                else
-                    preflight_results_string="$preflight_results_string\n\n${preflight_results[i]}"
-                fi
-            done
-
-            # Display the results
-            message info "$preflight_results_string"
-        else
-            # User declined to automatically fix configuration issues
-            # Show manual configuration options
-            if [ ! -z "$preflight_manual_string" ]; then
-                message info "$preflight_manual_string"
-            fi
-        fi
-    fi
-}
 
 # Deploy Easy Anti-Cheat Workaround
 eac_workaround() {
@@ -1434,9 +1441,9 @@ eac_workaround() {
     eac_dir="$wine_prefix/drive_c/users/$USER/AppData/Roaming/EasyAntiCheat"
     eac_hosts="127.0.0.1 modules-cdn.eac-prod.on.epicgames.com"
 
-    # Check if EAC is installed
+    # Check if EAC workaround is already applied
-    if [ ! -d "$eac_dir" ]; then
+    if grep "$eac_hosts" /etc/hosts; then
-        message info "Easy Anti-Cheat does not appear to be installed yet.\nThere is nothing to do!"
+        message info "The Easy Anti-Cheat workaround has already been applied.\nYou're all set!"
         return 1
     fi
 
@@ -1460,13 +1467,95 @@ eac_workaround() {
             sudo sh -c "echo $eac_hosts '#Star Citizen EAC workaround' >> /etc/hosts"
         fi
 
+        # Delete the EAC directory if it exists
+        if [ -d "$eac_dir" ]; then
             debug_print continue "Deleting $eac_dir..."
             rm -r "$eac_dir"
+        fi
 
         message info "Easy Anti-Cheat workaround has been deployed!"
     fi
 }
 
+# Install Star Citizen using Lutris
+install_game() {
+    # Check if Lutris is installed
+    if [ ! -x "$(command -v lutris)" ]; then
+        message warning "Lutris is required but does not appear to be installed."
+        return 0
+    fi
+    # Check if the install script exists
+    if [ ! -f "$install_script" ]; then
+        message warning "Lutris install script not found.\n\n$install_script\n\nIt is included in our official releases here:\n$releases_url"
+        return 0
+    fi
+
+    if message question "Before proceeding, please refer to our Quick Start Guide:\n\n$lug_wiki\n\nAre you ready to continue?"; then
+        lutris --install "$install_script" &
+        message info "The installation will continue in Lutris"
+    fi
+}
+
+# Display the LUG Wiki
+display_wiki() {
+    # Display a message containing the URL
+    message info "See the Wiki for our Quick-Start Guide, Manual Installation instructions,\nPerformance Tuning, and Common Issues and Solutions:\n\n$lug_wiki"
+}
+
+# Delete the shaders directory
+rm_shaders() {
+    # Get/Set directory paths
+    getdirs
+    if [ "$?" -eq 1 ]; then
+        # User cancelled and wants to return to the main menu, or error
+        return 0
+    fi
+    
+    # Create an array containing all directories in the appdata_path
+    for appdata_list in "$wine_prefix/$appdata_path"/*; do
+        if [ -d "$appdata_list" ]; then
+            appdata_items+=("$appdata_list")
+        fi
+    done
+
+    # Delete shaders directory in every directory beginning with "sc-alpha"
+    for (( i=0; i<"${#appdata_items[@]}"; i++ )); do
+        if [[ "${appdata_items[i]}" = "$wine_prefix/$appdata_path"/sc-alpha* ]]  && [[  -d "${appdata_items[i]}"/shaders ]]; then  # check if the item in the array begins with sc-alpha
+            if message question "The following directory will be deleted:\n\n${appdata_items[i]}/shaders\n\nDo you want to proceed?"; then
+                    debug_print continue "Deleting ${appdata_items[i]}/shaders..."
+                    rm -r "${appdata_items[i]}/shaders"
+                    message info "Your shaders have been deleted!"
+            fi
+        elif [ $i = $(( "${#appdata_items[@]}" - 1 )) ]; then # display message when end of array is reached and no shaders or sc-alpha directories were found
+                message info "No more shader directories found"
+        fi
+    done
+}
+
+# Delete DXVK cache
+rm_dxvkcache() {
+    # Get/Set directory paths
+    getdirs
+    if [ "$?" -eq 1 ]; then
+        # User cancelled and wants to return to the main menu
+        # or there was an error
+        return 0
+    fi
+
+    # Sanity check
+    if [ ! -f "$dxvk_cache" ]; then
+        message warning "Unable to find the DXVK cache file. There is nothing to delete!\n\n$dxvk_cache"
+        return 0
+    fi
+
+    # Delete the cache file
+    if message question "The following file will be deleted:\n\n$dxvk_cache\n\nDo you want to proceed?"; then
+        debug_print continue "Deleting $dxvk_cache..."
+        rm "$dxvk_cache"
+        message info "Your DXVK cache has been deleted!"
+    fi
+}
+
 # Show maintenance/troubleshooting options
 maintenance_menu() {
     # Loop the menu until the user selects quit
@@ -1483,13 +1572,14 @@ maintenance_menu() {
         shaders_msg="Delete my shaders folder only (Do this after each game update)"
         vidcache_msg="Delete my DXVK cache"
         dirs_msg="Display Helper and Star Citizen directories"
+        wiki_msg="Show the LUG Wiki"
         reset_msg="Reset Helper configs"
         quit_msg="Return to the main menu"
         
         # Set the options to be displayed in the menu
-        menu_options=("$version_msg" "$sanitize_msg" "$shaders_msg" "$vidcache_msg" "$dirs_msg" "$reset_msg" "$quit_msg")
+        menu_options=("$version_msg" "$sanitize_msg" "$shaders_msg" "$vidcache_msg" "$dirs_msg" "$wiki_msg" "$reset_msg" "$quit_msg")
         # Set the corresponding functions to be called for each of the options
-        menu_actions=("set_version" "sanitize" "rm_shaders" "rm_dxvkcache" "display_dirs" "reset_helper" "menu_loop_done")
+        menu_actions=("set_version" "sanitize" "rm_shaders" "rm_dxvkcache" "display_dirs" "display_wiki" "reset_helper" "menu_loop_done")
 
         # Calculate the total height the menu should be
         menu_height="$(($menu_option_height * ${#menu_options[@]} + $menu_text_height))"
@@ -1505,7 +1595,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" "STAR-YD4Z-TQZV" "STAR-XLN7-9XNJ" "STAR-N62T-2R39" "STAR-3S3D-9HXQ" "STAR-TRZF-NMCV" "STAR-TLLJ-SMG4")
+    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" "STAR-MFT6-Q44H" "STAR-TZX2-TPWF")
     # 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")]}"
@@ -1568,20 +1658,6 @@ fi
 # Set defaults
 live_or_ptu="$live_dir"
 
-# Check if a newer verison of the script is available
-latest_version="$(get_latest_release "$repo")"
-
-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
-        releases_url_formatted="$releases_url"
-    fi
-    
-    message info "The latest version of the LUG Helper is $latest_version\nYou are using $current_version\n\nYou can download new releases here:\n$releases_url_formatted"
-fi
-
 # If invoked with command line arguments, process them and exit
 if [ "$#" -gt 0 ]; then
     while [ "$#" -gt 0 ]
@@ -1680,6 +1756,22 @@ Usage: lug-helper <options>
     fi
 fi
 
+# Format some URLs for Zenity
+if [ "$use_zenity" -eq 1 ]; then
+    releases_url="<a href='$releases_url'>$releases_url</a>"
+    lug_wiki="<a href='$lug_wiki'>$lug_wiki</a>"
+fi
+
+# Check if a newer verison of the script is available
+latest_version="$(get_latest_release "$repo")"
+
+# Sort the versions and check if the installed Helper is smaller
+if [ "$latest_version" != "$current_version" ] &&
+   [ "$current_version" = "$(printf "$current_version\n$latest_version" | sort -V | head -n1)" ]; then
+
+    message info "The latest version of the LUG Helper is $latest_version\nYou are using $current_version\n\nYou can download new releases here:\n$releases_url"
+fi
+
 # Loop the main menu until the user selects quit
 while true; do
     # Configure the menu
@@ -1692,7 +1784,7 @@ while true; do
     install_msg="Install Star Citizen"
     eac_msg="Deploy Easy Anti-Cheat Workaround"
     runners_msg="Manage Lutris Runners"
-    dxvk_msg="Manage DXVK Versions"
+    dxvk_msg="Manage Lutris DXVK Versions"
     maintenance_msg="Maintenance and Troubleshooting"
     randomizer_msg="Get a random Penguin's Star Citizen referral code"
     quit_msg="Quit"

lug-lutris-install.json

@@ -30,7 +30,7 @@
       "script": {
         "files": [
           {
-            "client": "https://install.robertsspaceindustries.com/star-citizen/RSI-Setup-1.5.4.exe"
+            "client": "https://install.robertsspaceindustries.com/star-citizen/RSI-Setup-1.5.5.exe"
           }
         ],
         "game": {
@@ -80,11 +80,12 @@
           "dxvk": true,
           "esync": true,
           "overrides": {
-            "nvapi,nvapi64": "disabled"
+            "nvapi,nvapi64": "disabled",
-          },
+            "libglesv2": "builtin"
+          }
         }
       },
-      "content": "files:\n- client: https://install.robertsspaceindustries.com/star-citizen/RSI-Setup-1.5.4.exe\ngame:\n  arch: win64\n  args: null\n  exe: drive_c/Program Files/Roberts Space Industries/RSI Launcher/RSI Launcher.exe\n  prefix: $GAMEDIR\ninstaller:\n- task:\n    arch: win64\n    description: Creating Wine prefix\n    name: create_prefix\n    prefix: $GAMEDIR\n- task:\n    app: --force arial vcrun2019 win10\n    arch: win64\n    description: Installing dlls\n    name: winetricks\n    prefix: $GAMEDIR\n- task:\n    arch: win64\n    args: /S\n    description: Installing client\n    executable: client\n    name: wineexec\n    prefix: $GAMEDIR\nsystem:\n  env:\n    DXVK_HUD: '0'\n    __GL_SHADER_DISK_CACHE: 1\n    __GL_SHADER_DISK_CACHE_SIZE: '1073741824'\n    __GL_THREADED_OPTIMIZATIONS: '1'\nwine:\n  dxvk: true\n  esync: true\n  overrides:\n    nvapi,nvapi64: disabled\n"
+      "content": "files:\n- client: https://install.robertsspaceindustries.com/star-citizen/RSI-Setup-1.5.5.exe\ngame:\n  arch: win64\n  args: null\n  exe: drive_c/Program Files/Roberts Space Industries/RSI Launcher/RSI Launcher.exe\n  prefix: $GAMEDIR\ninstaller:\n- task:\n    arch: win64\n    description: Creating Wine prefix\n    name: create_prefix\n    prefix: $GAMEDIR\n- task:\n    app: --force arial vcrun2019 win10\n    arch: win64\n    description: Installing dlls\n    name: winetricks\n    prefix: $GAMEDIR\n- task:\n    arch: win64\n    args: /S\n    description: Installing client\n    executable: client\n    name: wineexec\n    prefix: $GAMEDIR\nsystem:\n  env:\n    DXVK_HUD: '0'\n    __GL_SHADER_DISK_CACHE: 1\n    __GL_SHADER_DISK_CACHE_SIZE: '1073741824'\n    __GL_THREADED_OPTIMIZATIONS: '1'\nwine:\n  dxvk: true\n  esync: true\n  overrides:\n    nvapi,nvapi64: disabled\n    libglesv2: builtin\n"
     }
   ]
 }