LavishScript:Modules

From Lavish Software Wiki
Jump to: navigation, search

Overview

LavishScript modules extend the functionality of LavishScript. They may come in the form of extensions or plugins for LavishScript-enabled applications, or in the form of a direct LavishScript module (LSModules). The "Developing ..." topics below apply equally to all modules.

Existing LSModules

  • MySQL: MySQL database interaction
  • Regex: Adds support for regular expressions, including match, split and substitution
  • Scheduler: Adds command scheduling (optionally recurring)
  • Sound: Adds sound playback (and queuing) support
  • Targz: Adds support for tar/gzip functionality, including the tar command
  • Ventrilo: Adds support for Ventrilo interaction (with any number of instances of Ventrilo)
  • IRC: Fully featured support for IRC interaction


Installing and Using LSModules

To install a LavishScript module, extract the DLL file to the "LavishScript Modules" folder for the application you wish to use the module in. After doing so, the module must be explicitly loaded in order to be used. To load and later unload the module, use the Module command like so:

  • Module -add LSModule
  • Module -remove LSModule

A third form using the Module command can be used in scripts to require the module, and immediately end the script if it is not available:

  • Module -require LSModule

While a module is loaded, any commands, aliases, data types, and Top-Level Objects are available for use as if they were built directly into LavishScript.

Development

See Also