aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: d7a3a0bdbb84e5793141ab2411313fe053966512 (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
# Compfy
See [What is This](https://github.com/allusive-dev/compfy#what-is-this)

<br>
<br>

# Update

Now that Compfy has publically released I want to make a few things clear.
- Compfy will continue to recieve updates based on `yshui/picom`'s stable releases.
- Compfy is no longer considered a fork of Picom, it is its own compositor based upon Picom.


**There is now a live matrix chat room for Compfy/Picom-Allusive. Join us [here](https://matrix.to/#/#compfy-discussion:matrix.org)**

<br>
<br>


Want to chat or maybe help bug test? Contatct me here:

[![Matrix](https://img.shields.io/badge/MATRIX-012121.svg?style=for-the-badge&logo=Matrix&logoColor=white)](https://matrix.to/#/@allusive_:matrix.org)
[![Discord](https://img.shields.io/badge/DISCORD-5865F2.svg?style=for-the-badge&logo=Discord&logoColor=white)](https://github.com/allusive-dev/allusive-dev#contact-me)
[![Email](https://img.shields.io/badge/EMAIL-160F33.svg?style=for-the-badge&logo=ProtonMail&logoColor=white)](mailto:[email protected])

Thanks very much for the support on this project recently, it really helps me stay motivated to keep working on it.
Can we get to 100 stars on GitHub next?

**If you are feelling really generous I now have GitHub sponsors setup so you can support my work more directly.
Even if you can only give a small amount it goes a long way!**

[![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/allusive-dev)

## Announcements

Please check out the updated documentation.

Current Featueres:

- Includes all fixes and changes from `yshui/picom-v10.2`
- Includes pijulius animation code. (

    **As of `1.2.0` `animation-for-workspace-in`, `animation-for-workspace-out`, `animation-for-transient-window` have been removed because their corrosponding functions caused the issue of the wrong animations playing in all other instances, Aswell as not working as intended**
  
  )
- Includes corners-rule. Allowing you to set the corner-radius on a per window basis.
- Animation open and unmap exclusion lists! Don't want something animating? Now you can fix that.
- Blur rules. Background blurring can now be done on a whitelist basis to reduce hardware consumption.
- Fixes rounded corner issues on AwesomeWM, bspwm and i3.
- A New option, `wm-support` has been added. Applies patches for ("awesome", "dwm", "herb"). "herb" being HerbstluftWM.
- Adds `inactive-exclude` and `active-exclude`. See Wiki or Donument for more information.

## What Is This?

For those who don't know this is a compositor for Linux and the X11 platform. It gives windows transparency, blur, animations and much more!

This was originally a fork of Picom and nothing more, as of `1.6.0` **Compfy** has become its own project entirely. Offering a alternative to Picom.

This is currently the best actively maintained alternative to Picom adding proper animations, implementing all features from upstream `v10.2` and adding more features as requested by the community!

## Documentation/Wiki.

The Wiki is also avaliable and actively updated 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.

The GitHub Wiki is still actively maintained just incase, so don't worry about relying 100% on a external site yet if you don't feel comfortable with that. Thought I highly encourage taking a good look at Donument.

Can't find what you need in the wiki or have an problem? Open an Issue.

## Installation

### Building Manually
```
$ meson setup . 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)
```

### Arch Linux or other Arch based distros

```
$ paru -S compfy
```
or
```
$ yay -S compfy
```

### NixOS

Compfy is not yet avaliable on unstable(23.11)

Coming soon though.

Thank you for your patience.