tk-multi-launchapp Documentation
How It Works
Technical Details
   3DSMax
   Hiero
   Maya
   MotionBuilder
   Nuke
   Photoshop
Setup and Configuration

tk-multi-launchapp Documentation

This app provides a shortcut to make it easy to jump from Shotgun to any supported application. It registers a Tank Action entry called for various entities in Shotgun according to your configuration choices.

How It Works

Depending on your configuration options a menu entry will appear in Shotgun when right-clicking entities or using the tank actions menu or gear menu.

For example, this screenshot comes from a site who's configuration uses this app three times to implement menus for Maya, Nuke and Photoshop.

Tank Actions Menu

Currently supported applications and tank engines are:

Technical Details

3DSMax

This app automatically adds a MaxScript, init_tank.ms, to the 3DSMax command line that 3DSMax will run as part of its boot process.

When 3DSMax is booting, the following will happen:

  1. 3DSMax will run init_tank.ms upon starting
  2. init_tank.ms makes sure a Python interpreter is available and runs tank_startup.py
  3. Using the tank Context API, the entity id passed from Shotgun is converted into a Tank Context.
  4. Start the appropriate Engine (via tank.system.start_engine()) and pass in the Context. The engine will take care of the rest.

Extra configs

No extra configs are necessary for the 3DSMax engine

Hiero

Maya

This app registers a userSetup.py auto start script with Maya which Maya will call as part of its boot process.

When Maya is booting, the following will happen:

  1. Maya starts execution of the userSetup.py startup script
  2. Using the tank Context API, the entity id passed from Shotgun is converted into a Tank Context.
  3. Start the appropriate Engine (via tank.system.start_engine()) and pass in the Context. The engine will take care of the rest.

Extra configs

No extra configs are necessary for the Maya engine

MotionBuilder

This app registers a init_tank.py auto start script with MotionBuilder which MotionBuilder will call as part of its boot process.

When MotionBuilder is booting, the following will happen:

  1. MotionBuilder starts execution of the init_tank.py startup script
  2. Using the tank Context API, the entity id passed from Shotgun is converted into a Tank Context.
  3. Start the appropriate Engine (via tank.system.start_engine()) and pass in the Context. The engine will take care of the rest.

Extra configs

No extra configs are necessary for the MotionBuilder engine

Nuke

This app registers a menu.py auto start script with Nuke which Nuke will call as part of its boot process.

When Nuke is booting, the following will happen:

  1. Nuke starts execution of the menu.py startup script
  2. Using the tank Context API, the entity id passed from Shotgun is converted into a Tank Context.
  3. Start the appropriate Engine (via tank.system.start_engine()) and pass in the Context. The engine will take care of the rest.

Extra configs

No extra configs are necessary for the Nuke engine

Photoshop

This app will use the Adobe Extension Manager to install or make sure the Tank plugin is installed.

When Photoshop is booting, the following will happen:

  1. Photoshop will start the execution of the Tank Plugin
  2. Using the tank Context API, the entity id passed from Shotgun is converted into a Tank Context.
  3. Start the appropriate Engine (via tank.system.start_engine()) and pass in the Context. The engine will take care of the rest.

Extra configs

If you intend to use this app to launch Photoshop you will need to supply four config values in the extra section. Here are the configs and sane default values which you would need to adjust for your system and installation locations:

mac_python_path: "/usr/bin/python"
windows_python_path: "C:\\Python27\\python.exe"
mac_extension_manager_path: "/Applications/Adobe Extension Manager CS6/Adobe Extension Manager CS6.app"
windows_extension_manager_path: "C:\\Program Files (x86)\\Adobe\\Adobe Extension Manager CS6\\XManCommand.exe"

Setup and Configuration

To see all the various configuration parameters that you can set in order to customize the behaviour of this item, please head over to the settings page.

tk-multi-launchapp Documentation. This was auto generated on 2013-02-28. Click here for Release Notes.