SwayFX: A Beautiful Sway Fork

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:

Blur
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)
nixify the repo: Allows nixos users to easily contribute to and test this project

New Configuration Options

Window blur:
- blur enable|disable
- blur_xray enable|disable: this will set floating windows to blur based on the background, not the windows below. You probably want to set this to disable :)
- blur_passes <integer value 0 - 10>
- blur_radius <integer value 0 - 10>
Corner radius: corner_radius <val>
Window shadows:
- shadows enable|disable
- shadows_on_csd enable|disable (Note: The shadow might not fit some windows)
- shadow_blur_radius <integer value 0 - 100>
- shadow_color <hex color with alpha> ex, #0000007F
LayerShell effects (to blur panels / notifications etc) :
- layer_effects <layer namespace> <effects>
- Example: layer_effects "waybar" blur enable; shadows enable; corner_radius 6
  - Note: If an application uses gtk, its namespace is likely to be "gtk-layer-shell"
- SwayIPC Example: swaymsg "layer_effects 'waybar' 'blur enable; shadows enable; corner_radius 6'"
- Available Effects:
  - blur <enable|disable>
  - shadows <enable|disable>
  - corner_radius <int>
Dim unfocused windows:
- default_dim_inactive <float value 0.0 - 1.0>
- 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>
Keep/remove separator border between titlebar and content: titlebar_separator enable|disable
Treat Scratchpad as minimized: scratchpad_minimize enable|disable

Roadmap

fade in / out animations
window movement animations

Installation

SwayFX is also available on the Fedora copr

Nix

If you have Nix installed, you can build and run SwayFX easily:

nix build
./result/bin/sway

You can also bring up a development shell and follow the build instructions below, without installing all of the dependencies manually:

nix develop

Compiling from Source

Install dependencies:

meson *
wlroots
wayland
wayland-protocols *
pcre2
json-c
pango
cairo
gdk-pixbuf2 (optional: system tray)
[scdoc] (optional: man pages) *
git (optional: version info) *

* Compile-time dep

Run these commands:

meson build/
ninja -C build/
sudo ninja -C build/ install

On systems without logind nor seatd, you need to suid the sway binary:

sudo chmod a+s /usr/local/bin/sway

SwayFX will drop root permissions shortly after startup.

Contributing

SwayFX would love to receive any new features that you're willing to build! Generally, we'd like to focus on eye-candy type improvements to keep our scope appropriate. If you'd like to build something that you think may be out of that focus, please raise an issue and we can discuss whether or not it will fit within this project.

Here's a quick outline of where most of our changes lie vs the main sway repository:

sway/desktop/render.c: the file that handles calling fx_renderer to render to the screen, handles damage tracking and scaling
sway/desktop/fx_renderer.c: the meat and potatoes of this project, structured as similarly to wlr_renderer as possible
sway/desktop/shaders: where all of the shaders that fx_renderer uses live

4.6 KiB Raw Blame History