docs: refresh English and Chinese READMEs

This commit is contained in:
webadderall
2026-03-21 12:57:07 +11:00
parent b94882b9bc
commit 9103e1b619
2 changed files with 334 additions and 280 deletions
+163 -147
View File
@@ -12,112 +12,136 @@ Language: EN | [简中](README.zh-CN.md)
</p>
### Create polished, pro-grade screen recordings.
[Recordly](https://www.recordly.dev) is an **open-source screen recorder and editor** for creating **polished walkthroughs, demos, tutorials, and product videos**. Contribution encouraged.
[Recordly](https://www.recordly.dev) is an open-source screen recorder and editor for walkthroughs, demos, tutorials, product videos, and social clips. Record a screen or window, jump straight into the editor, and export a polished result with cursor effects, zooms, backgrounds, annotations, webcam overlays, and more.
<p align="center">
<img src="./demo.gif" width="750" alt="Recordly demo video">
</p>
> [!NOTE]
> Huge thank you to **tadees** for supporting! This donation directly helps cover the Apple Developer fees to get Recordly signed and notarised for macOS. Still waiting for Apple approval.
> Huge thank you to **tadees** for supporting the project. This donation helps cover Apple Developer fees for macOS signing and notarization.
[**Support the project**](https://ko-fi.com/webadderall/goal?g=0)
---
## What is Recordly?
Recordly lets you record your screen and automatically transform it into a polished video. It handles the heavy lifting of zooming into important actions and smoothing out jittery cursor movement so your demos look professional by default.
Recordly is a desktop app for recording and editing screen captures with motion-driven presentation tools built in. Instead of sending raw footage into a separate editor just to add zooms, cursor polish, or a styled background, Recordly handles that workflow in one place.
Recordly runs on:
- **macOS** 12.3+
- **Windows** 10 Build 19041+
- **Linux** (modern distros)
On Windows, builds older than 19041 fall back to Electron capture and the cursor cannot be hidden. On Linux, cursor hiding is not supported (contribute).
- **Linux** on modern distros
Platform notes:
- **macOS** uses native ScreenCaptureKit-based capture helpers.
- **Windows** uses a native Windows Graphics Capture (WGC) helper on supported builds, with native WASAPI audio support.
- **Linux** records through Electron capture APIs. Cursor hiding is not supported on Linux today.
---
# Core Features
## Auto-zooms, silky cursor & beautiful backgrounds
Recordly adds beautiful cursor animations and auto-zooming plus a background to your recordings so you can spend less time editing and more time shipping.
## 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.
<p>
<img src="./feature1.gif" width="450" alt="Recordly sway demo video">
<img src="./feature1.gif" width="450" alt="Recordly cursor and zoom demo video">
</p>
## Dynamic bubble webcam overlay
Record your face with smart webcam bubbles that expand and shrink to make sure you get the spotlight when you need to. Perfect for demos and tutorials.
## 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.
<p>
<img src="./feature2.gif" width="450" alt="Recordly sway demo video">
<img src="./feature2.gif" width="450" alt="Recordly webcam overlay demo video">
</p>
## Intuitive timeline editing interface
Use drag-and-drop pieces to control video speed, zooms, annotations, audio tracks and video length, and save your projects as .recordly files so you can save your progress or edit other projects.
## 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.
<p>
<img src="./feature3.png" width="450" alt="Recordly sway demo video">
<img src="./feature3.png" width="450" alt="Recordly timeline editor screenshot">
</p>
## All features
### Cursor Animations
<p>
<img src="./CursorSwayDemo.gif" width="450" alt="Recordly sway demo video">
</p>
- Adjustable cursor size
- Cursor smoothing
- Motion blur
- Click bounce animation
- macOS-style cursor assets
- Cursor sway effects
## All Features
### Recording
- Record an entire screen or a single window
- Jump straight from recording into the editor
- Microphone or system audio recording
- Chromium capture APIs on Windows/Linux
- Native **ScreenCaptureKit** capture on macOS
- native DXGI Desktop Duplication recording helper for display and app-window capture on Windows, native WASAPI for system/mic audio, and more
- Record an entire display or a single app window
- Jump directly from recording into the editor
- Capture microphone audio and system audio
- Use native capture backends where supported
- Resume editing from saved `.recordly` project files
- Open existing recordings or existing project files from the app
### Smart Motion
### Timeline and Editing
- Apple-style zoom animations
- Automatic zoom suggestions based on cursor activity
- Manual zoom regions
- Smooth pan transitions between zoom regions
- Drag-and-drop timeline editing
- Trim unwanted sections
- Add manual zoom regions
- Use automatic zoom suggestions based on cursor activity
- Add speed-up and slow-down regions
- Add text, image, and figure annotations
- Add extra audio regions on the timeline
- Crop the recorded frame
- Save and reopen projects with editor state preserved
### Infinite Loops
<p>
<img src="./CursorLoop.gif" width="450" alt="Recordly gif loop demo video">
</p>
### Cursor Controls
- Toggle to make cursor return to original position at end of video/GIF for clean loops
- Show or hide the rendered cursor overlay
- Cursor size adjustment
- Cursor smoothing
- Cursor motion blur
- Cursor click bounce
- Cursor sway
- Cursor loop mode for cleaner looping exports
- macOS-style cursor assets for the rendered overlay
### Editing Tools
### Webcam Overlay
- Timeline trimming
- Speed-up / slow-down regions
- Annotations
- Zoom spans
- Project save + reopen (`.recordly` files)
- Enable or disable webcam overlay footage
- Upload, replace, or remove webcam footage
- Mirror webcam footage
- Size control
- Preset positions and custom X/Y placement
- Margin control
- Roundness control
- Shadow control
- Optional zoom-reactive webcam scaling
### Frame Styling
### Frame Styling and Backgrounds
- Wallpapers
- Gradients
- Solid fills
- Padding
- Built-in wallpapers
- Runtime wallpaper discovery from the wallpapers directory
- Custom uploaded backgrounds
- Solid color backgrounds
- Gradient backgrounds
- Frame padding
- Rounded corners
- Blur
- Background blur
- Drop shadows
- Aspect ratio presets for the final frame
### Export
- MP4 video export
- MP4 export
- GIF export
- Aspect ratio controls
- Quality settings
- Export quality selection
- GIF frame-rate selection
- GIF loop toggle
- GIF size presets
- Aspect ratio and output dimension controls
- Reveal exported files in the system file manager
### Workflow and Usability
- Customizable keyboard shortcuts
- In-app shortcut reference
- Feedback and issue links from the editor
- Project persistence for editor preferences
- Faster preview recovery after export
---
@@ -127,13 +151,12 @@ Use drag-and-drop pieces to control video speed, zooms, annotations, audio track
<img src="https://i.postimg.cc/CKxm8DRs/Screenshot-2026-03-20-at-7-07-22-pm.png" width="700" alt="Recordly editor screenshot">
</p>
<p align="center">
<img src="https://i.postimg.cc/hjwdYRyV/Screenshot-2026-03-20-at-1-53-57-pm.png" width="700" alt="Recordly recording interface screenshot">
</p>
<p align="center">
<img src="https://i.postimg.cc/Zn9VY6bg/Screenshot-2026-03-18-at-6-32-59-pm.png" width="700" alt="Recordly recording interface screenshot">
<img src="https://i.postimg.cc/Zn9VY6bg/Screenshot-2026-03-18-at-6-32-59-pm.png" width="700" alt="Recordly timeline screenshot">
</p>
---
@@ -142,7 +165,7 @@ Use drag-and-drop pieces to control video speed, zooms, annotations, audio track
## Download a build
Prebuilt releases are available here:
Prebuilt releases are available at:
https://github.com/webadderall/Recordly/releases
@@ -157,11 +180,23 @@ npm install
npm run dev
```
For packaged builds:
```bash
npm run build
```
Target-specific build commands are also available:
- `npm run build:mac`
- `npm run build:win`
- `npm run build:linux`
---
## macOS: "App cannot be opened"
Recordly is not signed. macOS may quarantine locally built apps.
Locally built apps may be quarantined by macOS.
Remove the quarantine flag with:
@@ -175,12 +210,12 @@ xattr -rd com.apple.quarantine /Applications/Recordly.app
| Platform | Minimum version | Notes |
|---|---|---|
| **macOS** | macOS 12.3 (Monterey) | Required for ScreenCaptureKit. Recording and cursor hiding will not work on older versions. |
| **Windows** | Windows 10 20H1 (Build 19041, May 2020) | Required for the native DXGI Desktop Duplication helper. Older builds fall back to Electron browser capture — cursor will be visible in recordings. |
| **Linux** | Any modern distro | Recording works via Electron capture. Cursor is always visible in recordings. System audio requires PipeWire (Ubuntu 22.04+, Fedora 34+). |
| **macOS** | macOS 12.3 (Monterey) | Required for ScreenCaptureKit-based 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, if your build is older than 19041, recording will still work but **the cursor cannot be hidden** from the captured video.
> On Windows builds older than 19041, recording can still work through fallback capture, but the real OS cursor may remain visible in recordings.
---
@@ -188,120 +223,105 @@ xattr -rd com.apple.quarantine /Applications/Recordly.app
## Record
1. Launch Recordly
2. Select a screen or window
3. Choose audio recording options
4. Start recording
5. Stop recording to open the editor
---
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:
- Add zoom regions manually
- Use automatic zoom suggestions
- Adjust cursor behavior
- Trim the video
- Add speed changes
- Add annotations
- Style the frame
- add trims, zooms, speed regions, and annotations
- tune cursor behavior and preview volume
- style the frame with wallpapers, colors, gradients, blur, padding, and corners
- add or adjust webcam overlay footage
- add extra audio regions
- crop the frame and choose an aspect ratio
Save your work anytime as a `.recordly` project.
---
## Export
Export options include:
- **MP4** for full-quality video
- **GIF** for lightweight sharing
- **MP4** for standard video output
- **GIF** for lightweight sharing and loops
Adjust:
- Aspect ratio
- Output resolution
- Quality settings
You can adjust format-specific settings such as quality, GIF frame rate, GIF looping, and output size before export.
---
# Limitations
### Cursor Capture (We overlay a second animated cursor over the original hidden one)
### Cursor capture
**macOS**: Cursor is excluded from the recording at the ScreenCaptureKit level — always clean.
**Windows**: Cursor exclusion depends on the native DXGI Desktop Duplication helper plus OS cursor hide/show, and requires **Windows 10 Build 19041+**. On older builds the app falls back to Electron’s browser capture and the real cursor will be visible in the recording.
**Linux**: Electron’s desktop capture API does not support cursor hiding. The real OS cursor will always be visible in recordings. If you also enable the animated cursor overlay in the editor, you may see **two cursors** in the output.
Improving cross-platform cursor capture is an area where contributions are welcome.
---
### System Audio
System audio capture depends on platform support.
**Windows**
- Works out of the box via native WASAPI
- Requires Windows 10 Build 19041+
**Linux**
- Requires PipeWire (Ubuntu 22.04+, Fedora 34+)
- Older PulseAudio setups may not support system audio
Recordly renders a polished cursor overlay on top of the recording. Platform cursor-hiding behavior still depends on OS support.
**macOS**
- Requires macOS 12.3+
- Uses ScreenCaptureKit helper
- ScreenCaptureKit can exclude the real cursor cleanly.
**Windows**
- Best results require Windows 10 Build 19041+ and the native capture helper.
- Older builds fall back to Electron capture, so the real cursor may remain visible.
**Linux**
- Electron desktop capture does not currently support cursor hiding.
- If you also enable the rendered cursor overlay, exports may show both the real cursor and the styled cursor.
### System audio
System audio support varies by platform.
**Windows**
- Native WASAPI support
**Linux**
- Usually requires PipeWire
**macOS**
- Requires macOS 12.3+ and the ScreenCaptureKit-based workflow
---
# How It Works
Recordly is a **desktop video editor with a renderer-driven motion pipeline and platform-specific capture layer**.
Recordly combines a platform-specific capture layer with a renderer-driven editor and export pipeline.
**Capture**
- Electron orchestrates recording
- macOS uses native helpers for ScreenCaptureKit and cursor telemetry
- Windows uses a native DXGI Desktop Duplication helper for screen capture
- Electron coordinates recording and application flow
- macOS uses native ScreenCaptureKit helpers
- Windows uses a native Windows Graphics Capture (WGC) helper and native audio helpers where available
**Motion**
- Zoom regions
- Cursor tracking
- Speed changes
- Timeline edits
**Editing**
- Timeline regions define zooms, trims, speed changes, audio overlays, and annotations
- Cursor and webcam styling are applied in the editor state
**Rendering**
- Scene composition handled by **PixiJS**
- Scene composition is handled by **PixiJS**
**Export**
- Frames rendered through the same scene pipeline
- Encoded to MP4 or GIF
- The same scene logic used in preview is rendered into exported MP4 or GIF output
**Projects**
- `.recordly` files store the source video path and editor state
- `.recordly` files store the source media path plus editor state so work can be reopened later
---
# Contribution
All contributors welcomed!
Contributions are welcome.
Areas where help is especially valuable:
Areas where help is especially useful:
- Smooth cursor pipeline for **Linux**
- **Webcam** overlay bubble
- **Localisation** support, especially Chinese
- UI/UX **design** **improvements**
- **Export speed** improvements
- Linux capture and cursor behavior
- Export performance and stability
- UI and UX refinement
- Localisation work
- Additional editor tools and workflow polish
Please:
- Keep pull requests **focused and modular**
- Test playback, editing, and export flows
- Avoid large unrelated refactors
Please keep pull requests focused, test recording/edit/export flows, and avoid unrelated refactors.
See `CONTRIBUTING.md` for guidelines.
@@ -321,16 +341,13 @@ Pull requests are welcome.
[Donations](https://ko-fi.com/webadderall/goal?g=0)
Greatful for all supporters, you are helping Recordly stay open-source and supporting development.
• Tadees
• Anonymous supporter
• Anonymous supporter
Email youngchen3442@gmail.com for other inquiries or DM me via [@webadderall](https://x.com/webadderall)
Thanks to everyone supporting the project and helping keep Recordly open source.
- Tadees
- Anonymous supporter
- Anonymous supporter
For other inquiries, email `youngchen3442@gmail.com` or DM [@webadderall](https://x.com/webadderall).
---
@@ -344,8 +361,7 @@ Recordly is licensed under the **MIT License**.
## Acknowledgements
Originally built on top of the excellent [OpenScreen](https://github.com/siddharthvaddem/openscreen) project.
> Recordly originally started as a fork of OpenScreen, and is expanded to include a full cursor animation/rendering pipeline, native macOS and Windows screen recording workflow, an animated webcam overlay bubble system, zoom animations faithful to Screen Studio, cursor loops, audio tracks, and more major features.
Recordly was originally built on top of the excellent [OpenScreen](https://github.com/siddharthvaddem/openscreen) project and has since been expanded with its own recording, editing, cursor, webcam, export, and packaging workflow.
Created by
[@webadderall](https://x.com/webadderall)
+171 -133
View File
@@ -12,108 +12,151 @@
</p>
### 制作精致、专业级的屏幕录制视频。
[Recordly](https://www.recordly.dev) 是一款**开源录屏与编辑工具**,用于制作**精致的演示、讲解、教程和产品视频**。欢迎参与贡献。
Recordly 包含完整的光标动画与渲染管线、macOS 和 Windows 原生录屏系统、带动画的摄像头圆形叠加工作流、贴近 Screen Studio 的缩放动画、光标循环、音轨等更多核心功能。
[Recordly](https://www.recordly.dev) 是一款开源的录屏与编辑工具,适合制作演示、讲解、教程、产品视频和社交媒体短片。你可以录制屏幕或窗口,直接进入编辑器,并通过光标特效、缩放、背景、注释、摄像头叠加等功能快速导出更完整的成片。
<p align="center">
<img src="./recordlydemo.gif" width="750" alt="Recordly demo video">
<img src="./demo.gif" width="750" alt="Recordly demo video">
</p>
> [!NOTE]
> 非常感谢 **tadees** 的支持。这笔捐助会直接用于支付 Apple Developer 费用,帮助 Recordly 在 macOS 上完成签名和公证。目前仍在等待 Apple 审核。
> 非常感谢 **tadees** 对项目的支持。这笔捐助帮助承担了 macOS 签名与公证所需的 Apple Developer 费用。
[**支持项目**](https://ko-fi.com/webadderall/goal?g=0)
---
## Recordly 是什么?
Recordly 可以录制你的屏幕,并自动将内容整理为更精致的视频。它会自动放大关键操作、平滑抖动的光标移动,让你的演示默认就具备更专业的观感。
Recordly 是一款桌面应用,用于录制和编辑屏幕内容,并内置了面向演示视频的运动表达工具。你不需要先导出原始录像、再切到另一个编辑器去补缩放、光标润色或背景样式,Recordly 会在同一个工作流里完成这些事情。
Recordly 运行于:
Recordly 支持以下平台:
- **macOS** 12.3+
- **Windows** 10 Build 19041+
- **Linux**(现代发行版)
在 Windows 上,低于 19041 的版本会回退到 Electron 捕获,且无法隐藏光标。在 Linux 上,目前不支持隐藏光标(欢迎贡献)。
- **Linux** 现代发行版
平台说明:
- **macOS** 使用原生的 ScreenCaptureKit 捕获辅助程序。
- **Windows** 在支持的系统版本上使用原生 Windows Graphics Capture(WGC)辅助程序,并支持原生 WASAPI 音频。
- **Linux** 通过 Electron 捕获 API 录制。目前 Linux 不支持隐藏真实光标。
---
# 功能
# 核心功能
## 自动缩放、光标润色与画面样式
Recordly 可以根据操作自动强调重点区域,平滑光标运动,添加运动特效,并将最终画面放进带有壁纸、纯色、渐变、模糊、留白和阴影的样式化边框中。
### 光标动画
<p>
<img src="./CursorSwayDemo.gif" width="450" alt="Recordly sway demo video">
<img src="./feature1.gif" width="450" alt="Recordly cursor and zoom demo video">
</p>
- 可调节光标大小
- 光标平滑
- 运动模糊
- 点击弹跳动画
- macOS 风格光标素材
- 光标摆动效果
## 动态摄像头气泡叠加
你可以把摄像头素材作为气泡叠加层加入画面,使用预设位置或自定义坐标摆放,支持镜像、阴影、圆角调节,也可以让它跟随缩放变化,保证运动镜头中整体视觉更协调。
<p>
<img src="./feature2.gif" width="450" alt="Recordly webcam overlay demo video">
</p>
## 为演示而设计的时间线编辑
通过拖拽式时间线工具添加缩放、裁剪、变速、注释、额外音轨和裁切等内容,并将工程保存为 `.recordly` 项目文件,随时回来继续编辑。
<p>
<img src="./feature3.png" width="450" alt="Recordly timeline editor screenshot">
</p>
## 全部功能
### 录制
- 录制整个屏幕或单个窗口
- 录制后可直接进入编辑器
- 支持麦克风或系统音频录制
- Windows/Linux 使用 Chromium 捕获 API
- macOS 使用原生 **ScreenCaptureKit** 捕获
- Windows 使用原生 DXGI Desktop Duplication 录制辅助程序进行显示器和应用窗口捕获,并通过原生 WASAPI 处理系统/麦克风音频等
- 录制整个显示器或单个应用窗口
- 录制完成后直接进入编辑器
- 录制麦克风音频和系统音频
- 在支持的平台上使用原生捕获后端
- 从保存的 `.recordly` 项目文件继续编辑
- 可在应用中打开已有录像或已有项目文件
### 智能运动
### 时间线与编辑
- Apple 风格缩放动画
- 基于光标活动的自动缩放建议
- 手动缩放区域
- 缩放区域之间的平滑平移过渡
- 拖拽式时间线编辑
- 裁掉不需要的片段
- 添加手动缩放区域
- 根据光标活动生成自动缩放建议
- 添加加速和减速区域
- 添加文本、图片和图形注释
- 在时间线上添加额外音频片段
- 裁切录制画面
- 保存并重新打开项目,保留编辑状态
### 无限循环
<p>
<img src="./CursorLoop.gif" width="450" alt="Recordly gif loop demo video">
</p>
### 光标控制
- 可切换是否让光标在视频/GIF 结尾回到初始位置,从而生成更干净的循环效果
- 显示或隐藏渲染后的光标叠加层
- 调整光标大小
- 光标平滑
- 光标运动模糊
- 点击弹跳效果
- 光标摆动效果
- 光标循环模式,方便导出更自然的循环片段
- 使用 macOS 风格的渲染光标素材
### 编辑工具
### 摄像头叠加
- 时间线裁剪
- 加速 / 减速区域
- 注释
- 缩放区段
- 项目保存与重新打开(`.recordly` 文件)
- 启用或禁用摄像头叠加素材
- 上传、替换或移除摄像头素材
- 镜像摄像头画面
- 调整尺寸
- 使用预设位置或自定义 X/Y 坐标
- 调整边距
- 调整圆角程度
- 调整阴影强度
- 可选的缩放联动摄像头缩放效果
### 画面样式
### 画面样式与背景
- 壁纸
- 渐变
- 纯色填充
- 内边距
- 内置壁纸
- 运行时自动发现 wallpapers 目录中的壁纸
- 上传自定义背景图片
- 纯色背景
- 渐变背景
- 画面留白
- 圆角
- 模糊
- 背景模糊
- 投影阴影
- 最终画面的宽高比预设
### 导出
- MP4 视频导出
- MP4 导出
- GIF 导出
- 画幅比例控制
- 质量设置
- 导出质量选择
- GIF 帧率选择
- GIF 循环开关
- GIF 尺寸预设
- 宽高比和输出尺寸控制
- 在系统文件管理器中定位导出文件
### 工作流与易用性
- 可自定义键盘快捷键
- 应用内快捷键说明
- 在编辑器中直接打开反馈和问题链接
- 编辑器偏好设置持久化
- 导出后更稳定的预览恢复
---
# 截图
<p align="center">
<img src="https://i.postimg.cc/B6bX9gcy/Screenshot-2026-03-16-at-1-33-51-pm.png" width="700" alt="Recordly editor screenshot">
<img src="https://i.postimg.cc/CKxm8DRs/Screenshot-2026-03-20-at-7-07-22-pm.png" width="700" alt="Recordly editor screenshot">
</p>
<p align="center">
<img src="https://i.postimg.cc/nhnmSqgV/Screenshot-2026-03-16-at-1-36-14-pm.png" width="700" alt="Recordly recording interface screenshot">
<img src="https://i.postimg.cc/hjwdYRyV/Screenshot-2026-03-20-at-1-53-57-pm.png" width="700" alt="Recordly recording interface screenshot">
</p>
<p align="center">
<img src="https://i.postimg.cc/Zn9VY6bg/Screenshot-2026-03-18-at-6-32-59-pm.png" width="700" alt="Recordly timeline screenshot">
</p>
---
@@ -122,7 +165,7 @@ Recordly 运行于:
## 下载构建版本
预构建发布版见:
预构建发布版本请见:
https://github.com/webadderall/Recordly/releases
@@ -137,13 +180,25 @@ npm install
npm run dev
```
如果需要打包构建:
```bash
npm run build
```
也可以使用平台专用构建命令:
- `npm run build:mac`
- `npm run build:win`
- `npm run build:linux`
---
## macOS: “无法打开应用”
## macOS: “App cannot be opened”
Recordly 尚未签名。macOS 可能会隔离本地构建的应用。
本地构建的应用可能会被 macOS 隔离。
使用以下命令移除隔离标记:
可以用以下命令移除隔离标记:
```bash
xattr -rd com.apple.quarantine /Applications/Recordly.app
@@ -155,12 +210,12 @@ xattr -rd com.apple.quarantine /Applications/Recordly.app
| 平台 | 最低版本 | 说明 |
|---|---|---|
| **macOS** | macOS 12.3 (Monterey) | ScreenCaptureKit 的最低要求。更旧版本无法正常进行录制和隐藏光标。 |
| **Windows** | Windows 10 20H1(Build 19041,2020 年 5 月) | 原生 DXGI Desktop Duplication 录制助手的最低要求。更旧版本会回退到 Electron 浏览器捕获,录制中会显示真实光标。 |
| **Linux** | 任意现代发行版 | 通过 Electron 捕获实现录制。录制中光标始终可见。系统音频需要 PipeWire(Ubuntu 22.04+、Fedora 34+)。 |
| **macOS** | macOS 12.3 (Monterey) | 使用 ScreenCaptureKit 捕获所必需。 |
| **Windows** | Windows 10 20H1(Build 19041,2020 年 5 月) | 原生 Windows Graphics Capture(WGC)辅助程序及更稳定光标隐藏效果所必需。 |
| **Linux** | 任意现代发行版 | 通过 Electron 捕获录制。系统音频通常需要 PipeWire。 |
> [!IMPORTANT]
> 在 Windows 上,如果系统版本低于 19041,录制仍可使用,但**无法将光标从录制视频中隐藏**。
> 在 Windows 19041 之前的版本上,应用仍可能通过回退捕获方式录制,但真实系统光标可能仍会出现在视频中。
---
@@ -168,120 +223,105 @@ xattr -rd com.apple.quarantine /Applications/Recordly.app
## 录制
1. 启动 Recordly
2. 选择屏幕或窗口
3. 选择音频录制选项
4. 开始录制
5. 停止录制并打开编辑器
---
1. 启动 Recordly。
2. 选择屏幕或窗口。
3. 选择麦克风和系统音频选项。
4. 开始录制。
5. 停止录制后进入编辑器。
## 编辑
在编辑器中你可以:
在编辑器中,你可以:
- 手动添加缩放区域
- 使用自动缩放建议
- 调整光标行为
- 裁剪视频
- 添加变速
- 添加注释
- 调整画面样式
- 添加裁剪、缩放、变速和注释片段
- 调整光标行为和预览音量
- 使用壁纸、纯色、渐变、模糊、留白和圆角来美化画面
- 添加或调整摄像头叠加素材
- 添加额外音频片段
- 裁切画面并选择宽高比
你可以随时将工作保存为 `.recordly` 项目。
---
## 导出
导出选项包括:
支持以下导出格式:
- **MP4**,适合完整质量的视频
- **GIF**,适合轻量分享
- **MP4**,适合常规视频输出
- **GIF**,适合轻量分享和循环片段
可调整:
- 画幅比例
- 输出分辨率
- 质量设置
你可以在导出前调整对应格式的设置,例如质量、GIF 帧率、GIF 循环方式和输出尺寸。
---
# 限制
### 光标捕获(我们会在原始隐藏光标之上叠加第二个动画光标)
### 光标捕获
**macOS**:在 ScreenCaptureKit 层级就会将光标排除,因此始终干净。
Recordly 会在录制画面上渲染一个经过美化的光标叠加层,但真实系统光标是否能被隐藏仍取决于平台能力。
**Windows**:光标排除依赖原生 DXGI Desktop Duplication 录制助手以及系统光标隐藏/恢复逻辑,需要 **Windows 10 Build 19041+**。在更旧版本中,应用会回退到 Electron 浏览器捕获,真实光标会出现在录制里。
**macOS**
- ScreenCaptureKit 可以较干净地排除真实光标。
**Linux**:Electron 的桌面捕获 API 不支持隐藏光标。真实系统光标将始终出现在录制中。如果你同时在编辑器中启用动画光标叠加,导出结果中可能会出现**两个光标**。
**Windows**
- 最佳效果需要 Windows 10 Build 19041+ 和原生捕获辅助程序。
- 较旧版本会回退到 Electron 捕获,因此真实光标可能仍会显示。
欢迎贡献,帮助改进跨平台光标捕获。
---
**Linux**
- Electron 桌面捕获目前不支持隐藏真实光标。
- 如果同时启用渲染光标叠加,导出中可能会同时看到真实光标和样式化光标。
### 系统音频
系统音频捕获依赖平台支持。
系统音频支持因平台而异。
**Windows**
- 开箱即用,使用原生 WASAPI
- 需要 Windows 10 Build 19041+
- 支持原生 WASAPI
**Linux**
- 需要 PipeWire(Ubuntu 22.04+、Fedora 34+)
- 较旧的 PulseAudio 环境可能不支持系统音频
- 通常需要 PipeWire
**macOS**
- 需要 macOS 12.3+
- 使用 ScreenCaptureKit 辅助程序
- 需要 macOS 12.3+ 和基于 ScreenCaptureKit 的工作流
---
# 工作原理
Recordly 是一个**桌面视频编辑器**,以渲染驱动的运动管线和平台特定捕获层为核心。
Recordly 将平台相关的捕获层与基于渲染器的编辑、导出流程结合在一起。
**捕获**
- Electron 负责录制流程编排
- macOS 使用原生辅助程序处理 ScreenCaptureKit 和光标遥测
- Windows 使用原生 DXGI Desktop Duplication 进行屏幕捕获
- Electron 负责录制流程和应用级控制
- macOS 使用原生的 ScreenCaptureKit 辅助程序
- Windows 在可用时使用原生 Windows Graphics Capture(WGC)和原生音频辅助程序
**运动**
- 缩放区域
- 光标跟踪
- 变速
- 时间线编辑
**编辑**
- 时间线区域定义缩放、裁剪、变速、音频叠加和注释
- 光标和摄像头样式由编辑器状态统一控制
**渲染**
- 场景合成由 **PixiJS** 处理
- 场景合成由 **PixiJS** 负责
**导出**
- 帧通过同一套场景管线进行渲染
- 编码为 MP4 或 GIF
- 预览使用的同一套场景逻辑会被用于导出 MP4 或 GIF
**项目**
- `.recordly` 文件保存源视频路径和编辑状态
- `.recordly` 文件会保存源媒体路径和编辑器状态,方便后续继续编辑
---
# 贡献
欢迎所有贡献者参与。
欢迎贡献。
特别需要帮助的方向:
特别需要帮助的方向包括:
- **Linux** 的平滑光标管线
- **摄像头** 叠加气泡
- **本地化** 支持,尤其是中文
- UI/UX **设计** 改进
- **导出速度** 改进
- Linux 录制与光标行为改进
- 导出性能与稳定性优化
- UI 和 UX 打磨
- 本地化工作
- 更多编辑工具与工作流优化
请注意:
- 保持 Pull Request **聚焦且模块化**
- 测试播放、编辑和导出流程
- 避免大型且无关的重构
请尽量让 Pull Request 保持聚焦,测试录制、编辑、导出流程,并避免无关重构。
详细指南请参阅 `CONTRIBUTING.md`。
@@ -289,7 +329,7 @@ Recordly 是一个**桌面视频编辑器**,以渲染驱动的运动管线和
# 社区
Bug 反馈和功能请求:
问题反馈和功能建议:
https://github.com/webadderall/Recordly/issues
@@ -301,15 +341,13 @@ https://github.com/webadderall/Recordly/issues
[捐助](https://ko-fi.com/webadderall/goal?g=0)
感谢所有支持者。你们在帮助 Recordly 保持开源,并支持持续开发。
• Tadees ($100)
• Anonymous supporter ($5)
• Anonymous supporter ($1)
其他事项可发送邮件至 youngchen3442@gmail.com,或通过 [@webadderall](https://x.com/webadderall) 私信联系。
感谢所有支持者,帮助 Recordly 持续保持开源并继续开发。
- Tadees
- Anonymous supporter
- Anonymous supporter
其他事项可发送邮件至 `youngchen3442@gmail.com`,或通过 [@webadderall](https://x.com/webadderall) 私信联系。
---
@@ -323,7 +361,7 @@ Recordly 基于 **MIT License** 发布。
## 鸣谢
本项目最初构建于优秀的 [OpenScreen](https://github.com/siddharthvaddem/openscreen) 项目之上。
Recordly 最初构建于优秀的 [OpenScreen](https://github.com/siddharthvaddem/openscreen) 项目之上,随后逐步扩展出了自己的录制、编辑、光标、摄像头、导出与打包工作流。
创建者
[@webadderall](https://x.com/webadderall)