{"id":13437896,"url":"https://github.com/yshui/picom","last_synced_at":"2025-12-11T21:48:42.802Z","repository":{"id":37251729,"uuid":"63369078","full_name":"yshui/picom","owner":"yshui","description":"A lightweight compositor for X11 with animation support","archived":false,"fork":false,"pushed_at":"2025-05-09T16:13:13.000Z","size":7917,"stargazers_count":4415,"open_issues_count":262,"forks_count":593,"subscribers_count":48,"default_branch":"next","last_synced_at":"2025-05-12T04:52:46.145Z","etag":null,"topics":["compositor","compton","linux","x11","xcb","xcompmgr","xorg"],"latest_commit_sha":null,"homepage":"https://picom.app/","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yshui.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"yshui","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"custom":null}},"created_at":"2016-07-14T20:54:51.000Z","updated_at":"2025-05-12T04:33:53.000Z","dependencies_parsed_at":"2023-12-22T12:19:12.298Z","dependency_job_id":"8c674898-bb32-4dde-9a8d-2a74c4caa720","html_url":"https://github.com/yshui/picom","commit_stats":{"total_commits":2170,"total_committers":104,"mean_commits":"20.865384615384617","dds":0.3235023041474654,"last_synced_commit":"ba3093a913b7044649db8abd7c28fa5060388f19"},"previous_names":["yshui/compton"],"tags_count":63,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yshui%2Fpicom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yshui%2Fpicom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yshui%2Fpicom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yshui%2Fpicom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yshui","download_url":"https://codeload.github.com/yshui/picom/tar.gz/refs/heads/next","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253990500,"owners_count":21995776,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compositor","compton","linux","x11","xcb","xcompmgr","xorg"],"created_at":"2024-07-31T03:01:01.033Z","updated_at":"2025-12-11T21:48:42.794Z","avatar_url":"https://github.com/yshui.png","language":"C","funding_links":["https://github.com/sponsors/yshui"],"categories":["Dependencies","C","HarmonyOS","Installation","Details","Featuring","Getting Started","Window Managers","Setup Info","Compositor","Uncategorized","Install","Recommended","8. Picom","What You Need","Tool"],"sub_categories":["Windows Manager","1) Get all the dependencies","Prerequisites","Program List","Compositors","Uncategorized","Required dependencies","Desktop Extension Tool"],"readme":"picom\n=====\n\n[![circleci](https://circleci.com/gh/yshui/picom.svg?style=shield)](https://circleci.com/gh/yshui/picom)\n[![codecov](https://codecov.io/gh/yshui/picom/branch/next/graph/badge.svg?token=NRSegi0Gze)](https://codecov.io/gh/yshui/picom)\n[![chat on discord](https://img.shields.io/discord/1106224720833159198?logo=discord)](https://discord.gg/SY5JJzPgME)\n\n__picom__ is a compositor for X, and a [fork of Compton](History.md).\n\n**This is a development branch, bugs to be expected**\n\nYou can leave your feedback or thoughts in the [discussion tab](https://github.com/yshui/picom/discussions), or chat with other users on [discord](https://discord.gg/SY5JJzPgME)!\n\n## Change Log\n\nSee [Releases](https://github.com/yshui/picom/releases)\n\n## Build\n\n### Dependencies\n\nAssuming you already have all the usual building tools installed (e.g. gcc, python, meson, ninja, etc.), you still need:\n\n* libx11\n* libx11-xcb\n* xproto\n* xcb\n* xcb-util\n* xcb-damage\n* xcb-xfixes\n* xcb-shape\n* xcb-renderutil\n* xcb-render\n* xcb-randr\n* xcb-composite\n* xcb-image\n* xcb-present\n* xcb-glx\n* pixman\n* libconfig (\u003e= 1.7)\n* libdbus (optional, disable with the `-Ddbus=false` meson configure flag)\n* libGL, libEGL, libepoxy (optional, disable with the `-Dopengl=false` meson configure flag)\n* libpcre2 (optional, disable with the `-Dregex=false` meson configure flag)\n* libev\n* uthash\n\nIf libconfig \u003e= 1.7 is not available on your system, meson will try to build it from git. In which case, you also need `cmake`, and `git`.\n\nOn Debian based distributions (e.g. Ubuntu), the needed packages are\n\n```\nlibconfig-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-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 meson ninja-build uthash-dev\n```\n\nOn Fedora, the needed packages are\n\n```\ndbus-devel gcc git libconfig-devel libev-devel libX11-devel libX11-xcb 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\n```\n\nTo build the documents, you need `asciidoctor`\n\n### To build\n\n```bash\n$ meson setup --buildtype=release build\n$ ninja -C build\n```\n\nBuilt binary can be found in `build/src`\n\nIf 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.\n\nYou can do that by setting the `CPPFLAGS` and `LDFLAGS` environment variables when running `meson`. Like this:\n\n```bash\n$ LDFLAGS=\"-L/path/to/libraries\" CPPFLAGS=\"-I/path/to/headers\" meson setup --buildtype=release build\n```\n\nAs an example, on FreeBSD, you might have to run meson with:\n```bash\n$ LDFLAGS=\"-L/usr/local/lib\" CPPFLAGS=\"-I/usr/local/include\" meson setup --buildtype=release build\n$ ninja -C build\n```\n\n### To install\n\n``` bash\n$ ninja -C build install\n```\n\nDefault install prefix is `/usr/local`, you can change it with `meson configure -Dprefix=\u003cpath\u003e build`\n\n## How to Contribute\n\nAll contributions are welcome!\n\nNew features you think should be included in picom, a fix for a bug you found - please open a PR!\n\nYou can take a look at the [Issues](https://github.com/yshui/picom/issues).\n\nContributions to the documents and wiki are also appreciated.\n\nEven 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.\n\n### Become a Collaborator\n\nBecoming 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.\n\nIf this sounds good to you, feel free to contact me.\n\n## Contributors\n\nSee [CONTRIBUTORS](CONTRIBUTORS)\n\nThe README for the [original Compton project](https://github.com/chjj/compton/) can be found [here](History.md#Compton).\n\n## Licensing\n\npicom is free software, made available under the [MIT](LICENSES/MIT) and [MPL-2.0](LICENSES/MPL-2.0) software\nlicenses. See the individual source files for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyshui%2Fpicom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyshui%2Fpicom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyshui%2Fpicom/lists"}