Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jeffshee/gnome-ext-hanabi

Live Wallpaper for GNOME
https://github.com/jeffshee/gnome-ext-hanabi

gnome gnome-shell-extension live-wallpaper video-wallpaper wallpaper

Last synced: about 2 months ago
JSON representation

Live Wallpaper for GNOME

Awesome Lists containing this project

README

        

Live Wallpaper for GNOME


Hanabi 花火【はなび】(n) fireworks


( ・ω・)o─━・*:'・:・゜'・:※

# Gnome Shell Extension - Hanabi

If you like my project, please consider buying me a coffee!! (⁎˃ ꇴ ˂⁎)ッ

[![Github-sponsors](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/jeffshee)
[![Ko-Fi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/jeffshee)
[![BuyMeACoffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://buymeacoffee.com/jeffshee)

Also please don't forget to hit that star button! 🌟
Feel free to open an issue for problems or suggestions 🤗
Your support is truly appreciated!

## Join our Discord!

[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/mP7yg4gX7g)

## Demo 📽️

Please click on the image to view (redirect to YouTube)

[![](https://i3.ytimg.com/vi/BWjXl4h9_BA/maxresdefault.jpg)](https://www.youtube.com/watch?v=BWjXl4h9_BA)
[Wallpaper used in demo](https://www.youtube.com/watch?v=2pBj0RKN3Y8)

## GNOME Shell Support

| Version | ≤41 | 42 | 43 | 44 | 45 | 46 | 47 |
| :-----: | :-: | :-: | :-: | :-: | :-: | :-: | :-: |
| Status | ⛔ | ✅ | ✅ | ✅ | ✅ | ✅ | 🚧 |

See also the section [Troubleshooting](#troubleshooting), for version-specific known issues.

## Installation

1. Clone the repo

- **For GNOME 47 (experimental)**

```
git clone https://github.com/jeffshee/gnome-ext-hanabi.git -b gnome-47
```

See also: https://github.com/jeffshee/gnome-ext-hanabi/issues/146

- **For GNOME 45 and later**
```
git clone https://github.com/jeffshee/gnome-ext-hanabi.git
```
- **For GNOME 44 and earlier**
```
git clone https://github.com/jeffshee/gnome-ext-hanabi.git -b legacy
```

2. Run the installation script (Require `meson`)

```
cd gnome-ext-hanabi
./run.sh install
```

3. Restart GNOME Shell
4. Enable the Hanabi extension
5. Choose your video wallpaper in the extension preference window

### Distro-specific Guides

- [Installation Guide for Ubuntu/Pop!\_OS 22.04](docs/ubuntu-22-04.md)
- [Installation Guide for Ubuntu 23.04](docs/ubuntu-23-04.md)
- [Installation Guide for openSUSE Tumbleweed](docs/opensuse-tumbleweed.md)

### Troubleshooting

1. The video doesn't play / The extension is enabled but nothing happens
The GTK4 media backend is not pre-installed on some distributions (such as PopOS).

To install the backend:
`sudo apt install libgtk-4-media-gstreamer`

2. High CPU usage during video playback (proprietary NVIDIA)
Your hardware acceleration may not work properly, see this [issue](https://gitlab.freedesktop.org/gstreamer/gst-plugins-bad/-/issues/1478).

To delete the GStreamer cache:
`rm -rf ~/.cache/gstreamer-1.0/`
After that, check if `gst-inspect-1.0 nvcodec` reports all its features.

3. The GNOME Shell keeps crashing after enabling Hanabi, help!
You can try to disable the extension from tty ( Ctrl + Alt + F3 ):
```
gnome-extensions disable [email protected]
```

### Optimization

Hanabi extension can utilize `clappersink` from [Clapper](https://github.com/Rafostar/clapper) for the best performance if installed.

For this to work, Clapper must be installed **from the package manager and not from Flatpak/Snap**.

Performance comparison

- With `clappersink`
![](https://user-images.githubusercontent.com/25530920/190872365-f1cefa30-6e11-40e4-bf99-1b79c3790d6b.png)

- Without `clappersink` (Using `Gtk.MediaFile` as default fallback)
![](https://user-images.githubusercontent.com/25530920/190872366-7fce5703-2310-4c68-81c7-f17a8a15019f.png)

## Advanced Customization

For more advanced customization, learn how to write scripts for Hanabi extension!
Check out the [scripting guide](docs/scripting.md) for detailed instructions and examples.

## Get Involved 🚀

Contributors are welcome! Let's make Hanabi extension better together~
If you're interested in translating, you can help on [Hosted Weblate](https://hosted.weblate.org/projects/gnome-ext-hanabi/gnome-ext-hanabi/).

### Translation Status

[![Translation status](https://hosted.weblate.org/widget/gnome-ext-hanabi/gnome-ext-hanabi/multi-auto.svg)](https://hosted.weblate.org/engage/gnome-ext-hanabi/)

### Contributors ✨



Made with [contributors-img](https://contrib.rocks).
Icons made by [Freepik](http://www.freepik.com/) from [Flaticon](https://www.flaticon.com)