Tool config extension

The tool-config extension is a yaml file that defines the execution process of a specific tool. In this file is where all the plugins, widgets and options are declared to define the execution process that a particular tool should follow.

By default, named <dcc_name>-<description>-<tool-type>.yaml and located in the tool-configs folder.

Here is an example of a default tool-config extension for maya:

type: tool_config
name: maya-scene-publisher
config_type: publisher
engine:
  - type: plugin
    tags:
      - context
    plugin: store_asset_context
    options:
      asset_type_name: scene
    ui: publisher_asset_version_selector

  # Export the snapshot component.
  - type: group
    tags:
      - component
    options:
      component: snapshot
    #optional: False by default so is no need
    #enabled: True by default so is no need
    plugins:
      - type: plugin
        plugin: store_component
      - type: plugin
        tags:
          - collector
        plugin: maya_scene_collector
        ui: maya_scene_options_selector
        options:
          export_type: scene # selection is also available
          extension_format: mb # ma is also available
      - type: plugin
        tags:
          - validator
        plugin: maya_scene_saved_validator
        ui: validator_label
      - type: plugin
        tags:
          - exporter
        plugin: maya_scene_exporter
        ui: maya_export_options_selector

  # Export Thumbnail
  - type: group
    tags:
      - component
    options:
      component: thumbnail
    #optional: False by default so is no need
    #enabled: True by default so is no need
    plugins:
      - type: plugin
        plugin: store_component
      - type: plugin
        tags:
          - collector
        plugin: maya_camera_collector
        ui: maya_camera_selector
        options:
          camera_name: persp
      - type: plugin
        tags:
          - validator
        plugin: maya_camera_exists_validator
        ui: validator_label
      - type: plugin
        tags:
          - exporter
        plugin: maya_thumbnail_exporter

  # Common validator check all exported paths exists.
  - type: plugin
    tags:
      - validator
    plugin: exported_paths_validator
    ui: validator_label

  # Publish to ftrack.
  - publish_to_ftrack

If multiple tool configs are detected in the extensions_path, the configs are top level merged based on the order they appear in the path. This enables customisation of the shipped default tool configs.