#!/usr/bin/env bash ############################################################################ # Star Citizen's Linux Users Group Helper Script ############################################################################ # # Greetings, Space Penguin! # # # This script is designed to help you manage and optimize # Star Citizen on Linux. # # Features: # # - Check your system for optimal settings and # change them as needed to prevent crashes. # # - Install Star Citizen using a bundled Lutris install script # # - Easily install and remove Lutris wine Runners and DXVK versions. # # - Qickly wipe your Star Citizen USER folder as is recommended # by CIG after major version updates. # It will back up your exported keybinds, delete your USER folder, # then restore your keybind file(s). # # - Get a random participating LUG member's Star Citizen referral code. # # - Supports both the LIVE and PTU environments. # # - Zenity menus are used for a GUI experience with a fallback to # terminal-based menus where Zenity is unavailable. # # # To export your keybinds from within the game, go to # Options->Keybindings->Control Profiles->Save Control Settings # # To import your keybinds from within the game, select them from the list: # Options->Keybindings->Control Profiles # # # made with <3 # Author: https://github.com/the-sane # Contributor: https://github.com/Termuellinator # Contributor: https://github.com/pstn # Contributor: https://github.com/gort818 # Contributor: https://github.com/victort # Contributor: https://github.com/Wrzlprnft # Runner Downloader inspired by: # https://github.com/richardtatum/sc-runner-updater # # License: GPLv3.0 ############################################################################ # Check if script is run as root if [ "$(id -u)" -eq 0 ]; then echo "This script is not supposed to be run as root!" exit 1 fi # Check for dependencies if [ ! -x "$(command -v curl)" ]; then # Print to stderr and also try warning the user through notify-send printf "lug-helper.sh: The required package 'curl' was not found on this system.\n" 1>&2 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 zstd)" ]; then # Print to stderr and also try warning the user through notify-send # printf "lug-helper.sh: The package 'zstd' was not found on this system. It is required for extracting some runner packages.\n" 1>&2 # notify-send "lug-helper" "The package 'zstd' was not found on this system. It is required for extracting some runner packages.\n" --icon=dialog-warning # exit 1 #fi if [ ! -x "$(command -v mktemp)" ] || [ ! -x "$(command -v sort)" ] || [ ! -x "$(command -v basename)" ] || [ ! -x "$(command -v realpath)" ] || [ ! -x "$(command -v dirname)" ]; 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 coreutils packages are installed:\n- mktemp\n- sort\n- basename\n- realpath\n- dirname\n" 1>&2 notify-send "lug-helper" "One or more required packages were not found on this system.\nPlease check that the following coreutils packages are installed:\n- mktemp\n- sort\n- basename\n- realpath\n- dirname\n" --icon=dialog-warning exit 1 fi ######## Config ############################################################ wine_conf="winedir.conf" game_conf="gamedir.conf" # Use XDG base directories if defined conf_dir="${XDG_CONFIG_HOME:-$HOME/.config}" data_dir="${XDG_DATA_HOME:-$HOME/.local/share}" # .config subdirectory conf_subdir="starcitizen-lug" # Helper directory helper_dir="$(realpath "$0" | xargs -0 dirname)" # Temporary directory tmp_dir="$(mktemp -d --suffix=".lughelper")" trap 'rm -r "$tmp_dir"' EXIT ######## Game Directories ################################################## # The game's base directory name sc_base_dir="StarCitizen" # The default install location within a WINE prefix: install_path="drive_c/Program Files/Roberts Space Industries/$sc_base_dir" # The names of the live/ptu directories live_dir="LIVE" ptu_dir="PTU" # Location in the WINE prefix where shaders are stored appdata_path="drive_c/users/$USER/AppData/Local/Star Citizen" # The shaders subdirectory name shaders_subdir="shaders" # Remaining directory paths are set at the end of the getdirs() function ######## Runners ########################################################### # Lutris native wine runners directory runners_dir_native="$data_dir/lutris/runners/wine" # Lutris flatpak wine runners directory runners_dir_flatpak="$HOME/.var/app/net.lutris.Lutris/data/lutris/runners/wine" # URLs for downloading Lutris runners # Elements in this array must be added in quoted pairs of: "description" "url" # The first string in the pair is expected to contain the runner description # The second is expected to contain the github api releases url # ie. "RawFox" "https://api.github.com/repos/rawfoxDE/raw-wine/releases" runner_sources=( "RawFox" "https://api.github.com/repos/starcitizen-lug/raw-wine/releases" "/dev/null" "https://api.github.com/repos/gort818/wine-sc-lug/releases" "GloriousEggroll" "https://api.github.com/repos/GloriousEggroll/wine-ge-custom/releases" ) ######## DXVK ############################################################## # Lutris native dxvk directory dxvk_dir_native="$data_dir/lutris/runtime/dxvk" # Lutris flatpak dxvk directory dxvk_dir_flatpak="$HOME/.var/app/net.lutris.Lutris/data/lutris/runtime/dxvk" # URLs for downloading dxvk versions # Elements in this array must be added in quoted pairs of: "description" "url" # The first string in the pair is expected to contain the runner description # The second is expected to contain the github api releases url # ie. "Sporif Async" "https://api.github.com/repos/Sporif/dxvk-async/releases" 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 max_download_items=20 # Pixels to add for each Zenity menu option # 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 if [ -f "/usr/share/pixmaps/lug-logo.png" ]; then lug_logo="/usr/share/pixmaps/lug-logo.png" elif [ -f "$helper_dir/lug-logo.png" ]; then lug_logo="$helper_dir/lug-logo.png" else lug_logo="info" fi # 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.22" ############################################################################ ############################################################################ ############################################################################ # Echo a formatted debug message to the terminal and optionally exit # Accepts either "continue" or "exit" as the first argument # followed by the string to be echoed debug_print() { # This function expects two string arguments if [ "$#" -lt 2 ]; then printf "\nScript error: The debug_print function expects two arguments. Aborting.\n" read -n 1 -s -p "Press any key..." exit 0 fi # Echo the provided string and, optionally, exit the script case "$1" in "continue") printf "\n$2\n" ;; "exit") # Write an error to stderr and exit printf "lug-helper.sh: $2\n" 1>&2 read -n 1 -s -p "Press any key..." exit 1 ;; *) printf "lug-helper.sh: Unknown argument provided to debug_print function. Aborting.\n" 1>&2 read -n 1 -s -p "Press any key..." exit 0 ;; esac } # Try to execute a supplied command as root # Expects one string argument try_exec() { # This function expects one string arguments if [ "$#" -lt 1 ]; then printf "\nScript error: The try_exec() function expects an argument. Aborting.\n" read -n 1 -s -p "Press any key..." exit 0 fi retval=0 # Use pollkit's pkexec for gui authentication with a fallback to sudo if [ -x "$(command -v pkexec)" ]; then pkexec sh -c "$1" # Check the return value if [ "$?" -eq 126 ] || [ "$?" -eq 127 ]; then # User cancel or error retval=1 fi else sudo sh -c "$1" # Check the return value if [ "$?" -eq 1 ]; then # Error retval=1 fi fi return "$retval" } # Display a message to the user. # Expects the first argument to indicate the message type, followed by # a string of arguments that will be passed to zenity or echoed to the user. # # To call this function, use the following format: message [type] "[string]" # See the message types below for instructions on formatting the string. message() { # Sanity check if [ "$#" -lt 2 ]; then debug_print exit "Script error: The message function expects two arguments. Aborting." fi # Use zenity messages if available if [ "$use_zenity" -eq 1 ]; then case "$1" in "info") # info message # call format: message info "text to display" margs=("--info" "--window-icon=\"$lug_logo\"" "--no-wrap" "--text=") shift 1 # drop the message type argument and shift up to the text ;; "warning") # warning message # call format: message warning "text to display" margs=("--warning" "--window-icon=\"$lug_logo\"" "--text=") shift 1 # drop the message type argument and shift up to the text ;; "question") # question # call format: if message question "question to ask?"; then... margs=("--question" "--window-icon=\"$lug_logo\"" "--text=") shift 1 # drop the message type argument and shift up to the text ;; "options") # formats the buttons with two custom options # call format: if message options left_button_name right_button_name "which one do you want?"; then... # The right button returns 0 (ok), the left button returns 1 (cancel) if [ "$#" -lt 4 ]; then debug_print exit "Script error: The options type in the message function expects four arguments. Aborting." fi margs=("--question" "--cancel-label=$2" "--ok-label=$3" "--window-icon=\"$lug_logo\"" "--text=") shift 3 # drop the type and button label arguments and shift up to the text ;; *) debug_print exit "Script Error: Invalid message type passed to the message function. Aborting." ;; esac # Display the message zenity "${margs[@]}""$@" --width="400" --title="Star Citizen LUG Helper" 2>/dev/null else # Fall back to text-based messages when zenity is not available case "$1" in "info") # info message # call format: message info "text to display" clear printf "\n$2\n\n" read -n 1 -s -p "Press any key..." ;; "warning") # warning message # call format: message warning "text to display" clear printf "\n$2\n\n" read -n 1 -s -p "Press any key..." ;; "question") # question # call format: if message question "question to ask?"; then... clear printf "$2\n" while read -p "[y/n]: " yn; do case "$yn" in [Yy]*) return 0 ;; [Nn]*) return 1 ;; *) printf "Please type 'y' or 'n'\n" ;; esac done ;; *) debug_print exit "Script Error: Invalid message type passed to the message function. Aborting." ;; esac fi } # Display a menu to the user. # Uses Zenity for a gui menu with a fallback to plain old text. # # How to call this function: # # Requires two arrays to be set: "menu_options" and "menu_actions" # two string variables: "menu_text_zenity" and "menu_text_terminal" # and one integer variable: "menu_height". # # - The array "menu_options" should contain the strings of each option. # - The array "menu_actions" should contain function names to be called. # - The strings "menu_text_zenity" and "menu_text_terminal" should contain # the menu description formatted for zenity and the terminal, respectively. # This text will be displayed above the menu options. # Zenity supports Pango Markup for text formatting. # - The integer "menu_height" specifies the height of the zenity menu. # - The string "cancel_label" should contain the text of the cancel button. # # The final element in each array is expected to be a quit option. # # IMPORTANT: The indices of the elements in "menu_actions" # *MUST* correspond to the indeces in "menu_options". # In other words, it is expected that menu_actions[1] is the correct action # to be executed when menu_options[1] is selected, and so on for each element. # # See MAIN at the bottom of this script for an example of generating a menu. menu() { # Sanity checks if [ "${#menu_options[@]}" -eq 0 ]; then debug_print exit "Script error: The array 'menu_options' was not set\nbefore calling the menu function. Aborting." elif [ "${#menu_actions[@]}" -eq 0 ]; then debug_print exit "Script error: The array 'menu_actions' was not set\nbefore calling the menu function. Aborting." elif [ -z "$menu_text_zenity" ]; then debug_print exit "Script error: The string 'menu_text_zenity' was not set\nbefore calling the menu function. Aborting." elif [ -z "$menu_text_terminal" ]; then debug_print exit "Script error: The string 'menu_text_terminal' was not set\nbefore calling the menu function. Aborting." 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 'cancel_label' was not set\nbefore calling the menu function. Aborting." fi # Use Zenity if it is available if [ "$use_zenity" -eq 1 ]; then # Format the options array for Zenity by adding # TRUE or FALSE to indicate default selections # ie: "TRUE" "List item 1" "FALSE" "List item 2" "FALSE" "List item 3" for (( i=0; i<"${#menu_options[@]}"-1; i++ )); do if [ "$i" -eq 0 ]; then # Select the first radio button by default zen_options=("TRUE") zen_options+=("${menu_options[i]}") else zen_options+=("FALSE") zen_options+=("${menu_options[i]}") fi 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)" # Loop through the options array to match the chosen option matched="false" for (( i=0; i<"${#menu_options[@]}"; i++ )); do if [ "$choice" = "${menu_options[i]}" ]; then # Execute the corresponding action ${menu_actions[i]} matched="true" break fi done # If no match was found, the user clicked cancel if [ "$matched" = "false" ]; then # Execute the last option in the actions array "${menu_actions[${#menu_actions[@]}-1]}" fi else # Use a text menu if Zenity is not available clear printf "\n$menu_text_terminal\n\n" PS3="Enter selection number: " select choice in "${menu_options[@]}" do # Loop through the options array to match the chosen option matched="false" for (( i=0; i<"${#menu_options[@]}"; i++ )); do if [ "$choice" = "${menu_options[i]}" ]; then # Execute the corresponding action printf "\n\n" ${menu_actions[i]} matched="true" break fi done # Check if we're done looping the menu if [ "$matched" = "true" ]; then # Match was found and actioned, so exit the menu break else # If no match was found, the user entered an invalid option printf "\nInvalid selection.\n" continue fi done fi } # Called when the user clicks cancel on a looping menu # Causes a return to the main menu menu_loop_done() { looping_menu="false" } # Get paths to the user's wine prefix, game directory, and a backup directory getdirs() { # Sanity checks if [ ! -d "$conf_dir" ]; then message warning "Config directory not found. The Helper is unable to proceed.\n\n$conf_dir" return 1 fi if [ ! -d "$conf_dir/$conf_subdir" ]; then mkdir -p "$conf_dir/$conf_subdir" fi # Check if the config files already exist if [ -f "$conf_dir/$conf_subdir/$wine_conf" ]; then wine_prefix="$(cat "$conf_dir/$conf_subdir/$wine_conf")" if [ ! -d "$wine_prefix" ]; then debug_print continue "The saved wine prefix does not exist, ignoring." wine_prefix="" fi fi if [ -f "$conf_dir/$conf_subdir/$game_conf" ]; then game_path="$(cat "$conf_dir/$conf_subdir/$game_conf")" if [ ! -d "$game_path" ] || [ "$(basename "$game_path")" != "$sc_base_dir" ]; then debug_print continue "Unexpected game path found in config file, ignoring." game_path="" fi fi # 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 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 if [ -z "$wine_prefix" ]; then wine_prefix="$(zenity --file-selection --directory --title="Select your Star Citizen WINE prefix directory" --filename="$HOME/Games/star-citizen" 2>/dev/null)" if [ "$?" -eq -1 ]; then message warning "An unexpected error has occurred. The Helper is unable to proceed." return 1 elif [ -z "$wine_prefix" ]; then # User clicked cancel message warning "Operation cancelled.\nNo changes have been made to your game." return 1 fi fi # Get the game path if [ -z "$game_path" ]; then if [ -d "$wine_prefix/$install_path" ] && message question "Is this your Star Citizen game directory?\n\n$wine_prefix/$install_path"; then game_path="$wine_prefix/$install_path" else while game_path="$(zenity --file-selection --directory --title="Select your Star Citizen directory" --filename="$wine_prefix/$install_path" 2>/dev/null)"; do if [ "$?" -eq -1 ]; then 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 base game directory named '$sc_base_dir'\n\nie. [prefix]/drive_c/Program Files/Roberts Space Industries/StarCitizen" else # All good or cancel break fi done if [ -z "$game_path" ]; then # User clicked cancel message warning "Operation cancelled.\nNo changes have been made to your game." return 1 fi fi fi else # No Zenity, use terminal-based menus clear # Get the wine prefix directory if [ -z "$wine_prefix" ]; then printf "Enter the full path to your Star Citizen WINE prefix directory (case sensitive)\n" printf "ie. /home/USER/Games/star-citizen\n" while read -rp ": " wine_prefix; do if [ ! -d "$wine_prefix" ]; then printf "That directory is invalid or does not exist. Please try again.\n\n" else break fi done fi # Get the game path if [ -z "$game_path" ]; then if [ -d "$wine_prefix/$install_path" ] && message question "Is this your Star Citizen game directory?\n\n$wine_prefix/$install_path"; then game_path="$wine_prefix/$install_path" else printf "\nEnter the full path to your Star Citizen installation directory (case sensitive)\n" printf "ie. /home/USER/Games/star-citizen/drive_c/Program Files/Roberts Space Industries/StarCitizen\n" while read -rp ": " game_path; do if [ ! -d "$game_path" ]; then printf "That directory is invalid or does not exist. Please try again.\n\n" elif [ "$(basename "$game_path")" != "$sc_base_dir" ]; then printf "You must enter the full path to the directory named '$sc_base_dir'\n\n" else break fi done fi fi fi # Save the paths for later use echo "$wine_prefix" > "$conf_dir/$conf_subdir/$wine_conf" echo "$game_path" > "$conf_dir/$conf_subdir/$game_conf" fi ######## Set remaining directory paths ##################################### # $live_or_ptu is set in the set_version() function ############################################################################ # The game's user directory user_dir="$game_path/$live_or_ptu/USER/Client/0" # The location within the USER directory to which the game exports keybinds keybinds_dir="$user_dir/Controls/Mappings" # Shaders directory shaders_dir="$wine_prefix/$appdata_path" # dxvk cache file dxvk_cache="$game_path/$live_or_ptu/StarCitizen.dxvk-cache" # Where to store backed up keybinds backup_path="$conf_dir/$conf_subdir" } ############################################################################ ######## begin preflight check functions ################################### ############################################################################ ######## begin mapcount functions ########################################## ############################################################################ # Check if setting vm.max_map_count was successful mapcount_confirm() { if [ "$(cat /proc/sys/vm/max_map_count)" -lt 16777216 ]; then preflight_results+=("WARNING: As far as this Helper can detect, vm.max_map_count\nwas not successfully configured on your system.\nYou will most likely experience crashes.") fi } # Sets vm.max_map_count for the current session only mapcount_once() { preflight_actions+=('sysctl -w vm.max_map_count=16777216') preflight_results+=("vm.max_map_count was changed until the next boot.") preflight_followup+=("mapcount_confirm") } # Set vm.max_map_count 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-starcitizen-max_map_count.conf && sysctl --system') preflight_results+=("The vm.max_map_count configuration has been added 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') preflight_results+=("The vm.max_map_count configuration has been added to:\n/etc/sysctl.conf") fi # Verify that the setting took effect preflight_followup+=("mapcount_confirm") } # Check vm.max_map_count for the correct setting mapcount_check() { mapcount="$(cat /proc/sys/vm/max_map_count)" # Add to the results and actions arrays if [ "$mapcount" -ge 16777216 ]; then # All good 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.") # Add the function that will be called to change the configuration preflight_action_funcs+=("mapcount_once") # Add info for manually changing the setting preflight_manual+=("To change vm.max_map_count until the next reboot, run:\nsudo sysctl -w vm.max_map_count=16777216") else # The setting should be changed preflight_fail+=("vm.max_map_count is $mapcount\nand should be set to at least 16777216\nto give the game access to sufficient memory.") # Add the function that will be called to change the configuration preflight_action_funcs+=("mapcount_set") # 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-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") fi fi } ############################################################################ ######## end mapcount functions ############################################ ############################################################################ ############################################################################ ######## begin filelimit functions ######################################### ############################################################################ # Check if setting the open file descriptors limit was successful filelimit_confirm() { if [ "$(ulimit -Hn)" -lt 524288 ]; then preflight_results+=("WARNING: As far as this Helper can detect, the open files limit\nwas not successfully configured on your system.\nYou may experience crashes.") fi } # Set the open file descriptors limit filelimit_set() { if [ -f "/etc/systemd/system.conf" ]; then # Using systemd # Append to the file 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 preflight_actions+=('sed -i "\$i#Added by LUG-Helper:" /etc/security/limits.conf; sed -i "\$i* hard nofile 524288" /etc/security/limits.conf') preflight_results+=("The open files limit configuration has been appended to:\n/etc/security/limits.conf") else # Don't know what method to use preflight_results+=("This Helper is unable to detect the correct method of setting\nthe open file descriptors limit on your system.\n\nWe recommend manually configuring this limit to at least 524288.") fi # Verify that setting the limit was successful preflight_followup+=("filelimit_confirm") } # Check the open file descriptors limit filelimit_check() { filelimit="$(ulimit -Hn)" # Add to the results and actions arrays if [ "$filelimit" -ge 524288 ]; then # All good 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.") # Add the function that will be called to change the configuration preflight_action_funcs+=("filelimit_set") # 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 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") else # Don't know what method to use preflight_manual+=("This Helper is unable to detect the correct method of setting\nthe open file descriptors limit on your system.\n\nWe recommend manually configuring this limit to at least 524288.") fi fi } ############################################################################ ######## 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)" if [ ${memtotal%.*} -ge "15" ]; then preflight_pass+=("Your system has $memtotal GB of memory.") else preflight_fail+=("Your system has $memtotal GB of memory.\nWe recommend at least 16 GB to avoid crashes.") fi } # Check CPU for the required AVX extension avx_check() { if grep -q "avx" /proc/cpuinfo; then preflight_pass+=("Your CPU supports the necessary AVX instruction set.") else preflight_fail+=("Your CPU does not appear to support AVX instructions.\nThis requirement was added to Star Citizen in version 3.11") 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="$message_heading" 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 # Try to execute the actions as root try_exec "$preflight_actions_string" if [ "$?" -eq 1 ]; then message info "Authentication failed or there was an error.\nSee terminal for more information.\n\nReturning to main menu." return 0 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 ##################################### ############################################################################ ############################################################################ ######## begin download functions ########################################## ############################################################################ # Detect if lutris is installed lutris_detect() { lutris_installed="false" lutris_native="false" lutris_flatpak="false" # Detect native lutris if [ -x "$(command -v lutris)" ]; then # Native Lutris is installed lutris_installed="true" lutris_native="true" fi # Detect flatpak lutris if [ -x "$(command -v flatpak)" ]; then flatpak info net.lutris.Lutris >/dev/null 2>&1 if [ "$?" -eq 0 ]; then lutris_installed="true" lutris_flatpak="true" fi fi } # Restart lutris if necessary lutris_restart() { lutris_detect if [ "$lutris_needs_restart" = "true" ] && [ "$(pgrep -f lutris)" ]; then if message question "Lutris must be restarted to detect the changes.\nWould you like this Helper to restart it for you?"; then # Detect which version of Lutris is running and restart it if [ "$lutris_native" = "true" ] && pgrep -f lutris | xargs ps -fp | grep -q "/usr/bin/lutris"; then # Native Lutris is running debug_print continue "Restarting native Lutris..." pkill -f -SIGTERM lutris && nohup lutris /dev/null & fi if [ "$lutris_flatpak" = "true" ] && pgrep -f lutris | xargs ps -fp | grep -q "/app/bin/lutris"; then # Flatpak Lutris is running debug_print continue "Restarting flatpak Lutris..." pkill -f -SIGTERM lutris && nohup flatpak run net.lutris.Lutris /dev/null & fi fi fi lutris_needs_restart="false" } # Get an array of directories used by Lutris # Supports native install and flatpak # Array must be formatted in pairs of ("[type]" "[directory]") # Takes an argument to specify the type to return, ie "runner" or "dxvk" get_lutris_dirs() { # Sanity check if [ "$#" -lt 1 ]; then debug_print exit "Script error: The get_lutris_dirs function expects one argument. Aborting." fi # Detect the type of Lutris install lutris_detect # Add lutris directories to an array unset lutris_dirs case "$1" in "runner") # Native Lutris install if [ "$lutris_native" = "true" ]; then lutris_dirs+=("native" "$runners_dir_native") fi # Flatpak lutris install if [ "$lutris_flatpak" = "true" ]; then lutris_dirs+=("flatpak" "$runners_dir_flatpak") fi ;; "dxvk") # Native Lutris install if [ "$lutris_native" = "true" ]; then lutris_dirs+=("native" "$dxvk_dir_native") fi # Flatpak lutris install if [ "$lutris_flatpak" = "true" ]; then lutris_dirs+=("flatpak" "$dxvk_dir_flatpak") fi ;; *) printf "lug-helper.sh: Unknown argument provided to get_lutris_dirs function. Aborting.\n" 1>&2 read -n 1 -s -p "Press any key..." exit 0 ;; esac } # 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 if [ "$display_post_download_msg" = "true" ]; then message_heading="Download Complete" # Format some variables for zenity if [ "$use_zenity" -eq 1 ]; then message_heading="$message_heading" post_download_msg_italics="$post_download_msg_italics" # If we have a link to provide, format it as well if [ -n "$post_download_msg_link" ]; then post_download_msg_link="$post_download_msg_link" fi fi # 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. Called by download_select_install() # Note: The array installed_items is expected to be set before calling this function download_delete() { # This function expects an index number for the array installed_items to be passed in as an argument if [ -z "$1" ]; then debug_print exit "Script error: The download_delete function expects an argument. Aborting." fi item_to_delete="$1" if message question "Are you sure you want to delete the following ${download_type}?\n\n${installed_items[$item_to_delete]}"; then rm -r "${installed_items[$item_to_delete]}" debug_print continue "Deleted ${installed_items[$item_to_delete]}" lutris_needs_restart="true" fi } # List installed items for deletion. Called by download_manage() download_select_delete() { # Configure the menu menu_text_zenity="Select the $download_type you want to remove:" menu_text_terminal="Select the $download_type you want to remove:" menu_text_height="65" goback="Return to the $download_type management menu" unset installed_items unset installed_item_names unset menu_options unset menu_actions # Find all installed items in the download destinations for (( i=1; i<"${#download_dirs[@]}"; i=i+2 )); do # Loop through all download destinations # Odd numbered elements will contain the download destination's path for item in "${download_dirs[i]}"/*; do if [ -d "$item" ]; then if [ "${#download_dirs[@]}" -eq 2 ]; then # We're deleting from one location installed_item_names+=("$(basename "$item")") else # We're deleting from multiple locations so label each one installed_item_names+=("$(basename "$item [${download_dirs[i-1]}]")") fi installed_items+=("$item") fi done done # Create menu options for the installed items for (( i=0; i<"${#installed_items[@]}"; i++ )); do menu_options+=("${installed_item_names[i]}") menu_actions+=("download_delete $i") done # Complete the menu by adding the option to go back to the previous menu menu_options+=("$goback") menu_actions+=(":") # no-op # Calculate the total height the menu should be menu_height="$(($menu_option_height * ${#menu_options[@]} + $menu_text_height))" if [ "$menu_height" -gt "400" ]; then menu_height="400" fi # Set the label for the cancel button cancel_label="Go Back" # Call the menu function. It will use the options as configured above menu } # Download and install the selected item. Called by download_select_install() # Note: The variables download_versions, contributor_url, and download_url_type are expected to be set before calling this function download_install() { # This function expects an index number for the array # download_versions to be passed in as an argument if [ -z "$1" ]; then debug_print exit "Script error: The download_install function expects a numerical argument. Aborting." fi # Get the filename including file extension download_file="${download_versions[$1]}" # Get the selected item name minus the file extension # To add new file extensions, handle them here and in # the download_select_install function below case "$download_file" in *.tar.gz) download_name="$(basename "$download_file" .tar.gz)" ;; *.tgz) download_name="$(basename "$download_file" .tgz)" ;; *.tar.xz) download_name="$(basename "$download_file" .tar.xz)" ;; *.tar.zst) download_name="$(basename "$download_file" .tar.zst)" ;; *) debug_print exit "Script error: Unknown archive filetype in download_install function. Aborting." ;; esac # Get the selected download url # To add new sources, handle them here and in the # download_select_install function below if [ "$download_url_type" = "github" ]; then download_url="$(curl -s "$contributor_url" | grep "browser_download_url.*$download_file" | cut -d \" -f4)" else debug_print exit "Script error: Unknown api/url format in ${download_type}_sources array. Aborting." fi # Sanity check if [ -z "$download_url" ]; then message warning "Could not find the requested ${download_type}. The source API may be down or rate limited." return 1 fi # Download the item to the tmp directory debug_print continue "Downloading $download_url into $tmp_dir/$download_file..." if [ "$use_zenity" -eq 1 ]; then # Format the curl progress bar for zenity mkfifo "$tmp_dir/lugpipe" cd "$tmp_dir" && curl -#LO "$download_url" > "$tmp_dir/lugpipe" 2>&1 & curlpid="$!" stdbuf -oL tr '\r' '\n' < "$tmp_dir/lugpipe" | \ grep --line-buffered -ve "100" | grep --line-buffered -o "[0-9]*\.[0-9]" | \ ( trap 'kill "$curlpid"' ERR zenity --progress --auto-close --title="Star Citizen LUG Helper" --text="Downloading ${download_type}. This might take a moment.\n" 2>/dev/null ) if [ "$?" -eq 1 ]; then # User clicked cancel debug_print continue "Download aborted. Removing $tmp_dir/$download_file..." rm "$tmp_dir/$download_file" rm "$tmp_dir/lugpipe" return 1 fi rm "$tmp_dir/lugpipe" else # Standard curl progress bar (cd "$tmp_dir" && curl -LO "$download_url") fi # Sanity check if [ ! -f "$tmp_dir/$download_file" ]; then debug_print exit "Script error: The requested $download_type file was not downloaded. Aborting" fi # Extract the archive to the tmp directory debug_print continue "Extracting $download_type into $tmp_dir/$download_name..." if [ "$use_zenity" -eq 1 ]; then # Use Zenity progress bar mkdir "$tmp_dir/$download_name" && tar -xf "$tmp_dir/$download_file" -C "$tmp_dir/$download_name" | \ zenity --progress --pulsate --no-cancel --auto-close --title="Star Citizen LUG Helper" --text="Extracting ${download_type}...\n" 2>/dev/null else mkdir "$tmp_dir/$download_name" && tar -xf "$tmp_dir/$download_file" -C "$tmp_dir/$download_name" fi # Check the contents of the extracted archive to determine the # directory structure we must create upon installation num_dirs=0 num_files=0 for extracted_item in "$tmp_dir/$download_name"/*; do if [ -d "$extracted_item" ]; then num_dirs="$(($num_dirs+1))" extracted_dir="$(basename "$extracted_item")" elif [ -f "$extracted_item" ]; then num_files="$(($num_files+1))" fi done # Create the correct directory structure and install the item if [ "$num_dirs" -eq 0 ] && [ "$num_files" -eq 0 ]; then # Sanity check message warning "The downloaded archive is empty. There is nothing to do." elif [ "$num_dirs" -eq 1 ] && [ "$num_files" -eq 0 ]; then # If the archive contains only one directory, install that directory # 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() for (( i=1; i<"${#download_dirs[@]}"; i=i+2 )); do # Loop through all download destinations, installing to each one # Odd numbered elements will contain the download destination's path if [ -d "${download_dirs[i]}/$download_name" ]; then # This item has already been installed. Delete it before reinstalling debug_print continue "$download_type exists, deleting ${download_dirs[i]}/$download_name..." rm -r "${download_dirs[i]}/$download_name" debug_print continue "Reinstalling $download_type into ${download_dirs[i]}/$download_name..." else debug_print continue "Installing $download_type into ${download_dirs[i]}/$download_name..." fi if [ "$use_zenity" -eq 1 ]; then # Use Zenity progress bar mkdir -p "${download_dirs[i]}" && cp -r "$tmp_dir/$download_name/$extracted_dir" "${download_dirs[i]}/$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_dirs[i]}" && cp -r "$tmp_dir/$download_name/$extracted_dir" "${download_dirs[i]}/$download_name" fi done # 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 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 for (( i=1; i<"${#download_dirs[@]}"; i=i+2 )); do # Loop through all download destinations, installing to each one # Odd numbered elements will contain the download destination's path if [ -d "${download_dirs[i]}/$download_name" ]; then # This item has already been installed. Delete it before reinstalling debug_print continue "$download_type exists, deleting ${download_dirs[i]}/$download_name..." rm -r "${download_dirs[i]}/$download_name" debug_print continue "Reinstalling $download_type into ${download_dirs[i]}/$download_name..." else debug_print continue "Installing $download_type into ${download_dirs[i]}/$download_name..." fi if [ "$use_zenity" -eq 1 ]; then # Use Zenity progress bar mkdir -p "${download_dirs[i]}/$download_name" && cp -r "$tmp_dir"/"$download_name"/* "${download_dirs[i]}"/"$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_dirs[i]}/$download_name" && cp -r "$tmp_dir"/"$download_name"/* "${download_dirs[i]}"/"$download_name" fi done # 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 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" fi # Cleanup tmp download debug_print continue "Cleaning up $tmp_dir/$download_file..." rm "$tmp_dir/$download_file" rm -r "$tmp_dir/$download_name" } # List available items for download. Called by download_manage() download_select_install() { # This function expects an element number for the sources array # to be passed in as an argument if [ -z "$1" ]; then debug_print exit "Script error: The download_select_install function expects a numerical argument. Aborting." fi # Store info from the selected contributor contributor_name="${download_sources[$1]}" contributor_url="${download_sources[$1+1]}" # Check the provided contributor url to make sure we know how to handle it # To add new sources, add them here and handle in the if statement # just below and the download_install function above case "$contributor_url" in https://api.github.com*) download_url_type="github" ;; *) debug_print exit "Script error: Unknown api/url format in ${download_type}_sources array. Aborting." ;; esac # For runners, check GlibC version against runner requirements if [ "$download_type" = "runner" ] && ( [ "$contributor_name" = "/dev/null" ] || [ "$contributor_name" = "TKG" ] ); then required_glibc="2.33" system_glibc="$(ldd --version | awk '/ldd/{print $NF}')" # 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 fi # Fetch a list of versions from the selected contributor # To add new sources, handle them here, in the if statement # just above, and the download_install function above if [ "$download_url_type" = "github" ]; then download_versions=($(curl -s "$contributor_url" | awk '/browser_download_url/ {print $2}' | xargs basename -a)) else debug_print exit "Script error: Unknown api/url format in ${download_type}_sources array. Aborting." fi # Sanity check if [ "${#download_versions[@]}" -eq 0 ]; then message warning "No $download_type versions were found. The source API may be down or rate limited." return 1 fi # Configure the menu menu_text_zenity="Select the $download_type you want to install:" menu_text_terminal="Select the $download_type you want to install:" menu_text_height="65" goback="Return to the $download_type management menu" unset menu_options unset menu_actions # Iterate through the versions, check if they are installed, # and add them to the menu options # To add new file extensions, handle them here and in # the download_install function above for (( i=0,num_download_items=0; i<"${#download_versions[@]}" && "$num_download_items"<"$max_download_items"; i++ )); do # Get the file name minus the extension case "${download_versions[i]}" in *.sha*sum | *.ini | proton*) # Ignore hashes, configs, and proton downloads continue ;; *.tar.gz) download_name="$(basename "${download_versions[i]}" .tar.gz)" ;; *.tgz) download_name="$(basename "${download_versions[i]}" .tgz)" ;; *.tar.xz) download_name="$(basename "${download_versions[i]}" .tar.xz)" ;; *.tar.zst) download_name="$(basename "${download_versions[i]}" .tar.zst)" ;; *) # Print a warning and move on to the next item debug_print continue "Warning: Unknown archive filetype in download_select_install() function. Offending String: ${download_versions[i]}" continue ;; esac # Create a list of locations where the file is already installed unset installed_types for (( j=0; j<"${#download_dirs[@]}"; j=j+2 )); do # Loop through all download destinations to get installed types # Even numbered elements will contain the download destination type (ie. native/flatpak) if [ -d "${download_dirs[j+1]}/$download_name" ]; then installed_types+=("${download_dirs[j]}") fi done # Build the menu item unset menu_option_text if [ "${#download_dirs[@]}" -eq 2 ]; then # We're only installing to one location if [ -d "${download_dirs[1]}/$download_name" ]; then menu_option_text="$download_name [installed]" else # The file is not installed menu_option_text="$download_name" fi else # We're installing to multiple locations if [ "${#installed_types[@]}" -gt 0 ]; then # The file is already installed menu_option_text="$download_name [installed:" for (( j=0; j<"${#installed_types[@]}"; j++ )); do # Add labels for each installed location menu_option_text="$menu_option_text ${installed_types[j]}" done # Complete the menu text menu_option_text="$menu_option_text]" else # The file is not installed menu_option_text="$download_name" fi fi # Add the file names to the menu menu_options+=("$menu_option_text") menu_actions+=("download_install $i") # Increment the added items counter num_download_items="$(($num_download_items+1))" done # Complete the menu by adding the option to go back to the previous menu menu_options+=("$goback") menu_actions+=(":") # no-op # Calculate the total height the menu should be menu_height="$(($menu_option_height * ${#menu_options[@]} + $menu_text_height))" if [ "$menu_height" -gt "400" ]; then menu_height="400" fi # Set the label for the cancel button cancel_label="Go Back" # Call the menu function. It will use the options as configured above menu } # Manage downloads. Called by a dedicated download type manage function, ie runner_manage() below # # This function expects the following variables to be set: # # - The string download_sources is a formatted array containing the URLs # of items to download. It should be pointed to the appropriate # array set at the top of the script using indirect expansion. # See runner_sources at the top and runner_manage() below for examples. # - The array download_dirs should contain the locations the downloaded item # will be installed to. Must be formatted in pairs of ("[type]" "[directory]") # - The string "download_menu_heading" should contain the type of item # being downloaded. It will appear in the menu heading. # - The string "download_menu_description" should contain a description of # the item being downloaded. It will appear in the menu subheading. # - The integer "download_menu_height" specifies the height of the zenity menu. # # This function also expects one string argument containing the type of item to # be downloaded. ie. runner or dxvk. # # See runner_manage() below for a configuration example. download_manage() { # This function expects a string to be passed as an argument if [ -z "$1" ]; then debug_print exit "Script error: The download_manage function expects a string argument. Aborting." fi # Get the type of item we're downloading from the function arguments download_type="$1" # The download management menu will loop until the user cancels looping_menu="true" while [ "$looping_menu" = "true" ]; do # Configure the menu menu_text_zenity="Manage Your $download_menu_heading\n\n$download_menu_description\n\nYou may choose from the following options:" menu_text_terminal="Manage Your $download_menu_heading\n\n$download_menu_description\nYou may choose from the following options:" menu_text_height="$download_menu_height" # Configure the menu options delete="Remove an installed $download_type" back="Return to the main menu" unset menu_options unset menu_actions # Loop through the download_sources array and create a menu item # for each one. Even numbered elements will contain the item name for (( i=0; i<"${#download_sources[@]}"; i=i+2 )); do # Set the options to be displayed in the menu menu_options+=("Install a $download_type from ${download_sources[i]}") # Set the corresponding functions to be called for each of the options menu_actions+=("download_select_install $i") done # Complete the menu by adding options to uninstall an item # or go back to the previous menu menu_options+=("$delete" "$back") menu_actions+=("download_select_delete" "menu_loop_done") # Calculate the total height the menu should be menu_height="$(($menu_option_height * ${#menu_options[@]} + $menu_text_height))" # Set the label for the cancel button cancel_label="Go Back" # 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 } # Configure the download_manage function for runners runner_manage() { # Set some defaults lutris_needs_restart="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 declare -n download_sources=runner_sources # Check if Lutris is installed and get relevant directories get_lutris_dirs "runner" if [ "$lutris_installed" = "false" ]; then message warning "Lutris is required but does not appear to be installed." return 0 fi # Point download_dirs to the lutris_dirs array set by get_lutris_dirs # Must be formatted in pairs of ("[type]" "[directory]") declare -n download_dirs=lutris_dirs # Verify the directories actually exist missing_dir="false" for (( i=1; i<"${#download_dirs[@]}"; i=i+2 )); do if [ ! -d "${download_dirs[i]}" ]; then message warning "The following Lutris directory was not found. Unable to continue.\n\n${download_dirs[i]}" debug_print continue "The following Lutris directory was not found. Unable to continue.\n\n${download_dirs[i]}" missing_dir="true" fi done if [ "$missing_dir" = "true" ]; then return 0 fi # Configure the text displayed in the menus download_menu_heading="Lutris Runners" 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 # 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 # and displayed in the menus and dialogs. download_manage "runner" } # Configure the download_manage function for dxvks dxvk_manage() { # Set some defaults lutris_needs_restart="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 declare -n download_sources=dxvk_sources # Check if Lutris is installed and get relevant directories get_lutris_dirs "dxvk" if [ "$lutris_installed" = "false" ]; then message warning "Lutris is required but does not appear to be installed." return 0 fi # Point download_dirs to the lutris_dirs array set by get_lutris_dirs # Must be formatted in pairs of ("[type]" "[directory]") declare -n download_dirs=lutris_dirs # Verify the directories actually exist missing_dir="false" for (( i=1; i<"${#download_dirs[@]}"; i=i+2 )); do if [ ! -d "${download_dirs[i]}" ]; then message warning "The following Lutris directory was not found. Unable to continue.\n\n${download_dirs[i]}" debug_print continue "The following Lutris directory was not found. Unable to continue.\n\n${download_dirs[i]}" missing_dir="true" fi done if [ "$missing_dir" = "true" ]; then return 0 fi # Configure the text displayed in the menus 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 # 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 # 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 # and displayed in the menus and dialogs. download_manage "dxvk" } ############################################################################ ######## end download functions ############################################ ############################################################################ ############################################################################ ######## begin maintenance functions ####################################### ############################################################################ # Toggle between the LIVE and PTU game directories for all Helper functions set_version() { if [ "$live_or_ptu" = "$live_dir" ]; then live_or_ptu="$ptu_dir" message info "The Helper will now target your Star Citizen PTU installation." elif [ "$live_or_ptu" = "$ptu_dir" ]; then live_or_ptu="$live_dir" message info "The Helper will now target your Star Citizen LIVE installation." else debug_print continue "Unexpected game version provided. Defaulting to the LIVE installation." live_or_ptu="$live_dir" fi } # Save exported keybinds, wipe the USER directory, and restore keybinds rm_userdir() { # Prompt user to back up the current keybinds in the game message info "Before proceeding, please be sure you have exported\nyour Star Citizen keybinds from within the game.\n\nTo do this, launch the game and go to:\nOptions->Keybindings->Control Profiles->Save Control Settings\n\nGo on; I'll wait." # 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 [ ! -d "$user_dir" ]; then message warning "USER directory not found. There is nothing to delete!\n\n$user_dir" return 0 fi # Check for exported keybind files if [ ! -d "$keybinds_dir" ] || [ -z "$(ls -A "$keybinds_dir")" ]; then if message question "Warning: No exported keybindings found.\nContinuing will erase your existing keybinds!\n\nDo you want to continue anyway?"; then exported=0 else # User said no return 0 fi else exported=1 fi if message question "The following directory will be deleted:\n\n$user_dir\n\nDo you want to proceed?"; then # Back up keybinds if [ "$exported" -eq 1 ]; then debug_print continue "Backing up keybinds to $backup_path/keybinds..." mkdir -p "$backup_path/keybinds" && cp -r "$keybinds_dir/." "$backup_path/keybinds/" fi # Wipe the user directory debug_print continue "Wiping $user_dir..." rm -r "$user_dir" # Restore custom keybinds if [ "$exported" -eq 1 ]; then debug_print continue "Restoring keybinds..." mkdir -p "$keybinds_dir" && cp -r "$backup_path/keybinds/." "$keybinds_dir/" message info "To re-import your keybinds, select it in-game from the list:\nOptions->Keybindings->Control Profiles" fi message info "Your Star Citizen USER directory has been cleaned up!" fi } # 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 # Loop through all possible shader directories for appdata_dir in "$shaders_dir"/*; do if [ -d "$appdata_dir/$shaders_subdir" ]; then # If a shaders directory is found, delete it if message question "The following directory will be deleted:\n\n$appdata_dir/$shaders_subdir\n\nDo you want to proceed?"; then debug_print continue "Deleting $appdata_dir/$shaders_subdir..." rm -r "$appdata_dir/$shaders_subdir" fi fi done message info "All shaders have been deleted" } # 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 } # Display all directories currently used by this helper and Star Citizen display_dirs() { unset dirs_list # Helper configs and keybinds if [ -d "$conf_dir/$conf_subdir" ]; then dirs_list+=("\n\nHelper configuration:\n$conf_dir/$conf_subdir\n\nKeybind backups:\n$conf_dir/$conf_subdir/keybinds") fi # Wine prefix if [ -f "$conf_dir/$conf_subdir/$wine_conf" ]; then dirs_list+="\n\nWine prefix:\n$(cat "$conf_dir/$conf_subdir/$wine_conf")" fi # Star Citizen installation if [ -f "$conf_dir/$conf_subdir/$game_conf" ]; then dirs_list+="\n\nStar Citizen game directory:\n$(cat "$conf_dir/$conf_subdir/$game_conf")" fi # Star Citizen shaders path if [ -f "$conf_dir/$conf_subdir/$wine_conf" ]; then dirs_list+="\n\nStar Citizen shaders:\n$(cat "$conf_dir/$conf_subdir/$wine_conf")/$appdata_path" fi # Lutris runners if [ -d "$runners_dir_native" ] || [ -d "$runners_dir_flatpak" ]; then dirs_list+="\n\nLutris Runners:" if [ -d "$runners_dir_native" ]; then dirs_list+="\n$runners_dir_native" fi if [ -d "$runners_dir_flatpak" ]; then dirs_list+="\n$runners_dir_flatpak" fi fi # Lutris dxvk if [ -d "$dxvk_dir_native" ] || [ -d "$dxvk_dir_flatpak" ]; then dirs_list+="\n\nLutris DXVK Versions:" if [ -d "$dxvk_dir_native" ]; then dirs_list+="\n$dxvk_dir_native" fi if [ -d "$dxvk_dir_flatpak" ]; then dirs_list+="\n$dxvk_dir_flatpak" fi fi # Format the info header message_heading="These directories are currently being used by this Helper and Star Citizen" if [ "$use_zenity" -eq 1 ]; then message_heading="$message_heading" fi message info "$message_heading\n${dirs_list[@]}" } # 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 helper's config directory reset_helper() { # Delete the shader directory if message question "All config files will be deleted from:\n\n$conf_dir/$conf_subdir\n\nDo you want to proceed?"; then debug_print continue "Deleting $conf_dir/$conf_subdir/*.conf..." rm "$conf_dir/$conf_subdir/"*.conf message info "The Helper has been reset!" fi } # Show maintenance/troubleshooting options maintenance_menu() { # Loop the menu until the user selects quit looping_menu="true" while [ "$looping_menu" = "true" ]; do # Configure the menu menu_text_zenity="Game Maintenance and Troubleshooting\n\nYou may choose from the following options:" menu_text_terminal="Game Maintenance and Troubleshooting\n\nYou may choose from the following options:" menu_text_height="100" # Configure the menu options version_msg="Switch the Helper between LIVE and PTU (Currently: $live_or_ptu)" userdir_msg="Delete my Star Citizen USER folder and preserve my keybinds" shaders_msg="Delete my shaders (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" "$userdir_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" "rm_userdir" "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))" # Set the label for the cancel button cancel_label="Go Back" # Call the menu function. It will use the options as configured above menu done } ############################################################################ ######## end maintenance functions ######################################### ############################################################################ # Install Star Citizen using Lutris install_game() { # Check if Lutris is installed lutris_detect if [ "$lutris_installed" = "false" ]; 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 # Detect which version of Lutris is installed if [ "$lutris_native" = "true" ] && [ "$lutris_flatpak" = "true" ]; then # Both versions of Lutris are installed so ask the user if message options "Flatpak" "Native" "This Helper has detected both the Native and Flatpak versions of Lutris\nWhich version would you like to use?"; then # Native version install_version="native" else # Flatpak version install_version="flatpak" fi elif [ "$lutris_native" = "true" ]; then # Native version only install_version="native" elif [ "$lutris_flatpak" = "true" ]; then # Flatpak version only install_version="flatpak" else # We shouldn't get here debug_print exit "Script error: Unable to detect Lutris version in install_game function. Aborting." fi # Run the appropriate installer if [ "$install_version" = "native" ]; then lutris --install "$install_script" & elif [ "$install_version" = "flatpak" ]; then flatpak run --file-forwarding net.lutris.Lutris --install @@ "$install_script" @@ & else # We shouldn't get here debug_print exit "Script error: Unknown condition for install_version in install_game() function. Aborting." fi message info "The installation will continue in Lutris" fi } # Deploy Easy Anti-Cheat Workaround eac_workaround() { # 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 # Set the EAC directory path and hosts modification 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 workaround is already applied if grep -q "$eac_hosts" /etc/hosts; then if grep -q "^$eac_hosts" /etc/hosts; then message info "The Easy Anti-Cheat workaround has already been applied.\nYou're all set!" else message info "The Easy Anti-Cheat workaround has already been applied, but may be commented out.\nNo changes have been made, please edit /etc/hosts manually." fi return 0 fi # Configure message variables eac_title="Easy Anti-Cheat Workaround" eac_hosts_formatted="$eac_hosts" eac_dir_formatted="$eac_dir" if [ "$use_zenity" -eq 1 ]; then eac_title="$eac_title" eac_hosts_formatted="$eac_hosts_formatted" eac_dir_formatted="$eac_dir_formatted" fi if message question "$eac_title\n\nThe following entry will be added to /etc/hosts:\n$eac_hosts_formatted\n\nThe following directory will be deleted:\n$eac_dir_formatted\n\n\nTo revert these changes, delete the above line from\n/etc/hosts and relaunch the game\n\nDo you want to proceed?"; then debug_print continue "Editing hosts file..." # Try to modify /etc/hosts as root try_exec "printf '\n$eac_hosts #Star Citizen EAC workaround\n' >> /etc/hosts" if [ "$?" -eq 1 ]; then message info "Something went wrong. Unable to modify /etc/hosts.\n\nReturning to main menu." return 0 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 } # 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" "STAR-MFT6-Q44H" "STAR-TZX2-TPWF" "STAR-WCHN-4ZMX") # 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")]}" message info "Your random Penguin's referral code is:\n\n$random_code\n\nThank you!" } # Get the latest release version of a repo. Expects "user/repo_name" as input # Credits for this go to https://gist.github.com/lukechilds/a83e1d7127b78fef38c2914c4ececc3c get_latest_release() { # Sanity check if [ "$#" -lt 1 ]; then debug_print exit "Script error: The get_latest_release function expects one argument. Aborting." fi curl --silent "https://api.github.com/repos/$1/releases/latest" | # Get latest release from GitHub api grep '"tag_name":' | # Get tag line sed -E 's/.*"([^"]+)".*/\1/' # Pluck JSON value } quit() { exit 0 } ############################################################################ ######## MAIN ############################################################## ############################################################################ # Check if Zenity is available use_zenity=0 if [ -x "$(command -v zenity)" ]; then use_zenity=1 fi # Set defaults live_or_ptu="$live_dir" # Format some URLs for Zenity if [ "$use_zenity" -eq 1 ]; then releases_url="$releases_url" lug_wiki="$lug_wiki" 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 # If invoked with command line arguments, process them and exit if [ "$#" -gt 0 ]; then while [ "$#" -gt 0 ] do # Victor_Tramp expects the spanish inquisition. case "$1" in --help | -h ) printf "Star Citizen Linux Users Group Helper Script Usage: lug-helper -p, --preflight-check Run system optimization checks -i, --install Install Star Citizen -e, --eac Deploy Easy Anti-Cheat Workaround -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 -c, --delete-dxvk-cache Delete Star Citizen dxvk cache file -t, --target=[live|ptu] Target LIVE or PTU (default live) -g, --use-gui=[yes|no] Use Zenity GUI if available (default yes) -r, --get-referral Get a random LUG member's Star Citizen referral code -d, --show-directories Show all Star Citizen and LUG Helper directories -w, --show-wiki Show the LUG Wiki -x, --reset-helper Delete saved lug-helper configs " exit 0 ;; --preflight-check | -p ) cargs+=("preflight_check") ;; --install | -i ) cargs+=("install_game") ;; --eac | -e ) cargs+=("eac_workaround") ;; --manage-runners | -m ) cargs+=("runner_manage") ;; --manage-dxvk | -k ) cargs+=("dxvk_manage") ;; --delete-user-folder | -u ) cargs+=("rm_userdir") ;; --delete-shaders | -s ) cargs+=("rm_shaders") ;; --delete-dxvk-cache | -c ) cargs+=("rm_dxvkcache") ;; --target=* | -t=* ) live_or_ptu="$(echo "$1" | cut -d'=' -f2)" if [ "$live_or_ptu" = "live" ] || [ "$live_or_ptu" = "LIVE" ]; then live_or_ptu="$live_dir" elif [ "$live_or_ptu" = "ptu" ] || [ "$live_or_ptu" = "PTU" ]; then live_or_ptu="$ptu_dir" else printf "$0: Invalid option '$1'\n" exit 0 fi ;; --use-gui=* | -g=* ) # If zenity is unavailable, it has already been set to 0 # and this setting has no effect if [ -x "$(command -v zenity)" ]; then use_zenity="$(echo "$1" | cut -d'=' -f2)" if [ "$use_zenity" = "yes" ] || [ "$use_zenity" = "YES" ] || [ "$use_zenity" = "1" ]; then use_zenity=1 elif [ "$use_zenity" = "no" ] || [ "$use_zenity" = "NO" ] || [ "$use_zenity" = "0" ]; then use_zenity=0 else printf "$0: Invalid option '$1'\n" exit 0 fi fi ;; --get-referral | -r ) cargs+=("referral_randomizer") ;; --show-directories | -d ) cargs+=("display_dirs") ;; --show-wiki | -w ) cargs+=("display_wiki") ;; --reset-helper | -x ) cargs+=("reset_helper") ;; * ) printf "$0: Invalid option '$1'\n" exit 0 ;; esac # Shift forward to the next argument and loop again shift done # Call the requested functions and exit if [ "${#cargs[@]}" -gt 0 ]; then for (( x=0; x<"${#cargs[@]}"; x++ )); do ${cargs[x]} done exit 0 fi fi # Loop the main menu until the user selects quit while true; do # Configure the menu menu_text_zenity="Welcome, fellow Penguin, to the Star Citizen LUG Helper!\n\nThis Helper is designed to help optimize your system for Star Citizen\n\nYou may choose from the following options:" menu_text_terminal="Welcome, fellow Penguin, to the Star Citizen Linux Users Group Helper!\n\nThis Helper is designed to help optimize your system for Star Citizen\nYou may choose from the following options:" menu_text_height="140" # Configure the menu options preflight_msg="Preflight Check (System Optimization)" install_msg="Install Star Citizen" eac_msg="Deploy Easy Anti-Cheat Workaround" runners_msg="Manage Lutris Runners" 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" # Set the options to be displayed in the menu menu_options=("$preflight_msg" "$install_msg" "$eac_msg" "$runners_msg" "$dxvk_msg" "$maintenance_msg" "$randomizer_msg" "$quit_msg") # Set the corresponding functions to be called for each of the options menu_actions=("preflight_check" "install_game" "eac_workaround" "runner_manage" "dxvk_manage" "maintenance_menu" "referral_randomizer" "quit") # Calculate the total height the menu should be menu_height="$(($menu_option_height * ${#menu_options[@]} + $menu_text_height))" # Set the label for the cancel button cancel_label="Quit" # Call the menu function. It will use the options as configured above menu done