Skip to main content

Launch extension

Part of each integration is the launch extension yaml file, which is read by Connect on startup. This file contains paths were to find the DCC, arguments to pass, environment variables to set and extensions paths.

By default, named <dcc_name>-launch.yaml is located in the launch folder.

Here is an example of the default launch extension for maya:

type: launcher
name: framework-maya
priority: 100
context:
  - Task
identifier: ftrack-framework-launch-maya
applicationIdentifier: maya_{variant}
integrations:
  framework:
    - framework-maya
label: Maya
icon: maya
variant: "{version}"
search_path:
  windows:
    prefix:
      - C:\
      - Program Files.*
    expression:
      - Autodesk
      - Maya.+
      - bin
      - maya.exe
  darwin:
    prefix:
      - "/"
      - Applications
    expression:
      - Autodesk
      - maya.+
      - Maya.app
  linux:
    prefix:
      - "/"
      - usr
      - autodesk
      - maya.+
    expression:
      - bin
      - maya$
    version_expression: maya(?P<version>\d{4})
extensions_path:
  - extensions/common
  - extensions/maya

Extensions path​

The entries provided in extensions_path are driving the FTRACK_EXTENSIONS_PATH environment variable (FTRACK_EXTENSIONS_PATH is not meant to be overridden by the user and will be overwritten by Connect). This variable is picked up by the DCC integration and passed on to the registry.

Extending launch configs and extensions path​

On launch, Connect reads the FTRACK_CONNECT_EXTENSIONS_PATH environment variable. If a launch config with the same name and type is found, it will be first level merged on top the default launch config. The order of the paths in FTRACK_CONNECT_EXTENSIONS_PATH determines the order of the merge.

Creating a custom launcher, you can add/replace the extensions_path entry enabling easy customisation of the Framework.

For more detailed information about launch configs, please refer to Connect application launcher documentation and Customising a launcher tutorial.