wfrc

English | 中文

A simple bash script to make screen recording with shortcuts easy. Since it uses wf-recorder or wl-screenrec as the backend, it works on niri, Hyprland and wlroots-based Wayland compositors.

Since 0.1.2, wl-screenrec can be used as backend. If you want to use it please set WFRC_RECORDER=wl-screenrec

wfrc-2025-08-21T22-14-34.mp4

Features

• Customization with environment variables
• Area selection for recording
• Audio recording
• Notifications
• Automatic clipboard copy

Install

now in AUR, wfrc-git

Dependencies

• wf-recorder (or wl-screenrec)
• bash
• grep
• slurp
• libnotify
• libpulse
• wl-clipboard

Usage

• (optional) Add it to your PATH.
• (optional) Bind it to a key.
• The first time you run it, it will launch slurp to select a recording area. Running it again will stop recording and copy the video to your clipboard.

Config

This script's behavior is controlled by environment variables. You can create a script to set them.

# Use wf-recorder as the default recorder
#WFRC_RECORDER="${WFRC_RECORDER:-wf-recorder}"
# By default it can control where the file will be stored
#WFRC_FOLDER="/tmp/wfrc-$UID"
# By default it can control the title of the notification and the filename
#SCRIPT_NAME="wfrc"
# Where the lock file resides
#WFRC_LOCK="$WFRC_FOLDER/WFRCLOCK"
# Set the icon of notification
#WFRC_ICON="record"
# 1 to enable full screen
#WFRC_FULL_SCREEN=0
# 0 to disable notification
#WFRC_NOTIFY=1
# Your audio device
#WFRC_AUDIO_DEV="$(LANG=C pactl get-default-sink).monitor"
#WFRC_FILE_NAME="$WFRC_FOLDER/$SCRIPT_NAME-$(date +%Y-%m-%dT%H-%M-%S).mp4"
# The error message displayed if Wayland is not detected
#WFRC_NOWAYLAND="No WAYLAND_DISPLAY found. Did you run me on a wayland compositor?"

. /path/to/wfrc "$@"

TODO

Troubleshooting

1. The video has no audio

Check this:

LANG=C pactl list sources | grep 'Name.*output'

If the output is multiline, it means you have more than one audio output device. Use the config script and change WFRC_AUDIO_DEV to your device.

2. High CPU usage

It's caused by wf-recorder. If the issue can be resolved by adjusting some command-line options for wf-recorder, please add those options directly to the script, and they will be passed directly to wf-recorder.

or use wl-screenrec as backend.

See here:

To use GPU encoding, use a VAAPI codec (for ex. h264_vaapi) and specify a GPU device to use with the -d option: wf-recorder -f test-vaapi.mkv -c h264_vaapi -d /dev/dri/renderD128 ...

For me, just use

wfrc -c h264_vaapi -d /dev/dri/renderD128