Due to the changes on Nuke version 11+ on the Pyside (upgraded to Pyside2) and the underlying QT Framework (upgraded to QT 5.X), the plugin is distributed in two distinct packages. Be sure to pick up the right package for your Nuke version!

Installation

  • Copy the submitToMuster.py script into your Nuke scripts installation folder
  • Modify your menu.py file and add the following line to initialize the plug-in only on Nuke interactive sessions:
    nuke.menu( 'Nuke' ).addCommand( 'Render/Submit to Muster', “submitToMuster.submitToMuster()” )
  • Restart Nuke. You’ll find the Submit to Muster command in the Nuke Render menu

The plug-in is supported on any version of Nuke running PySide or Pyside2 (QT Python bindings)

Usage

The Submit to Muster plugin for Nuke allows you to send a job directly from the Nuke interface.

The window is made by two distinct tabs, the Job and the Dispatcher tab:

The Job tab let you define the parameters for the submission:

* Job name: The name of the job that will appear into Muster
* Job department: The department custom value that will appear into Muster
* Job project: The project custom value that will appear into Muster
* Start frame: The start frame for the job
* End frame: The end frame for the job
* By frame: The by frame for the job
* Packet size: The packet size of the job
* Job priority: The job's priority value into the queue
* Job parent ID: If you want to submit inside a folder, you can specify the folder ID
* Logs error check: The logs error check level desired
* Exit codes error check: The exit codes error check level desired
* Job maximum instances: The maximum instances allocable for the job
* Job dependancies: If you want the job to depend from other jobs, you can specify their IDs in this field
* Destination pools: The job's destination pools
* Excluded pools: The job's excluded pools
* Submit paused: Submit the job in paused status
* Nuke template version: If you're running a multi version template, you can specify the target version in this field
* Additional flags: Additional flags to pass to the Nuke command line renderer

While into the Dispatcher tab you'll find all the connection properties that should be configure only once:

* Installation path: The root Muster installation path on your local workstation
* Muster version: The Muster version you're going to target
* Dispatcher address: The Dispatcher host name or IP address
* Dispatcher port: The Dispatcher management port
* Login: The account login name used to submit the job
* Password: The account password
* Skip templates sync: If you're sure your templates have not changed since the last run of Mrtool, you can check this option and skip the synchronisation phase. This will produce a faster submission
* Nuke template ID: The ID of the Nuke template, if you're using a custom template, you can set your template ID in this field

You can simply fill in the fields and click the Submit button to have the job sent to the Dispatcher.
The Reset button resets the fields to their default values, while the Close button just closes the dialog