-
Notifications
You must be signed in to change notification settings - Fork 34
Release Notes
Welcome to the release notes for the Multi Launch 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!
2024-Mar-26
Rebranding component for Flow Production Tracking
2023-Nov-09
- Use the first version in list as
group_default(as advertised in info.yaml). Thanks to @dsagilles for the contribution.
2023-Oct-27
- No new features are included in this release.
2023-Sep-26
- Add indication when an app launches on SG Desktop.
- Remove deprecation warnings from Python 3.10
2023-Jun-29
- Pop up an error dialog if launch app fails
2022-Mar-28
ShotGrid branding updates.
2021-Dec-1
Replacing shotgunsoftware urls with Autodesk Knowledge Network and ShotGrid Developer Documentation pages.
2021-Jun-02
Rebranded to ShotGrid
2020-Mar-16
New features
Details:
- When using the
Softwareentity launcher, theSoftwareentity now gets passed through as a keyword argument to thebefore_app_launch.pyandapp_launch.pyhooks. AdditionalSoftwareentity fields can be specified via the newsoftware_entity_extra_fieldsapp setting. They will be fetched by the app and and included in theSoftwareentity dictionary that gets passed to the hooks. We have Unai Martínez Barredo to thank for their awesome help on implementing this. - The contents of the
Softwareentitydescriptionfield will now be used as the Tooltip message in Shotgun Desktop if provided. A big thanks goes to Joe Yu for providing that. - You can now specify args on the
Softwareentity via the dedicated args fields, and have them take effect without having to also set the path to the software. In short custom args can now be used in conjunction with the auto software detection logic.
2020-Jan-28
Adds Python 3 support.
2019-June-04
Fixes multiple launch args being combined as one on Mac.
Details:
Fixes an issue on Mac where if you provided multiple launch args, and you were pointing to the .app file for your software, then it would encapsulate all the args in one string, effectively providing them as a single arg in the command rather than as multiple. Thanks goes to Stéphane Deverly for suggesting the fix.
2018-Oct-29
Adds the software entity id to the properties of a launcher. This helps fixing a filtering issue in the browser integration.
2018-Sep-13
The application will now skip over undownloadable software icons instead of failing.
2018-Mar-06
On OS X, we now allow for both .app and unix-style executable launches.
Details:
Removes Flame-specific logic in favor of a generic solution. We now look at what kind of path we're being asked to launch on OS X: if it's a .app application bundle, we use the "open" command, and if it's not we treat it like any other Unix-style executable.
2017-Dec-04
QA fix to account for flame launch with and without tk integration
2017-Nov-30
Supplies the engine name to the app launch hooks
2017-Nov-13
Switch from path detection to env variable check for flame launch
2017-Nov-10
Updated metrics logging
2017-Oct-24
Adds additional logic to detect that Flame is being launched via a Software launcher.
2017-Sep-22
Adds a skip_engine_instances app setting.
Details:
This can be used to allow an engine instance to be configured for a given environment without a launcher existing for it. This is useful in the case of Nuke Studio, where we want to allow for context changes into certain environments, but we only want the application to be launchable from a project environment.
2017-Sep-19
Ensures that the requested engine instance is configured.
Details:
When the before_register_command hook changes the engine instance name to be used by a launcher, we now ensure that the new engine instance is configured in the current environment before going ahead with the command registration with the engine.
2017-Sep-18
Bug fix for argument ordering in the single-config-launcher API.
Details:
The single-config-launcher API did not order its arguments properly when launching from a context and/or path. This broke the tk-shotgun-launchpublish app.
2017-Sep-01
Minor changes needed to allow the tk-shotgun-launchpublish app to support Software entity launchers.
2017-Aug-22
Adds a new before_register_command hook.
Details:
The default implementation is for the hook method to be a no-op. It is intended to be overridden at the config level when redirecting to an engine instance other than what is set in the associated Software entity. A realistic example would be for Nuke and Nuke Studio. They share a single Software entity in SG, but in classic SGTK project setups Nuke Studio is configured differently than Nuke. In that situation, we need to redirect to a tk-nukestudio engine instance prior to the launcher command being registered with the engine.
2017-Jul-27
Clears and restores Qt library paths when launching.
Details:
This replaces logic that has now been removed from tk-shell and tk-shotgun. In those implementations, the library paths were always cleared, regardless of OS, and were never restored. That was a bad idea, and caused problems with browser integration and shell launching in some cases.
2017-Jun-29
Tweaks to debug logging.
2017-May-17
Minor adjustments to logging output
2017-May-16
Fixed issue in shotgun version detection check.
2017-May-16
Incremented minimum required core version
2017-May-04
Support for software entity based launching.
Details:
- When connected to shotgun 7.2 and above, adds support for the software entity. This is disabled by default and can be turned on via a use_software_entity setting.
- Adds parameters needed for the upcoming websockets integration
- Adds support for better grouping and group defaults. If used, these will propagate to the register command call and will be utilized by engines that implement command grouping.
- Support for automatic software scanning interfaces. Used in conjunction with the software entity, allowing a setup where the launch app reaches out to an engine and requests that the engine reports which software installations are detected on the current machine.
2017-Mar-15
Removes problematic profiles from png files used as icons.
Details:
This will silence libpng warnings from Qt when the png files are loaded as pixmaps. This is a second attempt as this profile stripping, and uses ImageMagick's "mogrify" command to achieve the desired result, which maintains color consistency.
2016-Oct-06
Removes Maya 2012/2013 specific SSL patching.
Details:
Support for Maya versions older than 2014 has been deprecated.
2016-Sep-19
PATH environment variable fixes for 3ds Max 2017 compatibility.
2016-Apr-12
adds support for version token replacement in args setting
Details:
-
This enables clients who use a wrapper to launch their DCC, take advantage of the version tokens in the
*_argssetting for launching multiple versions of their DCC. -
Removed error when launching from a Task in the Shotgun web application without an associated Pipeline Step. It is completely valid to have a schema that uses Tasks that do not have an associated Pipeline Step. Previously, we would raise an exception when launching from a Task in the Shotgun web UI that had no associated Pipeline Step.
2016-Apr-11
(NOT RELEASED) Removed error when launching from a Task in the Shotgun web application without an associated Pipeline Step
2016-Apr-08
(NOT RELEASED) adds support for version token replacement in args setting
2016-Feb-29
Remove warning about missing version tokens in menu
Details:
- Previously when you specified versions in your launcher instance settings, but didn't use any version tokens in the instance menu name, a warning would be emitted: . This warning was misleading and unnecessary. So we've now removed it altogether.
- Updated docs regarding using multiple defer_keywords
Cleans up the bootstrap module after launch.
Details:
After a "generic" bootstrap operation is performed, the bootstrap module that was imported is removed from sys.modules. This allows subsequent launches that make use of a bootstrap module to function properly.
Rearranges bootstrapping logic to fix bootstrapping for some engines.
Details:
Some engines have a bootstrap.py file included in their structure, but aren't setup for those to be fully standalone. In those cases, we need to let the launchapp bootstrapping code specific to that engine to run rather than relying on the generic bootstrapping behavior to handle everything.
Favors bootstrap routines provided by the engine over those contained in the app.
Details:
If the engine contains bootstrapping logic it will be used. If it does not then launchapp will fall back on its internal logic.
2015-Nov-04
Improved error message when flame is not found.
app_path, app_args, and version parameters passed to both hooks
Details:
The before_app_launch hook now gets the same parameters as the app_launch hook which means you have access to the path of the application being launched and any arguments passed in. Also added a version parameter which will contain the version being launched if it was defined in the 'versions' setting in the Launcher instance (otherwise this will be None).
add additional tokens to specify parts of the version string
Details:
Allows defining groups in the version string using ()s. You can then reference them in order as tokens in the icon, *_path, and menu_name settings. For example, if the version setting is ["(9.0)v4(beta1)"], the resulting available tokens would be:
{version}: "9.0v4beta1"
{v0}: "9.0"
{v1}: "beta1"
Updated signature for the generic engine boostrap call.
Pass multi-launchapp instance to the generic bootstrap.
improved error when trying to run 3dsmax 2015 with the old tk-3dsmax engine
Details:
3dsmax 2015 requires the newer tk-3dsmaxplus engine to run. However, users may upgrade from older versions of 3dsmax and not realize this. Previously when doing so, they would get an unhelpful error message when the bootstrap script attempted to run on startup. This change catches the error at that point and displays a dialog explaining the need to use the newer tk-3dsmaxplus engine instead.
App now backups the environment variables before launching an app and restores them afterwards.
Details:
sys.path and os.environ are now backed up before any app launch and restored after so that one app's launch environment can't leak into another's.
Added generic engine launch logic so new engines do not need to modify this app.
Documentation Update
Update the project python bootstrap to reset PATH
Details:
Make sure applications are launched with the proper DllDirectory set.
Minor adjustments to the Flame bootstrap sequence.
Details:
This changes the way the Flame family is being launched so that it gains greater control over the boostrap and launch process. The actual executable argument is being sent in to Flame so that this can be re-written by the engine at runtime, effectively allowing the Flame engine to run the DCC launch through its own wrapper script. This is to ensure that a particular environment is being set up where all library dependencies are working etc.
Added support for the Flame Engine.
Added support for the new 3DS Max Engine supporting MaxPlus and Max version 2015.
Added support for launching Mari
Improved error messaging when an application cannot be launched.
Added a 'defer_keyword' parameter to support some advanced use cases.
Details:
This adds a new manifest parameter called 'defer_keyword'. Here is the manifest description: Advanced parameter. This allows for advanced customization around deferred folder creation. Deferred folder creation allows for the creation of partial subfolder structures depending on a specific keyword (see main documentation for details). Before an app is launched, folders are automatically created and by default (e.g. if you leave this setting as null), the launch app will pass the name of the engine as the deferred folder creation keyword. This makes it easy to set up deferred rules in your folder creation config for tk-maya, tk-nuke etc. However, if you for example wanted to set up specific deferred folder structures for Nuke and Nuke X (both running the nuke engine), you need a finer granularity. This setting can then be used to override the default behaviour of just passing the engine name. Instead, you can pass any string into the deferred folder creation (for example 'nuke' and 'nuke_x' in the case above). This parameter is also useful if you want to use deferred folder creation in conjunction with launching of apps which do not have a toolkit engine defined - for these app launch instances, the engine setting is left blank, and therefore no engine name is passed into the deferred folder creation. In such cases you can utilize this parameter to control the deferred folder creation.
Added a 'defer_keyword' parameter to support some advanced use cases.
Details:
This adds a new manifest parameter called 'defer_keyword'. Here is the manifest description:
Relaxed the error catching for the icon setting.
Details: Relaxed throwing an error if the icon is set to a '{target_engine}' replacement string even if the engine setting is empty.
Support for the icon and versions settings.
Details: Added two new settings, "icon" and "versions". The icon can be used to define an icon that should be registered for the command if the engine has support for icons. The versions setting is shorthand for defining multiple applications where the only difference between the configurations is the version of the application being launched.
Event log statistics now also tracks the core API version.
Support for renamed env vars for photoshop engine.
Details: Added support for latest photoshop engine. Added readme for building linux Softimage dependencies. 3dsMax bootstrap handles _blurLibrary not being defined.
Improved Softimage launching on Linux
Fixed a bug that would cause launching to fail for 3dsMax and Motionbuilder
Added ability to launch applications not yet integrated with Toolkit.
Updated minimum required core version to v0.14.0
Better support for review versions.
Added logic for handling launching from review versions.
Updated Softimage support
Added exceptions for softimage.
Houdini is not supported on osx due to Qt compatibility issues.
Details: Houdini is not supported on osx due to Qt compatibility issues.
Added Houdini and ability to open hiero projects at application startup.
Renames and support for the new name Sgtk.
Added experimental support for launching softimage.
Added a check so that Tasks that are missing steps cannot be launched from when launching from inside Shotgun.
Adjustments to context handling and folder creation.
Details:
- The context is now serialized and passed from the app into the booting application
- Now correctly handles setups which are not task or file based
- Added new interfaces for better preserving context state when launching from a publish
Adjustments to context handling and folder creation.
Details:
- The context is now serialized and passed from the app into the booting application. This means that any context can be transferred into a launching app. Previously there were some built in restrictions as to what was possible to pass.
- Added a pre launch hook for easy addition of environment variables to the launch.
Bug fixes and preparation for v0.13
Details:
- adjusted launch code for hiero to work with latest version of hiero
- fixed a bug where opening nuke via a nuke file wasn't working
- general prep for v0.13
- improved command metadata
- polish on certain error messages
Added documentation.
Fixed issues with launching 3dsmax, removed the platforms parameter from the configs.
Initial Release to the Tank Store.