KnobScripter

KnobScripter v3.1 (or KS3) is a full script editor for Nuke that can script python on .py files and knobs as well as BlinkScript, with all the functionality from the default script editor in Nuke plus syntax helpers, predictions, snippets and other handy features.

KS3 is the next major step for this tool, and it features a greatly optimized code, Python 3 compatibility, BlinkScript mode, a Code Gallery and many other features and fixes.

 

GitHub download

 

 

 

KnobScripter was designed as a simple python script editor for Nuke, and its main goal is to let you interact with Nuke’s python API in a more pleasant way than Nuke’s default methods. It doesn’t intend to replace a fully featured IDE, but it proves enough for most common python tasks and quick work with snippets, basically anything that needs quick interaction with Nuke’s python console.

With this in mind, I focused its development in the aspects that I love about IDEs regarding efficiency (such as syntax helpers), in covering everything the default Script Editor in Nuke currently offers, and last but not least, in covering the python aspects of Nuke that are generally tedious, such as adding python or blink code to nodes/knobs.

 

 

---

Installation:

A. Fresh install

1. Copy the KnobScripter folder and paste it somewhere in your Nuke plugin path. For example, inside Users/YourUser/.nuke directory.
2. Open with a text editor the file menu.py that lives next to your KnobScripter folder, or create one if it doesn’t exist.
3. Add the following line:
   import KnobScripter
4. Restart Nuke.

B. Updating KnobScripter

1. Replace the KnobScripter folder with the updated one.
2. Restart Nuke.

 

---

Update Log:

KnobScripter v3.1 - 15 Jan 2024

New features:

1. Nuke 14 & 15 compatible.
2. Ctrl + +/- to change font size on both editor and output console.
3. Multi-line codes can be run on knobs as well (thanks pancho!)

Bug fixes and enhancements:

1. Fixed character movement error (thanks itaki!)
2. Removed python package ‘six’ (thanks itaki!)
3. Esc behaviour limited to floating panels only (thanks pancho!)
4. Other little bug fixes.

 

KnobScripter v3.0 - 25 April 2022

New features:

1. Blinkscript mode.
2. Compatible with python 2 and 3 (Nuke 13+) and Win/Mac/Lin.
3. Code Gallery.
4. Fully redesigned Snippets, with a new Snippet Editor, default snippets and a simplified workflow.
5. Preferences Panel redone, and new settings added.
6. Keyword Hotbox for double clicking on keywords and showing alternatives.
7. Storing the knob and .py editor state, for quickly jumping back to your edit point on new KnobScripters.
8. New code helpers such as Ctrl/Cmd + and Ctrl/Cmd - for changing font size.
9. Method placeholders.
10. Parentheses wrappers.

Bug fixes and enhancements:

1. Whole code refactored, and improved py import scheme.
2. Fixed predictor tab with custom words in Nuke 13.
3. Fixed backspace crash on indented lines.
4. Snippet behaviour improvements.
5. Fixed syntax highlighting errors.

 

KnobScripter v2.4 - 7 December 2020

New features:

1. Run in Context mode.
2. “Grab current dimensions” button.

Bug fixes and enhancements:

1. Improved modal window behavior (thanks Jed Smith!).
2. Ctrl+Backspace now clears output log.
3. Improved how Nuke’s Script Editor widgets are found (thanks Jed Smith!)
4. Modified (*) property now shows properly on the knob dropdown.
5. Picker (“change to Node”) crashing fixed.
6. Unicode encoding works with both .py scripts and nodes now.
7. Compatible with Nuke 12.2
8. Add snippet button scrolls to top.

 

KnobScripter v2.3 - 12 December 2019

Bug fixes and enhancements:

1. Fixed bracket and brace closing behaviour.
2. Added QStringListModel compatibility on Nuke 12.
3. Symlink error hidden on Windows.

KnobScripter v2.2 - 24 August 2019

Bug fixes and enhancements:

1. Variable placeholders error fixed (bug introduced on v2.1).
2. PySide import switch including Qt.

 

KnobScripter v2.1 - 10 August 2019

New features:

1. New Sublime color style. You can now choose between sublime or Nuke style in the Preferences.
2. Font selector in the Preferences, where you can set any available font.
3. Option to display the knob labels too (and not only names) on the knob dropdown.
4. Now accepting special characters (like accents or symbols) through utf-8 encoding.
5. New Snippets functionality: A snippet containing “hello $$world$$” will write “hello world” and the word “world” will be selected straightaway.
6. Auto-completer (when pressing tab) now also includes the functions, variables, classes etc live from the current script you’re writing.

Bug fixes and enhancements:

1. Python syntax highlighting improved.
2. Snippet editor now includes syntax highlighting.
3. Parenthesis/brackets auto-closing behavior improved when written inside each other.
4. Fixed error that prevented opening a new KnobScripter when a Blinkscript node properties were open too.
5. Tested on Windows OS (Nuke 11.3) and a few minor bugs fixed.
6. Improved auto-scroll to cursor behavior when duplicating, moving or unindenting lines.

 

I hope KS3 will help improve your scripting experience! Bugs and suggestions always appreciated :)

Copyright (c) 2016-2023, Adrian Pueyo
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Credit goes to Wouter Gilsing for the script editor widget part, which he made for his tool W_Hotbox.
It can be downloaded here: http://www.nukepedia.com/python/ui/w_hotbox