BlueGit

timfa kwin-marble

Files

kwin-marble / README.md

README.md

README.md 2.7 KiB Download Raw

Marble – KWin close & minimize effects (Burn-My-Windows variant)

NL – KWin 6 (Plasma 6) sluit-animatie: het venster vormt zich soepel om tot een kleine, glanzende knikker (inhoud blijft zichtbaar), blijft even stil liggen en valt daarna met echte zwaartekracht (constante versnelling vanuit stilstand) 1,5 schermhoogte omlaag, uit beeld.

EN – KWin 6 (Plasma 6) window-close animation: the window smoothly morphs into a small glossy marble (content stays visible), pauses, then drops off-screen under real gravity (constant acceleration from rest) for 1.5 screen heights.

filmstrip

Marble Magic Lamp (minimize)

NL – kwin6_effect_marble_minimize: bij minimaliseren vormt het venster zich net zo om tot een knikker, pauzeert, en valt dan in een rechte lijn met zwaartekracht (vanuit stilstand) naar zijn taakbalkknop. Herstellen is een korte fade-in. Zelfde instellingen en defaults.

EN – kwin6_effect_marble_minimize: on minimize the window becomes the same marble, pauses, then falls in a straight line under gravity (from rest) to its taskbar entry. Restore is a short fade-in. Same settings and defaults. It replaces the active minimize animation (e.g. Magic Lamp).

Installatie / Installation

cp -r kwin6_effect_marble kwin6_effect_marble_minimize ~/.local/share/kwin/effects/

Then enable Marble [Burn-My-Windows variant] in System Settings → Window Management → Desktop Effects (it replaces the active close animation; only one can be active). Log out/in if it does not show up.

Instellingen / Settings

KeyDefaultMeaning
Duration300 msMorph into the marble
Pause600 msMarble rests before falling
Gravity4000 px/s²Fall acceleration; fall time = sqrt(2·distance / g) (close: 1.5 screen heights; minimize: distance to taskbar entry)

All durations are scaled by Plasma's global animation speed.

Licentie / License & attribution

GPL-3.0-or-later (see LICENSE). This effect is a modified derivative of the KWin port of Energize B from Burn-My-Windows by Simon Schneegans (GPL-3.0-or-later), whose KWin effect code also credits Martin Flöser and Vlad Zahorodnii. The common shader prelude and main.js structure come from that project; the marble shader, gravity fall and settings are new. Original copyright notices are kept in the source files. Modified by Tim Falken, 2026.

Source
1# Marble – KWin close & minimize effects (Burn-My-Windows variant)
2
3**NL** – KWin 6 (Plasma 6) sluit-animatie: het venster vormt zich soepel om tot een kleine,
4glanzende knikker (inhoud blijft zichtbaar), blijft even stil liggen en valt daarna met echte
5zwaartekracht (constante versnelling vanuit stilstand) 1,5 schermhoogte omlaag, uit beeld.
6
7**EN** – KWin 6 (Plasma 6) window-close animation: the window smoothly morphs into a small glossy
8marble (content stays visible), pauses, then drops off-screen under real gravity (constant
9acceleration from rest) for 1.5 screen heights.
10
11![filmstrip](docs/filmstrip.png)
12
13## Marble Magic Lamp (minimize)
14
15**NL** – `kwin6_effect_marble_minimize`: bij minimaliseren vormt het venster zich net zo om tot
16een knikker, pauzeert, en valt dan in een rechte lijn met zwaartekracht (vanuit stilstand) naar
17zijn taakbalkknop. Herstellen is een korte fade-in. Zelfde instellingen en defaults.
18
19**EN** – `kwin6_effect_marble_minimize`: on minimize the window becomes the same marble, pauses,
20then falls in a straight line under gravity (from rest) to its taskbar entry. Restore is a short
21fade-in. Same settings and defaults. It replaces the active minimize animation (e.g. Magic Lamp).
22
23## Installatie / Installation
24
25```sh
26cp -r kwin6_effect_marble kwin6_effect_marble_minimize ~/.local/share/kwin/effects/
27```
28
29Then enable **Marble [Burn-My-Windows variant]** in System Settings → Window Management →
30Desktop Effects (it replaces the active close animation; only one can be active). Log out/in if
31it does not show up.
32
33## Instellingen / Settings
34
35| Key | Default | Meaning |
36|------------|---------|-----------------------------------------------------------------|
37| `Duration` | 300 ms | Morph into the marble |
38| `Pause` | 600 ms | Marble rests before falling |
39| `Gravity` | 4000 px/s² | Fall acceleration; fall time = sqrt(2·distance / g) (close: 1.5 screen heights; minimize: distance to taskbar entry) |
40
41All durations are scaled by Plasma's global animation speed.
42
43## Licentie / License & attribution
44
45GPL-3.0-or-later (see `LICENSE`). This effect is a modified derivative of the KWin port of
46**Energize B** from [Burn-My-Windows](https://github.com/Schneegans/Burn-My-Windows) by
47Simon Schneegans (GPL-3.0-or-later), whose KWin effect code also credits Martin Flöser and
48Vlad Zahorodnii. The common shader prelude and `main.js` structure come from that project; the
49marble shader, gravity fall and settings are new. Original copyright notices are kept in the
50source files. Modified by Tim Falken, 2026.