Shotgun+RV configuration guide

Last Updated 29-April-2015 

 

***This just got a lot easier with Shotgun 6 and RV 6...***

 

With Shotgun 6, you now get RV 6 free with your Shotgun subscription. We've also made installation and setup much easier. To get started, just download RV from your Shotgun site's Apps menu. For more information on getting setup with Screening Room for RV and Shotgun Integration, head over here

 

***PLEASE NOTE: What follows only applies to you if you're using a version of Shotgun or RV before V6.  Otherwise please head over here. ***

This guide assumes that you've got Admin access to a Shotgun site, have already installed RV 3.10.6 or later, are storing cut information on Versions and Shots in the standard way (documented here), and have enough technical knowledge to edit and save a configuration file. The guide consists of these sections:

 

Enable the Shotgun+RV Package

As of RV version 3.10.11, the Shotgun package is included in the RV installation and when enabled, makes RV "Shotgun-aware" and provides features in RV to interact directly with Shotgun. If you have an older version of RV, we recommend you download an updated version.

To enable the Shotgun package:

  1. Start RV
  2. Select the RV > Preferences menu
  3. Select the Packages Tab
  4. Select the "Installed" and "Load" checkboxes next to the Shotgun Integration package
  5. Close the Preferences and restart RV
  6. You should now see a Shotgun menu in your menubar and the Shotgun package is now enabled.

RV_Preferences.jpg

Note: At this point RV has the Shotgun package enabled, but we haven't configured it to know what Shotgun server to connect to. So when RV starts, you may see warnings like "No config module found". Not to worry, we'll take care of that in the next step.

 

 

Prepare your Shotgun site for RV integration

Minimum Shotgun fields for RV integration

NOTE FOR SCREENING ROOM USERS: Screening Room will create these fields for you when activated, so if you want to skip the manual setup, just turn on Screening Room in the Apps > Manage Apps menu.

See the documentation on the standard cut tracking fields to ensure these fields are configured with the correct field types. The values below in parentheses () are the default values or behavior that RV willa ssume if no data exists

Shot Fields  

  • Cut In (1)
    Used to trim the playback to match the current Cut. 
  • Cut Out (100)
    Used to trim the playback to match the current Cut.  
  • Cut Order (none)
    Used to "Isolate Version and neighbors" when viewing a Version. If you don't track Cut Order, this particular menu item won't work. 

Version Fields 

  • Path To Movie (default colorbars will display if the media doesn't exist)
    Required as the default media to load for playback 
  • Movie Aspect Ratio (1.0)
  • Movie Has Slate (No)
    If yes, allows you to toggle viewing/hiding the slate during playback.
  • Path To Frames (default colorbars will display if the media doesn't exist)
    Allows you to swap in high resolution frames instead of the low res movie. 
  • Frames Aspect Ratio (1.0)
  • Frames Have Slate (No)
    If yes, allows you to toggle viewing/hiding the slate during playback. 
  • First Frame (Shot.Cut In)
    For locating the first frame available in the Version when playing the Version at full length. 
  • Last Frame (Shot.Cut Out)
    For locating the last frame available in the Version when playing the Version at full length.  
  • Department (none)
    Displayed in the Shotgun Info Widget to show the department the Version originated from 

Turn on RV menu items in Shotgun

  • Login to your Shotgun server as an admin
  • Go to the site prefs page, then locate and expand the Advanced Preferences section
  • Check the checkbox next to Enable RV integration
  • Save the prefs by clicking the 'Save Changes' button

 

Allow RV to authenticate to your Shotgun site

  • Go to the Admin > Scripts page
  • If there's not a script named 'rv', you'll have to create one (currently, the name must be 'rv').
  • Copy the application key for the 'rv' script. It should look something like this:

    e1d958a09fa0c134d678cb0b6176cbb03ccec193

  • Note: The script key is randomly generated, so your's will be different from the example shown above.

 

Download and install the config file

Download this file shotgun_fields_config_custom.mu, then modify it in the following way: 

  • Open the file in a text editor and add your site url and script key towards the top underneath where it says  // ADD YOUR SERVER INFO HERE
  • Place shotgun_fields_config_custom.mu where RV can find it. RV will look in these places by default:

    Linux 

    ~/.rv/Mu
    RV_HOME/plugins/Mu

     

    Windows 

    ~\Application Support\RV\Mu # windows xp
    ~\AppData\Roaming\RV\Mu     # windows 7
    RV_HOME\plugins\Mu

     
    Mac 

    ~/Library/Application Support/RV/Mu
    RV_HOME/PlugIns/Mu

     

    *RV_HOME is the path where the RV application was installed
Install it in a directory in RV’s MU_MODULE_PATH. By default, this includes a location in your home directory where you installed the Shotgun package, and one the directory in which RV is installed (RV_HOME):
Linux 
~/.rv/Mu
RV_HOME/plugins/Mu
Windows 
~/Application Support/RV/Mu
RV_HOME/plugins/Mu
Mac 
~/Library/Application Support/RV/Mu
RV_HOME/PlugIns/Mu

 

Start RV and connect to your Shotgun site

  • Start RV
  • Click on the menu Shotgun > Preferences > Set Shotgun Config Style
  • Type in 'custom'. Alternately you can type a single space here to clear the current setting, if any. RV will look for a config style named 'custom' by default

    set_config_style_custom.png
  • Once you've set the config style to 'custom', quit and restart RV
  • Make sure that the media you intend to play in RV is on your local or a networked drive
  • Login to your Shotgun site
  • Go to a Versions page
  • Select 1 or more Versions
  • Click 'Play in RV'
  • You should see your local or networked media play in the RV window
  • You're done with the custom configuration!

 

Developer Info

 zendesk_sidepanel.png  github_logov3.png

The Shotgun package is open source and is available on GitHub at https://github.com/shotgunsoftware/rv-integration-package. If you make modifications you think should be included for others, submit a pull request with your changes and the developers at Tweak Software will contact you to try and make that happen.

 

For info on how to get started with developing packages for RV, check out the documentation on the Tweak Software website at 

 

Troubleshooting

If you've followed this guide, and still haven't gotten RV communicating with your Shotgun site, run down this quick check list. If you're still having issues, give us an email at support@shotgunsoftware.com.

Do you have the right Versions of RV and the Shotgun Package?

You should have RV 3.10.6 or later, and the Shotgun package 1.32 or later. To check and see if you have the right versions, just start RV, go to preferences, click Packages, then select the Shotgun Integration package. The notes should include the relevant version numbers.

shotgun_package_and_rv_versions.jpg

RV

If you don't have version 3.10.6 or later, you can download it here.

 

Shotgun package

This package is what gives you access to all of the Shotgun menu items from within RV. To check if you have it, start up RV, go to preferences, then click on Packages. If you don't have it, just follow these steps to get it:

  • Download the Shotgun package - available here (right click and "Save Link As...")
  • Start up RV
  • Go to RV > Preferences, then click on the Packages tab (furthest right)
  • If there are any existing Shotgun package(s) installed, uncheck each one's 'Installed' and 'Load' checkbox, then remove them all
  • Click on 'Add Packages...'
  • Point the file browser to the rvpkg file you downloaded, choose the file, then click 'Open'
  • When you see the 'Choose Package Installation' prompt appear, leave the location that RV selected
  • Click 'OK' and wait for the package to appear in the Packages window
  • Make sure that both the 'Installed' and 'Load' checkboxes are checked
  • Close out of RV preferences
  • Quit and restart RV
  • You should see a Shotgun menu

 

Is your RV Shotgun Config Style set properly?

While RV is open, go to Shotgun > Preferences > Set Shotgun Config Style. It should be set to custom. If it's not, then type custom into the input, then hit <ENTER>. Quit and restart RV.

 

Do you have access to the media you expect to play?

If you're just seeing color bars each time you try to use the RV menu items from Shotgun, it could be that you just don't have access to the files. RV will attempt to resolve file paths in a manner consistent with how they're stored in Shotgun (ie: Path to Movie = /BBB_Short/09_tree_trunk/011/ANIM/002/BBB_09_tree_trunk_011_ANIM_002.mov).

 

Did you correctly set up each Shotgun field that RV requires?

RV needs certain fields in Shotgun to already be created, and it needs each of these fields to be of a certain name and data type. To make sure your fields conform to this spec, please consult the section further up on this page.

 

Are you seeing a 'Connection refused' error when launching RV from Shotgun?

Check inside the shotgun_fields_config.mu file to confirm that your site URL is preceded with an https:// as opposed to http://.

 

Still having problems?

Please contact support@shotgunsoftware.com

 

Document History

  • 2010 Oct 19: Updated info for new RV 3.10 version and v1.32 Shotgun package information
  • 2011 Apr 20: Updated info to show Shotgun package is included in latest RV installations
  • 2011 Apr 21: Added link to GitHub for Developers
  • 2014 May 30: Updated config file paths for Windows 7
Follow

3 Comments

Please sign in to leave a comment.