mirror of
https://github.com/the-sane/lug-helper.git
synced 2025-09-18 15:31:15 +00:00
Compare commits
1 Commits
main
...
2780788f70
Author | SHA1 | Date | |
---|---|---|---|
|
2780788f70 |
23
.github/CONTRIBUTING.md
vendored
23
.github/CONTRIBUTING.md
vendored
@@ -1,23 +0,0 @@
|
||||
# Contributor's Guide
|
||||
### Project Goals
|
||||
The LUG Helper is a purpose-built bash script for the [Star Citizen Linux Users Group](https://wiki.starcitizen-lug.org/). Our community is a diverse group of Penguins running many differnet Linux distros on all kinds of hardware. As such, ease of use and compatibility are primary focuses of the project.
|
||||
|
||||
The Helper is designed to be easy and intuitive for novice Penguins who may be using Linux for the very first time. It clearly communicates to the user what is being done and aims to provide working defaults without overwhelming the user with too many unnecessary choices.
|
||||
|
||||
### Pull Request Guidelines
|
||||
With the above project goals in mind, please consider the following guidelines when submitting Pull Requests:
|
||||
- Avoid overwhelming the user with choices and, instead, provide defaults that "Just Work".
|
||||
- Any messages or options presented to the user should be clear and concise.
|
||||
- The Helper should not make any changes to the user's system without first asking or notifying the user.
|
||||
- Avoid duplicating code. Make use of the existing helper functions. See [Code Structure and Overview](https://github.com/starcitizen-lug/lug-helper/wiki/Code-Structure-and-Overview).
|
||||
|
||||
### Code Syntax and Formatting Guidelines
|
||||
- Match existing code styling and syntax for consistency and legibility.
|
||||
- Use POSIX-compliant code where possible for portability.
|
||||
- Where non-POSIX, bash-specific syntax is necessary for functionality or because it vastly simplifies code maintenance, check in which bash version the feature was introduced. Verify that the syntax will work on LTS distros.
|
||||
- Where possible, code should be easy to understand by someone moderately competent with shell script.
|
||||
- Avoid overly simplified one-liners that are difficult to parse. Break it up.
|
||||
- Please comment your code!
|
||||
|
||||
---
|
||||
❤️ Many thanks to everyone who has [contributed](https://github.com/starcitizen-lug/lug-helper/graphs/contributors) to the project!
|
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.
|
8
.github/ISSUE_TEMPLATE/config.yml
vendored
8
.github/ISSUE_TEMPLATE/config.yml
vendored
@@ -1,8 +0,0 @@
|
||||
blank_issues_enabled: false
|
||||
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/QRexSTkF25
|
||||
about: Get help 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.
|
14
.github/pull_request_template.md
vendored
14
.github/pull_request_template.md
vendored
@@ -1,14 +0,0 @@
|
||||
## Current behavior
|
||||
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue -->
|
||||
|
||||
## Changes made
|
||||
<!-- Please describe the changes made by this PR -->
|
||||
|
||||
## Other information
|
||||
<!-- Any other information that is important to this PR -->
|
||||
|
||||
## Checklist
|
||||
<!-- Put an `x` the boxes to check them off -->
|
||||
- [ ] I've read the [Contributor's Guide](https://github.com/starcitizen-lug/lug-helper?tab=contributing-ov-file)
|
||||
- [ ] I have fully tested this PR
|
||||
- [ ] The code is well documented
|
92
README.md
92
README.md
@@ -1,4 +1,4 @@
|
||||
# LUG Helper
|
||||
# LUG-Helper
|
||||
**Star Citizen's Linux Users Group Helper Script**
|
||||
https://robertsspaceindustries.com/orgs/LUG
|
||||
|
||||
@@ -8,91 +8,65 @@ _**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
|
||||
- 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
|
||||
- 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`
|
||||
- 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/Repair launch script`
|
||||
- Update the game launch script to the latest version or repair broken paths
|
||||
- `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
|
||||
- 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/*
|
||||
|
||||
`Get a random Penguin's Star Citizen referral code`
|
||||
- Display a referral code for a random member of the Star Citizen Linux Users Group
|
||||
- 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!
|
||||
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
|
||||
|
||||
❤️ Many thanks to everyone who has contributed to the project!
|
||||
You can view commit graphs for the Helper's contributors [here](https://github.com/starcitizen-lug/lug-helper/graphs/contributors).
|
||||
|
||||
## Contributing
|
||||
Please read the [Contributor's Guide](https://github.com/starcitizen-lug/lug-helper?tab=contributing-ov-file).
|
||||
For a high level overview of the script's functions, please see [Code Structure and Overview](https://github.com/starcitizen-lug/lug-helper/wiki/Code-Structure-and-Overview) on the wiki.
|
||||
Packagers, please see the [Packager's Guide](https://github.com/starcitizen-lug/lug-helper/wiki/Packagers-Guide).
|
||||
|
@@ -1,84 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# This script launches Star Citizen using Wine.
|
||||
# It is meant to be used after installation via the LUG Helper.
|
||||
#
|
||||
# Usage:
|
||||
# Run from your terminal or use the .desktop files installed by the Helper.
|
||||
#
|
||||
# version: 1.9
|
||||
|
||||
############################################################################
|
||||
# ENVIRONMENT VARIABLES
|
||||
############################################################################
|
||||
# Add additional environment variables to this section as needed
|
||||
# Example:
|
||||
# export NEW_VARIABLE="value"
|
||||
############################################################################
|
||||
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"
|
||||
# Performance options
|
||||
export WINEESYNC=1
|
||||
export WINEFSYNC=1
|
||||
# Optional HUDs
|
||||
#export DXVK_HUD=fps,compiler
|
||||
#export MANGOHUD=1
|
||||
|
||||
############################################################################
|
||||
# END ENVIRONMENT VARIABLES
|
||||
############################################################################
|
||||
|
||||
##################
|
||||
# Wine binary path
|
||||
##################
|
||||
# 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
|
||||
|
||||
##########################
|
||||
# Update check and cleanup
|
||||
##########################
|
||||
# Kill existing wine processes before launch
|
||||
update_check() {
|
||||
while "$wine_path"/winedbg --command "info proc" | grep -qi "rsi.*setup"; do
|
||||
echo "RSI Setup process detected. Exiting."; exit 0
|
||||
done
|
||||
}
|
||||
"$wine_path"/wineserver -k
|
||||
|
||||
############################################################################
|
||||
# Launch the game
|
||||
############################################################################
|
||||
"$wine_path"/wine "C:\Program Files\Roberts Space Industries\RSI Launcher\RSI Launcher.exe" > "$launch_log" 2>&1
|
3142
lug-helper.sh
3142
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