Record your screen, ship a demo. Free and open-source, GPU-accelerated, no watermarks, no subscriptions. Windows, macOS, Linux. Actively maintained.
TypeScript cross-platformelectronffmpegopen-sourceproduct-demorustscreen-capturescreen-recorderscreen-recordingscreen-studioscreencastspeech-to-texttypescriptvideo-editingvideo-editorwaylandwgpuwhisper
docs: recommend the udev rule wherever Wayland clicks are mentioned
EtienneLescot9b86b81ae52d
diff --git a/README.md b/README.mdindex 69f1893ac..2d0eb0b8b 100644--- a/README.md+++ b/README.md@@ -176,7 +176,7 @@ You may need to grant screen recording permissions depending on your desktop envEverything in the editor and export is the same on macOS, Windows, and Linux: zooms, backgrounds, motion blur, crop/trim/speed, blur regions, annotations, auto-captions, AI editing, projects, export, and all languages. All three now record through a native capture pipeline; the remaining differences are narrower than they used to be:- **Native recording**: macOS (ScreenCaptureKit), Windows (Windows Graphics Capture), and Linux (PipeWire via the ScreenCast portal) all record through a native pipeline for higher quality and clean window-level capture. On Linux the browser pipeline stays as an automatic fallback if the helper isn't available.-- **Custom cursors**: on macOS and Windows the real cursor is captured with shape, type, and clicks. Linux captures position and cursor shape through the portal, so the editable cursor overlay works there too. Click effects work on Linux as well, but not through the portal — Wayland exposes no portal for mouse buttons, so the capture helper reads the left button from evdev, which needs your user in the `input` group. Without that, recording is unaffected and every cursor sample is simply a move.+- **Custom cursors**: on macOS and Windows the real cursor is captured with shape, type, and clicks. Linux captures position and cursor shape through the portal, so the editable cursor overlay works there too. Click effects work on Linux as well, but not through the portal — Wayland exposes no portal for mouse buttons, so the capture helper reads the left button from evdev, which needs read access to your mouse: a udev rule for pointer devices (recommended) or the `input` group, set up as [Mouse clicks on Wayland](https://getopenscreen.com/docs/installation#mouse-clicks-on-wayland) shows. Without that, recording is unaffected and every cursor sample is simply a move.- **Webcam**: every platform saves the webcam as a separate file next to the screen recording. Windows captures it natively in the recording helper; macOS and Linux record it in the app. It works as a picture-in-picture overlay on all three.- **System audio** support varies by OS:- **macOS**: works on every supported version. On macOS 14.2+ you'll be prompted to grant audio capture permission.diff --git a/electron/native/README.md b/electron/native/README.mdindex 1d94526c7..ff701edc6 100644--- a/electron/native/README.md+++ b/electron/native/README.md@@ -227,14 +227,16 @@ electron/native/bin/linux-x64/openscreen-pipewire-helper '{"probeOnly":true}'### Known gaps-- **Mouse clicks need the `input` group.** Wayland exposes no portal for input+- **Mouse clicks need read access to evdev.** Wayland exposes no portal for inputevents, so the helper reads left-button presses straight from evdev- (`/dev/input/event*`). Those nodes are `root:input`, so a user outside the+ (`/dev/input/event*`). Those nodes are `root:input`, so a user with neither a+ udev `uaccess` rule for pointer devices (recommended) nor membership in the`input` group gets no readable device and every sample's `interactionType`stays `"move"` — the same as before. When a device is readable, the coincidingsample is tagged `"click"`. Scope is deliberately narrow: `BTN_LEFT` only,never keystrokes (see `pipewire-capture/src/input.rs`), and- `OPENSCREEN_DISABLE_CLICK_CAPTURE=1` turns it off entirely.+ `OPENSCREEN_DISABLE_CLICK_CAPTURE=1` turns it off entirely. User setup:+ [Mouse clicks on Wayland](../../website/docs/installation.md#mouse-clicks-on-wayland).- **The user picks a source twice.** Electron's `desktopCapturer` raises its ownportal dialog for the video, and this helper raises a second one for the cursor.Collapsing them requires one portal session serving both, which is why thediff --git a/website/docs/guides/product-demo-video.md b/website/docs/guides/product-demo-video.mdindex e93539132..67cc2b38f 100644--- a/website/docs/guides/product-demo-video.md+++ b/website/docs/guides/product-demo-video.md@@ -35,7 +35,7 @@ On Windows, OpenScreen keeps the HUD and the Notes window out of the capture. On1. On Windows and macOS, open the source picker and choose a display under **Screens** or a single window under **Windows**. On macOS 15.2 and later, you choose the display or window in Apple's system picker instead. On Linux there is no in-app picker: the system portal asks for the source on every take. OpenScreen has no region capture, so record the window or the screen, then crop the clip in the editor.2. Turn on the microphone and check its level meter. Turn on system audio if the product makes sound, and the webcam if you want to appear on screen.-3. Keep the editable cursor mode, the default: the pointer is recorded as data, so you can restyle it later. Clicks are recorded on Windows. On macOS they need the Accessibility permission. On Linux your user must be in the `input` group, and touchpad tap-to-click is not captured ([details](../installation.md#mouse-clicks-on-wayland)).+3. Keep the editable cursor mode, the default: the pointer is recorded as data, so you can restyle it later. Clicks are recorded on Windows. On macOS they need the Accessibility permission. On Linux your user needs read access to the mouse, through a udev rule (recommended) or the `input` group, and touchpad tap-to-click is not captured ([details](../installation.md#mouse-clicks-on-wayland)).4. Press record. A 3-2-1 countdown runs first and cannot be turned off.OpenScreen captures at a 60 fps target, up to 3840×2160 on Windows and macOS. On Linux the size is whatever the compositor hands over. While recording you can pause, restart the take, cancel it, or stop.diff --git a/website/docs/recording.md b/website/docs/recording.mdindex 8369a7ab9..c74d8bb88 100644--- a/website/docs/recording.md+++ b/website/docs/recording.md@@ -50,7 +50,7 @@ On Windows, macOS, and Linux, a cursor-mode toggle switches between:What the editable overlay captures depends on the platform:- **Windows** — the real cursor shape and clicks.- **macOS** — the cursor shape and clicks, which need the Accessibility permission. In this mode, pressing record without it opens the permissions window instead of starting (see [macOS installation](./installation.md#macos)).-- **Linux** — position and shape through the ScreenCast portal, plus left clicks when your user is in the `input` group (see [Mouse clicks on Wayland](./installation.md#mouse-clicks-on-wayland)).+- **Linux** — position and shape through the ScreenCast portal, plus left clicks when your user can read the mouse, through a udev rule (recommended) or the `input` group (see [Mouse clicks on Wayland](./installation.md#mouse-clicks-on-wayland)).A Linux take that falls back to [browser capture](#native-vs-browser-capture) records the system cursor, whichever mode you picked.diff --git a/website/src/pages/alternatives/loom.mdx b/website/src/pages/alternatives/loom.mdxindex 65fffac19..7eaaaa78d 100644--- a/website/src/pages/alternatives/loom.mdx+++ b/website/src/pages/alternatives/loom.mdx@@ -76,7 +76,7 @@ Loom's plan details in this section are as of September 2026.## Getting started1. Download OpenScreen from the [download page](/download/). On Linux, pick the AppImage, `.deb`, `.rpm` or `.pacman`, or use the Nix flake.-2. Follow [Installation](/docs/installation/). On macOS, grant permissions from the window that opens on first launch. On Linux, recording needs PipeWire and `xdg-desktop-portal`, and [mouse clicks on Wayland](/docs/installation/#mouse-clicks-on-wayland) need your user in the `input` group.+2. Follow [Installation](/docs/installation/). On macOS, grant permissions from the window that opens on first launch. On Linux, recording needs PipeWire and `xdg-desktop-portal`, and [mouse clicks on Wayland](/docs/installation/#mouse-clicks-on-wayland) need read access to the mouse, through a udev rule (recommended) or the `input` group.3. Make a first recording with the [quick start](/docs/quick-start/), then export it as an MP4 and share the file wherever your team already works.Comparing other tools as well? See the [Screen Studio alternative](/alternatives/screen-studio/), [OpenScreen vs Cap](/compare/openscreen-vs-cap/), [OpenScreen vs OBS Studio](/compare/openscreen-vs-obs/) and the [Camtasia alternative](/alternatives/camtasia/), or go back to the [OpenScreen home page](/).diff --git a/website/src/pages/features/auto-zoom.mdx b/website/src/pages/features/auto-zoom.mdxindex c1375e9ab..81529f860 100644--- a/website/src/pages/features/auto-zoom.mdx+++ b/website/src/pages/features/auto-zoom.mdx@@ -54,7 +54,7 @@ A few details matter in practice:- **The results are ordinary zooms.** Click one to change its depth, 3D camera or focus, drag its edges to move its start and end, or delete it.- **It runs after every take.** Each new recording gets its zooms as it opens in the editor. To stop it, turn off **Auto-zoom after recording** in the editor's **Record** mode. To run it on demand, choose **Automatic zooms** in the editor, or pass `--auto-zoom` on the command line.- **It tells you when nothing qualifies.** The editor reports that no auto-zoom moments were found.-- **It works from recorded clicks.** Clicks are recorded on Windows. On macOS they need the Accessibility permission, and on Linux your user must be in the `input` group.+- **It works from recorded clicks.** Clicks are recorded on Windows. On macOS they need the Accessibility permission, and on Linux your user needs read access to the mouse, through a udev rule (recommended) or the `input` group ([Mouse clicks on Wayland](/docs/installation/#mouse-clicks-on-wayland)).- **Pointing is not clicking.** A pointer held still while you talk over something gets no zoom. Add one by hand with `Z`.The same menu has a second item, **Smart cuts**, marked *With AI*. It is a different feature: it asks the optional chat agent to cut dead time. It waits for the recording's transcript, and it only works once you connect an AI provider with your own key. See [AI editing](/docs/ai-editing/).@@ -78,7 +78,7 @@ A manual zoom with a manual focus needs no cursor data, so it also works on a viThe same recorded movement drives the cursor in the export. The Cursor facet shows or hides it and sets its size, smoothing, motion blur, click bounce and click impact. The cursor path is smoothed the same way for the preview and the export, so the preview matches the file.-Click bounce needs recorded clicks. On macOS that takes the Accessibility permission, and on Linux your user must be in the `input` group. [Recording](/docs/recording/) lists what each platform captures.+Click bounce needs recorded clicks. On macOS that takes the Accessibility permission, and on Linux read access to the mouse, through a udev rule or the `input` group. [Recording](/docs/recording/) lists what each platform captures.<DemoLoop name="3d-cursors" />diff --git a/website/src/pages/screen-recorder-linux.mdx b/website/src/pages/screen-recorder-linux.mdxindex e964698a7..389331cd1 100644--- a/website/src/pages/screen-recorder-linux.mdx+++ b/website/src/pages/screen-recorder-linux.mdx@@ -25,7 +25,7 @@ This page is published by the OpenScreen project. The Screen Studio and OBS Stud| Capture | PipeWire through the ScreenCast portal, at a 60 fps target. The size is whatever the compositor hands over || Encoding while recording | H.264 through VAAPI, then Vulkan, then software || System audio | The PipeWire sink monitor, mixed with the microphone |-| Cursor | Position and shape from the portal. Left clicks with the `input` group |+| Cursor | Position and shape from the portal. Left clicks with a udev rule or the `input` group || Captions | Local Whisper on Vulkan, with a CPU fallback. Burned into the video || Export | MP4 (H.264) or GIF, no watermark. H.264 on the GPU through VAAPI when the driver allows it || Built-in updates | AppImage, `.deb`, `.rpm` and `.pacman`. Not Nix |@@ -39,7 +39,7 @@ OpenScreen records the screen on Linux with its own native helper, not with the- **System audio from PipeWire.** It comes from the monitor of the default PipeWire sink and is mixed with the microphone into one AAC track. It needs PipeWire as the sound server, the default on Ubuntu 22.10 and later and Fedora 34 and later.- **Microphone choice.** The HUD lists every input device, with a live level meter. The helper finds the matching PipeWire node by its description.- **An editable cursor.** In the default overlay mode, the portal reports the cursor position and shape, so you can restyle the cursor in the editor. System mode records the pointer as it is.-- **Clicks on Wayland.** Wayland has no portal for input events, so OpenScreen reads left-button presses from evdev. That works when your user is in the `input` group, and OpenScreen reads only the left button, never keystrokes. The group itself is broader: it lets every program you run read every input device, keyboard included. Without the group, recording still works and every cursor sample is saved as a move. [Mouse clicks on Wayland](/docs/installation/#mouse-clicks-on-wayland) has the command.+- **Clicks on Wayland.** Wayland has no portal for input events, so OpenScreen reads left-button presses from evdev. That works when your user can read the mouse, and OpenScreen uses only left-button presses and ignores every other event, so keystrokes are never recorded. The recommended way is a udev rule that gives your desktop session access to mice and touchpads, keyboards excluded. The `input` group also works but is broader: it lets every program you run read every input device, keyboard included. Without either, recording still works and every cursor sample is saved as a move. [Mouse clicks on Wayland](/docs/installation/#mouse-clicks-on-wayland) has the commands.- **Browser capture only as a fallback.** Chromium's capture takes over only in a build that is missing the helper. A helper that fails reports an error instead of switching. See [Recording](/docs/recording/).## Screen Studio-style polish on Linux@@ -47,7 +47,7 @@ OpenScreen records the screen on Linux with its own native helper, not with theScreen Studio supports only macOS (as of September 2026). OpenScreen offers the same kind of finishing on Linux, and its editing tools are the same on Windows, macOS and Linux.- **Automatic zooms.** **Auto-enhance → Automatic zooms** places zooms on the recorded clicks, with no network call and no model. Manual zooms have six depths. More on [auto-zoom](/features/auto-zoom/).-- **Cursor styling.** Show or hide the cursor, resize and smooth it, and add motion blur and a click bounce. Click effects need recorded clicks, so the `input` group again.+- **Cursor styling.** Show or hide the cursor, resize and smooth it, and add motion blur and a click bounce. Click effects need recorded clicks, so the same udev rule or `input` group.- **Backgrounds and framing.** 18 bundled wallpapers, a solid color, a gradient or your own image, with padding, rounded corners and a shadow. Output in 16:9, 9:16, 1:1 and other aspect ratios.- **Local captions.** whisper.cpp runs on your machine, on Vulkan with a CPU fallback. It uses one Whisper Small model of about 264 MB, downloaded once. Captions are burned into the video, and deleting words in the transcript cuts them from the video. More on [captions](/features/captions/).- **Webcam layouts.** Picture-in-picture and other layouts, with the camera background removed, blurred or replaced without a green screen.@@ -71,7 +71,7 @@ Screen Studio supports only macOS (as of September 2026). OpenScreen offers the## Getting started1. Download the package for your distribution from the [download page](/download/), or use the Nix flake.-2. Follow the [Linux installation steps](/docs/installation/#linux). Add your user to the `input` group if you want clicks recorded and accept what that group allows.+2. Follow the [Linux installation steps](/docs/installation/#linux). If you want clicks recorded, set up the udev rule or the `input` group from [Mouse clicks on Wayland](/docs/installation/#mouse-clicks-on-wayland).3. Make a first recording with the [quick start](/docs/quick-start/) and answer the portal dialog when it opens. The take opens in the editor with automatic zooms already placed.On another system? See the [Windows](/screen-recorder-windows/) and [macOS](/screen-recorder-mac/) pages. Coming from a Mac app? See the [Screen Studio alternative](/alternatives/screen-studio/). Or go back to the [OpenScreen home page](/).