Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vellum

vellum is a small native Wayland overlay for drawing directly over the live desktop, tested on niri.

demo.mp4

Vellum began as a fork of Chameleos by Thomas Lindae.

Usage

Start the overlay once, then toggle drawing from a compositor shortcut:

vellum &
vellum toggle

For example, in niri:

Mod+A { spawn "vellum" "toggle"; }

Controls

Input Action
Left drag Draw or manipulate the selection
Hold right click Open the tool wheel
Release right click in the center Open the color wheel
Middle drag Erase annotations
Mouse wheel Change stroke width or text size
Ctrl + wheel Change opacity
Shift + wheel Change roundness
Ctrl + click in Select Add or remove an annotation from the selection
Double-click selected text Edit it
Ctrl+Z Undo
Ctrl+Shift+Z or Ctrl+Y Redo
Ctrl+A Select all annotations
Backspace or Delete Delete selected annotations
Escape Cancel, clear the selection, or leave drawing mode

Drag selection handles to reshape supported elements. While drawing, Shift constrains geometry and Alt draws rectangles and ellipses from their center.

Run vellum --help for startup options and commands. Packaged releases also provide man vellum with the same command-line reference.

Configuration

See Configuration for the available options, defaults, and file lookup order.

Home Manager

{
  imports = [inputs.vellum.homeModules.default];
  services.vellum.enable = true;
}

Building from source

Arch

sudo pacman -S --needed base-devel git rust wayland libxkbcommon libglvnd vulkan-icd-loader

Fedora

sudo dnf install cargo gcc git pkgconf-pkg-config wayland-devel libxkbcommon-devel libglvnd-egl vulkan-loader

Then build:

git clone https://github.com/greyxp1/vellum
cd vellum
cargo build --release --locked

With Nix, skip the system dependencies and run nix build, or use nix develop for a development shell.

About

Wayland native screen annotation tool

Resources

Stars

28 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages