Skip to content

Repository files navigation

Open Wallpaper Engine

Made this for fun.

Scene Renderer

Open source scene renderer, mostly for linux.

  • vulkan 1.1
  • render graph for automatic pass dependencies

Web Renderer

CEF-based host for Wallpaper Engine web wallpapers.

How to use

Waywallen plugin

There are prebuilt zips in Releases page.
It only works for flatpak and appimage version of waywallen.

If you built waywallen yourself, you must build this.
If you use linux distribution package, you must install this as package too.

Standalone viewer

Build first — see BUILD.md. Examples below assume the clang-release build tree.

SceneViewer is a GLFW + Vulkan window that loads a Wallpaper Engine pkg directly. Point it at the Wallpaper Engine's assets/ directory and a scene.pkg:

./build/clang-release/viewer/SceneViewer \
    <wallpaper engine installed dir>/assets/ \
    <steamapps dir>/workshop/<id>/scene.pkg

Flags (see viewer/arg.hpp):

Flag Default Description
-R, --resolution WxH 1280x720 window size, e.g. 1920x1080
-f, --fps N 15 render fps
-M, --msaa N 1 MSAA samples for the screen RT (1/2/4/8/16; 1 = off)
-C, --cache-path DIR XDG cache shader/blob cache directory
-V, --valid-layer off enable Vulkan validation layers
-G, --graphviz off dump render graph to graph.dot

WebViewer is the CEF-backed HTML/JS counterpart (only built with BUILD_WEWEB=ON):

./build/clang-release/viewer/WebViewer \
    <steamapps dir>/workshop/<id> \
    --width 1920 --height 1080 \
    --presenter egl     # egl (default) or vulkan

Feature list

  • Layer
    • Image
    • Composition / Fullscreen
    • Text
  • Effect
    • Basic
    • Mouse position with delay
    • Parallax
    • Depth Parallax
    • ColorBlendMode
    • PBR light
    • Global bloom
  • Camera
    • Zoom
    • Shake
    • Path
  • Audio
    • Loop
    • Random
    • Visualization
  • Particle System
    • Renderers
    • Emitters
    • Initializers
    • Operators
    • Control Points
      • Mouse Follow
    • Children
    • Audio Response
  • Puppet
    • Mesh
    • Skeleton
    • Animation
    • Attachments (MDAT)
    • Mesh masks
    • Bone simulation
    • Morph (MDMP)
  • 3D model
  • Scenescript
  • User Properties

About

Open source wallpaper engine implement mostly for linux

Resources

Stars

141 stars

Watchers

3 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages