Manual/Plugins

Available Plugins

See the list of available plugins.

Plugin Data

A plugin is described by a JSON file containing the metadata for the given plugin.

This data is available in scripts as attributes of the plugin object.

Parameter	Presence	Description
script	Mandatory	Location of the script file that is to be executed by the plugin. The location is considered relative to the directory containing the JSON file. See Scripting for a description of the language.
name	Recommended	A unique string that identifies the plugin. If missing is deduced from the file name.
type	Recommended	Plugin type, see below for valid values. If missing or with an invalid value will be overwritten to script .
description	Recommended	A textual description of the use of the plugin.
requires	Recommended	String for the minimum version of Knotter required to run the script. (Eg: 0.9.6)
author	Suggested	Name of the author of the plugin.
version	Suggested	Plugin version.
license	Suggested	Short identifier of the software license covering the plugin.
icon	Optional	A named icon from the theme or a file name. How this is used can change depending on the plugin type.
auto_enable	Optional	Whether the plugin is enabled by default. If omitted it's considered true.
ui	Optional	Name or array of names of Ui files that are loaded by the plugin. The widgets will be available to the script from their object name.
category	Optional	For script plugins, the name of the menu that will contain it. Defaults to Other.
plugin_file	Automatic	Absolute path to the plugin JSON file.
plugin_dir	Automatic	Directory containing the JSON file.
plugin_shortname	Automatic	A unique name deduced from the file name.
plugin_deprecated	Automatic	Added with a value of true when there's a newer version of the plugin already installed.
plugin_settings	Optional	Name of the JSON file used to store the plugin settings. If missing a unique value (not shared by any other plugin) is used.
settings	Optional	(Recommended if using settings) An object with values from the plugin setting. If the plugin has not yet saved any settings, this will be read from the plugin definition file, otherwise from the settings file.

Reserved attributes

With the exception of plugin_settings, all attributes starting with plugin_ are reserved for internal use and my be overwritten by Knotter or the plugin repository.

Plugin Locations

Plugins are searched in the available data directories, the following directories are always searched:

• datadir as per configure.sh.
• current working directory/data
• executable directory/data

Other directories depend on the system and Qt version. Check Help → About → Plugins for details

Plugin Types

cusp	A new cusp style.
script	Execute an arbitrary script, when enabled will be available from the Plugin menu.
crossing	A new crossing style.