ShotGrid Create

The Desktop2 Engine is the engine which runs inside of the ShotGrid Create Application. It handles DCC launching from ShotGrid Create, as well as from the ShotGrid web application via browser integration.

The tk-desktop2 engine powers Toolkit’s integration with ShotGrid Create. The ShotGrid Create provides support for features that users of Toolkit are familiar with, including DCC launching.

Installation and Updates

Adding this Engine to the ShotGrid Pipeline Toolkit

If you want to add this engine to Project XYZ, and an environment named asset, execute the following command:

> tank Project XYZ install_engine asset tk-desktop2
Updating to the latest version

If you already have this item installed in a project and you want to get the latest version, you can run the update command. You can either navigate to the tank command that comes with that specific project, and run it there:

> cd /my_tank_configs/project_xyz
> ./tank updates

Alternatively, you can run your studio tank command and specify the project name to tell it which project to run the update check for:

> tank Project XYZ updates

Collaboration and Evolution

If you have access to the ShotGrid Pipeline Toolkit, you also have access to the source code for all apps, engines and frameworks in Github where we store and manage them. Feel free to evolve these items; use them as a base for further independent development, make changes (and submit pull requests back to us!) or simply tinker with them to see how they have been built and how the toolkit works. You can access this code repository at https://github.com/shotgunsoftware/tk-desktop2.

Special Requirements

You need ShotGrid Pipeline Toolkit Core API version v0.19.1 or higher to use this.

Fixing ShotGrid Integration Error

Your users are getting the following error message: Failed to initialize integrations. ValueError - Invalid localhost certificate data in ShotGrid! Please contact support. This error message indicates that they are trying to access ShotGrid Toolkit features when your ShotGrid instance is not configured to use the ShotGrid Toolkit integration.

To prevent users from accessng the ShotGrid Toolkit and seeing the error message, enable the environment variable SHOTGUN_CREATE_DISABLE_TOOLKIT_INTEGRATION. This env var completely disables ShotGrid Toolkit integration in Create.

If you’ve enabled this env var by mistake, disabling it should restore ShotGrid Toolkit integration.