Root

The Project Settings in the Compositing environment are contained within the Root node, but the node itself is never visible in the Node Graph. When you start working on a script, you should first define the settings for it in the Project Settings.

You can display the Project Settings by navigating to Edit > Project Settings or by pressing S in the Node Graph.

Controls

Control (UI)

Knob (Scripting)

Default Value

Function

Root Tab

name

name

none

Allows you to set the script name and path. This field is completed automatically the first time you save the script.

project directory

project_directory

none

Sets the default location where project files are saved. For example, if you only specify a file name in a Write node, the files are rendered to this location.

Script Directory

Script_directory

N/A

Click to set the project directory using an expression so that if the .nk file is relocated, the project directory updates automatically.

comment

label

none

Adds a comment to the script, which is only visible in the plain text of the .nk file in the label field.

lock all connections

lock_connections

disabled

When enabled, all node connections are locked, making it easier to move nodes around the Node Graph without disconnecting them accidentally.

frame range

first_frame

1

Sets the frame range for the script, which is used for nodes that don't include their own frame range controls.

last_frame

100

lock range

lock_range

disabled

When enabled, the frame range is locked so that adding new image sequences does not alter the frame range.

When disabled, adding new image sequences alters the frame range to encompass the new range.

fps

fps

24

Sets the project frame rate. Adjusting this control affects the Viewer's frame rate as well.

full size format

format

2K_Super_35

Sets the default format for the project.

proxy mode

proxy

disabled

When enabled, images are rendered at either the proxy scale or format as specified by the proxy type control.

proxy_type

scale

Sets the proxy type when proxy mode is enabled:

format - the proxy resolution is determined by the proxy format control.

scale - the proxy resolution is determined by the proxy scale control.

proxy scale

proxy_scale

0.5

Sets the proxy resolution when the proxy type control is set to scale.

proxy format

proxy_format

1K_Super_35

Sets the proxy resolution when the proxy type control is set to format.

read proxy files

proxySetting

if larger

Sets when Read nodes fallback to the proxy resolution when proxy mode is enabled:

never - the proxy resolution files are never used.

if larger - the proxy resolution files are used if the files are equal to or larger than the scaled size.

if nearest - the files closest to the scaled size is used.

always - the proxy resolution files are always used.

is live group

is_live

disabled

When enabled, the script is saved as a LiveGroup script, allowing you to nest it within other scripts using the LiveGroup node.

render mode

render_mode

classic

Sets the Viewer render mode:

classic - enables the legacy scanline by scanline progressive rendering method.

topdown - enables the top-down rendering to render the full frame. Although topdown rendering produces the full frame faster, it disables progressive rendering and uses more memory. You may want to use the classic method if you're only interested in the first few scanlines in the Viewer.

Color Tab

color management

colorManagement

Nuke

Sets which colorspaces are available to Read/Write nodes and Viewer processLUTs in the current script.

Nuke - only the Nuke root colorspaces are available.

OCIO - the specified OCIO config colorspaces are available as well as Nuke root colorspaces.

OCIO config

OCIO_config

nuke-default

When color management is set to OCIO, sets the configuration to use and populates the default LUT settings appropriately.

Selecting custom allows you to reference a custom OCIO color file using the custom OCIO config control.

custom OCIO config

customOCIOConfigPath

none

When OCIO config is set to custom, enter the file path and name of the .config file.

default LUT settings

working space

workingSpaceLUT

linear

Sets the working colorspace within Nuke. Files are converted to this colorspace when they are read into Nuke. At render time, the files are converted from this colorspace to the selected output colorspace.

If color management is set to Nuke, this control is always set to linear.

monitor

monitorLUT

sRGB

Sets the default LUT for postage stamps, OpenGL textures, and all non-Viewer image and color displays.

If your Viewer process is a simple LUT, set this control to the same LUT, although sRGB provides an acceptable result is most cases.

Note:  When color management is set to OCIO, these colorspaces are grouped by the Display and saved in the Project Settings.

Other colorspace types are grouped by the family name.

8-bit files

int8LUT

sRGB

Sets the default LUT used when reading and writing image data containing 8 bits.

16-bit files

int16LUT

sRGB

Sets the default LUT used when reading and writing image data containing 16 bits.

log files

logLUT

Cineon

Sets the default LUT used when reading and writing image data containing Cineon/DPX style log data. These files are typically 10-bit.

float files

floatLUT

linear

Sets the default LUT used when reading and writing image data containing floating point values.

luts

luts

none

Displays the lookup curves used to convert between file/device colorspaces and the linear working colorspace used for internal operations.

Note:  SLog has been deprecated in favor of SLog1, but remains in the list to ensure backward compatibility.

+

N/A

N/A

Click to add a new curve to the list of LUTs.

reset

N/A

N/A

Click to reset any points that you have adjusted on a curve to their default position.

-

N/A

N/A

Click to delete a custom curve from the list of LUTs. You can't delete the default LUTs that ship with Nuke.

Views Tab

+

views

N/A

Click to add a new view to the script.

-

views

N/A

Click to remove a view from the script.

Note:  You cannot remove a view if it is the only view in the script.

up

views

N/A

Click to move a view up or down the views list. The view at the top is the first listed above the Viewer.

down

views

N/A

views

views

main

Lists all the views currently in the script and the color associated with each view.

Note:  The colors are only visible in the script when Use colors in UI? is enabled.

hero

hero_view

main

Sets the view that is loaded by default when the script is loaded.

Set up views for stereo

setlr

N/A

Click to automatically create left and right views for stereographic projects.

View selection uses buttons?

views_button

enabled

When enabled, the views in the script are displayed as buttons above the Viewer.

When disabled, the views in the script are hidden in a dropdown menu.

Use colors in UI?

views_colours

disabled

When enabled, the colors specified per view in the views list are displayed above the Viewer and in Node Graph for clarity.

Python Tab (These controls are for Python callbacks and can be used to have Python functions automatically called when various events happen in Nuke.)

onScriptLoad

onScriptLoad

none

These functions run when a script is loaded.

onScriptSave

onScriptSave

none

These functions run when a script is saved.

onScriptClose

onScriptClose

none

These functions run when a script is closed.

Live Group Callbacks

onLiveGroupMakeLocal

onLiveGroupMakeLocal

none

These functions run after a LiveGroup node goes from the Published state to the Local state.

onLiveGroupPrePublish

onLiveGroupPrePublish

none

These functions run before a LiveGroup is published. If this callback throws an error, the publish operation is interrupted.

onLiveGroupPublish

onLiveGroupPublish

none

These functions run after a LiveGroup is published.

onLiveGroupReload

onLiveGroupReload

none

These functions run after a LiveGroup is reloaded.

Font Tab

project font path

free_type_font_path

none

Allows you to specify a directory from which to read font files.

include system fonts

free_type_system_fonts

enabled

When enabled, all the system fonts are available in addition to those that ship with Nuke.

When disabled, only the fonts that ship with Nuke are available.

Rescan font path

RescanFreeTypeMappingPaths

N/A

Click to rescan the specified project font path for new font files.