Personal tools
You are here: Home Products RV Packages

RV Packages

RV Packages


RV Packages make it easy to add new features to RV. Users can add/remove or toggle on/off Packages. You can install Packages provided by Tweak or you can create your own Packages. Tweak provides many Packages to extend RV, prototype new features that are not in RV's core, and as examples for users who want to make extend RV.


RV Package Manager


RV Packages can contain anything from a simple hot key binding that automates some common actions to major new functionality. Packages can add menus and menu items to RV's interface, create custom heads up widgets, and anything else that can be done with RV's extension language. The best way to get an idea of what is possible is to take a look at the list of packages that Tweak has already made available to download for RV users. These can be used as is, or they can serve as a starting point for you own customization of RV.


Some of these packages implement new features for RV and others are included as scripting examples to demonstrate how to use some of RV's newest scripting features. The RV Users Manual and RV Reference Manual have been updated with detailed information about using and creating Packages.


Remote Sync

RV Exposure Sync


RV's new remote sync feature is implemented as an RV Package. This is a good example of how Tweak's developers rely on the same tools for creating RV features that are available for users. RV Sync lets you control the sync settings that are sent or received by your RV session during the remote review. RV will let you pan/zoom, change color settings, modify stereo display settings, synchronize play/stop and scrub, set in/out points and other features.


The sync mechanism is written in RV's extension language so you can see how it works. You can even use sync in your own customizations. So if you add features to RV, you can enable them to share their own information over the network during a remote review session.

Missing Frame Bling


Missing Frame Bling X


This package provides four different methods of annotating missing frames:

  • A big red X is drawn across the frame along with an error message.
  • Text indcating the missing frame number
  • Do nothing -- holds a previous good frame
  • Clear to black

Missing frame bling also provides a good example of how a scripted RV mode can save its own preferences (or read other prefs). This mode allows you to save the preferred style of bling as a preference.

Window Title



The window title package uses the Mu command "setWindowTitle" with the name and frame of the currently displayed image. You can use this as an example for how to set the window title to display any other information, for example, you could customize it to indicate info about the current shot (retrieved from a production database), the artist's current environment (e.g. shot/show/version from environment variables) or the status of some custom RV mode you have written.

Layer Select Mode

Layer Select Widget

Layer Select Mode provides a widget that lists layers from an image file (e.g. render passes stored as layers in a single Exr file). The widget let's you easily select the layer from the file for RV to display. Once a layer is selected, RV will only cache the image data from that layer for playback.


Sequence From File

This package changes RV so that selecting a single file of a sequence in a file dialog or dropping a single file of a sequence onto the view will cause RV to load the entire sequence (assuming it can infer the correct files).  Sequence from File expoits the "incoming-source-path" event. This event provides an opportunity to modify a path before the media is loaded. In this package, the path is tested to see if the file is part of a sequence, and if so, the sequence is substituted for the original file in the path.

OS Dependent Path Converter (for RV session files in a mixed OS environment)




This package is an example of how to make RV automatically translate the file paths in .rv session files so that the same session files can be read on OS X, Linux and Windows. For example, if your Windows systems and your Linux systems see network resources differently, you can use this package to allow RV to handle RV sessions properly, regardless of which paths are in the .rv session and which platform RV is running on.


This package could also be modified for other path translation tasks, for example a company with a VPN between remote facilities may want to translate paths based on location rather than on OS. For example in the case of using RV Sync, you may want to generate RV files for dailies sessions, but ensure that the media is read from local storage at each facility.

 Playlist Package



This package implements a playlist to manage playback when you have multiple sources loaded into RV. Selecting a source sets in/out points to the beginning and end of the selected source. The widget can be docked in the right margin, or can float. The image above shows the playlist docked in the right margin.

Metadata Info Mode

 Metadata Info


The Metadata Info Package demonstrates how custom properties in RV session files (.rv files) can be used to store metadata for display inside RV. Metadata Info Mode creates a widget, like the existing Image Info Widget to display the metadata stored RV Session File.  This can be useful when exporting RV session files from in-house production databases or dailies browsers.

Custom LUT Menu Mode

Lut Menu 


This package populates a menu with selectable LUTs based on the contents of a directory. It also demonstrates how a menu can built on the fly based on the contents of a directory. An environment variable is checked to find the path to a directory containing display LUTs. A new menu is added to RV which is populated with an item for each LUT found in the directory. This same technique could be used to create menus for navigating to lastest takes, cuts of the current sequence, etc.

RV Custom Function Mode

This coding example implements a simple RV mode demonstrating how to create a custom function with a hot key to execute a number of RV commands or set RV settings. Various example fuctions are provided and many standard RV configuration/settings are demonstrated.  This module adds a 'Custom Functions' menu under the Tools Menu, with an item for each custom function.