From 7e91b9c1f7028ef155fad431c5e703b06043886b Mon Sep 17 00:00:00 2001 From: Simon Schneegans Date: Sun, 12 Jun 2022 18:13:49 +0200 Subject: [PATCH] :memo: Update README --- README.md | 90 ++++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 80 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 814c181..fd8177d 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@

🔥 Set GNOME Shell on Fire!

+

(and KWin as well)


@@ -13,27 +14,52 @@

-When I released the [Desktop Cube Extension](https://github.com/Schneegans/Desktop-Cube/), many people requested to revive one of the most useless features of Linux desktop history: Setting windows on fire! +When I released the [Desktop Cube Extension](https://github.com/Schneegans/Desktop-Cube/) for GNOME, many people requested to revive one of the most useless features of Linux desktop history: Setting windows on fire! This extension is not only more useless than the cube, but it is also much more hacky. So I expect some bug! [Let's incinerate them all](https://github.com/Schneegans/Burn-My-Windows/issues)! -For a list of things changed in previous releases, you can have a look at the [changelog](docs/changelog.md)! - +Burn-My-Windows is not only available for **GNOME** but also includes some basic support for **KDE Plasma's KWin**. +Further down in this file you'll find installation instructions for both. Effect | Preview -----|-------- -**Apparition**
This effect hides your windows by violently sucking them into the void of magic!

_Only available in GNOME Shell 3.38+_ | -**Broken Glass**
Shatter your windows into a shower sharp shards! This effect can be configured so that the shards fly away from your mouse pointer position!

_Only available in GNOME Shell 40+_ | +**Apparition**
This effect hides your windows by violently sucking them into the void of magic! | +**Broken Glass**
Shatter your windows into a shower sharp shards! This effect can be configured so that the shards fly away from your mouse pointer position!| **Energize A**
Beam your windows away! | **Energize B**
Using different transporter technology results in an alternative visual effect. | **Fire**
The classic effect inspired by Compiz. However, this is implemented using a GLSL shader and not with a particle system like in the old days. | **Hexagon**
With glowing lines and hexagon-shaped tiles, this effect looks very sci-fi. | -**Matrix**
Turn your windows into a shower of green letters! The color is actually configurable.

_Only available in GNOME Shell 40+_ | -**Snap of Disintegration**
Dissolve your windows into a cloud of dust.

_Only available in GNOME Shell 40+_ | -**T-Rex Attack**
Destroy your windows with a series of violent slashes!

_Only available in GNOME Shell 40+_ | +**Matrix**
Turn your windows into a shower of green letters! The color is actually configurable.| +**Snap of Disintegration**
Dissolve your windows into a cloud of dust.| +**T-Rex Attack**
Destroy your windows with a series of violent slashes!| **TV-Effect**
This is a very simple effect to demonstrate that this extension could also be used in a more professional environment. | **Wisps**
Let your windows be carried away to the realm of dreams by these little fairies! | **Your Effect!**
The extension is very modular and with a bit of creativity and GLSL knowledge, [you can easily create your own effects](docs/how-to-create-new-effects.md). | [![Create your own effects](docs/pics/custom.jpg)](docs/how-to-create-new-effects.md) +## ✅ Supported Versions + +Not every effect is available on each version of GNOME or KWin. +Below is a table which summarizes the current availability for all effects. + + + + + + + + + + + + + + + + + + + +
GNOMEKWin
3.363.384041425.25
Apparition ✅ ✅✅✅
Broken Glass ✅✅✅
Energize A ✅ ✅ ✅✅✅✅
Energize B ✅ ✅ ✅✅✅✅
Fire ✅ ✅ ✅✅✅✅
Hexagon ✅ ✅ ✅✅✅✅
Matrix ✅✅✅
Snap of Disintegration ✅✅✅
T-Rex Attack ✅✅✅
TV-Effect ✅ ✅ ✅✅✅✅
Wisps ✅ ✅ ✅✅✅✅
+ ## 💞 These People _love_ this Extension @@ -68,9 +94,9 @@ While [coding new features](docs/how-to-create-new-effects.md) or [translating t Do you want to show that you love it too? You may become a sponsor for as little as 1$ / month! -If you like this extension, you may also want to try one of my other extensions: [🧊 Desktop-Cube](https://github.com/Schneegans/Desktop-Cube) or [🍰 Fly-Pie](https://github.com/Schneegans/Fly-Pie/)! +If you like this extension, you may also want to try one of my other GNOME extensions: [🧊 Desktop-Cube](https://github.com/Schneegans/Desktop-Cube) or [🍰 Fly-Pie](https://github.com/Schneegans/Fly-Pie/)! -## ⬇️ Installation +## ⬇️ Installation (GNOME) You can either install the Burn-My-Windows extension from extensions.gnome.org (a), download a stable release from GitHub (b) or clone the latest version directly with `git` (c). @@ -129,6 +155,50 @@ Then you can enable the extension with the *Gnome Tweak Tool*, the *Extensions* gnome-extensions enable burn-my-windows@schneegans.github.com ``` +## ⬇️ Installation (KWin) + + +You can either download a stable version from GitHub (a) or clone the latest version directly with `git` (b). + +### a) Downloading a Stable Release + +Execute this command to download the latest stable release: + +```bash +wget https://github.com/Schneegans/Burn-My-Windows/releases/latest/download/burn_my_windows_kwin4.zip +``` + +Install it by executing the following commands. + +```bash +mkdir -p ~/.local/share/kwin/effects +unzip burn_my_windows_kwin4.zip -d ~/.local/share/kwin/effects +``` + +Then select the desired effects in the system settings under "Desktop Effects". + + +### b) Cloning the Latest Version with `git` + +Execute the clone command below where you want to have the source code of the extension. + +```bash +git clone https://github.com/Schneegans/Burn-My-Windows.git +cd Burn-My-Windows +``` + +Now you will have to build the effects and copy them to your KWin effect directory. + +```bash +./kwin/build.sh +mkdir -p ~/.local/share/kwin/effects +cp -r kwin/_build/* ~/.local/share/kwin/effects +``` + +That's it! +You can now select the desired effects in the system settings under "Desktop Effects". + + ## :octocat: I want to contribute! That's great!