Building Plugins

Example Plugin

We HIGHLY suggest you start by downloading the example plugin; especially if this is your first time building a plugin.
 

Plugin Structure

The structure for plugins is very simple, it requires a folder to contain the plugin which houses a config file (config.json) and any files the plugin requires to function.
 

The config.json File

The plugin is initialized into the system using this file, so it's important to get this one right, the format is shown below:

{
    "name":"[PLUGIN_NAME]",
    "description":"[PLUGIN_DESCRIPTION]",
    "win_width":"[WINDOW_WIDTH]",
    "default":"[DEFAULT_SCRIPT]",
    "overlay":"[SHOW_OVERLAY]"
}

[PLUGIN_NAME] is the name that the user will see when accessing the plugin
[PLUGIN_DESCRIPTION] is a breif description (think 1-sentence) about the plugin
[WINDOW_WIDTH] defines the starting width of the window containing the plugin
[DEFAULT_SCRIPT] defines the first file to load into the plugin window - may we suggest default.php...
[SHOW_OVERLAY] defines whether or not the translucent overlay will be shown to isolate actions to the plugin window.
 

Plugin Commands

The plugin engine provides a set of commands for working with the system. The example plugin does a good job of showing these in use, but for more information:

View the plugin command documentation »