kira-bruneau / goverlay

GOverlay is an opensource project that aims to create a Graphical UI to help manage Linux overlays.

GOverlay

GOverlay is an open source project aimed to create a Graphical UI to manage Vulkan/OpenGL overlays. It is still in early development, so it lacks a lot of features.

This project was only possible thanks to the other maintainers and contributors that have done the hard work. I am just a Network Engineer that really likes Linux and Gaming.

Table of contents

• Screenshot
• Prerequisites
• Installation
  • Distributions
    • Arch / Manjaro / Other Arch derivatives
    • Fedora
    • Solus
    • Ubuntu
  • Tarball
  • Source
    • Prerequisites
    • Building
    • Running
• Credits
• Donations

Screenshot

Prerequisites

Here are the dependencies needed in order to make GOverlay run:

• mangohud - Configure MangoHud
• mesa-demos - OpenGL preview
• vulkan-tools - Vulkan preview
• vkBasalt - Configure vkBasalt
• replay-sorcery - Instant replay solution
• git - Clone reshade repository
• qt5pas - Free Pascal Qt5 binding library updated by lazarus IDE

Installation

Distributions

Arch / Manjaro / Other Arch derivatives

goverlay-bin is in the AUR. You can install it using your favourite AUR helper. You can also grab the latest git code with goverlay-git. The repository chaotic-aur provides the binaries from the latest GIT code.

pamac install goverlay-bin

Fedora

To install goverlay, run the following command as root:

dnf install goverlay

Solus

To install goverlay, run the following command as root:

eopkg it goverlay

Debian

To install goverlay in debian sid, run the following command as root:

apt install goverlay

Ubuntu

To install goverlay in Ubuntu (20.04 and up) and derivatives use the PPA from Martin Wimpress. Run the following commands as root:

sudo add-apt-repository ppa:flexiondotorg/mangohud
sudo apt-get update
sudo apt-get install goverlay

Tarball

1. Download the latest tarball from Releases.

2. Extract the file by running the following command:

tar -zxvf goverlay*.tar.gz

3. Execute the binary by running the following command:

./goverlay

Source

Prerequisites

Before building, you will need to install the following:

• Lazarus - IDE

Building

To build GOverlay, clone the git repository by running following command:

git clone https://github.com/benjamimgois/goverlay.git

Then, change directory and build GOverlay by running the following commands:

cd goverlay
make

Running

To run GOverlay, run the following command:

./goverlay

If running the new QT5 interface, force the default QT style with:

./goverlay --style fusion

Wayland

QT5PAS still isn't compatible with wayland display server, but you can run the application by forcing the x11 backend. Credits by Darklink999999

QT_QPA_PLATFORM=xcb goverlay --style fusion

Credits

Mango

Most of the credits go to Flightless Mango. He is the man and the mind behind MangoHud.

https://flightlessmango.com/

https://github.com/flightlessmango/MangoHud

https://discordapp.com/invite/Gj5YmBb

DadSchoorse

Special thanks to DadSchoorse, creator of the vkBasalt project.

https://github.com/DadSchoorse/vkBasalt

matanui159

Special thanks to matanui159, creator of the ReplaySorcery project.

https://github.com/matanui159/ReplaySorcery

Lazarus

This project was built using Lazarus.

Donations

If this project was useful to you, don't hesitate to donate to me :)