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.1K ·GitHub
这是什么?Recordly 是一个开源的桌面应用,用来录制和剪辑屏幕视频,内置了跟随鼠标动作自动呈现的效果——自动缩放、鼠标光标美化,还有各种漂亮的边框——专门为操作演示、软件演示和产品视频打造。
所以要装在电脑上的软件,不是网页对吧?没错——这是一个基于 Electron 开发的桌面应用,带有针对不同平台的录制辅助组件。它可以在 macOS 14.0 及以上、Windows 10 Build 19041 及以上,以及较新的 Linux 发行版上运行。
我怎么把它装到自己的电脑上?可以从 GitHub 下载预编译的安装包;如果你用的是 Arch Linux/Manjaro,也可以从 AUR 安装 recordly-bin。你还可以用 npm 从源码自己构建(npm run build:mac、build:win 或 build:linux)。
我的系统需要满足什么条件,录制效果才好?有要求:macOS 需要 14.0 及以上版本才能用 ScreenCaptureKit 录制系统声音;Windows 需要 Build 19041 及以上才能使用原生的 Windows Graphics Capture 辅助组件;Linux 上的系统声音录制通常需要 PipeWire。
录制出来的视频里,我的真实鼠标光标会隐藏起来吗?取决于系统:macOS 可以通过 ScreenCaptureKit 干净地隐藏它;Windows 需要 19041 及以上版本并使用原生辅助组件;而 Linux 完全不支持隐藏光标——导出的视频里可能同时出现真实光标和 Recordly 的美化光标样式。
它真的免费吗?许可证上有什么要注意的?免费,但采用的是 AGPL 3.0 许可证——这是一种约束力很强的开源许可证:如果你修改了它并把它作为服务对外提供,就必须以同样的条款公开你修改后的源代码。
它是怎么让视频自动显得精致的?它会根据鼠标的动作建议缩放位置,用运动模糊、点击弹跳等效果美化鼠标光标,还可以用壁纸、渐变、模糊、内边距和阴影给视频加上背景和边框。你还能添加一个摄像头小窗口叠加在画面上,它还可以跟随缩放一起变化。
录完之后还能编辑吗?可以——拖拽式的时间线支持剪辑片段、设置缩放区域、加速和减速区域、添加文字和图片标注、插入额外的音频,以及画面裁剪。你的工作会保存为 .recordly 项目文件,之后可以随时重新打开。
能导出成哪些格式?标准视频可以导出为 MP4,轻量分享和循环播放可以用 GIF,还能选择画质、设置 GIF 的帧率和循环方式,以及使用尺寸预设和画面比例/输出尺寸控制。
我可以给 Recordly 添加新功能吗?可以——有一个社区 Marketplace,任何人都能在上面开发和发布扩展:鼠标点击音效、设备边框、浏览器模型、壁纸、渲染钩子、设置面板等等。
What are similar projects?openscreen, ScreenToGif, Captura, screenity, ShareX, Kap, scrcpy, Cap
Size
330.3 MB
Stars
34.1K
Age
7mo
Commits · 90 Days