Nuke - Quickdailies Node

Quickdailies

A custom dailies node in Nuke that creates a quicktime and creates a corresponding review version in Shotgun.


By: Shotgun Software
Latest Version: v0.3.5 (prod)
For our version numbers, we follow the Semantic Versioning standard.
System Name: tk-nuke-quickdailies

Overview

This document describes functionality only available if you have taken control over a Toolkit configuration. Please refer to the Shotgun Integrations User Guide for details. This app adds a node type to Nuke which you can add anywhere in your node graph. Once added to your scene, you can double click the node, go to the properties page and hit the "Send to Review" button. The app will then render a quicktime of your scene, add burnins and slates and send it to Shotgun. It will also generate filmstrip thumbnails which makes it easy to preview the version in Shotgun.

Documentation

This Shotgun App adds a custom node to Nuke. The node is called Quick Dailies and lets you quickly send stuff to review. You can create a Quick Dailies Node via the Shotgun Node Menu:

Snapshot

You simply attach the node to any part of the Nuke graph that you want to inspect and send to review:

Snapshot

If you click on the node, the following, very simple UI appears:

Snapshot

Clicking the button will launch a dialog asking you for comments and to type in a name. The name is auto-populated with the current work file name if this is available:

Snapshot

Once you click "ok", the App will generate a Quicktime with a slate and burn-ins and create a corresponding Version in Shotgun.

Snapshot Snapshot

Related Apps and Documents

Review Submission

This document describes functionality only available if you have taken control over a Toolkit configuration. Please refer to the [Shotgun Integrations User Guide](https://support.shotgunsoftware.com/hc/en-us/articles/115000068574-Integrations-User-Guide#Associated%20review) for details. An app that provides functionality to help submitting image sequences as Versions in Shotgun for review. This app does not have a UI but instead provides API methods for quicktime and review generation. You can call the app from your scripts, or from within hooks. For example, your publish configuration can call this as part of a post process hook if you want to create a quicktime and send it for review. This app will generate a quicktime with burn-ins and slates. You can configure if you want it to upload the quicktime to Shotgun or keep it on disk, or both. Lastly it will create a new version inside of Shotgun, ready to reviewed in Screening Room!

Installation and Updates

Adding this App to the Shotgun Pipeline Toolkit

If you want to add this app to Project XYZ, in an environment named asset, execute the following command:

> tank Project XYZ install_app asset tk-nuke tk-nuke-quickdailies

Updating to the latest version

If you already have this item installed in a project and you want to get the latest version, you can run the update command. You can either navigate to the tank command that comes with that specific project, and run it there:

> cd /my_tank_configs/project_xyz
> ./tank updates

Alternatively, you can run your studio tank command and specify the project name to tell it which project to run the update check for:

> tank Project XYZ updates

Collaboration and Evolution

If you have access to the Shotgun Pipeline Toolkit, you also have access to the source code for all apps, engines and frameworks in Github where we store and manage them. Feel free to evolve these items; use them as a base for further independent development, make changes (and submit pull requests back to us!) or simply tinker with them to see how they have been built and how the toolkit works. You can access this code repository at https://github.com/shotgunsoftware/tk-nuke-quickdailies.

Special Requirements

  • You need Shotgun Pipeline Toolkit Core API version v0.14.12 or higher to use this.
  • You need Engine version v0.2.3 or higher to use this.

Configuration

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.

post_hooks

Type: list

Description: List of hooks that runs after a quickdaily has been rendered and uploaded to Shotgun. Parameters passed to the hook are mov_path, version_id and comments.

movie_template

Type: template

Description: The location where the output quicktime will be written to. The two fields iteration and optionally name will be populated. Iteration is an integer number which will be automatically calculated based on the existing files on disk. Name is typically derived from the name of the current scene.

codec_settings_hook

Type: hook

Default Value: {self}/codec_settings.py

Description: Hook for customizing codec settings used when generating quickdaily items for review.

sg_version_name_template

Type: template

Description: Template used to populate the version name in Shotgun. You can use any field from the current context (such as for example Shot and Sequence) and the template must include iteration. Additionally, name and the current version will be used if they are defined.

height

Type: int

Description: The quicktime resolution height

width

Type: int

Description: The quicktime resolution width

upload_movie

Type: bool

Default Value: True

Description: If true, the Quicktime movie will be uploaded to Shotgun in the Version's sg_uploaded_movie field which will allow the Version to be viewed in the Shotgun web player.

current_scene_template

Type: template

Description: Template that will be used to extract the name and version from the current scene. Both name and version are optional.

Release Notes

Welcome to the release notes for this 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!

v0.3.5

2017-Feb-15

Small fix to correctly support Nuke 10.5v1

v0.3.4

2016-Oct-07

Accounts for changes in the Write node's .mov encoding settings in 10.0v2+

Details:

With the 10.0v2 release, Nuke's dependency on the Quicktime desktop application was removed. As a result, if Quicktime is not installed, the settings for the Write node when outputting the .mov file type have changed.

v0.3.3

2016-Aug-15

Adds full support for on-the-fly context changes by re-caching templates when needed.

v0.3.2

2016-Jun-20

Quicktime movie will be uploaded to Shotgun by default

v0.3.1

2016-May-12

Fix an issue where bad quality QuickTimes gets generated in Nuke 9

v0.3.0

Adds support for context changes.

v0.2.1

2016-Jan-07

Uses get_current_user to determine the current Shotgun user to associate the daily with.

v0.2.0

2015-Sep-28

Moves the Quicktime generation settings into a hook

Details:

  • Allows studios to easily override the default output settings. Also adds handling for the knob name change in Nuke 9.0 from codec to meta_codec.
  • Added setting to upload the movie to Shotgun. This allows reviewing the quickdaily in the Shotgun web player. Note, this is false by default to maintain backwards compatibility.
  • Updated default settings for Nuke 9+ on linux. Nuke 9 removed ffmpeg as a file_type and replaced it with mov64. This handles that case and sets the codec to jpeg in that case to match the behavior on Mac and Windows.

v0.1.8

Name is no longer a required key in templates

v0.1.7

Renames and support for the new name Sgtk.

v0.1.6

Added app icon.

v0.1.5

Updated to use new folder creation API methods.

v0.1.4

Updated manifest to require core v0.12.5

v0.1.3

App now supports code reload.

v0.1.2

Extended the template format. Customizable names in Shotgun.

  • The way versions are named in shotgun can now be customized via a template.
  • Previously, version numbers were not used with this app, only the concept of iterations. Now version numbers can be used in the templates, but are optional.
  • The UI has been tweaked so that it displays the full shotgun version name, as it will be appear, and it is no longer editable.

v0.1.1

Fixed a minor bug in the post-hook execution.

v0.1.0

Initial Release to the Tank App Store.

Follow

4 Comments

  • 0
    Avatar
    KP

    This app doesn't upload the movie to Shotgun by default so your daily won't be viewable in the browser using Screening Room. We plan to update quickdailies to use tk-multi-reviewsubmission which is a more standardized "api-type" app. However, for now, you can add this functionality yourself using a very simple hook. 

    Check out this forum post for details: "How do I view my Nuke Quickdaily in Shotgun Screening Room"

    ** UPDATE **

    This information is outdated. See comment below for updated information.

     

  • 0
    Avatar
    Tony Hudson

    the below is not very clear:

    Configuration

    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.

    It would be much more helpful to give the NAME of the .yml file that should be edited. I've been searching for an hour and cannot find the file to edit in order to set the move size and a format. By default it is giving me a prores 4444 file which cannot be viewed in the web view NOR rv as rv will not display prores files

     

  • 0
    Avatar
    KP

    As of v0.2.0, you can now set the upload_movie setting to true in order to have the Quick Dailies app upload your movie to Shotgun in order to review it in the web player. 

    We have also moved the codec settings into a hook so you can customize this as needed by your studio. By default the hook is also handling the various changes and updates in Nuke so it doesn't fall back on the default Apple ProRes 4444 codec.

  • 0
    Avatar
    KP

    @tony, sorry for the confusion and trouble. With the new update, you should be able to update and things should work as expected again. The "environment files" we refer to in Toolkit documentation, are located inside your pipeline configuration in the config/env/ . These files are all .yml files and correspond to what type of thing you're working on (a Task for a Shot, a Task for an Asset, etc). For example, shot_step.yml refers to the environment when you're working on a Shot Task (the "step" in the filename refers to the PIpeline Step of the Task) and asset_step.yml corresponds to working on a Task for an Asset. These environments would be loaded by default when launching Toolkit from the Shotgun web application by right-clicking on a Task linked to a Shot or Asset. 

    In general, these are the two most common environments, but if you don't use Tasks at your studio, you may just want to work on the Shot ( shot.yml ) or Asset ( asset.yml ). The Project environment ( project.yml ) is the default envrionment loaded when launching your DCCs from SG Desktop, but it also the environment you'd work on in Hiero for example. 

    Hope that explains things a little better!

     

Please sign in to leave a comment.