tryone144 / compton

A compositor for X11.
Other
615 stars 236 forks source link

Compton

Join the chat at https://gitter.im/chjj/compton

Compton is a compositor for X, and a fork of xcompmgr-dana.

This branch includes a new blur method: The multi-pass dual_kawase blur! Use it with the --blur-method dual_kawase and --blur-strength LEVEL options. Only works with the glx backend!

Deprecation Notice

This fork contains more of a proof-of-concept than a polished implementation of the dual-filter kawase blur. As you may have noticed, the development on compton seems to have halted. picom is a compton-fork that is actively maintained and has superseeded compton in most distributions already. As of Aug, 31st 2020, picom comes with a better optimized and polished implementation of the dual-filter kawase blur, that will be part of the next regular release (v9).

This fork will most likely not receive any future improvements or fixes. I strongly suggest you give picom a try, unless you absolutely have to use compton.


I was frustrated by the low amount of standalone lightweight compositors. Compton was forked from Dana Jansens' fork of xcompmgr and refactored. I fixed whatever bug I found, and added features I wanted. Things seem stable, but don't quote me on it. I will most likely be actively working on this until I get the features I want. This is also a learning experience for me. That is, I'm partially doing this out of a desire to learn Xlib.

Changes from xcompmgr:

Fixes from the original xcompmgr:

Building

Dependencies:

B for build-time

R for runtime

How to build

To build, make sure you have the dependencies above:

# Make the main program
$ make
# Make the man pages
$ make docs
# Install
$ make install

(Compton does include a _CMakeLists.txt in the tree, but we haven't decided whether we should switch to CMake yet. The Makefile is fully usable right now.)

Known issues

Usage

Please refer to the Asciidoc man pages (man/compton.1.asciidoc & man/compton-trans.1.asciidoc) for more details and examples.

Note a sample configuration file compton.sample.conf is included in the repository.

Support

License

Although compton has kind of taken on a life of its own, it was originally an xcompmgr fork. xcompmgr has gotten around. As far as I can tell, the lineage for this particular tree is something like:

Not counting the tens of people who forked it in between.

Compton is distributed under MIT license, as far as I (richardgv) know. See LICENSE for more info.