Configuration Settings
◀ Documentation Index

Optional Settings
   deny_platforms
   viewer_path_mac
   hook_launch_publish
   viewer_extensions
   deny_permissions
   viewer_path_windows
   viewer_path_linux

Configuration Settings

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.

Optional Settings

These settings are optional and can be defined at the discretion of the user.

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 Tank 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

Hook calling format: def execute(path, context, associated_entity)

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: ['exr', 'cin', '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.

tk-shotgun-launchpublish Documentation. This was auto generated on 2013-05-14. Click here for Release Notes.