Manual/Plugins
< Manual
Jump to navigation
Jump to search
Available Plugins
| Name | Description | Download |
|---|---|---|
| Example cusp plugin | An implementation of the built-in rounded cusp as a plugin | Included in the default installation. |
| Star cusp | A cusp that looks like a star | Included in the default installation. |
| Insert Lattice | Insert a square lattice | Included in the default installation. |
Plugin Structure
A plugin is described by a JSON file containing the metadata for the given plugin.
The JSON contains an object with the following fields:
| Parameter | Presence | Description |
|---|---|---|
| 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. |
| 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. |
| 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. |
| 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 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. |
| edge | (Planned, not yet available) A new edge type. |
