Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 1.37 KB

README.md

File metadata and controls

41 lines (31 loc) · 1.37 KB

Plugins

Generate Plugin

  • Make sure ./src/plugin/coreplugins is in config.plugin.basePaths (by default it is).
  • In an open project, select the root-node and add PluginGenerator to validPlugins under META in the Property Editor.
  • Run PluginGenerator (using the play-button in top left corner), download the files and follow the instructions in the Plugin Results Dialog.

Requirements

  1. Plugins cannot have an interactive UI during its execution.
  • Plugins can run on client side (in the browser) or on server side.
  • Plugins can have a configuration.
  • Plugin configuration can specify default values.
  • Plugin configuration can be serialized and deserialized.
  • Plugin configuration can be changed before execution by the user.
  • Common UI for the plugin configuration.
  • Plugins can generate messages that are linked to objects.
  • Plugin messages can be serialized and deserialized.
  • Plugins can retrieve assets.
  • Plugins can add assets.
  • Plugins can generate artifacts.
  • Plugins have a single entry point.
  • Plugins have access to a logger.
  • Plugins can have results.
  • Plugin results can be serialized and deserialized.

Design

Plugin

  • PluginBase is the base class of all plugins.
  • PluginResult
  • PluginMessage
  • PluginNodeDescription

Plugin manager

  • PluginManagerBase
  • PluginManagerConfiguration