Recordly README

The project's README from github.com/webadderallorg/Recordly. As one markdown file: README.md.

Language: EN | 简中

Recordly Logo

macOS Windows Linux AGPL 3.0 license

Create polished demo videos in minutes

Recordly is your open-source screen recorder and editor for walkthroughs, demos, product videos, and more. Accepting PRs.

MP4 to GIF export (4)

Backed by the community

CodeRabbit Typemark


What is Recordly?

Recordly is a desktop app for recording and editing screen captures with motion-driven presentation tools built in. Instead of sending raw footage to a motion designer just to add zooms, cursor polish, or a styled background, Recordly handles that workflow in one place for free.

Recordly runs on:

Platform notes:


Core Features

Auto-zooms, cursor polish, and styled frames

Recordly can automatically emphasize activity with zoom suggestions, smooth cursor movement, add motion effects, and place the final composition inside a styled frame with wallpapers, colors, gradients, blur, padding, and shadows.

Recordly cursor and zoom demo video

Dynamic webcam bubble overlays

Add webcam footage as an overlay bubble, position it with presets or custom coordinates, mirror it, control shadow and roundness, and optionally make it react to zoom so it stays visually balanced during motion.

Recordly webcam overlay demo video

Timeline editing built for demos

Use drag-and-drop timeline tools for zooms, trims, speed regions, annotations, extra audio regions, and crop-aware edits. Save and reopen work as .recordly project files.

timeline editor

Extensions & Marketplace

Recordly has a community-driven extension system. Anyone can build and publish extensions that add new capabilities to Recordly — cursor click sounds, device frames, browser mockups, wallpapers, render hooks, settings panels, and more.

Browse and install community extensions from the Recordly Marketplace.


All Features

Recording

Timeline and Editing

Cursor Controls

Webcam Overlay

Frame Styling and Backgrounds

Export

Workflow and Usability


Screenshots

Recordly recording interface screenshot

Recordly editor screenshot

Recordly timeline screenshot


Installation

Download a build

Prebuilt releases are available at:

https://github.com/webadderallorg/Recordly/releases


Arch Linux / Manjaro (yay)

Install from the AUR (recordly-bin):

yay -S recordly-bin

PKGBUILD, desktop entry, release sync, and optional local-from-source packaging live in recordly-aur so this repository stays free of Arch release chores. For maintainer contact and how the package is updated, see that repo or the AUR package page.


Build from source

Prerequisites

macOS: Xcode Command Line Tools (xcode-select --install).

Linux (Ubuntu/Debian):

sudo apt install build-essential cmake libx11-dev libxtst-dev libxrandr-dev libxt-dev

Windows: Visual Studio 2022 (or Build Tools) with the C++ workload and CMake.

Steps

git clone https://github.com/webadderallorg/Recordly.git recordly
cd recordly
npm install
npm run dev

For packaged builds:

npm run build

Target-specific build commands are also available:


macOS: "App cannot be opened"

Locally built apps may be quarantined by macOS.

Remove the quarantine flag with:

xattr -rd com.apple.quarantine /Applications/Recordly.app

System Requirements

Platform Minimum version Notes
macOS macOS 14.0 (Sonoma) Required for ScreenCaptureKit audio and microphone capture.
Windows Windows 10 20H1 (Build 19041, May 2020) Required for the native Windows Graphics Capture (WGC) helper and best cursor-hiding behavior.
Linux Any modern distro Recording works through Electron capture. System audio generally requires PipeWire.

[!IMPORTANT] On Windows builds older than 19041, recording can still work through fallback capture, but the real OS cursor may remain visible in recordings.


Usage

Record

  1. Launch Recordly.
  2. Select a screen or window.
  3. Choose microphone and system-audio options.
  4. Start recording.
  5. Stop recording to open the editor.

Edit

Inside the editor you can:

Save your work anytime as a .recordly project.

Export

Export options include:

You can adjust format-specific settings such as quality, GIF frame rate, GIF looping, and output size before export.


Limitations

Cursor capture

Recordly renders a polished cursor overlay on top of the recording. Platform cursor-hiding behavior still depends on OS support.

macOS

Windows

Linux

System audio

System audio support varies by platform.

Windows

Linux

macOS


How It Works

Recordly combines a platform-specific capture layer with a renderer-driven editor and export pipeline.

Capture

Editing

Rendering

Export

Projects


Contribution

Contributions are welcome.

Areas where help is especially useful:

Please keep pull requests focused, test recording/edit/export flows, and avoid unrelated refactors.

See CONTRIBUTING.md for guidelines.


Community

Bug reports and feature requests:

https://github.com/webadderallorg/Recordly/issues

Pull requests are welcome.


Hall of Supporters

Ko-Fi


License

Recordly is licensed under the AGPL 3.0.


Credits

Acknowledgements

Recordly originally started as a fork of OpenScreen. Over 80% of code has diverged since. Many features of OpenScreen such as its zoom animations are directly ported from early versions of Recordly.

Created by
@webadderall


Recordly (webadderallorg/Recordly)

Searching Database…

34.6K ·GitHub
What is this?Recordly is an open-source desktop app for recording and editing screen captures with motion-driven presentation tools built in — auto-zooms, cursor polish, and styled frames — made for walkthroughs, demos, and product videos.
So it's an app I install on my computer, not a website?Exactly — a desktop app built on Electron with platform-specific capture helpers. It runs on macOS 14.0+, Windows 10 Build 19041+, and modern Linux distros.
How do I get it on my machine?Download a prebuilt release from GitHub, or on Arch Linux/Manjaro install recordly-bin from the AUR. You can also build from source with npm (npm run build:mac, build:win, or build:linux).
Does my OS need anything specific for recording to work well?Yes: macOS needs 14.0+ for ScreenCaptureKit audio capture, Windows wants Build 19041+ for the native Windows Graphics Capture helper, and Linux system audio usually requires PipeWire.
Will my real mouse cursor stay hidden in the recording?It depends on the OS: macOS excludes it cleanly via ScreenCaptureKit, Windows needs 19041+ and the native helper, and on Linux cursor hiding is not supported at all — exports can show both the real cursor and Recordly's styled overlay.
Is it really free, and is there a catch in the license?It's free, but licensed under AGPL 3.0 — a strong copyleft license: if you modify it and offer it as a service, you must release your source changes under the same terms.
What does it do to make videos look polished on its own?It suggests zooms based on cursor activity, smooths the cursor with effects like motion blur and click bounce, and frames the result with wallpapers, gradients, blur, padding, and shadows. You can also add a webcam bubble overlay that can react to zoom.
Can I edit the recording after I stop capturing?Yes — the drag-and-drop timeline handles trims, zoom regions, speed-up and slow-down regions, text and image annotations, extra audio, and cropping. Work is saved as .recordly project files you can reopen later.
What formats can I export to?MP4 for standard video and GIF for lightweight sharing and loops, with quality selection, GIF frame rate and loop options, size presets, and aspect ratio / output dimension controls.
Can I add new features to Recordly?Yes — there's a community Marketplace with extensions anyone can build and publish: cursor click sounds, device frames, browser mockups, wallpapers, render hooks, settings panels, and more.
What are similar projects?openscreen, Captura, ScreenToGif, caplo, screenity, ShareX, Kap, scrcpy
Size
330.3 MB
Stars
34.6K
Age
7mo
Commits · 90 Days