Tool-config yaml files

A tool-config is a yaml file describing how a specific tool should look like and how it should behave. The tool-config has two main goals, the first one is to provide the set of plugins and options to the engine to be executed. The second one is to customise the main dialog that will represent the tool-config with specific widgets that will represent each plugin.

Current supported engine definition allow:

• Single strings: Just the name of the plugin has to be defined.

- publish_to_ftrack

• Dictionaries: Allows more definitions of a particular plugin or group.
  • type: (required) : Define if its a plugin or a group.
  • tags (optional) : Provide specific tags to be read by the dialog that represents the tool-config.
  • options (optional) : Dictionary of options provided to the plugins on execution time. Group options are scattered to inner plugins. Top level tool config options are also accepted.
  • ui (optional) : Widget to be shown to represent the defined plugin.

- type: plugin
  tags:
    - context
  plugin: store_asset_context
  options:
    asset_type_name: script
  ui: publisher_asset_version_selector

Here there is an example of the default standalone file publisher:

type: tool_config
name: standalone-file-publisher
config_type: publisher
engine:
  - type: plugin
    tags:
      - context
    plugin: store_asset_context
    options:
      asset_type_name: script
    ui: publisher_asset_version_selector

  # Export the file component.
  - type: group
    tags:
      - component
    options:
      component: file
    #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: file_collector
        ui: file_browser_collector
        options:
          folder_path: null
          file_name: null
      - type: plugin
        tags:
          - validator
        plugin: file_exists_validator
        ui: validator_label
      - type: plugin
        tags:
          - exporter
        plugin: rename_file_exporter
        ui: file_exporter_options
        options:
          export_destination: "~/Desktop/myPublishedFile.png"

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


  # Publish to ftrack.
  - publish_to_ftrack