https://github.com/spacebanana420/aya

Command-line screenshotter for Unix-like systems
https://github.com/spacebanana420/aya

bsd cli ffmpeg imagemagick linux screenshot screenshotter unix wrapper

Last synced: 13 days ago
JSON representation

Command-line screenshotter for Unix-like systems

• Host: GitHub
• URL: https://github.com/spacebanana420/aya
• Owner: spacebanana420
• License: mit
• Created: 2024-11-05T14:13:28.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-17T22:19:34.000Z (about 2 months ago)
• Last Synced: 2024-12-22T02:50:30.511Z (25 days ago)
• Topics: bsd, cli, ffmpeg, imagemagick, linux, screenshot, screenshotter, unix, wrapper
• Language: Java
• Homepage:
• Size: 1.77 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Aya

Aya is a command-line screenshotter tool for Unix-based systems that run on X11 environments such as Linux systems, FreeBSD, OpenBSD and others.

# Requirements and download

### Requirements:

- Unix-like system that can run a graphical X11 desktop (such as Linux-based systems, FreeBSD, OpenBSD, etc)

- Java 11 or newer

- [FFmpeg](https://ffmpeg.org/) **or** [ImageMagick](https://imagemagick.org/)

- Xwininfo (optional, for window capture) 

Download Aya's [latest release](https://github.com/spacebanana420/aya/releases) here.

Note: ImageMagick support is secondary and lacks some features/support compared to FFmpeg.

# How to use

Once downloaded, you can run Aya with the command `java -jar aya.jar`. Simply running Aya will make it take an immediate screenshot (unless your system is unsupported).

To see a full list of options, run `java -jar aya.jar -h`.

Aya also makes use of a configuration file, located in `~/.config/aya/aya.conf`. This config overrides Aya's default behavior, but any CLI argument you pass to it will also override the respective config's settings.

### Supported image formats

* PNG

* JPG

* AVIF (FFmpeg only)

# Build from source

Download [Yuuka](https://github.com/spacebanana420/yuuka), open a terminal at the root of the project and run:

```

yuuka package

```

Or if you don't have Yuuka installed:

```

java -jar yuuka.jar package

```