Cleaned up sources with pre-commit hooks. (#69)

This commit is contained in:
Jean-François Boismenu 2020-01-09 07:43:26 -05:00 коммит произвёл GitHub
Родитель 2642261598
Коммит feae35bf4e
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
110 изменённых файлов: 334 добавлений и 330 удалений

41
.pre-commit-config.yaml Normal file
Просмотреть файл

@ -0,0 +1,41 @@
# 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.
# Styles the code properly
# Exclude the UI files, as they are auto-generated.
exclude: "ui\/.*py$"
# List of super useful formatters.
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v2.2.3
hooks:
# Ensures the code is syntaxically correct
- id: check-ast
language_version: python3
# Ensures a yaml file is properly formatted
- id: check-yaml
# Ensures a file name will resolve on all platform
- id: check-case-conflict
# Checks files with the execute bit set have shebangs
- id: check-executables-have-shebangs
# Ensure there's no incomplete merges
- id: check-merge-conflict
# Adds an empty line if missing at the end of a file.
- id: end-of-file-fixer
# Makes sure requirements.txt is properly formatted
- id: requirements-txt-fixer
# Removes trailing whitespaces.
- id: trailing-whitespace
# Leave black at the bottom so all touchups are done before it is run.
- repo: https://github.com/ambv/black
rev: stable
hooks:
- id: black
language_version: python3

2
README
Просмотреть файл

@ -2,7 +2,7 @@
The Shotgun Pipeline Toolkit Default Configuration
-------------------------------------------------------------------------
Welcome to the Shotgun Pipeline Toolkit default configuration!
Welcome to the Shotgun Pipeline Toolkit default configuration!
For more information, go to the following url:
https://support.shotgunsoftware.com/hc/en-us/articles/115000067493-Integrations-Admin-Guide

Просмотреть файл

@ -23,6 +23,7 @@ the following keyword arguments:
"""
def create(sg, project_id, log, **kwargs):
"""
Insert post-project code here

Просмотреть файл

@ -1,12 +1,12 @@
This location is for core hook override files.
The Shotgun Pipeline Toolkit comes with a series of Core Hooks, essentially snippets of python
The Shotgun Pipeline Toolkit comes with a series of Core Hooks, essentially snippets of python
that contain key operations such as copying a file, creating directories etc.
These hooks are part of the platform distribution and are therefore bundled with the code itself.
If you want to provide your own hook implementations, for example control file system permissions
as files are being copied, you can override the core hooks by putting a file with the same
name as the core hook in this location. Sgtk will basically look in this folder first as it is
requesting a core hook - if it doesn't find the core hook here, it will look in its internal
platform location.
name as the core hook in this location. Sgtk will basically look in this folder first as it is
requesting a core hook - if it doesn't find the core hook here, it will look in its internal
platform location.

Просмотреть файл

@ -16,7 +16,6 @@ from tank import Hook
class PickEnvironment(Hook):
def execute(self, context, **kwargs):
"""
The default implementation assumes there are three environments, called shot, asset

Просмотреть файл

@ -67,4 +67,3 @@ primary:
# description: "High performance storage for fast/frequent texture access"
# shotgun_storage_id: 2
#

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -15,10 +15,9 @@ type: "shotgun_list_field"
entity_type: "Asset"
# switch this to true if you only want to make folders for
# values that are being used. Note that evaluating this is
# values that are being used. Note that evaluating this is
# expensive and may potentially slow down folder creation.
skip_unused: false
skip_unused: false
# the shotgun field to use for the folder name
field_name: "sg_asset_type"

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -18,7 +18,7 @@ name: "code"
entity_type: "Asset"
# shotgun filters to apply when getting the list of items
# this should be a list of dicts, each dict containing
# this should be a list of dicts, each dict containing
# three fields: path, relation and values
# (this is std shotgun API syntax)
# any values starting with $ are resolved into path objects

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "shotgun_step"
# the shotgun field to use for the folder name
name: "short_name"

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when 3dsmax starts
defer_creation: ["tk-3dsmax", "tk-3dsmaxplus"]

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Nuke starts
defer_creation: "tk-alias"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Houdini starts
defer_creation: "tk-houdini"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Maya starts
defer_creation: "tk-maya"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Motion Builder starts
defer_creation: "tk-motionbuilder"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Nuke starts
defer_creation: "tk-nuke"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Photoshop starts
defer_creation: "tk-photoshopcc"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Nuke starts
defer_creation: "tk-vred"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when 3dsmax starts
defer_creation: ["tk-3dsmax", "tk-3dsmaxplus"]

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Maya starts
defer_creation: "tk-alias"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Houdini starts
defer_creation: "tk-houdini"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Maya starts
defer_creation: "tk-maya"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Motion Builder starts
defer_creation: "tk-motionbuilder"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Nuke starts
defer_creation: "tk-nuke"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Photoshop starts
defer_creation: "tk-photoshopcc"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Maya starts
defer_creation: "tk-vred"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -18,9 +18,8 @@ name: "code"
entity_type: "Sequence"
# shotgun filters to apply when getting the list of items
# this should be a list of dicts, each dict containing
# this should be a list of dicts, each dict containing
# three fields: path, relation and values
# (this is std shotgun API syntax)
# any values starting with $ are resolved into path objects
filters: [ { "path": "project", "relation": "is", "values": [ "$project" ] } ]

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -18,8 +18,8 @@ name: "code"
entity_type: "Shot"
# shotgun filters to apply when getting the list of items
# this should be a list of dicts, each dict containing
# this should be a list of dicts, each dict containing
# three fields: path, relation and values
# (this is std shotgun API syntax)
# any values starting with $ are resolved into path objects
filters: [ { "path": "sg_sequence", "relation": "is", "values": [ "$sequence" ] } ]
filters: [ { "path": "sg_sequence", "relation": "is", "values": [ "$sequence" ] } ]

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "shotgun_step"
# the shotgun field to use for the folder name
name: "short_name"

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when 3dsmax starts
defer_creation: ["tk-3dsmax", "tk-3dsmaxplus"]

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Houdini starts
defer_creation: "tk-houdini"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Maya starts
defer_creation: "tk-maya"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Motion Builder starts
defer_creation: "tk-motionbuilder"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Nuke starts
defer_creation: "tk-nuke"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Photoshop starts
defer_creation: "tk-photoshopcc"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when 3dsmax starts
defer_creation: ["tk-3dsmax", "tk-3dsmaxplus"]

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Houdini starts
defer_creation: "tk-houdini"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Maya starts
defer_creation: "tk-maya"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Motion Builder starts
defer_creation: "tk-motionbuilder"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Nuke starts
defer_creation: "tk-nuke"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

Просмотреть файл

@ -1,11 +1,11 @@
# Copyright (c) 2015 Shotgun Software Inc.
#
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
#
# 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
# 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.
# the type of dynamic content
@ -13,4 +13,3 @@ type: "static"
# defer creation and only create this folder when Photoshop starts
defer_creation: "tk-photoshopcc"

Просмотреть файл

@ -1,4 +1,4 @@
# This file is a placeholder to ensure that the parent folder is preserved and not deleted by git.
# Any file named 'placeholder' will not be copied across when folders are created.
# Note: You can which files should be ignored when folders are created in the ignore_files file,
# located in the schema folder.
# located in the schema folder.

118
env/README.md поставляемый
Просмотреть файл

@ -1,38 +1,38 @@
Overview of tk-config-default2 environment structure
====================================================
The `tk-config-default2` config has a different structure than previous
configurations provided by toolkit. It has been reorganized based on client
feedback and observation to help maximize efficiency when needing to manually
curate your production environments.
The `tk-config-default2` config has a different structure than previous
configurations provided by toolkit. It has been reorganized based on client
feedback and observation to help maximize efficiency when needing to manually
curate your production environments.
Top-level environments
Top-level environments
----------------------
There are 7 top-level files that provide the entry points to environment
configuration. The names of these files correspond to one of the strings
There are 7 top-level files that provide the entry points to environment
configuration. The names of these files correspond to one of the strings
returned by the `pick_environment` hook. These files are:
* `asset.yml` - Asset context without a pipeline step. Typically used when
* `asset.yml` - Asset context without a pipeline step. Typically used when
building menus in the SG web interface.
* `asset_step.yml` - Asset context with a pipeline step. This is the environment
typically associated with an artist's Asset work area.
* `project.yml` - A Shotgun project context. Often used when launching a
* `project.yml` - A Shotgun project context. Often used when launching a
DCC from SG Desktop, providing apps for further refining the context.
* `publishedfile_version.yml` - A context for providing functionality when
* `publishedfile_version.yml` - A context for providing functionality when
viewing PublishedFile or Version entities, typically in SG web interface.
* `sequence.yml` - A context used for sequence-based workflows.
* `shot.yml` - Shot context without a pipeline step. Typically used when
* `shot.yml` - Shot context without a pipeline step. Typically used when
building menus in the SG web interface.
* `shot_step.yml` - Shot context with a pipeline step. This is the environment
typically associated with an artist's Shot work area.
Each of these files provides an outline of the engines configured for that
Each of these files provides an outline of the engines configured for that
environment. These file don't typically need to be modified unless you're adding
a new engine configuration into one of the environments.
a new engine configuration into one of the environments.
The structure of these files is as follows:
```yaml
includes:
# include all frameworks
@ -47,26 +47,26 @@ engines:
<engine>: "@settings.<engine>.<environment>"
<engine>: "@settings.<engine>.<environment>"
...
# reference all of the frameworks
frameworks: "@frameworks"
```
The `tk-config-default2` heavily relies on the Toolkit configuration includes
and references. The `includes` section references files that define regular
and references. The `includes` section references files that define regular
`YAML` key/value pairs. These keys can then be referenced with the `"@<key>"`
syntax seen above. Have a look at one of the top-level environment files for a
concrete example of how this works.
concrete example of how this works.
Engine Settings
---------------
The top-level environments include engine settings from
`includes/settings/<engine>.yml` files. In `tk-config-default2`, all
The top-level environments include engine settings from
`includes/settings/<engine>.yml` files. In `tk-config-default2`, all
engine-specific configurations live in that engine's settings file. This
makes it straight forward to know where to go to change how an engine is
configured. For example, if you need to change how the Maya engine is
configured, simply edit the `includes/settings/tk-maya.yml` file.
makes it straight forward to know where to go to change how an engine is
configured. For example, if you need to change how the Maya engine is
configured, simply edit the `includes/settings/tk-maya.yml` file.
The structure of these files is as follows:
@ -85,7 +85,7 @@ includes:
settings.<engine>.<environment>:
apps:
# list of apps for this engine in the specific environment
<app>:
<app>:
# some simple apps only need to specify a location descriptor
location: "@apps.<app>.location"
# other apps need more configuration, referenced from the included app file
@ -93,24 +93,24 @@ settings.<engine>.<environment>:
...
# engine settings are defined/edited here
location: "@engines.tk-maya.location"
# other environment configurations
...
...
```
Here you can see where the engine-specific environment keys (
`settings.<engine>.<environment>`) are defined and then included into the
top-level environment files. Take a look at one of the engine configuration
files for a concrete example.
top-level environment files. Take a look at one of the engine configuration
files for a concrete example.
App Settings
------------
Similar to the engine configuration files, any apps that require more than a
Similar to the engine configuration files, any apps that require more than a
location descriptor have a settings file in `includes/settings`. For example, to
make changes to the Nuke Write Node app, all of the different configurations
(for all environments) are defined in the
`includes/settings/tk-nuke-writenode.yml` file.
make changes to the Nuke Write Node app, all of the different configurations
(for all environments) are defined in the
`includes/settings/tk-nuke-writenode.yml` file.
The structure of these files is as follows:
@ -131,51 +131,51 @@ settings.<app>.<engine>.<environment>:
location: "@apps.<app>.location"
```
The keys defined in this file are the ones referenced in the engine
The keys defined in this file are the ones referenced in the engine
configuration files. Have a look at one of the app configuration files to see
a concrete example.
a concrete example.
App & Engine Locations
----------------------
One of the changes made for `tk-config-basic2` was to centralize the location
descriptors for apps and engines. By default, this configuration defines the
location for each app and engine being used in exactly one file.
One of the changes made for `tk-config-basic2` was to centralize the location
descriptors for apps and engines. By default, this configuration defines the
location for each app and engine being used in exactly one file.
For engines, the `includes/engine_locations.yml` file defines location
descriptors for all engines. These location descriptors are then included and
referenced anywhere an engine is used. This can be overridden, of course, by
descriptors for all engines. These location descriptors are then included and
referenced anywhere an engine is used. This can be overridden, of course, by
explicitly defining a location descriptor in one of the engine configuration
files.
files.
Similarly, all app location descriptors are defined in the
`includes/app_locations.yml` file. This file is then included by any
engine or app configuration that need to define an app's location.
`includes/app_locations.yml` file. This file is then included by any
engine or app configuration that need to define an app's location.
Centralizing these location descriptors makes it extremely easy to test and
rollout new integrations onto production.
Centralizing these location descriptors makes it extremely easy to test and
rollout new integrations onto production.
Frameworks
----------
Like the app and engine locations file, the `includes/frameworks.yml`
file defines a single, top-level `@frameworks` key that can be included
and used wherever frameworks are required (typically in the top-level
enviornment configuration files). This is the only file that defines location
descriptors for frameworks.
Like the app and engine locations file, the `includes/frameworks.yml`
file defines a single, top-level `@frameworks` key that can be included
and used wherever frameworks are required (typically in the top-level
enviornment configuration files). This is the only file that defines location
descriptors for frameworks.
Software Paths
--------------
The `paths.yml` file found in older configurations has been renamed to
`software_paths.yml` and lives in the `includes` folder. This file has
been significantly reduced in terms of content because of the new Software
The `paths.yml` file found in older configurations has been renamed to
`software_paths.yml` and lives in the `includes` folder. This file has
been significantly reduced in terms of content because of the new Software
entity and the ability of many of the latest Toolkit engines to scan the user's
filesystem for installed software. What's left in this file is software that
does not have an engine that supports the new Software entity.
filesystem for installed software. What's left in this file is software that
does not have an engine that supports the new Software entity.
The file still defines software paths for various operating systems, but the
keys used has been modified for consistency. The file takes the form:
The file still defines software paths for various operating systems, but the
keys used has been modified for consistency. The file takes the form:
```yaml
# <software>
@ -187,8 +187,8 @@ path.windows.<software>: C:\Path\to\the\Software.exe
...
```
These paths are typically included and used by apps like `tk-multi-launchapp`.
See the `software_paths.yml` and
These paths are typically included and used by apps like `tk-multi-launchapp`.
See the `software_paths.yml` and
`includes/settings/tk-multi-launchapp.yml` files to see concrete examples
of how this file is used.
@ -196,5 +196,5 @@ Questions?
----------
If you have any questions or concerns about the structure of this configuration,
or if you have any ideas for how to improve it, please send an email to
[support@shotgunsoftware.com](mailto:support@shotgunsoftware.com).
or if you have any ideas for how to improve it, please send an email to
[support@shotgunsoftware.com](mailto:support@shotgunsoftware.com).

2
env/includes/engine_locations.yml поставляемый
Просмотреть файл

@ -101,4 +101,4 @@ engines.tk-shotgun.location:
engines.tk-vred.location:
type: app_store
name: tk-vred
version: v2.0.2
version: v2.0.2

2
env/includes/frameworks.yml поставляемый
Просмотреть файл

@ -61,4 +61,4 @@ frameworks:
location:
version: v0.2.7
type: app_store
name: tk-framework-widget
name: tk-framework-widget

2
env/includes/settings/tk-alias.yml поставляемый
Просмотреть файл

@ -61,4 +61,4 @@ settings.tk-alias.project:
tk-multi-workfiles2: "@settings.tk-multi-workfiles2.alias"
menu_favourites:
- {app_instance: tk-multi-workfiles2, name: File Open...}
location: "@engines.tk-alias.location"
location: "@engines.tk-alias.location"

2
env/includes/settings/tk-desktop2.yml поставляемый
Просмотреть файл

@ -33,4 +33,4 @@ settings.tk-desktop2.all:
tk-multi-launchmari: "@settings.tk-multi-launchapp.mari"
tk-multi-launchmotionbuilder: "@settings.tk-multi-launchapp.motionbuilder"
tk-multi-publish2: "@settings.tk-multi-publish2.standalone"
location: "@engines.tk-desktop2.location"
location: "@engines.tk-desktop2.location"

2
env/includes/settings/tk-hiero-export.yml поставляемый
Просмотреть файл

@ -24,4 +24,4 @@ settings.tk-hiero-export:
template_plate_path: hiero_plate_path
template_render_path: hiero_render_path
template_version: hiero_version
location: "@apps.tk-hiero-export.location"
location: "@apps.tk-hiero-export.location"

Просмотреть файл

@ -41,4 +41,4 @@ settings.tk-houdini-mantranode.shot_step:
output_ifd_template: houdini_shot_ifd
output_dcm_template: houdini_shot_dcm
output_extra_plane_template: houdini_shot_extra_plane
location: "@apps.tk-houdini-mantranode.location"
location: "@apps.tk-houdini-mantranode.location"

1
env/includes/settings/tk-houdini.yml поставляемый
Просмотреть файл

@ -118,4 +118,3 @@ settings.tk-houdini.shot_step:
- {app_instance: tk-multi-workfiles2, name: File Save...}
- {app_instance: tk-multi-publish2, name: Publish...}
location: '@engines.tk-houdini.location'

2
env/includes/settings/tk-mari.yml поставляемый
Просмотреть файл

@ -52,4 +52,4 @@ settings.tk-mari.project:
location: "@apps.tk-multi-about.location"
tk-multi-shotgunpanel: "@settings.tk-multi-shotgunpanel"
tk-multi-workfiles: "@settings.tk-multi-workfiles.mari"
location: "@engines.tk-mari.location"
location: "@engines.tk-mari.location"

2
env/includes/settings/tk-maya.yml поставляемый
Просмотреть файл

@ -114,4 +114,4 @@ settings.tk-maya.shot_step:
- {app_instance: tk-multi-workfiles2, name: File Save...}
- {app_instance: tk-multi-publish2, name: Publish...}
template_project: shot_work_area_maya
location: "@engines.tk-maya.location"
location: "@engines.tk-maya.location"

2
env/includes/settings/tk-motionbuilder.yml поставляемый
Просмотреть файл

@ -89,7 +89,7 @@ settings.tk-motionbuilder.shot:
apps:
tk-multi-about:
location: '@apps.tk-multi-about.location'
tk-multi-shotgunpanel:
tk-multi-shotgunpanel:
location: '@apps.tk-multi-shotgunpanel.location'
tk-multi-screeningroom: "@settings.tk-multi-screeningroom.rv"
tk-multi-workfiles2:

Просмотреть файл

@ -28,4 +28,4 @@ settings.tk-multi-breakdown.alias:
# VRED
settings.tk-multi-breakdown.vred:
hook_scene_operations: '{engine}/tk-multi-breakdown/basic/scene_operations.py'
location: "@apps.tk-multi-breakdown.location"
location: "@apps.tk-multi-breakdown.location"

Просмотреть файл

@ -60,4 +60,3 @@ settings.tk-multi-launchapp.motionbuilder:
windows_path: "@path.windows.motionbuilder"
menu_name: MotionBuilder
location: "@apps.tk-multi-launchapp.location"

2
env/includes/settings/tk-multi-loader2.yml поставляемый
Просмотреть файл

@ -363,5 +363,3 @@ settings.tk-multi-loader2.vred:
actions_hook: "{engine}/tk-multi-loader2/basic/scene_actions.py"
publish_filters: [["sg_status_list", "is_not", null]]
location: "@apps.tk-multi-loader2.location"

1
env/includes/settings/tk-multi-publish2.yml поставляемый
Просмотреть файл

@ -555,4 +555,3 @@ settings.tk-multi-publish2.vred.asset_step:
settings: {}
help_url: *help_url
location: "@apps.tk-multi-publish2.location"

Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше