1. Nuke Tools README

Nuke tools to help the development process inside Visual Studio Code.

• 1. Nuke Tools README
  • 1.1. Features
  • 1.2. Requirements
  • 1.3. Usage
  • 1.4. BlinkScript
  • 1.5. PySide2 Template Project
  • 1.6. Available Commands
  • 1.7. Extension Settings

1.1. Features

• Execute code inside Nuke from a machine in your local network.
  • Get the output of Nuke execution inside Visual Studio Code.
  • When used locally (same machine), the extension requires no configuration, but running NukeServerSocket inside Nuke.
  • Connect to a Nuke instance on a different computer in the same network.
  • BlinkScript support.
• Nuke Python Stubs for an auto-complete feature.
• Syntax color for .nk and .gizmo files.
• PySide2 plugin template.
• Commands for executing Nuke instances via the terminal with default or optional arguments.
  • Add environment variables to the running Nuke instance.

1.2. Requirements

This extension is primarily a companion for NukeServerSocket. Executing code will only work when NukeServerSocket is up and running.

1.3. Usage

To execute code:

1. Download and install the companion plugin NukeServerSocket:
   • Via the Command Palette: Nuke: Add NukeServerSocket (more info on Available Commands).
   • Github
   • Nukepedia
2. Connect NukeServerSocket inside Nuke.
3. With an active Python/BlinkScript file, use the command Nuke: Run Inside Nuke from the Command Palette or use the dedicated button in the editor's top right corner.

To use the Python stubs

1. Use the command Nuke: Add Python Stubs to add the stubs to your python.analysis.extraPaths setting.
2. Write import nuke into your script.

NOTE: Having a folder named nuke in your Workspace root-directory can cause problems for the suggestions.

1.4. BlinkScript

NOTE: BlinkScript features are available in a basic form. If you would like to see something more, feel free to make a request or open a PR. Also, check out Material Icon Theme that adds a Nuke icon for the .blink file.

• Features
  • Code execution.
  • Syntax highlighting.
  • Code formatting.
  • Simple code suggestion.
  • Startup saturation snippet.

The extension will create a blinkscript node named after the active file. If the node already exists, it will update the code and recompile it.

The accepted file extension code are .cpp or .blink.

1.5. PySide2 Template Project

You can create a quick pyside2 template project via the Nuke: Create a PySide2 plugin command. Once done, you can find the plugin inside ~/.nuke/NukeTools and ready to be used inside Nuke.

You can read more on the GitHub README of the project.

1.6. Available Commands

• All commands are available by opening the Command Palette (Command+Shift+P on macOS and Ctrl+Shift+P on Windows/Linux) and typing in one of the following Command Name:

NOTES:

• Nuke: Run Code Inside Nuke command can be executed via a button in the Editor Toolbar.

• Nuke: Add NukeServerSocket will copy the plugin folder inside $HOME/.nuke/NukeTools and create an import statement inside the menu.py file. If menu.py does not exist, it will get created.

• By default, the extension does not provide any shortcut. But you can assign each command to one. (see Key Bindings for Visual Studio Code for more information).

  Example keybindings.json:

  [
      {
          "key":"alt+shift+n",
          "command":"nuke-tools.launchNuke",
      },
      {
          "key":"alt+shift+r",
          "command":"nuke-tools.runCodeInsideNuke",
          "when": "editorTextFocus"
      }
  ]
  

1.7. Extension Settings

• nukeTools.nukeExecutable.primaryExecutablePath: string

  A path for an executable.

  • On macOS, you can find the file in Show Package Contents -> Contents/MacOS/Nuke...
  • On Windows WSL, the path should be in Unix style: /mnt/c/Program Files/...

• nukeTools.nukeExecutable.secondaryExecutablePath: string

  Same as primary executable. It could be a different Nuke version.

• nukeTools.nukeExecutable.options.defaultCommandLineArguments: string

  Command-line arguments you can add at each "Nuke launch" 🚀.

• nukeTools.nukeExecutable.options.restartInstance: boolean

  Restart the terminal instance instead of creating new ones. Use with caution. This option will terminate every Nuke process spawned by the extension. Useful when rapid testing GUI plugins that don't need saving the composition.

• nukeTools.other.clearPreviousOutput: boolean

  Clear the previous console output text.

• nukeTools.network.enableManualConnection: boolean

  If enabled, nukeTools.network.port and nukeTools.network.host will take over the default settings. You might need this option when connecting to another computer.

  • nukeTools.network.port: string

    Specify a different port for the connection. This option only works if nukeTools.network.enableManualConnection is active. The server address should be the same as in the Nuke plugin.

  • nukeTools.network.host: string

    Same as the port. The host could be the local host or the local IP.

• nukeTools.network.debug: boolean

  Show network debug information in the output window. Enabling this option will not clean the console output after code execution.

• nukeTools.other.envVars: {key: string: value: string}

  NOTE: Currently not working on Windows.

  Add environment variables the current running Nuke instance.

  {
    "nukeTools.other.envVars": {
      "NUKE_PATH":"/path/nuke/plugins:/path/nuke/ui",
      "API_KEY": "0a9f0381-aebb-4e40-a77a-2c381b08e0ea",
    }
  }
  

• nukeTools.pysideTemplate.pythonVersion: string

  Set a default Python version to use in pyproject.toml. You can use Poetry version-constraints specification.

  {
    "nukeTools.pysideTemplate.pythonVersion": "~3.7.7"
  }
  

• nukeTools.pysideTemplate.pysideVersion: string

  Set a default PySide2 version to use in pyproject.toml and requirements.txt.

  {
    "nukeTools.pysideTemplate.pysideVersion": "5.12.2"
  }