Skip to content

Usage

The script accepts folders, individual files, or shell globs. Folders are scanned recursively by default.

Common Commands

sh
scripts/run-video-wallpaper
scripts/run-video-wallpaper ~/Movies/wallpapers
scripts/run-video-wallpaper ~/Downloads/*.mp4
scripts/run-video-wallpaper --fade 2.0 ~/Movies/wallpapers
scripts/run-video-wallpaper --low-power ~/Movies/wallpapers
scripts/stop-video-wallpaper

Options

OptionDescription
--fade SECONDSCrossfade duration. Default: 1.2.
--low-powerPrefer the main display and cap fades at 0.5 seconds.
--fitLetterbox the video instead of cropping.
--fillCrop to fill the screen. This is the default.
--only-mainUse only the main display.
--no-recursiveDo not scan subfolders.
--soundKeep video audio on. Default is muted.
--level-offset NRaise or lower the desktop window level if needed.
--checkValidate inputs and exit without starting playback.

Display Behavior

By default, the app creates one wallpaper window per connected display. Add --only-main when you want to keep secondary displays untouched:

sh
scripts/run-video-wallpaper --only-main ~/Movies/wallpapers

Use --low-power when you want the conservative default for laptops:

sh
scripts/run-video-wallpaper --low-power ~/Movies/wallpapers

Low power mode enables main-display-only playback and caps crossfades at 0.5 seconds.

Crop or Fit

Use --fill for a screen-filling crop. Use --fit when you prefer the full video frame, even if that leaves letterboxing:

sh
scripts/run-video-wallpaper --fit ~/Movies/wallpapers

Sound

Playback is muted by default. Add --sound if you intentionally want audio:

sh
scripts/run-video-wallpaper --sound ~/Movies/wallpapers

Released under the MIT License.