Shotgun and RV configuration guide

You get RV free with your Shotgun subscription. To get started, download RV from your Shotgun site’s Apps menu.

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, and have enough technical knowledge to edit and save a configuration file.

Step 1. Enable the Shotgun and RV Package

The Shotgun package is included in the RV installation. When enabled, this 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

You should now see a Shotgun menu in your menubar.

RV preferences

Note: At this point RV has the Shotgun package enabled, but it’s not configured to know what Shotgun server to connect to. So when RV starts, you may see warnings like “No config module found”. You can configure Shotgun in the next step.

Step 2. 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 set up, just turn on Screening Room in the Apps > Manage Apps menu.

See the “Standard fields for tracking cut information” to ensure these fields are configured with the correct field types. The values below in parentheses () are the default values or behavior that RV will assume 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 color bars 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 and hiding the slate during playback.
  • Path To Frames (default color bars will display if the media doesn’t exist): Allows you to swap in high resolution frames instead of the low resolution movie.
  • Frames Aspect Ratio (1.0)
  • Frames Have Slate (No): If yes, allows you to toggle viewing and 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 Preferences page, then locate and expand the Advanced Preferences section.
  • Check the checkbox next to “Enable RV integration”.
  • Save the preferences by clicking the “Save Changes” button.

Step 3. 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 yours will be different from the example shown above.

Step 4. Download and install the config file

Download the 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

Note: RV_HOME is the path where the RV application was installed.

Step 5. 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.
    • Shotgun info widget
  • 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 one 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!

Updating the RV-Shotgun integration package

As an example, you can use a flagging feature. First, add the “Flagged” field to the Version entity. Then make sure the RV-Shotgun Integration package is aware of that “Flagged” field.

Open your shotgun_fields_config_*.mu file in a text editor.

Find the section that looks like this:

 /* -----------------------------------------*/
 // ADDITIONAL FIELDS
 /* -----------------------------------------*/
 // name                 prettyName              fieldName               fieldType       entityType      compute
 ("name",                "Name",                 "code",                 "text",         "Version",      false),
 ("description",         "Description",          "description",          "text",         "Version",      false),
 ("created",             "Created",              "created_at",           "date_time",    "Version",      false),
 ("status",              "Status",               "sg_status_list",       "status_list",  "Version",      false),
 ("shotStatus",          "Shot Status",          "sg_status_list",       "status_list",  "Shot",         false),
 ("assetStatus",         "Asset Status",         "sg_status_list",       "status_list",  "Asset",        false),
 ("department",          "Department",           "sg_department",        "text",         "Version",      false),
 ("flagged",             "Flagged",              "flagged",              "checkbox",     "Version",      false)
 };

The bold line above is what needs to be added in order for the flagging feature to work properly. Don’t forget to add the comma on the preceding line.

Save this file and you’re done!

Developer information

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 Shotgun developers will contact you to try and make that happen.

Troubleshooting

If you’ve followed this guide, and still haven’t gotten RV communicating with your Shotgun site, run through this quick list of questions.

1. 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, start RV, go to preferences, click Packages, and then select the Shotgun Integration package. The notes should include the relevant version numbers.

RV packages

RV

If you don’t have RV version 3.10.6 or later, you can download it at http://www.tweaksoftware.com/downloads.

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, follow these steps to get the package:

  • Download the Shotgun package
  • Start up RV.
  • Go to RV > Preferences, then click on the Packages tab.
  • If there are any existing Shotgun package(s) installed, uncheck each one’s “Installed” and “Load” checkbox, and then remove them all.
  • Click on ‘Add Packages…’
  • Point the file browser to the rvpkg file you downloaded, choose the file, and 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 now see a Shotgun menu.

2. 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, type custom into the input, then hit . Quit and restart RV.

3. 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 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 (i.e., Path to Movie = /BBB_Short/09_tree_trunk/011/ANIM/002/BBB_09_tree_trunk_011_ANIM_002.mov).

4. 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 specification, please consult the section further up on this page.

5. 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://.

Follow

3 Comments

Please sign in to leave a comment.