aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 87e0e8c19f56dc434f811adfe96c074593bed309 (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
# picom-allusive
A Fork of Pijulius picom by Allusive.

Want to chat or maybe help bug test? Contatc 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 sponsor setup so you can support my work more directly.
Even if you can only give a small amount it goes a long way!

### Announcements

UPDATE 1.0.0 IS HERE!!!

Please check out the updated documentation!

Here is a full list of features that are now avaliable in `v1.0`

- Includes all fixes and changes from `yshui/picom-v10.2`
- Includes pijulius animation code.
- 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 is now done on a whitelist basis to reduce hardware consumption. (This might be changed in `v1.1` where you will be able to chose whether to use a whitelist or blacklist).

## What Is This?
This is a fork of picom-pijulius which is avaliable on Nixpkgs and the Arch User Repository.

This is currently the best actively maintained fork of picom adding proper animations.


## Documentation can be found in the Wiki tab above.

The docs were moved back to Github Wiki because the documentation framework I was using is actually pretty slow and unoptimized so for now things are back to the way they were.

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

## Installation

### Building Manually
```
$ meson setup --buildtype=release . build
$ ninja -C build
$ ninja -C build install
```

### Arch Linux or other Arch based distros

```
$ paru -S picom-allusive
```
or
```
$ yay -S picom-allusive
```

### NixOS

picom-allusive is now avaliable on unstable(23.11)!

Keep in mind it can take up to a week after picom is updated before it will be avaliable on NixOS.

Simply do one of the following
``` nix
environment.systemPackages = [ pkgs.picom-allusive ];
```
or for home-manager
``` nix
home.packages = [ pkgs.picom-allusive ];
```

The package will not be avaliable on NixOS 23.05 You will have to wait until the next stable update if you are on the stable branch.

**If you still want to use picom and you are on 23.05 you can use the custom package (updated in the releases page) in either `environment.systemPackages` or `home.packages` for home-manager users. Keep in mind this is considerably unstable so expect possible issues.**

Thank you for your patience.