README.md

# Überzug++

Überzug++ is a command line utility written in C++ which allows to draw images on terminals by using X11/wayland child
windows, sixels, kitty and iterm2..

This project intends to be a drop-in replacement for the now defunct [ueberzug](https://github.com/seebye/ueberzug)
project. If some tool doesn't work,
feel free to open an issue.

Advantages over w3mimgdisplay and ueberzug:

- support for wayland: sway, hyprland and wayfire
- support for MacOS
- no race conditions as a new window is created to display images
- expose events will be processed, so images will be redrawn on switch workspaces
- tmux support on X11, sway and hyprland
- terminals without the WINDOWID environment variable are supported
- chars are used as position - and size unit
- No memory leak (usage of smart pointers)
- A lot of image formats supported (through opencv and libvips).
- GIF and animated WEBP support on X11, Sixel, Sway and hyprland
- Fast image downscaling (through opencv and opencl)
- Cache resized images for faster viewing

# Applications that support Überzug++

- [ytfzf](https://github.com/pystardust/ytfzf)
- [lobster](https://github.com/justchokingaround/lobster)
- [vifm](https://github.com/vifm/vifm)
- [rnvimr](https://github.com/kevinhwang91/rnvimr)
- [image.nvim](https://github.com/3rd/image.nvim)
- [yazi](https://github.com/sxyazi/yazi)
- [twitchez](https://github.com/WANDEX/twitchez)
- ÜberzugPP is a drop in replacement for Ueberzug, so applications that worked with ueberzug should work out of the box
  with this project.

# Integration scripts

- [lf](https://github.com/jstkdng/ueberzugpp/blob/master/scripts/lf/lfub)
- [fzf](https://github.com/jstkdng/ueberzugpp/blob/master/scripts/fzfub)

# Install

<a href="https://repology.org/project/ueberzugpp/versions"><img src="https://repology.org/badge/vertical-allrepos/ueberzugpp.svg" /></a>

### Homebrew (MacOS/Linux)

`brew install jstkdng/programs/ueberzugpp`

### Debian/Ubuntu/Fedora

Packages for x86_64, aarch64 and ppc64le are available in the following repository.

https://software.opensuse.org/download.html?project=home%3Ajustkidding&package=ueberzugpp

# Usage

1. Ueberzugpp provides two commands, `layer` and `tmux`. `layer` is used to send
   commands to ueberzugpp, `tmux` is used internally.

- Layer accepts the following options

```bash
$ ueberzug layer -h
Display images on the terminal.
Usage: ueberzug layer [OPTIONS]

Options:
  -h,--help                   Print this help message and exit
  -s,--silent                 Print stderr to /dev/null.
  --use-escape-codes [0]      Use escape codes to get terminal capabilities.
  --pid-file TEXT             Output file where to write the daemon PID.
  --no-stdin Needs: --pid-file
                              Do not listen on stdin for commands.
  --no-cache                  Disable caching of resized images.
  --no-opencv                 Do not use OpenCV, use Libvips instead.
  -o,--output TEXT:{x11,wayland,sixel,kitty,iterm2,chafa}
                              Image output method
  -p,--parser                 **UNUSED**, only present for backwards compatibility.
  -l,--loader                 **UNUSED**, only present for backwards compatibility.
```

2. You can also configure ueberzugpp with a json file. The file should be located
   on `$XDG_CONFIG_HOME/ueberzugpp/config.json`, in case XDG_CONFIG_HOME isn't set,
   ueberzugpp will look for the configuration at `~/.config/ueberzugpp/config.json`

Application flags have precedence over the configuration file.
The configuration file should have this format.

```json
{
  "layer": {
    "silent": true,
    "use-escape-codes": false,
    "no-stdin": false,
    "output": "sixel"
  }
}
```

The most helpful is the `output` variable as that can be used to force
ueberzugpp to output images with a particular method.

3. You can configure ueberzug++ directory for temporary files (logs, sockets)
   with `${UEBERZUGPP_TMPDIR}` environment variable (by default it is system temporary directory)

```sh
export UEBERZUGPP_TMPDIR="${TMPDIR}/ueberzugpp"
```

4. By default, commands are sent to ueberzug++ through stdin, this is enough in
   some cases. In some terminals and application combinations (e.g. ranger + wezterm + zellij)
   using stdin to send commands doesn't work properly or ueberzug++ could fail to
   start altogether. In those cases, the user may send commands to ueberzug++ through
   a unix socket. By default, ueberzug++ will listen to commands on `${UEBERZUGPP_TMPDIR}/ueberzugpp-${PID}.socket`.

New software is encouraged to use sockets instead of stdin as they cover more cases.

5. You can then feed Ueberzug with json objects to display an image or make it disappear.

- json object to display the image:

  ```json
  {"action":"add","identifier":"preview","max_height":0,"max_width":0,"path":"/path/image.ext","x":0,"y":0}
  ```

The number values are COLUMNS and LINES of your terminal window, in TMUX it's relative to the size of the panels.

- Don't display the image anymore:

  ```json
  {"action":"remove","identifier":"preview"}
  ```

# Build from source

This project uses C++20 features so you must use a recent compiler. GCC 10.1 is
the minimum supported version.

## Required dependencies

Must be installed in order to build.

- cmake ≥ 3.22
- libvips
- libsixel
- chafa ≥ 1.6
- openssl
- tbb

### Install dependencies on Ubuntu

```
apt-get install libssl-dev libvips-dev libsixel-dev libchafa-dev libtbb-dev
```

## Downloadable dependencies

Required for building, if they are not installed, they will be downloaded
and included in the binary.

- nlohmann-json
- cli11
- spdlog
- fmt
- range-v3

## Optional dependencies

Not required for building, can be disabled/enabled using flags.

- opencv
- xcb-util-image
- turbo-base64
- wayland (libwayland)
- wayland-protocols
- extra-cmake-modules

## Build instructions

1. Download and extract the latest release.

2. Choose feature flags

The following feature flags are available:

ENABLE_OPENCV (ON by default)

ENABLE_X11 (ON by default)

ENABLE_TURBOBASE64 (OFF by default)

ENABLE_WAYLAND (OFF by default)

You may use any of them when building the project, for example:

- Compile with default options

```sh
git clone https://github.com/jstkdng/ueberzugpp.git
cd ueberzugpp
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build .
```

- Disable X11 and OpenCV support

```sh
git clone https://github.com/jstkdng/ueberzugpp.git
cd ueberzugpp
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_X11=OFF -DENABLE_OPENCV=OFF ..
cmake --build .
```

- Enable support for Turbo-Base64

```sh
git clone https://github.com/jstkdng/ueberzugpp.git
cd ueberzugpp
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_TURBOBASE64=ON ..
cmake --build .
```

after running these commands the resulting binary is ready to be used.

- Install the resulting build directory to the default installation path (Optional)

```sh
cmake --install build
```

# Donate

If you like my work you can send some monero my way.

XMR Address: `8BRt2qYXjyR9Bb2CXtjVWSYNCepqgcZkheoMWTXTNmwLLU3ZEscuxtYFGaytSMNn1FETLdbdhXimCTTLSkN5r5j7SEBLMho`

# Thanks

Thank you jetbrains for providing licenses for this project.

[<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg">](https://jb.gg/OpenSourceSupport)