sporada/lug-helper
1
0
Fork 0
mirror of https://github.com/the-sane/lug-helper.git synced 2024-11-11 02:17:49 +00:00
Code Issues Projects Releases Wiki Activity
545 Commits 1 Branch 24 Tags 6.4 MiB
Shell 100%
v2.8
Go to file
the-sane 1e70ad8d64 Bump version
2023-07-02 21:58:19 -04:00
LICENSE Initial commit 2019-10-23 21:46:16 -04:00
lug-helper.sh Bump version 2023-07-02 21:58:19 -04:00
lug-logo.png Add lug logo 2021-01-17 09:25:52 -05:00
lutris-sc-install.json Update install script 2023-07-02 21:54:19 -04:00
README.md Update README.md 2022-11-01 23:06:28 -04:00

README.md

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.
Command line arguments are available for quickly launching functions from the terminal.

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.

Install Star Citizen

  • Launches Lutris and uses the bundled json to install Star Citizen

Deploy Easy Anti-Cheat Workaround

  • Applies the workaround to /etc/hosts and deletes the necessary EAC files

Manage Lutris Runners

  • Quickly install and delete Lutris wine runners

Manage Lutris DXVK Versions

  • Quickly install and delete DXVK versions for Lutris

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

    • It is recommended to delete your shaders directory after each game update.

  • Delete my DXVK cache

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

  • Show the LUG Wiki

    • Display a link to the LUG Wiki for help with installation and troubleshooting

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! https://github.com/starcitizen-lug/lug-helper/releases
  2. Extract it!
  3. Run it!

Arch Linux: https://aur.archlinux.org/packages/lug-helper/

Dependencies: bash, coreutils, curl, polkit (these should be installed by default on most distributions)
Optional Dependencies: zenity (for GUI)

Contributors: