alvesvaren / wallpaper-engine-kde-plugin

A simple kde wallpaper plugin integrating wallpaper engine

Wallpaper Engine for Kde

A wallpaper plugin integrating wallpaper engine into kde wallpaper setting.

Note

• Known issue
  • Some scene wallpapers may crash your kde.
    Remove WallpaperFilePath line in ~/.config/plasma-org.kde.plasma.desktop-appletsrc and restart kde to fix.
  • Mouse long press(to enter panel edit mode) is broken on desktop
• Support scene(2d),video,web types
• Require wallpapaer engine installed by steam
• This plugin has(not required) a lib to be compiled, if you want any feature below
  • scene wallpaper
  • mpv video backend
  • mouse input

Contents

• Install
• Usage
• Support Status
• Acknowledgments
• Preview

Install

Kde plugin

Dependencies

qt-labs-folderlistmodel
qml-module-qtwebchannel

Install kde plugin

# Install
git clone https://github.com/catsout/wallpaper-engine-kde-plugin.git
plasmapkg2 -i wallpaper-engine-kde-plugin/plugin

# Update
plasmapkg2 -u wallpaper-engine-kde-plugin/plugin

# Uninstall
plasmapkg2 -r wallpaper-engine-kde-plugin/plugin

Plugin lib

Dependencies

Debian:

sudo apt install liblz4-dev qtbase5-private-dev qtbase5-dev qtdeclarative5-dev libqt5x11extras5-dev libmpv-dev  

Arch:

sudo pacman -S base-devel mpv qt5-declarative

Install plugin lib

cd wallpaper-engine-kde-plugin
mkdir build && cd build
cmake ..
make
sudo make install

Usage

1. Use steam+proton or wine+steam
2. Buy and install wallpaper engine(not run)
3. Subscribe some wallpapers on workshop(or the we app, if you can run it)
4. Let steam download wallpapers
5. Install this plugin, and select steam library dir(where wallpaper engine installed) in plugin
   e.g .local/share/Steam
6. Enjoy

Restart Kde

Need to restart kde(re-login) after updating plugin or reinstalling plugin lib
Or try: kquitapp5 plasmashell && kstart5 plasmashell

Support Status

Scene

Scene wallpaper is supported by direct opengl(3.2).
It's almost usable.

not work

• 3D model
• Timeline animations
• Puppet warp
• Scene script
• Text layer
• Audio visualization
• Camera shake,fade,path,zoom,parallax
• Global bloom effect
• Playing audio
• PBR light
• Perspective renderable
• Particle System
• Gif scene
• ColorBlendMode

Web

Basic web apis are supported, but the audio api dose not send data at now.

no webgl

WebEngineView in plasmashell can't init opengl.
Some wallpaper using webgl may not work, and performance may be bad.

Video HWdecode

QtMultimedia

Default video backend of this plugin.
It's using GStreamer to play video.
To enable hwdecode:

• GStreamer plugin installed like gstreamer1.0-vaapi in debain
• GST_VAAPI_ALL_DRIVERS=1 this needed for vaapi
  put it to where the xserver read.

Mpv

Need to compile plugin lib.
The config is set to hwdec=auto, and not configurable at now.

Acknowledgments

• RePKG
• RenderDoc
• NVIDIA Nsight Graphics

Preview