Plugins

Image

Extend Pixyz Studio's core features by encapsulating your data preparation process using plugins.

A plugin is composed of:

  • One or several Python script files (.py): they embed the data preparation code to execute
  • An XML file (.xml), used to provide an interfance, which exposes the arguments to feed as input/output to the scripts
  • Python modules dependencies

Why plugins?

Plugins can be created to add custom functionalities and behavior to Pixyz Studio, by creating dedicated data preparation tools with their own interface, menu, or button, for example to automate repetitive tasks.

How are plugins developed?

Plugins can be developed:

  • By you: Plugins can be easily created from a Template accessible in the Plugins menu, which can be modified in the Scripting Editor or using an your favorite IDE (see Creating a Plugin), with the help of the API Reference.
  • For you: Please contact Pixyz/Unity if you are interested in the creation of a bespoke scenario, based on your specific data preparation process.

Editable versus Published plugin

By default, a plugin is editable: all its files are accessible and can be modified, within Pixyz Studio using the Scripting Editor, or outside using an IDE. A plugin that can be edited is an Editable plugin.

A plugin can be published in the form of a binarized archive file, with a .pxzext extension. It is then called a Published plugin, easier to store and exchange with other Pixyz Studio users.

Plugins folder locations

In order to be loaded and executed in Pixyz Studio, plugins must be placed in one of the following predefined locations on a computer:

  • ProgramData folder (%programdata%/PixyzStudio/plugins): place a plugin folder here to make it available for all computer users (see Creating a Plugin) - recommended location
  • AppData folder (%appdata%/PixyzStudio/plugins): place a plugin folder here to restrain plugin access to the concerned user (see Creating a Plugin)
  • Pixyz Studio installation directory (PixyzStudioInstallationDirectory/bin/plugins): folder where default plugins are located, when existing - do not modify

At startup, Pixyz Studio loads all the plugins located in these 3 folders.

Warning

Plugins cannot be loaded from a different location than these 3 locations!

Refer to the following topics for plugin creation and management: