diff --git a/README.md b/README.md index a1646e7b..4b5776e0 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@
-# SwayFX: A Beautiful Sway Fork +![swayfx logo](assets/swayfx_logo.svg) + +
https://discord.gg/qsSx397rkh
-![swayfx_screenshot](assets/swayfx_screenshot.jpg) +![swayfx screenshot](assets/swayfx_screenshot.jpg) 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** @@ -17,6 +19,18 @@ Sway is an incredible window manager, and certainly one of the most well establi + **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)) + **nixify the repo**: Allows nixos users to easily contribute to and test this project + +
+
+ +
+
+ +
+
+ +[SwayFX is also available on the Fedora copr](https://copr.fedorainfracloud.org/coprs/swayfx/swayfx/) + ## New Configuration Options + Window blur: @@ -54,11 +68,7 @@ Sway is an incredible window manager, and certainly one of the most well establi + fade in / out animations + window movement animations -## Installation - -[![Packaging status](https://repology.org/badge/vertical-allrepos/swayfx.svg)](https://repology.org/project/swayfx/versions) - -[SwayFX is also available on the Fedora copr](https://copr.fedorainfracloud.org/coprs/swayfx/swayfx/) +## Compiling From Source ### Nix @@ -75,7 +85,7 @@ You can also bring up a development shell and follow the build instructions belo nix develop ``` -### Compiling from Source +### Manual Steps Install dependencies: @@ -114,3 +124,14 @@ Here's a quick outline of where most of our changes lie vs the main sway reposit + `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 + +## Acknowledgements + +The SwayFX team would like to first and foremost thank the maintainers and contributors of the Sway window manager. We are but a humble group of Sway enthusiasts who wanted to expand upon your creation. + +We would also like to thank the talented artists in our community for contibuting the visual assets that give this project charm: ++ pkdesuwu and honchokomodo for creating the swayfx mascot: https://twitter.com/pkdesuwu/status/1664517033017368576 ++ spooky_skeleton for the swayfx logo, and basil.cafe for making some fine adjustments to it + +Lastly, we would like to thank you, the community, for enjoying and using window manager that we have spent so much time maintaining. + diff --git a/assets/swayfx_logo.svg b/assets/swayfx_logo.svg new file mode 100644 index 00000000..c4d5024d --- /dev/null +++ b/assets/swayfx_logo.svg @@ -0,0 +1,191 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/assets/swayfx_mascot.png b/assets/swayfx_mascot.png new file mode 100644 index 00000000..717a05a5 Binary files /dev/null and b/assets/swayfx_mascot.png differ diff --git a/assets/swayfx_screenshot.jpg b/assets/swayfx_screenshot.jpg index afd86ed5..016641cd 100644 Binary files a/assets/swayfx_screenshot.jpg and b/assets/swayfx_screenshot.jpg differ