A plugin to be used with version 2 of Prism Pipeline
Prism automates and simplifies the workflow of animation and VFX projects.
You can find more information on the website:
The ResolveShortcuts plugin adds the ability to save a shortcut to a project located in Davinci Resolve's internal database. The shortcut file will be saved in the scenefiles alongside other versioned scenefiles. This allows the abilty to directly open the project (and timeline if it exists) from Prism's Project Browser mimicking other DCC scenefiles without having to start Resolve, and navigate its Project Manager to find the project.
The shortcut file is just a small Python script that contains the "path" to the project (and timeline) that will start Resolve and open the project.
A shortcut can be saved into Prism by opening the Prism Project Browser from the Resolve Prism tool, and right clicking. This opens the default Prism menu, with the added item "Save Shortcut to Resolve Project".
- Tested working up to Resolve 20 and Prism 2.1.0 (Python 3.13).
- Resolve Studio (paid version) must be used for this plugin to function. This is due to scripting being a Studio version feature.
- Two things need to be enabled for the plugin to function: the "Enabled" checkbox and the environment variable set.
- This does not handle versioning as would be normal for scenefiles. The shortcut just points to the project (and timeline) in Resolve. A user can use a workflow where different timeline versions are saved as different shortcuts which will mimic "normal" versioning.
- The shortcut files are small Python script files with the extension ".resolveShortcut" and thus the system's security preferences must allow .py scripts to run.
- The plugin will attempt to set the required filepaths during first run of the plugin. This assumes that Resolve is installed in the default location. If the plugin is moved on the system or Resolve is not installed into the default location, the correct filepaths must be set in the settings. The plugin directory must be named "ResolveShortcuts".
- Note: if a project was created with a previous version of Resolve, opening the Project Shortcut with a newer Resolve version will silently upgrade the project (as opposed to showing a UI popup asking to upgrade)
- It seems that Resolve's API to change databases is not working correctly. So if a shortcut is trying to reach a project that is on another database to what Resolve is on currently, it will not work. The solution is to navigate Resolve to the desired database and then the shortcuts will work.
- Shortcuts work for both local and Cloud databases.
- During shortcut generation, a Prism thumbnail will be attempted to be saved using Resolve's stills capture functions. It should work in most situations.
- To aid is use, tooltips are provided throughout.
This plugin is for Windows only, as Prism2 only supports Windows at this time.
You can either download the latest stable release version from: Latest Release
or download the current code zipfile from the green "Code" button above or on [Github]
Copy the directory named "ResolveShortcuts" to a directory of your choice, or a Prism2 plugin directory.
Prism's default plugin directories are: {installation path}\Plugins\Apps and {installation Path}\Plugins\Custom.
You can add the additional plugin search paths in Prism2 settings. Go to Settings->Plugins and click the gear icon. This opens a dialogue and you may add additional search paths at the bottom.
Once added, restart Prism or reload plugins.
To save a shortcut, open the Project Browser from the Prism tool inside Resolve. Navigate to the desired Department/Task, and right click in the scenefiles area. This opens the right-click menu with various Prism options, with the added "Save Shortcut to Resolve Project" item (the shortcut item will not be in Standalone or other DCC intergrations). This will generate the .resolveShortcut file and save it in the Prism project structure. The shortcut file will have a comment in its Description noting the Resolve project, and timeline if one existed at the time the shortcut was created.
Shortcuts are located in the Scenefiles tab as any other DCC. Double-clicking the shortcut will open Resolve and navigate to the project, and timeline if applicable.
The shortcut file is generated from a Python file named "shortcutTemplate.resolveShortcut" in the Template directory. The shortcut file is utilized to be able to be run by just double-clicking. The script will read the environment variable to get the plugin directory location, and then send a command line command to run a python script (DvResolve_Project_Shortcuts.py) with the project path as an argument. The python script will start Resolve, wait for the API to initialize, and then navigate to the project and open it.
Settings for ResolveShortcuts are located in Prism's: Settings->User->ResolveShortcuts. The settings will be greyed-out and the shortcut functions will not be active until it is both enabled, and the environmant variable is set.
Resolve Shortcuts uses a small Python file that contains the Resolve project "address". This is just a .py file with a ".resolveShortcut" extension, and thus will not be recognized by the system by default. Setting the file association will add a registry key for the current user to allow the shortcut file to be run by Python.
To set the assocation, just click the "Click to Set" button. And if needed, you may remove the associaton by clicking the "Click to Remove" button.
The environment variable "PRISM_DVR_SHORTCUTS_PATH" must be set to point to the ResolveShortcuts plugin directory. A button is provided in the settings to automatically set the variable (or remove if needed). Using the button will set the variable, and then exit Prism. The variable may also be manually set using Prism's environment or the standard systems settings.
Various filepaths must be set correctly for shortcuts to function. The paths will be set during the first run of the plugin and will be saved to the config file. This assumes that Resolve is installed in the default location [Program Files] and [ProgramData]. If this is not the case or the plugin is moved, the correct paths can be set in settings.
- "DaVinciResolveScript.py" is the python module for Resolve's API that enables scripts to function inside Resolve.
- It is suggested to use the python.exe that is included with the Prism install. Any instance of python.exe may work, but the same version must be used.
A Reset button is provided to reset the paths to the automatically generated locations that are set at first run.
By default in Prism, the .vbs file type does not have an associated icon. The plugin adds the association to a custom Resolve icon to differentiate the shortcut. This should work in most cases, but if desired the shortcut icon can be disabled in the settings.
For any bug reports or suggestions, please add an issue to the GitHub repo.