README.md

---

Goverlay is a modern Qt6 GUI application for Linux gamers that puts powerful performance and visual tools behind an easy-to-use interface. It configures MangoHud, vkBasalt, vkSumi, OptiScaler, and Proton environment tweaks through a visual, card-based layout — generating the config files and launch commands you drop into Steam or Lutris.

Whether you want real-time performance monitoring, post-processing effects, smarter upscaling, DLSS/FSR frame generation, or per-game environment overrides, Goverlay handles it in a few clicks.

This project exists thanks to the amazing work of the original maintainers and contributors behind the core tools.
I’m just a network engineer who loves Linux and gaming — this is my way of giving something back to the community.

---

Table of Contents

• Screenshots
• Prerequisites
• Installation
  • Universal Methods
    • Flatpak
    • AppImage
  • Distributions
    • Arch and derivatives
    • OpenSUSE
    • Solus
    • Fedora / Debian / Ubuntu
  • Tarball
  • Building from Source
• Architecture
• Keyboard Shortcuts
• Credits
• Donations

---

Integrated Vulkan Preview (PasCube)

Goverlay ships with PasCube, a full Vulkan demo compiled from the PasVulkan engine. It launches automatically (or on demand) to preview your MangoHud, vkBasalt, and vkSumi settings in real time. The demo title bar and overlay display the current GOverlay version.

Per-Game Config Architecture

When a game is selected, GOverlay switches to Game Mode. Each game gets its own XDG-compliant config directory containing:

• MangoHud.conf
• vkBasalt.conf
• vkSumi.conf
• OptiScaler.ini
• fakenvapi.ini
• bgmod.conf
• bgmod wrapper binary

The bottom launch command box updates to show the game-specific bgmod command with %command% suffix, ready to paste into Steam.

bgmod Wrapper

bgmod is a compiled Free Pascal binary (not a bash script) that replaces the legacy fgmod approach. It:

• Intercepts game execution arguments.
• Exports environment variables from bgmod.conf.
• Sets up Wine DLL overrides.
• Copies upscaler binaries/plugins into the game folder on launch.
• Supports launcher EXE replacements and UE Shipping EXE auto-discovery.
• Logs to /tmp/bgmod.log, the game directory, and ~/.local/share/goverlay/logs/[Game Name]/.

An uninstaller binary (bgmod-uninstaller) cleanly removes wrapper files and restores original backups.

---

Screenshots

Click to view screenshots

---

Prerequisites

Required

• mangohud — Performance overlay / monitoring
• git — Used to clone repositories (e.g., ReShade shaders)
• qt6pas — Qt6 bindings for Free Pascal / Lazarus
• gamemode — Feral GameMode daemon (for the GameMode tweak)
• Nerd Fonts — Used for icon glyphs in the sidebar and game badges

Optional / Used by specific features

• vkBasalt — Vulkan post-processing effects
• vksumi (optional but recommended) — Alternative Vulkan post-processor with 15 tunable parameters
• zenergy — Displays AMD CPU power metrics in MangoHud
• protontricks — Proton prefix management (native builds only, disabled in Flatpak)

---

Installation

Universal Methods

Flatpak

You can download it from Flathub

# Add Flathub repository
flatpak remote-add --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo

# Install Goverlay
flatpak install flathub io.github.benjamimgois.goverlay

# Install required Vulkan layers for MangoHud and vkBasalt support
flatpak install flathub org.freedesktop.Platform.VulkanLayer.MangoHud//25.08 \
org.freedesktop.Platform.VulkanLayer.vkBasalt//25.08 -y

# Download vksumi flatpak runtime from its github page and install
https://github.com/reakjra/vkSumi
flatpak install vkSumi-25.08.flatpak

AppImage

Download the AppImage from the Releases page and make it executable:

chmod +x Goverlay_*.AppImage
./Goverlay_*.AppImage

Distributions

Arch and derivatives

Option 1 – Official Repository

sudo pacman -S goverlay

Option 2 – AUR

yay -S goverlay-git

OpenSUSE

sudo zypper install goverlay

Solus

sudo eopkg it goverlay

---

Libqt6pas

The libqt6pas package is not available in some distributions’ official repositories.
You can get it from David Bannon’s repository:

Ubuntu example:

sudo apt-get update
wget https://github.com/davidbannon/libqt6pas/releases/download/v6.2.8/libqt6pas6_6.2.8-1_amd64.deb
sudo dpkg -i libqt6pas6_6.2.8-1_amd64.deb

Tarball

1. Download the latest tarball from the Releases page.
2. Extract it:

   tar -xvf Goverlay*.tar.xz
   

3. Run the binary:

   ./Goverlay
   

Note: Since version 0.6.4, MangoHud must be installed to run Goverlay.

Building from Source

Prerequisites

• Lazarus IDE with Qt6 widgetset support
• Qt6 development libraries (qt6-base-dev or equivalent)
• make
• git

Building

git clone https://github.com/benjamimgois/Goverlay.git
cd Goverlay
make

This compiles both goverlay and the integrated pascube Vulkan preview.

Running

./goverlay

Installing

sudo make install

This installs the startup script to /usr/local/bin/goverlay, allowing you to launch it directly via:

goverlay

---

Architecture

Component	Technology
Language	Free Pascal (ObjFPC mode)
IDE / Framework	Lazarus LCL with Qt6 widgetset
UI Designer	Lazarus IDE manages .lfm files
Build Tool	make (wrapper around lazbuild)
Target	Single Linux binary (goverlay)
Preview	Integrated Vulkan demo (pascube, PasVulkan engine)
Wrapper	Compiled Free Pascal binary (bgmod) replacing legacy bash scripts

---

Keyboard Shortcuts

Shortcut	Action
Ctrl + S	Save current tab configuration
Ctrl + C	Copy launch command to clipboard
Ctrl + F	Focus global search field
F1	Open "How to use FGMOD" quick guide

---

Credits

FlightlessMango

Huge thanks to FlightlessMango, creator and maintainer of MangoHud — the foundation that made Goverlay possible.

• https://flightlessmango.com
• https://github.com/flightlessmango/MangoHud
• https://discord.com/invite/Gj5YmBb

DadSchoorse

Special thanks to DadSchoorse, creator of vkBasalt, which adds post-processing effects to Vulkan.

• https://github.com/DadSchoorse/vkBasalt

OptiScaler Team & Contributors

Goverlay integrates several components from the OptiScaler ecosystem and community-driven projects that enable upscaling, frame generation, and NVIDIA APIs on Linux.

OptiScaler

Core upscaling and frame-generation project for Linux.

https://github.com/optiscaler/OptiScaler

fakenvapi

User-space implementation of NVAPI used by OptiScaler and other tools.

https://github.com/optiscaler/fakenvapi

Decky-Framegen (xXJSONDeruloXx)

Pioneer project that inspired much of the OptiScaler installation logic.

https://github.com/xXJSONDeruloXx/Decky-Framegen

fgmod (FakeMichau)

Another important reference implementation for frame-generation utilities on Linux.

https://github.com/FakeMichau/fgmod

DLSS-Enabler (Artur Graniszewski)

Tooling that expands compatibility layers for DLSS and NVAPI-based features.

https://github.com/artur-graniszewski/DLSS-Enabler

Lazarus IDE

This project was built using the Lazarus IDE.

---

Donations

If this project has been useful to you, consider supporting its development ❤️