README

CinnamonBurnMyWindows

Window open, close, minimize and unminimize effects for the Cinnamon desktop

This is a Cinnamon port of the Gnome extension Burn-my-Windows which can be found here:

https://github.com/Schneegans/Burn-My-Windows

Also includes a port of the Gnome Magic Lamp effect which can be found here:

https://github.com/hermes83/compiz-alike-magic-lamp-effect

Please go to the above links and support their projects since this is merely a port of their fine work! But DO NOT use these Github links to report issues. See Feedback section below

Requirements

Cinnamon 6.2 (Mint 22) or better.

This extension needs the Cinnamon.GLSLEffect class which is only available in Cinnamon 6.2 or better.

Known issues

1. When closing the Steam Client "setting" window the 'close window effect' does not show the windows contents, resulting in the closing effect to show where the window had existed but otherwise has no negative effect.
2. When running VirtualBox, some actions (like restarting Cinnamon or changing panel hide settings) will show a full screen animation of both the Open and Close effect. I assume this is caused by some weirdness with how VirtualBox was written. The problem can be avoided by using two "Application specific settings" list entries to disable open/close animations for the "VirtualBox" and "VirtualBoxVM" WM_CLASS names (entered under the "Application" entry box). New installs of this extension will have these entries by default, but installs that are upgraded to the latest version will need to manually enter these app rules to avoid the issues.
3. The Doom open effect seems to finish animating at a noticeably lower position than where the window is actually located. This results in the sudden jump up after the animation is completed. When used as a close effect it works correctly. There is a Doom effect option called "Y offset fix for open/unminimize events" which allows you to manually fix this issue while I look for a proper fix that works for everyone.
4. The window shadows are not part of the animation and therefore they suddenly appear or disappear right after or before the animation.
5. After upgrading to 0.9.8 the Fire effect setting and the effects included in the randomized sets will be reset to default.
6. After upgrading to 1.0.1 the Fire and Mushroom preset selections will be reset to default.

Currently these effects are working in Cinnamon:

• Apparition
• Aura Glow
• Doom
• Energize A
• Energize B
• Fire
• Focus
• Glide
• Glitch
• Hexagon
• Incinerate
• Magic Lamp
• Mushroom
• Pixelate
• Pixel Wheel
• Pixel Wipe
• Portal
• RGB Warp
• Team Rocket
• TV Effect
• TV Glitch
• Wisps

Effects currently disabled:

Because Cinnamon is missing a required API, the following effects are disabled. I am hoping I can enable these effect when Cinnamon 6.6 is available later this year:

• Broken Glass
• Matrix
• PaintBrush
• Snap Of Disintegration
• TRex Attack

Installation

1. Right click on the cinnamon panel and click "System Settings"
2. Click on the "Extensions" icon under the "Preferences" category
3. Click the "Download" tab and then click the "Burn My Windows" entry
4. Click the "Install" button on the right and then return to the "Manage" tab
5. Select the new "Burn My Windows" entry and then click the "+" button at the bottom of the window
6. Use the "gears" icon next to the "Burn My Windows" entry to open the setting window and setup the preferred behaviour

Feedback

Please leave a comment here on cinnamon-spices.linuxmint.com or you can create an issue on my Github (https://github.com/klangman/CinnamonBurnMyWindows) to give me feedback or to report any issues you find. Please DO NOT open any issues against the original Gnome project. Open issues only on my Github or on cinnamon-spices so I can check if the issue has anything to do with my changes to support Cinnamon

If you like this extension, please consider making a donation to the author of the original Gnome extension which makes up the vast majority of the code for this Cinnamon extension. Donation links can be found on his Github page:

https://github.com/Schneegans/Burn-My-Windows

If you want to help others find this Cinnamon extension, consider staring it here and on my Github page so that more people might learn of it's existence. The more stars it gets the more encouragement I'll have to continue working on it. Thanks!

Credits

Ported to Cinnamon by Kevin Langman

https://github.com/klangman/CinnamonBurnMyWindows

Based on the Burn-My-Windows code by Schneegans and contributors

https://github.com/Schneegans/Burn-My-Windows

The Magic Lamp Effect is based on code by hermes83

https://github.com/hermes83/compiz-alike-magic-lamp-effect

CHANGELOG

Changelog

1.0.3

• Fix the location of the icon file used in the About tab of the configuration window.
• Add power management feature: Added a "Power" tab to the configuration window where you can configure BurnMyWindows to use different effects (or no effects at all) when running on battery power and the battery charge stage is below a limit you set. (disabled by default)
• Fix to properly disconnect variable bindings on extension disable / upgrade

1.0.2

• Fixed a bug that results in the inability to minimize/unminimze windows after disabling the Burn-My-Windows extension.

1.0.1

• Fix Fire and Mushroom effect presets when using a translation of Burn-My-Windows. Note: This fix will reset the prefix settings to default so you will need to reconfigure the extension to use your desired preset if you had previously setup a preset other then the default one.
• Added "Open/Close Edge" and "Open/Close Offset" options under the Magic Lamp effect settings. These options allow you to set the monitor edge location where the Magic Lamp effect will animate from/to for open and close events. The default will be the "Closest edge to mouse pointer" but you can set it to a specific edge and offset. For example, you could direct the animations to towards the Main Menu location. These options only apply to Open/Close events as the minimize/unminimize events will continue to use the location of the windows icon on the window-list as it's source/target location.
• Make the custom scale widget show tooltips when hovering over the widgets label rather than just when hovering the scale bar.

1.0.0

Here we are at version 1.0. I had hoped to have the full suite of effects enabled for version 1.0, but that will have to wait for version 1.1 when Cinnamon 6.6 is out 🤞. I wanted to get this release out there since it has two fixes that makes the current feature set work without any major issues, so in that way maybe it is a suitable 1.0 release after all!

• Fixed the Magic Lamp effect to address the window flashing on minimize problem.
• Fixed the problem where no effect is activated when using "Randomized" for the "Unminimize window effect".
• Improved the wording of the Magic Lamp "Type of effect" drop down menu items.

0.9.9b

• Fix broken version 0.9.9, I forgot to copy over some changes from my dev branch for 0.9.9

0.9.9

• Added a "Reset to default" button for each effect under the "Effect Settings" tab.
• Added an "Open effect preview window" button to "Effect Settings" tab. It opens a preview window to test out the currently selected effect in the "Show setting for effect" drop down list.
• Added a custom "scale" widget that puts the label, scale, and number in a line to save GUI space. It also "marks" the default value for the setting.
• Fixed the issue where some setting under the "Effect Settings" were not appearing properly after changing the "Show settings for effect" drop-down. It turns out that adding a common element at the end of the effect settings somehow makes the issue disappear. So I didn't really "fix" anything but adding the "Open effect preview window" button at the bottom of the effect settings section has the added benefit of avoiding the issue.
• Added a custom "About page" widget to improve the look of the about tab and changed the URLs to clickable links. Also added a "Report an issue" link and the version number to the about tab.
• Added buttons to set or clear all the random set check boxes.
• Added BMW Gnome version changes to add a random color option to the Fire effect, also added a "Nuclear" preset.
• Added an Doom setting option to manually adjust the target location for the Doom open effect so that people can work-around the Doom effect issue while I work on finding a proper fix.

0.9.8

• Added new effects from the Gnome version (Aura Glow, Mushroom, RGB Warp, Team Rocket)
• Added Magic Lap effect based on hermes83/compiz-alike-magic-lamp-effect (same as CinnamonMagicLamp)
• Added the ability to apply effects to the minimize & unminimize events
• Fixed an issue where the window was jumping a pixel to the right post open animation (finally!)
• Added Fire effect presets (5 pre-configured fire setups)
• Changed the Random Effects tab to use a standard List widget
• Moved the Application Specific settings options to it's own tab
• Added a custom color selection widget to save configurator GUI space
• Use WM_CLASS when adding a app specific setting if no app can be found
• Improvements to the Focus effect (from Gnome version)
• Added an "About" tab with credits to the various authors

0.9.7

• Added options in the configuration that allows you to define which effects will be used (if any) for dialog windows (i.e. a file open dialog). This allows you to use a more subtle or shorter running effect (i.e focus or glide) for all the dialog windows which are typically opened/closed more frequently.
• Added support for using WM_CLASS names in the "application specific settings" table in the config.
• Added two default "application specific settings" table entries for "VirtualBox" and "VirtualBoxVM. This addresses the Virtualbox issue described in the readme.md

0.9.6

• Enabled the "Fire" effect
• Apply a visual fix to "Incinerate" that was fixed in the Gnome extension recently
• Reordered the code to make it a bit easier to maintain

0.9.5

• Added a new "Focus" effect by Justin Garza

0.9.4

• Fixed an issue that could interfere with other Cinnamon effects by returning true from Cinnamon's _shouldAnimate(). Some effects like Restore and Manximize might occur even when they were disabled in the Cinnamon Effects setting application. Also some BurnMyWindows effect could happen on events other than window open/close events (but I didn't ever see this occur myself).

0.9.3

• Fix Randomized effects so that when the Doom effect is enabled under "Random Effects" it can actually be randomly selected for use

0.9.2

• Added application specific effect settings that override the default effects setting when a specific application window is opened/closed
• Added a "none" options to the effect drop-down lists which will perform no effect and allow the cinnamon default effect to apply
• Added a button in the General configuration tab which will add an "Application Specific Settings" table entry for the application of the window that last had the focused.

0.9.1

• Initial version committed to cinnamon spices