8000 GitHub - greyxp1/vellum: Wayland native screen annotation tool · GitHub
[go: up one dir, main page]

Skip to content
greyxp1Public

About

Wayland native screen annotation tool

Resources

Stars

56 stars

Watchers

1 watching

Forks

Latest commit

 

History

255 Commits

Folders and files

Repository files navigation

Vellum

Vellum is a small native Wayland overlay for drawing directly over the live desktop.

image

Vellum began as a fork of Chameleos by Thomas Lindae.

Compatibility

Vellum requires a Wayland compositor that implements wlr-layer-shell. This includes niri, Sway, Hyprland, river, Wayfire, labwc, KDE Plasma, and COSMIC, though niri is the only compositor currently tested.

Installation

NixOS

For released versions, use the NixOS module from nixpkgs.

For Vellum main, use the flake module:

{
  imports = [inputs.vellum.nixosModules.default];

  # Optionally add cache settings for pre-built binaries.
  nix.settings = {
    extra-substituters = ["https://greyxp1.cachix.org"];
    extra-trusted-public-keys = ["greyxp1.cachix.org-1:hUnQC8sjfKykPgkFdcXiuv4xjiISuWnBnPfW2F2df3k="];
  };

  services.vellum = {
    enable = true;
    # Reduce driver memory use on NVIDIA. Disables software fallback.
    # graphicsDriver = "nvidia";
  };
}

From source

Install the dependencies for your distribution:

Arch dependencies
sudo pacman -S --needed base-devel git rust wayland libxkbcommon fontconfig mesa vulkan-icd-loader
Debian 13+ dependencies
sudo apt install build-essential git pkg-config rustup libwayland-dev libxkbcommon-dev libfontconfig-dev libgbm-dev libvulkan1
rustup default stable
Fedora dependencies
sudo dnf install cargo gcc git pkgconf-pkg-config wayland-devel libxkbcommon-devel fontconfig-devel mesa-libgbm-devel vulkan-loader

Build and install to ~/.local:

git clone https://github.com/greyxp1/vellum
cd vellum
cargo xtask install

Usage

Run vellum & and bind vellum toggle to a compositor shortcut. For example, in niri:

Mod+A { spawn "vellum" "toggle"; }
Running as a systemd user service

Save this as ~/.config/systemd/user/vellum.service:

[Unit]
Description=Vellum screen annotation overlay
After=graphical-session.target
PartOf=graphical-session.target

[Service]
Type=exec
ExecStart=%h/.local/bin/vellum
Restart=on-failure

[Install]
WantedBy=graphical-session.target

Enable the service:

systemctl --user enable --now vellum.service

About

Wayland native screen annotation tool

Resources

Stars

56 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages

0