Add lug-wine repo + default runner

This reverts commit 292995b822.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Bugs or issues with the Helper tool. See other options below for non-Helper
+  related issues
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**OS Info:**
+ - Distro: [e.g. Arch, Ubuntu]
+ - Version if applicable [e.g. 22.04]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+contact_links:
+  - name: Wiki
+    url: https://starcitizen-lug.github.io
+    about: Installation issues, troubleshooting, and recent news/changes
+  - name: Community Support
+    url: https://discord.gg/meCFYPj
+    about: Gelp in our Discord tech support channel. It's bridged to our Matrix space too! (See wiki above for links)

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for improving the Helper tool
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

README.md

@@ -11,7 +11,7 @@ Command line arguments are available for quickly launching functions from the te
 Configuration is saved in *$XDG_CONFIG_HOME/starcitizen-lug/*  
 Keybinds are backed up to *$XDG_CONFIG_HOME/starcitizen-lug/keybinds/*
 
-## Options:
+## Options
 
 `Preflight Check`
 - Runs a series of system optimization checks and offers to fix any issues.
@@ -21,33 +21,32 @@ Keybinds are backed up to *$XDG_CONFIG_HOME/starcitizen-lug/keybinds/*
     - 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
+- Installs Star Citizen using Wine
 
-`Deploy Easy Anti-Cheat Workaround`
-- Applies the workaround to /etc/hosts and deletes the necessary EAC files
+`Manage Wine Runners`
+- Quickly install and delete custom Wine runners
 
-`Manage Lutris Runners`
-- Quickly install and delete Lutris wine runners
-
-`Manage Lutris DXVK Versions`
-- Quickly install and delete DXVK versions for Lutris
+`Update DXVK`
+- Update DXVK in the game's Wine prefix
 
 `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.
+- `Target a different Star Citizen installation`
+  - Select a different wine prefix for the Helper to target in its operations
 
-- `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*
+- `Update launch script`
+  - Update the game launch script to the latest version
 
-- `Delete my shaders`
-  - It is recommended to delete your shaders directory after each game update.
+- `Edit launch script`
+  - Edit the game launch script
 
-- `Delete my DXVK cache`
-  - A troubleshooting step that sometimes helps fix various issues and crashes.
+- `Open Wine prefix configuration`
+  - Runs *winecfg* in the game's Wine prefix
+
+- `Open Wine controller configuration`
+  - Opens Wine's game controller configuration in the Wine prefix
+
+- `Install PowerShell into Wine prefix`
+  - Uses winetricks to install PowerShell
 
 - `Display Helper and Star Citizen directories`
   - Show all the directories currently in use by both the Helper and Star Citizen.
@@ -55,31 +54,41 @@ Keybinds are backed up to *$XDG_CONFIG_HOME/starcitizen-lug/keybinds/*
 - `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:
+## 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/
+**Arch Linux:** https://aur.archlinux.org/packages/lug-helper/  
+**NixOS:** https://github.com/LovingMelody/nix-citizen  
+**Fedora:** https://copr.fedorainfracloud.org/coprs/jackgreiner/lug-helper  
 
 _Dependencies: **bash**, **coreutils**, **curl**, **polkit** (these should be installed by default on most distributions)_  
+_Winetricks Dependencies: **cabextract**, **unzip**_  
 _Optional Dependencies: **zenity** (for GUI)_  
 
-## Contributors:
+## Made with <3
+#### Author:
+- https://github.com/the-sane
+#### 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
+- https://github.com/LovingMelody
+- https://github.com/mactan-sc
+- https://github.com/ProjectSynchro
 - Runner Downloader inspired by https://github.com/richardtatum/sc-runner-updater
+
+## Contributing
+See the [Contributor's Guide](https://github.com/starcitizen-lug/lug-helper/wiki/Contributors-Guide) for a high level overview of the script  
+Packagers, please see the [Packager's Guide](https://github.com/starcitizen-lug/lug-helper/wiki/Packagers-Guide)

lib/sc-launch.sh

@@ -0,0 +1,107 @@
+#!/usr/bin/env bash
+
+################################################################################
+# This script configures and launches Star Citizen.
+# It is installed by the LUG Helper for a non-Lutris installation.
+#
+# The following .desktop files are added by wine during installation and then
+# modified by the LUG Helper to call this script.
+# They are automatically detected by most desktop environments for easy game
+# launching.
+#
+################################################################################
+# $HOME/Desktop/RSI Launcher.desktop
+# $HOME/.local/share/applications/wine/Programs/Roberts Space Industries/RSI Launcher.desktop
+################################################################################
+#
+# If you do not wish to use the above .desktop files, simply run this script
+# from your terminal.
+#
+# version: 1.7
+################################################################################
+
+################################################################
+# Configure the environment
+# Add additional environment variables here as needed
+################################################################
+export WINEPREFIX="$HOME/Games/star-citizen"
+launch_log="$WINEPREFIX/sc-launch.log"
+
+export WINEDLLOVERRIDES=winemenubuilder.exe=d # Prevent updates from overwriting our .desktop entries
+export WINEDEBUG=-all # Cut down on console debug messages
+
+# Nvidia cache options
+export __GL_SHADER_DISK_CACHE=1
+export __GL_SHADER_DISK_CACHE_SIZE=10737418240
+export __GL_SHADER_DISK_CACHE_PATH="$WINEPREFIX"
+export __GL_SHADER_DISK_CACHE_SKIP_CLEANUP=1
+# Mesa (AMD/Intel) shader cache options
+export MESA_SHADER_CACHE_DIR="$WINEPREFIX"
+export MESA_SHADER_CACHE_MAX_SIZE="10G"
+# Optional HUDs
+#export DXVK_HUD=fps,compiler
+#export MANGOHUD=1
+
+################################################################
+# Configure the wine binaries to be used
+#
+# To use a custom wine runner, set the path to its bin directory
+# export wine_path="/path/to/custom/runner/bin"
+################################################################
+export wine_path="$(command -v wine | xargs dirname)"
+
+#############################################
+# Command line arguments
+#############################################
+# shell - Drop into a Wine maintenance shell
+# config - Wine configuration
+# controllers - Game controller configuration
+# Usage: ./sc-launch.sh shell
+case "$1" in
+    "shell")
+        echo "Entering Wine prefix maintenance shell. Type 'exit' when done."
+        export PATH="$wine_path:$PATH"; export PS1="Wine: "
+        cd "$WINEPREFIX"; pwd; /usr/bin/env bash --norc; exit 0
+        ;;
+    "config")
+        /usr/bin/env bash --norc -c "${wine_path}/winecfg"; exit 0
+        ;;
+    "controllers")
+        /usr/bin/env bash --norc -c "${wine_path}/wine control joy.cpl"; exit 0
+        ;;
+esac
+
+#############################################
+# Run optional prelaunch and postexit scripts
+#############################################
+# To use, update the game install paths here, create the scripts with your
+# desired actions in them, then place them in your prefix directory:
+# sc-prelaunch.sh and sc-postexit.sh
+# Replace the trap line in the section below with the example provided here
+#
+# "$WINEPREFIX/sc-prelaunch.sh"
+# trap "update_check; \"$wine_path\"/wineserver -k; \"$WINEPREFIX\"/sc-postexit.sh" EXIT
+
+#############################################
+# It's a trap!
+#############################################
+# Kill the wine prefix when this script exits
+# This makes sure there will be no lingering background wine processes
+update_check() {
+    while "$wine_path"/winedbg --command "info proc" | grep -qi "rsi.*setup"; do
+        sleep 2
+    done
+}
+trap "update_check; \"$wine_path\"/wineserver -k" EXIT
+
+#############################################
+# Launch the game
+#############################################
+# To enable feral gamemode, replace the launch line below with:
+# gamemoderun "$wine_path"/wine "C:\Program Files\Roberts Space Industries\RSI Launcher\RSI Launcher.exe" > "$launch_log" 2>&1
+#
+# To enable gamescope and feral gamemode, replace the launch line below with the
+# desired gamescope arguments. For example:
+# gamescope --hdr-enabled -W 2560 -H 1440 --force-grab-cursor gamemoderun "$wine_path"/wine "C:\Program Files\Roberts Space Industries\RSI Launcher\RSI Launcher.exe" > "$launch_log" 2>&1
+
+"$wine_path"/wine "C:\Program Files\Roberts Space Industries\RSI Launcher\RSI Launcher.exe" > "$launch_log" 2>&1

lug-lutris-install.json

@@ -1,102 +0,0 @@
-{
-  "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-02-08T15:20:16.896420Z",
-      "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.4.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"
-        }
-      }
-    }
-  ]
-}