https://github.com/zzag/plasma5-wallpapers-dynamic
Dynamic wallpaper plugin for KDE Plasma
https://github.com/zzag/plasma5-wallpapers-dynamic
dynamic plasma wallpaper
Last synced: 6 months ago
JSON representation
Dynamic wallpaper plugin for KDE Plasma
- Host: GitHub
- URL: https://github.com/zzag/plasma5-wallpapers-dynamic
- Owner: zzag
- Created: 2018-08-06T17:45:16.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-02-28T21:15:48.000Z (over 2 years ago)
- Last Synced: 2024-04-26T20:36:48.935Z (about 2 years ago)
- Topics: dynamic, plasma, wallpaper
- Language: C++
- Size: 8.45 MB
- Stars: 317
- Watchers: 8
- Forks: 17
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSES/BSD-3-Clause.txt
Awesome Lists containing this project
- awesome-kde - Dynamic Wallpaper Engine - A wallpaper plugin that continuously updates the desktop background based on the current time in your location. (Customization / Plasma desktop)
README
# Dynamic Wallpaper Engine
A wallpaper plugin for KDE Plasma that continuously updates the desktop background
based on the current time in your location.
## Additional Wallpapers
More dynamic wallpapers can be found at https://github.com/karmanyaahm/awesome-plasma5-dynamic-wallpapers.
## Installation
#### Arch Linux
```
yay -S plasma5-wallpapers-dynamic
```
#### Fedora
```
sudo dnf install plasma-wallpapers-dynamic
```
In order to use the dynamic wallpaper builder tool, install `plasma-wallpapers-dynamic-builder` package.
#### Ubuntu 20.10
```
sudo apt install plasma-wallpaper-dynamic
```
## Building From Git
**Note**: master branch targets Plasma 6. If you use Plasma 5, check the [latest release](https://github.com/zzag/plasma5-wallpapers-dynamic/releases/latest).
In order to build this wallpaper plugin from source code, you need to install a
couple of prerequisites
Arch Linux:
```sh
sudo pacman -S cmake extra-cmake-modules git plasma-framework qt5-base qt5-declarative \
qt5-location libexif libavif
```
Fedora:
```sh
sudo dnf install cmake extra-cmake-modules git kf5-kpackage-devel kf5-plasma-devel \
kf5-ki18n-devel qt5-qtbase-devel qt5-qtdeclarative-devel qt5-qtlocation-devel \
libexif-devel libavif-devel qt5-qtbase-private-devel
```
Ubuntu:
```sh
sudo apt install cmake extra-cmake-modules git libkf5package-dev libkf5plasma-dev \
libkf5i18n-dev qtbase5-dev qtdeclarative5-dev qtpositioning5-dev gettext \
qml-module-qtpositioning libexif-dev libavif-dev build-essential qtdeclarative5-private-dev \
qtbase5-private-dev
```
Once all prerequisites are installed, you need to grab the source code
```sh
git clone https://github.com/zzag/plasma5-wallpapers-dynamic.git
cd plasma5-wallpapers-dynamic
```
Configure the build
```sh
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX=/usr \
-DCMAKE_INSTALL_LIBDIR=lib \
-DBUILD_TESTING=OFF
```
Now trigger the build by running the following command
```sh
make
```
To install run
```sh
sudo make install
```
## How to Use It
Right-click a blank area of the desktop and choose "Configure Desktop...", select
"Dynamic" wallpaper type and click the Apply button.
## How to Create a Dynamic Wallpaper
The `kdynamicwallpaperbuilder` command line tool is used to create dynamic wallpapers. As input,
it takes a manifest json file describing the wallpaper and produces the wallpaper
```sh
kdynamicwallpaperbuilder path/to/manifest.json --output wallpaper.avif
```
This engine supports several types of dynamic wallpapers - _solar_ and _day-night_.
### How to Create a Solar Dynamic Wallpaper
With a solar dynamic wallpaper, the engine will try to keep the images in sync with the Sun
position at your location.
The manifest file looks as follows
```json
{
"Type": "solar",
"Meta": [
{
"SolarAzimuth": "*",
"SolarElevation": "*",
"CrossFade": true,
"Time": "*",
"FileName": "0.png"
}, {
"SolarAzimuth": 0,
"SolarElevation": -90,
"CrossFade": true,
"Time": "00:00",
"FileName": "1.png"
}, {
"SolarAzimuth": 90,
"SolarElevation": 0,
"CrossFade": true,
"Time": "06:00",
"FileName": "2.png"
}, {
"SolarAzimuth": 180,
"SolarElevation": 90,
"CrossFade": true,
"Time": "12:00",
"FileName": "3.png"
}
]
}
```
The `SolarAzimuth` field and the `SolarElevation` field specify the position of the Sun when the
associated picture was taken. The `Time` field specifies the time, which is in 24-hour format, when
the picture was taken. If the user is not located near the North or the South Pole, the dynamic
wallpaper engine will try to show images based on the current position of the Sun; otherwise it will
fallback to using time metadata.
Only the `Time` field is required, the position of the Sun is optional.
The `CrossFade` field indicates whether the current image can be blended with the next one. The
cross-fading is used to make transitions between images smooth. By default, the `CrossFade` field is
set to `true`. Last, but not least, the `FileName` field specifies the file path of the image
relative to the manifest json file.
Now that you have prepared all images and a manifest file, it's time pull out big guns. Run the
following command
```sh
kdynamicwallpaperbuilder path/to/manifest.json
```
If the command succeeds, you will see a new file in the current working directory `wallpaper.avif`,
which can be used as a dynamic wallpaper.
Note that encoding the dynamic wallpaper may take a lot of memory (AVIF encoders are very memory
hungry) and time!
#### Computing the position of the Sun based on GPS image metadata
`SolarAzimuth`, `SolarElevation`, and `Time` fields can have a special value of `*`. In which case,
`kdynamicwallpaperbuilder` will use the Exif metadata in the image to fill them. An image must
contain the following GPS [EXIF tags](https://exiftool.org/TagNames/GPS.html) to compute the position
of the Sun:
- `GPSLatitude` and `GPSLatitudeRef`
- `GPSLongitude` and `GPSLongitudeRef`
- `GPSTimeStamp` and `GPSDateStamp`
The calculated position of the Sun can be viewed by passing `--verbose` to the `kdynamicwallpaperbuilder` command.
### How to Create a Day/Night Dynamic Wallpaper
A day/night dynamic wallpaper consists of only two images - one for the day, and one for the night.
The engine will automagically figure out which one to use based on the current time or the Sun
position at your location.
The manifest file for a day/night wallpaper looks as follows
```sh
{
"Type": "day-night",
"Meta": [
{
"TimeOfDay": "day",
"FileName": "day.png"
}, {
"TimeOfDay": "night",
"FileName": "night.png"
}
]
}
```
## How to Use Dynamic Wallpapers for macOS
Since dynamic wallpapers for macOS and this plugin are incompatible, you need to use a script to
convert dynamic wallpapers.
```sh
curl -sLO https://raw.githubusercontent.com/zzag/plasma5-wallpapers-dynamic-extras/master/dynamicwallpaperconverter
chmod +x dynamicwallpaperconverter
```
Once you've downloaded the dynamicwallpaperconverter script, you can start converting wallpapers
```sh
./dynamicwallpaperconverter --crossfade file.heic
```
After the command above has finished its execution, you should see a file in the current working
directory named `wallpaper.avif`, which can be fed into this plugin.
If it takes too long to encode the wallpaper as an avif file, you can change the encoding
speed. Note that the encoding speed affects the final file size!
```sh
./dynamicwallpaperconverter --speed 5 --crossfade file.heic
```
For more details, check the output of `./dynamicwallpaperconverter --help`.