sporada/lug-helper
1
0
Fork 0
mirror of https://github.com/the-sane/lug-helper.git synced 2024-09-21 09:52:54 +00:00
Code Issues Projects Releases Wiki Activity
348bcfe0e4
lug-helper/README.md
the-sane 348bcfe0e4
Update README.md
2021-01-26 12:35:02 -05:00

2.4 KiB
Raw Blame History

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 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. 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:

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.

Manage Lutris Runners

  • Quickly install and delete Lutris wine runners

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

    • 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/

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: