added download option for TKG runners

3.17 shaders

README.md

@@ -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

@@ -85,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")"
@@ -102,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 ###########################################################
@@ -118,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 ##############################################################
@@ -132,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
@@ -169,7 +173,7 @@ 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.15"
+current_version="v1.21"
 
 ############################################################################
 ############################################################################
@@ -346,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"
@@ -460,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
@@ -524,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
@@ -641,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')
@@ -677,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")
@@ -701,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
@@ -734,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")
@@ -775,6 +779,15 @@ 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
@@ -789,6 +802,7 @@ preflight_check() {
     # Call the optimization functions to perform the checks
     wine_check
     memory_check
+    swap_check
     avx_check
     mapcount_check
     filelimit_check
@@ -902,6 +916,7 @@ lutris_restart() {
 # Perform post-download actions, display messages or instructions
 # 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() {
     # Check if lutris needs to be restarted after making changes
     lutris_restart
@@ -909,12 +924,30 @@ post_download() {
     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
         fi
-        message info "$message_heading\n\n$post_download_msg_text\n$post_download_msg_italics\n\n$downloaded_item_name"
+
+        # 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"
 }
 
@@ -1001,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."
             ;;
@@ -1203,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")
@@ -1334,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
+    # 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
@@ -1356,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
@@ -1365,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
+    # 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
@@ -1391,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
 
@@ -1417,8 +1467,11 @@ eac_workaround() {
             sudo sh -c "echo $eac_hosts '#Star Citizen EAC workaround' >> /etc/hosts"
         fi
 
-        debug_print continue "Deleting $eac_dir..."
+        # Delete the EAC directory if it exists
-        rm -r "$eac_dir"
+        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
@@ -1458,18 +1511,25 @@ rm_shaders() {
         return 0
     fi
     
-    # Sanity check
+    # Create an array containing all directories in the appdata_path
-    if [ ! -d "$shaders_dir" ]; then
+    for appdata_list in "$wine_prefix/$appdata_path"/*; do
-        message warning "Shaders directory not found. There is nothing to delete!\n\n$shaders_dir"
+        if [ -d "$appdata_list" ]; then
-        return 0
+            appdata_items+=("$appdata_list")
-    fi
+        fi
+    done
 
-    # Delete the shader directory
+    # Delete shaders directory in every directory beginning with "sc-alpha"
-    if message question "The following directory will be deleted:\n\n$shaders_dir\n\nDo you want to proceed?"; then
+    for (( i=0; i<"${#appdata_items[@]}"; i++ )); do
-        debug_print continue "Deleting $shaders_dir..."
+        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
-        rm -r "$shaders_dir"
+            if message question "The following directory will be deleted:\n\n${appdata_items[i]}/shaders\n\nDo you want to proceed?"; then
-        message info "Your shaders have been deleted!"
+                    debug_print continue "Deleting ${appdata_items[i]}/shaders..."
-    fi
+                    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
@@ -1724,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": {
@@ -81,11 +81,11 @@
           "esync": true,
           "overrides": {
             "nvapi,nvapi64": "disabled",
-            "libglesv2": "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    libglesv2: 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"
     }
   ]
 }