2022-01-10 17:57:39 +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
2022-01-15 00:22:04 +00:00
Configuration is saved in *$XDG_CONFIG_HOME/starcitizen-lug/*
2021-01-31 19:09:28 +00:00
Keybinds are backed up to *$XDG_CONFIG_HOME/starcitizen-lug/keybinds/*
2020-11-26 13:55:04 +00:00
2024-09-09 04:29:30 +00:00
## Options
2020-08-22 01:19:47 +00:00
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
2024-10-07 16:31:13 +00:00
`Install Star Citizen with Wine`
- Installs Star Citizen using the system's Wine without Lutris
2024-09-03 15:23:39 +00:00
`Install Star Citizen with Lutris`
2024-01-05 16:56:13 +00:00
- Launches Lutris and installs Star Citizen
2021-12-28 20:42:30 +00:00
2024-10-11 19:01:13 +00:00
`Manage Wine Runners (non-Lutris)`
- Quickly install and delete custom Wine runners
2024-09-03 15:23:39 +00:00
2020-12-27 21:47:26 +00:00
`Manage Lutris Runners`
2024-10-11 19:01:13 +00:00
- Quickly install and delete Lutris runners
2020-12-27 21:47:26 +00:00
2022-01-21 23:20:30 +00:00
`Manage Lutris DXVK Versions`
2021-10-18 19:28:45 +00:00
- Quickly install and delete DXVK versions for Lutris
2021-10-11 13:35:57 +00:00
`Maintenance and Troubleshooting`
2024-01-09 20:00:07 +00:00
- `Switch the helper between LIVE/PTU/EPTU`
- Target the LIVE, PTU, or EPTU installation for all operations. Defaults to LIVE on each run.
2021-01-24 21:44:34 +00:00
2024-10-11 19:01:13 +00:00
- `Target a different Star Citizen installation`
- Select a different wine prefix for the Helper to target in its operations
- `Install PowerShell into Wine prefix`
- Uses winetricks to install PowerShell
2024-09-03 15:23:39 +00:00
2021-01-24 21:44:34 +00:00
- `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*
2022-10-16 15:16:44 +00:00
- `Delete my shaders`
- It is recommended to delete your shaders directory after each game update.
2024-08-15 23:48:10 +00:00
- You will be prompted to confirm each directory before deletion, so you may choose which game version shaders you want cleared out.
2021-01-24 21:44:34 +00:00
- `Delete my DXVK cache`
- A troubleshooting step that sometimes helps fix various issues and crashes.
2021-10-11 13:35:57 +00:00
- `Display Helper and Star Citizen directories`
- Show all the directories currently in use by both the Helper and Star Citizen.
2021-01-24 21:44:34 +00:00
- `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
2024-09-09 04:29:30 +00:00
## Installation
2021-01-17 21:05:10 +00:00
2022-11-02 03:04:55 +00:00
**From Source:**
2022-02-12 19:00:49 +00:00
1. Download it! https://github.com/starcitizen-lug/lug-helper/releases
2022-02-12 19:00:19 +00:00
2. Extract it!
3. Run it!
2022-06-16 06:55:46 +00:00
2024-09-07 15:44:39 +00:00
**Arch Linux:** https://aur.archlinux.org/packages/lug-helper/
**NixOS:** https://github.com/LovingMelody/nix-citizen
2024-09-09 03:53:30 +00:00
**Fedora:** https://copr.fedorainfracloud.org/coprs/jackgreiner/lug-helper
2024-09-07 17:28:48 +00:00
2022-10-16 15:20:13 +00:00
_Dependencies: **bash** , **coreutils** , **curl** , **polkit** (these should be installed by default on most distributions)_
2022-11-02 03:06:28 +00:00
_Optional Dependencies: **zenity** (for GUI)_
2022-10-16 15:20:13 +00:00
2024-10-07 16:31:13 +00:00
## Made with <3
#### Author:
- https://github.com/the-sane
#### Contributors:
2021-01-23 14:32:34 +00:00
- 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-10-11 13:35:57 +00:00
- https://github.com/Wrzlprnft
2022-01-10 18:50:37 +00:00
- https://github.com/ananace
2023-07-29 01:15:04 +00:00
- https://github.com/LovingMelody
2024-10-07 16:31:13 +00:00
- https://github.com/mactan-sc
2021-01-23 14:32:34 +00:00
- Runner Downloader inspired by https://github.com/richardtatum/sc-runner-updater
2024-09-09 04:29:30 +00:00
## Contributing
See the [Contributors' Guide ](https://github.com/starcitizen-lug/lug-helper/wiki/Contributors-Guide ) for a high level overview of the script
