Skip to content
GakuseeiPublic

About

Wayland screenshot + annotation overlay built on Quickshell

Resources

Stars

143 stars

Watchers

0 watching

Forks

Latest commit

 

History

68 Commits

Folders and files

Repository files navigation

rishot

rishot

Screenshot and annotate, on Wayland

license  compositors  built on quickshell

rishot demo

Drag a region, click a window, or grab a whole monitor. Mark it up, then copy, save, or upload. rishot started as the screenshot surface in my Hyprland rice, Ricelin, and now stands on its own.

Install

curl -fsSL https://raw.githubusercontent.com/Gakuseei/rishot/main/install.sh | sh

Bind a key (see Keybinding) and run rishot. The installer pulls deps through your package manager and never touches your compositor config.

Other ways to install

Inspect before you pipe:

curl -fsSL https://raw.githubusercontent.com/Gakuseei/rishot/main/install.sh -o install.sh
less install.sh
sh install.sh

From a checkout:

git clone https://github.com/Gakuseei/rishot.git
cd rishot
bin/rishot

Quickshell is in the official repos on Arch (extra), Fedora 44+, Void, and Debian sid / Ubuntu 26.10. Older Fedora pulls it from the errornointernet/quickshell COPR, which a Qt version mismatch can sometimes break. bin/rishot finds its src/ via $RISHOT_CONFIG_DIR, then ~/.local/share/rishot/src, /usr/share/rishot/src, /usr/lib/rishot/src, then ../src.

Features

  • Region, window, and monitor capture: click the desktop to grab its whole monitor, right-click to quit
  • Resize the selection after the fact with eight handles, or hold Space and drag to move it
  • Twelve tools: rectangle, ellipse, line, arrow, pen, highlighter, text, numbered steps, blur, pixelate, zoom
  • Rectangle and ellipse draw filled or outline, toggled with f
  • Scroll while drawing to resize the stroke or text live
  • Per-tool memory: each tool keeps its own colour, width and fill, saved across launches
  • Undo and redo, copy, save, upload
  • Copy the text in a shot with OCR (Ctrl+T, needs tesseract)
  • Copy every QR code and barcode in a shot (Ctrl+R, needs zbar)
  • Skip the editor: rishot --clipboard copies the shot, rishot --raw writes the PNG to stdout, rishot --text and rishot --qr copy and print the text or codes
  • Save through a dialog or straight into a folder you pick, optionally copying to the clipboard at the same time
  • Settings panel: pixelate coarseness, blur strength, zoom factor, save options, key rebind, interface language

Compositors

Capture Region + monitor Window-click
Hyprland yes yes yes
Sway yes yes yes
Niri yes yes floating windows only
KDE Plasma (KWin) yes yes no
Wayfire / COSMIC / river yes yes region + monitor only

Capture works on any wlroots or ext-image-copy compositor. KDE is the exception: KWin speaks no screencopy protocol, so there rishot grabs the desktop through spectacle instead (the installer pulls it in on KDE). Window-click, grabbing one window's frame, needs the compositor to tell rishot where each window sits. Hyprland and Sway do, Niri reports it for floating windows only, and KWin reports none, so on KDE you drag a region or grab a monitor.

Keybinding

rishot does not grab a global hotkey. Bind it yourself:

bind = , Print, exec, rishot                       # Hyprland (conf)
hl.bind("Print", hl.dsp.exec_cmd("rishot"))        # Hyprland (lua)
bindsym Print exec rishot                          # Sway

Run rishot for region, window, or the monitor under a desktop click, rishot monitor for a whole output. Add --clipboard to copy the shot without opening the editor, --raw to write the PNG to stdout, --text or --qr to copy and print the text or codes in it:

rishot --clipboard
rishot monitor --raw > shot.png
rishot --qr

All four exit 1 when the capture is cancelled or fails, --text and --qr also when the shot holds no text or code.

Dependencies

Required: quickshell (the qs binary), Qt 6 (declarative, svg, 5compat, wayland), wl-clipboard.

Optional: imagemagick (multi-monitor stitch), cliphist (clip history), curl (upload), kdialog (save dialog and folder picker), libnotify (a desktop notification when a shot is copied, saved or uploaded), tesseract plus a language pack (OCR; reads with every installed language), zbar (QR codes and barcodes).

On KDE: spectacle, which rishot captures through since KWin has no screencopy protocol. The installer pulls it in when it sees a KDE session.

Config file

The settings panel writes ~/.config/rishot/config.json (or $XDG_CONFIG_HOME/rishot/config.json). You can also edit it by hand while rishot is closed. A full file with the defaults:

{
  "mosaicFactor": 14,
  "blurRadius": 64,
  "zoomFactor": 2,
  "copyToDisk": false,
  "copyOnSave": false,
  "skipSaveDialog": false,
  "saveDir": "",
  "language": "",
  "toolStyle": {
    "rect": { "color": "#e0563b", "width": 4, "filled": false }
  }
}
  • mosaicFactor: pixelate block size, bigger is coarser
  • blurRadius: blur strength
  • zoomFactor: magnification of the zoom tool
  • copyToDisk: copy also keeps the shot in the save folder
  • copyOnSave: save also puts the shot on the clipboard
  • skipSaveDialog: save goes straight into the save folder without asking
  • saveDir: save folder; empty means $RISHOT_SAVEDIR, else Screenshots inside your Pictures folder
  • language: interface catalogue, en or es; empty follows the system locale and RISHOT_LANG
  • toolStyle: colour, width (1 to 20) and fill per tool. Tool ids: rect, ellipse, line, arrow, pen, marker, step, text. filled only affects rect and ellipse; the marker always draws yellow, so only its width counts. A tool without an entry starts at #e0563b, width 4, outline.
Environment variables
  • RISHOT_CONFIG_DIR: the Quickshell config dir (the one holding shell.qml)
  • RISHOT_LANG: force the interface language (en, es) for the overlay and the CLI messages; the settings panel choice overrides it inside the app
  • RISHOT_SAVEDIR: the auto-save directory
  • RISHOT_CAPTURE: force the capture backend, screencopy or image (otherwise picked per compositor)
  • RISHOT_UPLOAD: the upload endpoint (curl form-post target)
  • RISHOT_KEYBIND_FILE: file the rebind line is written into, taken as given (written verbatim, so point it at a dedicated include file)

Rebinding from the settings panel on Hyprland writes a matching conf or lua line into its own include file, never your main config.

Upload

Upload posts to litterbox.catbox.moe by default. The link it returns is unguessable but public, and it expires after 72 hours. When imagemagick is present rishot strips image metadata before sending. Set RISHOT_UPLOAD to use your own host. For anything sensitive, copy or save instead.

Notes

Toolbar icon centring needs Qt 6.10 or newer. On older Qt the icons box-centre, a touch off, but everything works.


MIT  ·  built with Quickshell  ·  from Ricelin

About

Wayland screenshot + annotation overlay built on Quickshell

Resources

Stars

143 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages