Skip to content
forked from rockyroed/xborders

Active window border replacement for window managers

License

Notifications You must be signed in to change notification settings

Ari-43/xborders

 
 

Repository files navigation

xborders

Active window border replacement for window managers with extra features:

  • Fading borders
  • Gradient borders
  • pip install support

This is a 3rd degree fork of deter0/xborder.

  1. deter0/xborder
  2. lunegh/xborders (missing)
  3. rockyroed/xborders
  4. Ari-43/xborders (this)

It includes code from the following other forks not in this lineage:

Usage

Install with pipx (recommended)

pipx install git+https://github.com/Ari-43/xborders
xborders --help

Or clone the repository

git clone https://github.com/Ari-43/xborders
cd xborders
pip install -r requirements.txt
chmod +x xborders
./xborders --help

Dependencies

Make sure to install dependencies first! pip install -r requirements.txt

Python dependencies

  • pycairo (Tested with version 1.27.0)
  • requests (Tested with version 2.32.3)
  • pygobject (Tested with version 3.50.0)
  • zc.lockfile (Tested with version 3.0.post1)

System dependencies

  • libwnck (Tested with version 40.1-1, Arch: sudo pacman -S libwnck3 Debian: sudo apt install libwnck-3-0 NOTE: may need 'libwnck-3-0-dev' for Debian)
  • gtk
  • a compositor that supports transparent windows (i.e. picom)

Manually installing Python dependencies is not required when installing with pipx.

Recommended Dependencies

  • libnotify (Debian: sudo apt install libnotify-bin Arch: sudo pacman -S libnotify)

Note for Picom

If you don't want your entire screen blurred, add the following to your picom.conf in the window rules section

rules = (
	{ role = "xborder";
		# Exempt xborder from background blur
		blur-background = false;
	},
	...
)

i3 w/ xborder rounded borders:

image

i3 w/ Picom rounded borders:

image

Config

Configuration options can be found by passing in the argument --help on the command line, or by specifying a config file with the argument -c. If no config file is specified with the -c argument, xborders will look for one at ~/.config/xborders/xborders.json. However, it will not create the file if it is missing.

The config file is just a simple json file with the keys being the same as the command-line arguments (except without the "--" at the beginning).

Updating

For pipx installations

pipx upgrade xborders

For manual installations

cd /path/to/xborders
git pull origin main
pip install -r requirements.txt

About

Active window border replacement for window managers

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 98.6%
  • Nix 1.4%