alex/swayfx
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
William McKinnon 2023-03-10 22:56:24 -05:00 committed by GitHub
parent 83d7316a04
commit 3b101734e6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -4,17 +4,17 @@
Sway is an incredible window manager, and certainly one of the most well established wayland window managers. However, it is restricted to only include the functionality that existed in i3. This fork ditches the simple wlr_renderer, and replaces it with our fx_renderer, capable of rendering with fancy GLES2 effects. This, along with a couple of minor changes, expands sway's featureset to include the following:
+ **Anti-aliased rounded corners, borders, and titlebars**
+ **Shadows**
+ **Dim unfocused windows**
+ **Per application saturation control**: Allows the user to set the saturation (Digital Vibrance) for specific applications. Great for some FPS games!
+ **Scratchpad treated as minimize**: Allows docks, or panels with a taskbar, to correctly interpret minimize / unminimize requests ([thanks to LCBCrion](https://github.com/swaywm/sway/issues/6457))
+ **Add a nix flake to the repo**: Allows nixos users to easily contribute to and test this project
+ **nixify the repo**: Allows nixos users to easily contribute to and test this project
## New Configuration Options
+ Corner radius: `corner_radius <val>`
+ Smart corner radius: `smart_corner_radius on|off`
+ Application saturation: `for_window [CRITERIA HERE] saturation <set|plus|minus> <val 0.0 <-> 2.0>`
+ Window shadows: *ONLY ON SWAYFX-GIT, NOT YET RELEASED*
+ Window shadows:
- `shadows on|off`
- `shadows_on_csd on|off` (**Note**: The shadow might not fit some windows)
- `shadow_blur_radius <integer value 0 - 100>`
@ -24,6 +24,7 @@ Sway is an incredible window manager, and certainly one of the most well establi
- `for_window [CRITERIA_HERE] dim_inactive <float value 0.0 - 1.0>`
- `dim_inactive_colors.unfocused <hex color> ex, #000000FF`
- `dim_inactive_colors.urgent <hex color> ex, #900000FF`
+ Application saturation: `for_window [CRITERIA HERE] saturation <set|plus|minus> <val 0.0 <-> 2.0>`
## Roadmap
@ -49,10 +50,6 @@ You can also bring up a development shell and follow the build instructions belo
```
nix develop
```
### Gentoo
If you use gentoo, you can install it from the guru:
https://github.com/gentoo/guru/tree/master/gui-wm/swayfx
### Compiling from Source