mirror of
https://github.com/the-sane/lug-helper.git
synced 2024-09-21 14:02:52 +00:00
663 lines
24 KiB
Bash
Executable File
663 lines
24 KiB
Bash
Executable File
#!/bin/bash
|
|
|
|
############################################################################
|
|
# Star Citizen's Linux Users Group Helper Script
|
|
############################################################################
|
|
#
|
|
# Greetings, fellow Penguin!
|
|
#
|
|
#
|
|
# This script is designed to help you optimize your system to run
|
|
# Star Citizen as smoothly as possible.
|
|
#
|
|
# It presents options to check your system for optimal settings
|
|
# and helps you change them as needed to prevent game crashes.
|
|
#
|
|
#
|
|
# 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,
|
|
# then restore your keybind file(s).
|
|
#
|
|
# 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
|
|
#
|
|
############################################################################
|
|
|
|
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
|
|
|
|
conf_subdir="starcitizen-lug"
|
|
############################################################################
|
|
############################################################################
|
|
|
|
|
|
# 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
|
|
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
|
|
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
|
|
|
|
# Display the message
|
|
shift 1 # drop the first numerical argument and shift the remaining up one
|
|
zenity "${margs[@]}""$@" --width="400" --title="Star Citizen LUG Helper"
|
|
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
|
|
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
|
|
}
|
|
|
|
# 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..."
|
|
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..."
|
|
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..."
|
|
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..."
|
|
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..."
|
|
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
|
|
# 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="400" --height="$menu_height" --text="$menu_zenity_text" --title="Star Citizen LUG Helper" --hide-header --column="" --column="Option" "${zen_options[@]}")"
|
|
|
|
# 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
|
|
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
|
|
# Execute the corresponding action
|
|
echo -e "\n"
|
|
"${menu_actions[i]}"
|
|
matched="true"
|
|
break
|
|
fi
|
|
done
|
|
|
|
# If no match was found, the user entered an invalid option
|
|
if [ "$matched" == "false" ]; then
|
|
echo -e "\nInvalid selection."
|
|
continue
|
|
else
|
|
# Match was found and actioned, so exit the menu
|
|
break
|
|
fi
|
|
done
|
|
fi
|
|
}
|
|
|
|
# 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 "$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
|
|
echo -e "\nThe saved wine prefix does not exist, ignoring.\n"
|
|
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")" != "Star Citizen" ]; then
|
|
echo -e "\nUnexpected game path found in config file, ignoring.\n"
|
|
game_path=""
|
|
fi
|
|
fi
|
|
if [ -f "$conf_dir/$conf_subdir/$backup_conf" ]; then
|
|
backup_path="$(cat "$conf_dir/$conf_subdir/$backup_conf")"
|
|
if [ ! -d "$backup_path" ]; then
|
|
echo -e "\nThe saved backup path does not exist, ignoring.\n"
|
|
backup_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" ] || [ -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/"
|
|
if [ "$has_zen" -eq 1 ]; then
|
|
# Get the wine prefix directory
|
|
if [ -z "$wine_prefix" ]; then
|
|
wine_prefix="$(zenity --file-selection --directory --title="Select your WINE prefix directory" --filename="$HOME/.wine")"
|
|
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
|
|
while game_path="$(zenity --file-selection --directory --title="Select your Star Citizen directory" --filename="$wine_prefix/drive_c/Program Files/Roberts Space Industries/Star Citizen")"; do
|
|
if [ "$?" -eq -1 ]; then
|
|
message warning "An unexpected error has occurred. The helper is unable to proceed."
|
|
return 1
|
|
elif [ "$(basename "$game_path")" != "Star Citizen" ]; then
|
|
message warning "You must select the directory named 'Star Citizen'"
|
|
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
|
|
|
|
# Get the backup directory
|
|
if [ -z "$backup_path" ]; then
|
|
backup_path="$(zenity --file-selection --directory --title="Select a backup directory for your keybinds" --filename="$HOME/")"
|
|
if [ "$?" -eq -1 ]; then
|
|
message warning "An unexpected error has occurred. The helper is unable to proceed."
|
|
return 1
|
|
elif [ -z "$backup_path" ]; then
|
|
# User clicked cancel
|
|
message warning "Operation cancelled.\nNo changes have been made to your game."
|
|
return 1
|
|
fi
|
|
fi
|
|
else
|
|
clear
|
|
# Get the wine prefix directory
|
|
if [ -z "$wine_prefix" ]; then
|
|
echo -e "Enter the full path to your WINE prefix directory (case sensitive)"
|
|
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
|
|
|
|
# Get the game path
|
|
if [ -z "$game_path" ]; then
|
|
echo -e "\nEnter the full path to your Star Citizen installation directory\n(case sensitive)"
|
|
echo -e "ie. /home/USER/.wine/drive_c/Program Files/Roberts Space Industries/Star Citizen/"
|
|
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" ]; then
|
|
echo -e "You must enter the full path to the directory named 'Star Citizen'"
|
|
else
|
|
break
|
|
fi
|
|
done
|
|
fi
|
|
|
|
# Get the backup directory
|
|
if [ -z "$backup_path" ]; then
|
|
echo -e "\nEnter the full path to a backup directory for your keybinds (case sensitive)"
|
|
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"
|
|
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"
|
|
echo "$backup_path" > "$conf_dir/$conf_subdir/$backup_conf"
|
|
fi
|
|
|
|
# Set some remaining directory paths
|
|
user_dir="$game_path/$live_or_ptu/USER"
|
|
mappings_dir="$user_dir/Controls/Mappings"
|
|
}
|
|
|
|
# Save exported keybinds, wipe the USER directory, and restore keybinds
|
|
sanitize() {
|
|
# 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 "$mappings_dir" ] || [ -z "$(ls -A "$mappings_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 "This helper will delete the following directory:\n\n$user_dir\n\nDo you want to proceed?"; then
|
|
# Back up keybinds
|
|
if [ "$exported" -eq 1 ]; then
|
|
echo "Backing up all saved keybinds..."
|
|
cp -r "$mappings_dir/." "$backup_path/keybinds/"
|
|
echo -e "Done.\n"
|
|
fi
|
|
|
|
# Wipe the user directory
|
|
echo "Wiping USER directory..."
|
|
rm -r "$user_dir"
|
|
echo -e "Done.\n"
|
|
|
|
# Restore custom keybinds
|
|
if [ "$exported" -eq 1 ]; then
|
|
echo "Restoring keybinds..."
|
|
mkdir -p "$mappings_dir" && cp -r "$backup_path/keybinds/." "$mappings_dir/"
|
|
echo -e "Done.\n"
|
|
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
|
|
}
|
|
|
|
# Check if setting vm.max_map_count was successful
|
|
mapcount_check() {
|
|
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."
|
|
fi
|
|
}
|
|
|
|
# Sets vm.max_map_count for the current session only
|
|
mapcount_once() {
|
|
pkexec sh -c 'sysctl -w vm.max_map_count=16777216'
|
|
mapcount_check
|
|
}
|
|
|
|
# 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 -p'
|
|
else
|
|
pkexec sh -c 'echo "vm.max_map_count = 16777216" >> /etc/sysctl.conf && sysctl -p'
|
|
fi
|
|
mapcount_check
|
|
}
|
|
|
|
# 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 && sysctl -p'"
|
|
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 && sysctl -p'"
|
|
fi
|
|
}
|
|
|
|
# Check vm.max_map_count for the correct setting and let the user fix it
|
|
mapcount_set() {
|
|
# 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!"
|
|
return 0
|
|
fi
|
|
|
|
# Otherwise, check to see if it was supposed to be set by sysctl
|
|
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
|
|
pkexec sh -c 'sysctl -w vm.max_map_count=16777216'
|
|
fi
|
|
mapcount_check
|
|
return 0
|
|
fi
|
|
|
|
# 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
|
|
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"
|
|
|
|
# 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")
|
|
|
|
# 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."
|
|
|
|
# Call the menu function
|
|
menu
|
|
}
|
|
|
|
# Check if setting the open file descriptors limit was successful
|
|
check_filelimit() {
|
|
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."
|
|
fi
|
|
}
|
|
|
|
# Check the open file descriptors limit and let the user fix it if needed
|
|
set_filelimit() {
|
|
filelimit="$(ulimit -Hn)"
|
|
|
|
# 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!"
|
|
return 0
|
|
fi
|
|
|
|
# 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
|
|
if [ -f "/etc/systemd/system.conf" ]; then
|
|
# Using systemd
|
|
echo -e "Updating /etc/systemd/system.conf..."
|
|
# Append to the file
|
|
pkexec sh -c 'echo "DefaultLimitNOFILE=524288" >> /etc/systemd/system.conf && systemctl daemon-reexec'
|
|
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
|
|
# 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."
|
|
return 0
|
|
fi
|
|
fi
|
|
|
|
# Verify that setting the limit was successful
|
|
check_filelimit
|
|
}
|
|
|
|
# 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
|
|
|
|
shaders_dir="$user_dir/Shaders"
|
|
|
|
# Sanity check
|
|
if [ ! -d "$shaders_dir" ]; then
|
|
message warning "Shaders directory not found. There is nothing to delete!\n\n$shaders_dir"
|
|
return 0
|
|
fi
|
|
|
|
# Delete the shader directory
|
|
if message question "This helper will delete the following directory:\n\n$shaders_dir\n\nDo you want to proceed?"; then
|
|
echo "Deleting shaders..."
|
|
rm -r "$shaders_dir"
|
|
echo -e "Done.\n"
|
|
message info "Your shaders have been deleted!"
|
|
fi
|
|
}
|
|
|
|
# Delete DXVK cache
|
|
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
|
|
|
|
dxvk_cache="$game_path/$live_or_ptu/StarCitizen-dxvk.cache"
|
|
|
|
# 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 "This helper will delete the following file:\n\n$dxvk_cache\n\nDo you want to proceed?"; then
|
|
echo "Deleting DXVK cache..."
|
|
rm "$dxvk_cache"
|
|
echo -e "Done.\n"
|
|
message info "Your DXVK cache has been deleted!"
|
|
fi
|
|
}
|
|
|
|
# Toggle between targeting the LIVE and PTU game directories for all helper functions
|
|
set_version() {
|
|
if [ "$live_or_ptu" == "LIVE" ]; then
|
|
live_or_ptu="PTU"
|
|
message info "The helper will now target your Star Citizen PTU installation."
|
|
elif [ "$live_or_ptu" == "PTU" ]; then
|
|
live_or_ptu="LIVE"
|
|
message info "The helper will now target your Star Citizen LIVE installation."
|
|
else
|
|
echo -e "\nUnexpected game version provided. Defaulting to the LIVE installation."
|
|
live_or_ptu="LIVE"
|
|
fi
|
|
}
|
|
|
|
quit() {
|
|
exit 0
|
|
}
|
|
|
|
############################################################################
|
|
# MAIN
|
|
############################################################################
|
|
|
|
# Check if Zenity is available
|
|
has_zen=0
|
|
if [ -x "$(command -v zenity)" ]; then
|
|
has_zen=1
|
|
fi
|
|
|
|
# Default to LIVE
|
|
live_or_ptu="LIVE"
|
|
|
|
# Loop the main menu until the user selects quit
|
|
while true; do
|
|
# 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
|
|
menu_actions=("mapcount_set" "set_filelimit" "sanitize" "rm_shaders" "rm_vidcache" "set_version" "quit")
|
|
|
|
# Call the menu function
|
|
menu
|
|
done
|