Skip to main content

Customise application launcher

The launch configuration is a YAML file that aids Connect in locating the application executable and provide other information about the application such as launch arguments, environment variables and paths to framework extensions.

Upon launch, Connect will search first search path entries in FTRACK_CONNECT_EXTENSIONS_PATH for launch configurations, performing a first level YAML merge on top of the default launch configuration provided by the framework integration plugins.

This way, you can customise the launch configuration for your application without modifying the default configuration.

note

If you are migrating from v2 to v3, please see Migrating from v2 to v3.

As an example, we will have a look at the configuration for the Nuke Studio DCC application:


type: launch_config
name: nuke-studio
context:
- Project
identifier: ftrack-connect-launch-nuke-studio
applicationIdentifier: nuke-studio_{variant}
label: Nuke Studio
icon: nuke_studio
variant: "{version}"
integrations:
  legacy:
  - ftrack-nuke-studio
search_path:
  linux:
    prefix:
    - "/"
    - usr
    - local
    - Nuke.*
    expression:
    - Nuke\d.+
    version_expression: Nuke(?P<version>.*)\/.+$
    launch_arguments:
    - "--studio"
  windows:
    prefix:
    - C:\
    - Program Files.*
    expression:
    - Nuke.*
    - Nuke\d.+.exe
    version_expression: "(?P<version>[\\d.]+[vabc]+[\\dvabc.]*)"
    launch_arguments:
    - "--studio"
  darwin:
    prefix:
    - "/"
    - Applications
    expression:
    - Nuke.*
    - NukeStudio\d[\w.]+.app
environment_variables:
  FOUNDRY_LICENSE_FILE: /Volumes/nas/licenses/floating/foundry/FLEXlm
  PYTHONPATH:
    - "/Volumes/nas/pipeline/dependencies"
    - "/Volumes/nas/home/sverker/ftrack/dependencies"
  • type: The type extension, must be set to 'launcher'.
  • name: The name of the launcher, this is used to identify the launcher in the application launcher.
  • context: The context that the launcher is available in.
  • identifier: The identifier of the launcher, this is used to identify the launcher in the application launcher.
  • applicationIdentifier: The identifier of the application, this is used to identify the application in the application launcher.
  • label: The label of the launcher, used by the UI.
  • icon: The icon of the launcher, used by the UI.
  • variant: The variant of the launchers.
  • integrations: The dependency integrations that are required for the launcher to work.
  • search_path: The search path for the application executable, on each available platform.
  • environment_variables: The environment variables that should be set when launching the application, each variable can either have single or multiple values (list).
  • extensions_path: (Framework based integrations) The paths where extensions can be found, can be either on relative or absolute paths.
note

See how to customise or create your own launcher at Customising a launcher.

Deprecation notes​

warning
  • The previous application launcher Connect plugin is deprecated, and so are the previous JSON configuration files.
  • The previous action launcher widget plugin for Connect 2 is deprecated.