README.md

KittyBack

A lightweight ZSH plugin to automatically update and modify the background image of the Kitty terminal emulator from a specified image.

To put it simply, this ZSH plugin is for people who love to change wallpapers per month or weak. However, background images in terminal emulators might cause troubles due to low contrast. Thus we are forced to darken the image or use a monotone color scheme for the image. And well, this plugin essentially helps to make it easy and fast using CLI, if this option is prefered.

Features

• modifies the resolution, brightness, and color scheme of the background image
• changes the background image in the current session via kitty's remote control
• saves the background image via background.conf included in kitty.conf for more efficient and clean image loading during the initialization of a new kitty instance

Installation

You'll need to install Image Magick beforehand.

sudo apt install ImageMagick

Using a Plugin Manager

Zinit

zinit light pickle-slime/kittyback

Create a new kitty instance (reload the terminal) for loading the background.conf.

Oh My Zsh

Clone into the custom plugins directory:

git clone https://github.com/pickle-slime/kittyback ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/kittyback

Then add kitty-bg-switcher to your plugin list in .zshrc:

plugins=(git kittybask)

And source the .zshrc file

source ~/.zshrc

Create a new kitty instance (reload the terminal) for loading the background.conf.

Manual Installation

git clone https://github.com/pickle-slime/kittyback ~/.kittyback

Add this line to .zshrc file.

source ~/.kittyback/kittyback.plugin.zsh

And source the .zshrc file

source ~/.zshrc

Create a new kitty instance (reload the terminal) for loading the background.conf.

Usage

To load image to buffer.

kittyback path/to/image

To preview the image in the terminal.

kittyback preview

To disable the preview.

kittyback disable_preview

To reset all changes on the image.

kittyback reset

To apply changes.

kittyback apply

Image Modifiers

Darken the image (expects a percentage as an argument):

kittyback -d 20
kittyback --darken 20

Shift RGB colors (expects a float; values below 1 darken, above 1 lighten):

kittyback -s 0.2
kittyback --shift_rgb

Discolor the image (converts to grayscale and overlays a tint):

kittyback -c '#1e1e1e'
kittyback --discolor '#1e1e11e'

Pixelize the image (expects a percentage; lower values increase pixelation):

kittyback -p 80
kittyback --pixilize 80

Usage Example

Upload an image and preview it right in the terminal.

kittyback ~/Downloads/thumb-1920-1348376.png
kittyback preview

Use the default flag in order to adjust the image.

kittyback -D
kittyback preview

Requirements

• Kitty terminal emulator
• Zsh (Bourne Again Shell)

License

• MIT License