Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/catsout/wallpaper-engine-kde-plugin
A kde wallpaper plugin integrating wallpaper engine
https://github.com/catsout/wallpaper-engine-kde-plugin
kde live-wallpaper video-wallpaper wallpaper-engine
Last synced: 18 days ago
JSON representation
A kde wallpaper plugin integrating wallpaper engine
- Host: GitHub
- URL: https://github.com/catsout/wallpaper-engine-kde-plugin
- Owner: catsout
- License: gpl-2.0
- Created: 2020-11-08T15:08:36.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-03T05:36:00.000Z (about 2 months ago)
- Last Synced: 2024-11-03T06:21:09.594Z (about 2 months ago)
- Topics: kde, live-wallpaper, video-wallpaper, wallpaper-engine
- Language: QML
- Homepage: https://store.kde.org/p/1475528/
- Size: 5.12 MB
- Stars: 1,778
- Watchers: 28
- Forks: 78
- Open Issues: 139
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-useful-projects - <img src="https://icon.horse/icon/github.com" height="20px" align="center"/>/catsout/wallpaper-engine-kde-plugin - Wallpaper Engine for KDE (Jump To / Customizations)
- awesome-useful-projects - <img src="https://icon.horse/icon/github.com" height="20px" align="center"/>/catsout/wallpaper-engine-kde-plugin - Wallpaper Engine for KDE (Jump To / Customizations)
README
# Wallpaper Engine for Kde
A wallpaper plugin integrating [wallpaper engine](https://store.steampowered.com/app/431960/Wallpaper_Engine) into kde wallpaper setting.
## Todo
- move scene to separate process
## Note
- Known issues:
- Some scene wallpapers may **crash** your KDE.
Remove `WallpaperSource` 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.
- Screen Locking is not supported, please not use this plugin in screen locking.
- Support **scene(2d)**,**video**,**web** wallpaper types
- Requires *Wallpaper Engine* installed on steam
- Requires C++20(gcc 10+)
- Requires Python 3.5+
- Requires Qt 5.13+ for playing video(no mpv), or mpv instead
- Requires Vulkan 1.1+, Opengl [External Memory Object](https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_external_objects.txt) extension
- Requires [vulkan driver](https://wiki.archlinux.org/title/Vulkan#Installation) installed
If you are using amd, please choose RADV driver.
## Install
Gentoo:
```sh
sudo emerge -av eselect-repository
sudo eselect repository enable gig
sudo emerge -av kde-misc/wallpaper-engine-kde-plugin
```
#### Dependencies
Debian:
```sh
sudo apt install build-essential libvulkan-dev plasma-workspace-dev gstreamer1.0-libav \
liblz4-dev libmpv-dev python3-websockets qtbase5-private-dev \
libqt5x11extras5-dev \
qml-module-qtwebchannel qml-module-qtwebsockets cmake
```
Fedora:
```sh
# Please add "RPM Fusion" repo first
sudo dnf install vulkan-headers plasma-workspace-devel kf5-plasma-devel gstreamer1-libav \
lz4-devel mpv-libs-devel python3-websockets qt5-qtbase-private-devel libplasma-devel \
qt5-qtx11extras-devel qt5-qtwebchannel-devel qt5-qtwebsockets-devel cmake
```
Arch:
```sh
sudo pacman -S extra-cmake-modules plasma-framework5 gst-libav ninja \
base-devel mpv python-websockets qt5-declarative qt5-websockets qt5-webchannel vulkan-headers cmake
```
Void:
```sh
sudo xbps-install -S extra-cmake-modules plasma-framework \
gst-libav base-devel mpv python3-websockets qt5-declarative qt5-websockets \
qt5-webchannel plasma-workspace-devel mpv-devel liblz4-devel Vulkan-Headers cmake
```
openSUSE:
```sh
# You'll need to add the Packman repository first
sudo zypper in vulkan-devel plasma-framework-devel plasma5-workspace-devel \
libqt5-qtwebsockets-devel mpv-devel python310-websockets \
libqt5-qtx11extras-devel liblz4-devel gstreamer-plugins-libav \
libqt5-qtbase-private-headers-devel cmake extra-cmake-modules
```
Fedora Kinoite:
see [install via rpm-ostree](rpm)
#### Note for kde store
Still need to run commands below to get scene and mpv work.
Every time you receive update in discover, you should run these commands to update.
#### Build and Install
```sh
# Download source
git clone https://github.com/catsout/wallpaper-engine-kde-plugin.git
cd wallpaper-engine-kde-plugin
# Download submodule
git submodule update --init --force --recursive
# Configure, build and install
# 'USE_PLASMAPKG=ON': using kpackagetool tool to install plugin
cmake -B build -S . -GNinja -DUSE_PLASMAPKG=ON
cmake --build build
cmake --install build
# Install package (ignore if USE_PLASMAPKG=OFF for system-wide installation)
cmake --build build --target install_pkg
```
#### Uninstall
1. remove files that list in `wallpaper-engine-kde-plugin/build/install_manifest.txt`
2. `kpackagetool6 -t Plasma/Wallpaper -r com.github.catsout.wallpaperEngineKde`
## Usage
1. *Wallpaper Engine* installed on Steam
2. Subscribe to some wallpapers on the Workshop
3. Select the *steamlibrary* folder on the Wallpapers tab of this plugin
- The *steamlibrary* which contains the *steamapps* folder
- This is usually `~/.local/share/Steam` by default
- *Wallpaper Engine* needs to be installed in this *steamlibrary*
### Restart KDE
You need to restart plasmashell after **reinstalling the plugin**
`systemctl --user restart plasma-plasmashell.service`
If you are using old kde, you can't run command above, please re-login.
## Support Status
### Scene:
Scene wallpapers are supported by vulkan 1.1
Requires *Wallpaper Engine* installed for assets(shaders,pictures...)
#### standalone
Only for testing and debug
Requires glfw
```
# git clone and init submodule
cd src/backend_scene/standalone_view
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_QML=ON
make -j$nproc
./sceneviewer --help
```
#### open-source libraries
[argparse](https://github.com/p-ranav/argparse) - Command line argument parser
[stb](https://github.com/nothings/stb) - Image loading
[vog/sha1](https://github.com/vog/sha1) - SHA-1
[effolkronium/random](https://github.com/effolkronium/random) - Random wrapper for modern C++
[miniaudio](https://github.com/mackron/miniaudio) - Audio loading and playback
[nlohmann/json](https://github.com/nlohmann/json) - Json parsing
[Eigen](https://eigen.tuxfamily.org/index.php) - Math operations
[glad](https://github.com/Dav1dde/glad) - Opengl loader
[glslang](https://github.com/KhronosGroup/glslang) - Glsl to Spv
[SPIRV-Reflect](https://github.com/KhronosGroup/SPIRV-Reflect) - C/C++ reflection API for SPIR-V bytecode
[VulkanMemoryAllocator](https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator) - Vulkan memory allocation library
#### supported
- [x] Layer
- [x] Image
- [x] Composition / Fullscreen
- [ ] Text
- [x] Effect
- [x] Basic
- [x] Mouse position with delay
- [x] Parallax
- [x] Depth Parallax
- [x] ColorBlendMode
- [x] PBR light
- [ ] Global bloom
- [x] Camera
- [x] Zoom
- [ ] Shake
- [ ] Fade / Path
- [x] Audio
- [x] Loop
- [ ] Random
- [ ] Visualization
- [x] Particle System
- [x] Renderers
- [x] Emitters
- [ ] Duration
- [x] Initializers
- [x] Operators
- [x] Control Points
- [ ] Mouse Follow
- [x] Children
- [ ] Audio Response
- [x] Puppet warp
- [ ] 3D model
- [ ] Timeline animations
- [ ] Scenescript
- [ ] User Properties
### Web
Basic web apis are supported, but the audio api does not send data for 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
The default video backend of this plugin.
It's using GStreamer to play video.
[hwdecode](https://wiki.archlinux.org/title/GStreamer#Hardware_video_acceleration) for GStreamer
#### Mpv
Need to compile the plugin lib.
The config is set to `hwdec=auto`, and is not configurable for now.
## Acknowledgments
- [RePKG](https://github.com/notscuffed/repkg)
- [RenderDoc](https://renderdoc.org/)
- [NVIDIA Nsight Graphics](https://developer.nvidia.com/nsight-graphics)
- [learnopengl.com](https://learnopengl.com/)
- [SaschaWillems/Vulkan](https://github.com/SaschaWillems/Vulkan)
- All the open-source libraries mentioned above
## Preview
