info.yml

# ----------------------------------------------------------------------------
# Copyright (c) 2021, Diego Garcia Huerta.
#
# Your use of this software as distributed in this GitHub repository, is
# governed by the MIT License
#
# Your use of the Shotgun Pipeline Toolkit is governed by the applicable
# license agreement between you and Autodesk / Shotgun.
#
# The full license is in the file LICENSE, distributed with this software.
# ----------------------------------------------------------------------------


# Metadata defining the behaviour and requirements for this engine


# __author__ = "Diego Garcia Huerta"
# __contact__ = "https://www.linkedin.com/in/diegogh/"



# expected fields in the configuration file for this engine
configuration:

    automatic_context_switch:
        type: bool
        description: "Controls whether toolkit should attempt to automatically adjust its
                     context every time the currently loaded file changes. Defaults to True."
        default_value: True

    compatibility_dialog_min_version:
        type: float
        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 recomended that you set this
                     value to the current major version + 1."
        default_value: 0.60

    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 Gaffer 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 }

    use_sgtk_as_menu_name:
        type: bool
        description: Optionally choose to use 'Sgtk' as the primary menu name instead of 'Shotgun'
        default_value: false

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

# More verbose description of this item
display_name: "Shotgun Engine for Gaffer"
description: "Shotgun Integration in Gaffer"

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