Satty is a screenshot annotation tool inspired by Swappy and Flameshot.
Satty has been created to provide the following improvements over existing screenshot annotation tools:
- very simple and easy to understand toolset (like Swappy)
- fullscreen annotation mode and post shot cropping (like Flameshot)
- extremely smooth rendering thanks to HW acceleration (OpenGL)
- working on wlroots based compositors (Sway, Hyprland, River, ...)
- minimal, modern looking UI, thanks to GTK and Adwaita
- be a playground for new features (post window selection, post paint editing, ...)
Install
Thanks to our package maintainers, Satty is available for many distributions on Linux and BSD:
Specifics
| Distribution | Command | Note |
|---|---|---|
| Gentoo | emerge -av satty |
You need guru overlay (see wiki). Pending PR |
| Alpine Linux | apk add satty |
Available in Alpine Community |
Cargo
You can install satty via cargo install satty and cargo binstall satty, the latter requires cargo-binstall. In that case, no manpage, LICENSE file, .Desktop file are available. But you can use the --man and --license arguments to display either.
cargo install and cargo binstall methods install satty to $HOME/.cargo/bin. Using rustup and/or installing distribution packages for the Rust toolchain should normally add this to the user's path. How environment variables such as path are set depends on shell, distribution, compositor/desktop environment etc. It's not really possible to anticipate every possible combination from an application perspective.
Prebuilt Sources
You can download a prebuilt binary for x86-64 on the Satty Releases page.
Usage
Start by providing a filename or a screenshot via stdin and annotate using the available tools. Save to clipboard or file when finished. Tools and Interface have been kept simple.
All configuration is done either at the config file in XDG_CONFIG_DIR/.config/satty/config.toml or via the command line interface. In case both are specified, the command line options always override the configuration file.
Shortcuts
General
- Enter: as configured (see below), default: copy-to-clipboard (may be masked by active tool)
- Esc: as configured (see below), default: exit (may be masked by active tool)
- Shift+Delete reset (clear) experimental NEXTRELEASE
- Ctrl+C: Save to clipboard (may be masked by active tool)
- Ctrl+Shift+D or Ctrl+Shift+I: Open GTK inspector if not already opened
- Ctrl+S: Save to specified output file
- Ctrl+Shift+S: Save using file dialog 0.20.0. The dialog uses
output-filenameas initial filename/path when available and remembers the last selected folder. 0.21.0 - Ctrl+Alt+C: Copy last saved filepath to clipboard 0.20.1
- Ctrl+T: Toggle toolbars
- Ctrl+Y: Redo
- Ctrl+Z: Undo
- Alt+(Left/Right/Up/Down): Pan, also available with middle mouse button drag 0.20.1
Mouse:
- Ctrl+Wheel: Zoom in/out 0.22.0
- Middle: Pan
Touchpad: 0.22.0
- Pinch: Zoom (two finger)
- Ctrl+Scroll: Zoom in/out (two finger scroll)
- Scroll: Pan (two finger scroll)
Color Selection Shortcuts 0.20.1
1, 2, 3, …, 9, 0 — select nth color from the color palette
If out of range select custom color 0.21.0
Size Selection 0.22.0
In the bottom toolbar the size can be edited directly or by + and - buttons. Minimum is 0.1 and maximum to 99.99.
The bindings are:
- Mouse left-button, wheel and key up/down step size is 0.1
- Holding Shift will switch to 0.01 step size
- Holding Ctrl will switch to 1.0 step size
- Mouse middle-button and page up/page down step size is 1.0
- Mouse right-button jumps to minimum/maximum
- s focuses the annotation size factor input field
Tool Selection Shortcuts (configurable) 0.20.0
Default single-key shortcuts:
- p: Pointer tool
- c: Crop tool
- b: Brush tool
- i: Line tool
- z: Arrow tool
- r: Rectangle tool
- e: Ellipse tool
- t: Text tool
- m: Numbered Marker tool
- u: Blur tool
- g: Highlight tool
Tool Modifiers and Keys
Crop:
- Press Esc or Ctrl+right mouse0.22.0 experimental button while editing to reset crop altogether 0.21.0.
- Press Enter or Ctrl+left mouse0.22.0 experimental while editing to finish editing crop and keep the crop area active 0.21.0.
- Left click crop area when tool is active but not editing to resume editing0.21.0.
Arrow and line:
- Shift to make tool snap to 15° steps.
Rectangle, ellipse, blur 0.22.0 and highlight block mode0.22.0:
- Alt to center the tool around origin.
- Shift to make width and high uniform - results in square resp. circle.
- Hold both to combine them.
Text:
- Press Shift+Enter to insert line break.
- Combine Ctrl with Left or Right for word jump or Ctrl with Backspace or Delete for word delete.
- Press Enter or switch to another tool to accept input, press Escape to discard entered text.
- Home and End go to the start/end of current line or previous/next line if already on first/last character of line (automatic wrapping is not considered for this). Ctrl with Home/End jumps to start/end of text buffer.
- Up or Down to jump to previous/next line (if already on first/last line, it jumps to the start/end of text buffer). 0.20.1
- Combine Shift with other keys to select text (e.g.
Shift+Hometo select from start of line to cursor, Shift+Left to select characters before cursor, Ctrl+Shift+Left to select words before cursor,and so on) 0.20.1 - Double-click to select word under cursor.Triple-click to select all text. 0.20.1
- Ctrl+A to select all text. 0.20.1
- Ctrl+C to copy selected text to clipboard. 0.20.1
- Ctrl+X to cut selected text to clipboard. 0.20.1
- Ctrl+V to paste text from clipboard. 0.20.1
- Alt+Ctrl with Left or Right or Up or Down to move the text. Use Alt+Ctrl+Shift with arrow keys to nudge the text. 0.20.1
- Press Alt to cycle the text effect: none → inverted outline → contrast outline (black/white) → drop shadow. experimental 0.22.0
Marker:
- Hold Alt to get extra ring. 0.22.0
Highlight:
- Hold Ctrl to switch between block and freehand mode (default configurable, see below).
- Hold Shift in freehand mode for a straight 15° aligned line. Stop at some position and release and hold Shift again to achieve perfectly aligned turns.
Overwriting Keybindings NEXTRELEASE
Shortcuts can be overwritten in the config by
[keybinds] "BINDING" = "TOOL-OR-COMMAND"
Where BINDING follows the GTK syntax. This means modifiers are enclosed in angle brackets (e.g., <mod>) and keys are specified by name (for example, - must be written as minus).
Pressing any unbound key will print its name to the console.
Setting a binding to "none" will unbind it.
The defaults are listed in the config.toml.
Configuration File
# Satty Configuration file [general] # Start Satty in fullscreen mode fullscreen = false # fullscreen = true # since 0.20.1, this can be written like below. Current is just the current screen, all is all screens. This may depend on the compositor. #fullscreen = "all" #fullscreen = "current-screen" # resize initially (0.20.1) resize = { mode = "smart" } # resize = { mode = "size", width = 2000, height = 800 } # try to have the window float (0.20.1). This may depend on the compositor. floating-hack = true # Change to true to automatically copy to clipboard after every annotation change (0.21.0) auto-copy = false # Exit directly after copy/save action. 0.21.0: change to list of triggers # Note that exit-early-save-as was removed with 0.21.0. early-exit = ["all"] # is equivalent to both # early-exit = ["copy", "save", "save-as"] # early-exit = true # Draw corners of rectangles round if the value is greater than 0 (0 disables rounded corners) corner-roundness = 12 # Select the tool on startup [possible values: pointer, crop, line, arrow, rectangle, text, marker, blur, brush] initial-tool = "brush" # Configure the command to be called on copy, for example `wl-copy` copy-command = "wl-copy" # Increase or decrease the size of the annotations annotation-size-factor = 2 # Filename to use for saving action. Omit to disable saving to file. Might contain format specifiers: https://docs.rs/chrono/latest/chrono/format/strftime/index.html # starting with 0.20.0, can contain leading tilde (~) for home directory # starting with 0.21.0, save as uses this as initial filename/path when available output-filename = "/tmp/test-%Y-%m-%d_%H:%M:%S.png" # After copying the screenshot, save it to a file as well save-after-copy = false # Hide toolbars by default default-hide-toolbars = false # Experimental (since 0.20.0): whether window focus shows/hides toolbars. This does not affect initial state of toolbars, see default-hide-toolbars. focus-toggles-toolbars = false # Fill shapes by default (since 0.20.0) default-fill-shapes = false # Round caps for arrow and line tools default-round-caps = true # The primary highlighter to use, the other is accessible by holding CTRL at the start of a highlight [possible values: block, freehand] primary-highlighter = "block" # Disable notifications disable-notifications = false # Actions to trigger on right click (order is important) # [possible values: save-to-clipboard, save-to-file, save-to-file-as, copy-filepath-to-clipboard, exit] actions-on-right-click = [] # Actions to trigger on Enter key (order is important) # [possible values: save-to-clipboard, save-to-file, save-to-file-as, copy-filepath-to-clipboard, exit] actions-on-enter = ["save-to-clipboard"] # Actions to trigger on Escape key (order is important) # [possible values: save-to-clipboard, save-to-file, save-to-file-as, copy-filepath-to-clipboard, exit] actions-on-escape = ["exit"] # Action to perform when the Enter key is pressed [possible values: save-to-clipboard, save-to-file] # Deprecated: use actions-on-enter instead action-on-enter = "save-to-clipboard" # Right click to copy # Deprecated: use actions-on-right-click instead right-click-copy = false # request no window decoration. Please note that the compositor has the final say in this. At this point. requires xdg-decoration-unstable-v1. no-window-decoration = true # experimental feature: adjust history size for brush input smoothing (0: disabled, default: 0, try e.g. 5 or 10) brush-smooth-history-size = 10 # experimental feature (0.20.1): The pan step size to use when panning with arrow keys. pan-step-size = 50.0 # experimental feature (0.20.1): The zoom factor to use for the image. # 1.0 means no zooming. zoom-factor = 1.1 # experimental feature (0.20.1): The length to move the text when using arrow keys. defaults to 50.0 text-move-length = 50.0 # experimental feature (0.20.1): Scale factor on the input image when it was taken (e.g. DPI scale on the monitor it was recorded from). # This may be more useful to set via the command line. # Note, before 0.21.0 this is ignored with explicit resize. input-scale = 1.0 # experimental feature (0.21.0): set window title title = "Satty" # experimental feature (0.21.0): set app_id, note this has to match D-Bus well-known name format, otherwise GTK does not accept it. app-id = "org.satty.satty" # experimental feature (0.22.0): show thumbnail as notifcation icon # notification-thumbnail = "app-icon" notification-thumbnail = "screenshot" # Generic keyboard shortcuts (NEXTRELEASE) [keybinds] # "<Control>q" = "run-actions-on-escape" # additionally to Escape # "i" = "none" # unbind "i" default for line # "l" = "line" # Global "<Shift><Control>d" = "open-gtk-inspector" "<Shift><Control>i" = "open-gtk-inspector" "<Alt>Left" = "pan-left" "<Alt>Right" = "pan-right" "<Alt>Up" = "pan-up" "<Alt>Down" = "pan-down" "Delete" = "delete-selection" "Escape" = "run-actions-on-escape" "Return" = "run-actions-on-enter" "<Control>t" = "toggle-toolbars" # scale is in %, 0 is fit to window "<Alt>2" = "scale:50" "<Alt>3" = "scale:33" "<Alt>4" = "scale:25" "<Control>2" = "scale:200" "<Control>3" = "scale:300" "<Control>4" = "scale:400" # top toolbar "<Alt>1" = "scale:100" "<Control>1" = "scale:0" "<Shift>Delete" = "clear-all" "<Control>z" = "undo" "<Control>y" = "redo" "p" = "pointer" "c" = "crop" "b" = "brush" "i" = "line" "z" = "arrow" "r" = "rectangle" "e" = "ellipse" "t" = "text" "m" = "marker" "u" = "blur" "g" = "highlight" "<Control>s" = "save-to-file" "<Shift><Control>s" = "save-to-file-as" "<Control>c" = "save-to-clipboard" "<Shift><Control>c" = "copy-filepath-to-clipboard" # bottom toolbar "1" = "select-color-index:1" "2" = "select-color-index:2" "3" = "select-color-index:3" "4" = "select-color-index:4" "5" = "select-color-index:5" "6" = "select-color-index:6" "7" = "select-color-index:7" "8" = "select-color-index:8" "9" = "select-color-index:9" "minus" = "cycle-size" #"..." = "select-size:(small|medium|large)" "s" = "focus-annotation-size-factor" "f" = "toggle-fill" "k" = "toggle-round-caps" # Font to use for text annotations [font] family = "Roboto" style = "Regular" # specify fallback fonts (0.20.1) # Please note, there is no default setting for these and the fonts listed below # are not shipped with Satty but need to be available on the system. # An installed color emoji font (e.g. Noto Color Emoji) is picked up automatically # as the last fallback, so emoji render without extra configuration. (0.22.0) fallback = [ "Noto Sans CJK SC", # "Noto Sans CJK JP", # "Noto Sans CJK TC", # "Noto Sans CJK KR", # "Noto Serif CJK JP", # "Noto Serif JP", # "IPAGothic", # "IPAexGothic", # "Source Han Sans", # add or remove as needed - more fonts may make satty slower ] # Custom colours for the colour palette [color-palette] # These will be shown in the toolbar for quick selection palette = [ # RRGGBBAA format, where AA is the alpha channel # (00 is fully transparent, ff is fully opaque) "#f0932bff", "#eb4d4bff", "#6ab04cff", "#22a6b3ff", "#130f40FF", # add or remove as needed ] # These will be available in the color picker as presets # Leave empty to use GTK's default custom = [ # "#a52a2a", # "#ffd700", # "#008000", # add or remove as needed ]
