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
Что это такое?Recordly — опенсорсное настольное приложение для записи и редактирования видео с экрана со встроенными инструментами динамической подачи: автоувеличение, красивая подсветка курсора и стильные рамки. Создано для обучающих видео, демо и презентаций продукта.
То есть это программа, которую я ставлю на компьютер, а не сайт?Именно так — настольное приложение на Electron со вспомогательными модулями захвата под каждую платформу. Работает на macOS 14.0+, Windows 10 (сборка 19041+) и современных дистрибутивах Linux.
Как установить его на свой компьютер?Скачайте готовую сборку с GitHub или в Arch Linux/Manjaro установите пакет recordly-bin из AUR. Можно также собрать из исходников с помощью npm (npm run build:mac, build:win или build:linux).
Нужна ли моей системе что-то особенное, чтобы запись шла нормально?Да: на macOS нужна версия 14.0+ для записи звука через ScreenCaptureKit, на Windows — сборка 19041+ для встроенного помощника Windows Graphics Capture, а системный звук в Linux обычно требует PipeWire.
Мой настоящий курсор мыши не будет виден в записи?Зависит от системы: на macOS он аккуратно исключается через ScreenCaptureKit, на Windows нужны версия 19041+ и встроенный помощник, а на Linux скрытие курсора вообще не поддерживается — в экспортированном видео могут быть видны и настоящий курсор, и стилизованная подсветка от Recordly.
Оно правда бесплатное? Нет ли подвоха в лицензии?Бесплатное, но распространяется под лицензией AGPL 3.0 — это строгая copyleft-лицензия: если вы измените программу и будете предлагать её как сервис, исходники ваших изменений нужно опубликовать на тех же условиях.
Что он делает, чтобы видео само по себе выглядело аккуратно?Он предлагает зум в зависимости от активности курсора, сглаживает курсор эффектами вроде motion blur и отскока при клике, а результат оформляет — обои, градиенты, размытие, отступы и тени. Можно также добавить всплывающее окно с веб-камерой, которое реагирует на зум.
Можно ли отредактировать запись после того, как я закончу съёмку?Да — таймлайн с перетаскиванием позволяет вырезать фрагменты, задавать области зума, ускорять и замедлять участки, добавлять текстовые и графические пометки, дополнительное аудио и обрезку кадра. Работа сохраняется в файлы проектов .recordly, которые можно открыть позже.
В какие форматы можно экспортировать?MP4 для обычного видео и GIF для лёгкого обмена и зацикленных роликов. Есть выбор качества, настройки частоты кадров и зацикливания GIF, готовые размеры и управление соотношением сторон и разрешением.
Могу ли я добавить в Recordly новые функции?Да — есть общественный Marketplace с расширениями, которые любой может создать и опубликовать: звуки кликов курсора, рамки устройств, макеты браузера, обои, хуки рендеринга, панели настроек и другое.
What are similar projects?openscreen, ScreenToGif, Captura, screenity, ShareX, Kap, scrcpy, Cap
Which topics is it in?pixijs, screencast, screen-recorder, video-editor, screen-recording, webcam, gif, screen-capture, video-editing, video-processing, electron, agpl
Creator
webadderallorg
Size
330.3 MB
Stars
34.1K
Updated
CommitOct 17Releasev1.4.0Sep 08
Age
7mo
Commits · 90 Days