Skip to content

Latest commit

 

History

History

quickCapture

README.md

DMS Quick Capture

Upvote on DMS Plugin Registry

Screenshot annotation and screen recording plugin for DankMaterialShell.

Screenshot

Documentation

  • User Guide: capture workflow, annotation tools, shortcuts, floating images, and IPC commands.
  • Documentation Index: architecture, annotation engine, settings reference, and contributor documentation.

Requirements

Dependency Purpose
DankMaterialShell >= 1.6.0 Required for floating window and scrolling capture
gpu-screen-recorder Screen recording backend (Hardware NVENC / VA-API; native or Flatpak com.dec05eba.gpu_screen_recorder)
wf-recorder Alternative CPU screen recording backend (Software libx264, fallback when GPU encoder is unavailable)
ffmpeg Video thumbnail generation
ImageMagick (magick/mogrify) WebP/JPEG exports and OCR/QR crop
img2pdf PDF export
tesseract OCR text scanner
zbar (zbarimg) QR scanner
pkill (procps / procps-ng) Signaling Flatpak GPU Screen Recorder sessions

Note

At least one recording backend (gpu-screen-recorder or wf-recorder) is required for video capture. gpu-screen-recorder is recommended for optimal performance, pause/resume support, and audio (supports both native package and Flatpak com.dec05eba.gpu_screen_recorder); wf-recorder serves as a lightweight CPU-based alternative (video only, pause/resume not supported).

If using Flatpak GPU Screen Recorder, system installation is recommended for proper KMS/DRI screen capture permissions (pkill on host is used to control pause/stop/cancel):

flatpak install --system com.dec05eba.gpu_screen_recorder

Install

Via DMS CLI:

dms plugins install quickCapture

Or manually:

git clone https://github.com/hthienloc/dms-quick-capture ~/.config/DankMaterialShell/plugins/quickCapture

Translations

Quick Capture supports native DMS 1.6+ sideload translations located in translations/<locale>.json.

Translations are crowdsourced and managed online via POEditor:
👉 Contribute translations on POEditor (Project #839330)

Language Locale Progress Coverage Status Contributors
Arabic ar 465/491 94.7% 🟡 In Progress —
Bulgarian bg 68/491 13.8% 🟡 In Progress —
German de 83/491 16.9% 🟡 In Progress —
Esperanto eo 63/491 12.8% 🟡 In Progress —
Spanish es 82/491 16.7% 🟡 In Progress —
Persian fa 58/491 11.8% 🟡 In Progress —
French fr 70/491 14.3% 🟡 In Progress —
Hebrew he 67/491 13.6% 🟡 In Progress —
Hungarian hu 68/491 13.8% 🟡 In Progress —
Italian it 465/491 94.7% 🟡 In Progress —
Japanese ja 80/491 16.3% 🟡 In Progress —
Korean ko 80/491 16.3% 🟡 In Progress —
Dutch nl 67/491 13.6% 🟡 In Progress —
Polish pl 64/491 13.0% 🟡 In Progress —
Portuguese pt 67/491 13.6% 🟡 In Progress —
Russian ru 82/491 16.7% 🟡 In Progress —
Swedish sv 55/491 11.2% 🟡 In Progress —
Turkish tr 43/491 8.8% 🟡 In Progress —
Ukrainian uk 68/491 13.8% 🟡 In Progress —
Vietnamese vi 82/491 16.7% 🟡 In Progress —
Chinese (Simplified) zh-CN 491/491 100.0% 🟢 Complete @Lemon-mon-254
Chinese (Traditional) zh-TW 62/491 12.6% 🟡 In Progress —

Contributing Translations

  1. Extract the latest translatable strings:
    python3 scripts/i18n.py extract
  2. Edit your language file under translations/<locale>.json (or add a new language with python3 scripts/i18n.py add-lang <locale>).
  3. Check translation coverage and update the table:
    python3 scripts/i18n.py status --readme

Credits

  • Quick Capture toolbar
    • Version 1: Quick Capture toolbar version 1
    • Version 5: Quick Capture toolbar version 5
  • Gradia Capture and Noctalia — Inspiration for the toolbar layout and background algorithms
    • Gradia Capture toolbar
    • Noctalia toolbar
  • Flameshot — Inspiration for the radial menu and tool interaction patterns
  • Snapzy — Inspiration for the float image / continue-editing workflow
  • vky and bodify (Discord) — Bug reports and feedback that helped polish the plugin

Thanks to everyone who supported, contributed code, gave feedback, and helped the DankMaterialShell community.

License

MIT