Improve archive subdirectory handling

Closes #22

README.md

@@ -1,46 +1,58 @@
 # LUG-Helper
-**Star Citizen's Linux Users Group Helper Script**
+**Star Citizen's Linux Users Group Helper Script**  
-
 https://robertsspaceindustries.com/orgs/LUG
 
-*Greetings, fellow Penguin!*
+### *Greetings, fellow Penguin!*
+_**This script is designed to help you manage and optimize Star Citizen on Linux.**_
 
-This script is designed to help you manage and optimize Star Citizen on Linux.
+Zenity menus are used for a GUI experience with a fallback to terminal-based menus where Zenity is unavailable.  
+Command line arguments are available for quickly launching functions from the terminal.  
 
-Zenity menus are used for a GUI experience with a fallback to terminal-based menus where Zenity is unavailable. The game directory paths provided by the user on first run are saved in *$XDG_CONFIG_HOME/starcitizen-lug*.  Keybinds are backed up to *$XDG_CONFIG_HOME/starcitizen-lug/keybinds*
+Configuration is saved in *$XDG_CONFIG_HOME/starcitizen-lug/*.  
+Keybinds are backed up to *$XDG_CONFIG_HOME/starcitizen-lug/keybinds/*
 
 ## Options:
 
+`Preflight Check`
+- Runs a series of system optimization checks and offers to fix any issues.
+  - Checks that vm.max_map_count is set to at least 16777216.
+    - This sets the maxmimum number of "memory map areas" a process can have. While most applications need less than a thousand maps, Star Citizen requires access to more.
+  - Checks that the hard open file descriptors limit is set to at least 524288.
+    - This limits the maximum number of open files on your system.  On some Linux distributions, the default is set too low for Star Citizen.
+
 `Manage Lutris Runners`
 - Quickly install and delete Lutris wine runners
 
-`Delete my Star Citizen USER folder and preserve my keybinds`
+`Manage DXVK Versions`
-- The helper will make backups of any exported keybinds, delete your Star Citizen USER folder, then restore your keybind files.
+- Quickly install and delete DXVK versions for Lutris
-- To export your keybinds from within the game, go to:
-  - *Options->Keybindings->Control Profiles->Save Control Settings*
-- To re-import your keybinds from within the game, select them from the list:
-  - *Options->Keybindings->Control Profiles*
 
-`Check vm.max_map_count for optimal performance`
+`Maintenance and Troubleshooting`
-- We recommend setting this to at least 16777216 to give the game access to sufficient memory.
+- `Switch the helper between LIVE and PTU`
-- The helper will offer to set it for you or show you the commands to do it yourself.
+  - Toggle between targeting LIVE or PTU for all of the above options.  Defaults to LIVE on each run.
 
-`Check my open file descriptors limit`
+- `Delete my Star Citizen USER folder and preserve my keybinds`
-- We recommend setting the hard open files limit to at least 524288.
+  - The helper will make backups of any exported keybinds, delete your Star Citizen USER folder, then restore your keybind files.
-- The helper will offer to set it for you and try to auto-detect the correct method to do so.
+  - To export your keybinds from within the game, go to:
-- It is able to update either */etc/systemd/system.conf* or */etc/security/limits.conf*
+    - *Options->Keybindings->Control Profiles->Save Control Settings*
+  - To re-import your keybinds from within the game, select them from the list:
+    - *Options->Keybindings->Control Profiles*
 
-`Delete my shaders only`
+- `Delete my shaders folder only`
-- Sometimes all you need to do between major version updates is delete your shaders directory.
+  - Sometimes all you need to do between major version updates is delete your shaders directory.
 
-`Delete my DXVK cache`
+- `Delete my DXVK cache`
-- A troubleshooting step that sometimes helps fix various issues and crashes.
+  - A troubleshooting step that sometimes helps fix various issues and crashes.
+
+- `Display Helper and Star Citizen directories`
+  - Show all the directories currently in use by both the Helper and Star Citizen.
+
+- `Reset Helper configs`
+  - Delete the configs saved by the helper in *$XDG_CONFIG_HOME/starcitizen-lug/*
 
 `Get a random Penguin's Star Citizen referral code`
 - Display a referral code for a random member of the Star Citizen Linux Users Group.
 
-`Switch the helper between LIVE and PTU`
+
-- Toggle between targeting LIVE or PTU for all of the above options.  Defaults to LIVE on each run.
 
 ## Installation:
 
@@ -50,3 +62,11 @@ From Source:
 3. If you want, move *lug-logo.png* to */usr/share/pixmaps/*
 
 Arch Linux: https://aur.archlinux.org/packages/lug-helper/
+
+## Contributors:
+- https://github.com/Termuellinator
+- https://github.com/pstn
+- https://github.com/gort818
+- https://github.com/victort
+- https://github.com/Wrzlprnft
+- Runner Downloader inspired by https://github.com/richardtatum/sc-runner-updater