Skip to main content

Installing plugins

New plugins are placed in the FTRACK_CONNECT_PLUGIN_PATH path, after which they will be discovered and loaded by the ftrack connect application if they have the required hook folder with the appropriate API bootstrap register Python file(s).

For example :

<$FTRACK_CONNECT_PLUGIN_PATH>/my_plugin/hook

If you find yourself in need of using third party modules, please see how ftrack plugins are usually packaged. A example is available as part of our recipes repository

Plugin manager

Connect comes shipped with a plugin manager that allows you to install and manage you plugins.

This plugin provide a ConnectWidget made to visually manage your integrations, which can be used to install and update them from local as well as remote sources.

info

The User Plugin Manager widget will manipulate ONLY locally installed to the user. Will not discover, look or manage centrally installed plugins.

Start Up

When Connect startup it’ll check for the integrations available locally as well as remote, and present with various options. Plugins which can be updated, will be automatically be checked.

Filtering

The widget allows to simply filter all the available integrations to quickly search for the one needed.

Installation

When your list of plugin is checked, all you’ll be in need of doing is to press he apply button and the installation process will begin.

Plugins (as zip) can also be installed through drag and drop in the widget.

The progress will show what plugins is installing.

Once the list of plugin to install is processed, users will be prompted with a message to restart connect.

warning

ftrack Connect requires to be restarted after plugins have been installed.