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

https://github.com/achu94/gnome-wallpaper-engine

gnome live-wallpaper wayland x11
https://github.com/achu94/gnome-wallpaper-engine

extension gnome gnome-shell gnome-shell-extension linux live-wallpapers mpv wallpaper wayland x11

Last synced: 2 days ago
JSON representation

gnome live-wallpaper wayland x11

Awesome Lists containing this project

README

          

# ๐ŸŒŒ GNOME Live Wallpaper Engine

No complex setup. No heavy dependencies. Just mpv, ffmpeg + the extension.

The **simplest and most reliable way** to use live wallpapers on GNOME โ€” fully compatible with **Wayland & X11**.

Powered by **mpv** for maximum performance, low resource usage, and full format support (MP4, GIF, WebM, MKVโ€ฆ).

If you like this project, consider giving it a star โญ โ€” it really helps!

## โ˜• Support & Updates

If youโ€™d like to support the project, you can do so here:

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/achu94)

Iโ€™ll also be sharing development updates, progress, and behind-the-scenes work on Ko-fi.

You donโ€™t need to donate to see the posts โ€” everyone is welcome to follow along and stay updated ๐Ÿ™‚

And if you enjoy the project, a โญ on GitHub is always appreciated!

---

## ๐ŸŽฅ Demo

> Live wallpaper running on GNOME (Wayland)

![demo](https://raw.githubusercontent.com/achu94/gnome-wallpaper-engine/main/assets/demo.gif)

---

## โœจ Features

- ๐ŸŽฌ **Integrated Gallery:** Browse and select wallpapers directly from GNOME Settings
- ๐Ÿ–ผ๏ธ **Thumbnail Previews:** Automatically generated previews for all wallpapers
- ๐Ÿ“ฅ **Smart Import:** Add videos with one click and apply instantly
- ๐Ÿš€ **GPU Accelerated (enabled by default):** Uses mpv with `hwdec=auto`
- โšก **Very Low CPU Usage:** Typically ~1โ€“3%
- ๐Ÿ”„ **Instant Apply:** Switch wallpapers in real-time
- ๐Ÿ–ฅ๏ธ **Wayland Ready:** Works reliably where most tools fail
- ๐Ÿ“ฆ **Minimal Setup:** Only requires mpv and ffmpeg
- ๐ŸŽž๏ธ **Wide Format Support:** MP4, GIF, WebM, MKV and more
- ๐Ÿ” **Autostart:** Automatically start wallpaper on login
- ๐Ÿงฉ **Tray Icon Toggle:** Show or hide the top panel indicator
- โธ๏ธ **Auto Pause (Fullscreen):** Pauses when a fullscreen app is active
- ๐Ÿ”‹ **Auto Pause (Battery):** Pauses when running on battery to save power

---

## ๐Ÿšง Roadmap

- ๐ŸŽฎ Steam Wallpaper Engine integration (auto-detect and list compatible wallpapers)
- ๐ŸŽ›๏ธ Advanced playback settings (loop modes, speed, etc.)
- ๐ŸŽจ Future rendering engine (without mpv)

---

## ๐Ÿ›  Requirements

You only need **mpv** installed:

### Ubuntu / Debian / Zorin OS

```bash
sudo apt update && sudo apt install mpv ffmpeg
```

### Fedora

```bash
sudo dnf install mpv ffmpeg
```

### Arch Linux

```bash
sudo pacman -S mpv ffmpeg
```

### openSUSE

```bash
sudo zypper in mpv ffmpeg
```

## ๐Ÿ“ฆ Installation

### โšก Quick Install (Recommended)

```bash
gnome-extensions install gnome-wallpaper-engine@gjs.com.zip
```

Then:

- Wayland: Log out and log back in
- X11: Press `Alt + F2`, type `r`, press Enter

Finally, enable the extension using the **Extensions** app
(or via the top panel indicator if enabled).

---

### ๐Ÿงฉ Manual Install

1. Download the ZIP file from the latest release
2. Extract it to:

```
~/.local/share/gnome-shell/extensions/
```

3. Make sure the folder is named:

```
gnome-wallpaper-engine@gjs.com
```

4. Restart GNOME Shell
- Wayland: Log out and log back in
- X11: Press `Alt + F2`, type `r`, press Enter

5. Enable the extension using the **Extensions** app

---

## ๐Ÿ“– Usage

1. Open the extension settings
2. Click **"Add Video/GIF"**
3. Select a wallpaper from the gallery
4. Wallpapers are applied instantly
5. Optionally use the top panel indicator to start or stop playback
6. Optionally hide the tray icon from the settings

---

## ๐Ÿ’ก Why this exists

I built this to solve the lack of simple and reliable live wallpaper solutions on GNOME, especially on Wayland.

---

## โš–๏ธ License

GPL-3.0 โ€” free and open source.