Bump version

Handles the hosts file addition and eac directory deletion separately

README.md

@@ -1,42 +1,85 @@
-# lug-helper
+# LUG Helper
 **Star Citizen's Linux Users Group Helper Script**  
-
 https://robertsspaceindustries.com/orgs/LUG
 
-*Greetings, fellow Penguin!*
+### *Greetings, fellow Penguin!*
+_**This script is designed to help you manage and optimize Star Citizen on Linux.**_
 
-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.
+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.  
 
-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*.
+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
 
-`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*
+`Manage Lutris DXVK Versions`
+- Quickly install and delete DXVK versions for Lutris
 
-`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.
+`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.
 
-`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*
+- `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 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.
+- `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.
+- `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:
+- https://github.com/Termuellinator
+- https://github.com/pstn
+- https://github.com/gort818
+- https://github.com/victort
+- https://github.com/Wrzlprnft
+- https://github.com/ananace
+- Runner Downloader inspired by https://github.com/richardtatum/sc-runner-updater

lug-lutris-install.json

@@ -0,0 +1,102 @@
+{
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "id": 10872,
+      "game_id": 17622,
+      "game_slug": "star-citizen",
+      "name": "Star Citizen",
+      "year": 2016,
+      "user": "ungarscool1",
+      "runner": "wine",
+      "slug": "starcitizen-lutris-install",
+      "version": "LIVE/PTU",
+      "description": "Welcome to the Star Citizen installer maintained by the Star Citizen LUG!\r\nBefore continuing, please see our Quick Start Guide:\r\nhttps://github.com/starcitizen-lug/information-howtos/wiki\r\n\r\nFor help with the installer or to just hang out, we invite Linux Star Citizen players to join us: https://robertsspaceindustries.com/orgs/LUG/",
+      "notes": "Performance may be choppy for the first couple minutes after visiting a new place or performing a new activity while shaders compile. Subsequent arrival should not be choppy.\r\n\r\nIf you receive a Runtime Error you can continue using Star Citizen by dragging the dialog box to the side, but in-game VoIP and FoIP will cease to function until Star Citizen is restarted. Drop in to the LUG group's chat and forums; we have custom runners to work around this problem.\r\n\r\nPlease make sure you have all Wine dependencies properly installed or your game may crash during start-up. See our wiki linked above for more information and instructions.\r\n\r\nTo prevent crashes in areas with lots of geometry, the game needs a Linux resource limit named \"vm.max_map_count\" increased. If you are following our Quick Start Guide and using our LUG Helper, the Preflight Check will do this for you. To set it manually, execute:\r\n\r\nsudo sysctl -w vm.max_map_count=16777216\r\n\r\nConsult your distro's documentation on how to set this permanently or ask a LUG member.\r\n\r\nSee you in the 'verse!",
+      "credits": "",
+      "created_at": "2018-11-15T17:43:07.367000Z",
+      "updated_at": "2023-01-30T21:43:51.079643Z",
+      "draft": false,
+      "published": true,
+      "published_by": 64834,
+      "rating": "",
+      "is_playable": null,
+      "steamid": null,
+      "gogid": null,
+      "gogslug": "",
+      "humbleid": "",
+      "humblestoreid": "",
+      "humblestoreid_real": "",
+      "script": {
+        "files": [
+          {
+            "client": "https://install.robertsspaceindustries.com/star-citizen/RSI-Setup-1.6.3.exe"
+          }
+        ],
+        "game": {
+          "arch": "win64",
+          "exe": "drive_c/Program Files/Roberts Space Industries/RSI Launcher/RSI Launcher.exe",
+          "prefix": "$GAMEDIR"
+        },
+        "install_complete_text": "Installation Complete!\r\n\r\nPlease see our Quick Start Guide for instructions on deploying the necessary Easy Anti-Cheat workaround as well as other important configuration requirements:\r\n\r\nhttps://github.com/starcitizen-lug/information-howtos/wiki/Quick-Start-Guide",
+        "installer": [
+          {
+            "task": {
+              "arch": "win64",
+              "description": "Creating Wine prefix",
+              "name": "create_prefix",
+              "prefix": "$GAMEDIR"
+            }
+          },
+          {
+            "task": {
+              "app": "--force arial vcrun2019 win10",
+              "arch": "win64",
+              "description": "Installing dlls",
+              "name": "winetricks",
+              "prefix": "$GAMEDIR"
+            }
+          },
+          {
+            "task": {
+              "arch": "win64",
+              "args": "/S",
+              "description": "Installing client",
+              "executable": "client",
+              "name": "wineexec",
+              "prefix": "$GAMEDIR"
+            }
+          },
+          {
+            "execute": {
+              "description": "Creating game path",
+              "command": "mkdir -p $GAMEDIR'/drive_c/Program Files/Roberts Space Industries/StarCitizen/'{LIVE,PTU}"
+            }
+          }
+        ],
+        "system": {
+          "prefer_system_libs": false,
+          "env": {
+            "DXVK_HUD": "0",
+            "__GL_SHADER_DISK_CACHE": 1,
+            "__GL_SHADER_DISK_CACHE_SIZE": "1073741824",
+            "__GL_THREADED_OPTIMIZATIONS": "1"
+          }
+        },
+        "wine": {
+          "dxvk": true,
+          "esync": true,
+          "system_winetricks": false,
+          "dxvk_nvapi": false,
+          "overrides": {
+            "nvapi,nvapi64": "disabled",
+            "libglesv2": "builtin"
+          },
+          "version": "lutris-GE-Proton7-35-x86_64"
+        }
+      }
+    }
+  ]
+}