Merge pull request #36 from pythonlover02/next

Release 1.3.0

Author: pythonlover02

README.md

@@ -1,6 +1,8 @@
-# volt-gui:
+# volt-gui
 
-A graphical user interface for configuring GPU related environment variables and more for Linux gaming. Originally designed just for me and my friends, but seeing that it could be useful for other Linux users i have decided to Open Source it.
+> **My AMD Adrenaline / NVIDIA Settings Linux Alternative**
+
+A graphical interface for configuring GPU, CPU, Disk, and Kernel performance settings for Linux gaming. Initially made for personal use, now open-sourced so others can benefit from it too.
 
 ![Badge Language](https://img.shields.io/github/languages/top/pythonlover02/volt-gui)
 [![Stars](https://img.shields.io/github/stars/pythonlover02/volt-gui?style=social)](https://github.com/pythonlover02/volt-gui/stargazers)
@@ -23,90 +25,38 @@ A graphical user interface for configuring GPU related environment variables and
 
 ## What you can do?:
 
-- CPU Management
-  - Governor Selection: Choose from available CPU governors
+### CPU Management:
+  - Governor Selection: Choose from available CPU governors.
   - Adjust the maximum and minimum CPU frequencies within the permitted range.
-  - Scheduler Configuration: Select CPU pluggable schedulers (requires [scx](https://github.com/sched-ext/scx) and `Linux Kernel >= 6.12` or a `Custom Patched Kernel`)
-- GPU Configuration
-  - Mesa Drivers: Configure Mesa Drivers specific environment variables
-  - NVIDIA Drivers: Configure NVIDIA Proprietary Drivers specific environment variables
-  - Render Selection: Choose the renderers for both OpenGL and Vulkan applications
-  - Set a frame limit for both OpenGL and Vulkan applications, Texture Filters and MidMap LOD Bias for Vulkan only (requires [mangohud](https://github.com/flightlessmango/MangoHud))
-  - All those GPU settings will be added to the `volt` script
-- Disk Configuration
+  - Scheduler Configuration: Select, start and stop CPU pluggable schedulers (requires [scx](https://github.com/sched-ext/scx) and `Linux Kernel >= 6.12` or a `Custom Patched Kernel`).
+### GPU Configuration:
+  - Mesa Drivers: Configure Mesa Drivers specific environment variables.
+  - NVIDIA Drivers: Configure NVIDIA Proprietary Drivers specific environment variables.
+  - Dynamic Render Selection: Select renderers for both OpenGL and Vulkan applications. The program dynamically sets the required environment variables depending on your GPU.
+  - Configure various MangoHud options.
+  - Configure lsfg-vk settings
+  - All GPU settings are automatically added to the `volt` script.
+### Disk Configuration:
   - Change Disks Schedulers
-- Kernel Configuration
-  - Choose /proc/sys/vm/compaction_proactiveness value
-  - Choose /proc/sys/vm/watermark_boost_factor value
-  - Choose /proc/sys/vm/watermark_scale_factor value
-  - Choose /proc/sys/vm/extfrag_threshold value
-  - Choose /proc/sys/vm/compact_unevictable_allowed value
-  - Choose /proc/sys/vm/defrag_mode value
-  - Choose /proc/sys/vm/min_free_kbytes value
-  - Choose /proc/sys/vm/overcommit_memory value
-  - Choose /proc/sys/vm/overcommit_ratio value
-  - Choose /proc/sys/vm/admin_reserve_kbytes value
-  - Choose /proc/sys/vm/user_reserve_kbytes value
-  - Choose /proc/sys/vm/max_map_count value
-  - Choose /proc/sys/vm/mmap_min_addr value
-  - Choose /proc/sys/vm/page_lock_unfairness value
-  - Choose /proc/sys/vm/swappiness value
-  - Choose /proc/sys/vm/page-cluster value
-  - Choose /proc/sys/vm/vfs_cache_pressure value
-  - Choose /proc/sys/vm/percpu_pagelist_high_fraction value
-  - Choose /proc/sys/vm/zone_reclaim_mode value
-  - Choose /proc/sys/vm/min_unmapped_ratio value
-  - Choose /proc/sys/vm/min_slab_ratio value
-  - Choose /proc/sys/vm/numa_stat value
-  - Choose /proc/sys/vm/oom_kill_allocating_task value
-  - Choose /proc/sys/vm/oom_dump_tasks value
-  - Choose /proc/sys/vm/panic_on_oom value
-  - Choose /proc/sys/vm/dirty_ratio value
-  - Choose /proc/sys/vm/dirty_background_ratio value
-  - Choose /proc/sys/vm/dirty_bytes value
-  - Choose /proc/sys/vm/dirty_background_bytes value
-  - Choose /proc/sys/vm/dirty_expire_centisecs value
-  - Choose /proc/sys/vm/dirty_writeback_centisecs value
-  - Choose /proc/sys/vm/dirtytime_expire_seconds value
-  - Choose /proc/sys/vm/laptop_mode value
-  - Choose /proc/sys/vm/nr_hugepages value
-  - Choose /proc/sys/vm/nr_overcommit_hugepages value
-  - Choose /proc/sys/vm/hugetlb_optimize_vmemmap value
-  - Choose /proc/sys/vm/stat_interval value
-  - Choose /sys/kernel/mm/transparent_hugepage/enabled value
-  - Choose /sys/kernel/mm/transparent_hugepage/shmem_enabled value
-  - Choose /sys/kernel/mm/transparent_hugepage/defrag value
-  - Choose /sys/class/rtc/rtc0/max_user_freq value
-  - Choose /proc/sys/kernel/numa_balancing value
-  - Choose /proc/sys/kernel/randomize_va_space value
-  - Choose /proc/sys/kernel/perf_event_paranoid value
-  - Choose /proc/sys/kernel/sched_cfs_bandwidth_slice_us value
-  - Choose /proc/sys/kernel/sched_autogroup_enabled value
-  - Choose /proc/sys/kernel/sched_rt_runtime_us value
-  - Choose /proc/sys/kernel/sched_rt_period_us value
-  - Choose /proc/sys/kernel/sched_schedstats value
-  - Choose /proc/sys/kernel/timer_migration value
-  - Choose /proc/sys/kernel/watchdog value
-  - Choose /proc/sys/kernel/nmi_watchdog value
-  - Choose /proc/sys/kernel/hung_task_timeout_secs value
-  - Choose /proc/sys/kernel/pid_max value
-  - Choose /proc/sys/fs/file-max value
-  - Choose /proc/sys/net/core/rmem_max value
-  - Choose /proc/sys/net/core/wmem_max value
-  - Choose /proc/sys/net/ipv4/tcp_fastopen value
-  - Choose /proc/sys/net/ipv4/tcp_window_scaling value
-  - Choose /proc/sys/net/ipv4/tcp_timestamps value
-
-- Launch Options: add custom Launch Options to the `volt` that will be passed to the program executed, example:
+### Configure Kernel Parameters related to:
+  - CPU
+  - Memory
+  - Disk
+  - System
+  - Network
+  - Security
+### Add custom launch options to the `volt` script:
+
+These will be passed to the executed program. Example:
   ```
   gamemoderun PROTON_USE_WINED3D=1
   ```
-- Extras
-  - Useful Links for the average Linux Gamer
-  - Useful Programs for the average Linux Gamer
-- Options
-  - Options for the program itself
-- Create or Delete Profiles, all of them with its own settings, witch you can apply trough the program or systray.
+### Extras:
+  - Useful Links and Programs for the average Linux Gamer.
+### Options:
+  - Configure settings specific to the volt-gui program itself.
+### Create or Delete Profiles:
+  - Each profile has its own set of configurations, which can be applied through the program or system tray.
 
 ## Build/Test Requirements:
 
@@ -122,29 +72,34 @@ A graphical user interface for configuring GPU related environment variables and
 - ccache (optional, for optimizing compiling times)
 
 ## Additional requirements for some Options:
+
 If this software is not provided, its options will be locked.
 
 - [scx](https://github.com/sched-ext/scx) in the case you want to make use of the CPU Pluggable Schedulers
-- [mangohud](https://github.com/flightlessmango/MangoHud) in the case you want to make use of the Render Pipeline Settings. Both the native or the Flatpak version satisfy the dependency.
+- [mangohud](https://github.com/flightlessmango/MangoHud) in the case you want to make use of the MangoHud Settings. Both the native or the Flatpak version satisfy the dependency.
+- [lsfg-vk](https://github.com/PancakeTAS/lsfg-vk) in the case you want to make use of the LS Frame Gen Settings. Both the native or the Flatpak version satisfy the dependency.
 - `glxinfo` its required to use the OpenGL Render Selector.
 - `vulkaninfo` and the `vulkan mesa layer` are required to use the Vulkan Render Selector.
 
 ## Installation:
 
 ### Quick Install:
+
 1. Run one of the builds scripts avaliable to create the application:
-   
+
    Using Pyinstaller:
+
    ```bash
    ./make-pyinstaller.sh
    ```
-   
+
    Using Nuitka:
+
    ```bash
    ./make-nuitka.sh
    ```
 
-   *Note: Both use a Python virtual environment to avoid system wide package installation using pip*
+   _Note: Both use a Python virtual environment to avoid system wide package installation using pip_
 
 2. Install the application system wide:
    ```bash
@@ -156,6 +111,7 @@ If this software is not provided, its options will be locked.
    - Create a desktop entry at `/usr/share/applications/volt-gui.desktop`
 
 ### Removal:
+
 1. To uninstall volt-gui:
    ```bash
    sudo ./remove.sh
@@ -167,20 +123,23 @@ If this software is not provided, its options will be locked.
    - Remove the desktop entry `/usr/share/applications/volt-gui.desktop`
 
 ## Testing volt-gui:
+
 In the case you want to contribute to the project you can use the provided `test.sh` script to test the changes you made. This script will create a Python virtual environment if one does not already exist. This way, you don't have to install the program dependencies systemwide.
 
 The first time you run it, use the -c flag that will also copy the `volt-helper` to `/usr/local/bin/`, as the program requires it for appliying the settings:
+
 ```
 ./test.sh -c
 ```
 
 After this unless you make changes to the `volt-helper`, or the script have been updated, just run it without the flag to avoid unnecessary overwrites of the script:
+
 ```
 ./test.sh
 ```
 
-> [!NOTE]  
-> You can use the `remove.sh` script to remove the `volt-helper`. The `py_env` folder should be deleted in the case you created it with your system python, and you want to use a python version that its inside a `distrobox` box, or vice versa. 
+> [!NOTE]
+> You can use the `remove.sh` script to remove the `volt-helper`. The `py_env` folder should be deleted in the case you created it with your system python, and you want to use a python version that its inside a `distrobox` box, or vice versa.
 
 ## How to use `volt-gui`:
 
@@ -201,11 +160,13 @@ volt glxgears
 When using a Launcher to play your game, you can just add it to the game launch options, like this:
 
 Steam (Native):
+
 ```
 volt %command%
 ```
 
 Lutris (Native):
+
 ```
 volt
 ```
@@ -220,26 +181,30 @@ volt flatpak run net.pcsx2.PCSX2
 
 ## Render Selector explained:
 
-- `Select OpenGL Renderer` Selects the GPU/Renderer that will be used to render OpenGL programs. Those GPUs are obtained trough `glxinfo`.
-- `Select Vulkan Renderer` Selects the GPU/Renderer that will be used to render Vulkan programs. Those GPUs are obtained trough `vulkaninfo`, also for this to work on some distros you might need to install some additional dependencies like `vulkan-mesa-layers` on Arch Linux. More info its provided on the Welcome Window that opens once you open volt-gui.
+- `Select OpenGL Renderer` Selects the GPU/Renderer that will be used to render OpenGL programs. Those GPUs/Renderers are obtained trough `glxinfo`.
+- `Select Vulkan Renderer` Selects the GPU/Renderer that will be used to render Vulkan programs. Those GPUs/Renderers are obtained trough `vulkaninfo`, also for this to work on some distros you might need to install some additional dependencies like `vulkan-mesa-layers` on Arch Linux. More info its provided on the Welcome Window that opens once you open volt-gui.
 
 ## Technical References:
 
-Documentation used:
+Based on documentation and references from:
 
 - [Arch Linux Wiki - Improving performance](https://wiki.archlinux.org/title/Improving_performance)
 - [Arch Linux Wiki - Gaming](https://wiki.archlinux.org/title/Gaming#Improving_performance)
 - [sched-ext tutorial - CachyOs Wiki](https://wiki.cachyos.org/configuration/sched-ext/)
 - [sched-ext scx Github - Readme](https://github.com/sched-ext/scx/blob/main/README.md)
 - [MangoHud Github - Readme](https://github.com/flightlessmango/MangoHud/blob/master/README.md)
+- [lsfg-vk Github - Readme](https://github.com/PancakeTAS/lsfg-vk)
+- [lsfg-vk Github - Wiki](https://github.com/PancakeTAS/lsfg-vk/wiki)
 - [Mesa Documentation - Environment Variables](https://docs.mesa3d.org/envvars.html#environment-variables)
 - [FreeDesktop - Dri Configuration Options](https://dri.freedesktop.org/wiki/ConfigurationOptions/)
-- [NVIDIA 570 Drivers - Documentation](https://download.nvidia.com/XFree86/Linux-x86_64/570.153.02/README/openglenvvariables.html)
-- [NVIDIA 470 Drivers - Documentation](https://download.nvidia.com/XFree86/Linux-x86_64/470.256.02/README/openglenvvariables.html)
-- [NVIDIA 390 Drivers - Documentation](https://download.nvidia.com/XFree86/Linux-x86_64/390.157/README/openglenvvariables.html)
+- [NVIDIA 580 Drivers - Documentation](https://download.nvidia.com/XFree86/Linux-x86_64/580.82.09/README/)
+- [NVIDIA 570 Drivers - Documentation](https://download.nvidia.com/XFree86/Linux-x86_64/570.153.02/README/)
+- [NVIDIA 470 Drivers - Documentation](https://download.nvidia.com/XFree86/Linux-x86_64/470.256.02/README/)
+- [NVIDIA 390 Drivers - Documentation](https://download.nvidia.com/XFree86/Linux-x86_64/390.157/README/)
 - [Linux Kernel - Subsystem Documentation](https://docs.kernel.org/subsystem-apis.html)
 - Additionally, sometimes i had to read code from Open Source projects to check how some options work.
 
 ## Contributing:
 
-Contributions are welcome. Please ensure any changes maintain compatibility with the supported Python versions and follow the existing code structure. You might want to read: [Build/Test Requirements](#buildtest-requirements), [Installation](#installation) and [Testing volt-gui](#testing-volt-gui).
+Contributions are welcome. Please ensure compatibility with supported Python versions and follow the existing code structure.
+Read: [Build/Test Requirements](#buildtest-requirements), [Installation](#installation), and [Testing volt-gui](#testing-volt-gui) before contributing.

images/1.png

@@ -1,48 +1,39 @@
 #!/bin/bash
 
-# Exit on errors and unset variables
-set -eu
+set -euo pipefail
 
-# Check if running with sudo
 if [[ $EUID -ne 0 ]]; then
   echo -e "\033[31mError: Please run this script as root (use sudo)\033[0m" >&2
   exit 1
 fi
 
-# Configuration
 INSTALL_DIR="/usr/local/bin"
 BIN_DIR="bin"
 EXECUTABLE="$BIN_DIR/volt-gui"
 HELPER_SCRIPT="scripts/volt-helper"
 DESKTOP_FILE="/usr/share/applications/volt-gui.desktop"
 
-# Check bin directory
 if [[ ! -d "$BIN_DIR" ]]; then
   echo -e "\033[31mError: bin directory not found. Run make-pyinstaller.sh or make-nuitka.sh first.\033[0m" >&2
   exit 1
 fi
 
-# Check main executable
 if [[ ! -f "$EXECUTABLE" ]]; then
   echo -e "\033[31mError: Executable 'volt-gui' not found in bin directory. Run make-pyinstaller.sh or make-nuitka.sh first.\033[0m" >&2
   exit 1
 fi
 
-# Check helper script
 if [[ ! -f "$HELPER_SCRIPT" ]]; then
   echo -e "\033[31mError: Helper script $HELPER_SCRIPT not found.\033[0m" >&2
   exit 1
 fi
 
-# Install main executable
 echo -e "\033[34mInstalling main executable...\033[0m"
 install -v -m 755 -T "$EXECUTABLE" "$INSTALL_DIR/volt-gui"
 
-# Install helper script
 echo -e "\n\033[34mInstalling helper script...\033[0m"
 install -v -m 755 -T "$HELPER_SCRIPT" "$INSTALL_DIR/volt-helper"
 
-# Create desktop entry
 echo -e "\n\033[34mCreating desktop entry...\033[0m"
 cat > "$DESKTOP_FILE" << EOF
 [Desktop Entry]
@@ -57,7 +48,6 @@ EOF
 
 echo "Desktop entry created at $DESKTOP_FILE"
 
-# Update desktop database
 echo -e "\n\033[34mUpdating desktop database...\033[0m"
 update-desktop-database "$(dirname "$DESKTOP_FILE")"