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. Available Commands
  • 1.6. 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, just a running server inside Nuke.
  • Specify a custom address when the connection is from/to another computer.
  • BlinkScript support.
• Nuke Python Stubs for an auto-complete feature.
• Syntax color for .nk and .gizmo files.
• Commands for executing Nuke instances via the terminal with default or optional arguments.
  • Inject paths to NUKE_PATH only for current Nuke session.

1.2. Requirements

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

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.

• Execute BlinkScript

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

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

1.5. 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:

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

  • The button can be disabled in the settings.

• Nuke: Add NukeServerSocket will copy the plugin folder inside $HOME/.nuke and append an import statement inside the menu.py file: import NukeServerSocket. 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.6. 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 to be added 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.other.showToolbarButton: boolean

  Show the execute code button in the editor toolbar.

• nukeTools.network.enableManualConnection: boolean

  If enabled, nukeTools.network.port and nukeTools.network.host will take over the default settings. This option is needed when connecting to another computer.

  • nukeTools.network.port: string

    Specify a different port for the connection. This option will only work if nukeTools.network.enableManualConnection is enabled. 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 prevent the console from being cleared after code execution.

• nukeTools.other.nukePaths: array<string>

  NOTE: Currently not working on Windows.

  Add new paths to your NUKE_PATH for the current Nuke session. The paths will be available only when launching Nuke with the extension command.

  TIP: You can add new paths only for the current workspace.

  {
    "nukeTools.other.nukePaths": [
      "/Users/virgil/Developer/Nuke/plugins"
    ]
  }