Skip to content

Repository files navigation

DMS Quick Capture & Annotate

Upvote on DMS Plugin Registry

Screenshot annotation 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.
  • Rust Backend Architecture: capture flow, selector state, coordinates, scaling, scroll capture, and compositor fallbacks.

Requirements

Dependency Purpose
DankMaterialShell >= 1.5.2 Required for scrolling capture
ImageMagick (magick/mogrify) WebP/JPEG exports and OCR/QR crop
img2pdf PDF export
tesseract OCR text scanner
zbar (zbarimg) QR scanner
Rust screenshot backend Installed separately when the New Backend is selected
curl and sha256sum Verify and install the Rust backend release asset

Install

Via DMS CLI:

dms plugins install quickCapture

Or manually:

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

The New Backend is distributed as a GitHub Release asset and installed separately after verifying its checksum. For installation and backend development, see the dms-screenshot-rs README.

Build the Rust backend locally

Users who prefer to build from source can install the required tools and dependencies, then run:

sudo dnf install rust cargo cairo-devel libXcursor-devel
git clone https://github.com/hthienloc/dms-quick-capture
cd dms-quick-capture
./scripts/update-bundled-backend.sh

The script builds an optimized binary and installs it into backend/<architecture>/ inside the plugin. Select New Backend in Quick Capture settings after the build completes.

Credits

  • Gradia Capture — Inspiration for the toolbar layout and background algorithms
  • 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

About

Screenshot annotation plugin for DankMaterialShell

Resources

Contributing

Stars

37 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages