blob: 4466d33cd3863974d7dc285f82bb5ac8ec9b1524 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
# Compfy
1. [Introduction](#introduction)
2. [Getting Started](#getting-started)
- [Installation](#installation)
- [Configuration](#configuration)
3. [Usage](#usage)
4. [License](#license)
## Introduction
Compfy is a Compositor for the [X11](https://www.x.org/wiki/) 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](https://github.com/yshui/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 make this work possible!**
*If you are interesting in supporting this work aswell you too can sponsor me on GitHub. Even the smallest amount is much appreciated and shows me that this project is still wanted!*
[](https://github.com/sponsors/allusive-dev)
- [@SolninjaA](https://github.com/SolninjaA) ($5 One Time) (The First Ever Sponsor!)
- [@maclightning2](https://github.com/maclightning2) ($3 A Month) (First Ever Monthly Sponsor)
## Getting Started
Let's cover how to install Compfy on your system and breifly 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](https://github.com/NixOS/nixpkgs)
| Linux Distribution | Method | Compatibility |
| ------------------ | ------- | --------------|
| Arch Linux | [AUR](https://aur.archlinux.org/packages/compfy) | :green_circle: |
| NixOS (Stable) | [Custom Package](https://github.com/allusive-dev/compfy/releases/latest) | :green_circle: |
| Other | [Manually Building](#manually) | :green_circle: |
#### 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](https://donument.com/d/Allusive/compfy/-/documents/) 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](LICENSES/MIT) and [MPL-2.0](LICENSES/MPL-2.0)
|