Skip to content

This tool checks the versions of your Read nodes, coloring them Green (if they are updated), Orange (if they are out of date), Red (if they don’t exist), and Blue (if they come from your Assets Library).

Notifications You must be signed in to change notification settings

danilodelucio/ReadChecker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ReadChecker_Logo_v001 LQ

Introduction 📓

This tool checks the versions of your Read nodes, coloring them to:

  • Green: if they are updated;
  • Orange: if they are out of date;
  • Red: if they don’t exist;
  • Blue: if they come from your Assets Library;

Nodes color preview

This is helpful to check visually if the Read nodes are updated or not in your Node Graph.

Screenshot 2023-07-14 080128


Version Pattern ✅

The validation starts by looking for a version pattern in the file path of a Read node. This pattern is created using Regular Expression, so that any type of versioning (of the most used in the industry) is recognized. If the version captured doesn't match the pattern, the node will remain the default color.

image


Folders/Files validation 📁📄

Some examples of folders and files validation, if the version pattern is found:

  • File name: 2023-07-14 08_56_10-test - ReadChecker - Visual Studio Code

  • Previous folder: 2023-07-14 09_00_47-test - ReadChecker - Visual Studio Code

  • Previous folder + File name 2023-07-14 09_07_56-test - ReadChecker - Visual Studio Code

  • Different folder + File name: 2023-07-14 09_26_33-test - ReadChecker - Visual Studio Code

Warning

Regardless of the file extension or if the folder is empty, ReadChecker will validate the version pattern found in the file path only.


Assets Library path 🔍

To set the color for the Assets Library, open the ReadChecker Settings panel and update the Assets Path.

image

Note

ReadChecker will not validate the versions for the Read nodes that contain the Assets Path, they will be only set to BLUE color.


Nuke and Python compatibility ☢️🐍

ReadChecker was written in Python 2.7.16 and 3.10.5, so it's designed to work with all versions of Nuke.


Performance 📊

By default, this tool utilizes the updateUI() callback, which means that all Read nodes will be validated after any changes to the script. Don't worry about performance issues, this callback is designed to run as a low-priority process. Additionally, it uses the OnScriptLoad() and OnScriptSave() callbacks to validate all Read nodes just once when the Nuke script is opened/saved.

If you prefer to not use the callbacks, you can run the tool whenever you want by using the Validate now button.

Screenshot 2023-08-12 015704

You can also turn on/off the callbacks by the ReadChecker Settings panel:

image

Important

For now, the RED color for nodes with Error doesn’t work using the UpdateUI function.
For more information about callbacks, please visit the NUKE Python Developer’s Guide page.


Troubleshooting 🛠️

If you have feedback, suggestions, or feature requests, please visit the Discussions page and create a New Discussion.
For bugs, please go to the Issues page and create a New Issue.


Installation ⚙️

  • Paste the ReadChecker folder into your main .nuke directory (usually inside ~/user/.nuke);
  • Add nuke.pluginAddPath('./ReadChecker') into your init.py (if you don’t have one, you can create it);
  • Enjoy! 😍

image

image

License📝

  • You are free to use this tool for both non-commercial and commercial purposes (it's completely free!);
  • You cannot claim to be the original author of this tool or sell it as your own product;

Special Thanks🙏

Special thanks to Henrique Reginato, Magno Borgo, and Gustavo Goncalves for testing this tool and providing valuable feedback for improvement. Also, thanks to Juliana Chen for her support and encouragement.


Supporters 💪

  • Dario Spinelli;

Support me! 🥺

image

If you find this tool useful, please consider supporting me on Buy Me A Coffee. ☕

If you donate any amount, please mention this tool (also your preference name if you want to), so your name will appear in the Supporters list above.

You can also share this tool or send me a positive message, it would help me in the same way.

Cheers! 🥂

About

This tool checks the versions of your Read nodes, coloring them Green (if they are updated), Orange (if they are out of date), Red (if they don’t exist), and Blue (if they come from your Assets Library).

Resources

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Languages