Skip to content

Latest commit

 

History

History
287 lines (224 loc) · 21.7 KB

README.md

File metadata and controls

287 lines (224 loc) · 21.7 KB
Raw

🔥 Set GNOME Shell and KWin on Fire!


Important

The code in the main branch is for GNOME Shell 45+. For older GNOME versions, please use the gnome-3.36-44 branch.

When I released the Desktop Cube Extension 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!

🖼️ The wallpapers used in the previews below were all generated using AI and are available in this GitHub repository.

Effect Preview
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!
Doom
Melt your windows. Inspired by the legendary screen transitions of the original Doom.
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.
Focus
Focus dude, focus!
Glide
This very simple effect fades the window to transparency with subtle 3D effects.
Glitch
This effect applies some intentional graphics issues to your windows.
Hexagon
With glowing lines and hexagon-shaped tiles, this effect looks very sci-fi.
Incinerate
A less snappy but definitely more fancy take on the fire effect.
Matrix
Turn your windows into a shower of green letters! The color is actually configurable.
Paint Brush
Paint or erase your windows with a thick paint brush.
Pixelate
Pixelate your windows and randomly hide pixels until the entire window is gone.
Pixel Wheel
This simple effect pixelates the window and hides the pixels in a wheel-like fashion.
Pixel Wipe
This effect pixelates the window and hides the pixels radially, starting from the pointer position.
Portal
This ridiculous effect teleports your windows from and to alternative dimensions. It may resemble the portal from a well-known cartoon series...
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.
TV Glitch
This effect combines the Glitch and the TV Effect.
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.		 Create your own effects

✅ 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.

GNOME KWin
3.36 3.3840+5.25.0+
Apparition ✅ ✅
Broken Glass ✅
Doom ✅ ✅ ✅
Energize A ✅ ✅ ✅ ✅
Energize B ✅ ✅ ✅ ✅
Fire ✅ ✅ ✅ ✅
Focus ✅ ✅ ✅ ✅
Glide ✅ ✅ ✅ ✅
Glitch ✅ ✅ ✅ ✅
Hexagon ✅ ✅ ✅ ✅
Incinerate ✅ ✅ ✅ ✅
Matrix ✅
Paint Brush ✅
Pixelate ✅ ✅ ✅ ✅
Pixel Wheel ✅ ✅ ✅ ✅
Pixel Wipe ✅ ✅ ✅ ✅
Portal ✅ ✅ ✅ ✅
Snap of Disintegration ✅
T-Rex Attack ✅
TV Effect ✅ ✅ ✅ ✅
TV Glitch ✅ ✅ ✅ ✅
Wisps ✅ ✅ ✅ ✅

💞 Show that you love Burn-My-Windows!

kofi github paypal crypto

While coding new features or translating Burn-My-Windows is the most awesome way to contribute, providing financial support will encourage me to invest my spare time for developing free and open-source software.

These awesome people have already donated to the development of my open-source projects:

Sponsors List

⬇️ 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).

a) Installing from extensions.gnome.org

This is the easiest way to install the Burn-My-Windows extension. Just head over to extensions.gnome.org and flip the switch! If you want to use a more up-to-date version, you can try one of the methods listed below.

b) Downloading a Stable Release

Execute this command to download the latest stable release:

wget https://github.com/Schneegans/Burn-My-Windows/releases/latest/download/[email protected]

Install it by executing the following command. If you have the Burn-My-Windows extension already installed and want to upgrade to the latest version, append the --force flag in order to overwrite existing installs of the Burn-My-Windows extension.

gnome-extensions install [email protected]

Then restart GNOME Shell with Alt + F2, r + Enter. Or logout / login if you are on Wayland. Then you can enable the extension with the Gnome Tweak Tool, the Extensions application or with this command:

gnome-extensions enable [email protected]

c) Cloning the Latest Version with git

You should not clone the Burn-My-Windows extension directly to the ~/.local/share/gnome-shell/extensions directory as this may get overridden occasionally! Execute the clone command below where you want to have the source code of the extension.

git clone https://github.com/Schneegans/Burn-My-Windows.git
cd Burn-My-Windows

If your GNOME Shell version is <= 45, you will have to checkout the gnome-3.36-44 branch:

git checkout gnome-3.36-44

Now you will have to install the extension. The make command below compiles the locales, schemas and resources, creates a zip file of the extension and finally installs it with the gnome-extensions tool.

make install

Then restart GNOME Shell with Alt + F2, r + Enter. Or logout / login if you are on Wayland. Then you can enable the extension with the Gnome Tweak Tool, the Extensions application or with this command:

gnome-extensions enable [email protected]

⬇️ Installation (KWin)

You can either download the effects from the KDE store (a), download a stable version from GitHub (b) or clone the latest version directly with git (c).

Important

You need at least KWin 5.25.0 for the Burn-My-Windows effects.

Note

If the color picker widgets in the effect settings do not work for you, you may have to install a package called libkf5widgetsaddons-dev (Kubuntu, KDE Neon, ...) or kf5-kwidgetsaddons-devel, kwidgetsaddons-devel (Fedora, OpenSuse, ...).

a) Download from the KDE Store

Here are links to all effects which are currently available in the KDE store:

Plasma 5 Plasma 6
Doom Doom
Energize A Energize A
Energize B Energize B
Fire Fire
Focus Focus
Glide Glide
Glitch Glitch
Hexagon Hexagon
Incinerate Incinerate
Pixelate Pixelate
Pixel Wheel Pixel Wheel
Pixel Wipe Pixel Wipe
Portal Portal
TV-Effect TV-Effect
TV-Glitch TV-Glitch
Wisps Wisps

You can also directly get the effects from within your system settings. Just go to your System Settings, then "Workspace Behavior", and "Desktop Effects". Then click on "Get new Desktop Effects...".

b) Downloading a Stable Release

Execute this command to download the latest stable release:

# For Plasma 5
wget https://github.com/Schneegans/Burn-My-Windows/releases/latest/download/burn_my_windows_kwin5.tar.gz

# For Plasma 6
wget https://github.com/Schneegans/Burn-My-Windows/releases/latest/download/burn_my_windows_kwin6.tar.gz

Install it by executing the following commands.

mkdir -p ~/.local/share/kwin/effects

# For Plasma 5
tar -xf burn_my_windows_kwin5.tar.gz -C ~/.local/share/kwin/effects

# For Plasma 6
tar -xf burn_my_windows_kwin6.tar.gz -C ~/.local/share/kwin/effects

Then select the desired effects in the system settings under "Desktop Effects".

c) Cloning the Latest Version with git

Execute the clone command below where you want to have the source code of the extension.

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.

./kwin/build.sh
mkdir -p ~/.local/share/kwin/effects

# For Plasma 5
tar -xf kwin/burn_my_windows_kwin5.tar.gz -C ~/.local/share/kwin/effects

# For Plasma 6
tar -xf kwin/burn_my_windows_kwin6.tar.gz -C ~/.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! Most likely, you want to create a new effect or to translate the extension? Here are some basic rules to get you started: Commits should start with a Capital letter and should be written in present tense (e.g. 🎉 Add cool new feature instead of 🎉 Added cool new feature). You should also start your commit message with one applicable emoji. This does not only look great but also makes you rethink what to add to a commit. Make many but small commits!

Emoji Description
🎉 :tada: When you added a cool new feature.
🔧 :wrench: When you added a piece of code.
♻️ :recycle: When you refactored a part of the code.
✨ :sparkles: When you applied clang-format.
🌐 :globe_with_meridians: When you worked on translations.
🎨 :art: When you improved / added assets like themes.
💄 :lipstick: When you worked on the UI of the preferences dialog.
🚀 :rocket: When you improved performance.
📝 :memo: When you wrote documentation.
🪲 :beetle: When you fixed a bug.
💞 :revolving_hearts: When a new sponsor is added or credits are updated.
✔️ :heavy_check_mark: When you worked on checks or adjusted the code to be compliant with them.
🔀 :twisted_rightwards_arrows: When you merged a branch.
🔥 :fire: When you removed something.
🚚 :truck: When you moved / renamed something.