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: 2 months 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 (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-17T22:19:34.000Z (over 1 year ago)
- Last Synced: 2025-01-02T23:27:36.293Z (over 1 year 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 screenshot tool for UNIX-like systems running on X11 or Wayland.
## Requirements and download
### Core requirements:
- UNIX-like system that can run X11 or Wayland (such as Linux-based systems, FreeBSD, OpenBSD, etc)
- Java 11 or newer
- [FFmpeg](https://ffmpeg.org/)
### Additional requirements for X11 users:
- xclip (optional, for copying the screenshot to clipboard)
- xwininfo (optional, for window capture)
### Additional requirements for Wayland users:
- grim
- slurp (optional, for capturing a selection of the screen)
- wl-clipboard (optional, for copying the screenshot to clipboard)
Install the necessary and desired dependencies from your Linux system's package manager and download Aya's [latest release](https://github.com/spacebanana420/aya/releases) here.
Note: Wayland support is currently only tested in wl-roots compositors and Hyprland, it's not guaranteed to work on other environments. GUI mode only supports x11, so using it in wayland might result in a blurry, glitchy or pixelated interface and requires xwayland.
## How to use
Once downloaded, you can run Aya with the command `java -jar aya.jar`.
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
* BMP
## Build from source
Building Aya requires my own build tool [Yuuka](https://github.com/spacebanana420/yuuka).
The command `yuuka` as seen below applies if you have it installed system-wide. If you do not, then replace `yuuka` with `java -jar yuuka.jar`.
### Getting the source code
```
git clone https://github.com/spacebanana420/aya.git
cd aya
```
### Building a JAR file
```
yuuka package
```
### Installing Aya system-wide (run as root)
This installs Aya in /usr/local/bin so it can be accessed from anywhere by running `aya`.
```
yuuka install
```
### Build separate .class files
If for some reason you don't want Aya built as a JAR and you want to have the raw bytecode:
```
yuuka build
```