Add-ons

Warning

Ramses is still under active development, and this documentation is still being written.

For now, the only Add-on available for testing is the Autodesk Maya Add-On, others will follow in the upcoming weeks and months.

This specific page of the documentation is just a draft, sorry!

Ramses comes with some add-ons to be used in your creative applications (Blender, Maya, After Effects…). They are basic add-ons to demonstrate some capabilities of Ramses for file versionning and asset management, and can be used as templates to develop your own add-ons working with Ramses.

They will be developed one at a time, and you’re welcome to contribute with your own!

Here are some guidelines and descriptions about how these add-ons should work. We’re trying to apply the same guidelines to all host applications for a unified experience. These add-ons should use the provided Scripting API available at first in Python and Adobe ExtendsScript.

Introduction

Although the add-ons are primarily meant to be used in conjunction with the Ramses Client Application (which in turn may be connected to the Ramses Server), they can also be used on their own. In which case not all functionnalities will be available; the differences are mentionned in this documentation.

Available Commands

Some of these commands manage files in the Ramses Tree, see the corresponding documentation.

All commands except open Ramses and Settings should first:

Open and import

Shows a selector to quickly open or import a file from the Ramses Tree.

Allows the user to select either a shot, asset or template.

The user can then select the shot or asset, and then the step, to open a file.

To make shot and asset selection easier, they can be filtered by group or sequence, and a search field is available.

Optionnaly, the user can select a specific version of the file.

When importing a file, the way it is imported and managed depends on the host application. Some options may be shown before importing.

Save

If the file is not a working file, but a version coming from the ramses_version subfolder (named restore-vXX), runs Save new version instead of Save.

See the naming scheme and folder structure for more information.

Save new version & Publish

Retrieve version

It is only when the file will be saved that this new copied file will be removed and the working file will be overwritten to a new version.

Publish as template

Open template

Import template

Settings

Open Ramses

UI / UX

Depending on the host application, the implementation and User Interface / User Experience of the add-ons may vary, but they should follow these guidelines as closely as possible.

Integrated commands

When possible, the commands should be integrated as seamlessly as possible in the host application, e.g. by adding or even replacing menu items for saving files, saving as., etc.

Especially for the save command, the default save shortcut (generally [Ctrl] + [S]) should be replaced by the save command for Ramses. Other save command shortcuts should be added, preferably the same for all add-ons:

These shortcuts have been chosen to avoid conflicts in most host applications but can be changed to something else if they’re still conflicting with something important.

UI Panel

If possible, each Ramses Add-on should provide a UI panel integrated into the host software, but organized similarly in all add-ons, with specific variations to respect the host software UI guidelines.

The panel must display buttons for all available commands.

The panel must also provide a way to quickly set the current Project and Step, and show the opened asset or shot information: state, version, date, comment, completion ratio… This information is retrieved from the client application if available, or from the Ramses Tree if not. The panel and this information must be updated as soon as the opened file changes, or at least when the user interacts with it.

Information available in the panel:

If the client application is not available, the Project and Step information is displayed but cannot be changed. Comment is not available.

Settings

If the host application provides a way to display the settings of its add-ons, the settings should be located there (and the settings command should open this location if possible). If it does not, the Add-on must provide a dialog or a panel to let the user change the settings.

These settings are:

Note: the settings are saved in a shared location (user documents folder ?) between all add-ons so that they’re configured only once. They’re in an easy-to-edit JSON text file.