Update swap message

Add libglesv2 override to fix white launcher window

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!
-2. Run it!
-3. If you want, move *lug-logo.png* to */usr/share/pixmaps/*
+1. Download it! https://github.com/starcitizen-lug/lug-helper/releases
+2. Extract it!
+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")"
@@ -139,7 +141,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,16 +153,23 @@ else
     lug_logo="info"
 fi
 
-# Lutris install script
-install_script="$helper_dir/lug-lutris-install.json"
+# Use Lutris install script installed by a packaged version of this script if available
+# 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"
-
-# LUG Wiki
-lug_wiki="https://github.com/starcitizen-lug/information-howtos/wiki"
+current_version="v1.18"
 
 ############################################################################
 ############################################################################
@@ -451,7 +460,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
@@ -632,8 +641,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_results+=("The vm.max_map_count configuration has been appended to:\n/etc/sysctl.d/20-max_map_count.conf")
+        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-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')
@@ -668,7 +677,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")
@@ -692,8 +701,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_results+=("The open files limit configuration has been appended to:\n/etc/systemd/system.conf")
+        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 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
@@ -725,7 +734,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")
@@ -766,6 +775,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
@@ -780,6 +798,7 @@ preflight_check() {
     # Call the optimization functions to perform the checks
     wine_check
     memory_check
+    swap_check
     avx_check
     mapcount_check
     filelimit_check
@@ -893,6 +912,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
@@ -900,12 +920,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"
 }
 
@@ -1143,11 +1181,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
@@ -1323,9 +1363,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
@@ -1345,8 +1389,8 @@ dxvk_manage() {
     download_dir="$dxvk_dir"
 
     # Configure the text displayed in the menus
-    download_menu_heading="DXVK Versions"
-    download_menu_description="The DXVK versions below may help improve game performance"
+    download_menu_heading="Lutris DXVK Versions"
+    download_menu_description="The DXVK versions below may help reduce stuttering"
     download_menu_height="140"
 
     # Set the post download instructions
@@ -1354,9 +1398,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
@@ -1380,9 +1428,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
-    if [ ! -d "$eac_dir" ]; then
-        message info "Easy Anti-Cheat does not appear to be installed yet.\nThere is nothing to do!"
+    # Check if EAC workaround is already applied
+    if grep "$eac_hosts" /etc/hosts; then
+        message info "The Easy Anti-Cheat workaround has already been applied.\nYou're all set!"
         return 1
     fi
 
@@ -1406,8 +1454,11 @@ eac_workaround() {
             sudo sh -c "echo $eac_hosts '#Star Citizen EAC workaround' >> /etc/hosts"
         fi
 
-        debug_print continue "Deleting $eac_dir..."
-        rm -r "$eac_dir"
+        # 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
@@ -1432,6 +1483,12 @@ install_game() {
     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
@@ -1495,13 +1552,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))"
@@ -1580,20 +1638,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 ]
@@ -1692,6 +1736,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
@@ -1704,7 +1764,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"
     }
   ]
 }