Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 2.48 KB

README.md

File metadata and controls

82 lines (53 loc) · 2.48 KB
Raw

Cute Sway Recorder

Screen recorder for wlroots-based compositors like Sway and Hyperland. For other compositors, it falls back to using wlr-randr to get outputs.

More specifically, this project is merely a graphical Qt wrapper for wf-recorder, leveraging slurp for selecting screen regions.

Installation

Do note that you will need to have wf-recorder and slurp accessible via $PATH =)

Using pip

pip install cute-sway-recorder

You might prefer using pipx:

pipx install cute-sway-recorder

Arch Linux

For Arch Linux users, you can install the cute-sway-recorder-git package from the AUR using an AUR helper like paru:

paru -S cute-sway-recorder-git

Configuration

Default configuration is stored in the file $HOME/.config/cute-sway-recorder/config.ini in ini format.

Here is an example configuration which saves recordings as gifs:

[wf-recorder-defaults]
# Default file save location (location must exist)
# Type: string, default: "~/Videos/cute-{id}.mp4"
file_dest = ~/Gifs/gif.gif

# Whether to include audio in recording
# Type: bool, default: off
include_audio = off

# Delay before recording starts 
# Type: integer, default: 0
delay = 0

# Additional flags to pass to wf-recorder
# Type: string, default: ""
flags = -c gif -r 10

Contributing

PRs are welcome!

  1. After forking this repository, make sure to install the project dependencies locally:
poetry install

This will create a virtual environment and install all the required dependencies.

  1. Make sure cute-sway-recorder runs locally:
poetry run python -m cute_sway_recorder.main

Alternatives

  • green-recorder is a recent fork of the project abandoned in 2019. It doesn't use wf-recorder under the hood. It currently has more features than this project; you might want to try it first, and come back here if it gives you a hard time.