Merge pull request #22 from pythonlover02/experimental

Update Readme, Render Selector and change Frame Options to Render Pipeline

Author: pythonlover02

README.md

@@ -12,6 +12,18 @@ A graphical user interface for configuring GPU related environment variables and
 ![](/images/2.png)
 ![](/images/3.png)
 
+## Table of Contents
+
+- [What you can do?](#what-you-can-do)
+- [Build/Test Requirements](#buildtest-requirements)
+- [Installation](#installation)
+- [Testing volt-gui](#testing-volt-gui)
+- [How to use volt-gui](#how-to-use-volt-gui)
+- [How to use the volt script](#how-to-use-the-volt-script)
+- [Render Selector explained](#render-selector-explained)
+- [Technical References](#technical-references)
+- [Contributing](#contributing)
+
 ## What you can do?:
 
 - CPU Management
@@ -21,7 +33,7 @@ A graphical user interface for configuring GPU related environment variables and
   - 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 frame limit for both OpenGL and Vulkan applications (requires [mangohud](https://github.com/flightlessmango/MangoHud))
+  - 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
   - Change Disks Schedulers
@@ -47,7 +59,7 @@ A graphical user interface for configuring GPU related environment variables and
   - Choose /proc/sys/kernel/nmi_watchdog value
   - Choose /proc/sys/vm/laptop_mode value
 
-- Launch Options: add custom Launch Options to the `volt` that will be passed to the program executed, ej:
+- Launch Options: add custom Launch Options to the `volt` that will be passed to the program executed, example:
   ```
   gamemoderun PROTON_USE_WINED3D=1
   ```
@@ -58,24 +70,24 @@ A graphical user interface for configuring GPU related environment variables and
   - 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.
 
-## Build Requirements:
+## Build/Test Requirements:
 
 - Python 3.9 or higher
 - Pip
 - The `python3-venv` package its required on Debian/Debian based distros.
 - Linux operating system
 
-### Additional requirements in the case you build the program using Nuitka:
+## Additional requirements in the case you build the program using Nuitka:
 
 - C/C++ Compiler
 - patchelf
 - ccache (optional, for optimizing compiling times)
 
-### Additional requirements for some Options:
+## 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 Frame Options 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 Render Pipeline Settings. Both the native or the Flatpak version satisfy the dependency.
 
 ## Installation:
 
@@ -100,7 +112,7 @@ If this software is not provided, its options will be locked.
    ```
    This will:
    - Copy the executable to `/usr/local/bin/`
-   - Copy the helper scripts to `/usr/local/bin/`
+   - Copy the `volt-helper` script to `/usr/local/bin/`
    - Create a desktop entry at `/usr/share/applications/volt-gui.desktop`
 
 ### Removal:
@@ -110,10 +122,26 @@ If this software is not provided, its options will be locked.
    ```
    This will:
    - Remove the `volt-gui` executable from `/usr/local/bin/`
-   - Remove the helper scripts from `/usr/local/bin/`
+   - Remove the `volt-helper` script from `/usr/local/bin/`
    - Remove the `volt` bash script from `/usr/local/bin/`
    - 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. 
+
 ## How to use `volt-gui`:
 
 Simply launch volt-gui from your application menu or run `volt-gui` from the terminal.
@@ -150,11 +178,10 @@ When using the terminal or a custom desktop entry:
 volt flatpak run net.pcsx2.PCSX2
 ```
 
-## GPU Selector explained:
+## Render Selector explained:
 
-- `GLX Vendor Library` Select a GLX provider between the NVIDIA Proprietary Drivers and Mesa Drivers.
-- `Mesa Select GPU` Select which to use GPU among those available on the system. (Only for GPUs using the Mesa Drivers)
-- `OpenGL Software Rendering` Use Mesa OpenGL Software Rendering; this will ignore the `Mesa Select GPU` option.
+- `OpenGL Provider` Select a OpenGL provider between the NVIDIA Proprietary Drivers and Mesa Drivers.
+- `Mesa Select GPU` In this case “select” means the GPU will be first in the reported physical devices list, It applies to OpenGL and Vulkan and only GPUs using the Mesa Drivers. Something to add its that the `OpenGL Provider` and `Vulkan ICD` settings have priority over this.
 - `Vulkan ICD` Selects the Vulkan Installable Client Driver, obtained from `/usr/share/vulkan/icd.d/`.
 
 ## Technical References:
@@ -167,10 +194,11 @@ Documentation used:
 - [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)
 - [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)
 
 ## Contributing:
 
-Contributions are welcome. Please ensure any changes maintain compatibility with the supported Python versions and follow the existing code structure.
+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).

build-nuitka.sh

@@ -28,7 +28,7 @@ NUITKA_OPTS=(
 
 # Cleanup function
 cleanup() {
-    rm -rf "$BASE_FILENAME.build/" "$BASE_FILENAME.dist/" "$BASE_FILENAME.onefile-build/" **__pycache__*/ 2>/dev/null || true
+    rm -rf "$BASE_FILENAME.build/" "$BASE_FILENAME.dist/" "$BASE_FILENAME.onefile-build/" 2>/dev/null || true
 }
 
 # Check for required commands

build-pyinstaller.sh

@@ -27,7 +27,7 @@ PYINSTALLER_OPTS=(
 
 # Cleanup function
 cleanup() {
-    rm -rf dist/ build/ **__pycache__*/ "${SPEC_FILE}" 2>/dev/null || true
+    rm -rf dist/ build/ "${SPEC_FILE}" 2>/dev/null || true
 }
 
 # Check for required commands

src/config.py

@@ -64,10 +64,10 @@ def save_config(cpu_widgets, gpu_widgets, kernel_widgets, disk_widgets, profile_
             if hasattr(widget, 'currentText') and widget_key != 'render_selector_apply_button':
                 config['RenderSelector'][widget_key] = widget.currentText()
 
-        config['FrameControl'] = {}
-        for widget_key, widget in gpu_widgets['frame_control'].items():
-            if hasattr(widget, 'currentText') and widget_key != 'frame_control_apply_button':
-                config['FrameControl'][widget_key] = widget.currentText()
+        config['RenderPipeline'] = {}
+        for widget_key, widget in gpu_widgets['render_pipeline'].items():
+            if hasattr(widget, 'currentText') and widget_key != 'render_pipeline_apply_button':
+                config['RenderPipeline'][widget_key] = widget.currentText()
 
         if 'launch_options_input' in gpu_widgets['launch_options']:
             launch_options = gpu_widgets['launch_options']['launch_options_input'].text().replace('%', '%%')
@@ -124,10 +124,10 @@ def load_config(cpu_widgets, gpu_widgets, kernel_widgets, disk_widgets, profile_
                 if widget_key in gpu_widgets['render_selector'] and hasattr(gpu_widgets['render_selector'][widget_key], 'setCurrentText'):
                     gpu_widgets['render_selector'][widget_key].setCurrentText(value)
 
-        if 'FrameControl' in config and 'frame_control' in gpu_widgets:
-            for widget_key, value in config['FrameControl'].items():
-                if widget_key in gpu_widgets['frame_control'] and hasattr(gpu_widgets['frame_control'][widget_key], 'setCurrentText'):
-                    gpu_widgets['frame_control'][widget_key].setCurrentText(value)
+        if 'RenderPipeline' in config and 'render_pipeline' in gpu_widgets:
+            for widget_key, value in config['RenderPipeline'].items():
+                if widget_key in gpu_widgets['render_pipeline'] and hasattr(gpu_widgets['render_pipeline'][widget_key], 'setCurrentText'):
+                    gpu_widgets['render_pipeline'][widget_key].setCurrentText(value)
 
         if 'LaunchOptions' in config and 'launch_options' in gpu_widgets and 'launch_options_input' in gpu_widgets['launch_options']:
             launch_options = config['LaunchOptions'].get('launch_options', '').replace('%%', '%')