How do I switch from using tk-photoshop to tk-photoshopcc?

Note: This document describes functionality only available if you have taken control over a Toolkit configuration. Please refer to the Shotgun Integrations Admin Guide.

With the release of the tk-photoshopcc engine and accompanying support for Photoshop CC 2015.5+, Shotgun Toolkit configs will need to be upgraded to make use of the new integration. Follow the steps below to ensure that your projects are properly configured.

  • It would be best to go ahead and upgrade to the latest tk-core, but at a minimum ensure that your project is using v0.18.18 or newer.
  • Update the paths to Photoshop in your paths.yml file. Here's an example from our default config.
#
# Photoshop CC
#
photoshop_mac: /Applications/Adobe Photoshop CC 2017/Adobe Photoshop CC 2017.app
photoshop_win: 'C:\Program Files\Adobe\Adobe Photoshop CC 2017\Photoshop.exe'
  • Update all of the tk-photoshop engine instances to become tk-photoshopcc. You'll need to go through each of the yml files in the env directory in your config and make these changes. There's also the need to make a small change to one of the hook definitions for the tk-multi-loader2 app, as highlighted in the example below. Good examples from our default config can be found here and here.
  #
  # -------------------------------------------------
  # Photoshop CC
  # -------------------------------------------------
  tk-photoshopcc:
    apps:
      tk-multi-about: '@about'
      tk-multi-shotgunpanel: '@shotgunpanel'
      tk-multi-screeningroom: '@launch_screeningroom'
      tk-multi-workfiles2: '@workfiles2'
    shelf_favorites:
    - {app_instance: tk-multi-workfiles2, name: File Open...}
    - {app_instance: tk-multi-workfiles2, name: File Save...}
    debug_logging: false
    location:
      version: v1.0.1
      type: app_store
      name: tk-photoshopcc

  #
  # -------------------------------------------------
  # photoshop CC
  # -------------------------------------------------
  tk-photoshopcc:
    apps:
      tk-multi-about: '@about'
      tk-multi-loader2:
        action_mappings:
          Photoshop Image: [add_as_a_layer, open_file]
          Rendered Image: [add_as_a_layer, open_file]
        actions_hook: default
        download_thumbnails: true
        entities:
        - caption: Assets

...
shelf_favorites: - {app_instance: tk-multi-workfiles2, name: File Open...} - {app_instance: tk-multi-snapshot, name: Snapshot...} - {app_instance: tk-multi-workfiles2, name: File Save...} - {app_instance: tk-multi-publish, name: Publish...} debug_logging: false location: version: v1.0.1 type: app_store name: tk-photoshopcc
  • Point the Photoshop app launcher to use the tk-photoshopcc engine instance in your env/includes/app_launchers.yml file. An example from our default config can be found here. You can also replace the extra setting's value with an empty dictionary, as it's no longer needed for the new engine.
#
# -------------------------------------------------
# Photoshop CC
# -------------------------------------------------
launch_photoshop:
  defer_keyword: ''
  engine: tk-photoshopcc
  extra: {}
  hook_app_launch: default
  hook_before_app_launch: default
  icon: '{target_engine}/icon_256.png'
  linux_args: ''
  linux_path: ''
  location:
    version: v0.8.0
    type: app_store
    name: tk-multi-launchapp
  mac_args: ''
  mac_path: '@photoshop_mac'
  menu_name: Launch Photoshop
  versions: []
  windows_args: ''
  windows_path: '@photoshop_win'
  • Run the tank updates command on your config. This will ensure that you have all of the necessary apps and frameworks at their required versions for the new engine.
  • Run the tank cache_apps command on your config. This will ensure that the new engine has been downloaded from the app store after updating all of the engine definitions in your config to make use of the new tk-photoshopcc engine.

 

Follow

0 Comments

Article is closed for comments.