cragl vfx tools | Nuke Python Tools and Plugins | smartLib


smartLib

Project and shot management for Nuke. Whether you work alone or in a team, you'll love it smartLib

The project and shot managemet system – you will love it.

smartLib is a project and shot management system for NUKE. Do you find yourself oftten switching between several shots and projects? Then you will love this tool.


Keep track of all your work and collaborate

You can set shot status and write comments for each shot and thus keep track of your work. Everybody using smartLib in your company will also see each shot status and comments which makes collaborating among artists simple and fast.


Create shot templates and setup render directories

smartLib lets you create fully customizable shot templates to create new shots with the folder structure you need. Besides you don't need to set up render locations manually anymore.


FAQ

Do you have any question about smartLib? make sure to read our tools specific faq for smartLib.

Features

• Project and shot manager for NUKE
• Keep track off all your shots
• Easily navigate between multiple projects and shots
• Per shot todo list and status view
• Export all of your project details as pdf
• Create new shots by shot templates
• Automatically set up render locations

where to buy

download trial

Please use our free tool connect to download your smartLib trial.
 01.jpg  02.jpg  03.jpg  04.jpg  05.jpg  06.jpg  07.jpg  08.jpg  09.jpg  10.jpg  11.jpg  12.jpg  13.jpg  14.jpg  15.jpg




1) Instal smartLib

Like any other cragl product, smartLib can be installed with cragl connect directly inside NUKE.
Open connect and drag smartLib to the right to reveal more information. Just click on "buy" and you will be located to the web page where you can purchase smartLib. After purchasing you will receive a mail including an instal code. Now simply click on install, enter your received instal code and smartLib will be installed automatically on your machine.

2) Access smartLib

After the installation is finished you now find the new sub menu "smartLib" inside your cragl menu. It contains four commands: "open smartLib", "set preview image from current node", "settings" and "about". open smartLib: opens the smartLib window. The shortcut is the comma key.
set preview image from current node: sets the shot's thumbnail from the selected node. Further information: 3.4.4) Setting a shot thumbnail.
settings: opens the settings window
about: opens the smartLib about window

3) Working with smartLib

To open smartLib you can access it with NUKE's menubar via "cragl->smartLib->open smartLib". The shortcut is the comma key.
The smartLib main window is split into several sections: 1) The navigation
2) The system
3) the project bookmarks
4) the current project
5) the current shot

To navigate between different projects and shots you work from left to right. Let's have a closer look on all sections.

3.1) System and project bookmarks

In the system you will find your systems folder structure. This is the same structure that you see in your explorer. To navigate inside a folder just double click it. So here you can browse your system and navigate to your project folder. If you need you can right click the system section and refresh the current folder.

The system section contains a right click menu with three options:
1) refresh: refreshes the system section
2) reveal in finder: reveal the selected directory in your explorer
3) new folder: function to create a new folder. Will pop up a dialog to enter a folder name
You can use the system section to navigate to the folder that includes all your shots. You can then drag the folder including all your shots to the middle section which represents the project view.

When you have navigated to a project you can bookmark a specific project in the project bookmark section below the system section. Just drag the folder you like to bookmark to the project section below. If you need you can set a name in the upcoming window. smartLib works by opening the folders that include all shots: To open a project simply drag the folder that includes all shots from the system section or from the project bookmark section to the middle section which is the project view. Just keep in mind to drag the folder inside the project section that includes all your nuke shots.

3.2) Navigation

1) At the top you find the path that you have browsed to in your system section. You can jump to previous folders directly in here by just clicking inside the url.
2) With this button you can jump one folder up in the hierarchy.
3) This button navigates you to your user home directory.
4) Here you can set bookmarks to quickly switch between different locations on your system. For further information see 3.2.1) Working with bookmarks

To enlarge the sections you find two buttons at the top right:
5) Press this button to toggle the visibility of the system section
6) Press this button to toggle the visibility of the current shot.

3.2.1) Navigating manually

You can set a url manually by right clicking the current url. This will show an input displaying the current location. You can paste a copied path or type in the url that you like to switch to manually.

3.2.2) Working with bookmarks

You can set bookmarks to quicker jump to different locations in your system section. To bookmark your current location just choose "add bookmark" from the bookmark dropdown list. The current path will then be appended to the bookmark list. To delete a bookmark, simply select a bookmark to jump to the location and then choose "delete bookmark" from the dropdown.

3.3) The project view

As soon as you have dragged the folder into the project view that contains all shots of your project you will see all your shots in the list. 1) At the top you find the name of the project.
2) In the middle you find all shots sorted by name. Each shot is arranged in a row, containing a shot thumbnail, the shot name, the shot's status and a comment section.
3) At the bottom you find an input field to search a shot from the project list by name.

3.3.1) The project view right click menu

The project view contains a right click menu with several commands:

"clear": Clear the current project view
"refresh": Refresh the current project view
"open current project in finder": Reveal the current project in the finder/ explorer
"open in separate window": Open the selected shot in a separate window.
"create project report": export a pdf of the current project containing an overview of all shots. For further information see 5) Creating project reports
"display by status": Display all shots by status. For further information see 3.3.3) search shots by status.
"create new shot": Create new shot in the current project. For further information see 3.5) Creating new shots

3.3.2) Search shots by name

You can search shots in the project view by name. the list will then only show the shots that contain the character that are entered. In this example we search for all shots that contain the number "2" in their name. The result is "SH020" and "SH120".

3.3.3) Search shots by status

You can search shots in the project view status. For instance, to see all shots of the project that haven't been started working on right click the project view and choose "display by status->not started".

3.4) Shot section

To enter a shot in the shot section simply drag and drop a shot from the project section into the shot section. The shot section contains several elements:

1) The shot name
2) The shot's status (red: "not started", yellow: "in progress", green: "done")
3) Toggle show/ hide comments section at the bottom
4) Shot thumbnail
5) Nukescripts list of the current shot
6) Shot's folder and file structure
7) Comments section

3.4.1) Set shot status

To set the shot's status simply click the shots status button. There are three status types:

red: "not started"
yellow: "in progress"
green: "done"

The shot's status will be also updated in the project view.

3.4.2) Writing shot comments

You can use the shot's comment section to write down some comments. If the comment section is hidden click the comments toggle at the top right of the shot.
As soon as you leave the comment section the comment will also be shown in the project view. All user using smartLib in your team can see the comments.

3.4.3) Shot thumbnail right click menu

The shot thumbnail contains a right click menu with these options:
1) clear: This clears the shot being shown in the shots sections
2) refresh: Refresh the shot section including the thumbnail as well as the folder and file hirarchy
3) reveal shot in finder: displays the shot in your explorer/ finder
4) set preview image: browse an image to set as the shot's thumbnail. See 3.4.4) Setting a shot thumbnail

3.4.4) Setting a shot thumbnail

Shot thumbnails help you with faster navigating in the project view. The thumbnail is displayed in the shot thumbnail section as well as in the project view for each shot. To set a shot thumbnail you can use one of these methods:

1) Right click the thumbnail image and choose "set preview image". You can then browse your system and set it manually.
2) You can also set a thumbnail directly inside your current shot that you are working in. Simply select the node from which you like to create a thumbnail from. This can be any node you like. After it has been selected navigate to "cragl->smartLib->set preview image from current node". The shortcut is holding Shift Alt or Option and pressing P.

3.4.5) The folder and file structure

The shot view contains the folder and file structure as you see it in your explorer. This section contains a right click menu which offers you several options to edit your hierarchy directly inside smartLib:
1) reveal in finder: Reveal the selected item in your explorer/ finder.
2) insert in dag: Insert the selected item in your node graoh. Works with footage and nuke scripts.
3) cut: Cut the selected item(s)
4) copy: Copy the selected item(s)
5) paste: Paste the selected item(s)
6) rename: Rename the selected item
7) new nukesript: Create a blank nukescript at the selected location.
8) render directory: Set and unset a render directory.
8) footage directory: Set and unset a footage directory.
9) new directory: Create new directory/ directories
10) delete: Delete the selected item(s)

3.4.5.1) Creating a directory or several directories in one go

To create a new directory right click the hierarchy and choose "new directory". A dialog shows up in which you can type in the name of the new directory.
Instead of creating several directories one by one you can create them in one go. In the dialog you need to separate them by a comma. By hitting the "ok" button all directories will be created in one go.

3.4.5.2) Setting a render directory

You can use the hierarchy to set up a render directory. Whenever you create a write node in your shot then the render path inside the write node will be automatically set up so you don't need to set a path manually. To set a render directory select a folder from the hierarchy, right click and choose "render directory->set as render directory". The folder icon changes to a small yellow circle with a "w" in it which indicates a render directory. To unset a render directory you can right click it and choose "render directory->unset as render directory". By the way: When it comes to rendering smartLib will always check if the render directory exists and if it doesn't then smartLib will create it automatically for you.

3.4.5.3) Setting a custom render directory

Besides setting a render directory inside the current shot or the shot template you can now also set the render directory outside of the shot. To do so right click the hierarchy and choose "render directory->set custom render directory". A window will show up in which you can either browse to the desired path or enter it manually. When the path is set simply click the "save" button. The render directory is now successfully set up outside the current shot. Whenever you create a write node in that nukescript the renderpath will be set up automatically and point to that set render path. The path can always be changed the same way described above.

Please note: Setting a custom render directory outside the current shot works also for shot templates. In smartLib's settings section navigate to the shot templates section and set up a custom render path the same way as described above. Whenever you create a new shot from that template then the custom renderpath will take place setting up the write node automatically to point to that set path.

3.4.5.4) Setting a footage directory

Besides setting a render directory in- and outside your current shot smartLib offers the same functionality for your footage. By setting a custom footage directory this will always start your browser in the set footage directory. To import footage into your nuke script navigate to your menu bar and choose 'cragl->smartLib->import from footage directory' or use the hotkey alt+shift+R.

3.4.5.5) Getting assets into the nodegraph

You can drag footage from smartLib directly inside your dag. If you drag a nuke script into your dag all nodes of that selected nukescripts are appended to your current nukescript. To insert a footage or a nuke script into your nodegraph you can also right click an item in your shot right click menu and choose 'insert in dag'.

3.5) Creating new shots

smartLib offers you three different options to create a new shot in a project. Right click your project view and choose "create new shot" at the bottom of the list. You have three options: 1) empty shot: Create a blank shot with no direcotories and no files in it.
2) from existing shot folder structure: Create a new shot and copy the folder structure from another one.
3) from shot template: Create a shot from a shot template

Each option is described in the following.

3.5.1) Creating a new empty shot

To create a new shot with no additional folders and files right click the project view and choose "create new shot->empty shot". A dialog shows up in which you can name your new shot. A new shot will be created inside the current project.
One tip:To create multiple shots in one go you can enter multiple shot names separated by comma.

3.5.2) Creating a new shot from existing shot folder structure

You can create a new shot based on the hierarchical structure of another existing shot of your current project. This way you can use an already exisitng folder structure and don't need to create it manually again.
Right click the project view and choose "create new shot->from existing shot folder structure". A dialog shows up in which you can name your new shot and choose a shot from the project that you like to copy the folder hierarchy from. Click on "set". The dialog will enlarge and show more options to create a new nukescript with the new shot. You can enter the name and the location of the new nukescript. Finally click on "create new shot". A new shot will be created inside the current project containing the hierarchical structure of the chosen shot.
One tip:To create multiple shots in one go you can enter multiple shot names separated by comma.

3.5.3) Setting up a new shot based on a shot template

A third way of creating a new shot is by creating it by a shot template. You can create a template and use it later to create a new shot which will then contain the chosen folder structure. To do so you need to create a shot template first.
One tip:To create multiple shots in one go you can enter multiple shot names separated by comma.

3.5.4) Working with shot templates

The following describes how to create shot templates inside smartLib's settings.
The directory structure that you create will be created as a folder structure in this place:

Linux: /home/[username]/cragl/smartLib/shot_templates
Mac: /Users/[username]/cragl/smartLib/shot_templates
Windows: C:\Users\[username]\cragl/smartLib\shot_templates

Keep in mind that you can also edit the folder structure directly in your explorer in order to edit your shot templates.

Open the settings via "cragl->smartLib->settings". In here switch to the third tab "shot templates". In this tab you can manage all of your shot templates.
1) Dropdown to choose a shot template
2) Delete the current shot template
3) New shot template
4) Folder hierarchy of current shot template

The following shows an example of creating a "comp" shot template.

To create a new template click on the "new" button and enter a name for the new template. Let's for instance call it "comp". After creating it the shot template is automatically selected in the shot template dropdown list. You can use the dropdown to switch between different shot templates. You can see its folder hierarchy in the hierarchy section. Let's start populating the shot template. Right click the shot root folder and choose "new directory". In the upcoming window choose a name for the new folder. You can also create several folders in one go. Simply enter the folder names separated by a comma . In this example let's create folders for:

scripts: All nukescripts go in here
trk: Tracking data from other programs go in here
render: Render pictures go in here
assets: All assets for the current shot go in here
roto: Roto nukescripts go in here
prep: Prep nukescripts go in here
intermediate: prerenderings go in here

To create all folder in one go simply separate them by a comma. If required you can also create subdirectories.

You can also create a template nukescript in your template shot. Let's select the "scripts" folder and choose "new nukescript". In the upcoming window choose a name for the nukescript. To keep the shot name variable and stick to the shot name you can use the keyword "{shot}". By using the keyword the nukescript will be named after the shot that we will create in the future. So let's call it "{shot}_comp_V001.nk". If required you can also create template nukescripts for the "roto" and for the "prep" folder. Finally let's also set the render directory. So selet the render folder, right click and choose "render directory->set as render directory".
The finished shot template should now look like the one below. Feel free to choose and create an own shot template with a different folder structure. You can create as many templates as you like. Use the dropdown list at the top to switch between different templates. You can then always come back and change the folder structure.

3.5.5) Customizing a Nuke script's format

You can customize a a nuke script in your template menu (settings window), while creating a new shot from a template and in the shot section.
To edit a nuke script right click it's item and choose 'edit format': A window will show up in which you can edit the selected nuke script'S format. When you are done editing the format click the 'set format' button.

3.5.6) creating a new shot based on a shot template

To create a new shot based on a shot template you need to create a shot template first. If you haven't already done so please see 3.5.3) Setting up a new shot based on a shot template. Right click the project view and choose "create new shot->from shot template". In the upcoming window choose a name for the new shot. Then choose a template that the new shot will be based on. After choosing a template you will see the folder hierarchy at the bottom to make sure that you choose the right template. Finally click the "create shot" button at the bottom right. The new shot will be created using the chosen shot template. The name of the nukescript was also formed based on the shot name. Instead of creating just one shot from a shot template you can also create multiple ones in one go. Simply enter multiple shot names separated by comma.

3.5.7) creating multiple shots based on a shot template

You can create multiple shots based on a shot template in one go. All shots will then use the chosen shot template folder structure.

The following shows an example of creating twenty shots ("SH10" to "SH200") in a blank project in one go.

Let's select a blank project, right click in the project view and choose "new shot->from shot template". To switch to the multiple shot view click the "single shot" button to the top right. The window layout changes, revealing the inputs for batch creating multiple shots. Let's type in the necessary values. The shot name will be "SH", starting at "10", ending at "200" by an increment of "10". This will create the 20 shots "SH10" to "SH200". Let's choose our "comp" template. By clicking the "create shots" button at the bottom right all 20 shots will be batch created containing the hierarchy of the chosen "comp" shot template. And by having used the "{shot}" keyword in the template all nukescripts will carry the right shot name.

4) smartLib settings

In the settings you can customize smartLib to your needs. To access the settings navigate to cragl->smartLib->settings The settings window is divided into three sections: "General", "Render", "Shot Templates"

4.1) settings - General

1) tooltips: If this checkbox is enabled show tooltips for all major elements. Otherwise hide tooltips.
2) pin smartLib window: If this checkbox is enabled then the smartLib main window will always stay on top of all windows. Uncheck to disable this functionality.
3) collapse_image_sequences: Check to enable collapsed image sequences preview in smartLib shot section.
An example: The image sequence will be displayed like file_[1-10].jpg if this checkbox is checked. If it is unchecked it will display single files like file_1.jpg, file_2.jpg, file_3.jpg, etc.
4) shot section: enable drag functionality: If this checkbox is checked the drag functionality in the current shot section tree view is enabled. To prevent unwanted dragging and copying of files uncheck it and use the 'insert in dag' functionality to perform the same action.
5) show hidden files: If this checkbox is checked show hidden files that start with a '.' in the current shot tree view.
6) force create render directory: If this checkbox is checked smartLib will create the render directory of a given write node's file path if it doesn't exist.
7) reset xml settings: Click to reset all smartLib settings to their default settings.
8) shot thumbnail gamma: Set the shot thumbnail gamma. Increase to lighten dark images, decrease to darken light images.
9) user: Here you can set the user for this workstation. Whenever you open a shot the set user will be displayed in the smartLib main window. Using this feature becomes useful as all artists can see who is working on which shot at a given time. The current user of a shot can also be set and unset manually.
If the user input is empty no user will be set when opening a shot.
10) ignore nuke scripts in dropdown: ignore all nukescripts in smartLib's current shot's dropdown menu that contain one of the following characters. This is to prevent displaying backup- and annotation nuke scripts in the dropdown. You can enter multiple elements to ignore in here by separating them by comma. 11) default formats: When creating a new shot inside a shot template, via a shot template or via the right click menu of your current shot the new nuke script takes the format settings that are set in here. You can set the full size format (width and height), pixel aspect ratio and fps for your nuke script.

4.2) settings - Status/Report

The Status/Report tab lets you create a default export path for your project reports (to export a project report please see 5) Creating project reports) as well as custom status for your project. By default smartLib creates the default status "not started", "in progress" and "done". But you can edit, delete and create custom status if you need to.

Please note: If you work in a team it is recommended that all artists in your team use the same status.

1) custom project report path: You can set a custom default project export. Whenever you create a project report (see 5) Creating project reports) the export browser will point to this location by at first. By default this input is empty which will let your export browser start at the default location which is your Desktop located at: /Users/[username]/Desktop
2) custom status: Here you can create and edit custom status if you need more than the default status "not started", "in progress" and "done"
3) status overview: This is a list of all your status
4) edit status: click to edit the selected status. This will pop up the "edit status" window. Please see 4.2.1) editing status
5) delete status: click to delete the selected status.
6) create new status: click to create a new custom status. This will pop up the "new status" window. Please see 4.2.2) creating new custom status

4.2.1) editing status

To edit an existing status please navigate to the "Status/Report" tab and push the "edit" button for the according status that you want to edit. This will pop up the "edit status" window: 1) status name: here you can change the name of the status
1) default: By activating this checkbox all shots that haven't been given a status will get this status. By default the "default" checkbox is checked at the status "not started" so all new shots and shots that haven't been assigned to any status will get the "not started" status. Please note: There can be only one default status so if you check this checkbox the previous default status will be no longer a default status.
1) status color: here you can change the color of the status
When you are done editing the status click the blue "update status" button.

4.2.2) creating new custom status

By default smartLib creates three default status "not started", "in progress" and "done". However you can create your own custom status and fit them to your needs. To create custom status please navigate to the "Status/Report" tab and push the "create new status" button. This will pop up the "create new shot status" window which looks the same as the "edit status" window: 1) status name: here you can set the name of the status
1) default: By activating this checkbox all shots that haven't been given a status will get this status. By default the "default" checkbox is checked at the status "not started" so all new shots and shots that haven't been assigned to any status will get the "not started" status. Please note: There can be only one default status so if you check this checkbox the previous default status will be no longer a default status.
1) status color: here you can set the color of the status
Finally click the blue "create new status" button.

4.3) settings - Render

These settings apply to a write node as soon as you have set up a render location for the shot. To set a render location please refer to 3.4.5) The folder and file structure.
1) When you create a write node it will have this file extension already set up.
2) When you create a write node it will have this frame padding already set up

4.4) settings - Shot templates

The shot templates section has already been discussed. Please refer to 3.5.4) Working with shot templates.

5) creating project reports

You can export your current project status to a pdf and send it to your producer and your artists. The pdf shows an overview of the work that has been done and shows all shots including status and notes of the current time. To export your current project status open smartLib, set your project that you like to export to the current project in the middle project section. Right click the current project section and choose "create project report". A browser pops up which lets you choose where to save the pdf to. By default the browser points to the desktop. You can set a custom starting point in the settings in the "custom project report path" under "Status/Report". Please see 4.2) settings - Status/Report After exporting the project report pdf looks something like this: At the top you will find some information like: The project name, the generation date and time, the project's path and the number of shots included in this project. Below you will find a graph that shows you a percentage overview of the status. Underneath You will find a list of all shots including shot name, shot thumbnail, status and comments

FAQ for smartLib

Here you will find some frequently asked questions on smartLib. Please make sure to read them first. Please also have a look on the documentation. If you have any question that is not listed in here please don't hesitate to contact us. We are pleased to help you.



How do I install smartLib?

Each cragl tool can be installed via cragl connect - our free tool to install and manage all of your cragl tools directly inside NUKE. If you haven't already done so please download connect.
By opening connect you will see a list of all cragl tools. You can drag and drop it to the right hand side of the connect window to reveal more infos. Just click on "buy". After purchasing you will receive an install code for your tool. Now simply click "install now" and enter the received install code. The tool will be downloaded and installed automatically for you. So you don't need to struggle with any install issue.

Versions

Here you will find an overview of the smartLib's versions and its improvements. Please log in to download versions.



smartLib v3.0

• user setting to set the user for the currently opened shot
• setting default formats for nuke scripts
• changing the format of a nuke script on the fly (shot template creation, tree hierarchy current shot, creating new shots from template)
• pin/ unpin smartLib main window to stay always on top or not
• ignore nuke script in shot dropdown(e.g. backup- and annotation scripts)
• delete preview shot image
• inline tooltips on all major widgets and elements (smartLib main window and settings)
• overall code improvement, stability and speed ups


smartLib v2.3

• system folder - ability to create a new folder
• default shot template for project - as soon as you create a new shot from a shot template the selected template will be stored for this project. So if you create another one the selected template from the template list will be the template the you used the last time.
• bulk shot creation from template - all three shot creation methods (empty shot, from existing shot folder structure, from shot template) include now the ability to create multiple shots in one go. In the name input simply enter multiple shot names separated by comma.
• source footage default folder - In the current shot section right click one of your folders and choose "footage direcotry->set footage directory". Now you can directly browse to the folder by navigating to cragl->smartLib->import from footage directory. This can be set per shot or you can also set a default footage directory in your shot template to enable this feature for each shot. In the right click menu you can also choose a global folder outside the shot itself so this will then always direct you to that folder.
• global gamma slider for shot thumbnails - in the settings window in the general section there is a new slider for setting the gamma when creating shot thumbnails.
• collapse image sequences - In cragl->smartLib->settings in the general tab you can find the option "collapse image sequences". This collapses image sequences in the current shot section and displays a sequence in this format - sequenceName.[1001-1100].exr. If you need to copy, cut and paste items you need to uncheck the collapse image sequences option in smartLib's settings window.
• insert into dag - in the currentShot section right click a file, image sequence or nukescript and choose "insert in dag". This will insert the selected item into your node graph.
• insert shot notes - choose cragl->smartLib->insert shot notes. This creates a sticky note and pastes all notes for this shot into it.
• all items get sorted alphabetically. This is now the default method.
• improved file selection behaviour in shot lib section. This behaves now exactly the same way as selecting files in your explorer.


smartLib v2.2

• double clicking the saved projects opens the currently clicked project in the project view
• fixed bug that caused problem when setting the thumbnail image in windows 10
• custom status color - color picker now in edit window
• functionality to set the padding delimiter to an underscore or to a fullstop


smartLib v2.1

• added functionality to set render path for a shot outside the shot folder. Works also for whole shot templates (Please refer to to the smartLib documentation at 3.4.5.3) Setting a custom render directory).
• Fixed Bug that caused errors in creating shot thumbnails in windows


smartLib v2.0

• code optimization
• added Status/Report Tab in Settings (see documentation 4.2)
• added functionality to create custom shot status (see documentation 4.2.1, 4.2.2)
• added functionality to export the current project with all thumbnails, status and comments (see documentation 5)
• added shortcut to system section. Pressing enter will now enter the currently selected folder
• added shortcut to system section. Pressing the backspace key will now leave the current folder and navigate to the parent folder
• added reveal in finder functionality to right click menu in system section
• fixed bug that caused the status to be redrawn to the previuos status in the current project section if a shot note is written
• fixed bug that caused problems with loading a project that had non well formed metaxml files


smartLib v1.0

initial release