# Overview

LipSurf(opens new window) plugins are like UserScripts(opens new window) (eg. GreaseMonkey et al.) for voice.

Firstly, prohst to you! By nature of being on this page, I can tell you have exquisite taste for software!

If you were looking for the user manual, see here(opens new window) .

# What are you talking about?

LipSurf(opens new window) is a Google Chrome extension that enables users to browse with their voice — augmenting the mouse/keyboard paradigm, enabling hands-free productivity. This serves many purposes:

  • Using the computer while your hands are dirty or busy (eating, cleaning etc.)
  • Enabling those with physical impairments or those wishing to prevent repetitive strain injury (RSI(opens new window) ) of the hands
  • Creating quick shortcuts for complex motions (eg. compose mail to John can open up a prefilled email message on Gmail faster than traditional browser navigation)
  • Enabling one to be far from the computer keyboard/mouse (eg. media center PCs)

# Features

  • Extensible architecture
  • Simple, declarative plugins
  • Command chaining
  • Supports 100+ languages
  • Testing is built-in

# Quick Complete Example Plugin

Writing your own plugins for LipSurf is pleasurably straightforward.

/// <reference types="lipsurf-types/extension"/>
declare const PluginBase: IPluginBase;

export default <IPluginBase & IPlugin> {...PluginBase, ...{
    niceName: 'Gmail',
    match: /^https:\/\/mail\.google\.com/,
    commands: [{
        name: 'Compose Mail',
        description: 'Open the new email composition form in Gmail.',
        global: true,
        match: ['compose mail', 'write new mail'],
        pageFn: function() {
            window.location.href = 'https://mail.google.com/mail/?view=cm&fs=1';
        }
    }],
}};