Compton

This is a development branch, bug to be expected

This is forked from the original Compton because that seems to have become unmaintained.

The current battle plan of this fork is to refactor it to make the code possible to maintain, so potential contributors won't be scared away when they take a look at the code.

We also try to fix bugs.

The original README can be found here

Call for testers

--experimental-backends

This flag enables the refactored/partially rewritten backends.

Currently new backends features better vsync with the xrender backend, improved input lag with the glx backend (for non-NVIDIA users). The performance should be on par with the old backends.

New backend features will only be implemented on the new backends from now on, and the old backends will eventually be phased out after the new backends stabilizes.

To test the new backends, add the --experimental-backends flag to the command line you used to run compton. This flag is not available from the configuration file.

To report issues with the new backends, please state explicitly you are using the new backends in your report.

Change Log

See Releases

Build

Dependencies

Assuming you already have all the usual building tools installed (e.g. gcc, meson, ninja, etc.), you still need:

• libx11
• libx11-xcb
• libXext
• xproto
• xcb
• xcb-damage
• xcb-xfixes
• xcb-shape
• xcb-renderutil
• xcb-render
• xcb-randr
• xcb-composite
• xcb-image
• xcb-present
• xcb-xinerama
• pixman
• libdbus (optional, disable with the -Ddbus=false meson configure flag)
• libconfig (optional, disable with the -Dconfig_file=false meson configure flag)
• libxdg-basedir (optional, disable with the -Dconfig_file=false meson configure flag)
• libGL (optional, disable with the -Dopengl=false meson configure flag)
• libpcre (optional, disable with the -Dregex=false meson configure flag)
• libev
• uthash

To build the documents, you need asciidoc

To build

$ git submodule update --init --recursive
$ meson --buildtype=release . build
$ ninja -C build

Built binary can be found in build/src

If you have libraries and/or headers installed at non-default location (e.g. under /usr/local/), you might need to tell meson about them, since meson doesn't look for dependencies there by default.

You can do that by setting the CPPFLAGS and LDFLAGS environment variables when running meson. Like this:

$ LDFLAGS="-L/path/to/libraries" CPPFLAGS="-I/path/to/headers" meson --buildtype=release . build

As an example, on FreeBSD, you might have to run meson with:

$ LDFLAGS="-L/usr/local/include" CPPFLAGS="-I/usr/local/include" meson --buildtype=release . build
$ ninja -C build

To install

$ ninja -C build install

Default install prefix is /usr/local, you can change it with meson configure -Dprefix=<path> build

How to Contribute

Code

You can look at the Projects page, and see if there is anything interests you. Or you can take a look at the Issues.

Non-code

Even if you don't want to contribute code, you can still contribute by compiling and running this branch, and report any issue you can find.

Contributions to the documents and wiki will also be appreciated.

Contributors

See CONTRIBUTORS