A bunch of Nuke related tools that will help the development process in Visual Studio Code.
This is primarily a companion extension for: NukeServerSocket. Some features will only work when the server inside Nuke is active.
1.1. Features
- Execute code inside Nuke from a machine in your local network.
- Get output of Nuke execution inside Visual Studio Code.
- When used locally (same machine) no configuration is required, just running the server inside Nuke.
- Specify a custom address when connection is from/to another computer.
- Multiple computer can connect to the same Nuke instance.
- BlinkScript support.
- Easy commands for launching Nuke instances via the terminal with default or optional arguments.
- Included Nuke Python Stubs to be added to
python.analysis.extraPaths for a simple auto complete feature.
1.2. Nuke Python Stubs
The stubs are pre-generated and you can check more about the github project here.
Nuke Tools now includes python stubs for Nuke.
For the most part, stubs files will have the type annotation declared. This will allow vscode to infer the type of the variable. Some of them are wrong or missing but you can read more about that in the git repo.
The command Add Python Stubs will add the stubs path to your workspace python.analysis.extraPaths settings.
Then is simple as: import nuke
If you have a package named nuke in your workspace root, it will not work, as python will import that one first.
~~The extension will automatically create the settings python.analysis.extraPaths in every directory with a python file and append the stubs path to it (together with all of your global python.analysis.extraPaths settings)
Alternatively you could disable the settings Auto Add Stubs Path and use the command Add Python Stubs to manually add them to the workspace settings.~~
Note: Auto Add Stubs Path is now deprecated and it will be removed in the future versions.
1.2.1. Other ways to add the stubs
The stubs can be found inside the extension folder: $HOME/.vscode/extensions/virgilsisoe.nuke-tools/Nuke-Python-Stubs/nuke_stubs.
There are a few ways to add them:
- Add the path to the global settings
python.analysis.extraPath. Keep in mind that, if you need a custom settings in your workspace, the workspace settings will override the global one so you need to re add the stubs path to your workspace settings.
- Add the path to the global setting:
python.analysis.stubPath. Because this setting is a simple string, only one path can be specified at the time, so if you are using it for something else, you need to move the stubs folder into that location.
Although you could generate the stubs from the git repo, using the ones included with the extension, ensures that futures updates to the stubs will be automatically picked from Nuke Tools.
1.3. BlinkScript
NukeServerSocket >= 0.1.0 is needed in order for this to work.
You can execute code from the text editor directly inside a Nuke BlinkScript node.
The extension will take the name of the current active file and create a blinkscript node inside Nuke with the name as the current filename. If the node already exists then will only modified its source code. Once done will recompile the source kernel.
The accepted file extension are .cpp or .blink.
There used to be an extension on the marketplace for the blink language syntax but it appears to have been taken down. If you want to use a .blink file, you could set the language id to C++ in order to have the syntax colored. Also the extension Material Icon Theme offers a nice Nuke icon for the .blink files.
1.4. 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:
| Command Name |
Command ID |
Description |
Nuke: Launch main executable |
nuke-tools.launchNuke |
Launch main executable |
Nuke: Launch alternative executable |
nuke-tools.launchNukeAlt |
Launch alternative executable |
Nuke: Launch main executable with prompt |
nuke-tools.launchNukeOptArgs |
Launch main exec. with prompt for optional args |
Nuke: Run Inside Nuke |
nuke-tools.runCodeInsideNuke |
Execute code inside nuke |
Nuke: Show Network Addresses |
nuke-tools.showNetworkAddresses |
Show network addresses |
Nuke: Add Stubs to Workspace |
nuke-tools.addPythonStubs |
Add stubs path to workspace settings |
Nuke: Debug Message |
nuke-tools.testRunInsideNuke |
Quick test connection |
By default the extension does not provide any shortcut, but every command can be assigned to one. (see Key Bindings for Visual Studio Code for more information)
Example json
[
{
"key":"alt+shift+n",
"command":"nuke-tools.launchNuke",
},
{
"key":"alt+shift+r",
"command":"nuke-tools.runCodeInsideNuke",
"when": "editorTextFocus"
}
]
Nuke: Run Code Inside Nuke can be access also via a button in the Editor Toolbar.
1.5. Extension Settings
Primary path for the Nuke executable.
- On MacOS you can find the file with: Show Package Contents -> Contents/MacOS/Nuke...
- On Windows WSL the path should be the Unix style: /mnt/c/Program Files/...
Same as primary executable. Could be a different Nuke version.
Command line arguments to be added at each "Nuke launch" 🚀.
Restart the terminal instance instead of creating new ones. Use with caution as this option will terminate every Nuke process created by the extension. Useful when rapid testing GUI plugins and don't need to save the Nuke comp.
Clear previous console output before next code execution.
If enabled, nukeTools.network.port and nukeTools.network.host will take over the default settings. Needed when connecting to another computer.
Specify a different port for the connection. This will only work if nukeTools.network.enableManualConnection is enabled. Server address should be taken from the Nuke plugin.
Same as nukeTools.network.port. Host could be the localhost or the local ip.
Show network debug information in the output window. Enabling this option, will prevent the console from being cleared after code execution.
1.6. NukeServerSocket
Download companion plugin: Git, Nukepedia.
1.7. Overview
Code execution.
Python stubs auto-complete
