wallgrab

README

wallgrab

A quick util to grab Apple's wallpapers.

Using

# list available wallpapers
$ wallgrab --list

# show available wallpapers using terminal graphics
$ wallgrab --show

# grab
$ wallgrab --grab

# grab and write playlist
$ wallgrab --grab --dest /path/to/wallpapers --m3u apple.m3u

# use with mpvpaper
$ mpvpaper -o 'no-audio --loop-playlist shuffle --speed=0.2' '*' /path/to/wallpapers/apple.m3u

Sway

Example sway config:

# set up some variables
set {
  # modifier keys (windows key)
  $mod Mod4
  $shf $mod+Shift

  # control path for mpv
  $mpvctl $HOME/.local/lib/mpvpaper/control

  # sets the output for the media title (read from the m3u) to the bottom right
  $mpvopt \
    --hwdec \
    --no-audio \
    --input-ipc-server=$mpvctl \
    --shuffle \
    --loop-playlist \
    --speed=0.8 \
    --osd-playing-msg='\${osd-ass-cc/0}{\\\\\\\\\\\\\\\\an3}\${osd-ass-cc/1}\${media-title}'

  # alternate location, bottom center with margin from bottom, stay on screen
  # for 7.5 seconds
  $mpvopt \
    --hwdec \
    --no-audio \
    --input-ipc-server=$mpvctl \
    --loop-playlist \
    --shuffle \
    --speed=0.8 \
    --osd-margin-y=70 \
    --osd-playing-msg-duration=7500 \
    --osd-playing-msg='\${osd-ass-cc/0}{\\\\\\\\\\\\\\\\an2}\${osd-ass-cc/1}\${media-title}'
}

# run mpvpaper as wallpaper
exec {
  mpvpaper -o "$mpvopt" '*' $HOME/Pictures/backgrounds/apple/wallpapers.m3u
}

# bind modifier key + media keys to change/pause background
bindsym {
  $mod+XF86AudioStop exec socat - $mpvctl <<< 'cycle pause'
  $mod+XF86AudioPrev exec socat - $mpvctl <<< 'playlist-prev'
  $mod+XF86AudioPlay exec socat - $mpvctl <<< 'cycle pause'
  $mod+XF86AudioNext exec socat - $mpvctl <<< 'playlist-next'
  $shf+XF86AudioPlay exec socat - $mpvctl <<< 'show-text ${osd-ass-cc/0}{\\an2}${osd-ass-cc/1}${media-title} 7500'
}

Note:

The above \'s are not a typo: due to the way escaping works with sway config, and in turn with mpvpaper, this is the correct number of \'s.

To use with swaylock-plugin, see the lock script here.

Notes

Quick commands:

$ export mpvctl=/path/to/control/socket

# display text in bottom right corner
$ socat - $mpvctl <<< 'show-text ${osd-ass-cc/0}{\\an3}${osd-ass-cc/1}${media-title}'

# set pause
$ socat - $mpvctl <<< 'set pause yes'

# cycle pause
$ socat - $mpvctl <<< 'cycle pause'

# get property
$ socat - $mpvctl <<< '{ "command": ["get_property", "pause"] }'

# list properties
$ mpv --list-properties

Note:

${osd-ass-cc/0} and ${osd-ass-cc/1} - starts and ends subtitle escaping

\an - uses numpad numbers for location, hence 3 == lower right

• See the mpv.io manual
• See mpv.io commands for commands that can be sent via the control socket
• See mpv.io properties for available mpv text properties
• See aegisub manual for more info on subtitle tags
• See Aerials discussion thread