No description
Find a file
spearzificial 34d49274d3 fix(updater): pick the more complete release when two sources tie
The updater resolves the release from two hosts, Forgejo and GitHub.
Forgejo is queried first, so on equal versions it was always the
release that got shown, and a mirror that was missing an installer hid
it from the user.

The selection is now a function of its own: a newer version always wins,
and on equal versions the release with more assets wins. Five tests
cover the ordering, the tie on assets and the empty case.
2026-10-21 17:38:37 +05:30
.github/workflows fix(packaging): build the RPM with rpmbuild and derive its requirements 2026-10-21 17:18:00 +05:30
assets feat(ui): dropdown rolldown animation, sound in replay, square buttons, full QoL keybinds, and monospace font support 2026-10-08 23:09:52 +05:30
docs/superpowers docs: add implementation plan for settings UI and notification overhaul 2026-10-04 11:30:17 +05:30
packaging chore(release): v0.2.21 2026-10-21 17:18:11 +05:30
src fix(updater): pick the more complete release when two sources tie 2026-10-21 17:38:37 +05:30
tests fix(cli): dispatch from argv[0] so daemon symlinks work; harden e2e run 2026-10-20 16:55:33 +05:30
.gitignore fix(ci, windows): track bundle_deps.py and improve mingw dynamic library resolution 2026-09-04 23:45:07 +05:30
.gitlab-ci.yml fix(ci): package the unified scythe binary instead of removed targets 2026-10-20 16:31:46 +05:30
Cargo.lock chore(release): v0.2.21 2026-10-21 17:18:11 +05:30
Cargo.toml chore(release): v0.2.21 2026-10-21 17:18:11 +05:30
install.sh feat(arch): consolidate daemon and UI into singular multicall binary scythe 2026-10-11 14:28:14 +05:30
LICENSE-APACHE Add LICENSE 2026-09-27 20:52:52 +05:30
LICENSE-MIT Add LICENSE 2026-09-27 20:52:52 +05:30
PROJECT_GUIDE.md chore(release): v0.2.21 2026-10-21 17:18:11 +05:30
README.md docs: point the project at the oiupoyt GitHub repository 2026-10-21 16:40:27 +05:30
TODO_CHECKLIST.md docs: record the CI work in the checklist 2026-10-20 18:23:49 +05:30

Scythe (WIP)

High-performance, zero-copy GPU hardware screen recorder and instant replay overlay for Linux (Wayland & X11) and Windows.

Release License

Scythe is a native, ultra-lightweight alternative to NVIDIA ShadowPlay and GPU Screen Recorder. It records gameplay and desktop screens with near-zero CPU and GPU overhead by leveraging hardware video acceleration and zero-copy direct memory pipelines.


Features

  • Instant Replay Buffer: Constantly records gameplay into a high-speed in-memory circular ring buffer. Save the last 15s to 5 minutes of action instantly with one hotkey (Ctrl+Shift+R) without writing temporary files to disk.
  • Zero-Copy Capture Engine:
    • Wayland: PipeWire DMA-BUF frame-passing directly to hardware encoder surfaces.
    • X11: XCB Shared Memory (MIT-SHM) capture with per-frame pool reuse.
    • Windows: Desktop Duplication API via Direct3D 11 (DXGI) texture binding.
  • Hardware-Accelerated Encoding:
    • NVIDIA NVENC (h264_nvenc, hevc_nvenc, av1_nvenc) with direct hardware BGR0 input
    • AMD AMF (h264_amf, hevc_amf, av1_amf) with native hardware format support
    • Intel QuickSync (h264_qsv, hevc_qsv, av1_qsv)
    • AMD & Intel VAAPI (h264_vaapi, hevc_vaapi, av1_vaapi) with DMA-BUF zero-copy
    • Universal SIMD-accelerated CPU fallback (libx264, libx265, libsvtav1)
  • ShadowPlay-Style Stealth Overlay:
    • Native GTK 3 Layer-Shell overlay with real background blur for Wayland compositors (Hyprland, Sway, etc.).
    • Cross-platform hardware-rendered egui overlay for Windows, GNOME, KDE, and X11.
    • Translucent frosted glass HUD dock, centered controls, and contextual dropdowns.
  • Dynamic Hyprland Integration: Automatically registers overlay blur rules and binds hotkeys at runtime without modifying hyprland.conf.
  • Multi-Channel Audio Routing: Record system audio, microphone, or both simultaneously with individual volume controls via native PulseAudio/PipeWire and WASAPI/CPAL.

Default Shortcuts

Action Shortcut CLI Command
Open / Close HUD Overlay Alt + Z scythe --menu
Save Instant Replay Ctrl + Shift + R scythe --save
Toggle Normal Recording Ctrl + Shift + F9 scythe --record
Toggle Mouse Cursor Ctrl + Shift + F10 scythe --cursor
Take Screenshot Ctrl + Shift + S scythe --screenshot

Installation

Arch Linux (AUR)

git clone https://aur.archlinux.org/scythe-git.git
cd scythe-git
makepkg -si

Pre-Built Packages (Releases)

Download the latest packages directly from GitHub Releases or Forgejo Releases:

  • Windows Setup: scythe-setup.exe (Official installer with Start Menu & Desktop shortcuts)
  • Windows Portable: scythe.exe (Standalone self-contained executable) & scythe-windows-x86_64.zip
  • Debian / Ubuntu / Linux Mint: scythe_*_amd64.deb
  • Fedora / RHEL / openSUSE: *.rpm
  • Universal Linux: scythe-x86_64.AppImage
  • Generic Linux: scythe-linux-x86_64.tar.gz

Build from Source

Prerequisites

  • Rust (1.85+, the crate uses the 2024 edition)
  • FFmpeg 6+ / 7+ development libraries (libavcodec, libavformat, libavutil, libswresample, libswscale)
  • PipeWire (libpipewire-0.3-dev)
  • XCB (libxcb1-dev, libxcb-shm0-dev, libxcb-xfixes0-dev)
  • ALSA (libasound2-dev)
  • clang and pkg-config for the FFmpeg bindings

Compile & Install

git clone https://github.com/oiupoyt/scythe.git
cd scythe
bash install.sh

CLI Usage

scythe --menu           # Open the interactive overlay UI menu
scythe --status         # Query background daemon state and metrics
scythe --save           # Save instant replay clip to disk
scythe --record         # Toggle normal recording on/off
scythe --cursor         # Toggle mouse cursor capture
scythe --reload         # Reload daemon settings
scythe --quit           # Stop background recording daemon

Configuration

Settings are saved in JSON format at ~/.config/scythe/config.json:

{
  "fps": 60,
  "record_bitrate_kbps": 18000,
  "replay_duration_sec": 60,
  "video_codec": "h264",
  "output_directory": "~/Videos",
  "show_cursor": true,
  "audio_mode": "system",
  "mic_volume": 0.6,
  "system_volume": 1.0,
  "menu_hotkey": "Alt+Z",
  "save_hotkey": "Ctrl+Shift+R",
  "record_hotkey": "Ctrl+Shift+F9",
  "cursor_hotkey": "Ctrl+Shift+F10"
}

License

Licensed under either of Apache License, Version 2.0 or MIT License at your option.