mirror of
https://github.com/the-sane/lug-helper.git
synced 2025-07-05 09:03:27 +00:00
Compare commits
1 Commits
main
...
1a415f9f1b
Author | SHA1 | Date | |
---|---|---|---|
1a415f9f1b |
32
.github/ISSUE_TEMPLATE/bug_report.md
vendored
32
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -1,32 +0,0 @@
|
||||
---
|
||||
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.
|
7
.github/ISSUE_TEMPLATE/config.yml
vendored
7
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -1,7 +0,0 @@
|
||||
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)
|
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -1,20 +0,0 @@
|
||||
---
|
||||
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.
|
74
README.md
74
README.md
@ -1,4 +1,4 @@
|
||||
# LUG Helper
|
||||
# LUG-Helper
|
||||
**Star Citizen's Linux Users Group Helper Script**
|
||||
https://robertsspaceindustries.com/orgs/LUG
|
||||
|
||||
@ -8,10 +8,10 @@ _**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/*
|
||||
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.
|
||||
@ -20,33 +20,28 @@ Keybinds are backed up to *$XDG_CONFIG_HOME/starcitizen-lug/keybinds/*
|
||||
- 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`
|
||||
- Installs Star Citizen using Wine
|
||||
`Manage Lutris Runners`
|
||||
- Quickly install and delete Lutris wine runners
|
||||
|
||||
`Manage Wine Runners`
|
||||
- Quickly install and delete custom Wine runners
|
||||
|
||||
`Update DXVK`
|
||||
- Update DXVK in the game's Wine prefix
|
||||
`Manage DXVK Versions`
|
||||
- Quickly install and delete DXVK versions for Lutris
|
||||
|
||||
`Maintenance and Troubleshooting`
|
||||
- `Target a different Star Citizen installation`
|
||||
- Select a different wine prefix for the Helper to target in its operations
|
||||
- `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.
|
||||
|
||||
- `Update launch script`
|
||||
- Update the game launch script to the latest version
|
||||
- `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*
|
||||
|
||||
- `Edit launch script`
|
||||
- Edit the game launch script
|
||||
- `Delete my shaders folder only`
|
||||
- Sometimes all you need to do between major version updates is delete your shaders directory.
|
||||
|
||||
- `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
|
||||
- `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.
|
||||
@ -59,36 +54,19 @@ Keybinds are backed up to *$XDG_CONFIG_HOME/starcitizen-lug/keybinds/*
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
## Installation:
|
||||
|
||||
**From Source:**
|
||||
1. Download it! https://github.com/starcitizen-lug/lug-helper/releases
|
||||
2. Extract it!
|
||||
3. Run it!
|
||||
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/
|
||||
**NixOS:** https://github.com/LovingMelody/nix-citizen
|
||||
**Fedora:** https://copr.fedorainfracloud.org/coprs/jackgreiner/lug-helper
|
||||
Arch Linux: https://aur.archlinux.org/packages/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)_
|
||||
|
||||
## Made with <3
|
||||
#### Author:
|
||||
- https://github.com/the-sane
|
||||
#### Contributors:
|
||||
## 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)
|
||||
|
107
lib/sc-launch.sh
107
lib/sc-launch.sh
@ -1,107 +0,0 @@
|
||||
#!/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.6
|
||||
################################################################################
|
||||
|
||||
################################################################
|
||||
# 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
|
||||
export EOS_USE_ANTICHEATCLIENTNULL=1
|
||||
# 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
|
3086
lug-helper.sh
3086
lug-helper.sh
File diff suppressed because it is too large
Load Diff
BIN
lug-logo.png
BIN
lug-logo.png
Binary file not shown.
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 35 KiB |
BIN
rsi-launcher.png
BIN
rsi-launcher.png
Binary file not shown.
Before Width: | Height: | Size: 46 KiB |
Reference in New Issue
Block a user