Alias

Shotgun Engine for Alias

Shotgun Integration for Alias DCC
Latest Version: v2.0.4 (prod)
For our version numbers, we follow the Semantic Versioning standard.
System Name: tk-alias

Please Note: This document describes functionality only available if you have taken control over a Toolkit configuration. Please refer to the Shotgun Integrations User Guide for more details.
Overview Summary
Documentation
      Information for App Developers
            PySide
            Alias Project Management
      Working with tk-alias
                  File Open and Save ([tk-multi-workfiles2](https://github.com/shotgunsoftware/tk-multi-workfiles2/wiki/Documentation))
                  Snapshot ([tk-multi-snapshot](https://github.com/shotgunsoftware/tk-multi-snapshot))
                  Publish ([tk-multi-publish2](https://github.com/shotgunsoftware/tk-multi-publish2))
                  Loader ([tk-multi-loader2](https://github.com/shotgunsoftware/tk-multi-loader2))
                  Scene Breakdown ([tk-multi-breakdown](https://github.com/shotgunsoftware/tk-multi-breakdown))
Installation, Updates and Development
Configuration Options
Release Notes History

The Shotgun engine for Alias Autostudio and Alias Surface & Design establishes a bridge between the Shotgun Pipeline Toolkit apps and Alias. It also contains a PySide distribution, designed to connect QT inside Alias. This makes it possible to write apps, using Python and PySide, that run inside the engine.

Supported Application Versions

This item has been tested and is known to be working on the following application versions: 2019, 2020. Please note that it is perfectly possible, even likely, that it will work with more recent releases, however it has not yet been formally tested with these versions.

Overview Video

The following video gives a quick overview of features and functionality.

Documentation

The Shotgun engine for Alias contains a standard platform for integrating Shotgun Apps into Alias. It is lightweight and straight forward and adds a Shotgun menu to the Alias menu.

Information for App Developers

PySide

The Shotgun engine for Alias uses a PySide installation shipped with the Shotgun Desktop and will activate this whenever this is necessary.

Alias Project Management

Whenever the Shotgun engine for Alias starts, it will set the Alias Project to point at a location defined in the settings for this engine. This means that the Project may 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.


Working with tk-alias

This Shotgun integration supports the Alias application family (Concept, Surface, and AutoStudio).

When Alias opens, a Shotgun menu (the Alias engine) is added to the menu bar.

File Open and Save (tk-multi-workfiles2)

Use the My Tasks and Assets tabs to see all your assigned tasks and browse for assets. To the right, use these tabs to view all files, working or published files associated with what is selected to the left.

Snapshot (tk-multi-snapshot)

Snapshot: Opens the Snapshot dialog to create a quick backup of the current scene.

Publish (tk-multi-publish2)

Publish: Opens the Publish dialog for publishing the file to Shotgun, which can then be used by artists downstream. For more information, see The Publisher. 

Loader (tk-multi-loader2)

Load: Opens the Content Loader app, along with instructional slides explaining how it works.

Scene Breakdown (tk-multi-breakdown)

Scene Breakdown: Opens the Breakdown dialog, which displays a list of referenced (WREF References) content, along with what in the scene is out-of-date. Select one or more items and click Update Selected to switch and use the latest version of the content.

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

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 Shotgun 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-alias.

Special Requirements

  • You need Shotgun Pipeline Toolkit Core API version v0.18.116 or higher to use this.

Configuration

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.

translator_info

Type: dict

Description: Translators info.

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.

debug_logging

Type: bool

Description: Controls whether debug messages should be emitted to the logger

file_usage_hook

Type: hook

Default Value: default_file_usage

Description: Hook to customize behaviour on file change and file close.

Release Notes

Welcome to the release notes for this Engine. Below you will find an overview of all the changes we did for each release. We try to be as detailed as possible and include all bugs we have fixed, features we have added and things that may have changed. If you have questions about a particular release, don't hesitate to contact our support team!

v2.0.4

Fixed Bugs

  • Fixed backwards compatibility for Alias Shotgun Plugin

v2.0.3

Fixed Bugs

  • Context lost after loading a file in a newly created file.

  • Fix the way we get the translator path for backward compatibility.

  • Alias doesn't show thumbnails and won't open in create.

  • Add start_version_control publish plugin to Alias engine.

Improvements

  • Remove old translation plugins.

  • Make translation plugin just one.

  • Do not use the alias_translator_dir setting anymore.

  • Get command line for translations into a single plugin to be used in standalone publish 2 plugin.

  • Clean Loader hook for Alias.

  • Clean Hook and be sure the basic actions are added in Shotgun Panel (Set Task in Progress, Assign myself to Task).

v2.0.2

Improvements:

  • Move the collector logic from tk-config to tk-alias engine
  • Create the publish2 plugins for tk-config-basic

Fixed bugs:

  • Fixed a bug related with context switching when user wanted to save a file outside Shotgun.

v2.0.1

  • Fixed a bug in the menu where snapshot and snapshot history were launching the same app.

  • Fixed a bug with the plugin in fresh installations. This was ocurring when a python 2.7.X is not installed on the machine or the PATH environment variable doesn't contain a python executable folder.

v2.0.0

Whats New:

With this major release we have added a new communication framework to improve the overall speed and resiliency between Alias and Shotgun. We have also addressed some cleanup and consistency with the rest of toolkit and fixed some customer bugs.

Features/Polish:

  • Replaced Alias communication protocol with Shotgun using pybind11 library
  • Remove dependency of tk-framework-atf
  • Make tk-framework-locking an optional dependency
  • Change hooks from tk-multi-breakdown, tk-multi-loader2, tk-multi-snapshot, tk-multi-workfiles2 and tk-multi-shotgunpanel to match existing Shotgun tk-default-config2 hook structure
  • Removed the about app and created software_credits files in each app/engine/framework repo
  • Cleanup messages in Publish logs while in DEBUG mode
  • Add sg_uploaded_movie for each Version created from Alias Publish
  • Modified WREF Publish Description in Publish hooks
  • Remove "Screening Room..." options in Alias
  • Improve Publish Hooks to support when publishing to a permission restricted directory
  • Remove "Import into a New Scene" action in tk-multi-loader2
  • Linked Task to Notes when publishing annotations and variants from Alias
  • Improved popup notification when loading in files from the Loader

Fixed Bugs:

  • Fixed some bugs related with the locking framework:
    • Unable to save file to Shotgun after publishing
    • Opening a file in Alias fails if using default file_usage_hook
  • Failed to Publish file with external references

  • Failed to publish file with variants
  • Failed to save file with external references
  • Alias Alternatives don't update when updating a reference using the Scene Breakdown app
  • Redraw Alias viewport when a "Scene Breakdown Update Selected" completes to show the changes

v1.0.1

First release of Alias engine.

Follow