benjamimgois/goverlay

This is stars and forks stats for /benjamimgois/goverlay repository. As of 18 Apr, 2024 this repository has 311 stars and 35 forks.

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 OpenSUSE 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 breeze - Breeze Qt theme 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 OpenSUSE Tumbleweed To install goverlay, run the following command as root: zypper install goverlay Leap 15.2 To install goverlay from the games:tools repo, run the following commands as root: zypper addrepo https://download.opensuse.org/repositories/games:tools/openSUSE_Leap_15.2/games:tools.repo zypper refresh zypper 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, run the following commands: sudo apt-get update sudo apt-get install goverlay To avoid a issue with libdl.so on ubuntu based distros it's recomended to build Mangohud from source. https://github.com/flightlessmango/MangoHud Tarball Download the latest tarball from Releases. Extract the file by running the following command: tar -zxvf goverlay*.tar.gz Properly execute the binary by running the script inside the tar file: ./start_goverlay.sh Note: Since version 0.6.4 mangohud needs to be installed to run 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 Start GOverlay with: ./start_goverlay.sh Note: Since version 0.6.4 mangohud needs to be installed to run GOverlay. Installing To install GOverlay execute: make install This will install the start script to /usr/local/bin/goverlay, so that it can be launched via goverlay in the console. Theme compatibility Since GOverlay 0.9 the official supported themes are Breeze (plasma) and Adwaita (Gnome). If you run into issues with your current one you can force goverlay to run with a specific theme: goverlay --style breeze or 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 :)