Skip to content

Command Line Controls

Dani John edited this page Mar 25, 2021 · 264 revisions

Contents

Instruction

Lively can be controlled with command line arguments from terminal.

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

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

(Alternatively download the command utility which includes --help documentation and also if required set it as PATH for easy access.)

For example the wallpaper audio can by muted by running the following commands

without PATH variable:

<install_location>\livelywpf.exe app --volume 0

with PATH variable and command utility:

livelycu app --volume 0

Note:

There will be a 1sec delay for script execution if you directly send message to Lively executable instead of the command utility.

The utility requires .NET Core 3.1 x86 Desktop Runtime to be installed.

Commands

Open Application

Open Lively main application.

app --showApp <state>

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

Wallpaper Playback

Control wallpaper playback state.

app --play <state>

state: true/false - play/pause wallpapers.

Wallpaper Volume

Set global sound level of all wallpapers.

app --volume <volume-level>

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

Desktop Icon

Control desktop icon visibility.

app --showIcons <state>

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

Screen Saver

Show currently running wallpaper as screen saver.

screensaver --show <state>

state: true/false - start/stop screen saver.

Set Wallpaper

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

screen-id: (optional) The screen number as seen in Lively control panel, if not given primary screen is default.

file-path: Folder path containing LivelyInfo.json project file/File path of the wallpaper in library.

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.

closewp <screen-id>

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

Seek Wallpaper

Sets wallpaper playback position.

seekwp --monitor <screen-id> --percent <absolute-percent>

screen-id: (optional) The screen number as seen in Lively control panel, if not given primary screen is default.

absolute-percent: Seek percentage (0-100), decimal value.

Special cases:

Full support for media files only.

For webpages only value of 0 have effect which reloads the page.

Require Lively v1.2.6 or above.

Customize Wallpaper

Set the Lively Properties of the wallpaper.

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

screen-id: (optional) The screen number as seen in Lively control panel, if not given primary screen is default.

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

Make sure to enclose the arg inside double quotes so that spaces in text are correctly parsed.

Example:

To change the color control:

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

setprop --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"
  }

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

Special cases:

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

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

The default Lively property of media files can be referred here.

AutoHotkey

The following AutoHotkey scripts execute when Win + Z key is pressed.

Requires adding Lively command utility to system PATH variable.

Audio toggle

Toggle wallpaper volume between 0 and 75

toggle:= false
; hotkeys - winkey-z
#z::
toggle := !toggle
If toggle
{
  Run cmd.exe /c livelycu.exe app --volume 0,,hide 
}
else
{
  Run cmd.exe /c livelycu.exe app --volume 75,,hide 
}

Wallpaper shuffle

Sets a random wallpaper from wallpapers.txt file

; Create the array, initially empty:
Array := Array()

; Write to the array:
Loop, Read, wallpapers.txt ; This loop retrieves each line from the file, one at a time.
{
    Array.Push(A_LoopReadLine) ; Append this line to the array.
}

#z::
command := "livelycu.exe setwp --file " . """"Array[random(Array.MinIndex(), Array.MaxIndex())]""""
Run cmd.exe /c %command%,,hide

random( x, y )
{
   Random, var, %x%, %y%
   return var
}
wallpapers.txt
C:\Users\rocks\AppData\Local\Lively Wallpaper\Library\wallpapers\aiqzbihh.0ho
C:\Users\rocks\Documents\GIFS\Car.gif

Random hue (video only)

Sets a random hue value for the running wallpaper

#z::
command := "livelycu.exe setprop --property hue=" . random(-100,100)
Run cmd.exe /c %command%,,hide

random( x, y )
{
   Random, var, %x%, %y%
   return var
}

Screen saver

Set currently running wallpaper(s) as fullscreen screen saver(s)

#z::
Run cmd.exe /c livelycu.exe screensaver --show true,,hide 

Rainmeter

The following Rainmeter meters require adding Lively command utility to system PATH variable.

Day/Night Hue (video only)

In this example color of wallpaper is changed based on time of day.

[Rainmeter]
Update=1000
AccurateText=1

[Metadata]
Name=Lively Hue
Author=rocksdanister
Information=Cycles different video hue property based on time.
Version=1.0
License=Creative Commons Attribution - Non - Commercial - Share Alike 3.0

[Variables]

[MeterDummy]
Meter=String

[MeasureRunDay]
Measure=Plugin
Plugin=RunCommand
Program=livelycu.exe
Parameter=setprop --property hue=-40
State=Hide

[MeasureRunNight]
Measure=Plugin
Plugin=RunCommand
Program=livelycu.exe
Parameter=setprop --property hue=70
State=Hide

[MeasureHour]
Measure=Time
Format=%H
IfCondition=((MeasureHour >= 6) && (MeasureHour < 18))
IfTrueAction=[!CommandMeasure "MeasureRunDay" "Run"]
IfFalseAction=[!CommandMeasure "MeasureRunNight" "Run"]

Clone this wiki locally