Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nowrep/imgoverlay
Vulkan/OpenGL overlay renderer
https://github.com/nowrep/imgoverlay
opengl overlay vulkan
Last synced: 30 days ago
JSON representation
Vulkan/OpenGL overlay renderer
- Host: GitHub
- URL: https://github.com/nowrep/imgoverlay
- Owner: nowrep
- License: mit
- Created: 2020-09-04T09:04:41.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-08-21T11:09:59.000Z (about 1 year ago)
- Last Synced: 2024-08-01T13:25:38.645Z (3 months ago)
- Topics: opengl, overlay, vulkan
- Language: C++
- Homepage:
- Size: 40.6 MB
- Stars: 17
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Imgoverlay
Vulkan/OpenGL overlay renderer (shared memory or texture).
Included QtWebEngine client allows to use any web page as overlay.
Started as [MangoHud](https://github.com/flightlessmango/MangoHud) fork.
## Building
#### Dependencies
* glslangValidator
* python3
* Xlib
* Qt - Core, Network, Widgets, WebEngineWidgets, QuickWidgets
* EGL
#### Build
```sh
meson build
meson install
```
ArchLinux: [PKGBUILD](dist/PKGBUILD)
# Usage
## Run Vulkan/OpenGL app
```sh
# Vulkan
IMGOVERLAY=1 /path/to/app
# OpenGL
imgoverlay /path/to/app
```
#### Configuration (app)
* `IMGOVERLAY_CONFIGFILE` env variable
* `~/.config/imgoverlay/.conf` (eg. `~/.config/imgoverlay/vkcube.conf`)
* `~/.config/imgoverlay/imgoverlay.conf`
```ini
socket=/tmp/imgoverlay.socket
toggle_overlay=Shift_R+F12
```
## Run client
```sh
imgoverlayclient [--tray] [config-file]
```
* `--tray` start minimized in system tray
* `--shm` use shared memory instead of DMA-BUF (required for GLX currently)
* `--disable-gpu` disable QtWebEngine GPU rendering
* `config-file` path to config file (default `~/.config/imgoverlayclient.conf`)
#### Configuration (client)
```ini
[General]
Socket=/tmp/imgoverlay.socket
Cache=cache
[Github_example]
Url=https://github.com/nowrep/imgoverlay
X=0
Y=0
Width=200
Height=200
InjectScript=script.js
[Another_site]
Url=https://google.com
X=210
Y=210
Width=100
Height=100
```