Giter Club home page Giter Club logo

goverlay's Introduction

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

vCWK9.png vCkkz.png vCofK.png vCjt7.png

Prerequisites

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

Installation

Distributions

Arch / Manjaro / Other Arch derivatives

To install goverlay, run the following command as root:

pacman -S goverlay

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, you need to install libqt6pas that isn't provided by official repo, but you can grab it in https://github.com/davidbannon/libqt6pas

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
tar -zxvf goverlay*.tar.gz
./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

  1. Download the latest tarball from Releases.

  2. Extract the file by running the following command:

tar -zxvf goverlay*.tar.gz
  1. Properly execute the binary inside the tar file:
./goverlay

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:

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:

./goverlay

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

Lazarus

This project was built using Lazarus.

Laz-banner

Donations

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

paypal

goverlay's People

Contributors

benjamimgois avatar stephanlachnit avatar gloriouseggroll avatar kira-bruneau avatar antiz96 avatar jacekjagosz avatar lukashoracek avatar yochananmarqos avatar theevilskeleton avatar gamingdoom avatar thewyn avatar totalcaesar659 avatar akien-mga avatar rotartsi82 avatar noxphasma avatar newbytee avatar jokergermany avatar ishchow avatar duckbuster avatar catericka avatar tim77 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.