Shotgun Engine for Alias
Shotgun Integration in Alias
- Information for App Developers - Alias Project Management
- Installation and Updates - Adding This Engine to the Shotgun Pipeline Toolkit
- Installation and Updates - Updating to the Latest Version
- Release Notes
The Shotgun Engine for Alias creates a bridge between the Shotgun Pipeline Toolkit apps and Alias. Write apps using Python to run right inside the engine.
Supported Application Versions
This item has been tested and is known to be working on the following application version: 2020. Please note that it is possible, even likely, to work with some older releases; however, it has not been formally tested with these versions.
Shotgun Engine for Alias Documentation
The Shotgun Engine for Alias contains a standard platform for integrating Shotgun Apps into Alias. It is lightweight, straight forward, and adds a Shotgun menu to the Alias menu bar.
- For documentation specific to Shotgun integration with Alias, see Working with Shotgun.
- For general documentation on Shotgun's Automotive Design Studio Components, see Introduction.
Information for App Developer - Alias Project Management
Whenever the Shotgun Engine for Alias starts, it will set the Alias Project to point at a location defined in the engine settings. This means the Project can also change when a new file is opened. The details relating to how the Alias project is set, based on a file, can be configured in the configuration file, using the template system.
Installation and Updates - Adding This Engine to the Shotgun 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-alias
Installation and Updates - Updating to the Latest Version
If this item is already installed in a project and you want the latest version, run the
update command. You can navigate to the tank command for 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 indicate which project to run the update check for:
> tank Project XYZ updates
Collaboration and Evolution
If you have access to the Shotgun Pipeline Toolkit, you also have access to the source code for all apps, engines, and frameworks in GitHub, where they are stored and managed. Feel free to evolve these; 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. Access this code repository at https://github.com/shotgunsoftware/tk-alias.
Below is a summary of all the configuration settings used. These settings need to be defined in the environment file where you want to enable this App or Engine.
Description: Template to use to determine where to set the Alias project location. This should be a string specifying the template to use, but can also be empty, if you do not want the Alias project automatically set.
Description: Optionally choose to use 'Sgtk' as the primary menu name instead of 'Shotgun'.
Description: Controls the favorites section on the main menu. This is a list. Each menu item is a dictionary with two keys:
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 favorite.
Description: Specify the minimum Application major version to 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, set this value to the current major version + 1.
Description: Translator information.
Description: Controls whether debug messages should be emitted to the logger.
Description: Hook to customize behaviour on file change and file close.
There are currently no release notes specific to the Shotgun Engine for Alias.