Skip to content

Recommend GPU Screen Recorder instead of SimpleScreenRecorder for recording on Linux #10937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

v1993
Copy link

@v1993 v1993 commented May 9, 2025

Switch to recommending GPU Screen Recorder instead of SimpleScreenRecorder for recording for Linux. It's a newer project that offers the following features over SSR:

  1. Full Wayland support, including Wayland hotkeys. X11 is supported as well.
  2. Very efficient utilization of GPU encoding across all GPU vendors, even better than OBS Studio
  3. Not quite relevant for Godot at the moment, but HDR recording support
  4. Importantly for end users, it's available as a Flatpak, meaning it's easy to install on about every distro out there

Other than that, GPU Screen Recorder is just generally the go-to solution for screen recording on Linux these days due to being both efficient and easy to use, so it makes sense to recommend it.

@Calinou
Copy link
Member

Calinou commented May 14, 2025

GPU Screen Recorder worked poorly when I tried it on KDE + X11 last year (despite having a top-end system, i.e. 13900K + RTX 4090). It dropped to very low framerates when trying to record a 4K60 video, yet I can do that just fine with SimpleScreenRecorder (in software H.264 no less).

I think it's fine to add a mention of GPU Screen Recorder (even list it first if you want), but I would keep a mention of SimpleScreenRecorder.

@Calinou Calinou added enhancement area:contributing Issues and PRs related to the Contributing/Development section of the documentation labels May 14, 2025
@@ -31,7 +31,7 @@ If you need to encode to a different format or pipe a stream through third-party

\ **Editor usage:** A default movie file path can be specified in :ref:`ProjectSettings.editor/movie_writer/movie_file<class_ProjectSettings_property_editor/movie_writer/movie_file>`. Alternatively, for running single scenes, a ``movie_file`` metadata can be added to the root node, specifying the path to a movie file that will be used when recording that scene. Once a path is set, click the video reel icon in the top-right corner of the editor to enable Movie Maker mode, then run any scene as usual. The engine will start recording as soon as the splash screen is finished, and it will only stop recording when the engine quits. Click the video reel icon again to disable Movie Maker mode. Note that toggling Movie Maker mode does not affect project instances that are already running.

\ **Note:** MovieWriter is available for use in both the editor and exported projects, but it is *not* designed for use by end users to record videos while playing. Players wishing to record gameplay videos should install tools such as `OBS Studio <https://obsproject.com/>`__ or `SimpleScreenRecorder <https://www.maartenbaert.be/simplescreenrecorder/>`__ instead.
\ **Note:** MovieWriter is available for use in both the editor and exported projects, but it is *not* designed for use by end users to record videos while playing. Players wishing to record gameplay videos should install tools such as `OBS Studio <https://obsproject.com/>`__ or `GPU Screen Recorder <https://git.dec05eba.com/gpu-screen-recorder/about/>`__ instead.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Files in classes/ should not be edited manually, as they are automatically generated. Instead, you should open a pull request on the main Godot repository: https://github.com/godotengine/godot/blob/master/doc/classes/MovieWriter.xml

Copy link
Contributor

@skyace65 skyace65 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm in agreement with Calinou. Adding GPU Screen Recorder is fine but I don't see a reason to remove SimpleScreenRecorder

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:contributing Issues and PRs related to the Contributing/Development section of the documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants