Scripting Plugins

What is a Lauf Plugin?

A plugin written for Lauf is essentially just a shell script. The only difference is a plugin script will communicate with Lauf by passing around shared variables. These variables include the following:

yarra

yarra "Variable Name" "String" This allows you to split a string of words into multiple variables

lauf_notify

lauf_notify "Message Heading" "Message Text"

$lauf_exec

Holds the string typed into the main Lauf window

$lauf_exec1

Holds the first word in the string held in $lauf_exec, Often this is the plugin name or the command being used.

$lauf_exec2 through $lauf_exec999

Holds any other words typed after $lauf_exec1, These are generally used as arguments to be passed onto plugins.

• The following are variables that can’t be changed but contain useful information:

$lauf_app_dir

Holds the directory in which Lauf resides in

$lauf_app_icon

Holds the location of where Lauf’s Icon image is located

$lauf_version

Holds the version information

$lauf_app_name

Holds the Laufs' application name

$lauf_app_motto

Holds Laufs' slogan

$lauf_core_dir

Holds the core plugin directory

$lauf_plugin_dir

Holds the external plugin directory

$lauf_app_options

Holds general Lauf options, These options contain information stored in lauf.cfg