Skip to content

Latest commit

 

History

History
111 lines (87 loc) · 6.35 KB

README.md

File metadata and controls

111 lines (87 loc) · 6.35 KB

VNREZ Tool VNREZ Logo

Make Recordings & Screenshots and upload them to your favorite file hosts on Linux, with support for region, GIF, and audio at ease.

Total Commits
Last commit



Dependencies

  • Screenshot: flameshot or grimblast (not package)
  • Wayland: jq, wl-clipboard, slurp & wf-recorder or wl-screenrec
  • COSMIC & GNOME / KDE Wayland: jq, wl-clipboard & kooha or io.github.seadve.Kooha
  • X11: jq, xclip, slop & ffmpeg
How to install them?

Go to your prefered terminal and execute this command depending on your Distro.

Compositor Distribution Instructions
Wayland Debian/Ubuntu sudo apt install wf-recorder jq wl-clipboard slurp or sudo apt install wl-screenrec jq wl-clipboard slurp
Wayland Fedora sudo dnf install wf-recorder jq wl-clipboard slurp or sudo dnf install wl-screenrec jq wl-clipboard slurp
Wayland Arch sudo pacman -S wf-recorder jq wl-clipboard slurp or sudo pacman -S wl-screenrec jq wl-clipboard slurp
Wayland Gentoo sudo emerge -av gui-apps/wf-recorder app-misc/jq x11-misc/wl-clipboard gui-apps/slurp or sudo emerge -av media-video/wl-screenrec app-misc/jq x11-misc/wl-clipboard gui-apps/slurp
Compositor Distribution Instructions
X11 Debian/Ubuntu sudo apt install ffmpeg jq xclip slop
X11 Fedora sudo apt install ffmpeg jq xclip slop
X11 Arch sudo pacman -S ffmpeg jq xclip slop
X11 Gentoo sudo emerge -av media-video/ffmpeg app-misc/jq x11-misc/xclip x11-misc/slop
Compositor Distribution Instructions
COSMIC & GNOME / KDE Wayland Debian/Ubuntu sudo apt install kooha jq wl-clipboard
COSMIC & GNOME / KDE Wayland Fedora sudo dnf install jq wl-clipboard and sudo flatpak install io.github.seadve.Kooha
COSMIC & GNOME / KDE Wayland Arch sudo pacman -S kooha jq wl-clipboard
COSMIC & GNOME / KDE Wayland Gentoo sudo emerge -av media-video/kooha app-misc/jq x11-misc/wl-clipboard

Installation

vnrez

git clone https://github.com/verysillycat/vnrez
cd vnrez
# [!] Start the Script to Create the Configuration file
./vnrez.sh
How to get my API KEY? Log in to Your Preferred File Host, Go to Account Settings, and Copy your API KEY
Now paste that API KEY when doing the initial setup.

Arguments

  • --help (-h) show the list of arguments
  • upload (-u) upload specified video files (mp4, mkv, webm, gif)
  • config open the configuration file in the default text editor
  • reinstall reinstall the configuration file with default settings
  • auto run with default settings without using a config file

Screenshot

case: shot

  • --gui select a region to screenshot
  • --full full screen screenshot of every monitor
  • --screen full screen screenshot

Recording

case: record

  • --abort abort recording and the upload
  • --sound snip with sound
  • --fullscreen full screen without sound
  • --fullscreen-sound fullscreen with sound
  • --gif snip with gif output
★ When using Kooha, you'll not see some of these arguments as they aren't needed.

Configuration

  • fps will be your Max FPS
  • pixelformat set the pixel format, default is yuv420p
  • encoder set the encoder, default is libx264
  • preset set the preset profile
  • wlscreenrec set to true if want to use wl-screenrec (only for wl-roots based DEs and recommend for old GPUs/iGPUs)
  • bitrate set the bitrate (only for wl-screenrec)
  • codec set the codec, default is hevc (only for wl-screenrec)
  • extpixelformat set the pixel format, default is nv12 (only for wl-screenrec)
  • crf set crf number
  • save will save your Recorded Videos on ~/Videos
  • failsave if your Video Recording upload fails, it will be saved on ~/Videos/e-zfailed
  • colorworkaround re-encode videos on upload for color correction, might take longer to upload
  • startnotif show the start notification or not
  • endnotif show the end notification or not
  • directory set directory to save videos in there will be ignored if using kooha
  • kooha_dir set the kooha directory also save videos in here if using kooha
  • grimshot set to true if want to use grimblast (hyprland only)
☆ When using Kooha, some of these arguments are unnecessary as they are not supported or required.

Credits

The record script is based on End's Dotfiles Record script but to support alot more DEs, Configuration, allow GIF Output & so much more.

The grimshot Screenshot script has some functions borrowed from Hyprland's grimblast to have freeze functionality.