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.
These settings need to be defined in any environment where this app or engine is being used.
Type: str
Description: The name of the Tank engine to start. This is typically the application name prefixed with tk, e.g. tk-maya, tk-nuke, tk-photoshop etc.
Type: str
Description: The path to the application executable on Windows.
Type: dict
Description: Tank engine specific extra values. These are defined per Tank engine. Please look in the app documentation for more details.
Type: str
Description: The path to the application executable on Mac OS X.
Type: str
Description: Name to appear on the Tank menu.
Type: str
Description: The path to the application executable on Linux.
These settings are optional and can be defined at the discretion of the user.
Type: str
Description: The arguments to be passed to application on Linux, as a string.
Type: str
Description: The arguments to be passed to application on Windows, as a string.
Type: hook
Hook calling format: def execute()
Default Value: app_launch
Description: Called to launch the application. This hook contains the code that does the actual execution of the launch command and parameters. If you have a custom launcher system in your studio, it can be handy to override Tank's default launch behaviour.
Type: str
Description: The arguments to be passed to application on Mac OS X, as a string.
Type: hook
Hook calling format: def execute()
Default Value: before_app_launch
Description: This hook is called just before the hook_app_launch is used and can be useful if you don't want to modify the way applications are being launched (which is advanced usage and can be done by overriding the app_launch hook), but merely want to modify the environment before app launch. You may want to add additional pipeline paths, APIs or other things to the setup, or specify additional scripts etc to run.
tk-multi-launchapp Documentation. This was auto generated on 2013-05-14. Click here for Release Notes.