Skip to content

A tool on Linux that lets you upload images to e-z, with extra features built in!

Notifications You must be signed in to change notification settings

RobinTT69/e-z-screenshot-linux

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dependencies

Dependencies are automatically installed by your AUR Helper on Arch Linux.

  • Python
  • Python-requests
  • xclip
  • Flameshot (Optional, but recommended)
  • Grim (Optional if Flameshot is installed)
  • Slurp (If using grim)
  • Slop (If using X11 without Flameshot)

Depending on your operating system, you may need to install the requests module for python differently.

With PIP

pip install requests

or

pip3 install requests

With Pacman

sudo pacman -S python-requests

Dependencies

Arch Linux Based Systems

sudo pacman -S grim jq slurp xclip flameshot slop

Debian/Ubuntu Based Systems

sudo apt install grim jq slurp xclip flameshot slop

Fedora Based Systems

sudo dnf install grim jq slurp xclip flameshot slop

Gentoo Based Systems

sudo emerge -av gui-apps/grim gui-apps/slurp app-misc/jq xclip flameshot slop
Arch installation via the AUR

Paru

paru -S e-zshot

Yay

yay -S e-zshot

Clone with git and build manually

git clone https://aur.archlinux.org/e-zshot.git
cd e-zshot
makepkg -si
cd ..
rm -rf e-zshot
For non-arch distros
git clone https://github.com/RobinTT69/e-z-screenshot-linux
cd e-z-screenshot-linux
chmod +x ./e-zconfig.sh
chmod +x ./e-zshot.py

Configuration and usage

If installed via AUR, enter the command

e-zconfig

and follow the interactive prompts.

Otherwise

cd e-z-screenshot-linux
./e-zconfig.sh

e-zshot is now done being configured, and you can run it

./e-zshot.py

By default, e-zshot is not installed to your binaries directory. You can do this manually at your own risk, but we do not recommend it if you don't know what you're doing.

Arguments

  • -h, --help: List all options and usage
  • -s, --save-to-disk: Save the screenshot to the specified path
  • -f, --full-screen: Capture full screen instead of a selected area
  • -v, --verbose: Enable verbose logging for debugging
  • -t, --top-text: Text to display at the top of the screenshot (e.g. -t 'Hello')
  • -b, --bottom-text: Text to display at the bottom of the screenshot (e.g. -b 'World!')
  • -c, --colour: Choose text colour (e.g. -c black or -c #000000)

Understanding your configuration

You may have gotten a little curious and taken a look at your config.json file, only to be confused. Don't worry, we'll break it down for you!

config.json

{
	"api_key": "your-api-key",
	"domain": "your-domain.gg",
	"image_type": "png",
	"compression_level": "4",
	"save_to_disk": "",
	"upload_to_api": "",
	"verbose": "",
	"screenshot_tool": "flameshot"
  }
  • API Key - Self explanatory. Refer to the section below if unsure.
  • Domain - The domain you would like your screenshot to be linked to.
  • Image Type - Also fairly self explanatory. JPG/PNG/Webp
  • Compression Level - When using Grim with PNGs, it applies a certain amount of compression. This can be either disabled, lowered or increased by changing this value. Values 0-9 are acceptable.
  • Save To Disk - Saves your screenshot to your device. Defaults to ~/Pictures/Screenshots but can be edited.
  • Verbose - Enables verbose output, useful for diagnosing issues with the program. Don't use this unless you have problems.
  • Screenshot Tool - Which program you'd like to use in order to capture screenshots. Flameshot, Grim and Gnome-Screenshot.

If you have any more questions, contact keirandev or RobinTT on Discord.

Locating your API Key

  • Go to Account Settings

    Account Settings

  • Click 'Copy API Key'

    Copy API Key

Using your own custom domain (optional)

Replace "cdn" with your desired subdomain:

Domain Setup On Cloudflare (Redirect Rule)

Redirect Rule

Set up a DNS record for your subdomain:

DNS Record

Troubleshooting

  • It doesn't embed the images!

    Ensure "Preserve query string" is enabled in Cloudflare and purge all caches.

  • I need to change my domain or API key!

    Run e-zconfig with your updated credentials or domain..

Credits

Credits to KeiranScript for contributing and adding custom domain functionality.

Oliver

oliver

About

A tool on Linux that lets you upload images to e-z, with extra features built in!

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •