PolytreeDE/picom
1
0
Fork 0
mirror of https://github.com/yshui/picom.git synced 2024-12-02 14:15:41 -05:00
Code Releases Activity
A lightweight compositor for X11
2423 commits 57 branches 63 tags 33 MiB
C 92.8%
Python 2.5%
CSS 2%
Shell 1.4%
Meson 0.8%
Other 0.4%
Find a file
Yuxuan Shui bd26302f07
backend: embed backend_operations table in backend_base 
The idea is to allow backend plugins to override backend functions by
modifying this table. Right now, when they do this they are actually
changing a global variable and their change will persist after backend
resets (!). Store the table inside backend_base solves this problem.

Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
2024-05-25 11:08:52 +01:00
.builds ci: use github actions for OpenBSD build 2024-05-15 20:19:15 +01:00
.circleci ci: test parsing config file in a different locale 2024-05-20 11:39:24 +01:00
.github ci: don't let apt-get overwrite the libconfig we installed 2024-05-20 06:11:13 +01:00
bin picom-trans: Added SPDX-License-Identifier 2021-07-23 21:15:53 +01:00
dbus-examples Update inverter.sh 2020-04-01 04:50:03 +00:00
include backend: embed backend_operations table in backend_base 2024-05-25 11:08:52 +01:00
LICENSES
man config: support loading plugins 2024-05-25 11:08:39 +01:00
media
meson Made meson/install.sh executable 2022-04-12 05:41:41 +00:00
src backend: embed backend_operations table in backend_base 2024-05-25 11:08:52 +01:00
subprojects/test.h test.h: import upstream updates 2024-02-15 13:58:29 +00:00
tests ci: run tests with all backends 2024-05-20 11:56:16 +01:00
.clang-format file_watch: use kqueue on *BSD platforms 2019-11-11 21:22:57 +00:00
.clang-tidy chore: tweak .clang-tidy 2024-02-16 15:43:52 +00:00
.editorconfig build: add libepoxy 2024-02-10 20:35:24 +00:00
.gitignore misc: update .gitignore 2024-05-15 23:34:32 +01:00
CHANGELOG.md config: support loading plugins 2024-05-25 11:08:39 +01:00
compton-default-fshader-win.glsl
compton-fake-transparency-fshader-win.glsl
compton.desktop set .desktop files to NoDisplay=true 2020-12-14 14:54:33 +01:00
CONTRIBUTORS update contributors list 2024-02-11 21:33:14 +03:00
COPYING rename: documentation changes 2019-10-23 20:24:25 +01:00
desc.txt
Doxyfile
flake.lock flake: update flake.lock 2024-05-25 09:16:30 +01:00
flake.nix flake: add a dev shell that has frame pointers 2024-04-08 09:42:51 +01:00
History.md README: Move old historical info out of main README 2022-04-12 09:43:57 -04:00
LICENSE.spdx rename: documentation changes 2019-10-23 20:24:25 +01:00
meson.build plugin: add picom API headers 2024-05-25 11:08:43 +01:00
meson_options.txt build: make libconfig mandatory 2024-04-20 16:25:08 +01:00
picom-dbus.desktop set .desktop files to NoDisplay=true 2020-12-14 14:54:33 +01:00
picom.desktop meson.build: autostart picom 2022-08-21 06:25:55 +01:00
picom.sample.conf config: remove --shadow-exclude-reg 2024-05-12 13:52:41 +01:00
README.md build: make libconfig mandatory 2024-04-20 16:25:08 +01:00

README.md

picom

circleci codecov chat on discord

picom is a compositor for X, and a fork of Compton.

This is a development branch, bugs to be expected

You can leave your feedback or thoughts in the discussion tab, or chat with other users on discord!

Change Log

See Releases

Build

Dependencies

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

  • libx11
  • libx11-xcb
  • libXext
  • xproto
  • xcb
  • xcb-util
  • xcb-damage
  • xcb-dpms
  • xcb-xfixes
  • xcb-shape
  • xcb-renderutil
  • xcb-render
  • xcb-randr
  • xcb-composite
  • xcb-image
  • xcb-present
  • xcb-glx
  • pixman
  • libconfig
  • libdbus (optional, disable with the -Ddbus=false meson configure flag)
  • libGL, libEGL, libepoxy (optional, disable with the -Dopengl=false meson configure flag)
  • libpcre2 (optional, disable with the -Dregex=false meson configure flag)
  • libev
  • uthash

On Debian based distributions (e.g. Ubuntu), the needed packages are

libconfig-dev libdbus-1-dev libegl-dev libev-dev libgl-dev libepoxy-dev libpcre2-dev libpixman-1-dev libx11-xcb-dev libxcb1-dev libxcb-composite0-dev libxcb-damage0-dev libxcb-dpms0-dev libxcb-glx0-dev libxcb-image0-dev libxcb-present-dev libxcb-randr0-dev libxcb-render0-dev libxcb-render-util0-dev libxcb-shape0-dev libxcb-util-dev libxcb-xfixes0-dev libxext-dev meson ninja-build uthash-dev

On Fedora, the needed packages are

dbus-devel gcc git libconfig-devel libdrm-devel libev-devel libX11-devel libX11-xcb libXext-devel libxcb-devel libGL-devel libEGL-devel libepoxy-devel meson pcre2-devel pixman-devel uthash-devel xcb-util-image-devel xcb-util-renderutil-devel xorg-x11-proto-devel xcb-util-devel

To build the documents, you need asciidoc

To build

$ meson setup --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 setup --buildtype=release build

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

$ LDFLAGS="-L/usr/local/lib" CPPFLAGS="-I/usr/local/include" meson setup --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

All contributions are welcome!

New features you think should be included in picom, a fix for a bug you found - please open a PR!

You can take a look at the Issues.

Contributions to the documents and wiki are also appreciated.

Even if you don't want to add anything to picom, you are still helping by compiling and running this branch, and report any issue you can find.

Become a Collaborator

Becoming a collaborator of picom requires significant time commitment. You are expected to reply to issue reports, reviewing PRs, and sometimes fix bugs or implement new feature. You won't be able to push to the main branch directly, and all you code still has to go through code review.

If this sounds good to you, feel free to contact me.

Contributors

See CONTRIBUTORS

The README for the original Compton project can be found here.

Licensing

picom is free software, made available under the MIT and MPL-2.0 software licenses. See the individual source files for details.