n3rdium / compfy

A Linux Compositor for X11. Based on Picom. Providing Animations, Active Support and More! This is just a "backup" of @allusive-dev's project, so that my workflow doesn't break.

Compfy

Notice

Context: #61 So for some reason my account wasn't deleted so I guess I'll just put it out there that this project is no longer being maintained! Why?

1. See #61
2. Picom is finally updating and adding animations support, BUT GUESS WHAT. They are not adding anything from Compfy. (sad)

Update

So i just tried to create a new repository just to let people know about my new GitHub account @jasper-at-windswept, but I can't create repositories because my account APPARENTLY still being deleted, so yeah if this repository just dissapears in like a month you now know why.

TOC

1. Introduction
2. Getting Started
   • Installation
   • Configuration
3. Usage
4. License

Introduction

Compfy is a Compositor for the X11 platform on Linux. Compfy's main purpose is to pretty up your graphical desktop environment by letting users have features like transparency, background blurring, rounded corners, animations and way more!

Compfy was made as an alternative to Picom, another popular X11 compositor. Compfy is based on Picom but provides more features and active community support.

Before we begin I want to say I massive thank you to my sponsors as they made this work possible!

• @SolninjaA ($5 One Time) (The First Ever Sponsor!)
• @maclightning2 ($3 A Month) (First Ever Monthly Sponsor)

Getting Started

Let's cover how to install Compfy on your system and briefly go over how to configure it.

Installation

Compfy is avaliable on a few packaged platforms including on the AUR and very soon coming to Nixpkgs

Linux Distribution	Method	Compatibility
Arch Linux	AUR	🟠
NixOS (Stable)	Custom Package	🟢
Other	Manually Building	🟢

AUR package is not maintained by me anymore

Manually

Note if you want to enabled the --check-for-updates option (avaliable as of 1.7.0) you will need to build with these commands instead. (--check-for-updates will print out your current version and the latest release version number if you are connected to the internet)

Without --check-for-updates:

$ meson setup . build
$ ninja -C build
$ ninja -C build install

With --check-for-updates:

$ meson setup -Dupdate_checks=true . build
$ ninja -C build
$ ninja -C build install

Dependencies:

libconfig
libdbus
libev
libglvnd
libx11
libxcb
libxdg-basedir
pcre2
pixman
uthash
xcb-util-image
xcb-util-renderutil
gcc (make)
git (make)
meson (make)
ninja (make)

# If you enabled -Dupdate-checks you will also need these dependencies.

'json-c' or 'json_c'
'curl' or 'libcurl'

Configuration

Compfy stores its default configuration at /etc/xdg/compfy.conf.example(may vary depending on OS). The default configuration provides almost all the options you will ever need, some commented out.

It is reccomended you store your personal configuration at ~/.config/compfy.conf or ~/.config/compfy/compfy.conf You can do this by copying over the sample configuration or simply writing your own.

For a VERY detailed guide on configurating Compfy please see the Documentation. It is avaliable in the Wiki tab above and on Donument an up and coming git versioned database allows for more than just code to be versioned.

Or if you still use man the Documentation is also avaliable under man compfy.

Usage

Compfy has very similar command line arguments to Picom.

You can view all the commands and what they do with compfy --help but here is a few to get you started.

$ compfy --version
# Print the current version

$ compfy --help
# Print all the avaliable command line options with explanations

$ compfy -b
or
$ compfy --daemon
# Run Compfy in the background, dissociating it from the terminal.

License

Compfy is licensed under MIT and MPL-2.0