Simon Schneegans
157 lines
9.3 KiB
Markdown
157 lines
9.3 KiB
Markdown
<p align="center">
|
|
<a href="https://www.youtube.com/watch?v=L2aaNF_rPHo"><img src ="docs/pics/teaser.jpg" /></a>
|
|
</p>
|
|
|
|
<h1 align="center">🔥 Set GNOME Shell on Fire!</h1>
|
|
|
|
<p align="center">
|
|
<a href="https://extensions.gnome.org/extension/4679/burn-my-windows/"><img src="https://img.shields.io/badge/Download-extensions.gnome.org-e67f4d.svg?logo=gnome&logoColor=lightgrey&labelColor=303030" /></a><br/>
|
|
<a href="https://github.com/Schneegans/Burn-My-Windows/actions"><img src="https://github.com/Schneegans/Burn-My-Windows/workflows/Checks/badge.svg?branch=main" /></a>
|
|
<a href="LICENSE"><img src="https://img.shields.io/badge/License-GPLv3-blue.svg?labelColor=303030" /></a>
|
|
<a href="https://hosted.weblate.org/engage/burn-my-windows/"><img src="https://img.shields.io/weblate/progress/burn-my-windows?label=Translated&logo=weblate&logoColor=lightgray&labelColor=303030" /></a>
|
|
<a href="scripts/cloc.sh"><img src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/Schneegans/8cf45f23253ff09b21196e7271378762/raw/loc.json" /></a>
|
|
<a href="scripts/cloc.sh"><img src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/Schneegans/8cf45f23253ff09b21196e7271378762/raw/comments.json" /></a>
|
|
</p>
|
|
|
|
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!
|
|
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)!
|
|
|
|
|
|
Effect | Preview
|
|
-----|--------
|
|
**Apparition** <br> This effect hides your windows by violently sucking them into the void of magic! <br><br> _Only available in GNOME Shell 3.38+_ | <img src ="docs/pics/apparition.gif" />
|
|
**Broken Glass** <br> Shatter your windows into a shower sharp shards! This effect can be configured so that the shards fly away from your mouse pointer position! <br><br> _Only available in GNOME Shell 40+_ | <img src ="docs/pics/glass.gif" />
|
|
**Energize A** <br> Beam your windows away! | <img src ="docs/pics/energizeA.gif" />
|
|
**Energize B** <br> Using different transporter technology results in an alternative visual effect. | <img src ="docs/pics/energizeB.gif" />
|
|
**Fire** <br> 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. | <img src ="docs/pics/fire.gif" />
|
|
**Hexagon** <br> With glowing lines and hexagon-shaped tiles, this effect looks very sci-fi. | <img src ="docs/pics/hexagon.gif" />
|
|
**Matrix** <br> Turn your windows into a shower of green letters! The color is actually configurable. <br><br> _Only available in GNOME Shell 40+_ | <img src ="docs/pics/matrix.gif" />
|
|
**Snap of Disintegration** <br> Dissolve your windows into a cloud of dust. <br><br> _Only available in GNOME Shell 40+_ | <img src ="docs/pics/snap.gif" />
|
|
**T-Rex Attack** <br> Destroy your windows with a series of violent slashes! <br><br> _Only available in GNOME Shell 40+_ | <img src ="docs/pics/trex.gif" />
|
|
**TV-Effect** <br> This is a very simple effect to demonstrate that this extension could also be used in a more professional environment. | <img src ="docs/pics/tv.gif" />
|
|
**Wisps** <br> Let your windows be carried away to the realm of dreams by these little fairies! | <img src ="docs/pics/wisps.gif" />
|
|
**Your Effect!** <br> 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). | [](docs/how-to-create-new-effects.md)
|
|
|
|
|
|
## 💞 These People _love_ this Extension
|
|
|
|
While [coding new features](docs/how-to-create-new-effects.md) or [translating the extension](https://hosted.weblate.org/engage/burn-my-windows/) 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.
|
|
|
|
<h3 align="center">🥇 Current Gold Sponsors</h3>
|
|
<p align="center">
|
|
<a href="https://github.com/dennis1248">Dennis ten Hoove</a><br>
|
|
</p>
|
|
|
|
<h3 align="center">🥈 Current Silver Sponsors</h3>
|
|
<p align="center">
|
|
<a href="https://github.com/danielheadbang">@danielheadbang</a><br>
|
|
<a href="https://twitter.com/tjiiik">tj3k</a><br>
|
|
<a href="https://github.com/MRR-dev">@MRR-dev</a><br>
|
|
<a href="https://github.com/castrojo">Jorge Castro</a><br>
|
|
</p>
|
|
|
|
<h3 align="center">🥉 Current Bronze Sponsors</h3>
|
|
<p align="center">
|
|
<a href='https://github.com/AngelBrielez'>Angel Brielez</a>
|
|
</p>
|
|
|
|
<h3 align="center">🏅 Previous Sponsors and One-Time Donators</h3>
|
|
<p align="center">
|
|
<a href="https://github.com/MrTomRod">@MrTomRod</a><br>
|
|
Pouhiou<br>
|
|
DAPREMONT Christophe<br>
|
|
<a href="https://github.com/manero6">@manero6</a><br>
|
|
<a href="https://github.com/RickStanley">@RickStanley</a><br>
|
|
</p>
|
|
|
|
|
|
Do you want to show that you love it too? You may <a href="https://github.com/sponsors/Schneegans">become a sponsor for as little as 1$ / month</a>!
|
|
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/)!
|
|
|
|
## ⬇️ Installation
|
|
|
|
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](https://extensions.gnome.org/extension/4679/burn-my-windows/) 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:
|
|
|
|
```bash
|
|
wget https://github.com/Schneegans/Burn-My-Windows/releases/latest/download/burn-my-windows@schneegans.github.com.zip
|
|
```
|
|
|
|
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.
|
|
|
|
```bash
|
|
gnome-extensions install burn-my-windows@schneegans.github.com.zip
|
|
```
|
|
|
|
Then restart GNOME Shell with <kbd>Alt</kbd> + <kbd>F2</kbd>, <kbd>r</kbd> + <kbd>Enter</kbd>.
|
|
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:
|
|
|
|
```bash
|
|
gnome-extensions enable burn-my-windows@schneegans.github.com
|
|
```
|
|
|
|
### 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.
|
|
|
|
```bash
|
|
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.
|
|
|
|
```bash
|
|
make install
|
|
```
|
|
|
|
Then restart GNOME Shell with <kbd>Alt</kbd> + <kbd>F2</kbd>, <kbd>r</kbd> + <kbd>Enter</kbd>.
|
|
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:
|
|
|
|
```bash
|
|
gnome-extensions enable burn-my-windows@schneegans.github.com
|
|
```
|
|
|
|
## :octocat: I want to contribute!
|
|
|
|
That's great!
|
|
Most likely, you want to [create a new effect](docs/how-to-create-new-effects.md) or to [translate the extension](https://hosted.weblate.org/engage/burn-my-windows/)?
|
|
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. __:tada: Add cool new feature__ instead of __:tada: 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: `:tada:` | When you added a cool new feature.
|
|
:wrench: `:wrench:` | When you added a piece of code.
|
|
:recycle: `:recycle:` | When you refactored a part of the code.
|
|
:sparkles: `:sparkles:` | When you applied clang-format.
|
|
:globe_with_meridians: `:globe_with_meridians:` | When you worked on translations.
|
|
:art: `:art:` | When you improved / added assets like themes.
|
|
:lipstick: `:lipstick:` | When you worked on the UI of the preferences dialog.
|
|
:rocket: `:rocket:` | When you improved performance.
|
|
:memo: `:memo:` | When you wrote documentation.
|
|
:beetle: `:beetle:` | When you fixed a bug.
|
|
:revolving_hearts: `:revolving_hearts:` | When a new sponsor is added or credits are updated.
|
|
:heavy_check_mark: `:heavy_check_mark:` | When you worked on checks or adjusted the code to be compliant with them.
|
|
:twisted_rightwards_arrows: `:twisted_rightwards_arrows:` | When you merged a branch.
|
|
:fire: `:fire:` | When you removed something.
|
|
:truck: `:truck:` | When you moved / renamed something. |