info.yml

# Copyright (c) 2019 Shotgun Software Inc.
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
# Source Code License included in this distribution package. See LICENSE.
# By accessing, using, copying or modifying this work you indicate your
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
# not expressly granted therein are reserved by Shotgun Software Inc.

# Metadata defining the behaviour and requirements for this engine

# expected fields in the configuration file for this engine
configuration:
    hook_menu_customization:
        type: hook
        description: "A hook that customizes the Flow Production Tracking menu in Alias."
        default_value: "{self}/menu_customization.py"

    debug_logging:
        type: bool
        description: Controls whether debug messages should be emitted to the logger
        default_value: false

    menu_favourites:
        type: list
        description: "Controls the favourites section on the main menu. This is a list
                     and each menu item is a dictionary with keys app_instance and name.
                     The app_instance parameter connects this entry to a particular
                     app instance defined in the environment configuration file. The name
                     is a menu name to make a favourite."
        allows_empty: True
        values:
            type: dict
            items:
                name: { type: str }
                app_instance: { type: str }

    run_at_startup:
        type: list
        description: "Controls what apps will run on startup.  This is a list where each element
                     is a dictionary with two keys: 'app_instance' and 'name'.  The app_instance
                     value connects this entry to a particular app instance defined in the
                     environment configuration file.  The name is the menu name of the command
                     to run when the Alias engine starts up.  If name is '' then all commands from the
                     given app instance are started."
        allows_empty: True
        default_value: []
        values:
            type: dict
            items:
                name: { type: str }
                app_instance: { type: str }

    reference_template:
        type: template
        description: Reference template to store the files created (.wref) when importing a file as reference.
        allows_empty: True
        fields: context, *

    compatibility_dialog_min_version:
        type:           int
        description:    "Specify the minimum Application major version that will prompt a warning if
                        it isn't yet fully supported and tested with Toolkit.  To disable the warning
                        dialog for the version you are testing, it is recommended that you set this
                        value to the current major version + 1."
        default_value:  2025

    compatibility_dialog_old_version:
        type:           bool
        description:    "Disable warning about older versions of Alias"
        default_value:  True

    data_validation_max_error_count:
        type: int
        description: "The maximum number of errors to display in the Data
                     Validation App details panel. Lowering this number can
                     improve performance when there are many errors."
        default_value: 500

# the Shotgun fields that this engine needs in order to operate correctly
requires_shotgun_fields:

# More verbose description of this item
display_name: "Flow Production Tracking Engine for Alias"
description: "Flow Production Tracking Integration for Alias DCC"

# Required minimum versions for this item to run
requires_shotgun_version:
requires_core_version: "v0.19.18"

frameworks:
  - {"name": "tk-framework-aliastranslations", "version": "v0.x.x", "minimum_version": "v0.2.3"}
  - {"name": "tk-framework-alias", "version": "v2.x.x", "minimum_version": "v2.0.0"}
  - {"name": "tk-framework-lmv", "version": "v1.x.x"}