@@ -8,23 +8,46 @@ Noctalia does not decode video itself. This plugin runs `mpvpaper`, which draws
88outputs you assign a video to — so the video shows through, with the bar and dock still
99drawn above it.
1010
11+ ## Plugin
12+
13+ | Field | Value |
14+ | --- | --- |
15+ | ID | ` noctalia/mpvpaper ` |
16+ | Entries | Service: ` service ` ; Panel: ` picker ` ; bar widget: ` mpvpaper ` |
17+
1118## Requirements
1219
13- - ` mpvpaper ` (which pulls in ` mpv ` ). ` mpv ` is also used to render the picker thumbnails.
20+ Install ` mpvpaper ` and ` mpv ` on ` PATH ` . ` mpvpaper ` renders the wallpaper
21+ surface, and ` mpv ` renders picker thumbnails.
1422
1523The plugin works on ` wlr-layer-shell ` compositors (Niri, Hyprland, Sway, Mango).
1624
1725## Usage
1826
19271 . Set ** Video directory** in the plugin settings (defaults to ` ~/Videos ` ).
20282 . Add the ** Video Wallpaper** bar widget, or open the picker with
21- ` noctalia msg panel-toggle noctalia/mpvpaper:picker ` .
29+
30+ ``` sh
31+ noctalia msg panel-toggle noctalia/mpvpaper:picker
32+ ```
33+
22343 . Choose a target output (or ** All outputs** ), then click a video to apply it.
2335 Use ** Stop** to restore Noctalia's own wallpaper on that output.
2436
2537Assignments persist across restarts. Supported files: ` mp4 ` , ` webm ` , ` mkv ` , ` mov ` , ` gif ` .
2638
27- ## How it works
39+ ## Settings
40+
41+ | Setting | Type | Default | Description |
42+ | --- | --- | --- | --- |
43+ | ` video_directory ` | ` folder ` | * (empty)* | Folder scanned for wallpaper videos; defaults to ` ~/Videos ` when empty. |
44+ | ` mute ` | ` bool ` | ` true ` | Starts video wallpapers muted. |
45+ | ` hardware_decode ` | ` bool ` | ` true ` | Uses ` mpv ` hardware decoding. |
46+ | ` auto_pause ` | ` bool ` | ` true ` | Pauses playback while a fullscreen window covers the wallpaper. |
47+ | ` mpv_options ` | ` string ` | * (empty)* | Additional space-separated ` mpv ` options. |
48+ | ` glyph ` | ` glyph ` | ` movie ` | Bar widget icon. |
49+
50+ ## Notes
2851
2952A headless service supervises one long-lived helper process (` supervisor.sh ` ) that owns
3053every ` mpvpaper ` instance, one per output. The picker panel and bar widget are thin
0 commit comments