lug-helper/README.md

66 lines
2.7 KiB
Markdown
Raw Permalink Normal View History

2021-01-03 18:29:28 +00:00
# LUG-Helper
2021-01-31 19:12:19 +00:00
**Star Citizen's Linux Users Group Helper Script**
2020-08-17 02:10:34 +00:00
https://robertsspaceindustries.com/orgs/LUG
2021-01-31 19:11:03 +00:00
### *Greetings, fellow Penguin!*
2021-01-31 19:15:18 +00:00
_**This script is designed to help you manage and optimize Star Citizen on Linux.**_
2020-08-17 02:10:34 +00:00
2021-01-31 19:09:28 +00:00
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.
2021-01-31 19:10:00 +00:00
2021-01-31 19:09:28 +00:00
Configuration is saved in *$XDG_CONFIG_HOME/starcitizen-lug/*.
Keybinds are backed up to *$XDG_CONFIG_HOME/starcitizen-lug/keybinds/*
2020-11-26 13:55:04 +00:00
2020-08-22 01:19:47 +00:00
## Options:
2021-01-24 03:37:53 +00:00
`Preflight Check`
2021-01-24 03:38:21 +00:00
- Runs a series of system optimization checks and offers to fix any issues.
2021-01-26 17:35:02 +00:00
- 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.
2021-01-24 03:37:53 +00:00
- Checks that the hard open file descriptors limit is set to at least 524288.
2021-01-27 22:32:48 +00:00
- This limits the maximum number of open files on your system. On some Linux distributions, the default is set too low for Star Citizen.
2021-01-24 03:37:53 +00:00
2020-12-27 21:47:26 +00:00
`Manage Lutris Runners`
- Quickly install and delete Lutris wine runners
2021-01-25 00:04:23 +00:00
`User Folder Maintenance and Troubleshooting`
2021-01-24 21:44:34 +00:00
- `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`
- Sometimes all you need to do between major version updates is delete your shaders directory.
- `Delete my DXVK cache`
- A troubleshooting step that sometimes helps fix various issues and crashes.
- `Reset Helper configs`
- Delete the configs saved by the helper in *$XDG_CONFIG_HOME/starcitizen-lug/*
2020-08-22 01:19:47 +00:00
2021-01-12 01:03:42 +00:00
`Get a random Penguin's Star Citizen referral code`
2021-01-12 01:04:01 +00:00
- Display a referral code for a random member of the Star Citizen Linux Users Group.
2021-01-12 01:03:24 +00:00
2021-01-24 21:42:32 +00:00
2021-01-17 21:05:10 +00:00
## Installation:
2021-01-17 21:10:52 +00:00
From Source:
2021-01-17 21:05:10 +00:00
1. Download it!
2. Run it!
2021-01-17 21:10:52 +00:00
3. If you want, move *lug-logo.png* to */usr/share/pixmaps/*
Arch Linux: https://aur.archlinux.org/packages/lug-helper/
2021-01-23 14:32:34 +00:00
## Contributors:
- https://github.com/Termuellinator
- https://github.com/pstn
2021-01-30 19:35:30 +00:00
- https://github.com/gort818
- https://github.com/victort
2021-01-23 14:32:34 +00:00
- Runner Downloader inspired by https://github.com/richardtatum/sc-runner-updater