lug-helper/lug-helper.sh

680 lines
25 KiB
Bash
Raw Normal View History

#!/bin/bash
2020-08-02 18:12:02 +00:00
############################################################################
# Star Citizen's Linux Users Group Helper Script
############################################################################
#
# Greetings, fellow Penguin!
2020-08-02 18:12:02 +00:00
#
#
# This script is designed to help you optimize your system to run
# Star Citizen as smoothly as possible.
2020-08-02 18:12:02 +00:00
#
# It presents options to check your system for optimal settings
# and helps you change them as needed to prevent game crashes.
2020-08-02 18:12:02 +00:00
#
#
2020-08-22 01:24:26 +00:00
# It also gives you a fast and easy way to 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,
2020-08-22 01:24:26 +00:00
# then restore your keybind file(s).
2020-08-02 18:12:02 +00:00
#
# To export your keybinds from within the game, go to
# Options->Keybindings->Control Profiles->Save Control Settings
#
2020-08-22 01:24:26 +00:00
# To import your keybinds from within the game, select them from the list:
# Options->Keybindings->Control Profiles
#
2020-08-02 18:12:02 +00:00
############################################################################
2020-08-10 20:03:11 +00:00
wine_conf="winedir.conf"
game_conf="gamedir.conf"
backup_conf="backupdir.conf"
# Use the XDG config directory if defined
if [ -z "$XDG_CONFIG_HOME" ]; then
conf_dir="$HOME/.config"
else
conf_dir="$XDG_CONFIG_HOME"
fi
2020-08-02 18:12:02 +00:00
2020-08-10 20:03:11 +00:00
conf_subdir="starcitizen-lug"
# Set some variables needed by the getdirs() function
# The user subdirectory name
user_subdir_name="USER"
# The location within the USER directory to which the game exports keybinds
keybinds_export_path="Controls/Mappings"
2020-08-02 18:12:02 +00:00
############################################################################
############################################################################
2020-08-10 01:30:10 +00:00
2020-09-07 22:51:19 +00:00
# Display a message to the user.
# Expects the first argument to indicate the message type, followed by
2020-09-07 22:51:19 +00:00
# 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]"
2020-09-07 22:51:19 +00:00
# See the message types below for instructions on formatting the string.
message() {
# Sanity check
if [ "$#" -lt 2 ]; then
echo -e "\nScript error: The message function expects two arguments. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
fi
# Use zenity messages if available
2020-08-03 22:15:38 +00:00
if [ "$has_zen" -eq 1 ]; then
case "$1" in
"info")
# info message
# call format: message info "text to display"
margs=("--info" "--no-wrap" "--text=")
;;
"warning")
# warning message
# call format: message warning "text to display"
margs=("--warning" "--text=")
;;
"question")
# question
# call format: message question "question to ask?"
margs=("--question" "--text=")
;;
*)
echo -e "\nScript Error: Invalid message type passed to the message function. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
;;
esac
2020-08-02 18:12:02 +00:00
2020-08-03 22:15:38 +00:00
# Display the message
2020-09-07 23:42:18 +00:00
shift 1 # drop the first numerical argument and shift the remaining up one
zenity "${margs[@]}""$@" --width="400" --title="Star Citizen LUG Helper"
else
2020-09-07 23:42:18 +00:00
# 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
echo -e "\n$2\n"
read -n 1 -s -p "Press any key..."
;;
"warning")
# warning message
# call format: message warning "text to display"
clear
echo -e "\n$2\n"
read -n 1 -s -p "Press any key..."
return 0
;;
"question")
# question
# call format: message question "question to ask?"
clear
echo -e "$2"
while read -p "[y/n]: " yn; do
case "$yn" in
[Yy]*)
return 0
;;
[Nn]*)
return 1
;;
*)
echo "Please type 'y' or 'n'"
;;
esac
done
;;
*)
echo -e "\nScript Error: Invalid message type passed to the message function. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
;;
esac
fi
2020-08-02 18:12:02 +00:00
}
2020-09-07 22:51:19 +00:00
# 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_zenity_text" and "menu_terminal_text"
# and one integer variable: "menu_height".
#
# The array "menu_options" is expected to contain the strings of each option.
# The array "menu_actions" is expected to contain function names to be called.
# The strings "menu_zenity_text" and "menu_terminal_text" are expected to
# contain menu text formatted for zenity and the terminal, respectively.
# The integer "menu_height" specifies the height of the zenity menu.
#
# 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.
menu() {
# Sanity checks
if [ "${#menu_options[@]}" -eq 0 ]; then
echo -e "\nScript error: The array 'menu_options' was not set\nbefore calling the menu function. Aborting."
read -n 1 -s -p "Press any key..."
2020-09-07 22:51:19 +00:00
exit 0
elif [ "${#menu_actions[@]}" -eq 0 ]; then
echo -e "\nScript error: The array 'menu_actions' was not set\nbefore calling the menu function. Aborting."
read -n 1 -s -p "Press any key..."
2020-09-07 22:51:19 +00:00
exit 0
elif [ -z "$menu_zenity_text" ]; then
echo -e "\nScript error: The string 'menu_zenity_text' was not set\nbefore calling the menu function. Aborting."
read -n 1 -s -p "Press any key..."
2020-09-07 22:51:19 +00:00
exit 0
elif [ -z "$menu_terminal_text" ]; then
echo -e "\nScript error: The string 'menu_terminal_text' was not set\nbefore calling the menu function. Aborting."
read -n 1 -s -p "Press any key..."
2020-09-07 22:51:19 +00:00
exit 0
elif [ -z "$menu_height" ]; then
echo -e "\nScript error: The string 'menu_height' was not set\nbefore calling the menu function. Aborting."
read -n 1 -s -p "Press any key..."
2020-09-07 22:51:19 +00:00
exit 0
fi
# Use Zenity if it is available
if [ "$has_zen" -eq 1 ]; then
# Format the options array for Zenity by adding
# TRUE or FALSE to indicate default selections
2020-09-07 23:42:18 +00:00
# ie: "TRUE" "List item 1" "FALSE" "List item 2" "FALSE" "List item 3"
2020-09-07 22:51:19 +00:00
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
2020-09-07 23:42:18 +00:00
# Display the zenity radio button menu
choice="$(zenity --list --radiolist --width="400" --height="$menu_height" --text="$menu_zenity_text" --title="Star Citizen LUG Helper" --hide-header --column="" --column="Option" "${zen_options[@]}")"
2020-09-07 22:51:19 +00:00
# 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
2020-09-07 22:51:19 +00:00
# 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
2020-09-07 22:51:19 +00:00
# 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
echo -e "$menu_terminal_text"
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
2020-09-07 22:51:19 +00:00
# Execute the corresponding action
echo -e "\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
echo -e "\nInvalid selection."
2020-09-07 22:51:19 +00:00
continue
fi
done
fi
}
2020-08-10 20:03:11 +00:00
# Get paths to the user's wine prefix, game directory, and a backup directory
2020-08-10 01:30:10 +00:00
getdirs() {
2020-08-10 20:03:11 +00:00
# Sanity checks
if [ ! -d "$conf_dir" ]; then
message warning "Config directory not found. The helper is unable to proceed.\n\n$conf_dir"
2020-08-15 02:33:04 +00:00
return 1
2020-08-10 20:03:11 +00:00
fi
if [ ! -d "$conf_dir/$conf_subdir" ]; then
mkdir "$conf_dir/$conf_subdir"
fi
# Check if the config files already exist
if [ -f "$conf_dir/$conf_subdir/$wine_conf" ]; then
2020-08-12 00:42:44 +00:00
wine_prefix="$(cat "$conf_dir/$conf_subdir/$wine_conf")"
2020-08-22 01:02:16 +00:00
if [ ! -d "$wine_prefix" ]; then
echo -e "\nThe saved wine prefix does not exist, ignoring.\n"
wine_prefix=""
fi
2020-08-10 20:03:11 +00:00
fi
if [ -f "$conf_dir/$conf_subdir/$game_conf" ]; then
2020-08-12 00:42:44 +00:00
game_path="$(cat "$conf_dir/$conf_subdir/$game_conf")"
if [ ! -d "$game_path" ] || ([ "$(basename "$game_path")" != "Star Citizen" ] && [ "$(basename "$game_path")" != "StarCitizen" ]); then
2020-08-18 01:57:24 +00:00
echo -e "\nUnexpected game path found in config file, ignoring.\n"
game_path=""
fi
2020-08-10 20:03:11 +00:00
fi
if [ -f "$conf_dir/$conf_subdir/$backup_conf" ]; then
2020-08-12 00:42:44 +00:00
backup_path="$(cat "$conf_dir/$conf_subdir/$backup_conf")"
2020-08-22 01:02:16 +00:00
if [ ! -d "$backup_path" ]; then
echo -e "\nThe saved backup path does not exist, ignoring.\n"
backup_path=""
fi
2020-08-10 20:03:11 +00:00
fi
2020-08-22 01:02:16 +00:00
# If we don't have the directory paths we need yet, ask the user to provide them
2020-08-12 02:02:44 +00:00
if [ -z "$wine_prefix" ] || [ -z "$game_path" ] || [ -z "$backup_path" ]; then
message info "You will now be asked to provide some directories needed by the helper.\n\nThey will be saved for later use in:\n$conf_dir/$conf_subdir/"
2020-08-12 00:42:44 +00:00
if [ "$has_zen" -eq 1 ]; then
# Get the wine prefix directory
2020-08-12 02:02:44 +00:00
if [ -z "$wine_prefix" ]; then
wine_prefix="$(zenity --file-selection --directory --title="Select your WINE prefix directory" --filename="$HOME/.wine")"
2020-08-12 00:42:44 +00:00
if [ "$?" -eq -1 ]; then
message warning "An unexpected error has occurred. The helper is unable to proceed."
2020-08-15 02:33:04 +00:00
return 1
2020-08-12 02:02:44 +00:00
elif [ -z "$wine_prefix" ]; then
# User clicked cancel
message warning "Operation cancelled.\nNo changes have been made to your game."
2020-08-15 02:33:04 +00:00
return 1
2020-08-12 00:42:44 +00:00
fi
2020-08-10 20:03:11 +00:00
fi
2020-08-12 00:42:44 +00:00
# Get the game path
2020-08-12 02:02:44 +00:00
if [ -z "$game_path" ]; then
2020-11-21 13:42:07 +00:00
while game_path="$(zenity --file-selection --directory --title="Select your Star Citizen directory" --filename="$wine_prefix/drive_c/Program Files/Roberts Space Industries/StarCitizen")"; do
2020-08-12 00:42:44 +00:00
if [ "$?" -eq -1 ]; then
message warning "An unexpected error has occurred. The helper is unable to proceed."
2020-08-15 02:33:04 +00:00
return 1
elif [ "$(basename "$game_path")" != "Star Citizen" ] && [ "$(basename "$game_path")" != "StarCitizen" ]; then
2020-11-21 13:42:07 +00:00
message warning "You must select the directory named 'StarCitizen'"
2020-08-12 02:02:44 +00:00
else
# All good or cancel
2020-08-12 00:42:44 +00:00
break
fi
done
2020-08-12 02:02:44 +00:00
if [ -z "$game_path" ]; then
# User clicked cancel
message warning "Operation cancelled.\nNo changes have been made to your game."
2020-08-15 02:33:04 +00:00
return 1
2020-08-12 02:02:44 +00:00
fi
2020-08-12 00:42:44 +00:00
fi
2020-08-10 20:03:11 +00:00
2020-08-12 00:42:44 +00:00
# Get the backup directory
2020-08-12 02:02:44 +00:00
if [ -z "$backup_path" ]; then
2020-11-21 13:42:07 +00:00
while backup_path="$(zenity --file-selection --directory --title="Select a directory to back up your keybinds into" --filename="$HOME/")"; do
if [ "$?" -eq -1 ]; then
message warning "An unexpected error has occurred. The helper is unable to proceed."
return 1
2020-11-21 14:29:30 +00:00
elif [[ $backup_path == $game_path* ]]; then
2020-11-21 13:42:07 +00:00
message warning "Please select a backup location outside your Star Citizen directory.\nie. /home/USER/backups/"
else
# All good or cancel
break
fi
done
if [ -z "$backup_path" ]; then
2020-08-12 02:02:44 +00:00
# User clicked cancel
message warning "Operation cancelled.\nNo changes have been made to your game."
2020-08-15 02:33:04 +00:00
return 1
2020-08-12 00:42:44 +00:00
fi
2020-08-10 20:03:11 +00:00
fi
2020-08-12 00:42:44 +00:00
else
clear
# Get the wine prefix directory
2020-08-12 02:02:44 +00:00
if [ -z "$wine_prefix" ]; then
echo -e "Enter the full path to your WINE prefix directory (case sensitive)"
2020-08-12 00:42:44 +00:00
echo -e "ie. /home/USER/.wine/"
while read -rp ": " wine_prefix; do
if [ ! -d "$wine_prefix" ]; then
echo -e "That directory is invalid or does not exist. Please try again.\n"
else
break
fi
done
2020-08-10 01:30:10 +00:00
2020-08-12 00:42:44 +00:00
# Get the game path
2020-08-12 02:02:44 +00:00
if [ -z "$game_path" ]; then
2020-08-18 01:57:24 +00:00
echo -e "\nEnter the full path to your Star Citizen installation directory\n(case sensitive)"
2020-11-21 13:42:07 +00:00
echo -e "ie. /home/USER/.wine/drive_c/Program Files/Roberts Space Industries/StarCitizen/"
2020-08-12 00:42:44 +00:00
while read -rp ": " game_path; do
if [ ! -d "$game_path" ]; then
echo -e "That directory is invalid or does not exist. Please try again.\n"
elif [ "$(basename "$game_path")" != "Star Citizen" ] && [ "$(basename "$game_path")" != "StarCitizen" ]; then
2020-11-21 13:42:07 +00:00
echo -e "You must enter the full path to the directory named 'StarCitizen'\n"
2020-08-12 00:42:44 +00:00
else
break
fi
done
fi
2020-08-10 01:30:10 +00:00
2020-08-12 00:42:44 +00:00
# Get the backup directory
2020-08-12 02:02:44 +00:00
if [ -z "$backup_path" ]; then
echo -e "\nEnter the full path to a backup directory for your keybinds (case sensitive)"
2020-08-12 00:42:44 +00:00
echo -e "ie. /home/USER/backups/"
while read -rp ": " backup_path; do
if [ ! -d "$backup_path" ]; then
echo -e "That directory is invalid or does not exist. Please try again.\n"
2020-11-21 14:29:30 +00:00
elif [[ $backup_path == $game_path* ]]; then
2020-11-21 13:42:07 +00:00
echo -e "Please select a backup location outside your Star Citizen directory.\nie. /home/USER/backups/\n"
2020-08-12 00:42:44 +00:00
else
break
fi
done
fi
fi
fi
2020-08-10 20:03:11 +00:00
# Save the paths for later use
echo "$wine_prefix" > "$conf_dir/$conf_subdir/$wine_conf"
echo "$game_path" > "$conf_dir/$conf_subdir/$game_conf"
echo "$backup_path" > "$conf_dir/$conf_subdir/$backup_conf"
fi
# Set some remaining directory paths
user_dir="$game_path/$live_or_ptu/$user_subdir_name"
keybinds_dir="$user_dir/$keybinds_export_path"
2020-08-10 01:30:10 +00:00
}
2020-08-02 18:12:02 +00:00
# Save exported keybinds, wipe the USER directory, and restore keybinds
sanitize() {
2020-08-12 00:42:44 +00:00
# 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."
2020-08-10 20:03:11 +00:00
2020-08-12 00:42:44 +00:00
# Get/Set directory paths
getdirs
2020-08-15 02:33:04 +00:00
if [ "$?" -eq 1 ]; then
# User cancelled and wants to return to the main menu, or there was an error
return 0
fi
2020-08-02 18:12:02 +00:00
2020-08-12 02:46:05 +00:00
# Sanity check
if [ ! -d "$user_dir" ]; then
message warning "USER directory not found. There is nothing to delete!\n\n$user_dir"
2020-08-15 02:33:04 +00:00
return 0
2020-08-12 02:46:05 +00:00
fi
2020-08-12 00:42:44 +00:00
# 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
2020-08-12 02:46:05 +00:00
exported=0
else
2020-08-15 02:33:04 +00:00
# User said no
return 0
2020-08-12 02:46:05 +00:00
fi
2020-08-12 00:42:44 +00:00
else
exported=1
fi
2020-08-02 18:12:02 +00:00
if message question "This helper will delete the following directory:\n\n$user_dir\n\nDo you want to proceed?"; then
2020-08-23 14:01:38 +00:00
# Back up keybinds
if [ "$exported" -eq 1 ]; then
echo "Backing up all saved keybinds..."
cp -r "$keybinds_dir/." "$backup_path/keybinds/"
2020-08-23 14:01:38 +00:00
echo -e "Done.\n"
fi
# Wipe the user directory
echo "Wiping USER directory..."
rm -r "$user_dir"
2020-08-12 00:42:44 +00:00
echo -e "Done.\n"
2020-08-02 18:12:02 +00:00
2020-08-23 14:01:38 +00:00
# Restore custom keybinds
if [ "$exported" -eq 1 ]; then
echo "Restoring keybinds..."
mkdir -p "$keybinds_dir" && cp -r "$backup_path/keybinds/." "$keybinds_dir/"
2020-08-23 14:01:38 +00:00
echo -e "Done.\n"
message info "To re-import your keybinds, select it in-game from the list:\nOptions->Keybindings->Control Profiles"
2020-08-23 14:01:38 +00:00
fi
message info "Your Star Citizen USER directory has been cleaned up!"
2020-08-23 14:01:38 +00:00
fi
2020-08-02 18:12:02 +00:00
}
# Check if setting vm.max_map_count was successful
mapcount_check() {
2020-08-02 18:12:02 +00:00
if [ "$(cat /proc/sys/vm/max_map_count)" -lt 16777216 ]; then
message warning "As far as this helper can detect, vm.max_map_count\nwas not successfully configured on your system.\n\nYou will most likely experience crashes."
2020-08-02 18:12:02 +00:00
fi
}
2020-09-07 22:51:19 +00:00
# Sets vm.max_map_count for the current session only
mapcount_once() {
pkexec sh -c 'sysctl -w vm.max_map_count=16777216'
mapcount_check
2020-09-07 22:51:19 +00:00
}
# Sets vm.max_map_count to persist between reboots
mapcount_persist() {
if [ -d "/etc/sysctl.d" ]; then
pkexec sh -c 'echo "vm.max_map_count = 16777216" >> /etc/sysctl.d/20-max_map_count.conf && sysctl --system'
2020-09-07 22:51:19 +00:00
else
pkexec sh -c 'echo "vm.max_map_count = 16777216" >> /etc/sysctl.conf && sysctl -p'
fi
mapcount_check
2020-09-07 22:51:19 +00:00
}
# Displays instructions for the user to manually set vm.max_map_count
mapcount_manual() {
if [ -d "/etc/sysctl.d" ]; then
# Newer versions of sysctl
message info "To change the setting (a kernel parameter) until next boot, run:\n\nsudo sh -c 'sysctl -w vm.max_map_count=16777216'\n\n\nTo persist the setting between reboots, run:\n\nsudo sh -c 'echo \"vm.max_map_count = 16777216\" >> /etc/sysctl.d/20-max_map_count.conf &amp;&amp; sysctl --system'"
2020-09-07 22:51:19 +00:00
else
# Older versions of sysctl
message info "To change the setting (a kernel parameter) until next boot, run:\n\nsudo sh -c 'sysctl -w vm.max_map_count=16777216'\n\n\nTo persist the setting between reboots, run:\n\nsudo sh -c 'echo \"vm.max_map_count = 16777216\" >> /etc/sysctl.conf &amp;&amp; sysctl -p'"
2020-09-07 22:51:19 +00:00
fi
}
# Check vm.max_map_count for the correct setting and let the user fix it
mapcount_set() {
2020-08-02 18:12:02 +00:00
# If vm.max_map_count is already set, no need to do anything
if [ "$(cat /proc/sys/vm/max_map_count)" -ge 16777216 ]; then
message info "vm.max_map_count is already set to the optimal value.\nYou're all set!"
2020-08-15 02:33:04 +00:00
return 0
2020-08-02 18:12:02 +00:00
fi
2020-08-22 01:02:16 +00:00
# Otherwise, check to see if it was supposed to be set by sysctl
2020-08-02 18:12:02 +00:00
if grep -E -x -q "vm.max_map_count" /etc/sysctl.conf /etc/sysctl.d/* 2>/dev/null; then
if message question "It looks like you've already configured vm.max_map_count\nand saved the setting to persist across reboots.\nHowever, for some reason the persistence part did not work.\n\nFor now, would you like to enable the setting again until the next reboot?"; then
2020-08-02 18:12:02 +00:00
pkexec sh -c 'sysctl -w vm.max_map_count=16777216'
fi
mapcount_check
2020-08-15 02:33:04 +00:00
return 0
2020-08-02 18:12:02 +00:00
fi
2020-09-07 22:51:19 +00:00
# Configure the menu
menu_zenity_text="<b>This helper can change vm.max_map_count for you.</b>\n\nChoose from the following options:"
menu_terminal_text="\nThis helper can change vm.max_map_count for you.\n\nChoose from the following options:\n"
menu_height="200"
# Configure the menu options
2020-08-02 18:12:02 +00:00
once="Change setting until next reboot"
persist="Change setting and persist after reboot"
manual="Show me the commands; I'll handle it myself"
goback="Return to the main menu"
2020-08-15 16:23:25 +00:00
2020-09-07 22:51:19 +00:00
# Set the menu options
menu_options=("$once" "$persist" "$manual" "$goback")
# Set the corresponding functions to be called for each of the options
menu_actions=("mapcount_once" "mapcount_persist" "mapcount_manual" "mapcount_check")
2020-09-07 22:51:19 +00:00
# Display an informational message to the user
message info "Running Star Citizen requires changing a system setting\nto give the game access to more than 8GB of memory.\n\nvm.max_map_count must be increased to at least 16777216\nto avoid crashes in areas with lots of geometry.\n\n\nAs far as this helper can detect, the setting\nhas not been changed on your system.\n\nYou will now be given the option to change it."
2020-09-07 22:51:19 +00:00
# Call the menu function
menu
2020-08-02 18:12:02 +00:00
}
2020-09-04 00:56:53 +00:00
# Check if setting the open file descriptors limit was successful
2020-09-08 01:59:34 +00:00
filelimit_check() {
2020-09-04 00:56:53 +00:00
if [ "$(ulimit -Hn)" -lt 524288 ]; then
message warning "As far as this helper can detect, the open files limit\nwas not successfully configured on your system.\nYou may experience crashes.\n\nWe recommend manually configuring this limit to at least 524288."
2020-09-04 00:56:53 +00:00
fi
}
2020-09-07 22:51:19 +00:00
# Check the open file descriptors limit and let the user fix it if needed
2020-09-08 01:59:34 +00:00
filelimit_set() {
filelimit="$(ulimit -Hn)"
2020-09-04 00:56:53 +00:00
# If the file limit is already set, no need to do anything
if [ "$filelimit" -ge 524288 ]; then
message info "Your open files limit is already set to the optimal value.\nYou're all set!"
2020-09-04 00:56:53 +00:00
return 0
fi
2020-09-04 01:20:06 +00:00
# Adjust the limit
if message question "We recommend setting the hard open\nfile descriptors limit to at least 524288.\n\nThe current value on your system appears to be $filelimit.\n\nWould you like this helper to change it for you?"; then
2020-09-05 12:12:11 +00:00
if [ -f "/etc/systemd/system.conf" ]; then
2020-09-04 00:56:53 +00:00
# Using systemd
echo -e "Updating /etc/systemd/system.conf..."
# Append to the file
2020-09-05 12:03:23 +00:00
pkexec sh -c 'echo "DefaultLimitNOFILE=524288" >> /etc/systemd/system.conf && systemctl daemon-reexec'
2020-09-04 00:56:53 +00:00
echo -e "Done.\n"
elif [ -f "/etc/security/limits.conf" ]; then
# Using limits.conf
echo -e "Updating /etc/security/limits.conf..."
# Insert before the last line in the file
pkexec sh -c 'sed -i "\$i* hard nofile 524288" /etc/security/limits.conf'
echo -e "Done.\n"
else
2020-09-04 01:20:06 +00:00
# Don't know what method to use
message warning "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."
2020-09-04 01:20:06 +00:00
return 0
2020-09-04 00:56:53 +00:00
fi
fi
2020-09-04 01:20:06 +00:00
# Verify that setting the limit was successful
2020-09-08 01:59:34 +00:00
filelimit_check
}
2020-08-17 21:53:25 +00:00
# Delete the shaders directory
rm_shaders() {
# Get/Set directory paths
getdirs
if [ "$?" -eq 1 ]; then
2020-09-07 22:51:19 +00:00
# User cancelled and wants to return to the main menu, or error
2020-08-17 21:53:25 +00:00
return 0
fi
2020-08-22 01:02:16 +00:00
shaders_dir="$user_dir/Shaders"
2020-08-17 21:53:25 +00:00
# Sanity check
if [ ! -d "$shaders_dir" ]; then
message warning "Shaders directory not found. There is nothing to delete!\n\n$shaders_dir"
2020-08-17 21:53:25 +00:00
return 0
fi
# Delete the shader directory
if message question "This helper will delete the following directory:\n\n$shaders_dir\n\nDo you want to proceed?"; then
2020-08-23 14:01:38 +00:00
echo "Deleting shaders..."
rm -r "$shaders_dir"
echo -e "Done.\n"
message info "Your shaders have been deleted!"
2020-08-23 14:01:38 +00:00
fi
2020-08-17 21:53:25 +00:00
}
2020-08-21 22:49:28 +00:00
# Delete DXVK cache
2020-08-17 21:53:25 +00:00
rm_vidcache() {
# 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
2020-08-22 01:02:16 +00:00
dxvk_cache="$game_path/$live_or_ptu/StarCitizen-dxvk.cache"
2020-08-17 21:53:25 +00:00
# Sanity check
2020-08-21 22:49:28 +00:00
if [ ! -f "$dxvk_cache" ]; then
message warning "Unable to find the DXVK cache file. There is nothing to delete!\n\n$dxvk_cache"
2020-08-17 21:53:25 +00:00
return 0
fi
2020-08-21 22:49:28 +00:00
# Delete the cache file
if message question "This helper will delete the following file:\n\n$dxvk_cache\n\nDo you want to proceed?"; then
2020-08-23 14:01:38 +00:00
echo "Deleting DXVK cache..."
rm "$dxvk_cache"
echo -e "Done.\n"
message info "Your DXVK cache has been deleted!"
2020-08-23 14:01:38 +00:00
fi
2020-08-17 21:53:25 +00:00
}
2020-08-19 01:19:26 +00:00
# Toggle between targeting the LIVE and PTU game directories for all helper functions
set_version() {
if [ "$live_or_ptu" = "LIVE" ]; then
2020-08-19 01:19:26 +00:00
live_or_ptu="PTU"
message info "The helper will now target your Star Citizen PTU installation."
elif [ "$live_or_ptu" = "PTU" ]; then
2020-08-19 01:19:26 +00:00
live_or_ptu="LIVE"
message info "The helper will now target your Star Citizen LIVE installation."
2020-08-19 01:19:26 +00:00
else
echo -e "\nUnexpected game version provided. Defaulting to the LIVE installation."
live_or_ptu="LIVE"
fi
}
2020-09-07 22:51:19 +00:00
quit() {
exit 0
}
############################################################################
# MAIN
############################################################################
# Check if Zenity is available
has_zen=0
if [ -x "$(command -v zenity)" ]; then
has_zen=1
2020-08-02 18:12:02 +00:00
fi
2020-08-18 01:57:24 +00:00
# Default to LIVE
live_or_ptu="LIVE"
# Loop the main menu until the user selects quit
while true; do
2020-09-07 22:51:19 +00:00
# Configure the menu
menu_zenity_text="<b><big>Welcome, fellow Penguin, to the Star Citizen LUG Helper!</big>\n\nThis helper is designed to help optimize your system for Star Citizen</b>\n\nYou may choose from the following options:"
menu_terminal_text="\nWelcome, 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:\n"
menu_height="315"
# Configure the menu options
mapcount_msg="Check vm.max_map_count for optimal performance"
filelimit_msg="Check my open file descriptors limit"
sanitize_msg="Delete my Star Citizen USER folder and preserve my keybinds"
shaders_msg="Delete my shaders only"
vidcache_msg="Delete my DXVK cache"
version_msg="Switch the helper between LIVE and PTU (default is LIVE)"
quit_msg="Quit"
# Set the menu options
menu_options=("$mapcount_msg" "$filelimit_msg" "$sanitize_msg" "$shaders_msg" "$vidcache_msg" "$version_msg" "$quit_msg")
# Set the corresponding functions to be called for each of the options
2020-09-08 01:59:34 +00:00
menu_actions=("mapcount_set" "filelimit_set" "sanitize" "rm_shaders" "rm_vidcache" "set_version" "quit")
2020-09-07 22:51:19 +00:00
# Call the menu function
menu
done