User quick start guide

Here’s all you need to know before you start using Ramses. Follow these few steps and you’ll be able to benefit from all it’s features very quickly.


Ramses can help you automate your workflow, track and plan your production. For this, it’s made of several different components, which can work both hand in hand or independently:

Ramses is modular; that means you don’t need to use all components together: it’s not mandatory to have access to a Ramses Server to use the application, and the Add-ons can also work independently.

No matter what, all these components also expect you to have a least a few predefined folders available in your computer or a shared location to store some data. That’s the Ramses Tree.

Follow the next steps to learn how to use Ramses and all of these components.


Although in the future the Ramses Client Application will be able to be used as a stand-alone, offline application, the currently available Alpha or Beta Versions absolutely need a connection to a Ramses Server (there’s no offline storage of the data for now). That’s temporary.


For now, the only official Add-on available is the one for Autodesk Maya, but others will follow soon (for Blender, After Effects, Nuke…)

As Ramses is free and open source, and provides easy-to-use APIs in Python and Adobe ExtendScript, other users may have developped other unofficial add-ons.


Although Ramses is made to be as simple as possible to use, it’s a production tool which both helps and needs you to be organized, and you’ll have to familiarize yourself with its organization.

1 - Check the Ramses folder, the Ramses Tree

In order to work correctly, Ramses expects a few folders to be available on your workstation or a shared location. Your administrator should give you the needed information.

More details about the Ramses Tree.

1.A - Project folders

In short, a project folder should contain at least these subfolders.

Sorting your files this way enables a lot of features in Ramses (thumbnails in the UI, direct access to the files from the Ramse Client Application, automatic time tracking, etc.). Read the details about naming conventions and the folder structure to know more.

More details about the file and folder structure.

2 - The Ramses Client Application

The Ramses Client Application is the main User Interface of Ramses.


Although in the future the Ramses Client will be able to be used as a stand-alone, offline application, the currently available Alpha or Beta Versions absolutely need a connection to a Ramses Server (there’s no offline storage of the data for now). That’s temporary.

3.A - Installation

Installing the application is standard and very simple, depending on your system. Instructions are available in the documentation here.

Before starting to use the Ramses Client Application there are a few steps to configure it correctly.

3.B - Settings

The first time the Client is run, it shows the following welcome screen, asking for mandatory settings.

At any time, you can also go to the settings with the settings button at the bottom right of the application.

The first mandatory setting to set is the location of the Ramses main folder, where Ramses will store all local data by default.

The Ramses main folder location should be given by your admnistrator. Be careful, it not a specific project folder; it is a folder which should contain at least one of these subfolders: Config, Projects, Users.

The Server address must be the complete URL to the server as given by your administrator. It should look like one of these:, localhost/ramses,,

The Secure connexion box should be checked by default. Only with some servers or local installation it may be unchecked.

That’s all, now you can log in, using your user name and password as given by your administrator.

All other settings are explained here.

3.C - Project settings

If you’re joining an existing project, and your administrator gave you a specific path for its data, you can go to the project panel tp set its location.

By default, the project is located inside the Ramses main folder as defined in step 3.B but you can override it in this panel.

Project settings are detailed here.

3.D - Folders, file access and thumbnails

To access or even create folders to store your files and be sure Ramses finds them, it is easier to use Ramses than create them manually.

From the Assets or Shots panels, clicking on any folder button opens (and creates if needed) the corresponding folder in your file explorer.

When changing the size of the rows, more details can be shown for each task, including a preview image.
The image is pulled from the _preview subfolder of the shot or the asset folder which you can open with the folder button on the top right corner of the cell. Ramses will get the first PNG or JPG correctly named image from the folder, or any other image if a correct one is not found.

Each cell contains information about a task (the combination of an asset or shot and a step).

4 - Install the Ramses Add-Ons

Finally, you can install the Ramses Add-ons you need. Installation differs depending on the host application (Maya, Blender, After Effects…), read the doc for more information.