Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Gustash/Hyprshot
Hyprshot is an utility to easily take screenshots in Hyprland using your mouse.
https://github.com/Gustash/Hyprshot
Last synced: 2 months ago
JSON representation
Hyprshot is an utility to easily take screenshots in Hyprland using your mouse.
- Host: GitHub
- URL: https://github.com/Gustash/Hyprshot
- Owner: Gustash
- License: gpl-3.0
- Created: 2022-11-09T21:28:54.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-29T13:54:51.000Z (6 months ago)
- Last Synced: 2024-10-30T16:03:23.555Z (2 months ago)
- Language: Shell
- Homepage:
- Size: 68.4 KB
- Stars: 358
- Watchers: 2
- Forks: 27
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hyprland - Hyprshot - like tool to make things easier) (Tools / Screenshotting)
README
# Hyprshot
[](https://aur.archlinux.org/packages/hyprshot)
[](https://aur.archlinux.org/packages/hyprshot-git)
[](https://github.com/Gustash/hyprshot/releases/latest)
Hyprshot is an utility to easily take screenshot in Hyprland using your mouse.
It allows taking screenshots of windows, regions and monitors which are saved to a folder of your choosing and copied to your clipboard.
## Installation
### ALT Sisyphus
```shell
# apt-get install hyprshot
```
### Arch Linux
You can install the [hyprshot](https://aur.archlinux.org/packages/hyprshot) package in AUR.
### Gentoo Linux
Activate wayland overlay as described in [README](https://github.com/bsd-ac/wayland-desktop#activate-overlay-via-eselect-repository), allow **~amd64** keyword and then install it:
```bash
# emerge --ask gui-apps/hyprshot
```
### Dependencies
- hyprland (this one should be obvious)
- jq (to parse and manipulate json)
- grim (to take the screenshot)
- slurp (to select what to screenshot)
- wl-clipboard (to copy screenshot to clipboard)
- libnotify (to get notified when a screenshot is saved)
### Optional Dependencies
- hyprpicker (to freeze the screen contents with the `--freeze` flag)
### Manual
To install manually, simply clone this repo and copy/symlink the `hyprshot` script to a folder in your `PATH`:
```bash
$ git clone https://github.com/Gustash/hyprshot.git Hyprshot
$ ln -s $(pwd)/Hyprshot/hyprshot $HOME/.local/bin
$ chmod +x Hyprshot/hyprshot
```
## Usage
You can get help on how to use hyprshot by executing:
```bash
$ hyprshot -h
```
The simplest usage of Hyprshot is executing it with one of the available modes.
For example, to screenshot an open window:
```bash
$ hyprshot -m window
```
You can also skip saving the screenshot to a file, copying it only to the clipboard:
```bash
$ hyprshot -m output --clipboard-only
```
## Configuration
You can add the various modes as keybindings in your Hyprland config like so:
```
# ~/.config/hypr/hyprland.conf
...
# Screenshot a window
bind = $mainMod, PRINT, exec, hyprshot -m window
# Screenshot a monitor
bind = , PRINT, exec, hyprshot -m output
# Screenshot a region
bind = $shiftMod, PRINT, exec, hyprshot -m region
```
This would allow you to:
Take a screenshot of a window by using `MOD + PrintScr`
Take a screenshot of a monitor by using `PrintScr`
Take a screenshot of a region by using `MOD + Shift + PrintScr`
## Save location
You can choose which directory Hyprshot will save screenshots in by setting an `HYPRSHOT_DIR` environment variable to your preferred location.
If `HYPRSHOT_DIR` is not set, Hyprshot will attempt to save to `XDG_PICTURES_DIR` and will further fallback to your home directory if this is also not available.