Get Started
Plugins
Macros
More information

Plugin structure

Each plugin for the server version is a folder with files. To use the plugins with the desktop version, you need to pack these files into a single zip archive file (see the Adding plugins section for more information on how to add plugins to the editors).

The plugin folder must contain three files required for the plugin to work:

  • config.json - plugin configuration file containing the information about the main plugin data needed to register the plugin in the editors.
  • index.html - plugin entry point, connecting the config.json and plugin.js (the base file needed for work with plugins) files.
  • plugin code (.js file) - the plugin code file itself containing the JavaScript code of the plugin you want to connect to the editors.

The plugin folder can also contain other files such as plugin icons, styles, translations, readme, third-party services, etc. More information can be found here.


Structure