FramR

Screenshot, annotate, record, upload.

Demo - Install - Quick start - Uploaders

FramR is a screenshot and screen-recording tool for Wayland, written in Rust.

Works on wlroots/scenefx compositors (Hyprland, Sway, River, ...) and KDE Plasma on Wayland.

Demo

framr_showcase.mp4

Area selection, annotations, recording, and uploads.

Features

• Capture your screen, monitor (-s) or area (-a).

• Annotate your images before it is even captured, with abilities for: blurring, pixelating, drawing and more.

• Record your entire screen, monitor or area, running it again will stop the recording with support for --duration.

• Upload images using any ShareX/iShare compatiable uploader, nest.rip is recommended.

Quick start

framr -a                    # select an area, annotate, save
framr -a -c                 # select an area, copy to clipboard
framr -a -c -o ~/Pictures   # select an area, save it there and copy it
framr -l                    # re-take last selected region
framr -s 0                  # shoot monitor 0
framr -r                    # record a region (run again to stop)
framr -s 0 -r               # record monitor 0
framr -s 0 -r --duration 10 # record monitor 0 for 10 seconds
framr --delay 3 -o -        # wait 3 seconds, write the PNG to stdout
framr -a -u                 # select, then upload with your default uploader
framr config                # interactive setup wizard

Installation

Arch Linux (AUR)

yay -S framr    # or framr-bin for the pre-built binary

Nix

nix profile add github:vMohammad24/framr

Pre-built binaries exist over at framr.cachix.org:

nix.settings = {
  extra-substituters = [ "https://framr.cachix.org" ];
  extra-trusted-public-keys = [ "framr.cachix.org-1:Nn6BXpOrE0I1sO89xW8l2WVcf2FD4UqU6PD30sgRLZk=" ];
};

Home Manager

# flake.nix
{
  inputs.framr.url = "github:vMohammad24/framr";

  outputs = { framr, ... }: {
    homeConfigurations."user" = home-manager.lib.homeManagerConfiguration {
      modules = [
        framr.homeManagerModules.default
        {
          programs.framr = {
            enable = true;
            settings = {
              default_action = "UploadAndCopy";
              default_capture = "Area";
              default_uploader = "nest.rip";
              # selectively silence notifications. --silent overrides this.
              silent = {
                image = false;
                video = true;
                upload = false;
                error = false;
              };
              uploaders = [
                {
                  name = "nest.rip";
                  request_method = "POST";
                  request_url = "https://nest.rip/api/files/upload";
                  body_type = "FormData";
                  file_form_name = "files";
                  output_url = "{json:fileURL}";
                  error_message = "{json:message}";
                  headers = [ [ "authorization" "your_api_key" ] ]; # supports `file:/path/to/file`
                }
              ];
            };
          };
        }
      ];
    };
  };
}

Gentoo (community-maintained)

eselect repository add roxy-overlay git https://codeberg.org/key/roxy-overlay.git
eselect repository enable roxy-overlay
emaint sync -r roxy-overlay
emerge media-gfx/framr

Cargo

cargo install --git https://github.com/vMohammad24/framr.git

Pre-built binary

Linux x86_64 binaries, .deb and .rpm packages on the Releases page.

Dependencies

Building or running the raw binary needs: wayland, libxkbcommon, cairo, pango, dbus, libxcursor, FFmpeg, PipeWire, ALSA, GBM, and DRM. Package manager installs pull these in automatically.

Uploaders & deeplinks

Bring your existing ShareX/iShare host config:

framr config import my-host.sxcu                    # from a file
framr config import https://example.com/host.sxcu   # from a URL

Or if you own a host, one-click imports via framr:// deeplinks: either a direct link to a config or the config itself, base64-encoded.

• framr://https://example.com/uploader.sxcu
• framr://eyJOYW1lIjogIk15IFVwbG9hZGVyIiwgLi4ufQ==

Register the protocol handler (done automatically on NixOS/Home Manager and AUR installations, required on KDE):

framr config protocol

Tip

On KDE Plasma, framr config protocol also authorizes FramR so it is able to capture screenshots and recordings. Run it once and re-login (or update your desktop database).

Contributing

Want to report a bug or implement a new feature? Open an issue or a pull request.

License

GNU AGPL-3.0. See the LICENSE file.

Credits

• wayshot: inspiration for some code snippets.