https://github.com/Kirottu/watershot

A simple wayland native screenshot tool.
https://github.com/Kirottu/watershot

Last synced: 6 days ago
JSON representation

A simple wayland native screenshot tool.

• Host: GitHub
• URL: https://github.com/Kirottu/watershot
• Owner: Kirottu
• License: gpl-3.0
• Created: 2022-12-23T07:24:27.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-28T09:25:00.000Z (4 months ago)
• Last Synced: 2024-08-02T07:23:05.586Z (3 months ago)
• Language: Rust
• Homepage:
• Size: 174 KB
• Stars: 170
• Watchers: 3
• Forks: 15
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hyprland - Watershot

README

        
# Watershot

A simple wayland native screenshot tool inspired by [Flameshot](https://flameshot.org/).

## Packages

On an Arch based distro, you can simply install the AUR package [watershot](https://aur.archlinux.org/packages/watershot),

or [watershot-git](https://aur.archlinux.org/packages/watershot-git) for the latest git version.

This project is a flake! If you have Nix, you know what to do.

## Manual installation

### Dependencies

Some of the cargo packages rely on system dependencies. For Nix based systems

this is handled with flake.nix, but other systems may need to manually install:

- fontconfig

- pkgconfig

- libxkbcommon

### Installation

Simply clone the repository and install the program locally with cargo. You will

need to have [grim](https://sr.ht/~emersion/grim/), if it is in a non-standard

location you can use `--grim` or `-g` argument to set a custom path. A

compositor that implements layer-shell is also a requirement.

```

git clone https://github.com/Kirottu/watershot

cd watershot

cargo install --path .

```

## Usage

Just run the executable. Do note that without any arguments, the screenshots are

not saved/copied anywhere.

```

Commands:

  path       The path to save the image to

  directory  The directory to save the image to with a generated name

  help       Print this message or the help of the given subcommand(s)

Options:

  -c, --copy         Copy the screenshot after exit

  -s, --stdout       Output the screenshot into stdout in PNG format

  -g, --grim   Path to the `grim` executable

  -h, --help         Print help

  -V, --version      Print version

```

## Configuration

Watershot supports configuration of colors, fonts, sizes, etc. via it's config

file. The config file is saved in `~/.config/watershot.ron` and uses the ron

config format.

Here is an example config for it:

```

Config(

    handle_radius: 10,

    line_width: 2,

    display_highlight_width: 5,

    selection_color: Color(

        r: 0.38,

        g: 0.68,

        b: 0.94,

        a: 1.0,

    ),

    shade_color: Color(

        r: 0.11,

        g: 0.0,

        b: 0.11,

        a: 0.6,

    ),

    text_color: Color(

        r: 1.0,

        g: 1.0,

        b: 1.0,

        a: 1.0,

    ),

    mode_text_size: 50,

    font_family: "monospace",

)

```