Giter Club home page Giter Club logo

burn-my-windows's Introduction

๐Ÿ”ฅ Set GNOME Shell on Fire!

(and KWin as well)


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!

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!
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.
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.
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.
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 โœ… โœ… โœ… โœ…
Glide โœ… โœ… โœ… โœ…
Glitch โœ… โœ… โœ… โœ…
Hexagon โœ… โœ… โœ… โœ…
Incinerate โœ… โœ… โœ… โœ…
Matrix โœ…
Pixelate โœ… โœ… โœ… โœ…
Pixel Wheel โœ… โœ… โœ… โœ…
Pixel Wipe โœ… โœ… โœ… โœ…
Portal โœ… โœ… โœ… โœ…
Snap of Disintegration โœ…
T-Rex Attack โœ…
TV-Effect โœ… โœ… โœ… โœ…
Wisps โœ… โœ… โœ… โœ…

๐Ÿ’ž These People love this Extension

While coding new features or translating the extension are the most awesome ways to contribute, providing financial support will help me stay motivated to invest my spare time to keep the project alive in the future.

๐Ÿฅ‡ Current Gold Sponsors

D3vil0p3r
Maxence Sebald
Dennis ten Hoove

๐Ÿฅˆ Current Silver Sponsors

@danielheadbang
@MRR-dev
Jorge Castro

๐Ÿฅ‰ Current Bronze Sponsors

Angel Brielez

๐Ÿ… Previous Sponsors and One-Time Donators

@taconomix
@enolive
@Aggraxis
tj3k
@wolfyrion
@MrTomRod
Pouhiou
DAPREMONT Christophe
@manero6
@RickStanley

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 GNOME extensions: ๐ŸงŠ Desktop-Cube or ๐Ÿฐ Fly-Pie!

โฌ‡๏ธ 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

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

โš ๏ธ You need at least KWin 5.25.0 for the Burn-My-Windows effects.

โš ๏ธ 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 kwidgetsaddons-devel (Fedora, OpenSuse, ...).

a) Download from the KDE Store

You can 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 Effetcs...".

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/burn_my_windows_kwin4.tar.gz

Install it by executing the following commands.

mkdir -p ~/.local/share/kwin/effects
tar -xf burn_my_windows_kwin4.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
tar -xf kwin/burn_my_windows_kwin4.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.

burn-my-windows's People

Contributors

albanobattistella avatar allfred1 avatar atalanttore avatar coelacanthushex avatar comradekingu avatar creepen123 avatar d3vil0p3r avatar darkcircle avatar dasherpack avatar daudix avatar fitojb avatar ge0rgecz avatar jose1711 avatar kheyyam avatar lenemter avatar mbousq avatar nathanbnm avatar nullscroll avatar oscfdezdz avatar pedrovnasc avatar redxxiii avatar schneegans avatar sir-ivysaur avatar softexpert avatar umeaboy avatar vistaus avatar weblate avatar welaq avatar yehudaelyasaf avatar yuridm avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.