diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 8 insertions, 4 deletions
@@ -7,10 +7,10 @@ Note: This software is still in early alpha. Expect bugs, and please report any You can report an issue by emailing the issue to dec05eba@protonmail.com. # Usage -Run `gsr-ui` and press `Alt+Z` to show/hide the UI. You can start the overlay UI at system startup by running `systemctl enable --now --user gpu-screen-recorder-ui`. +Run `gsr-ui` and press `Left Alt+Z` to show/hide the UI. You can start the overlay UI at system startup by running `systemctl enable --now --user gpu-screen-recorder-ui`. There is also an option in the settings to enable/disable starting the program on system startup. This option only works on systems that use systemd. You have to manually add `gsr-ui` to system startup on systems that uses another init system.\ -Note that at the moment different keyboard layouts are not supported. The physical layout of keys are used for global hotkeys. If your Z and Y keys are swapped for example then you need to press Alt+Y instead of Alt+Z to open/hide the UI. +A program called `gsr-ui-cli` is also installed when installing this software. This can be used to remotely control the UI. Run `gsr-ui-cli --help` to list the available commands. # Installation If you are using an Arch Linux based distro then you can find gpu screen recorder ui on aur under the name gpu-screen-recorder-ui (`yay -S gpu-screen-recorder-ui`).\ @@ -24,6 +24,7 @@ GPU Screen Recorder UI uses meson build system so you need to install `meson` to These are the dependencies needed to build GPU Screen Recorder UI: * x11 (libx11, libxrandr, libxrender, libxcomposite, libxfixes, libxi) +* libxcursor * libglvnd (which provides libgl, libglx and libegl) * linux-api-headers @@ -33,6 +34,10 @@ There are also additional dependencies needed at runtime: * [GPU Screen Recorder](https://git.dec05eba.com/gpu-screen-recorder/) * [GPU Screen Recorder Notification](https://git.dec05eba.com/gpu-screen-recorder-notification/) +## Program behavior notes +This program has to grab all keyboards and create a virtual keyboard (`gsr-ui virtual keyboard`) to make global hotkeys work on all Wayland compositors. +This might cause issues for you if you use input remapping software. To workaround this you can go into settings and select "Only grab virtual devices" + # License This software is licensed under GPL3.0-only. Files under `fonts/` directory belong to the Noto Sans Google fonts project and they are licensed under `SIL Open Font License`. @@ -49,6 +54,5 @@ If you want to donate you can donate via bitcoin or monero. * Monero: 4An9kp2qW1C9Gah7ewv4JzcNFQ5TAX7ineGCqXWK6vQnhsGGcRpNgcn8r9EC3tMcgY7vqCKs3nSRXhejMHBaGvFdN2egYet # Known issues -* Some games receive mouse input while the UI is open * When the UI is open the wallpaper is shown instead of the game on Hyprland and Sway. This is an issue with Hyprland and Sway. It cant be fixed until the UI is redesigned to not be a fullscreen overlay. -* Different keyboard layouts are not supported at the moment. The physical layout of keys are used for global hotkeys. If your Z and Y keys are swapped for example then you need to press Alt+Y instead of Alt+Z to open/hide the UI.
\ No newline at end of file +* Opening the UI when a game is fullscreened can mess up the game window a bit on Hyprland and Sway. I believe this is an issue in Hyprland and Sway.
\ No newline at end of file |