aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorMaria Lisina <sekoohaka.sarisan@gmail.com>2026-08-20 16:43:35 +0500
committerMaria Lisina <sekoohaka.sarisan@gmail.com>2026-08-20 16:43:35 +0500
commit710c57ef7cc39c6173137fda60dd49e85734b5ce (patch)
tree9c1fc103c95c2a632323027b31b5218b3ab0cd16 /README.md
parent47bb6235a4c9f5c8632f9a85d2ad2470254d8f7f (diff)
parent8c33f61c75af723f55c2c235d6807686579fe157 (diff)
Merge tag '6.0.1' of https://repo.dec05eba.com/gpu-screen-recorder into debian
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index 56cd972..d8dc8d5 100644
--- a/README.md
+++ b/README.md
@@ -31,8 +31,9 @@ This software works on X11 and Wayland on AMD, Intel and NVIDIA.
# Installation
If you are running an Arch Linux based distro then you can find gpu screen recorder in the official repositories under the name gpu-screen-recorder (`sudo pacman -S gpu-screen-recorder`).\
If you are running another distro then you can run `sudo ./install.sh`, but you need to manually install the dependencies, as described below.\
-You can also install gpu screen recorder ([the ui version](https://git.dec05eba.com/gpu-screen-recorder-gtk/)) from [flathub](https://flathub.org/apps/details/com.dec05eba.gpu_screen_recorder), which is the easiest method
-to install GPU Screen Recorder on non-arch based distros.\
+When you run `install.sh` it will build FFmpeg from source, which can take a while. You can build GPU Screen Recorder from source without building FFmpeg if you setup the meson project with the `-Dffmpeg_static=false` option, for example: `meson setup --buildtype=release -Dffmpeg_static=false -Dstrip=true build`.\
+You can also install GPU Screen Recorder from [flathub](https://flathub.org/apps/details/com.dec05eba.gpu_screen_recorder), which is the easiest method
+to install GPU Screen Recorder on non-arch based distros (it includes both this cli and the [UI version](https://git.dec05eba.com/gpu-screen-recorder-ui/about/)).\
You can alternatively install GPU Screen Recorder from one of the unofficial sources mentioned below.\
If you install GPU Screen Recorder flatpak, which is the ui version then you can still run GPU Screen Recorder command line by using the flatpak command option, for example `flatpak run --command=gpu-screen-recorder com.dec05eba.gpu_screen_recorder -w screen -f 60 -o video.mp4`. Note that if you want to record your monitor on AMD/Intel then you need to install the flatpak system-wide (like so: `flatpak install --system com.dec05eba.gpu_screen_recorder`).
@@ -59,7 +60,7 @@ These are the dependencies needed to build GPU Screen Recorder:
* x11 (libx11, libxcomposite, libxrandr, libxfixes, libxdamage)
* wayland (wayland-client, wayland-egl, wayland-scanner)
-* ffmpeg (libavcodec, libavformat, libavutil, libswresample, libavfilter)
+* ffmpeg (libavcodec, libavformat, libavutil, libswresample, libavfilter) - Only needed if you build GPU Screen Recorder with `-Dffmpeg_static=false` meson option
* libva (and libva-drm)
* libpulse
* libdrm
@@ -228,6 +229,7 @@ Note: this issue doesn't happen when you using the vulkan video encoding option
## TEMPORARY ISSUES
1) Videos are in variable framerate format. Use MPV to play such videos, otherwise you might experience stuttering in the video if you are using a buggy video player. You can try saving the video into a .mkv file instead as some software may have better support for .mkv files (such as kdenlive). You can use the "-fm cfr" option to to use constant framerate mode.
2) FLAC audio codec is disabled at the moment because of temporary issues.
+3) Capturing webcam doesn't work on nvidia x11 when capturing a monitor at the same time.
# Examples
Look at the [scripts](https://git.dec05eba.com/gpu-screen-recorder/tree/scripts) directory for script examples. For example if you want to automatically save a recording/replay into a folder with the same name as the game you are recording.
@@ -256,7 +258,7 @@ See [https://git.dec05eba.com/?p=about](https://git.dec05eba.com/?p=about).
Some linux distros (such as manjaro and fedora) disable hardware accelerated h264/hevc on AMD/Intel because of "patent license issues". If you are using an arch-based distro then you can install mesa-git instead of mesa and if you are using another distro then you may have to switch to a better distro. On fedora based distros you can follow this: [Hardware Accelerated Codec](https://rpmfusion.org/Howto/Multimedia).\
You can alternatively install the flatpak version of GPU Screen Recorder from [flathub](https://flathub.org/apps/details/com.dec05eba.gpu_screen_recorder) which doesn't have this issue on any distro.
## I have an old nvidia GPU that supports nvenc but I get a cuda error when trying to record
-Newer ffmpeg versions don't support older nvidia cards. Try installing GPU Screen Recorder flatpak from [flathub](https://flathub.org/apps/details/com.dec05eba.gpu_screen_recorder) instead. It comes with a custom version of ffmpeg to support older nvidia GPUs.
+Newer ffmpeg versions don't support older nvidia cards. Try installing GPU Screen Recorder flatpak from [flathub](https://flathub.org/apps/details/com.dec05eba.gpu_screen_recorder) instead or use the [AppImage](https://github.com/pkgforge-dev/gpu-screen-recorder-AppImage/releases), which uses a custom version of ffmpeg to support older nvidia gpus. Alternatively you can build GPU Screen Recorder from source, which builds ffmpeg from source with a patch to support older nvidia gpus.
## I get a black screen/glitches while live streaming
It seems like ffmpeg earlier than version 6.1 has some type of bug. Install ffmpeg version 6.1 or later and then reinstall GPU Screen Recorder to fix this issue. The flatpak version of GPU Screen Recorder comes with a newer version of ffmpeg so no extra steps are needed.
## I can't play the video in my browser directly or in discord
@@ -326,3 +328,5 @@ This is a hyprland bug. Capture the monitor directly with `-w monitor` or use an
This is a bug in COSMIC and Wlroots. Their desktop portals send frame updates at low framerates (such as 25 fps) instead of the selected framerate (such as 60 fps). Capture a monitor directly instead (`-w DP-1` for example) to workaround that problem.
## How to adjust the volume of the recorded audio?
GPU Screen Recorder doesn't have the option to do that yet, but you can change the volume by starting recording and then open `pavucontrol`, go to the `Recording` tab and set the volume there. The system will remember the settings even after reboot, as long as the audio capture options remain the same.
+## My game and recorded video is stuttering but my frame rate is high
+This is an issue with linux kernel graphics scheduling when the gpu usage is 99-100%. The only fix available at the moment is to run X11 with the compositor disabled. There is no known fix on Wayland at the moment. Hopefully this issue will be fixed in linux soon.