Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sculx

stands for screenshot utility linux

These are just simple screenshot scripts for use in terminal emulators or keybinds.

Features

  • Taking screenshots
  • Uploading screenshots to web services
  • Getting notified after screenshot uploads
  • Playing a different sound when the upload succeeded or failed

Installation

Use the quick installtion script inside the main directory:

curl -s https://raw.githubusercontent.com/Noki77/sculx/master/quicksetup.sh | sh

Usage

You can simply create fullscreen screenshots by typing

screenshot

or screenshots of the current active window by typing

screenshot -w

or screenshots where you select the region by yourself

screenshot -a
# or 'screenshot -r', 'screenshot -region', 'screenshot -area', etc.

Configuration

File: <configuration directory>/sculx.conf.sh

You can configure the following variables:

  • SCREENSHOT_DIR: directory uesd to store screenshots
  • SCREENSHOT_NAME: screenshot naming format
  • ACTIVE_UPLOAD_PROFILE: the upload profile used
  • ACTIVE_PROGRAM_PROFILE: the program profile used
  • USER_AGENT: the user agent curl uses when uploading data
  • MPG123_SCALE: the mpg123 scale parameter, used to control sound volume (the higher value you assign, the louder the sounds will be played; up to 32768)

Creating profiles

Profiles are stored inside <configuration directory>/profiles.d and written in bash.

You can create profiles for either your screenshot utilities, or your upload service.

Upload profiles

Directory: <configuration directory>/profiles.d/upload

You can configure the following variables (italic means optional)

  • UPLOAD_DEST: the exact URL for uploading files (images)
  • UPLOAD_PARAMS (array): form attribtues sent by curl
  • UPLOAD_HEADERS (array): headers sent by curl (as ex. for authentication)
  • REQ_METHOD: request method, depends on the api used

Program profiles

Directory: <configuration directory>/profiles.d/program

You can configure the following variables

  • SCR_COMMAND: command used to take screenshots (use $1 for the file path)
  • SCR_FLAG_WINDOW: the window flag
  • SCR_FLAG_AREA: the area flag
  • SCR_FLAG_FULL: flag for fullscreen screenshots The flags depend on the screenshot tool which you wish to use. You can leave them empty, if the program has no flag or uses it as default, when no flags are given (as ex. fullscreen screenshots)

About

Screenshot and upload utilities for linux

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages