Command Line Controls

Instruction

Require Lively v1.1.9 or above, still under development and subject to change.

Lively can be controlled with command line arguments from terminal.

This allows you to interact with Lively through scripts or third party applications like Rainmeter.

Make sure Lively is already running and then send the commands through its executable.

(You can download the messenger application which includes --help documentation and set it as environment variable to globally refer it.)

Example, the wallpaper music can by muted by running the following command:

livelywpf.exe control --volume 0

Commands

Play

Control wallpaper playback state.

control --play <state>

state: true/false - play/pause wallpapers.

Volume

Set global wallpaper sound level.

control --volume <volume-level>

volume-level: Number in the range 0-100.

Desktop Icon

Control desktop icon visibility.

--showIcons <state>

state: true/false - show/hide desktop icons.

Open Application

Open Lively main application.

--showApp <state>

state: true/false - open/minimize Lively tray application.

Set Wallpaper

setwp --file <file-path> --monitor <screen-id>

screen-id: (optional) The screen number as seen in Lively control panel.

file-path: Folder containing LivelyInfo.json project file.

Example:

setwp --file "C:\Users\rocks\AppData\Local\Lively Wallpaper\Library\wallpapers\xyz"

Set wallpaper to primary screen.

setwp --file "C:\Users\rocks\AppData\Local\Lively Wallpaper\Library\wallpapers\xyz" ---monitor 1

Set wallpaper to screen 1.

Close Wallpaper(s)

Closes the running wallpaper on the given screen, if screen-id is -1 then all wallpapers are closed.

control --closewp <screen-id>

screen-id: The screen number as seen in Lively control panel.

Customize Wallpaper

Customize Lively Properties of the wallpaper.

cuzwp --monitor <screen-id> --property <arg>

screen-id: The screen number as seen in Lively control panel.

arg: LivelyProperty.json argument, syntax "keyValue=value".

Example:

To change the color control:

   "backgroundColor": {
    "text": "Overlay Color",
    "type": "color",
    "value": "#C0C0C0"
  }

cuzwp --monitor 1 --property "backgroundColor=#ff0000"

To change the file in folderDropdown control:

   "imgSelect": {
    "type": "folderDropdown",
    "value": "image3.jpg",
    "text": "Image",
    "filter": "*.jpg|*.png",
    "folder": "wallpapers"
  }

cuzwp --monitor 1 --property "imgSelect=image1.jpg"

Special cases:

Reset properties: cuzwp --monitor 1 --property "lively_default_settings_reload=true"

Button press: cuzwp --monitor 1 --property "button_name=true"