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, plan and track your production.


The Ramses Application (and Add-ons) can be used without server; all the features will still be available, except for the ability to sync the data across workstations and multiple users at the same time.

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

Follow the next steps to learn how to prepare your pipeline and computers to work with Ramses and all of these components.


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 Application

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

2.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.

2.B - Settings

2.C - Create a database

2.D - 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 to set its location.

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

Project settings are detailed here.

3 - 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.