Skip to content

README.md

Latest commit

 

History

History
70 lines (47 loc) · 1.44 KB

README.md

File metadata and controls

70 lines (47 loc) · 1.44 KB
Raw

bw_plugin

A template repository for building BotWave plugins.

Using this template?

  1. Replace every occurrence of myplugin with your plugin's actual name.
  2. Edit or replace the example handlers and scripts, or delete them and start fresh.
  3. Fill in this README below the line.
  4. Delete this block.

See the Plugin Template wiki page for a full walkthrough.

bw_myplugin

A BotWave plugin that does something.

What it does

[describe what your plugin does]

Requirements

  • BotWave installed at /opt/BotWave
  • [any other dependencies]

Installation

sudo bash install.sh

Copies scripts to /opt/BotWave/scripts/myplugin/ and handlers to /opt/BotWave/handlers/.

Removal

sudo bash uninstall.sh

Usage

botwave> hello one two three
arg1: one
arg2: two
arg3: three

BotWave passes arguments as BW_ARGV{n} environment variables (0-indexed, BW_ARGV0 is the command name itself).

File structure

handlers/
  hello.cmd                # custom command
  s_onready_myplugin.shdl  # runs silently when BotWave is ready
  s_onexit_myplugin.shdl   # runs silently when BotWave exits

scripts/
  hello.sh                 # backing script for hello.cmd
  
install.sh
uninstall.sh

License

Licensed under GPLv3.0