Update README.md

2025-07-01 13:30:35 +00:00 · 2021-01-27 17:32:48 -05:00 · 2021-01-26 12:35:02 -05:00 · 2021-01-24 19:04:23 -05:00 · 2021-01-24 18:49:17 -05:00 · 2021-01-24 16:44:34 -05:00
3 changed files with 1006 additions and 429 deletions
--- a/README.md
+++ b/README.md
@ -1,39 +1,61 @@
-# lug-helper
+# LUG-Helper
 **Star Citizen's Linux Users Group Helper Script**

 https://robertsspaceindustries.com/orgs/LUG

 *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.
+This script is designed to help you manage and optimize Star Citizen on Linux.

-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).
-
-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*.
+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/*

 ## Options:

-`Check vm.max_map_count for optimal performance`
- We recommend setting this to at least 16777216 to give the game access to sufficient memory.
- The helper will offer to set it for you or show you the commands to do it yourself.
+`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.

-`Check my open file descriptors limit`
- We recommend setting the hard open files limit to at least 524288.
- The helper will offer to set it for you and try to auto-detect the correct method to do so.
- It is able to update either */etc/systemd/system.conf* or */etc/security/limits.conf*
+`Manage Lutris Runners`
+- Quickly install and delete Lutris wine runners

-`Delete my Star Citizen USER folder and preserve my keybinds`
+`User Folder Maintenance and Troubleshooting`
+- `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.
+
+- `Delete my Star Citizen USER folder and preserve my keybinds`
  - The helper will make backups of any exported keybinds, delete your Star Citizen USER folder, then restore your keybind files.
  - 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*

-`Delete my shaders only`
+- `Delete my shaders only`
  - 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.

-`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.
+- `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.
+
+
+
+## Installation:
+
+From Source:
+1. Download it!
+2. Run it!
+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
+- Runner Downloader inspired by https://github.com/richardtatum/sc-runner-updater
--- a/lug-helper.sh
+++ b/lug-helper.sh
--- a/lug-logo.png
+++ b/lug-logo.png
Author	SHA1	Message	Date
the-sane	1670c3ccf7	Update README.md	2021-01-27 17:32:48 -05:00
the-sane	348bcfe0e4	Update README.md	2021-01-26 12:35:02 -05:00
the-sane	5850ec847b	Update README.md	2021-01-24 19:04:23 -05:00
the-sane	829610b13e	Improve menu description	2021-01-24 18:49:17 -05:00
the-sane	f91422a8c4	Update README.md	2021-01-24 16:44:34 -05:00
the-sane	12d9e205f7	Update README.md	2021-01-24 16:42:32 -05:00
the-sane	d4c3015a22	Improve runner menu description	2021-01-24 16:21:49 -05:00
the-sane	f6ea8c04c7	Add maintenence and troubleshooting menu	2021-01-24 16:15:35 -05:00
the-sane	b7a36a872b	Improve preflight check + check total ram	2021-01-24 15:37:06 -05:00
the-sane	4a4d8a0f2a	If you find yourself invoking grep and awk in one line, you're doing it wrong.	2021-01-24 15:35:33 -05:00
the-sane	2dd81588b2	Improve message	2021-01-24 14:51:00 -05:00
the-sane	7b7460fa0d	Fallback to sudo where pollkit is unavailable	2021-01-24 14:43:42 -05:00
the-sane	478ff37b8a	Improve messages	2021-01-24 14:37:36 -05:00
the-sane	1840983431	Improve preflight check Run all actions at once to avoid multiple password prompts. Move followups and results to the preflight_check function.	2021-01-24 12:44:49 -05:00
the-sane	693edd56fa	Clarify menu item	2021-01-24 01:29:46 -05:00
the-sane	a0d60cf0ee	Update README.md	2021-01-23 22:38:21 -05:00
the-sane	371accc92c	Update README.md	2021-01-23 22:37:53 -05:00
the-sane	9af012eaaf	Improve comments	2021-01-23 22:34:15 -05:00
the-sane	870091faaa	Fix messages	2021-01-23 22:13:28 -05:00
the-sane	2c6cceb60f	Add Preflight Check for all optimization checks	2021-01-23 22:05:23 -05:00
the-sane	32e4dae92e	Update README.md	2021-01-23 09:32:34 -05:00
the-sane	7ebaa6d2d2	Additional referral code	2021-01-23 09:31:19 -05:00
the-sane	8bea7dc005	Credit Tatumkhamun	2021-01-23 09:29:42 -05:00
the-sane	5107076b2f	Fallback logo	2021-01-17 16:17:51 -05:00
the-sane	3cf15be6de	Update README.md	2021-01-17 16:10:52 -05:00
the-sane	7e30f706fc	Update README.md	2021-01-17 16:05:10 -05:00
the-sane	bc39507e48	Use an installed logo if available	2021-01-17 15:58:14 -05:00
the-sane	9d8e17bd2a	Add lug logo	2021-01-17 09:25:52 -05:00
the-sane	fe2b9f56c0	Use the lug logo for zenity's taskbar icon	2021-01-17 09:25:18 -05:00
the-sane	7a4de1ad21	Rearrange menu	2021-01-16 22:09:46 -05:00
the-sane	4b924ba068	Improve message	2021-01-16 22:00:06 -05:00
the-sane	b66d1554e9	Improve deletion messages & capital Helper.	2021-01-16 21:55:58 -05:00
the-sane	ec3027bc28	Rearrange menu	2021-01-16 21:52:21 -05:00
the-sane	ec794a0fd2	Add reset_helper feature	2021-01-16 21:51:00 -05:00
the-sane	762c069fb5	Rename to debug_print	2021-01-16 21:33:15 -05:00
the-sane	9689a4a60b	Cleanup	2021-01-16 19:56:56 -05:00
the-sane	6895313492	Update README.md	2021-01-16 19:24:23 -05:00
the-sane	0e454883e9	Update README.md	2021-01-16 19:23:58 -05:00
the-sane	0ef2481e70	Update README.md	2021-01-16 19:23:45 -05:00
the-sane	3a9b4194e0	Improve debug message	2021-01-16 19:22:37 -05:00
the-sane	9be4f45449	Show which mode we're in	2021-01-16 19:07:50 -05:00
the-sane	7d667343d3	Cleanup	2021-01-16 18:51:32 -05:00
the-sane	1aa6c3f4c2	Use conf directory for keybind backups	2021-01-16 18:50:28 -05:00
the-sane	0c80a1f132	Improve intro comment	2021-01-16 14:31:27 -05:00
the-sane	bc608f7ac4	Reference lutris default install path	2021-01-16 14:20:10 -05:00
the-sane	d2983fa519	Improve debug messages	2021-01-16 14:07:44 -05:00
the-sane	8e6fe1225d	Fix shaders directory	2021-01-16 14:04:36 -05:00
the-sane	41210bfd1c	Check for curl dependency separately from coreutils	2021-01-16 11:54:44 -05:00
the-sane	71df862879	Add curl dependency	2021-01-16 11:33:11 -05:00
the-sane	2b94fd5e68	Update README.md	2021-01-16 09:33:13 -05:00
the-sane	ee5da5d348	Add notify-send for dependency errors	2021-01-16 09:07:01 -05:00
the-sane	7f9ad04753	printf for portability	2021-01-16 08:51:22 -05:00
the-sane	37762b9075	Output errors to stderr	2021-01-15 20:42:47 -05:00
the-sane	82c5ccbbab	Remove testing oops	2021-01-15 20:21:51 -05:00
the-sane	669ee6eb91	even moar referral codes!	2021-01-15 20:19:31 -05:00
the-sane	7c0fbc65b7	Add contributor pstn	2021-01-15 20:02:48 -05:00
the-sane	62477143f2	Dependency check. Remove tmp_dir on exit.	2021-01-15 20:02:10 -05:00
the-sane	35fd12b672	Add mktemp suffix and fallback	2021-01-15 19:33:10 -05:00
the-sane	ff30d8d557	Merge pull request #9 from pstn/fixes Fixes	2021-01-15 19:27:12 -05:00
Philipp Steinpaß	ec860270bb	Use mktemp to generate tmp dir.	2021-01-15 18:02:28 +01:00
Philipp Steinpaß	3ea9fb0f35	make shebang fully posix compatible	2021-01-15 18:00:52 +01:00
the-sane	7f7b63caeb	Formatting	2021-01-13 19:07:43 -05:00
the-sane	86604f2b7d	Kill only the curl spawned by the helper. More referral codes.	2021-01-13 19:06:36 -05:00
the-sane	5a00c74ddc	MOAR REFERRAL CODES!	2021-01-12 18:30:20 -05:00
the-sane	089f69ef06	Formatting	2021-01-11 20:13:47 -05:00
the-sane	9e79fd68e0	Fix comment	2021-01-11 20:10:41 -05:00
the-sane	d42207d521	Update README.md	2021-01-11 20:04:01 -05:00
the-sane	5c55e6795c	Update README.md	2021-01-11 20:03:42 -05:00
the-sane	5db7fef24c	Update README.md	2021-01-11 20:03:24 -05:00
the-sane	08f8f1e07c	Add Zenity progress bars for runner installation. +More referral codes.	2021-01-11 20:01:47 -05:00
the-sane	707d1ad47d	Improve comments	2021-01-03 13:48:48 -05:00
the-sane	f2dfda5c5b	Update README.md	2021-01-03 13:29:28 -05:00
the-sane	debf799dad	Update README.md	2021-01-03 13:28:52 -05:00
the-sane	0d7e4ea2b3	Improve comments	2021-01-03 08:49:13 -05:00
the-sane	aaccca1dc9	Clarify instructions	2021-01-02 08:57:01 -05:00
the-sane	b378de0b9e	Add more penguin referral codes	2021-01-02 08:47:03 -05:00
the-sane	61e14ed4de	Improve getdirs: Try to detect the game directory	2021-01-01 14:52:43 -05:00
the-sane	2cdef0f1c4	Begin adding penguin referral code randomzier	2021-01-01 10:41:07 -05:00
the-sane	d20fc859e1	Shorten comments for small terminal windows	2020-12-31 20:55:44 -05:00
the-sane	4cc8e3331c	Only offer to restart lutris if it's running	2020-12-31 20:46:45 -05:00
the-sane	a5d372a43b	Improve debug_echo function	2020-12-31 20:43:10 -05:00
the-sane	48582c3a22	Refactor URL handling for easy future additions Store runner source URLs in an array for easy expansion. Handle different file extensions automatically. Detect whether the archive is packaged with a subdirectory or not and handle it automatically.	2020-12-31 20:28:34 -05:00
the-sane	363be810aa	+ <3	2020-12-27 19:08:11 -05:00
the-sane	467e1b7164	Re-order operations in case some shells can't math good	2020-12-27 19:07:17 -05:00
the-sane	85c1f62c22	Update phrasing	2020-12-27 18:04:45 -05:00
the-sane	758f106efd	Add debug_echo function Easy formatting of debug messages	2020-12-27 17:47:57 -05:00
the-sane	43d2b467e8	Dynamically calculate zenity menu heights	2020-12-27 17:27:00 -05:00
the-sane	aa60600807	Throw out zenity errors Cleans up the terminal output	2020-12-27 16:56:41 -05:00
the-sane	02338ff299	Update README.md	2020-12-27 16:47:26 -05:00
the-sane	a2594c3af3	Add contributors and function sections	2020-12-27 16:45:31 -05:00
the-sane	e63893f50a	Merge pull request #7 from the-sane/runners Merge Runners	2020-12-27 16:35:10 -05:00
the-sane	fa14c6d9de	Merge pull request #6 from Termuellinator/patch-1 Added option to download and delete runners	2020-12-27 16:34:00 -05:00
the-sane	8f3efd0b9c	Fix url parsing Be more specific for when grep returns multiple matches	2020-12-27 16:32:55 -05:00
the-sane	6d7c84c8b6	Loop runner_manage menu until the user cancels	2020-12-27 15:40:54 -05:00
the-sane	c12509bc0c	Fix string compare	2020-12-27 14:59:41 -05:00
the-sane	224c531d64	Offer Lutris restart only if changes were made	2020-12-27 14:57:57 -05:00
the-sane	32fdc04ec7	Improve runner_delete Sanity check and rename variable	2020-12-27 14:48:38 -05:00
the-sane	20eb8e984a	Rename functions with "runner_" prefix Consistency with other function names	2020-12-27 14:43:05 -05:00
the-sane	0df2659e54	Don't manage lutris runners if lutris isn't installed	2020-12-27 14:34:09 -05:00
the-sane	4a0b053a68	Restart after deleting a runner	2020-12-27 14:30:22 -05:00
the-sane	26030a6c82	Use XDG_DATA_HOME	2020-12-27 14:29:00 -05:00
the-sane	9c44505d27	Improve install_runner	2020-12-27 14:12:20 -05:00
the-sane	7f0f12e61b	Add sanity check for function argument	2020-12-27 11:11:20 -05:00
the-sane	da8c63fdcf	Improve choose_runner_version() Fix bash formatting and improve code consistency, add sanity check to catch github API errors	2020-12-27 10:58:00 -05:00
the-sane	6e27ae8449	Refactor choose_runner_to_delete(). Untabify.	2020-12-25 11:24:10 -05:00
Termuellinator	be533e842b	Update lug-helper.sh quoted the variables	2020-12-22 20:06:39 +01:00
Termuellinator	dfc2b4f573	Added option to download and delete runners finally :D	2020-12-22 13:02:18 +01:00