Shotgun - Viewing Published Files

Launch Published File

Open a published file in its associated application.


By: Shotgun Software
Latest Version: v0.1.16 (beta)
For our version numbers, we follow the Semantic Versioning standard.
System Name: tk-shotgun-launchpublish

Overview

This document describes functionality only available if you have taken control over a Toolkit configuration. Please refer to the Shotgun Integrations User Guide for details. This app works in conjunction with the launcher app and lets you right click on a published file in order to launch it in its host application. Shotgun will start up the relevant application and initialise the Shotgun Pipeline Toolkit via a launcher app and then finally load the file in.

Documentation

This app adds a "Open in Associated Application" action to the Published File entity in Shotgun. This makes it easy to open up an already published file: Just navigate to that file, right click on it and select the action.

Work FS

The app makes it easy to configure different app launch sequences for different files -- all this is done inside a hook. It also dispatches image sequences to a viewer (such as RV). Files not recongized by the hook will be dispatched to the os-level app.

Related Apps and Documents

Launch Application

This document describes functionality only available if you have taken control over a Toolkit configuration. Please refer to the [Shotgun Integrations User Guide](https://support.shotgunsoftware.com/hc/en-us/articles/115000068574) for details. The Launch app makes it easy to jump from Shotgun or other environments right into an application. It supports a number of common applications such as Maya, Nuke, Photoshop etc. - see the documentation for the full list. We are adding support for new applications regularly as we build engines for them. When an application is being launched, the Shotgun context (the current Work Area) is set and the Shotgun pipeline toolkit is initialized and launched. It also handles folder creation on disk if you are using a user work sandbox. When the app has launched you will see a Shotgun menu, focused around the context you selected in Shotgun, ready for you to start work right away in the right part of the file system.

Installation and Updates

Adding this App to the Shotgun Pipeline Toolkit

If you want to add this app to the Shotgun action menu for Assets in Project XYZ, execute the following command:

> tank Project XYZ install_app shotgun_asset tk-shotgun tk-shotgun-launchpublish

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-shotgun-launchpublish.

Special Requirements

  • You need Shotgun Pipeline Toolkit Core API version v0.13.22 or higher to use this.
  • You need Engine version v0.1.0 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.

deny_platforms

Type: list

Description: An optional parameter which lets you turn off this app on certain platforms. If you don't want it to appear on the Shotgun Pipeline Toolkit action menu for a platform, just include it in the the deny_platforms list. Valid values are Windows, Mac and Linux.

viewer_path_mac

Type: str

Default Value: /Applications/RV64.app

Description: A path to an image sequence viewer for mac. Any path with an extension defined in the viewer_extensions list will be dispatched here.

hook_launch_publish

Type: hook

Default Value: shotgun_launch_publish

Description: Launch an application and tell it to load a file. Typically, this hook would look at the file extension, then decide on an app to launch, launch that app, start up the engine and finally load the file. Returns True if an application was launched, False if not.

viewer_extensions

Type: list

Default Value: [u'exr', u'cin', u'dpx']

Description: A list of file extensions to send to the viewer application. Do not include the period character. Example: [exr, cin, dpx]

deny_permissions

Type: list

Description: An optional parameter which lets you limit the visibility of this app. If you for example put in ['Artist'] as the value for this parameter, any user belonging to the shotgun permissions group Artist will not be able to see or execute the App.

viewer_path_windows

Type: str

Default Value: C:\Program Files\RV\RV64.exe

Description: A path to an image sequence viewer for windows. Any path with an extension defined in the viewer_extensions list will be dispatched here.

viewer_path_linux

Type: str

Default Value: rv

Description: A path to an image sequence viewer for linux. Any path with an extension defined in the viewer_extensions list will be dispatched here.

Release Notes

Welcome to the release notes for this App. 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!

v0.1.16

Added support for multi launch app syntax, needed by the default config.

v0.1.15

Added hook to allow custom resolution of the published file path

v0.1.14

Fixed an issue preventing new style publishes to be opened from versions.

v0.1.13

Fixed an issue with detecting hiero file extensions.

v0.1.12

Renames and support for the new name Sgtk.

v0.1.11

Renames and support for the new name Sgtk.

v0.1.10

Updated to use the configured Published File Entity type.

v0.1.9

Improved transfer of the context state when launching publishes.

Details:

  • Now creates a task based context if possible
  • Uses new method interfaces in multi-launchapp, falls back to old ones if needed
  • Improved hook structure.

v0.1.8

The default launch hook now stops the launch and errors if a launch app isn't installed for a known file extension.

v0.1.7

Preparations for Core v0.13

v0.1.6

Now runs the tank folder creation prior to engine launch.

v0.1.5

Added support for additional file formats in default hook. Added support for launching apps from a version record.

Details:

  • Extended the default hook to support fbx (motionbuilder), max (3dsmax) and hrx(hiero) files.
  • Added support for versions. A right click menu now also appears on version records. If these records have an associated tank publish, this publish is opened in its associated application.

v0.1.4

Added photoshop support to the default hook.

Details: psd files will now launch photoshop within the photoshop engine if the photoshop launcher is available.

v0.1.3

Minor modifications to manifest constraints.

v0.1.2

Minor changes to work nicely with core v0.12.5

v0.1.1

Tweaks to the configuration.

v0.1.0

First Release with the new Tank API.

v0.0.1

Initial release to the App Store.

Follow

0 Comments

Please sign in to leave a comment.