Skip to content

install as a new menu entry

  1. Copy localorender.py to your local nuke path (~/.nuke)

  2. At the same location, open the menu.py file (or create it) and add the following content inside:

A nuke panel floating above the UI. Can be docked.

import nuke
import localorender

menu = nuke.menu("Nuke").menu("Render")
menu.addCommand("Open LocaloRender", lambda: localorender.open_as_panel(), "F8")

A modal dialog is an un dockable window that block all the UI until the window is closed.

import nuke
import localorender

menu = nuke.menu("Nuke").menu("Render")
menu.addCommand("Open LocaloRender", lambda: localorender.open_as_panel(modal=True), "F8")

You can open the tool in Nuke by going to the top menu bar > Render > Open LocaloRender

Tip

You can also change the shortcut in the above code from F8 to what you prefer.

optional configuration

You can also optionally add the following lines: 

localorender.configure_logging()
which should allow you to see logging message in the Script Editor.

It's possible to set the configuration in which the tool open using the uibuilder argument:

import nuke
import localorender

uibuilder = localorender.UiBuilder(
    # open the UI with all writes nodes loaded by default
    node_selection_mode=localorender.WriteNodeSelectorWidget.option_all,
    # prevent to use the Settings system (if bugged)
    lock_settings=True,
)

menu = nuke.menu("Nuke").menu("Render")
menu.addCommand(
    "Open LocaloRender",
    lambda: localorender.open_as_panel(modal=True, uibuilder=uibuilder),
    "F8"
)