Skip to content

Latest commit

 

History

History
83 lines (61 loc) · 2.02 KB

README.md

File metadata and controls

83 lines (61 loc) · 2.02 KB
Raw

Aestuarium

Yet another wayland wallpaper manager using openGL.
Disclaimer: Aestuarium is still in early stages of development.

Why another tool for background in wayland?

Because all other tools for background didn't have the features I needed and were not in their plans to implement such features.

Why the name "Aestuarium"

It is the latin for Estuary, I will leave the explanation to your imagination.

Usage

To set any wallpaper you need to first preload it

aestuarium --preload /absolute/path/to/file.png

To set the wallpaper you need to define the monitor (if no monitor is passed than it will fallback to first monitor found)

aestuarium -m monitor1 --preload /absolute/path/to/file.png

You can unload a specific preloaded file or all

aestuarium --unload all

For further help

aestuarium --help

Configuration

You can configure aestuarium by creating a config.ini file in the $XDG_CONFIG_DIRS/aestuarium/ folder or refer to known-folders if you are not in linux.

Config template:

[monitors]
monitor1=/absolute/path/to/file.png

[shaders]
# files should be inside the config folder
vertex=shader1.glsl
fragment=shader2.glsl

[animations]
# for animations to run infinitely
loop=true
# defaults to file frame duration
fps=15

Supported File Formats

The supported formats yet are:

  • BMP (Partial)
  • GIF
  • PAM
  • PBM
  • PCX (Partial)
  • PGM (Partial)
  • PNG (Partial)
  • PPM
  • QOI
  • TGA

Yes, it supports animations but your RAM might not like it.

Dependencies