swayimg

Swayimg: image viewer for Wayland and DRM

Swayimg is a fully customizable image viewer with Lua scripting support.

• Support for the most popular image formats:
  • JPEG (via libjpeg),
  • JPEG XL (via libjxl);
  • JPEG 2000 (via OpenJPEG);
  • PNG (via libpng);
  • GIF (via giflib);
  • SVG (via librsvg);
  • WebP (via libwebp);
  • HEIF/HEIC (via libheif);
  • AV1F/AVIFS (via libavif);
  • TIFF (via libtiff);
  • Sixel (via libsixel);
  • Raw: CRW/CR2, NEF, RAF, etc (via libraw);
  • EXR (via OpenEXR);
  • BMP (built-in);
  • PNM (built-in);
  • TGA (built-in);
  • XBM (built-in);
  • QOI (built-in);
  • DICOM (built-in);
  • Farbfeld (built-in).
• Support for non-image previews:
  • Font: TTF/OTF/WOFF (via FreeType);
  • Video: preview in storyboard (via FFMpeg).
• Native support for Wayland and DRM output;
• Gallery and viewer modes with slideshow;
• Image animation support;
• EXIF, XMP and IPTC tags support;
• Loading images from files, pipes and external programs;
• Preload images in a separate thread;
• Support for the Sway and Hyprland window managers, including an overlay feature that simulates displaying an image in the currently active window (e.g. a terminal);
• Fully customizable keyboard bindings, colors, and many other parameters via Lua bindings.

Usage

swayimg [OPTIONS]... [FILE]...

Examples:

• View multiple files:

  swayimg photo.jpg logo.png
  

• View using pipes:

  wget -qO- https://www.kernel.org/theme/images/logos/tux.png | swayimg -
  

• Loading stdout from external commands:

  swayimg "exec://wget -qO- https://www.kernel.org/theme/images/logos/tux.png" \
          "exec://curl -so- https://www.kernel.org/theme/images/logos/tux.png"
  

See full documentation for details.

Configuration

The Swayimg configuration file is a Lua script. The full list of available functions is described in the documentation and in the Lua source file. Some tips and trick can be found here.

Example of the configuration file is available after installation in /usr/share/swayimg/example.lua.

Install

List of supported distributives can be found on the Repology page.

Arch users can install the program from the extra repository or from AUR package.

Build

The project uses Meson build system:

meson setup my_build_dir
meson compile -C my_build_dir
meson install -C my_build_dir